IBM WebSphere

IBM WebSphere Channels API

Channel administration

Documentation GitHub OpenAPI

Operations 6

GET /admin/qmgr/{qmgrName}/channel List Channels #

POST /admin/qmgr/{qmgrName}/channel Create a Channel #

GET /admin/qmgr/{qmgrName}/channel/{channelName} Get Channel Details #

DELETE /admin/qmgr/{qmgrName}/channel/{channelName} Delete a Channel #

POST /admin/qmgr/{qmgrName}/channel/{channelName}/start Start a Channel #

POST /admin/qmgr/{qmgrName}/channel/{channelName}/stop Stop a Channel #

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-channels-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 Channels 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: Channels
  description: Channel administration
paths:
  /admin/qmgr/{qmgrName}/channel:
    get:
      operationId: listChannels
      summary: List Channels
      description: Returns a list of channels on the specified queue manager.
      tags:
      - Channels
      parameters:
      - $ref: '#/components/parameters/qmgrName'
      - name: name
        in: query
        description: Channel name filter
        schema:
          type: string
        example: Example Title
      - name: type
        in: query
        description: Channel type filter
        schema:
          type: string
          enum:
          - sender
          - receiver
          - server
          - requester
          - serverConnection
          - clusterSender
          - clusterReceiver
          - amqp
        example: sender
      responses:
        '200':
          description: List of channels
          content:
            application/json:
              schema:
                type: object
                properties:
                  channel:
                    type: array
                    items:
                      $ref: '#/components/schemas/Channel'
              examples:
                Listchannels200Example:
                  summary: Default listChannels 200 response
                  x-microcks-default: true
                  value:
                    channel:
                    - name: Example Title
                      type: sender
                      description: A sample description.
                      connectionName: example_value
                      transmissionQueue: example_value
                      status:
                        state: running
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      operationId: createChannel
      summary: Create a Channel
      description: Creates a new channel on the queue manager.
      tags:
      - Channels
      parameters:
      - $ref: '#/components/parameters/qmgrName'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChannelCreate'
            examples:
              CreatechannelRequestExample:
                summary: Default createChannel request
                x-microcks-default: true
                value:
                  name: Example Title
                  type: sender
                  description: A sample description.
                  connectionName: example_value
                  transmissionQueue: example_value
      responses:
        '201':
          description: Channel created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Channel'
              examples:
                Createchannel201Example:
                  summary: Default createChannel 201 response
                  x-microcks-default: true
                  value:
                    name: Example Title
                    type: sender
                    description: A sample description.
                    connectionName: example_value
                    transmissionQueue: example_value
                    status:
                      state: running
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /admin/qmgr/{qmgrName}/channel/{channelName}:
    get:
      operationId: getChannel
      summary: Get Channel Details
      description: Returns details of a specific channel.
      tags:
      - Channels
      parameters:
      - $ref: '#/components/parameters/qmgrName'
      - name: channelName
        in: path
        required: true
        description: Channel name
        schema:
          type: string
        example: example_value
      responses:
        '200':
          description: Channel details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Channel'
              examples:
                Getchannel200Example:
                  summary: Default getChannel 200 response
                  x-microcks-default: true
                  value:
                    name: Example Title
                    type: sender
                    description: A sample description.
                    connectionName: example_value
                    transmissionQueue: example_value
                    status:
                      state: running
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      operationId: deleteChannel
      summary: Delete a Channel
      description: Deletes a channel from the queue manager.
      tags:
      - Channels
      parameters:
      - $ref: '#/components/parameters/qmgrName'
      - name: channelName
        in: path
        required: true
        schema:
          type: string
        example: example_value
      responses:
        '204':
          description: Channel deleted
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /admin/qmgr/{qmgrName}/channel/{channelName}/start:
    post:
      operationId: startChannel
      summary: Start a Channel
      description: Starts a channel on the queue manager.
      tags:
      - Channels
      parameters:
      - $ref: '#/components/parameters/qmgrName'
      - name: channelName
        in: path
        required: true
        schema:
          type: string
        example: example_value
      responses:
        '200':
          description: Channel started
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /admin/qmgr/{qmgrName}/channel/{channelName}/stop:
    post:
      operationId: stopChannel
      summary: Stop a Channel
      description: Stops a channel on the queue manager.
      tags:
      - Channels
      parameters:
      - $ref: '#/components/parameters/qmgrName'
      - name: channelName
        in: path
        required: true
        schema:
          type: string
        example: example_value
      responses:
        '200':
          description: Channel stopped
        '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: []
    ChannelCreate:
      type: object
      required:
      - name
      - type
      properties:
        name:
          type: string
          example: Example Title
        type:
          type: string
          enum:
          - sender
          - receiver
          - server
          - requester
          - serverConnection
          - clusterSender
          - clusterReceiver
          - amqp
          example: sender
        description:
          type: string
          example: A sample description.
        connectionName:
          type: string
          example: example_value
        transmissionQueue:
          type: string
          example: example_value
    Channel:
      type: object
      properties:
        name:
          type: string
          description: Channel name
          example: Example Title
        type:
          type: string
          enum:
          - sender
          - receiver
          - server
          - requester
          - serverConnection
          - clusterSender
          - clusterReceiver
          - amqp
          example: sender
        description:
          type: string
          example: A sample description.
        connectionName:
          type: string
          description: Connection name (host and port)
          example: example_value
        transmissionQueue:
          type: string
          description: Transmission queue name
          example: example_value
        status:
          type: object
          properties:
            state:
              type: string
              enum:
              - running
              - stopped
              - retrying
              - binding
              - starting
              - stopping
          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:
    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 Channels API

Operations 6

Documentation

Specifications

Schemas & Data

Other Resources