Get the backup configuration for a cluster

cURL

curl --request GET \
  --url https://cockroachlabs.cloud/api/v1/clusters/{cluster_id}/backups-config \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

{
  "enabled": true,
  "frequency_minutes": 60,
  "retention_days": 7
}

{
  "code": 123,
  "details": [
    {
      "@type": "<string>"
    }
  ],
  "message": "<string>"
}

GET

api

clusters

{cluster_id}

backups-config

cURL

curl --request GET \
  --url https://cockroachlabs.cloud/api/v1/clusters/{cluster_id}/backups-config \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

{
  "enabled": true,
  "frequency_minutes": 60,
  "retention_days": 7
}

{
  "code": 123,
  "details": [
    {
      "@type": "<string>"
    }
  ],
  "message": "<string>"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

cluster_id

string

required

The UUID of the cluster that this backup configuration belongs to.

Response

A successful response.

enabled

boolean

required

Indicates whether backups are enabled.

frequency_minutes

integer<int32>

required

How frequently in minutes that backups are taken, which will determine the RPO of the cluster.

retention_days

integer<int32>

required

The number of days backups are retained for.

List cluster backups Update the backup configuration for a cluster