Snapshot

Update service snapshot configuration

This endpoint is in beta. API contract is stable, and no breaking changes are expected in the future. <br /><br /> 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). Enabling snapshots or changing the cadence requires an eligible organization (see the organization's capabilities.snapshots).

patch/v1/organizations/{organizationId}/services/{serviceId}/snapshotConfiguration

Request

  • Base URL: https://api.clickhouse.cloud
  • URL: https://api.clickhouse.cloud/v1/organizations/{organizationId}/services/{serviceId}/snapshotConfiguration
  • Auth: HTTP basic

Path parameters

organizationIdstring uuid required

ID of the organization that owns the service.

serviceIdstring uuid required

ID of the service.

Request body

enabledboolean

Whether scheduled snapshots are enabled for the service.

gapnumber

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

timeFramenumber

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

Response

Successful response

statusnumber

HTTP status code.

requestIdstring uuid

Unique id assigned to every request. UUIDv4

Example response

{
  "status": 200
}

Changes

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