# Azure Mongo Cluster management API

> Azure Mongo Cluster management API on Apizie: 24 endpoints (List the operations for the provider, Check if DocumentDB cluster name is available for use., List all the DocumentDB clusters in a given subscription., List all the DocumentDB clusters in a given resource group., …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://zieapi.vercel.app/v1/cloud:azure-arm-mongocluster/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:azure-arm-mongocluster`
- Category: Cloud
- Status: byok
- Source: https://learn.microsoft.com/rest/api/azure/
- Page: https://zieapi.vercel.app/api/cloud/azure-arm-mongocluster
- OpenAPI: https://zieapi.vercel.app/api/cloud/azure-arm-mongocluster/openapi.json

Azure Resource Manager API for Mongo Cluster: manage these Azure resources in your subscription with a Microsoft Entra access token.

## Endpoints

### List the operations for the provider
`GET https://zieapi.vercel.app/v1/cloud:azure-arm-mongocluster/operations-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |

### Check if DocumentDB cluster name is available for use.
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-mongocluster/mongo-clusters-check-name-availability` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| location | string | yes | The name of the Azure region. |
| body | object | yes | JSON request body |

### List all the DocumentDB clusters in a given subscription.
`GET https://zieapi.vercel.app/v1/cloud:azure-arm-mongocluster/mongo-clusters-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |

### List all the DocumentDB clusters in a given resource group.
`GET https://zieapi.vercel.app/v1/cloud:azure-arm-mongocluster/mongo-clusters-list-by-resource-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |

### Gets information about a DocumentDB cluster.
`GET https://zieapi.vercel.app/v1/cloud:azure-arm-mongocluster/mongo-clusters-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| mongoClusterName | string | yes | The name of the DocumentDB cluster. |

### Create or update a DocumentDB cluster. Update overwrites all properties for the resource. To only modify…
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-mongocluster/mongo-clusters-create-or-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| mongoClusterName | string | yes | The name of the DocumentDB cluster. |
| body | object | yes | JSON request body |

### Updates an existing DocumentDB cluster. The request body can contain one to many of the properties present…
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-mongocluster/mongo-clusters-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| mongoClusterName | string | yes | The name of the DocumentDB cluster. |
| body | object | yes | JSON request body |

### Deletes a DocumentDB cluster.
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-mongocluster/mongo-clusters-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| mongoClusterName | string | yes | The name of the DocumentDB cluster. |

### List all the firewall rules in a given DocumentDB cluster.
`GET https://zieapi.vercel.app/v1/cloud:azure-arm-mongocluster/firewall-rules-list-by-mongo-cluster` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| mongoClusterName | string | yes | The name of the DocumentDB cluster. |

### Gets information about a DocumentDB cluster firewall rule.
`GET https://zieapi.vercel.app/v1/cloud:azure-arm-mongocluster/firewall-rules-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| mongoClusterName | string | yes | The name of the DocumentDB cluster. |
| firewallRuleName | string | yes | The name of the DocumentDB cluster firewall rule. |

### Creates a new firewall rule or updates an existing firewall rule on a DocumentDB cluster.
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-mongocluster/firewall-rules-create-or-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| mongoClusterName | string | yes | The name of the DocumentDB cluster. |
| firewallRuleName | string | yes | The name of the DocumentDB cluster firewall rule. |
| body | object | yes | JSON request body |

### Deletes a DocumentDB cluster firewall rule.
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-mongocluster/firewall-rules-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| mongoClusterName | string | yes | The name of the DocumentDB cluster. |
| firewallRuleName | string | yes | The name of the DocumentDB cluster firewall rule. |

### List DocumentDB cluster connection strings. This includes the default connection string using SCRAM-SHA-256,…
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-mongocluster/mongo-clusters-list-connection-strings` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| mongoClusterName | string | yes | The name of the DocumentDB cluster. |

### List existing private connections
`GET https://zieapi.vercel.app/v1/cloud:azure-arm-mongocluster/private-endpoint-connections-list-by-mongo-cluster` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| mongoClusterName | string | yes | The name of the DocumentDB cluster. |

### Get a specific private connection
`GET https://zieapi.vercel.app/v1/cloud:azure-arm-mongocluster/private-endpoint-connections-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| mongoClusterName | string | yes | The name of the DocumentDB cluster. |
| privateEndpointConnectionName | string | yes | The name of the private endpoint connection associated with the Azure resource. |

### Create a Private endpoint connection
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-mongocluster/private-endpoint-connections-create` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| mongoClusterName | string | yes | The name of the DocumentDB cluster. |
| privateEndpointConnectionName | string | yes | The name of the private endpoint connection associated with the Azure resource. |
| body | object | yes | JSON request body |

### Delete the private endpoint connection
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-mongocluster/private-endpoint-connections-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| mongoClusterName | string | yes | The name of the DocumentDB cluster. |
| privateEndpointConnectionName | string | yes | The name of the private endpoint connection associated with the Azure resource. |

### list private links on the given resource
`GET https://zieapi.vercel.app/v1/cloud:azure-arm-mongocluster/private-links-list-by-mongo-cluster` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| mongoClusterName | string | yes | The name of the DocumentDB cluster. |

### Promotes a replica DocumentDB cluster to a primary role.
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-mongocluster/mongo-clusters-promote` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| mongoClusterName | string | yes | The name of the DocumentDB cluster. |
| body | object | yes | JSON request body |

### List all the replicas for the DocumentDB cluster.
`GET https://zieapi.vercel.app/v1/cloud:azure-arm-mongocluster/replicas-list-by-parent` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| mongoClusterName | string | yes | The name of the DocumentDB cluster. |

### List all the users on a DocumentDB cluster.
`GET https://zieapi.vercel.app/v1/cloud:azure-arm-mongocluster/users-list-by-mongo-cluster` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| mongoClusterName | string | yes | The name of the DocumentDB cluster. |

### Gets the defintion of a DocumentDB cluster user.
`GET https://zieapi.vercel.app/v1/cloud:azure-arm-mongocluster/users-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| mongoClusterName | string | yes | The name of the DocumentDB cluster. |
| userName | string | yes | The name of the DocumentDB cluster user. |

### Creates a new user or updates an existing user on a DocumentDB cluster.
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-mongocluster/users-create-or-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| mongoClusterName | string | yes | The name of the DocumentDB cluster. |
| userName | string | yes | The name of the DocumentDB cluster user. |
| body | object | yes | JSON request body |

### Deletes a DocumentDB cluster user.
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-mongocluster/users-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| mongoClusterName | string | yes | The name of the DocumentDB cluster. |
| userName | string | yes | The name of the DocumentDB cluster user. |

## Example
```
curl "https://zieapi.vercel.app/v1/cloud:azure-arm-mongocluster/operations-list" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Azure Mongo Cluster management API?
Create a free Apizie key, then send GET https://zieapi.vercel.app/v1/cloud:azure-arm-mongocluster/operations-list with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Azure Mongo Cluster management API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Azure Mongo Cluster management itself also needs your own key from azure.com.

### Can AI agents use the Azure Mongo Cluster management API?
Yes. Add the Apizie MCP server (https://zieapi.vercel.app/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:azure-arm-mongocluster.

### What is the status of the Azure Mongo Cluster management API?
Needs your own provider key (bring your own key)