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 Queue Messaging API

Send and receive messages on queues

IBM MQ Queue Messaging 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 Queue Messaging. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 3 operations across 1 path, and defines 1 schema. 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.

3 operations 1 paths 1 schemas 1 DELETE1 GET1 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 Queue Messaging 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 3

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

Queue Messaging 3

Send and receive messages on queues

POST
/messaging/qmgr/{qmgrName}/queue/{queueName}/message
IBM MQ Send a message to a queue
sendMessageToQueue 7 params body → 201400401404503
GET
/messaging/qmgr/{qmgrName}/queue/{queueName}/message
IBM MQ Receive a message from a queue
receiveMessageFromQueue 6 params → 200204401404
DELETE
/messaging/qmgr/{qmgrName}/queue/{queueName}/message
IBM MQ Browse a message on a queue
browseMessageFromQueue 5 params → 200204401404

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. The most detailed is Error (1 property). Each schema is shown below with its type and property counts.

Error
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ibm-mq-queue-messaging-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 Queues API
IBM MQ Subscriptions API
IBM MQ Topic Messaging API
IBM MQ Topics API