Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

IBM MQ Queues API

Manage and query queue objects and status

IBM MQ Queues API is one of 11 APIs that IBM MQ publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Queues. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 5 operations across 2 paths, and defines 4 schemas. It is described by OpenAPI 3.1.0, at version 2.0.

Requests are made against a single base URL, https://{host}:{port}/ibmmq/rest/v2.

5 operations 2 paths 4 schemas 1 DELETE2 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2.0
Base URL
https://{host}:{port}/ibmmq/rest/v2
Authentication
HTTP Basic, API Key
Resource Areas
1

Authentication & Security 2

IBM MQ Queues API declares 2 security schemes for authenticating requests. It accepts HTTP basic authentication (basicAuth). An API key is passed in the cookie as LtpaToken2 (tokenAuth). By default, every request must be authenticated.

  • basicAuth — HTTP Basic authentication with MQ user credentials
  • tokenAuth — LTPA token-based authentication via login endpoint

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Queues 5

Manage and query queue objects and status

GET
/admin/qmgr/{qmgrName}/queue
IBM MQ List queues
listQueues 6 params → 200400401404
POST
/admin/qmgr/{qmgrName}/queue
IBM MQ Create a queue
createQueue 2 params body → 201400401409
GET
/admin/qmgr/{qmgrName}/queue/{queueName}
IBM MQ Get queue details
getQueue 5 params → 200401404
PATCH
/admin/qmgr/{qmgrName}/queue/{queueName}
IBM MQ Update a queue
updateQueue 3 params body → 200400401404
DELETE
/admin/qmgr/{qmgrName}/queue/{queueName}
IBM MQ Delete a queue
deleteQueue 3 params → 204401404

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are Queue (6 properties), QueueCreateRequest (4 properties), QueueUpdateRequest (2 properties), Error (1 property). Each schema is shown below with its type and property counts.

Queue
object
6 properties
QueueUpdateRequest
object
2 properties
QueueCreateRequest
object
4 properties 2 required
Error
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ibm-mq-queues-api-openapi.yml Raw ↑

Other APIs IBM MQ publishes across the network.

IBM MQ JMS API
IBM MQ Native API
IBM MQ Channels API
IBM MQ Installations API
IBM MQ Login API
IBM MQ Queue Managers API
IBM MQ Queue Messaging API
IBM MQ Subscriptions API
IBM MQ Topic Messaging API
IBM MQ Topics API