Update service snapshot configuration

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

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).

Authorizations

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

Path parameters

organizationIdstringrequired
ID of the organization that owns the service.

format: uuid
serviceIdstringrequired
ID of the service.

format: uuid

Request bodyJSON

enabledoptionalboolean
Whether scheduled snapshots are enabled for the service.
gapoptionalnumber
Interval between snapshots, in minutes. Set together with timeFrame; only supported preset pairs are accepted.
timeFrameoptionalnumber
Retention window the snapshots cover, in minutes. Set together with gap; only supported preset pairs are accepted.

Response

JSON

200

Successful response

JSON

statusoptionalnumber
HTTP status code.

Example: 200
requestIdoptionalstring
Unique id assigned to every request. UUIDv4

format: uuid
resultoptionalobject
3 properties
- enabledoptionalboolean
  Whether scheduled snapshots are enabled for the service.
- gapoptionalnumber
  Interval between snapshots, in minutes. Set together with timeFrame; only supported preset pairs are accepted.
- timeFrameoptionalnumber
  Retention window the snapshots cover, in minutes. Set together with gap; only supported preset pairs are accepted.

Update service snapshot configuration

curl --request PATCH \
  --url https://api.clickhouse.cloud/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/services/497f6eca-6276-4993-bfeb-53cbbbba6f08/snapshotConfiguration \
  --header 'Authorization: Basic <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "enabled": true,
  "gap": 0,
  "timeFrame": 0
}
'

const url = 'https://api.clickhouse.cloud/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/services/497f6eca-6276-4993-bfeb-53cbbbba6f08/snapshotConfiguration';
const options = {
  method: 'PATCH',
  headers: {'Content-Type': 'application/json', Authorization: 'Basic <token>'},
  body: JSON.stringify({enabled: true, gap: 0, timeFrame: 0})
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

import requests

url = "https://api.clickhouse.cloud/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/services/497f6eca-6276-4993-bfeb-53cbbbba6f08/snapshotConfiguration"

payload = {
    "enabled": True,
    "gap": 0,
    "timeFrame": 0
}
headers = {
    "Content-Type": "application/json",
    "Authorization": "Basic <token>"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

Response example

{
  "status": 200,
  "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6",
  "result": {
    "enabled": true,
    "gap": 0,
    "timeFrame": 0
  }
}

{
  "status": 400,
  "error": "string",
  "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6"
}

{
  "status": 500,
  "error": "string",
  "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6"
}