REST API resources

This collection of topics provides reference information for each of the administrative REST API resources.

For more information about using the administrative REST API, see Administration using the REST API.

For more information about configuring the administrative REST API, see Configure the REST API.

For more information about securing the administrative REST API, see Securing the REST API.

• /admin/action/qmgr/{qmgrName}/mqsc
  We can use the HTTP POST method with the /admin/action/qmgr/{qmgrName}/mqsc resource to execute an arbitrary MQSC command on a queue manager.
• /admin/installation
  We can use the HTTP GET method with the installation resource to request information about installations.
• /login
  We can use the HTTP GET method together with the login resource to get information about the user that is logged in to the REST API. We can use the HTTP POST method to log in a user and get an LTPA token. We can use the HTTP DELETE method to log out a user and end the session.
• /admin/qmgr
  We can use the HTTP GET method with the qmgr resource to request information about queue managers, including status information.
• /admin/mft/agent
  We can use the HTTP GET method with the agent resource, to request information about the status of agents, and other attribute details.
• /admin/mft/transfer
  We can use the HTTP GET method with the transfer resource, to request information about transfers, and other status details, and the HTTP POST method with the transfer resource, to put a transfer request message in the command queue manager, which will be routed to the source agent queue manager.
• /admin/mft/monitor
  We can use the HTTP GET method with the list resource monitor resource, to list information about the MFT resource monitor status, and other configuration information. We can use the the HTTP POST method to create a resource monitor and the HTTP DELETE method to delete a resource monitor.
• /admin/qmgr/{qmgrName}/channel
  We can use the HTTP GET method with the channel resource to request information about channels.
• /admin/qmgr/{qmgrName}/queue
  We can use the HTTP GET method with the queue resource to request information about queues. We can use the HTTP POST method to create queues, the PATCH method to modify queues, and the DELETE method to delete queues.
• /admin/qmgr/{qmgrName}/subscription
  We can use the HTTP GET method with the subscription resource to request information about subscriptions.

Parent topic: Administrative REST API reference