OpenAPI Specification
openapi: 3.1.0
info:
title: IBM MQ Administration REST Channels 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: Channels
description: Manage and query channel objects and status
paths:
/admin/qmgr/{qmgrName}/channel:
get:
operationId: listChannels
summary: IBM MQ List channels
description: Retrieve a list of channel objects defined on a queue manager, with optional filtering by name and type.
tags:
- Channels
parameters:
- $ref: '#/components/parameters/qmgrName'
- $ref: '#/components/parameters/ibmMqRestCsrfToken'
- name: name
in: query
description: Filter channels by name (supports wildcard *)
schema:
type: string
- name: type
in: query
description: Filter by channel type
schema:
type: string
enum:
- sender
- receiver
- server
- requester
- serverConnection
- clusterSender
- clusterReceiver
- clientConnection
- amqp
- 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: Channels retrieved successfully
content:
application/json:
schema:
type: object
properties:
channel:
type: array
items:
$ref: '#/components/schemas/Channel'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
post:
operationId: createChannel
summary: IBM MQ Create a channel
description: Create a new channel on the specified queue manager.
tags:
- Channels
parameters:
- $ref: '#/components/parameters/qmgrName'
- $ref: '#/components/parameters/ibmMqRestCsrfToken'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ChannelCreateRequest'
responses:
'201':
description: Channel created successfully
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'409':
description: Channel already exists
/admin/qmgr/{qmgrName}/channel/{channelName}:
get:
operationId: getChannel
summary: IBM MQ Get channel details
description: Retrieve detailed information about a specific channel, including configuration attributes and runtime status.
tags:
- Channels
parameters:
- $ref: '#/components/parameters/qmgrName'
- $ref: '#/components/parameters/channelName'
- $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: Channel details retrieved
content:
application/json:
schema:
type: object
properties:
channel:
type: array
items:
$ref: '#/components/schemas/Channel'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
patch:
operationId: updateChannel
summary: IBM MQ Update a channel
description: Modify attributes of an existing channel on the queue manager.
tags:
- Channels
parameters:
- $ref: '#/components/parameters/qmgrName'
- $ref: '#/components/parameters/channelName'
- $ref: '#/components/parameters/ibmMqRestCsrfToken'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ChannelUpdateRequest'
responses:
'200':
description: Channel updated successfully
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
delete:
operationId: deleteChannel
summary: IBM MQ Delete a channel
description: Delete a channel from the queue manager.
tags:
- Channels
parameters:
- $ref: '#/components/parameters/qmgrName'
- $ref: '#/components/parameters/channelName'
- $ref: '#/components/parameters/ibmMqRestCsrfToken'
responses:
'204':
description: Channel deleted successfully
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
components:
schemas:
ChannelCreateRequest:
type: object
required:
- name
- type
properties:
name:
type: string
description: Name of the channel
type:
type: string
enum:
- sender
- receiver
- server
- requester
- serverConnection
- clusterSender
- clusterReceiver
- clientConnection
- amqp
description: Type of channel to create
general:
type: object
properties:
description:
type: string
connectionName:
type: string
transmissionQueue:
type: string
ChannelUpdateRequest:
type: object
properties:
general:
type: object
properties:
description:
type: string
connectionName:
type: string
Channel:
type: object
properties:
name:
type: string
description: Name of the channel
type:
type: string
enum:
- sender
- receiver
- server
- requester
- serverConnection
- clusterSender
- clusterReceiver
- clientConnection
- amqp
description: Type of the channel
general:
type: object
properties:
description:
type: string
description: Description of the channel
connectionName:
type: string
description: Connection name (host/port)
transmissionQueue:
type: string
description: Transmission queue name
status:
type: object
properties:
state:
type: string
enum:
- running
- stopped
- retrying
- binding
- starting
- stopping
- initializing
description: Current channel state
messagesTransferred:
type: integer
description: Number of messages transferred
bytesTransferred:
type: integer
description: Number of bytes transferred
lastMessageTime:
type: string
format: date-time
description: Timestamp of the last message
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
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:
channelName:
name: channelName
in: path
required: true
description: Name of the channel
schema:
type: string
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
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