Skip to main content

List PostgreSQL clusters

Reviewed on

You can list all the PostgreSQL clusters within your space.

Permissions​

info

This action requires the following IAM (Identity and Access Management) permissions:

  • postgresql.cluster.get

API​

The request GET /postgresql/spaces/{spaceId}/clusters lists the PostgreSQL clusters of a space.

Parameters​

ParameterTypeRequiredDescription
spaceIdstringYesThe Numspot space ID.

Example response​

{
"items": [
{
"id": "123e4567-e89b-42d3-a456-426614174000",
"name": "my-cluster-postgresql",
"databaseName": "appdb",
"user": "admin",
"majorVersion": "17",
"fullVersion": "17.2",
"status": {
"state": "RUNNING",
"message": "Cluster is healthy"
},
"nodeConfiguration": {
"vcpuCount": 2,
"memorySizeGiB": 8
},
"volume": {
"type": "GP2",
"sizeGiB": 100
},
"replicaCount": 1,
"host": "my-cluster-postgresql.postgres.eu-west-2.numspot.com",
"port": 5432,
"visibility": "EXTERNAL",
"createdOn": "2026-08-15T12:41:00Z"
}
]
}

View the full specification

Was this page helpful?