List a cluster's backups

Returns the cluster's managed backups, newest first, with the storage they use. On plans without managed backups the list is empty and entitled is false.

Required scope: clusters:backups:read

get/clusters/{cluster_id}/backups

Request

Base URL: http://localhost:8000
URL: http://localhost:8000/clusters/{cluster_id}/backups
Auth: API key in header API-Key

Path parameters

cluster_idstring uuid required

Headers

API-Version'2026-06-01.beta' required

Response

The request has succeeded.

entitledboolean required

Whether the workspace plan includes managed backups (Business and Enterprise).

max_retention_daysinteger required

Retention of automatic backups, and the most days an on-demand backup can be kept. 0 when not entitled.

storage_used_bytesinteger required

Bytes of this cluster's backups currently stored.

next_scheduled_atstring date-time

When the next automatic backup starts.

Example response

{
  "backups": [
    {
      "id": "auto-202609230300",
      "cluster_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "type": "automatic",
      "status": "completed",
      "retention_days": 14,
      "size_bytes": 52428800,
      "sha256": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",
      "keycloak_version": "26.3.0",
      "requested_at": "2026-09-23T03:00:00Z",
      "started_at": "2026-09-23T03:00:04Z",
      "completed_at": "2026-09-23T03:04:12Z",
      "expires_at": "2026-10-07T03:04:12Z",
      "created_at": "2026-09-23T03:00:00Z"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.