Anypoint MQ Admin API

1.0.0

Overview

Statistics
28 Operations
0 Skills
Messaging Category
Manage Anypoint MQ destinations, exchanges, bindings, and client authorizations across environments.

Servers

  • https://anypoint.mulesoft.com/mq/admin/api
  • https://{region}.anypoint.mulesoft.com/mq/admin/api
  • https://{region}.platform.mulesoft.com/mq/admin/api

Authentication & Security

  • oauth_2_0 oauth2

    This API supports OAuth 2.0 for authenticating all API requests.

  • bearerAuth http

    Bearer token authentication using JWT

  • clientAuth oauth2

    OAuth 2.0 client credentials flow

Delete V1Organizations By Organizationid deleteV1OrganizationsByOrganizationid

DELETE

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Delete organization. If you are using connected app, "Administer destinations" and "Manage clients" scope is needed.

Path Parameters

organizationId *: string

Response

The resource has been correctly removed.

Delete V1Organizations By Organizationid Environments By Environmentid deleteV1OrganizationsByOrganizationidEnvironmentsByEnvironmentid

DELETE

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Delete environment. If you are using connected app, "Administer destinations" and "Manage clients" scope is needed.

Path Parameters

organizationId *: string
environmentId *: string

Response

The resource has been correctly removed.

Get V1Organizations By Organizationid Environments By Environmentid Clients getV1OrganizationsByOrganizationidEnvironmentsByEnvironmentidClients

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Gets the list of messaging clients. If you are using connected app, "View clients" or "Manage clients" scope is needed.

Path Parameters

organizationId *: string
environmentId *: string

Response

Successful operation.
Examples
application/json
[ { "name": "CustomerSuccessToSupportClient", "clientId": "123434645645765858", "clientSecret": "asdfgsdfhd32456uerfgd^rtgsDFV" }, { "name": "BillingToFinanceClient", "clientId": "123434645231234348", "clientSecret": "asdfgsdfhdasdfa6uerfgd^rtgsDFV" } ]

Update V1Organizations By Organizationid Environments By Environmentid Clients updateV1OrganizationsByOrganizationidEnvironmentsByEnvironmentidClients

PUT

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Create a messaging client. If you are using connected app, "Manage clients" scope is needed.

Path Parameters

organizationId *: string
environmentId *: string

Request Body

json

Response

Successful operation.

Create V1Organizations By Organizationid Environments By Environmentid Clients By Clientid createV1OrganizationsByOrganizationidEnvironmentsByEnvironmentidClientsByClientid

POST

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Regenerates the client secret. If you are using connected app, "Manage clients" scope is needed.

Path Parameters

organizationId *: string
environmentId *: string
clientId *: string

Response

Successful operation.
Examples
application/json
{ "name": "CustomerSuccessToSupportClient" }

Delete V1Organizations By Organizationid Environments By Environmentid Clients By Clientid deleteV1OrganizationsByOrganizationidEnvironmentsByEnvironmentidClientsByClientid

DELETE

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Deletes a client. If you are using connected app, "Manage clients" scope is needed.

Path Parameters

organizationId *: string
environmentId *: string
clientId *: string

Response

Successful operation.

Get V1Organizations By Organizationid Environments By Environmentid Regions getV1OrganizationsByOrganizationidEnvironmentsByEnvironmentidRegions

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Obtains the valid regions where the service is deployed. If you are using connected app, no specific scope is needed.

Path Parameters

organizationId *: string
environmentId *: string

Response

Successful operation.
Examples
application/json
[ { "regionId": "us-east-1", "serviceUrl": "http://example.domain/api/v1", "fallbackRegion": "us-east-2" }, { "regionId": "us-east-2", "serviceUrl": "http://example.domain/api/v1", "fallbackRegion": "us-west-2" } ]

Get V1Organizations By Organizationid Environments By Environmentid Regions By Regionid getV1OrganizationsByOrganizationidEnvironmentsByEnvironmentidRegionsByRegionid

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Obtains the region entity. If you are using connected app, no specific scope is needed.

Path Parameters

organizationId *: string
environmentId *: string
regionId *: string

Response

Successful operation.
Examples
application/json
[ { "regionId": "us-east-1", "serviceUrl": "http://example.domain/api/v1", "fallbackRegion": "us-east-2" }, { "regionId": "us-east-2", "serviceUrl": "http://example.domain/api/v1", "fallbackRegion": "us-west-2" } ]

Get V1Organizations By Organizationid Environments By Environmentid Regions By Regionid Destinations getV1OrganizationsByOrganizationidEnvironmentsByEnvironmentidRegionsByRegionidDestinations

GET

Try it out

Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Retrieve all the destinations. If you are using connected app, "View destinations" or "Administer destinations" scope is needed.

Path Parameters

organizationId *: string
environmentId *: string
regionId *: string

Query Parameters

destinationType: string
startsWith *: string
offset: integer
inclusion: string
limit: integer

Response

Successful operation.
Examples
application/json
[ { "exchangeId": "myExchangeId", "encrypted": true }, { "queueId": "myQueueId", "defaultTtl": 120000, "defaultLockTtl": 10000, "defaultDeliveryDelay": 0, "encrypted": true, "isFallback": false, "fallbackConfig": { "enabled": true, "linkedQueueName": "myQueueId_fb", "linkedQueueRegion": "<fallback region>" } }, { "queueId": "myQueueId2", "defaultTtl": 120000, "defaultLockTtl": 10000, "defaultDeliveryDelay": 0, "encrypted": true, "isFallback": false } ]

Get V1Organizations By Organizationid Environments By Environmentid Regions By Regionid Destinations Queues By Queueid getV1OrganizationsByOrganizationidEnvironmentsByEnvironmentidRegionsByRegionidDestinationsQueuesByQueueid

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Get the queue with queueId = {queueId}. If you are using connected app, "View destinations" or "Administer destinations" scope is needed.

Path Parameters

organizationId *: string
environmentId *: string
regionId *: string
queueId *: string
The queue ID to identify the target resource.

Response

Successful operation.
Examples
application/json
{ "queueId": "myQueueId", "defaultTtl": 120000, "defaultLockTtl": 10000, "defaultDeliveryDelay": 0, "encrypted": true, "deadLetterQueueId": "<existing_DLQ_name>", "maxDeliveries": 10, "isFallback": false }

Update V1Organizations By Organizationid Environments By Environmentid Regions By Regionid Destinations Queues By Queueid updateV1OrganizationsByOrganizationidEnvironmentsByEnvironmentidRegionsByRegionidDestinationsQueuesByQueueid

PUT

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Add new queue to the broker. This is an idempotent API. If you are using connected app, "Administer destinations" scope is needed.

Path Parameters

organizationId *: string
environmentId *: string
regionId *: string
queueId *: string
The queue ID to identify the target resource.

Request Body

json

Response

Successful operation.
Examples
application/json
{ "queueId": "myQueueId", "defaultTtl": 120000, "defaultLockTtl": 10000, "defaultDeliveryDelay": 0, "encrypted": true, "deadLetterQueueId": "<existing_DLQ_name>", "maxDeliveries": 10, "isFallback": false }

Patch V1Organizations By Organizationid Environments By Environmentid Regions By Regionid Destinations Queues By Queueid patchV1OrganizationsByOrganizationidEnvironmentsByEnvironmentidRegionsByRegionidDestinationsQueuesByQueueid

PATCH

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Updates fields specified; if "maxDeliveries" or "deadLetterQueueId" are not provided the dead letter queue configuration will be removed.
If you are using connected app, "Administer destinations" scope is needed.

Path Parameters

organizationId *: string
environmentId *: string
regionId *: string
queueId *: string
The queue ID to identify the target resource.

Request Body

json

Response

Successful operation.
Examples
application/json
{ "queueId": "myQueueId", "defaultTtl": 120000, "defaultLockTtl": 10000, "defaultDeliveryDelay": 0, "encrypted": true, "deadLetterQueueId": "<existing_DLQ_name>", "maxDeliveries": 10, "isFallback": false }

Delete V1Organizations By Organizationid Environments By Environmentid Regions By Regionid Destinations Queues By Queueid deleteV1OrganizationsByOrganizationidEnvironmentsByEnvironmentidRegionsByRegionidDestinationsQueuesByQueueid

DELETE

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Delete queue from the broker. If you are using connected app, "Administer destinations" scope is needed.

Path Parameters

organizationId *: string
environmentId *: string
regionId *: string
queueId *: string
The queue ID to identify the target resource.

Response

The resource has been correctly removed.

Delete V1Organizations By Organizationid Environments By Environmentid Regions By Regionid Destinations Queues By Queueid Messages deleteV1OrganizationsByOrganizationidEnvironmentsByEnvironmentidRegionsByRegionidDestinationsQueuesByQueueidMessages

DELETE

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Deletes the messages contained in the queue (effectively purging it). The deleted messages cannot be retrieved any more Messages present in the queue prior to this call are deleted; messages sent after this call may also be deleted.
If you are using connected app, "Administer destinations" scope is needed.

Path Parameters

organizationId *: string
environmentId *: string
regionId *: string
queueId *: string
The queue ID to identify the target resource.

Response

The resource has been correctly removed.

Update V1Organizations By Organizationid Environments By Environmentid Regions By Regionid Destinations Queues By Queueid Fallback updateV1OrganizationsByOrganizationidEnvironmentsByEnvironmentidRegionsByRegionidDestinationsQueuesByQueueidFallback

PUT

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Enables or disables cross-region failover configuration for a queue. This configuration is used to evaluate if messages published to or consumed from a queue using Anypoint MQ Connector temporarily redirect to a fallback queue in a fallback region when the primary region is unavailable.<br/><br/>If you are using a connected app, "Administer destinations" scope is required.

Path Parameters

organizationId *: string
environmentId *: string
regionId *: string
queueId *: string
The queue ID to identify the target resource.

Request Body

json
fallbackEnabled *: boolean
Property for turning on or turning off cross region fallback configuration for a queue.

Response

Resource created successfully.
Examples
application/json
{ "queueId": "myQueueId", "isFallback": false, "fallbackConfig": { "enabled": true, "linkedQueueName": "myQueueId_fb", "linkedQueueRegion": "<fallback region>" } }

Get V1Organizations By Organizationid Environments By Environmentid Regions By Regionid Destinations Exchanges By Exchangeid getV1OrganizationsByOrganizationidEnvironmentsByEnvironmentidRegionsByRegionidDestinationsExchangesByExchangeid

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Get the exchange with exchangeId = {exchangeId}. If you are using connected app, "View destinations" or "Administer destinations" scope is needed.

Path Parameters

organizationId *: string
environmentId *: string
regionId *: string
exchangeId *: string
The exchange ID to identify the target resource.

Response

Successful operation.
Examples
application/json
{ "encrypted": true }

Update V1Organizations By Organizationid Environments By Environmentid Regions By Regionid Destinations Exchanges By Exchangeid updateV1OrganizationsByOrganizationidEnvironmentsByEnvironmentidRegionsByRegionidDestinationsExchangesByExchangeid

PUT

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Add new exchange to the broker. If you are using connected app, "Administer destinations" scope is needed.

Path Parameters

organizationId *: string
environmentId *: string
regionId *: string
exchangeId *: string
The exchange ID to identify the target resource.

Request Body

json

Response

Successful operation.
Examples
application/json
{ "encrypted": true }

Patch V1Organizations By Organizationid Environments By Environmentid Regions By Regionid Destinations Exchanges By Exchangeid patchV1OrganizationsByOrganizationidEnvironmentsByEnvironmentidRegionsByRegionidDestinationsExchangesByExchangeid

PATCH

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Modifies the exchange of the broker. If you are using connected app, "Administer destinations" scope is needed.

Path Parameters

organizationId *: string
environmentId *: string
regionId *: string
exchangeId *: string
The exchange ID to identify the target resource.

Request Body

json

Response

Successful operation.
Examples
application/json
{ "encrypted": true }

Delete V1Organizations By Organizationid Environments By Environmentid Regions By Regionid Destinations Exchanges By Exchangeid deleteV1OrganizationsByOrganizationidEnvironmentsByEnvironmentidRegionsByRegionidDestinationsExchangesByExchangeid

DELETE

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Delete the exchange. If you are using connected app, "Administer destinations" scope is needed.

Path Parameters

organizationId *: string
environmentId *: string
regionId *: string
exchangeId *: string
The exchange ID to identify the target resource.

Response

The resource has been correctly removed.

Get V1Organizations By Organizationid Environments By Environmentid Regions By Regionid Bindings Exchanges By Exchangeid getV1OrganizationsByOrganizationidEnvironmentsByEnvironmentidRegionsByRegionidBindingsExchangesByExchangeid

GET

Try it out

Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Gathers all the queues bound to exchange. If you are using connected app, "View destinations" or "Administer destinations" scope is needed.

Path Parameters

organizationId *: string
environmentId *: string
regionId *: string
exchangeId *: string
The exchange ID to identify the target resource.

Query Parameters

inclusion: string
offset: integer
limit: integer
startsWith *: string

Response

Successful operation.
Examples
application/json
[ { "queueId": "myQueueId", "exchangeId": "myExchangeId" } ]

Get V1Organizations By Organizationid Environments By Environmentid Regions By Regionid Bindings Exchanges By Exchangeid Queues By Queueid getV1OrganizationsByOrganizationidEnvironmentsByEnvironmentidRegionsByRegionidBindingsExchangesByExchangeidQueuesByQueueid

GET

Try it out

Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Gathers the existence of a specific binding. If you are using connected app, "View destinations" or "Administer destinations" scope is needed.

Path Parameters

exchangeId *: string
The exchange ID to identify the target resource.
queueId *: string
The queue ID to identify the target resource.
environmentId *: string
organizationId *: string
regionId *: string

Query Parameters

inclusion: string

Response

The requested resource in the form it is requested is not found on this broker.

Update V1Organizations By Organizationid Environments By Environmentid Regions By Regionid Bindings Exchanges By Exchangeid Queues By Queueid updateV1OrganizationsByOrganizationidEnvironmentsByEnvironmentidRegionsByRegionidBindingsExchangesByExchangeidQueuesByQueueid

PUT

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Creates a binding between a message exchange and a queue. If you are using connected app, "Administer destinations" scope is needed.

Path Parameters

exchangeId *: string
The exchange ID to identify the target resource.
queueId *: string
The queue ID to identify the target resource.
environmentId *: string
organizationId *: string
regionId *: string

Response

The requested resource in the form it is requested is not found on this broker.

Delete V1Organizations By Organizationid Environments By Environmentid Regions By Regionid Bindings Exchanges By Exchangeid Queues By Queueid deleteV1OrganizationsByOrganizationidEnvironmentsByEnvironmentidRegionsByRegionidBindingsExchangesByExchangeidQueuesByQueueid

DELETE

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Deletes this binding. If you are using connected app, "Administer destinations" scope is needed.

Path Parameters

exchangeId *: string
The exchange ID to identify the target resource.
queueId *: string
The queue ID to identify the target resource.
environmentId *: string
organizationId *: string
regionId *: string

Response

The resource has been correctly removed.

Update V1Organizations By Organizationid Environments By Environmentid Regions By Regionid Bindings Exchanges By Exchangeid Queues By Queueid Rules Routing updateV1OrganizationsByOrganizationidEnvironmentsByEnvironmentidRegionsByRegionidBindingsExchangesByExchangeidQueuesByQueueidRulesRouting

PUT

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Creates a routing rule on a binding between a message exchange and a queue. This rule is used to evaluate if a message published to an exchange should be forwarded to a specific queue. <br/><br/>This will override existing routing rules on the binding with the new rules specified in this request.
If you are using connected app, "Administer destinations" scope is needed.

Path Parameters

exchangeId *: string
The exchange ID to identify the target resource.
queueId *: string
The queue ID to identify the target resource.
environmentId *: string
organizationId *: string
regionId *: string

Request Body

json
routingRules: array

Response

Resource created successfully.
Examples
application/json
{ "queueId": "new-orders", "exchangeId": "orders-processing", "routingRules": [ { "propertyName": "Order Number", "propertyType": "NUMERIC", "matcherType": "GT", "value": 1009 } ] }

Delete V1Organizations By Organizationid Environments By Environmentid Regions By Regionid Bindings Exchanges By Exchangeid Queues By Queueid Rules Routing deleteV1OrganizationsByOrganizationidEnvironmentsByEnvironmentidRegionsByRegionidBindingsExchangesByExchangeidQueuesByQueueidRulesRouting

DELETE

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Deleted routing rules on a binding between a message exchange and queue. If you are using connected app, "Administer destinations" scope is needed.

Path Parameters

exchangeId *: string
The exchange ID to identify the target resource.
queueId *: string
The queue ID to identify the target resource.
environmentId *: string
organizationId *: string
regionId *: string

Response

Successfully deleted or routing rules don't exist.

Get V1Organizations By Organizationid Environments By Environmentid Regions By Regionid Bindings Queues By Queueid getV1OrganizationsByOrganizationidEnvironmentsByEnvironmentidRegionsByRegionidBindingsQueuesByQueueid

GET

Try it out

Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Gathers all the exchanges bound to the queue. If you are using connected app, "View destinations" or "Administer destinations" scope is needed.

Path Parameters

organizationId *: string
environmentId *: string
regionId *: string
queueId *: string
The queue ID to identify the target resource.

Query Parameters

inclusion: string
offset: integer
limit: integer
startsWith *: string

Response

Successful operation.
Examples
application/json
[ { "queueId": "myQueueId", "exchangeId": "myExchangeId" } ]

Create V1Authorize createV1Authorize

POST

Try it out

Custom Query Parameters
Custom Headers
Request Body application/x-www-form-urlencoded
Obtains an access token using client credentials of the OAuth grant type. This API is not supported with connected apps.

Request Body

x-www-form-urlencoded

Response

Successful operation.
Examples
application/json
{ "access_token": "aaaaaaa-bbbb-cccc-dddd-eeeeee", "token_type": "bearer" }

Patch V2Organizations By Organizationid Environments By Environmentid Regions By Regionid Destinations Queues By Queueid patchV2OrganizationsByOrganizationidEnvironmentsByEnvironmentidRegionsByRegionidDestinationsQueuesByQueueid

PATCH

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Updates only the fields specified, "maxDeliveries" and "deadLetterQueueId" must be consistent.

Path Parameters

organizationId *: string
environmentId *: string
regionId *: string
The region ID to identify the target resource.
queueId *: string
The queue ID to identify the target resource.

Request Body

json

Response

Successful operation.