List the backups of a PostgreSQL cluster

You can list all the backups available for a PostgreSQL cluster.

Backup types

There are two types of backups:

Type	Description
ON_DEMAND	Manual backup triggered by the user
AUTO	Automatic backup generated by the system

Permissions

info

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

• postgresql.cluster.get

API

The GET /postgresql/spaces/{spaceId}/clusters/{clusterId}/backups request lets you list all the backups of a PostgreSQL cluster.

Parameters

Parameter	Type	Required	Description
spaceId	UUID (Universally Unique Identifier)	Yes	Space identifier
clusterId	UUID	Yes	Unique identifier of the cluster

Example response

{
  "items": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "clusterId": "e592a4f6-2e49-46e7-b6d0-248a7711197a",
      "clusterName": "my-cluster-postgresql",
      "name": "my-backup",
      "type": "ON_DEMAND",
      "target": "PREFER_STANDBY",
      "status": {
        "state": "SUCCEEDED",
        "message": "Backup completed successfully"
      },
      "startedAt": "2026-04-08T10:00:00Z",
      "completedAt": "2026-04-08T10:30:00Z"
    },
    {
      "id": "b2c3d4e5-f6a7-8901-bcde-f23456789012",
      "clusterId": "e592a4f6-2e49-46e7-b6d0-248a7711197a",
      "clusterName": "my-cluster-postgresql",
      "name": "auto-backup-20260407",
      "type": "AUTO",
      "target": "PREFER_STANDBY",
      "status": {
        "state": "ACTIVE",
        "message": "Backup schedule is active and running"
      },
      "startedAt": "2026-04-07T02:00:00Z",
      "completedAt": "2026-04-07T02:15:00Z"
    }
  ]
}

Response fields

Field	Type	Description
id	UUID	Unique identifier of the backup
clusterId	UUID	Identifier of the source cluster
clusterName	string	Name of the source cluster
name	string	Name of the backup
type	string	Type of backup (ON_DEMAND or AUTO)
target	string	Target node for running the backup (PREFER_STANDBY, STANDBY or PRIMARY)
status	object	Current status of the backup
startedAt	string (date-time)	Start date of the backup
completedAt	string (date-time)	End date of the backup (null if in progress)

Backup states

State	Description	Applicable to
CREATING	Backup request submitted, not yet started	ON_DEMAND, AUTO
RUNNING	Backup in progress (on-demand backups)	ON_DEMAND
ACTIVE	Backup schedule active and running (automatic backups)	AUTO
SUCCEEDED	Backup completed successfully (on-demand backups)	ON_DEMAND
FAILED	Backup failed	ON_DEMAND, AUTO
DELETING	Backup being deleted	ON_DEMAND

See the full specification