Azure HorizonDB REST API

The Azure HorizonDB management API provides create, read, update, and delete functionality for Azure HorizonDB resources including clusters, firewall rules, parameter groups, pools, private endpoint connections, Private Link resources, and replicas.

Azure HorizonDB is a managed PostgreSQL service that enables developers to deploy high‑performance, scalable database applications in minutes, without managing infrastructure.

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

  • Replace {api-version} with the latest available preview version such as 2026-01-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} in the URI with the identifier of the subscription on which you want to deploy new resources or act upon existing resources. 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 {clusterName} with the name of your Azure HorizonDB cluster.
  • For any other entities like firewallRuleName, parameterGroupName, poolName, 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.