IBM WebSphere Subscriptions API

Subscription management

Operations 3

GET /admin/qmgr/{qmgrName}/subscription List Subscriptions #
GET /admin/qmgr/{qmgrName}/subscription/{subscriptionId} Get Subscription Details #
DELETE /admin/qmgr/{qmgrName}/subscription/{subscriptionId} Delete a Subscription #

Documentation

📖
Documentation
https://www.ibm.com/docs/en/was/9.0.5?topic=overview-administrative-rest-api
📖
Authentication
https://www.ibm.com/docs/en/was/9.0.5?topic=api-authentication-authorization
📖
GettingStarted
https://www.ibm.com/docs/en/was-nd/9.0.5?topic=specifications-discovering-rest-api-documentation
📖
APIReference
https://www.ibm.com/docs/en/was/9.0.5?topic=javadoc-apis-application-programming-interfaces
📖
Documentation
https://www.ibm.com/docs/en/was-liberty/base?topic=liberty-admin-rest-api
📖
GettingStarted
https://www.ibm.com/docs/en/was-liberty/base?topic=api-getting-started
📖
APIReference
https://openliberty.io/docs/latest/reference/feature/restConnector-2.0.html
📖
Documentation
https://www.ibm.com/docs/en/was-liberty/base?topic=center-setting-up-admin
📖
Documentation
https://openliberty.io/docs/latest/reference/feature/restConnector-2.0.html
📖
APIReference
https://openliberty.io/docs/latest/reference/api/open-liberty-apis.html
📖
Documentation
https://openliberty.io/docs/latest/configuring-jmx-connection.html
📖
Documentation
https://www.ibm.com/docs/en/was-liberty/core?topic=features-admin-rest-connector-20
📖
Documentation
https://www.ibm.com/docs/en/ibm-mq/9.3?topic=api-rest-introduction
📖
APIReference
https://www.ibm.com/docs/en/ibm-mq/9.3?topic=api-rest-reference
📖
Authentication
https://www.ibm.com/docs/en/ibm-mq/9.3?topic=api-rest-authentication
📖
GettingStarted
https://developer.ibm.com/tutorials/mq-develop-mq-rest-api/
📖
Documentation
https://www.ibm.com/docs/en/ibm-mq/9.3?topic=mq-messaging-using-rest-api
📖
Documentation
https://www.ibm.com/docs/en/was-liberty/base?topic=liberty-collective-rest-api
📖
APIReference
https://www.ibm.com/docs/en/was-liberty/base?topic=api-collective-reference
📖
Documentation
https://www.ibm.com/docs/en/was-liberty/base?topic=deploying-applications-in-liberty
📖
Documentation
https://www.ibm.com/docs/en/ws-automation?topic=apis
📖
APIReference
https://www.ibm.com/docs/en/ws-automation?topic=reference-rest-api
📖
Documentation
https://www.ibm.com/docs/en/ws-automation?topic=viewing-rest-api
📖
Documentation
https://openliberty.io/docs/latest/reference/api/open-liberty-apis.html
📖
APIReference
https://openliberty.io/docs/latest/documentation-openapi.html
📖
GettingStarted
https://openliberty.io/guides/rest-intro.html
📖
Documentation
https://openliberty.io/docs/latest/microprofile.html

Specifications

Schemas & Data

Other Resources

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/websphere-subscriptions-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

websphere-subscriptions-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: IBM MQ REST Subscriptions API
  description: 'REST API for IBM MQ messaging operations including sending and receiving messages, queue management, topic management, and monitoring. Supports both administration and messaging endpoints for point-to-point and publish-subscribe patterns. The API provides two main categories: the administrative REST API for managing MQ objects and the messaging REST API for sending and receiving messages.'
  version: 9.3.0
  license:
    name: IBM International License Agreement
    url: https://www.ibm.com/legal/terms
  contact:
    name: IBM Support
    url: https://www.ibm.com/mysupport
servers:
- url: https://localhost:9443/ibmmq/rest/v2
  description: IBM MQ REST API v2 Server
security:
- basicAuth: []
- tokenAuth: []
tags:
- name: Subscriptions
  description: Subscription management
paths:
  /admin/qmgr/{qmgrName}/subscription:
    get:
      operationId: listSubscriptions
      summary: List Subscriptions
      description: Returns a list of subscriptions on the queue manager.
      tags:
      - Subscriptions
      parameters:
      - $ref: '#/components/parameters/qmgrName'
      responses:
        '200':
          description: List of subscriptions
          content:
            application/json:
              schema:
                type: object
                properties:
                  subscription:
                    type: array
                    items:
                      $ref: '#/components/schemas/Subscription'
              examples:
                Listsubscriptions200Example:
                  summary: Default listSubscriptions 200 response
                  x-microcks-default: true
                  value:
                    subscription:
                    - id: abc123
                      name: Example Title
                      topicString: example_value
                      destination: example_value
                      type: admin
                      durability: durable
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /admin/qmgr/{qmgrName}/subscription/{subscriptionId}:
    get:
      operationId: getSubscription
      summary: Get Subscription Details
      description: Returns details of a specific subscription.
      tags:
      - Subscriptions
      parameters:
      - $ref: '#/components/parameters/qmgrName'
      - name: subscriptionId
        in: path
        required: true
        description: Subscription identifier
        schema:
          type: string
        example: '500123'
      responses:
        '200':
          description: Subscription details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Subscription'
              examples:
                Getsubscription200Example:
                  summary: Default getSubscription 200 response
                  x-microcks-default: true
                  value:
                    id: abc123
                    name: Example Title
                    topicString: example_value
                    destination: example_value
                    type: admin
                    durability: durable
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      operationId: deleteSubscription
      summary: Delete a Subscription
      description: Deletes a subscription from the queue manager.
      tags:
      - Subscriptions
      parameters:
      - $ref: '#/components/parameters/qmgrName'
      - name: subscriptionId
        in: path
        required: true
        schema:
          type: string
        example: '500123'
      responses:
        '204':
          description: Subscription deleted
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    Error:
      type: object
      properties:
        error:
          type: array
          items:
            type: object
            properties:
              type:
                type: string
              msgId:
                type: string
              explanation:
                type: string
              action:
                type: string
              message:
                type: string
          example: []
    Subscription:
      type: object
      properties:
        id:
          type: string
          description: Subscription identifier
          example: abc123
        name:
          type: string
          description: Subscription name
          example: Example Title
        topicString:
          type: string
          description: Topic string
          example: example_value
        destination:
          type: string
          description: Destination queue name
          example: example_value
        type:
          type: string
          enum:
          - admin
          - api
          example: admin
        durability:
          type: string
          enum:
          - durable
          - nonDurable
          example: durable
  responses:
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: Authentication required
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  parameters:
    qmgrName:
      name: qmgrName
      in: path
      required: true
      description: Queue manager name
      schema:
        type: string
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic authentication
    tokenAuth:
      type: apiKey
      in: cookie
      name: LtpaToken2
      description: LTPA token authentication
externalDocs:
  description: IBM MQ REST API Documentation
  url: https://www.ibm.com/docs/en/ibm-mq/9.3?topic=api-rest-reference