IBM WebSphere

IBM WebSphere Queues API

Queue administration and management

Documentation GitHub OpenAPI

Operations 5

GET /admin/qmgr/{qmgrName}/queue List Queues #

POST /admin/qmgr/{qmgrName}/queue Create a Queue #

GET /admin/qmgr/{qmgrName}/queue/{queueName} Get Queue Details #

PATCH /admin/qmgr/{qmgrName}/queue/{queueName} Update Queue Attributes #

DELETE /admin/qmgr/{qmgrName}/queue/{queueName} Delete a Queue #

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-queues-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.

GitHub Google LinkedIn

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

OpenAPI Specification

openapi: 3.2.0
info:
  title: IBM MQ REST Queues 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: Queues
  description: Queue administration and management
paths:
  /admin/qmgr/{qmgrName}/queue:
    get:
      operationId: listQueues
      summary: List Queues
      description: Returns a list of queues on the specified queue manager.
      tags:
      - Queues
      parameters:
      - $ref: '#/components/parameters/qmgrName'
      - name: name
        in: query
        description: Queue name filter with wildcard support
        schema:
          type: string
        example: Example Title
      - name: type
        in: query
        description: Queue type filter
        schema:
          type: string
          enum:
          - local
          - alias
          - remote
          - model
          - cluster
        example: local
      - name: attributes
        in: query
        description: Comma-separated list of attributes to return
        schema:
          type: string
        example: example_value
      responses:
        '200':
          description: List of queues
          content:
            application/json:
              schema:
                type: object
                properties:
                  queue:
                    type: array
                    items:
                      $ref: '#/components/schemas/Queue'
              examples:
                Listqueues200Example:
                  summary: Default listQueues 200 response
                  x-microcks-default: true
                  value:
                    queue:
                    - name: Example Title
                      type: local
                      description: A sample description.
                      maxDepth: 10
                      maxMessageLength: 10
                      currentDepth: 10
                      inhibitPut: true
                      inhibitGet: true
                      persistence:
                        default: persistent
                      cluster:
                        name: Example Title
                        workloadRank: 10
                        workloadPriority: 10
                      status:
                        currentDepth: 10
                        openInputCount: 10
                        openOutputCount: 10
                        lastGetDateTime: '2026-01-15T10:30:00Z'
                        lastPutDateTime: '2026-01-15T10:30:00Z'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      operationId: createQueue
      summary: Create a Queue
      description: Creates a new queue on the specified queue manager.
      tags:
      - Queues
      parameters:
      - $ref: '#/components/parameters/qmgrName'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/QueueCreate'
            examples:
              CreatequeueRequestExample:
                summary: Default createQueue request
                x-microcks-default: true
                value:
                  name: Example Title
                  type: local
                  description: A sample description.
                  maxDepth: 10
                  maxMessageLength: 10
                  persistence:
                    default: persistent
      responses:
        '201':
          description: Queue created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Queue'
              examples:
                Createqueue201Example:
                  summary: Default createQueue 201 response
                  x-microcks-default: true
                  value:
                    name: Example Title
                    type: local
                    description: A sample description.
                    maxDepth: 10
                    maxMessageLength: 10
                    currentDepth: 10
                    inhibitPut: true
                    inhibitGet: true
                    persistence:
                      default: persistent
                    cluster:
                      name: Example Title
                      workloadRank: 10
                      workloadPriority: 10
                    status:
                      currentDepth: 10
                      openInputCount: 10
                      openOutputCount: 10
                      lastGetDateTime: '2026-01-15T10:30:00Z'
                      lastPutDateTime: '2026-01-15T10:30:00Z'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '409':
          description: Queue already exists
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                Createqueue409Example:
                  summary: Default createQueue 409 response
                  x-microcks-default: true
                  value:
                    error:
                    - type: example_value
                      msgId: '500123'
                      explanation: example_value
                      action: example_value
                      message: example_value
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /admin/qmgr/{qmgrName}/queue/{queueName}:
    get:
      operationId: getQueue
      summary: Get Queue Details
      description: Returns details of a specific queue.
      tags:
      - Queues
      parameters:
      - $ref: '#/components/parameters/qmgrName'
      - $ref: '#/components/parameters/queueName'
      - name: status
        in: query
        description: Include queue status information
        schema:
          type: boolean
          default: false
        example: true
      - name: attributes
        in: query
        description: Comma-separated list of attributes to return
        schema:
          type: string
        example: example_value
      responses:
        '200':
          description: Queue details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Queue'
              examples:
                Getqueue200Example:
                  summary: Default getQueue 200 response
                  x-microcks-default: true
                  value:
                    name: Example Title
                    type: local
                    description: A sample description.
                    maxDepth: 10
                    maxMessageLength: 10
                    currentDepth: 10
                    inhibitPut: true
                    inhibitGet: true
                    persistence:
                      default: persistent
                    cluster:
                      name: Example Title
                      workloadRank: 10
                      workloadPriority: 10
                    status:
                      currentDepth: 10
                      openInputCount: 10
                      openOutputCount: 10
                      lastGetDateTime: '2026-01-15T10:30:00Z'
                      lastPutDateTime: '2026-01-15T10:30:00Z'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    patch:
      operationId: updateQueue
      summary: Update Queue Attributes
      description: Updates attributes of an existing queue.
      tags:
      - Queues
      parameters:
      - $ref: '#/components/parameters/qmgrName'
      - $ref: '#/components/parameters/queueName'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/QueueUpdate'
            examples:
              UpdatequeueRequestExample:
                summary: Default updateQueue request
                x-microcks-default: true
                value:
                  description: A sample description.
                  maxDepth: 10
                  maxMessageLength: 10
                  inhibitPut: true
                  inhibitGet: true
      responses:
        '200':
          description: Queue updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Queue'
              examples:
                Updatequeue200Example:
                  summary: Default updateQueue 200 response
                  x-microcks-default: true
                  value:
                    name: Example Title
                    type: local
                    description: A sample description.
                    maxDepth: 10
                    maxMessageLength: 10
                    currentDepth: 10
                    inhibitPut: true
                    inhibitGet: true
                    persistence:
                      default: persistent
                    cluster:
                      name: Example Title
                      workloadRank: 10
                      workloadPriority: 10
                    status:
                      currentDepth: 10
                      openInputCount: 10
                      openOutputCount: 10
                      lastGetDateTime: '2026-01-15T10:30:00Z'
                      lastPutDateTime: '2026-01-15T10:30:00Z'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      operationId: deleteQueue
      summary: Delete a Queue
      description: Deletes a queue from the queue manager.
      tags:
      - Queues
      parameters:
      - $ref: '#/components/parameters/qmgrName'
      - $ref: '#/components/parameters/queueName'
      - name: purge
        in: query
        description: Purge messages before deleting
        schema:
          type: boolean
          default: false
        example: true
      responses:
        '204':
          description: Queue 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: []
    QueueUpdate:
      type: object
      properties:
        description:
          type: string
          example: A sample description.
        maxDepth:
          type: integer
          example: 10
        maxMessageLength:
          type: integer
          example: 10
        inhibitPut:
          type: boolean
          example: true
        inhibitGet:
          type: boolean
          example: true
    QueueCreate:
      type: object
      required:
      - name
      properties:
        name:
          type: string
          description: Queue name
          example: Example Title
        type:
          type: string
          enum:
          - local
          - alias
          - remote
          - model
          default: local
          example: local
        description:
          type: string
          example: A sample description.
        maxDepth:
          type: integer
          default: 5000
          example: 10
        maxMessageLength:
          type: integer
          default: 4194304
          example: 10
        persistence:
          type: object
          properties:
            default:
              type: string
              enum:
              - persistent
              - nonPersistent
          example: example_value
    Queue:
      type: object
      properties:
        name:
          type: string
          description: Queue name
          example: Example Title
        type:
          type: string
          enum:
          - local
          - alias
          - remote
          - model
          - cluster
          description: Queue type
          example: local
        description:
          type: string
          example: A sample description.
        maxDepth:
          type: integer
          description: Maximum queue depth
          example: 10
        maxMessageLength:
          type: integer
          description: Maximum message length in bytes
          example: 10
        currentDepth:
          type: integer
          description: Current number of messages on the queue
          example: 10
        inhibitPut:
          type: boolean
          description: Whether put operations are inhibited
          example: true
        inhibitGet:
          type: boolean
          description: Whether get operations are inhibited
          example: true
        persistence:
          type: object
          properties:
            default:
              type: string
              enum:
              - persistent
              - nonPersistent
          example: example_value
        cluster:
          type: object
          properties:
            name:
              type: string
            workloadRank:
              type: integer
            workloadPriority:
              type: integer
          example: example_value
        status:
          type: object
          properties:
            currentDepth:
              type: integer
            openInputCount:
              type: integer
            openOutputCount:
              type: integer
            lastGetDateTime:
              type: string
              format: date-time
            lastPutDateTime:
              type: string
              format: date-time
          example: example_value
  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'
    BadRequest:
      description: Bad request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  parameters:
    queueName:
      name: queueName
      in: path
      required: true
      description: Queue name
      schema:
        type: string
    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

IBM WebSphere Queues API

Operations 5

Documentation

Specifications

Schemas & Data

Other Resources