# Azure Cosmos DB for PostgreSQL management API

> Azure Cosmos DB for PostgreSQL management API on Apizie: 35 endpoints (Lists all clusters in a subscription., Lists all clusters in a resource group., Gets information about a cluster such as compute and storage configuration and cluster lifecycle metadata…, Creates a new cluster with servers., …) 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://www.apizie.tech/v1/cloud:azure-arm-postgresqlhsc/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:azure-arm-postgresqlhsc`
- Category: Cloud
- Status: byok
- Source: https://learn.microsoft.com/rest/api/azure/
- Page: https://www.apizie.tech/api/cloud/azure-arm-postgresqlhsc
- OpenAPI: https://www.apizie.tech/api/cloud/azure-arm-postgresqlhsc/openapi.json

Azure Resource Manager API for Cosmos DB for PostgreSQL: manage these Azure resources in your subscription with a Microsoft Entra access token.

## Endpoints

### Lists all clusters in a subscription.
`GET https://www.apizie.tech/v1/cloud:azure-arm-postgresqlhsc/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. |

### Lists all clusters in a resource group.
`GET https://www.apizie.tech/v1/cloud:azure-arm-postgresqlhsc/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 cluster such as compute and storage configuration and cluster lifecycle metadata…
`GET https://www.apizie.tech/v1/cloud:azure-arm-postgresqlhsc/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. |
| clusterName | string | yes | The name of the cluster. |

### Creates a new cluster with servers.
`POST https://www.apizie.tech/v1/cloud:azure-arm-postgresqlhsc/clusters-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. |
| clusterName | string | yes | The name of the cluster. |
| body | object | yes | JSON request body |

### Updates an existing cluster. The request body can contain one or several properties from the cluster…
`POST https://www.apizie.tech/v1/cloud:azure-arm-postgresqlhsc/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. |
| clusterName | string | yes | The name of the cluster. |
| body | object | yes | JSON request body |

### Deletes a cluster together with servers in it.
`POST https://www.apizie.tech/v1/cloud:azure-arm-postgresqlhsc/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. |
| clusterName | string | yes | The name of the cluster. |

### Lists servers of a cluster.
`GET https://www.apizie.tech/v1/cloud:azure-arm-postgresqlhsc/servers-list-by-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. |
| clusterName | string | yes | The name of the cluster. |

### Gets information about a server in cluster.
`GET https://www.apizie.tech/v1/cloud:azure-arm-postgresqlhsc/servers-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. |
| clusterName | string | yes | The name of the cluster. |
| serverName | string | yes | The name of the server. |

### List all the configurations of a server in cluster.
`GET https://www.apizie.tech/v1/cloud:azure-arm-postgresqlhsc/configurations-list-by-server` (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. |
| clusterName | string | yes | The name of the cluster. |
| serverName | string | yes | The name of the server. |

### List all the configurations of a cluster.
`GET https://www.apizie.tech/v1/cloud:azure-arm-postgresqlhsc/configurations-list-by-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. |
| clusterName | string | yes | The name of the cluster. |

### Gets information of a configuration for coordinator and nodes.
`GET https://www.apizie.tech/v1/cloud:azure-arm-postgresqlhsc/configurations-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. |
| clusterName | string | yes | The name of the cluster. |
| configurationName | string | yes | The name of the cluster configuration. |

### Gets information of a configuration for coordinator.
`GET https://www.apizie.tech/v1/cloud:azure-arm-postgresqlhsc/configurations-get-coordinator` (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. |
| clusterName | string | yes | The name of the cluster. |
| configurationName | string | yes | The name of the cluster configuration. |

### Updates configuration of coordinator in a cluster
`POST https://www.apizie.tech/v1/cloud:azure-arm-postgresqlhsc/configurations-update-on-coordinator` (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. |
| clusterName | string | yes | The name of the cluster. |
| configurationName | string | yes | The name of the cluster configuration. |
| body | object | yes | JSON request body |

### Gets information of a configuration for worker nodes.
`GET https://www.apizie.tech/v1/cloud:azure-arm-postgresqlhsc/configurations-get-node` (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. |
| clusterName | string | yes | The name of the cluster. |
| configurationName | string | yes | The name of the cluster configuration. |

### Updates configuration of worker nodes in a cluster
`POST https://www.apizie.tech/v1/cloud:azure-arm-postgresqlhsc/configurations-update-on-node` (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. |
| clusterName | string | yes | The name of the cluster. |
| configurationName | string | yes | The name of the cluster configuration. |
| body | object | yes | JSON request body |

### Gets information about a cluster firewall rule.
`GET https://www.apizie.tech/v1/cloud:azure-arm-postgresqlhsc/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. |
| clusterName | string | yes | The name of the cluster. |
| firewallRuleName | string | yes | The name of the cluster firewall rule. |

### Creates a new cluster firewall rule or updates an existing cluster firewall rule.
`POST https://www.apizie.tech/v1/cloud:azure-arm-postgresqlhsc/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. |
| clusterName | string | yes | The name of the cluster. |
| firewallRuleName | string | yes | The name of the cluster firewall rule. |
| body | object | yes | JSON request body |

### Deletes a cluster firewall rule.
`POST https://www.apizie.tech/v1/cloud:azure-arm-postgresqlhsc/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. |
| clusterName | string | yes | The name of the cluster. |
| firewallRuleName | string | yes | The name of the cluster firewall rule. |

### Lists all the firewall rules on cluster.
`GET https://www.apizie.tech/v1/cloud:azure-arm-postgresqlhsc/firewall-rules-list-by-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. |
| clusterName | string | yes | The name of the cluster. |

### Gets information about a cluster role.
`GET https://www.apizie.tech/v1/cloud:azure-arm-postgresqlhsc/roles-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. |
| clusterName | string | yes | The name of the cluster. |
| roleName | string | yes | The name of the cluster role. |

### Creates a new role or updates an existing role.
`POST https://www.apizie.tech/v1/cloud:azure-arm-postgresqlhsc/roles-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. |
| clusterName | string | yes | The name of the cluster. |
| roleName | string | yes | The name of the cluster role. |
| body | object | yes | JSON request body |

### Deletes a cluster role.
`POST https://www.apizie.tech/v1/cloud:azure-arm-postgresqlhsc/roles-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. |
| clusterName | string | yes | The name of the cluster. |
| roleName | string | yes | The name of the cluster role. |

### List all the roles in a given cluster.
`GET https://www.apizie.tech/v1/cloud:azure-arm-postgresqlhsc/roles-list-by-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. |
| clusterName | string | yes | The name of the cluster. |

### Restarts all nodes in the cluster.
`POST https://www.apizie.tech/v1/cloud:azure-arm-postgresqlhsc/clusters-restart` (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. |
| clusterName | string | yes | The name of the cluster. |

### Starts stopped compute on all cluster nodes.
`POST https://www.apizie.tech/v1/cloud:azure-arm-postgresqlhsc/clusters-start` (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. |
| clusterName | string | yes | The name of the cluster. |

### Stops compute on all cluster nodes.
`POST https://www.apizie.tech/v1/cloud:azure-arm-postgresqlhsc/clusters-stop` (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. |
| clusterName | string | yes | The name of the cluster. |

### Promotes read replica cluster to an independent read-write cluster.
`POST https://www.apizie.tech/v1/cloud:azure-arm-postgresqlhsc/clusters-promote-read-replica` (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. |
| clusterName | string | yes | The name of the cluster. |

### Checks availability of a cluster name. Cluster names should be globally unique; at least 3 characters and at…
`POST https://www.apizie.tech/v1/cloud:azure-arm-postgresqlhsc/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. |
| body | object | yes | JSON request body |

### Lists all of the available REST API operations.
`GET https://www.apizie.tech/v1/cloud:azure-arm-postgresqlhsc/operations-list` (byok)

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

### Gets list of private endpoint connections on a cluster.
`GET https://www.apizie.tech/v1/cloud:azure-arm-postgresqlhsc/private-endpoint-connections-list-by-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. |
| clusterName | string | yes | The name of the cluster. |

### Gets private endpoint connection.
`GET https://www.apizie.tech/v1/cloud:azure-arm-postgresqlhsc/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. |
| clusterName | string | yes | The name of the cluster. |
| privateEndpointConnectionName | string | yes | The name of the private endpoint connection associated with the cluster. |

### Approves or Rejects a private endpoint connection with a given name.
`POST https://www.apizie.tech/v1/cloud:azure-arm-postgresqlhsc/private-endpoint-connections-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. |
| clusterName | string | yes | The name of the cluster. |
| privateEndpointConnectionName | string | yes | The name of the private endpoint connection associated with the cluster. |
| body | object | yes | JSON request body |

### Deletes a private endpoint connection with a given name.
`POST https://www.apizie.tech/v1/cloud:azure-arm-postgresqlhsc/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. |
| clusterName | string | yes | The name of the cluster. |
| privateEndpointConnectionName | string | yes | The name of the private endpoint connection associated with the cluster. |

### Gets the private link resources for cluster.
`GET https://www.apizie.tech/v1/cloud:azure-arm-postgresqlhsc/private-link-resources-list-by-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. |
| clusterName | string | yes | The name of the cluster. |

### Gets a private link resource for cluster.
`GET https://www.apizie.tech/v1/cloud:azure-arm-postgresqlhsc/private-link-resources-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. |
| clusterName | string | yes | The name of the cluster. |
| privateLinkResourceName | string | yes | The name of the private link resource. |

## Example
```
curl "https://www.apizie.tech/v1/cloud:azure-arm-postgresqlhsc/clusters-list" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Azure Cosmos DB for PostgreSQL management API?
Create a free Apizie key, then send GET https://www.apizie.tech/v1/cloud:azure-arm-postgresqlhsc/clusters-list with the header x-api-key. Every endpoint returns { project, data, timestamp }.

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

### Can AI agents use the Azure Cosmos DB for PostgreSQL management API?
Yes. Add the Apizie MCP server (https://www.apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:azure-arm-postgresqlhsc.

### What is the status of the Azure Cosmos DB for PostgreSQL management API?
Needs your own provider key (bring your own key)