IBM MQ Queue Managers API

openapi: 3.1.0
info:
  title: IBM MQ Administration REST Channels Queue Managers API
  description: REST API for administering and monitoring IBM MQ queue managers, queues, topics, subscriptions, and channels. Provides programmatic access to manage MQ objects and retrieve status information.
  version: '2.0'
  contact:
    name: IBM Support
    url: https://www.ibm.com/mysupport
    email: support@ibm.com
  license:
    name: IBM License
    url: https://www.ibm.com/terms
servers:
- url: https://{host}:{port}/ibmmq/rest/v2
  description: IBM MQ REST API v2
  variables:
    host:
      default: localhost
      description: Hostname of the MQ web server
    port:
      default: '9443'
      description: HTTPS port of the MQ web server
security:
- basicAuth: []
- tokenAuth: []
tags:
- name: Queue Managers
  description: Manage and query queue manager objects and status
paths:
  /admin/qmgr:
    get:
      operationId: listQueueManagers
      summary: IBM MQ List queue managers
      description: Retrieve a list of queue managers accessible from the MQ web server, with optional filtering by name and attribute selection.
      tags:
      - Queue Managers
      parameters:
      - $ref: '#/components/parameters/ibmMqRestCsrfToken'
      - name: name
        in: query
        description: Filter queue managers by name (supports wildcard *)
        schema:
          type: string
      - name: attributes
        in: query
        description: Comma-separated list of attributes to return
        schema:
          type: string
      - name: status
        in: query
        description: Comma-separated list of status attributes to return
        schema:
          type: string
      responses:
        '200':
          description: Queue managers retrieved successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  qmgr:
                    type: array
                    items:
                      $ref: '#/components/schemas/QueueManager'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /admin/qmgr/{qmgrName}:
    get:
      operationId: getQueueManager
      summary: IBM MQ Get queue manager details
      description: Retrieve detailed information about a specific queue manager, including configuration attributes and runtime status.
      tags:
      - Queue Managers
      parameters:
      - $ref: '#/components/parameters/qmgrName'
      - $ref: '#/components/parameters/ibmMqRestCsrfToken'
      - name: attributes
        in: query
        description: Comma-separated list of attributes to return
        schema:
          type: string
      - name: status
        in: query
        description: Comma-separated list of status attributes to return
        schema:
          type: string
      responses:
        '200':
          description: Queue manager details retrieved
          content:
            application/json:
              schema:
                type: object
                properties:
                  qmgr:
                    type: array
                    items:
                      $ref: '#/components/schemas/QueueManager'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  responses:
    Unauthorized:
      description: Authentication required or credentials invalid
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    BadRequest:
      description: Invalid request parameters or body
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    NotFound:
      description: Requested resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  parameters:
    ibmMqRestCsrfToken:
      name: ibm-mq-rest-csrf-token
      in: header
      required: false
      description: CSRF token required for state-changing operations
      schema:
        type: string
    qmgrName:
      name: qmgrName
      in: path
      required: true
      description: Name of the queue manager
      schema:
        type: string
  schemas:
    QueueManager:
      type: object
      properties:
        name:
          type: string
          description: Name of the queue manager
        state:
          type: string
          enum:
          - running
          - ended
          description: Current state of the queue manager
        extended:
          type: object
          description: Extended queue manager attributes
          properties:
            commandLevel:
              type: integer
              description: Command level of the queue manager
            platform:
              type: string
              description: Platform the queue manager runs on
            maximumMessageLength:
              type: integer
              description: Maximum message length in bytes
            description:
              type: string
              description: Description of the queue manager
            deadLetterQueue:
              type: string
              description: Name of the dead-letter queue
            defaultTransmissionQueue:
              type: string
              description: Name of the default transmission queue
        status:
          type: object
          description: Runtime status information
          properties:
            started:
              type: string
              format: date-time
              description: Timestamp when the queue manager was started
            connectionCount:
              type: integer
              description: Number of current connections
            channelInitiatorState:
              type: string
              description: State of the channel initiator
    Error:
      type: object
      properties:
        error:
          type: array
          items:
            type: object
            properties:
              type:
                type: string
                description: Error type
              msgId:
                type: string
                description: Message identifier
              explanation:
                type: string
                description: Explanation of the error
              action:
                type: string
                description: Suggested action
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic authentication with MQ user credentials
    tokenAuth:
      type: apiKey
      in: cookie
      name: LtpaToken2
      description: LTPA token-based authentication via login endpoint
externalDocs:
  description: IBM MQ REST API Documentation
  url: https://www.ibm.com/docs/en/ibm-mq/latest?topic=api-rest