Update the backup configuration for a cluster

Can be used by the following roles assigned at the organization, folder or cluster scope:

• CLUSTER_ADMIN
• CLUSTER_OPERATOR_WRITER

PATCH /api/v1/clusters/{cluster_id}/backups-config

cURL

cURL

curl --request PATCH \
  --url https://cockroachlabs.cloud/api/v1/clusters/{cluster_id}/backups-config \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \
  --json '{"enabled":true,"frequency_minutes":60,"retention_days":7}'

200

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

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.

Body

application/json

spec contains the information that is being updated for the given BackupConfiguration.

enabled · boolean

Indicates whether backups are enabled.

frequency_minutes · integer<int32>

How frequently in minutes that backups are taken, which will determine the RPO of the cluster. Valid values are [5, 10, 15, 30, 60, 240, 1440].

retention_days · integer<int32>

The number of days to retain backups for. Can only be set once, further changes require opening a support ticket. Valid values are [2, 7, 30, 90, 365].

Response

200

application/json

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.