Administration using the REST API

Administration using the REST API

We can use the administrative REST API to administer IBM MQ objects, such as queue managers and queues, and Managed File Transfer GET REST services. Information is sent to, and received from, the administrative REST API in the JSON format. These RESTful APIs can help you to embed IBM MQ administration into popular DevOps and automation tooling.

Before you begin

For reference information about the available REST resources, see The administrative REST API reference.
Note:
In IBM MQ Version 9.0.1, the administrative REST API is not integrated with IBM MQ security. Therefore, the administrative REST API is disabled by default. You must manually enable the administrative REST API before we can use it. For more information about enabling the administrative REST API, see Get started with the administrative REST API.

From IBM MQ Version 9.0.2, the administrative REST API is integrated with IBM MQ security. The administrative REST API is enabled by default. However, you must configure security before we can use the administrative REST API. For more information, see IBM MQ Console and REST API security.

Get started with the administrative REST API
Before we can start the administrative REST API you must install the correct components, enable the REST API, configure security, and start the mqweb server.
Use the administrative REST API
When we use the administrative REST API, you invoke HTTP methods on URLs that represent the various IBM MQ objects, such as queue managers or queues. The HTTP method, for example POST, represents the type of action to be performed on the object that is represented by the URL. Further information about the action might be provided in JSON as part of the payload of the HTTP method, or encoded in query parameters. Information about the result of performing the action might be returned as the body of the HTTP response.
Remote administration using the REST API
We can use the REST API to administer remote queue managers, and the IBM MQ objects that are associated with those queue managers. This remote administration includes queue managers that are on the same system, but not in the same IBM MQ installation as the mqweb server. Therefore, we can use the REST API to administer your entire IBM MQ network with only one installation that runs the mqweb server. To administer remote queue managers, you must configure the administrative REST API gateway so that at least one queue manager in the same installation as the mqweb server acts as a gateway queue manager. Then, we can specify the remote queue manager in the REST API resource URL to perform the specified administrative action.
REST API time stamps
When date and time information is returned by the administrative REST API, it is returned in Coordinated Universal Time (UTC), and in a set format.
REST API error handling
The REST API reports errors by returning an appropriate HTTP response code, for example 404 (Not Found), and a JSON response. Any HTTP response code that is not in the range 200 - 299 is considered an error.
REST API discovery
Documentation for the REST API is available within the IBM Knowledge Center and in Swagger format. Swagger is a commonly used approach for documenting REST APIs. The Swagger documentation for the REST API can be viewed by enabling the API discovery feature on the mqweb server.
REST API national language support
The REST API supports, with certain qualifications, the ability to specify national languages as part of an HTTP request.
Parent topic: Administer IBM MQ