# Azure Postgre SQL management API

> Azure Postgre SQL management API on Apizie: 74 endpoints (Gets the private DNS zone suffix., Lists all available REST API operations., Checks the validity and availability of the given name, to assign it to a new server or to use it as the…, Lists all servers in a subscription., …) 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-postgresql/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

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

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

## Endpoints

### Gets the private DNS zone suffix.
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-postgresql/private-dns-zone-suffix-get` (byok)

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

### Lists all available REST API operations.
`GET https://zieapi.vercel.app/v1/cloud:azure-arm-postgresql/operations-list` (byok)

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

### Checks the validity and availability of the given name, to assign it to a new server or to use it as the…
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-postgresql/name-availability-check-globally` (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 servers in a subscription.
`GET https://zieapi.vercel.app/v1/cloud:azure-arm-postgresql/servers-list-by-subscription` (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 the capabilities available in a given location for a specific subscription.
`GET https://zieapi.vercel.app/v1/cloud:azure-arm-postgresql/capabilities-by-location-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. |
| locationName | string | yes | The name of the location. |

### Check the availability of name for resource
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-postgresql/name-availability-check-with-location` (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. |
| locationName | string | yes | The name of the location. |
| body | object | yes | JSON request body |

### Lists the virtual network subnet usage for a given virtual network.
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-postgresql/virtual-network-subnet-usage-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. |
| locationName | string | yes | The name of the location. |
| body | object | yes | JSON request body |

### Get quota usages at specified location in a given subscription.
`GET https://zieapi.vercel.app/v1/cloud:azure-arm-postgresql/quota-usages-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. |
| locationName | string | yes | The name of the location. |

### Lists all servers in a resource group.
`GET https://zieapi.vercel.app/v1/cloud:azure-arm-postgresql/servers-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 an existing server.
`GET https://zieapi.vercel.app/v1/cloud:azure-arm-postgresql/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. |
| serverName | string | yes | The name of the server. |

### Creates a new server.
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-postgresql/servers-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. |
| serverName | string | yes | The name of the server. |
| body | object | yes | JSON request body |

### Updates an existing server. The request body can contain one or multiple of the properties present in the…
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-postgresql/servers-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. |
| serverName | string | yes | The name of the server. |
| body | object | yes | JSON request body |

### Deletes or drops an existing server.
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-postgresql/servers-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. |
| serverName | string | yes | The name of the server. |

### List all server administrators associated to a Microsoft Entra principal.
`GET https://zieapi.vercel.app/v1/cloud:azure-arm-postgresql/administrators-microsoft-entra-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. |
| serverName | string | yes | The name of the server. |

### Gets information about a server administrator associated to a Microsoft Entra principal.
`GET https://zieapi.vercel.app/v1/cloud:azure-arm-postgresql/administrators-microsoft-entra-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. |
| serverName | string | yes | The name of the server. |
| objectId | string | yes | Object identifier of the Microsoft Entra principal. |

### Creates a new server administrator associated to a Microsoft Entra principal.
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-postgresql/administrators-microsoft-entra-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. |
| serverName | string | yes | The name of the server. |
| objectId | string | yes | Object identifier of the Microsoft Entra principal. |
| body | object | yes | JSON request body |

### Deletes an existing server administrator associated to a Microsoft Entra principal.
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-postgresql/administrators-microsoft-entra-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. |
| serverName | string | yes | The name of the server. |
| objectId | string | yes | Object identifier of the Microsoft Entra principal. |

### Lists state of advanced threat protection settings for a server.
`GET https://zieapi.vercel.app/v1/cloud:azure-arm-postgresql/advanced-threat-protection-settings-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. |
| serverName | string | yes | The name of the server. |

### Gets state of advanced threat protection settings for a server.
`GET https://zieapi.vercel.app/v1/cloud:azure-arm-postgresql/advanced-threat-protection-settings-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. |
| serverName | string | yes | The name of the server. |
| threatProtectionName | string | yes | Name of the advanced threat protection settings. |

### Creates or updates a server's Advanced Threat Protection settings.
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-postgresql/server-threat-protection-settings-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. |
| serverName | string | yes | The name of the server. |
| threatProtectionName | string | yes | Name of the advanced threat protection settings. |
| body | object | yes | JSON request body |

### Lists all available backups of a server.
`GET https://zieapi.vercel.app/v1/cloud:azure-arm-postgresql/backups-automatic-and-on-demand-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. |
| serverName | string | yes | The name of the server. |

### Gets information of an on demand backup, given its name.
`GET https://zieapi.vercel.app/v1/cloud:azure-arm-postgresql/backups-automatic-and-on-demand-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. |
| serverName | string | yes | The name of the server. |
| backupName | string | yes | Name of the backup. |

### Creates an on demand backup of a server.
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-postgresql/backups-automatic-and-on-demand-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. |
| serverName | string | yes | The name of the server. |
| backupName | string | yes | Name of the backup. |

### Deletes a specific backup, given its name.
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-postgresql/backups-automatic-and-on-demand-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. |
| serverName | string | yes | The name of the server. |
| backupName | string | yes | Name of the backup. |

### Lists the capabilities available for a given server.
`GET https://zieapi.vercel.app/v1/cloud:azure-arm-postgresql/capabilities-by-server-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. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| serverName | string | yes | The name of the server. |

### Check the validity and availability of the given name, to assign it to a new migration.
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-postgresql/migrations-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. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| serverName | string | yes | The name of the server. |
| body | object | yes | JSON request body |

### Lists all configurations (also known as server parameters) of a server.
`GET https://zieapi.vercel.app/v1/cloud:azure-arm-postgresql/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. |
| serverName | string | yes | The name of the server. |

### Gets information about a specific configuration (also known as server parameter) of a server.
`GET https://zieapi.vercel.app/v1/cloud:azure-arm-postgresql/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. |
| serverName | string | yes | The name of the server. |
| configurationName | string | yes | Name of the configuration (also known as server parameter). |

### Updates, using Put verb, the value assigned to a specific modifiable configuration (also known as server…
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-postgresql/configurations-put` (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. |
| serverName | string | yes | The name of the server. |
| configurationName | string | yes | Name of the configuration (also known as server parameter). |
| body | object | yes | JSON request body |

### Updates the value assigned to a specific modifiable configuration (also known as server parameter) of a…
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-postgresql/configurations-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. |
| serverName | string | yes | The name of the server. |
| configurationName | string | yes | Name of the configuration (also known as server parameter). |
| body | object | yes | JSON request body |

### Lists all databases in a server.
`GET https://zieapi.vercel.app/v1/cloud:azure-arm-postgresql/databases-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. |
| serverName | string | yes | The name of the server. |

### Gets information about an existing database.
`GET https://zieapi.vercel.app/v1/cloud:azure-arm-postgresql/databases-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. |
| serverName | string | yes | The name of the server. |
| databaseName | string | yes | Name of the database (case-sensitive). Exact database names can be retrieved by getting the list of all existing databases in a server. |

### Creates a new database.
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-postgresql/databases-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. |
| serverName | string | yes | The name of the server. |
| databaseName | string | yes | Name of the database (case-sensitive). Exact database names can be retrieved by getting the list of all existing databases in a server. |
| body | object | yes | JSON request body |

### Deletes an existing database.
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-postgresql/databases-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. |
| serverName | string | yes | The name of the server. |
| databaseName | string | yes | Name of the database (case-sensitive). Exact database names can be retrieved by getting the list of all existing databases in a server. |

### Lists information about all firewall rules in a server.
`GET https://zieapi.vercel.app/v1/cloud:azure-arm-postgresql/firewall-rules-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. |
| serverName | string | yes | The name of the server. |

### Gets information about a firewall rule in a server.
`GET https://zieapi.vercel.app/v1/cloud:azure-arm-postgresql/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. |
| serverName | string | yes | The name of the server. |
| firewallRuleName | string | yes | Name of the firewall rule. |

### Creates a new firewall rule or updates an existing firewall rule.
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-postgresql/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. |
| serverName | string | yes | The name of the server. |
| firewallRuleName | string | yes | Name of the firewall rule. |
| body | object | yes | JSON request body |

### Deletes an existing firewall rule.
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-postgresql/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. |
| serverName | string | yes | The name of the server. |
| firewallRuleName | string | yes | Name of the firewall rule. |

### Lists all captured logs for download in a server.
`GET https://zieapi.vercel.app/v1/cloud:azure-arm-postgresql/captured-logs-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. |
| serverName | string | yes | The name of the server. |

### Lists the results of the long term retention backup operations for a server.
`GET https://zieapi.vercel.app/v1/cloud:azure-arm-postgresql/backups-long-term-retention-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. |
| serverName | string | yes | The name of the server. |

### Gets the results of a long retention backup operation for a server.
`GET https://zieapi.vercel.app/v1/cloud:azure-arm-postgresql/backups-long-term-retention-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. |
| serverName | string | yes | The name of the server. |
| backupName | string | yes | The name of the backup. |

### Performs all checks required for a long term retention backup operation to succeed.
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-postgresql/backups-long-term-retention-check-prerequisites` (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. |
| serverName | string | yes | The name of the server. |
| body | object | yes | JSON request body |

### Lists all maintenance events for a flexible server.
`GET https://zieapi.vercel.app/v1/cloud:azure-arm-postgresql/maintenance-events-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. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| serverName | string | yes | The name of the server. |
| maintenanceStatus | string | no | Filter maintenance events by status. |

### Gets information about a maintenance event for a flexible server.
`GET https://zieapi.vercel.app/v1/cloud:azure-arm-postgresql/maintenance-events-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. |
| serverName | string | yes | The name of the server. |
| maintenanceEventId | string | yes | The name of the MaintenanceEventResource |

### Applies the maintenance event immediately.
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-postgresql/maintenance-events-apply-now` (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. |
| serverName | string | yes | The name of the server. |
| maintenanceEventId | string | yes | The name of the MaintenanceEventResource |

### Reschedules a maintenance event to a new date and time.
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-postgresql/maintenance-events-reschedule` (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. |
| serverName | string | yes | The name of the server. |
| maintenanceEventId | string | yes | The name of the MaintenanceEventResource |
| body | object | yes | JSON request body |

### Lists major version upgrade prechecks for a flexible server.
`GET https://zieapi.vercel.app/v1/cloud:azure-arm-postgresql/major-version-upgrade-precheck-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. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| serverName | string | yes | The name of the server. |

### Gets information about a major version upgrade precheck for a flexible server.
`GET https://zieapi.vercel.app/v1/cloud:azure-arm-postgresql/major-version-upgrade-precheck-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. |
| serverName | string | yes | The name of the server. |
| precheckValidationId | string | yes | The name of the MajorVersionUpgradePrecheckResource |

### Migrates an Azure Database for PostgreSQL server from VNet integration to a Private Link network model.
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-postgresql/servers-migrate-network-mode` (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. |
| serverName | string | yes | The name of the server. |

### Lists all migrations of a target flexible server.
`GET https://zieapi.vercel.app/v1/cloud:azure-arm-postgresql/migrations-list-by-target-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. |
| serverName | string | yes | The name of the server. |
| migrationListFilter | string | no | Migration list filter. Indicates if the request should retrieve only active migrations or all migrations. Defaults to Active. |

### Gets information about a migration.
`GET https://zieapi.vercel.app/v1/cloud:azure-arm-postgresql/migrations-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. |
| serverName | string | yes | The name of the server. |
| migrationName | string | yes | Name of migration. |

### Creates a new migration.
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-postgresql/migrations-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. |
| serverName | string | yes | The name of the server. |
| migrationName | string | yes | Name of migration. |
| body | object | yes | JSON request body |

### Updates an existing migration. The request body can contain one to many of the mutable properties present in…
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-postgresql/migrations-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. |
| serverName | string | yes | The name of the server. |
| migrationName | string | yes | Name of migration. |
| body | object | yes | JSON request body |

### Cancels an active migration.
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-postgresql/migrations-cancel` (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. |
| serverName | string | yes | The name of the server. |
| migrationName | string | yes | Name of migration. |

### Lists all private endpoint connections on a server.
`GET https://zieapi.vercel.app/v1/cloud:azure-arm-postgresql/private-endpoint-connections-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. |
| serverName | string | yes | The name of the server. |

### Gets a private endpoint connection.
`GET https://zieapi.vercel.app/v1/cloud:azure-arm-postgresql/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. |
| serverName | string | yes | The name of the server. |
| privateEndpointConnectionName | string | yes | The name of the private endpoint connection associated with the Azure resource. |

### Approves or rejects a private endpoint connection.
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-postgresql/private-endpoint-connections-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. |
| serverName | string | yes | The name of the server. |
| privateEndpointConnectionName | string | yes | The name of the private endpoint connection associated with the Azure resource. |
| body | object | yes | JSON request body |

### Deletes a private endpoint connection.
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-postgresql/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. |
| serverName | string | yes | The name of the server. |
| privateEndpointConnectionName | string | yes | The name of the private endpoint connection associated with the Azure resource. |

### Gets the private link resources for PostgreSQL server.
`GET https://zieapi.vercel.app/v1/cloud:azure-arm-postgresql/private-link-resources-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. |
| serverName | string | yes | The name of the server. |

### Gets a private link resource for PostgreSQL server.
`GET https://zieapi.vercel.app/v1/cloud:azure-arm-postgresql/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. |
| serverName | string | yes | The name of the server. |
| groupName | string | yes | The name of the private link resource. |

### Lists all read replicas of a server.
`GET https://zieapi.vercel.app/v1/cloud:azure-arm-postgresql/replicas-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. |
| serverName | string | yes | The name of the server. |

### Restarts PostgreSQL database engine in a server.
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-postgresql/servers-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. |
| serverName | string | yes | The name of the server. |
| body | object | no | JSON request body |

### Starts a stopped server.
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-postgresql/servers-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. |
| serverName | string | yes | The name of the server. |

### Initiates a long term retention backup.
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-postgresql/backups-long-term-retention-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. |
| serverName | string | yes | The name of the server. |
| body | object | yes | JSON request body |

### Start Major Version Upgrade Prechecks.
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-postgresql/servers-start-major-version-upgrade-precheck` (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. |
| serverName | string | yes | The name of the server. |
| body | object | yes | JSON request body |

### Stops a server.
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-postgresql/servers-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. |
| serverName | string | yes | The name of the server. |

### Lists the tuning options of a server.
`GET https://zieapi.vercel.app/v1/cloud:azure-arm-postgresql/tuning-options-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. |
| serverName | string | yes | The name of the server. |

### Gets the tuning options of a server.
`GET https://zieapi.vercel.app/v1/cloud:azure-arm-postgresql/tuning-options-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. |
| serverName | string | yes | The name of the server. |
| tuningOption | string | yes | The name of the tuning option. |

### Lists available object recommendations.
`GET https://zieapi.vercel.app/v1/cloud:azure-arm-postgresql/tuning-options-list-recommendations` (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. |
| serverName | string | yes | The name of the server. |
| tuningOption | string | yes | The name of the tuning option. |
| recommendationType | string | no | Recommendations list filter. Retrieves recommendations based on type. |

### Lists pair of virtual endpoints associated to a server.
`GET https://zieapi.vercel.app/v1/cloud:azure-arm-postgresql/virtual-endpoints-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. |
| serverName | string | yes | The name of the server. |

### Gets information about a pair of virtual endpoints.
`GET https://zieapi.vercel.app/v1/cloud:azure-arm-postgresql/virtual-endpoints-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. |
| serverName | string | yes | The name of the server. |
| virtualEndpointName | string | yes | Base name of the virtual endpoints. |

### Creates a pair of virtual endpoints for a server.
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-postgresql/virtual-endpoints-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. |
| serverName | string | yes | The name of the server. |
| virtualEndpointName | string | yes | Base name of the virtual endpoints. |
| body | object | yes | JSON request body |

### Updates a pair of virtual endpoints for a server.
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-postgresql/virtual-endpoints-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. |
| serverName | string | yes | The name of the server. |
| virtualEndpointName | string | yes | Base name of the virtual endpoints. |
| body | object | yes | JSON request body |

### Deletes a pair of virtual endpoints.
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-postgresql/virtual-endpoints-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. |
| serverName | string | yes | The name of the server. |
| virtualEndpointName | string | yes | Base name of the virtual endpoints. |

## Example
```
curl "https://zieapi.vercel.app/v1/cloud:azure-arm-postgresql/private-dns-zone-suffix-get" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Azure Postgre SQL management API?
Create a free Apizie key, then send POST https://zieapi.vercel.app/v1/cloud:azure-arm-postgresql/private-dns-zone-suffix-get with the header x-api-key. Every endpoint returns { project, data, timestamp }.

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

### Can AI agents use the Azure Postgre SQL 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-postgresql.

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