IBM MQ REST API

Name: IBM MQ REST API API
Brand: IBM MQ REST API
Availability: InStock

✓ Official Vendor SpecCommunicationsChat MessagingapiKey, basic, bearer14 EndpointsREST

For Agents

Administer IBM MQ queue managers, queues, channels, and subscriptions, and put or get messages on a queue over HTTPS — without an MQ client.

Connect the IBM MQ REST API to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the IBM MQ REST API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Install Jentic One Beta (Self-Hosted)

Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh

Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh
jentic register       # connects your agent to your Jentic One instance

Jentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.

Capabilities

What an agent can do with IBM MQ REST API API.

Administer queue managers via /v2/admin/qmgr and /v2/admin/qmgr/{qmgrName}

Manage queues on a queue manager via /v2/admin/qmgr/{qmgrName}/queue

Configure channels and subscriptions via /v2/admin/qmgr/{qmgrName}/channel and /subscription

Put or get messages on a named queue via /v2/messaging/qmgr/{qmgrName}/queue/{queueName}/message

GET STARTED

Start building with IBM MQ REST API API

Explore with Jentic

View OpenAPI Document

IBM MQ is the enterprise message-oriented middleware that backs many bank, insurance, and supply-chain integrations, and the IBM MQ REST API exposes administration and messaging operations over HTTPS so that systems without a native MQ client can still participate. The spec covers queue manager, queue, channel, and subscription administration, plus a messaging endpoint for putting and getting messages on a named queue. It is suited to teams that need to drive MQ from cloud-native services, browsers, or AI agents that cannot bundle the MQ client libraries.

Use Cases

Patterns agents use IBM MQ REST API API for, with concrete tasks.

★ Cloud-Native MQ Producer

Send messages onto an IBM MQ queue from a service that cannot run the MQ client libraries — a serverless function, a browser, or an AI agent — by POSTing to /v2/messaging/qmgr/{qmgrName}/queue/{queueName}/message. This makes it possible to bridge cloud-native systems into a bank or insurer's existing MQ-based messaging backbone without distributing native binaries.

POST a JSON message body to /v2/messaging/qmgr/QM1/queue/ORDERS.IN/message with content type application/json and the order payload.

Queue Administration

Inspect and configure queues, channels, and subscriptions on a queue manager from an external automation tool. The API exposes admin endpoints under /v2/admin/qmgr/{qmgrName}/* so an operator or agent can list queues, create new ones, and audit channel configuration without using the MQ Explorer UI.

GET /v2/admin/qmgr/QM1/queue and return the list of queues whose name starts with PAYMENTS.

Cross-System Bridging

Use the REST messaging endpoint as a bridge between MQ and HTTP-only systems — for example, drop messages onto MQ when a webhook fires, or read MQ messages and forward them to a Slack channel. Because the API speaks HTTPS, it integrates cleanly into iPaaS tools and Jentic-driven agents.

GET a single message from /v2/messaging/qmgr/QM1/queue/ALERTS/message and post the message body to a configured Slack channel.

AI Agent Messaging Operator

An AI agent uses Jentic to enqueue messages on MQ as part of a larger workflow — for example, submitting a payment instruction onto a banking system's intake queue. The agent searches by intent, loads the messaging schema, and executes the call, never holding the raw MQ credentials. Typical agent integration is under one hour because the messaging surface is small and well-scoped.

Search Jentic for 'put a message on an IBM MQ queue', load the /v2/messaging/qmgr/{qmgrName}/queue/{queueName}/message schema, and submit the payment instruction.

Key Endpoints

14 endpoints — ibm mq is the enterprise message-oriented middleware that backs many bank, insurance, and supply-chain integrations, and the ibm mq rest api exposes administration and messaging operations over https so that systems without a native mq client can still participate.

METHOD

PATH

DESCRIPTION

GET

/v2/admin/qmgr

List queue managers

GET

/v2/admin/qmgr/{qmgrName}/queue

List queues on a queue manager

GET

/v2/admin/qmgr/{qmgrName}/channel

List channels on a queue manager

POST

/v2/messaging/qmgr/{qmgrName}/queue/{queueName}/message

Put a message on a queue

DELETE

/v2/messaging/qmgr/{qmgrName}/queue/{queueName}/message

Get and remove the next message

POST

/v1/login

Establish a REST session

POST

/v1/logout

End a REST session

GET

/v2/admin/qmgr

List queue managers

GET

/v2/admin/qmgr/{qmgrName}/queue

List queues on a queue manager

GET

/v2/admin/qmgr/{qmgrName}/channel

List channels on a queue manager

POST

/v2/messaging/qmgr/{qmgrName}/queue/{queueName}/message

Put a message on a queue

DELETE

/v2/messaging/qmgr/{qmgrName}/queue/{queueName}/message

Get and remove the next message

Why though Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

MQ basic auth, bearer tokens, or LtpaToken2 cookies are stored encrypted in the Jentic vault. Agents authenticate to MQ through scoped Jentic credentials and never receive the raw token or cookie in their context.

Intent-based discovery

Agents search by intent (for example 'put a message on an IBM MQ queue') and Jentic returns the matching MQ operation with its parameter schema, so the agent does not have to read the MQ administration reference.

Time to first call

Direct IBM MQ integration: 3-7 days when the consumer cannot run the native MQ client. Through Jentic: under one hour — search, load schema, execute.

Related APIs

Alternatives and complements available in the Jentic catalogue.

Complementary

IBM MQ Cloud API

MQ Cloud provisions and manages cloud-hosted queue managers; the MQ REST API operates on the queue manager once it exists.

Use MQ Cloud to provision a queue manager on IBM Cloud. Use the MQ REST API to administer or send messages to that queue manager at runtime.

Alternative

Azure Service Bus Management API

Azure Service Bus is a cloud-native enterprise messaging service; IBM MQ is the on-premises and IBM Cloud equivalent.

Choose Azure Service Bus for new cloud-native messaging on Azure. Choose IBM MQ when the organisation already runs MQ as its messaging backbone.

Alternative

Confluent Kafka API

Confluent Kafka is a streaming platform with topic-based pub/sub; IBM MQ is a queue-based enterprise messaging system.

Choose Confluent for high-throughput event streaming. Choose IBM MQ for guaranteed-delivery, transactional messaging in established enterprise estates.

FAQs

Specific to using IBM MQ REST API API through Jentic.

What authentication does the IBM MQ REST API use?

The MQ REST API supports three schemes: an LtpaToken2 cookie set by /v1/login, HTTP basic authentication, and HTTP bearer authentication. Through Jentic, the chosen credentials are stored in the Jentic vault and the agent calls MQ via a scoped Jentic credential.

Can I put a message on an IBM MQ queue with this API?

Yes. POST the message payload to /v2/messaging/qmgr/{qmgrName}/queue/{queueName}/message. The endpoint accepts both text and JSON payloads and writes them onto the named queue without requiring a native MQ client.

How do I get the next message off a queue?

DELETE /v2/messaging/qmgr/{qmgrName}/queue/{queueName}/message returns and removes the next available message from the queue. The destructive read pattern matches the MQ get-with-remove semantics used by traditional MQ clients.

How do I send a message to IBM MQ through Jentic?

Search Jentic for 'put a message on an IBM MQ queue', load the /v2/messaging/qmgr/{qmgrName}/queue/{queueName}/message schema, and execute. Install the SDK with pip install jentic and use the async search, load, execute pattern from Python.

Can I administer queue managers and queues over the REST API?

Yes. The /v2/admin/qmgr endpoints cover queue manager listing and inspection, /v2/admin/qmgr/{qmgrName}/queue covers queue administration, and /v2/admin/qmgr/{qmgrName}/channel and /subscription cover channels and topic subscriptions.

What are the rate limits for the IBM MQ REST API?

IBM MQ does not enforce a fixed REST rate limit; throughput depends on the queue manager configuration, channel limits, and the deployment topology. Treat HTTP 429 and 503 as backpressure and retry with exponential backoff.