# Anypoint MQ Admin API

Manage Anypoint MQ destinations, exchanges, bindings, and client authorizations across environments.

- **Version:** 1.0.0
- **Category:** Messaging
- **OpenAPI Spec:** [api.yaml](https://dev-portal.mulesoft.com/apis/anypoint-mq-admin/api.yaml)

## Servers
- `https://anypoint.mulesoft.com/mq/admin/api`
- `https://{region}.anypoint.mulesoft.com/mq/admin/api`
- `https://{region}.platform.mulesoft.com/mq/admin/api`

## Operations (28)
### DELETE /v1/organizations/{organizationId}

**Operation ID:** `deleteV1OrganizationsByOrganizationid`
Delete organization. If you are using connected app, "Administer destinations" and "Manage clients" scope is needed.


**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |

### DELETE /v1/organizations/{organizationId}/environments/{environmentId}

**Operation ID:** `deleteV1OrganizationsByOrganizationidEnvironmentsByEnvironmentid`
Delete environment. If you are using connected app, "Administer destinations" and "Manage clients" scope is needed.


**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `environmentId` | query | The environment ID to identify the target resource. | required |

### GET /v1/organizations/{organizationId}/environments/{environmentId}/clients

**Operation ID:** `getV1OrganizationsByOrganizationidEnvironmentsByEnvironmentidClients`
Gets the list of messaging clients. If you are using connected app, "View clients" or "Manage clients" scope is needed.


**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `environmentId` | query | The environment ID to identify the target resource. | required |

### PUT /v1/organizations/{organizationId}/environments/{environmentId}/clients

**Operation ID:** `updateV1OrganizationsByOrganizationidEnvironmentsByEnvironmentidClients`
Create a messaging client. If you are using connected app, "Manage clients" scope is needed.


**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `environmentId` | query | The environment ID to identify the target resource. | required |

### POST /v1/organizations/{organizationId}/environments/{environmentId}/clients/{clientId}

**Operation ID:** `createV1OrganizationsByOrganizationidEnvironmentsByEnvironmentidClientsByClientid`
Regenerates the client secret. If you are using connected app, "Manage clients" scope is needed.


**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `environmentId` | query | The environment ID to identify the target resource. | required |
| `clientId` | query | The unique identifier of the client application. | required |

### DELETE /v1/organizations/{organizationId}/environments/{environmentId}/clients/{clientId}

**Operation ID:** `deleteV1OrganizationsByOrganizationidEnvironmentsByEnvironmentidClientsByClientid`
Deletes a client. If you are using connected app, "Manage clients" scope is needed.


**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `environmentId` | query | The environment ID to identify the target resource. | required |
| `clientId` | query | The unique identifier of the client application. | required |

### GET /v1/organizations/{organizationId}/environments/{environmentId}/regions

**Operation ID:** `getV1OrganizationsByOrganizationidEnvironmentsByEnvironmentidRegions`
Obtains the valid regions where the service is deployed. If you are using connected app, no specific scope is needed.


**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `environmentId` | query | The environment ID to identify the target resource. | required |

### GET /v1/organizations/{organizationId}/environments/{environmentId}/regions/{regionId}

**Operation ID:** `getV1OrganizationsByOrganizationidEnvironmentsByEnvironmentidRegionsByRegionid`
Obtains the region entity. If you are using connected app, no specific scope is needed.


**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `environmentId` | query | The environment ID to identify the target resource. | required |
| `regionId` | query | The region ID to identify the target resource. | required |

### GET /v1/organizations/{organizationId}/environments/{environmentId}/regions/{regionId}/destinations

**Operation ID:** `getV1OrganizationsByOrganizationidEnvironmentsByEnvironmentidRegionsByRegionidDestinations`
Retrieve all the destinations. If you are using connected app, "View destinations" or "Administer destinations" scope is needed.

**Parameters:**
| `destinationType` | query | Defines what to fetch | optional |
| `startsWith` | query | Searchs the field from the left using the passed string.
 | required |
| `offset` | query | Skip over a number of elements by specifying an offset value for the query. | optional |
| `inclusion` | query | Defines what to fetch | optional |
| `limit` | query | Limit the number of elements in the response. | optional |
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `environmentId` | query | The environment ID to identify the target resource. | required |
| `regionId` | query | The region ID to identify the target resource. | required |

### GET /v1/organizations/{organizationId}/environments/{environmentId}/regions/{regionId}/destinations/queues/{queueId}

**Operation ID:** `getV1OrganizationsByOrganizationidEnvironmentsByEnvironmentidRegionsByRegionidDestinationsQueuesByQueueid`
Get the queue with queueId = {queueId}. If you are using connected app, "View destinations" or "Administer destinations" scope is needed.


**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `environmentId` | query | The environment ID to identify the target resource. | required |
| `regionId` | query | The region ID to identify the target resource. | required |
| `queueId` | query | The queue ID to identify the target resource. | required |

### PUT /v1/organizations/{organizationId}/environments/{environmentId}/regions/{regionId}/destinations/queues/{queueId}

**Operation ID:** `updateV1OrganizationsByOrganizationidEnvironmentsByEnvironmentidRegionsByRegionidDestinationsQueuesByQueueid`
Add new queue to the broker. This is an idempotent API. If you are using connected app, "Administer destinations" scope is needed.


**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `environmentId` | query | The environment ID to identify the target resource. | required |
| `regionId` | query | The region ID to identify the target resource. | required |
| `queueId` | query | The queue ID to identify the target resource. | required |

### PATCH /v1/organizations/{organizationId}/environments/{environmentId}/regions/{regionId}/destinations/queues/{queueId}

**Operation ID:** `patchV1OrganizationsByOrganizationidEnvironmentsByEnvironmentidRegionsByRegionidDestinationsQueuesByQueueid`
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.


**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `environmentId` | query | The environment ID to identify the target resource. | required |
| `regionId` | query | The region ID to identify the target resource. | required |
| `queueId` | query | The queue ID to identify the target resource. | required |

### DELETE /v1/organizations/{organizationId}/environments/{environmentId}/regions/{regionId}/destinations/queues/{queueId}

**Operation ID:** `deleteV1OrganizationsByOrganizationidEnvironmentsByEnvironmentidRegionsByRegionidDestinationsQueuesByQueueid`
Delete queue from the broker. If you are using connected app, "Administer destinations" scope is needed.


**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `environmentId` | query | The environment ID to identify the target resource. | required |
| `regionId` | query | The region ID to identify the target resource. | required |
| `queueId` | query | The queue ID to identify the target resource. | required |

### DELETE /v1/organizations/{organizationId}/environments/{environmentId}/regions/{regionId}/destinations/queues/{queueId}/messages

**Operation ID:** `deleteV1OrganizationsByOrganizationidEnvironmentsByEnvironmentidRegionsByRegionidDestinationsQueuesByQueueidMessages`
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.


**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `environmentId` | query | The environment ID to identify the target resource. | required |
| `regionId` | query | The region ID to identify the target resource. | required |
| `queueId` | query | The queue ID to identify the target resource. | required |

### PUT /v1/organizations/{organizationId}/environments/{environmentId}/regions/{regionId}/destinations/queues/{queueId}/fallback

**Operation ID:** `updateV1OrganizationsByOrganizationidEnvironmentsByEnvironmentidRegionsByRegionidDestinationsQueuesByQueueidFallback`
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.


**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `environmentId` | query | The environment ID to identify the target resource. | required |
| `regionId` | query | The region ID to identify the target resource. | required |
| `queueId` | query | The queue ID to identify the target resource. | required |

### GET /v1/organizations/{organizationId}/environments/{environmentId}/regions/{regionId}/destinations/exchanges/{exchangeId}

**Operation ID:** `getV1OrganizationsByOrganizationidEnvironmentsByEnvironmentidRegionsByRegionidDestinationsExchangesByExchangeid`
Get the exchange with exchangeId = {exchangeId}. If you are using connected app, "View destinations" or "Administer destinations" scope is needed.


**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `environmentId` | query | The environment ID to identify the target resource. | required |
| `regionId` | query | The region ID to identify the target resource. | required |
| `exchangeId` | query | The exchange ID to identify the target resource. | required |

### PUT /v1/organizations/{organizationId}/environments/{environmentId}/regions/{regionId}/destinations/exchanges/{exchangeId}

**Operation ID:** `updateV1OrganizationsByOrganizationidEnvironmentsByEnvironmentidRegionsByRegionidDestinationsExchangesByExchangeid`
Add new exchange to the broker. If you are using connected app, "Administer destinations" scope is needed.


**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `environmentId` | query | The environment ID to identify the target resource. | required |
| `regionId` | query | The region ID to identify the target resource. | required |
| `exchangeId` | query | The exchange ID to identify the target resource. | required |

### PATCH /v1/organizations/{organizationId}/environments/{environmentId}/regions/{regionId}/destinations/exchanges/{exchangeId}

**Operation ID:** `patchV1OrganizationsByOrganizationidEnvironmentsByEnvironmentidRegionsByRegionidDestinationsExchangesByExchangeid`
Modifies the exchange of the broker. If you are using connected app, "Administer destinations" scope is needed.


**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `environmentId` | query | The environment ID to identify the target resource. | required |
| `regionId` | query | The region ID to identify the target resource. | required |
| `exchangeId` | query | The exchange ID to identify the target resource. | required |

### DELETE /v1/organizations/{organizationId}/environments/{environmentId}/regions/{regionId}/destinations/exchanges/{exchangeId}

**Operation ID:** `deleteV1OrganizationsByOrganizationidEnvironmentsByEnvironmentidRegionsByRegionidDestinationsExchangesByExchangeid`
Delete the exchange. If you are using connected app, "Administer destinations" scope is needed.


**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `environmentId` | query | The environment ID to identify the target resource. | required |
| `regionId` | query | The region ID to identify the target resource. | required |
| `exchangeId` | query | The exchange ID to identify the target resource. | required |

### GET /v1/organizations/{organizationId}/environments/{environmentId}/regions/{regionId}/bindings/exchanges/{exchangeId}

**Operation ID:** `getV1OrganizationsByOrganizationidEnvironmentsByEnvironmentidRegionsByRegionidBindingsExchangesByExchangeid`
Gathers all the queues bound to exchange. If you are using connected app, "View destinations" or "Administer destinations" scope is needed.


**Parameters:**
| `inclusion` | query | Defines what to fetch. inclusion=all returns details like routing rules defined on the binding | optional |
| `offset` | query | Skip over a number of elements by specifying an offset value for the query. | optional |
| `limit` | query | Limit the number of elements in the response. | optional |
| `startsWith` | query | Searchs the field from the left using the passed string.
 | required |
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `environmentId` | query | The environment ID to identify the target resource. | required |
| `regionId` | query | The region ID to identify the target resource. | required |
| `exchangeId` | query | The exchange ID to identify the target resource. | required |

### GET /v1/organizations/{organizationId}/environments/{environmentId}/regions/{regionId}/bindings/exchanges/{exchangeId}/queues/{queueId}

**Operation ID:** `getV1OrganizationsByOrganizationidEnvironmentsByEnvironmentidRegionsByRegionidBindingsExchangesByExchangeidQueuesByQueueid`
Gathers the existence of a specific binding. If you are using connected app, "View destinations" or "Administer destinations" scope is needed.


**Parameters:**
| `inclusion` | query | Defines what to fetch. inclusion=all returns details like routing rules defined on the binding | optional |
| `exchangeId` | query | The exchange ID to identify the target resource. | required |
| `queueId` | query | The queue ID to identify the target resource. | required |
| `environmentId` | query | The environment ID to identify the target resource. | required |
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `regionId` | query | The region ID to identify the target resource. | required |

### PUT /v1/organizations/{organizationId}/environments/{environmentId}/regions/{regionId}/bindings/exchanges/{exchangeId}/queues/{queueId}

**Operation ID:** `updateV1OrganizationsByOrganizationidEnvironmentsByEnvironmentidRegionsByRegionidBindingsExchangesByExchangeidQueuesByQueueid`
Creates a binding between a message exchange and a queue. If you are using connected app, "Administer destinations" scope is needed.


**Parameters:**
| `exchangeId` | query | The exchange ID to identify the target resource. | required |
| `queueId` | query | The queue ID to identify the target resource. | required |
| `environmentId` | query | The environment ID to identify the target resource. | required |
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `regionId` | query | The region ID to identify the target resource. | required |

### DELETE /v1/organizations/{organizationId}/environments/{environmentId}/regions/{regionId}/bindings/exchanges/{exchangeId}/queues/{queueId}

**Operation ID:** `deleteV1OrganizationsByOrganizationidEnvironmentsByEnvironmentidRegionsByRegionidBindingsExchangesByExchangeidQueuesByQueueid`
Deletes this binding. If you are using connected app, "Administer destinations" scope is needed.


**Parameters:**
| `exchangeId` | query | The exchange ID to identify the target resource. | required |
| `queueId` | query | The queue ID to identify the target resource. | required |
| `environmentId` | query | The environment ID to identify the target resource. | required |
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `regionId` | query | The region ID to identify the target resource. | required |

### PUT /v1/organizations/{organizationId}/environments/{environmentId}/regions/{regionId}/bindings/exchanges/{exchangeId}/queues/{queueId}/rules/routing

**Operation ID:** `updateV1OrganizationsByOrganizationidEnvironmentsByEnvironmentidRegionsByRegionidBindingsExchangesByExchangeidQueuesByQueueidRulesRouting`
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.


**Parameters:**
| `exchangeId` | query | The exchange ID to identify the target resource. | required |
| `queueId` | query | The queue ID to identify the target resource. | required |
| `environmentId` | query | The environment ID to identify the target resource. | required |
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `regionId` | query | The region ID to identify the target resource. | required |

### DELETE /v1/organizations/{organizationId}/environments/{environmentId}/regions/{regionId}/bindings/exchanges/{exchangeId}/queues/{queueId}/rules/routing

**Operation ID:** `deleteV1OrganizationsByOrganizationidEnvironmentsByEnvironmentidRegionsByRegionidBindingsExchangesByExchangeidQueuesByQueueidRulesRouting`
Deleted routing rules on a binding between a message exchange and queue. If you are using connected app, "Administer destinations" scope is needed.


**Parameters:**
| `exchangeId` | query | The exchange ID to identify the target resource. | required |
| `queueId` | query | The queue ID to identify the target resource. | required |
| `environmentId` | query | The environment ID to identify the target resource. | required |
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `regionId` | query | The region ID to identify the target resource. | required |

### GET /v1/organizations/{organizationId}/environments/{environmentId}/regions/{regionId}/bindings/queues/{queueId}

**Operation ID:** `getV1OrganizationsByOrganizationidEnvironmentsByEnvironmentidRegionsByRegionidBindingsQueuesByQueueid`
Gathers all the exchanges bound to the queue. If you are using connected app, "View destinations" or "Administer destinations" scope is needed.


**Parameters:**
| `inclusion` | query | Defines what to fetch. inclusion=all returns details like routing rules defined on the binding | optional |
| `offset` | query | Skip over a number of elements by specifying an offset value for the query. | optional |
| `limit` | query | Limit the number of elements in the response. | optional |
| `startsWith` | query | Searchs the field from the left using the passed string.
 | required |
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `environmentId` | query | The environment ID to identify the target resource. | required |
| `regionId` | query | The region ID to identify the target resource. | required |
| `queueId` | query | The queue ID to identify the target resource. | required |

### POST /v1/authorize

**Operation ID:** `createV1Authorize`
Obtains an access token using client credentials of the OAuth grant type. This API is not supported with connected apps.


### PATCH /v2/organizations/{organizationId}/environments/{environmentId}/regions/{regionId}/destinations/queues/{queueId}

**Operation ID:** `patchV2OrganizationsByOrganizationidEnvironmentsByEnvironmentidRegionsByRegionidDestinationsQueuesByQueueid`
Updates only the fields specified, "maxDeliveries" and "deadLetterQueueId" must be consistent.


**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `environmentId` | query | The environment ID to identify the target resource. | required |
| `regionId` | query | The region ID to identify the target resource. | required |
| `queueId` | query | The queue ID to identify the target resource. | required |