The IBM MQ Console and REST API

You can use the IBM® MQ Console and REST API to administer IBM MQ, and perform messaging operations, by using HTTP.

You can use the IBM MQ Console to perform basic administration tasks from a web browser. For more information, see Administration using the IBM MQ Console.
You can use the administrative REST API to administer IBM MQ objects, such as queue managers and queues, and Managed File Transfer agents and transfers. For more information, see Administration using the REST API.
You can use the messaging REST API to perform simple point-to-point and publish messaging. For more information, see Messaging using the REST API.

Installation options

The IBM MQ Console and REST API run in a WebSphere® Liberty server, called mqweb. From IBM MQ 9.3.5, you can install the mqweb server either as an optional component in an IBM MQ installation, or as a stand-alone IBM MQ Web Server installation.

Stand-alone IBM MQ Web Server installation

From IBM MQ 9.3.5, the mqweb server can run in a stand-alone installation of IBM MQ Web Server. A stand-alone IBM MQ Web Server installation enables you to install and run the mqweb server on systems that are separate to your IBM MQ installations. Installing a stand-alone IBM MQ Web Server gives greater flexibility as to which systems, and the number of systems, that you choose to run your mqweb servers on. If required, several instances of the mqweb server can be run on different machines to provide the scalability and availability that you need.

If you have purchased IBM MQ entitlement, you can install as many copies as required of the stand-alone IBM MQ Web Server. IBM MQ Web Server installations are not counted against your purchased IBM MQ entitlement. For more information on IBM MQ licensing, see IBM MQ license information.

The following restrictions apply in a stand-alone IBM MQ Web Server installation:

The IBM MQ Console can be used to administer only remote queue managers.
The messaging REST API can be used only with remote queue managers.
The administrative REST API is not available.

The stand-alone IBM MQ Web Server is supported only on Linux® platforms.

For more information about installing the stand-alone IBM MQ Web Server, see Installing the stand-alone IBM MQ Web Server.

Optional component of an IBM MQ installation

You can choose to install the IBM MQ Console and REST API component as part of an IBM MQ installation.

All IBM MQ Console and REST API features are available when the mqweb server runs in an IBM MQ installation.

The IBM MQ Console can be used to administer local and remote queue managers.
The messaging REST API can be used with local and remote queue managers.
The administrative REST API can be used to administer local and remote queue managers.

To use the IBM MQ Console and REST API component, install the following component as part of your IBM MQ installation:

On AIX®, install the mqm.web.rte fileset.
On IBM i, install the WEB component.
On Linux, install the MQSeriesWeb component.
On Windows, install the Web Administration feature.
On z/OS®, install the IBM MQ for z/OS UNIX System Services Web Components feature.