Update service backup configuration

Updates service backup configuration. Requires ADMIN auth key role. Setting the properties with null value, will reset the properties to theirs default values.

PATCH /v1/organizations/{organizationId}/services/{serviceId}/backupConfiguration

Update service backup configuration

cURL

curl --request PATCH \
  --url https://api.clickhouse.cloud/v1/organizations/{organizationId}/services/{serviceId}/backupConfiguration \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "backupPeriodInHours": 123,
  "backupRetentionPeriodInHours": 123,
  "backupStartTime": "<string>"
}
'

200

{
  "status": 200,
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "result": {
    "backupPeriodInHours": 123,
    "backupRetentionPeriodInHours": 123,
    "backupStartTime": "<string>"
  }
}

Authorizations

Authorization · string · header · required

Use key ID and key secret obtained in ClickHouse Cloud console: https://clickhouse.com/docs/cloud/manage/openapi

Path Parameters

organizationId · string<uuid> · required

ID of the organization that owns the service.

serviceId · string<uuid> · required

ID of the service.

Body

application/json

backupPeriodInHours · number

The interval in hours between each backup.

backupRetentionPeriodInHours · number

The minimum duration in hours for which the backups are available.

backupStartTime · string

The time in HH:MM format for the backups to be performed (evaluated in UTC timezone). When defined the backup period resets to every 24 hours.

Response

200

application/json

Successful response

status · number

HTTP status code.

Example:

200

requestId · string<uuid>

Unique id assigned to every request. UUIDv4

result · object

Show child attributes