Using the HM API

Using the HM API to integrate directly with HM for management activities such as cluster provisioning, deprovisioning, and scaling.

The API reference documentation is available from the EDB Postgres AI portal.

Prerequisite

Before calling API, create an access key. For more information, see access key.

Call the API

To authenticate with the HM API, your application must include the retrieved access key in the x-access-key header of each HTTP request. For example:

curl --request GET \
  --url "https://portal.edb-hcp.com/api/v1/projects" \
  --header "x-access-key: $ACCESS_KEY"

Where the ACCESS_KEY variable is the access key's text copied from the HM UI.

Example response:

{
"data": 
[
{
"projectId": "string",

"projectName": "string",
"userCount": 0,
"clusterCount": 0,
"tags": 
[]
}
]
}