Skip to main content
PATCH
Update service snapshot configuration
Beta This endpoint is in beta. API contract is stable, and no breaking changes are expected in the future.

Updates the service snapshot configuration. Requires ADMIN auth key role. Enables or disables scheduled snapshots and sets the cadence; when enabled, gap and timeFrame (in minutes) must together be one of the supported (gap, timeFrame) pairs: (30, 1440), (60, 2880). Provide at least one of enabled, gap, timeFrame; omit a field to leave it unchanged (null is not accepted).

Permission

The API key must have the control-plane:service:manage-backups permission.

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
enabled
boolean

Whether scheduled snapshots are enabled for the service.

gap
number

Interval between snapshots, in minutes. Set together with timeFrame; only supported preset pairs are accepted.

timeFrame
number

Retention window the snapshots cover, in minutes. Set together with gap; only supported preset pairs are accepted.

Response

Successful response

status
number

HTTP status code.

Example:

200

requestId
string<uuid>

Unique id assigned to every request. UUIDv4

result
object
Last modified on September 18, 2026