Share via

Azure Database for PostgreSQL REST API

The Azure Database for PostgreSQL management API provides create, read, update, and delete functionality for Azure PostgreSQL resources including servers, databases, firewall rules, network configuration, security alert policies, log files and configurations with new business model.

Azure Database for PostgreSQL provides a managed database service for application development and deployment that allows you to stand up a PostgreSQL database in minutes and scale on the fly - on the cloud you trust most.

The following information is common to all tasks that you might do using these REST APIs:

  • Replace {api-version} with the latest available stable API version, such as 2024-08-01, if you plan to use functionality which is generally available. Or with the latest available preview version such as 2024-11-01-preview, in case you plan to use functionality which is still in preview and hasn't transitioned to general availability. Find the list of stable and preview versions published so far.
  • Replace {subscriptionId} with the identifier of the subscription identifier in the URI. This value is a Globally Unique Identifier assigned to your subscription, such as aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e. Locate the subscription identifier using Azure portal subscriptions blade.
  • Replace {resourceGroupName} with the name of the resource group. For more information, see Use the Azure portal and Azure Resource Manager to manage resource groups.
  • Replace {serverName} with the name of your Azure Database for PostgreSQL server.
  • For any other entities like backupName, firewallRuleName, objectId, targetDbServerName, etc., read through the documentation of the specific API which uses them, and the examples referenced in that documentation.
  • Set the Content-Type header to application/json.
  • Set the Authorization header to a JSON Web Token that you obtain from Microsoft Entra ID service. For more information, see Getting Started with Azure REST.

REST operations

Operation group Description
Administrators Create, Delete, Get, or List By Server.
Backups Create, Delete, Get, or List By Server.
Check Migration Name Availability Check Migration Name Availability.
Check Name Availability Execute.
Check Name Availability With Location Execute.
Configurations Get, or List By Server, Put, or Update.
Databases Create, Delete, Get, or List By Server.
Firewall Rules Create or Update, Delete, Get, or List By Server.
Flexible Server Start Ltr Backup, or Trigger Ltr Pre Backup.
Get Private Dns Zone Suffix Execute.
Location Based Capabilities Execute.
Log Files List By Server.
Ltr Backup Operations Get, or List By Server.
Migrations Create, Delete, Get, List By Target Server, or Update.
Operations List.
Private Endpoint Connection Delete, or Update.
Private Endpoint Connections Get, or List By Server.
Private Link Resources Get, or List By Server.
Quota Usages List.
Replicas List By Server.
Server Capabilities List.
Server Threat Protection Settings Create or Update, Get, or List By Server.
Servers Create, Delete, Get, List, List By Resource Group, Restart, Start, Stop, or Update.
Tuning Options Get, List By Server, or List Recommendations.
Virtual Endpoints Create, Delete, Get, List By Server, or Update.
Virtual Network Subnet Usage Execute.

See also