Microsoft Azure

Azure Database for PostgreSQL: Openapi

The Azure Database for PostgreSQL management API provides create, read, update, and delete functionality for Azure PostgreSQL resources including servers,…

Data & analytics#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

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.

Endpoints 74

Operations

  • GETOperations_List/providers/Microsoft.DBforPostgreSQL/operationsLists all available REST API operations.

AdministratorMicrosoftEntras

  • GETAdministratorsMicrosoftEntra_ListByServer/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforPostgreSQL/flexibleServers/:serverName/administratorsList all server administrators associated to a Microsoft Entra principal.
  • GETAdministratorsMicrosoftEntra_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforPostgreSQL/flexibleServers/:serverName/administrators/:objectIdGets information about a server administrator associated to a Microsoft Entra principal.
  • PUTAdministratorsMicrosoftEntra_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforPostgreSQL/flexibleServers/:serverName/administrators/:objectIdCreates a new server administrator associated to a Microsoft Entra principal.
  • DELETEAdministratorsMicrosoftEntra_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforPostgreSQL/flexibleServers/:serverName/administrators/:objectIdDeletes an existing server administrator associated to a Microsoft Entra principal.

Migrations

  • GETMigrations_ListByTargetServer/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforPostgreSQL/flexibleServers/:serverName/migrations?migrationListFilter=ActiveLists all migrations of a target flexible server.
  • GETMigrations_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforPostgreSQL/flexibleServers/:serverName/migrations/:migrationNameGets information about a migration.
  • PUTMigrations_Create/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforPostgreSQL/flexibleServers/:serverName/migrations/:migrationNameCreates a new migration.
  • DELETEMigrations_Cancel/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforPostgreSQL/flexibleServers/:serverName/migrations/:migrationNameCancels an active migration.
  • PATCHMigrations_Update/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforPostgreSQL/flexibleServers/:serverName/migrations/:migrationNameUpdates an existing migration. The request body can contain one to many of the mutable properties present in the migration definition. Certain property…

Servers

  • GETServers_ListBySubscription/subscriptions/:subscriptionId/providers/Microsoft.DBforPostgreSQL/flexibleServersLists all servers in a subscription.
  • GETServers_ListByResourceGroup/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforPostgreSQL/flexibleServersLists all servers in a resource group.
  • GETServers_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforPostgreSQL/flexibleServers/:serverNameGets information about an existing server.
  • PUTServers_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforPostgreSQL/flexibleServers/:serverNameCreates a new server.
  • DELETEServers_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforPostgreSQL/flexibleServers/:serverNameDeletes or drops an existing server.
  • PATCHServers_Update/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforPostgreSQL/flexibleServers/:serverNameUpdates an existing server. The request body can contain one or multiple of the properties present in the normal server definition.
  • GETCapabilitiesByServer_List/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforPostgreSQL/flexibleServers/:serverName/capabilitiesLists the capabilities available for a given server.
  • POSTCheck the validity and availability of the given name, to assign it to a new migration./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforPostgreSQL/flexibleServers/:serverName/checkMigrationNameAvailabilityChecks if a proposed migration name is valid and available.
  • GETCapturedLogs_ListByServer/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforPostgreSQL/flexibleServers/:serverName/logFilesLists all captured logs for download in a server.
  • POSTBackupsLongTermRetention_CheckPrerequisites/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforPostgreSQL/flexibleServers/:serverName/ltrPreBackupPerforms all checks required for a long term retention backup operation to succeed.
  • POSTServers_MigrateNetworkMode/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforPostgreSQL/flexibleServers/:serverName/migrateNetworkMigrates an Azure Database for PostgreSQL server from VNet integration to a Private Link network model.
  • GETReplicas_ListByServer/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforPostgreSQL/flexibleServers/:serverName/replicasLists all read replicas of a server.
  • POSTServers_Restart/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforPostgreSQL/flexibleServers/:serverName/restartRestarts PostgreSQL database engine in a server.
  • POSTServers_Start/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforPostgreSQL/flexibleServers/:serverName/startStarts a stopped server.
  • POSTBackupsLongTermRetention_Start/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforPostgreSQL/flexibleServers/:serverName/startLtrBackupInitiates a long term retention backup.
  • POSTServers_StartMajorVersionUpgradePrecheck/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforPostgreSQL/flexibleServers/:serverName/startMajorVersionUpgradePrecheckStart Major Version Upgrade Prechecks.
  • POSTServers_Stop/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforPostgreSQL/flexibleServers/:serverName/stopStops a server.

AdvancedThreatProtectionSettingsModels

  • GETAdvancedThreatProtectionSettings_ListByServer/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforPostgreSQL/flexibleServers/:serverName/advancedThreatProtectionSettingsLists state of advanced threat protection settings for a server.
  • GETAdvancedThreatProtectionSettings_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforPostgreSQL/flexibleServers/:serverName/advancedThreatProtectionSettings/:threatProtectionNameGets state of advanced threat protection settings for a server.
  • PUTServerThreatProtectionSettings_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforPostgreSQL/flexibleServers/:serverName/advancedThreatProtectionSettings/:threatProtectionNameCreates or updates a server's Advanced Threat Protection settings.

BackupAutomaticAndOnDemands

  • GETBackupsAutomaticAndOnDemand_ListByServer/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforPostgreSQL/flexibleServers/:serverName/backupsLists all available backups of a server.
  • GETBackupsAutomaticAndOnDemand_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforPostgreSQL/flexibleServers/:serverName/backups/:backupNameGets information of an on demand backup, given its name.
  • PUTBackupsAutomaticAndOnDemand_Create/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforPostgreSQL/flexibleServers/:serverName/backups/:backupNameCreates an on demand backup of a server.
  • DELETEBackupsAutomaticAndOnDemand_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforPostgreSQL/flexibleServers/:serverName/backups/:backupNameDeletes a specific backup, given its name.

Configurations

  • GETConfigurations_ListByServer/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforPostgreSQL/flexibleServers/:serverName/configurationsLists all configurations (also known as server parameters) of a server.
  • GETConfigurations_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforPostgreSQL/flexibleServers/:serverName/configurations/:configurationNameGets information about a specific configuration (also known as server parameter) of a server.
  • PUTConfigurations_Put/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforPostgreSQL/flexibleServers/:serverName/configurations/:configurationNameUpdates, using Put verb, the value assigned to a specific modifiable configuration (also known as server parameter) of a server.
  • PATCHConfigurations_Update/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforPostgreSQL/flexibleServers/:serverName/configurations/:configurationNameUpdates the value assigned to a specific modifiable configuration (also known as server parameter) of a server.

Databases

  • GETDatabases_ListByServer/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforPostgreSQL/flexibleServers/:serverName/databasesLists all databases in a server.
  • GETDatabases_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforPostgreSQL/flexibleServers/:serverName/databases/:databaseNameGets information about an existing database.
  • PUTDatabases_Create/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforPostgreSQL/flexibleServers/:serverName/databases/:databaseNameCreates a new database.
  • DELETEDatabases_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforPostgreSQL/flexibleServers/:serverName/databases/:databaseNameDeletes an existing database.

FirewallRules

  • GETFirewallRules_ListByServer/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforPostgreSQL/flexibleServers/:serverName/firewallRulesLists information about all firewall rules in a server.
  • GETFirewallRules_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforPostgreSQL/flexibleServers/:serverName/firewallRules/:firewallRuleNameGets information about a firewall rule in a server.
  • PUTFirewallRules_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforPostgreSQL/flexibleServers/:serverName/firewallRules/:firewallRuleNameCreates a new firewall rule or updates an existing firewall rule.
  • DELETEFirewallRules_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforPostgreSQL/flexibleServers/:serverName/firewallRules/:firewallRuleNameDeletes an existing firewall rule.

BackupsLongTermRetentionOperations

  • GETBackupsLongTermRetention_ListByServer/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforPostgreSQL/flexibleServers/:serverName/ltrBackupOperationsLists the results of the long term retention backup operations for a server.
  • GETBackupsLongTermRetention_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforPostgreSQL/flexibleServers/:serverName/ltrBackupOperations/:backupNameGets the results of a long retention backup operation for a server.

PrivateEndpointConnections

  • GETPrivateEndpointConnections_ListByServer/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforPostgreSQL/flexibleServers/:serverName/privateEndpointConnectionsLists all private endpoint connections on a server.
  • GETPrivateEndpointConnections_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforPostgreSQL/flexibleServers/:serverName/privateEndpointConnections/:privateEndpointConnectionNameGets a private endpoint connection.
  • PUTPrivateEndpointConnections_Update/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforPostgreSQL/flexibleServers/:serverName/privateEndpointConnections/:privateEndpointConnectionNameApproves or rejects a private endpoint connection.
  • DELETEPrivateEndpointConnections_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforPostgreSQL/flexibleServers/:serverName/privateEndpointConnections/:privateEndpointConnectionNameDeletes a private endpoint connection.

PrivateLinkResources

  • GETPrivateLinkResources_ListByServer/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforPostgreSQL/flexibleServers/:serverName/privateLinkResourcesGets the private link resources for PostgreSQL server.
  • GETPrivateLinkResources_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforPostgreSQL/flexibleServers/:serverName/privateLinkResources/:groupNameGets a private link resource for PostgreSQL server.

TuningOptionsOperationGroup

  • GETTuningOptions_ListByServer/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforPostgreSQL/flexibleServers/:serverName/tuningOptionsLists the tuning options of a server.
  • GETTuningOptions_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforPostgreSQL/flexibleServers/:serverName/tuningOptions/:tuningOptionGets the tuning options of a server.
  • GETTuningOptions_ListRecommendations/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforPostgreSQL/flexibleServers/:serverName/tuningOptions/:tuningOption/recommendations?recommendationType=CreateIndexLists available object recommendations.

VirtualEndpoints

  • GETVirtualEndpoints_ListByServer/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforPostgreSQL/flexibleServers/:serverName/virtualendpointsLists pair of virtual endpoints associated to a server.
  • GETVirtualEndpoints_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforPostgreSQL/flexibleServers/:serverName/virtualendpoints/:virtualEndpointNameGets information about a pair of virtual endpoints.
  • PUTVirtualEndpoints_Create/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforPostgreSQL/flexibleServers/:serverName/virtualendpoints/:virtualEndpointNameCreates a pair of virtual endpoints for a server.
  • DELETEVirtualEndpoints_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforPostgreSQL/flexibleServers/:serverName/virtualendpoints/:virtualEndpointNameDeletes a pair of virtual endpoints.
  • PATCHVirtualEndpoints_Update/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforPostgreSQL/flexibleServers/:serverName/virtualendpoints/:virtualEndpointNameUpdates a pair of virtual endpoints for a server.

MaintenanceEvents

  • GETMaintenanceEvents_List/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforPostgreSQL/flexibleServers/:serverName/maintenanceEvents?maintenanceStatus=UpcomingLists all maintenance events for a flexible server.
  • GETMaintenanceEvents_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforPostgreSQL/flexibleServers/:serverName/maintenanceEvents/:maintenanceEventIdGets information about a maintenance event for a flexible server.
  • POSTMaintenanceEvents_ApplyNow/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforPostgreSQL/flexibleServers/:serverName/maintenanceEvents/:maintenanceEventId/applyNowApplies the maintenance event immediately.
  • POSTMaintenanceEvents_Reschedule/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforPostgreSQL/flexibleServers/:serverName/maintenanceEvents/:maintenanceEventId/rescheduleReschedules a maintenance event to a new date and time.

MajorVersionUpgradePrecheck

  • GETMajorVersionUpgradePrecheck_List/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforPostgreSQL/flexibleServers/:serverName/majorVersionUpgradePrecheckLists major version upgrade prechecks for a flexible server.
  • GETMajorVersionUpgradePrecheck_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforPostgreSQL/flexibleServers/:serverName/majorVersionUpgradePrecheck/:precheckValidationIdGets information about a major version upgrade precheck for a flexible server.
  • POSTPrivateDnsZoneSuffix_Get/providers/Microsoft.DBforPostgreSQL/getPrivateDnsZoneSuffixGets the private DNS zone suffix.
  • POSTNameAvailability_CheckGlobally/subscriptions/:subscriptionId/providers/Microsoft.DBforPostgreSQL/checkNameAvailabilityChecks the validity and availability of the given name, to assign it to a new server or to use it as the base name of a new pair of virtual endpoints.
  • GETCapabilitiesByLocation_List/subscriptions/:subscriptionId/providers/Microsoft.DBforPostgreSQL/locations/:locationName/capabilitiesLists the capabilities available in a given location for a specific subscription.
  • POSTNameAvailability_CheckWithLocation/subscriptions/:subscriptionId/providers/Microsoft.DBforPostgreSQL/locations/:locationName/checkNameAvailabilityCheck the availability of name for resource
  • POSTVirtualNetworkSubnetUsage_List/subscriptions/:subscriptionId/providers/Microsoft.DBforPostgreSQL/locations/:locationName/checkVirtualNetworkSubnetUsageLists the virtual network subnet usage for a given virtual network.
  • GETQuotaUsages_List/subscriptions/:subscriptionId/providers/Microsoft.DBforPostgreSQL/locations/:locationName/resourceType/flexibleServers/usagesGet quota usages at specified location in a given subscription.

API details

Base URL
https://management.azure.com
Authentication
OAuth 2.0 (implicit flow) with 1 scope
Operations
74 operations on 52 pathsGET 38POST 14PUT 10DELETE 8PATCH 4
Main resources
Servers 17Migrations 5VirtualEndpoints 5AdministratorMicrosoftEntras 4BackupAutomaticAndOnDemands 4Configurations 4Databases 4FirewallRules 4MaintenanceEvents 4PrivateEndpointConnections 4
Response formats
application/json
Description format
Swagger 2.0, API version 2026-10-01

How to test the Azure Database for PostgreSQL: Openapi in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Azure Database for PostgreSQL: Openapi collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (implicit flow) with 1 scope. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Operations_List” (GET /providers/Microsoft.DBforPostgreSQL/operations), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Azure Database for PostgreSQL: Openapi?

The Azure Database for PostgreSQL management API provides create, read, update, and delete functionality for Azure PostgreSQL resources including servers,… It is listed under Data & analytics and has 74 endpoints.

Who publishes the Azure Database for PostgreSQL: Openapi?

It is listed from Microsoft Azure's public API description (an OpenAPI document), not published by Microsoft Azure on Swastik Codes. Anyone who controls azure.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Azure Database for PostgreSQL: Openapi?

Requests go to https://management.azure.com. Endpoint paths are added to this base URL.

How do I authenticate with the Azure Database for PostgreSQL: Openapi?

With OAuth 2.0 (implicit flow) with 1 scope.

How many endpoints does the Azure Database for PostgreSQL: Openapi have?

74 operations on 52 paths (38 GET, 14 POST, 10 PUT, 8 DELETE, 4 PATCH). The largest groups are Servers, Migrations, VirtualEndpoints, AdministratorMicrosoftEntras.

Is forking the Azure Database for PostgreSQL: Openapi free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.