Anypoint MQ Admin

The Anypoint MQ Admin API provides API access to Anypoint MQ administrative functionality. This API allows you to perform the following actions:

• Browse queues and message exchanges
• Create queues and message exchanges
• Manage bindings for message exchanges
• Manage cross region fallback configuration for standard queues

Getting Started

Before using this API, you should be familiar with the following:

• Queues, message exchanges, and clients. See About Anypoint MQ for more information.

Use this API in conjunction with the following APIs:

• Anypoint MQ Broker API. This API allows clients to publish and receive messages from queues and message exchanges.
• Anypoint MQ Stats API. This API allows users to view statistics for queues and message exchanges.

To access this MQ Admin API, you must first authenticate and obtain a token by using Anypoint Access Management. Typically you would use your Anypoint Platform user credentials to obtain the access token, and then you would use the obtained token to call the MQ Admin API. See examples of this authentication at the Anypoint Access Management link above.

Example MQ Admin API Calls

The following example shows how to retrieve a list of all destinations (queues and exchanges) in an environment. Notice the following variables in the API call:

• The Authorization header includes the bearer token obtained from Anypoint Access Management.
• ORG_ID is the ID of the business group where your queue resides
• ENV_ID is the ID of the environment where your queue resides
• REGION_ID is the region where your queue resides (i.e. us-east-1)

Request:

curl -X GET \
-H 'Authorization: Bearer xxxxxxxx-xxxx-xxxxxx-xxxx-xxxxxxxxxxx' \
'https://anypoint.mulesoft.com/mq/admin/api/v1/organizations/${ORG_ID}/environments/${ENV_ID}/regions/${REGION_ID}/destinations'

Response:

[
  {
    "encrypted": true,
    "type": "queue",
    "queueId": "orders-received",
    "fifo": false,
    "defaultTtl": 604800000,
    "defaultLockTtl": 120000,
    "isFallback": false,
    "fallbackConfig" : {
      "enabled" : true,
      "linkedQueueName" : "orders-received_fb",
      "linkedQueueRegion" : "<fallback region>"
    }
  },
  {
    "encrypted": true,
    "type": "queue",
    "queueId": "orders-processed",
    "fifo": false,
    "defaultTtl": 604800000,
    "defaultLockTtl": 120000
  }
]

Support

Support for this API is provided through the Anypoint Platform Support portal.