This article contains a list of REST API commands that pertain to IBM MQ channels.
For a walk-through of the Navigator REST API using the demo site, see Using the REST API using the Navigator demo system. No installation is required. The article Performing REST API operations using the Swagger UI includes three detailed examples, as well as instructions for issuing plain text or JSON-formatted MQSC Commands through the REST API.
|
Jump ahead: |
Read IBM MQ Channel Authority Records
GET /ibmmq/channels/{nodeName}/{qmgrName}/{type}/{channelName}/auth-recs
Purpose: Lists channel authority records for the channel.
Curl example
curl -X GET "http://jenkins.nastel.com:8019/rest/v1/ibmmq/channels/LEUNAME/LEUNAME/Cluster-Sender/TO.QA/auth-recs" -H "accept: application/json" -H "Authorization: Basic QWRtaW46YWRtaW4="
Example Response
{
"authRecs": [
{
"objectType": "channel",
"objectName": "TO.QA",
"principalName": "SYSTEM@NT AUTHORITY",
"auths": [
"chg",
"dlt",
"dsp",
"ctrl",
"ctrlx"
]
},
{
"objectType": "channel",
"objectName": "TO.QA",
"groupName": "mqm@LEUNAME",
"auths": [
"chg",
"dlt",
"dsp",
"ctrl",
"ctrlx"
]
}
],
"overallCompletionCode": 0,
"overallReasonCode": 0
}
Read Channel Data
GET /ibmmq/channels/{nodeName}/{qmgrName}/{type}/{channelName}
Purpose: Lists properties of the specified channel.
Curl example
curl -X GET "http://jenkins.nastel.com:8019/rest/v1/ibmmq/channels/LEUNAME/LEUNAME/Cluster-Sender/TO.QA?attributes=general.%2A%2Cextended.%2A" -H "accept: application/json" -H "Authorization: Basic QWRtaW46YWRtaW4="
Example Response
{
"wgsName": "MQM",
"nodeName": "LEUNAME",
"qmgrName": "LEUNAME",
"name": "TO.QA",
"type": "Cluster-Sender",
"general": {
"description": "",
"xmitProtocolType": "TCP",
"connectionName": "LEUNAME(1414)",
"localAddress": "",
"xmitQName": "SYSTEM.CLUSTER.TRANSMIT.QUEUE",
"qsgDisp": "QMgr"
},
"extended": {
"maxMsgLength": 4194304,
"sharingConvers": 0,
"sequenceWrap": 999999999,
"discInterval": 6000,
"heartbeatInterval": 300,
"batchHeartbeat": 0,
"batchSize": 50,
"batchInterval": 0,
"batchDataLimit": 5000,
"keepAlive": -1,
"npmSpeed": "Fast",
"dataConversion": "Disabled",
"maxInstances": 0,
"maxInstsPerClient": 0,
"propertyControl": "Compatibility",
"useDeadLetterQ": "Yes"
}
Search Channels
GET /ibmmq/channels
Purpose: Lists channels for the queue manager(s) (if specified) and node(s) (if specified).
Curl example
curl -X GET "http://jenkins.nastel.com:8019/rest/v1/ibmmq/channels?nodeName=LEUNAME&qmgrName=TESTQM%2A&channelName=%2A" -H "accept: application/json" -H "Authorization: Basic QWRtaW46YWRtaW4="
Example Response
[
{
"wgsName": "MQM",
"nodeName": "LEUNAME",
"qmgrName": "TESTQM1",
"name": "SYSTEM.DEF.CLUSRCVR",
"type": "Cluster-Receiver"
},
{
"wgsName": "MQM",
"nodeName": "LEUNAME",
"qmgrName": "TESTQM3",
"name": "SYSTEM.DEF.CLUSRCVR",
"type": "Cluster-Receiver"
},
{
"wgsName": "MQM",
"nodeName": "LEUNAME",
"qmgrName": "TESTQM1",
"name": "SYSTEM.DEF.CLUSSDR",
"type": "Cluster-Sender"
},
{
"wgsName": "MQM",
"nodeName": "LEUNAME",
"qmgrName": "TESTQM3",
"name": "SYSTEM.DEF.CLUSSDR",
"type": "Cluster-Sender"
},
{
"wgsName": "MQM",
"nodeName": "LEUNAME",
"qmgrName": "TESTQM1",
"name": "SYSTEM.AUTO.RECEIVER",
"type": "Receiver"
},
{
"wgsName": "MQM",
"nodeName": "LEUNAME",
"qmgrName": "TESTQM3",
"name": "SYSTEM.AUTO.RECEIVER",
"type": "Receiver"
},
{
"wgsName": "MQM",
"nodeName": "LEUNAME",
"qmgrName": "TESTQM1",
"name": "SYSTEM.DEF.RECEIVER",
"type": "Receiver"
},
{
"wgsName": "MQM",
"nodeName": "LEUNAME",
"qmgrName": "TESTQM3",
"name": "SYSTEM.DEF.RECEIVER",
"type": "Receiver"
},
{
"wgsName": "MQM",
"nodeName": "LEUNAME",
"qmgrName": "TESTQM1",
"name": "SYSTEM.DEF.REQUESTER",
"type": "Requester"
},
{
"wgsName": "MQM",
"nodeName": "LEUNAME",
"qmgrName": "TESTQM3",
"name": "SYSTEM.DEF.REQUESTER",
"type": "Requester"
},
{
"wgsName": "MQM",
"nodeName": "LEUNAME",
"qmgrName": "TESTQM1",
"name": "SYSTEM.DEF.SENDER",
"type": "Sender"
},
{
"wgsName": "MQM",
"nodeName": "LEUNAME",
"qmgrName": "TESTQM3",
"name": "SYSTEM.DEF.SENDER",
"type": "Sender"
},
{
"wgsName": "MQM",
"nodeName": "LEUNAME",
"qmgrName": "TESTQM1",
"name": "SYSTEM.DEF.SERVER",
"type": "Server"
},
{
"wgsName": "MQM",
"nodeName": "LEUNAME",
"qmgrName": "TESTQM3",
"name": "SYSTEM.DEF.SERVER",
"type": "Server"
},
{
"wgsName": "MQM",
"nodeName": "LEUNAME",
"qmgrName": "TESTQM1",
"name": "SYSTEM.AUTO.SVRCONN",
"type": "Server-Connection"
},
{
"wgsName": "MQM",
"nodeName": "LEUNAME",
"qmgrName": "TESTQM3",
"name": "SYSTEM.AUTO.SVRCONN",
"type": "Server-Connection"
},
{
"wgsName": "MQM",
"nodeName": "LEUNAME",
"qmgrName": "TESTQM1",
"name": "SYSTEM.DEF.SVRCONN",
"type": "Server-Connection"
},
{
"wgsName": "MQM",
"nodeName": "LEUNAME",
"qmgrName": "TESTQM3",
"name": "SYSTEM.DEF.SVRCONN",
"type": "Server-Connection"
},
{
"wgsName": "MQM",
"nodeName": "LEUNAME",
"qmgrName": "TESTQM1",
"name": "SYSTEM.DEF.AMQP",
"type": "AMQP"
},
{
"wgsName": "MQM",
"nodeName": "LEUNAME",
"qmgrName": "TESTQM3",
"name": "SYSTEM.DEF.AMQP",
"type": "AMQP"
},
{
"wgsName": "MQM",
"nodeName": "LEUNAME",
"qmgrName": "TESTQM1",
"name": "SYSTEM.DEF.CLNTCONN",
"type": "Client-Connection"
},
{
"wgsName": "MQM",
"nodeName": "LEUNAME",
"qmgrName": "TESTQM3",
"name": "SYSTEM.DEF.CLNTCONN",
"type": "Client-Connection"
}
]
Force Update Channel
PATCH /ibmmq/channels/{nodeName}/{qmgrName}/{type}/{channelName}/force-update
Purpose:
Curl example
curl -X PATCH "http://jenkins.nastel.com:8019/rest/v1/ibmmq/channels/LEUNAME/TESTQM3/Client-Connection/SYSTEM.DEF.CLNTCONN/force-update" -H "accept: */*" -H "Authorization: Basic QWRtaW46YWRtaW4="
Example Response
Code: 204 (Object Changed)
Response headers:
date: Fri, 31 Dec 2021 17:25:56 GMT
server: Jetty(9.4.28.v20200408)