Skip to content
ClickHouse Docs
ClickHouse DocsClickHouse Docs

Get service snapshot configuration

GET/v1/organizations/{organizationId}/services/{serviceId}/snapshotConfiguration
API playground

This endpoint is in beta. API contract is stable, and no breaking changes are expected in the future.

Returns the service snapshot configuration.

Permission

The API key must have the control-plane:service:view-snapshots permission.

Authorizations

Path parameters

  • organizationIdstringrequired

    ID of the organization that owns the service.

    format: uuid
  • serviceIdstringrequired

    ID of the service.

    format: uuid

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. One of 10, 20, 30, 60. Validated when an enabled configuration is saved; stored values are not re-validated on read.

    • timeFrameoptionalnumber

      Retention window the snapshots cover, in minutes. A whole number of days (a multiple of 1440), at least 1440; timeFrame / gap must not exceed 300 snapshots. Validated when an enabled configuration is saved; stored values are not re-validated on read.