IBM MQ Cloud API

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

✓ Official Vendor SpecCloud InfrastructureComputebearer11 EndpointsREST

For Agents

Provision and manage IBM MQ queue managers on IBM Cloud — create, configure, monitor, and tear down queue managers and their attached users and applications.

Connect the IBM MQ Cloud API to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the IBM MQ Cloud 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 Cloud API API.

Provision and tear down queue managers via /{serviceInstanceGuid}/queue_managers

Inspect queue manager status via /{serviceInstanceGuid}/queue_managers/{queueManagerId}/status

Manage users on a service instance via /{serviceInstanceGuid}/users

Manage applications attached to a service instance via /{serviceInstanceGuid}/applications

GET STARTED

Start building with IBM MQ Cloud API API

Explore with Jentic

View OpenAPI Document

IBM MQ on Cloud is the managed offering of IBM MQ that runs queue managers as a service on IBM Cloud, removing the need to operate the underlying virtual machines or storage. The MQ Cloud API exposes provisioning and management operations for queue managers, queue manager users, and applications attached to a service instance, so platform teams can spin up and tear down MQ environments through automation rather than the IBM Cloud console. It is suited to teams treating MQ as ephemeral or environment-scoped infrastructure.

Use Cases

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

★ Environment Provisioning

Stand up a queue manager per environment (dev, staging, prod) on IBM MQ on Cloud as part of a broader infrastructure pipeline. POST to /{serviceInstanceGuid}/queue_managers to create the queue manager, then poll /{serviceInstanceGuid}/queue_managers/{queueManagerId}/status until it reaches a running state. Tear it down with DELETE on the same resource at the end of the environment lifecycle.

POST a new queue manager named QM_DEV to /{serviceInstanceGuid}/queue_managers, then poll /status every 30 seconds until it returns running.

Queue Manager User Management

Provision queue manager users with the right role for an application or human operator. POST to /{serviceInstanceGuid}/users to add a user, then list /{serviceInstanceGuid}/users to confirm membership. This is the auth surface that pairs with downstream IBM MQ REST API messaging calls against the same queue manager.

Create a user named app_orders on /{serviceInstanceGuid}/users with the messaging role and confirm by listing the users on the service instance.

Application Registration

Register an application with a service instance so it can connect to the queue manager with a known identity. The /{serviceInstanceGuid}/applications endpoint covers create and list operations, which makes it possible to script application onboarding alongside the queue manager itself rather than configuring it manually after provisioning.

POST a new application named order-service to /{serviceInstanceGuid}/applications and verify it is listed for the service instance.

AI Agent Cloud MQ Operator

An AI agent uses Jentic to provision queue managers on demand for short-lived test environments, then tears them down when the test completes. Through Jentic, the agent searches by intent, loads the queue manager creation schema, and executes calls without holding the raw IAM bearer token. Typical agent integration is under one hour because the provisioning surface has only a handful of resources.

Search Jentic for 'create a queue manager on IBM MQ Cloud', load the schema, and create a queue manager named QM_TEST_RUN_42.

Key Endpoints

11 endpoints — ibm mq on cloud is the managed offering of ibm mq that runs queue managers as a service on ibm cloud, removing the need to operate the underlying virtual machines or storage.

METHOD

PATH

DESCRIPTION

GET

/{serviceInstanceGuid}/queue_managers

List queue managers on a service instance

POST

/{serviceInstanceGuid}/queue_managers

Provision a new queue manager

GET

/{serviceInstanceGuid}/queue_managers/{queueManagerId}

Get a queue manager by ID

GET

/{serviceInstanceGuid}/queue_managers/{queueManagerId}/status

Get queue manager status

GET

/{serviceInstanceGuid}/users

List service instance users

GET

/{serviceInstanceGuid}/applications

List service instance applications

GET

/{serviceInstanceGuid}/queue_managers

List queue managers on a service instance

POST

/{serviceInstanceGuid}/queue_managers

Provision a new queue manager

GET

/{serviceInstanceGuid}/queue_managers/{queueManagerId}

Get a queue manager by ID

GET

/{serviceInstanceGuid}/queue_managers/{queueManagerId}/status

Get queue manager status

GET

/{serviceInstanceGuid}/users

List service instance users

Why though Jentic?

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

Credential isolation

IBM Cloud IAM bearer tokens are stored encrypted in the Jentic vault. Agents call MQ Cloud through scoped Jentic credentials and never see the raw IAM token in their context.

Intent-based discovery

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

Time to first call

Direct MQ Cloud integration: 1-3 days for IAM token exchange and provisioning polling. Through Jentic: under one hour — search, load schema, execute.

Related APIs

Alternatives and complements available in the Jentic catalogue.

Complementary

IBM MQ REST API

MQ Cloud provisions queue managers; the IBM MQ REST API administers and sends messages to those queue managers.

Use MQ Cloud to create a queue manager. Use the MQ REST API to send messages to that queue manager once it is running.

Alternative

Azure Service Bus Management API

Azure Service Bus is a fully-managed cloud messaging service; MQ Cloud is the IBM-platform equivalent.

Choose Azure Service Bus on Azure-centric platforms. Choose IBM MQ Cloud when the organisation standardises on IBM Cloud and MQ semantics.

Complementary

IBM API Connect Management API

API Connect publishes the APIs that may be backed by services running on IBM MQ Cloud.

Use API Connect to publish a managed API. Use MQ Cloud to provide the messaging backbone behind that API.

FAQs

Specific to using IBM MQ Cloud API API through Jentic.

What authentication does the IBM MQ Cloud API use?

The MQ Cloud API uses HTTP bearer authentication with an IBM Cloud IAM token. Through Jentic, the IAM credential is stored in the Jentic vault and the agent calls MQ Cloud via a scoped Jentic credential, never the raw IAM token.

Can I provision a queue manager with this API?

Yes. POST to /{serviceInstanceGuid}/queue_managers to create a queue manager on a given service instance, then poll /{serviceInstanceGuid}/queue_managers/{queueManagerId}/status until the queue manager reaches a running state.

How do I manage queue manager users and applications?

Use /{serviceInstanceGuid}/users to manage the human and service users on a queue manager and /{serviceInstanceGuid}/applications to register applications. The two together cover the identity surface the runtime MQ REST API expects.

How do I provision MQ Cloud through Jentic?

Search Jentic for 'create a queue manager on IBM MQ Cloud', load the /{serviceInstanceGuid}/queue_managers schema, and execute. Install the SDK with pip install jentic and run the async search, load, execute pattern.

Is the IBM MQ Cloud API the same as the IBM MQ REST API?

No. The MQ Cloud API provisions and manages queue managers as a managed service, while the IBM MQ REST API operates on a queue manager that already exists — administering queues and channels, and putting or getting messages.

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

IBM Cloud applies account-level IAM-protected rate limits rather than a published per-endpoint limit. Treat 429 responses as backpressure and retry with exponential backoff, particularly when polling status endpoints during provisioning.