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 Subscriptions API

Manage and query subscription objects

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

This API exposes 4 operations across 2 paths, and defines 3 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.

4 operations 2 paths 3 schemas 1 DELETE2 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 Subscriptions 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 4

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

Subscriptions 4

Manage and query subscription objects

GET
/admin/qmgr/{qmgrName}/subscription
IBM MQ List subscriptions
listSubscriptions 4 params → 200401404
POST
/admin/qmgr/{qmgrName}/subscription
IBM MQ Create a subscription
createSubscription 2 params body → 201400401409
GET
/admin/qmgr/{qmgrName}/subscription/{subscriptionId}
IBM MQ Get subscription details
getSubscription 4 params → 200401404
DELETE
/admin/qmgr/{qmgrName}/subscription/{subscriptionId}
IBM MQ Delete a subscription
deleteSubscription 3 params → 204401404

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are Subscription (5 properties), SubscriptionCreateRequest (3 properties), Error (1 property). Each schema is shown below with its type and property counts.

SubscriptionCreateRequest
object
3 properties 3 required
Subscription
object
5 properties
Error
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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