Skip to content
ClickHouse Docs
ClickHouse DocsClickHouse Docs
49.6kGet Started

Get snapshot details

View as MarkdownEdit this pageReport an issueSet up docs MCP
GET/v1/organizations/{organizationId}/services/{serviceId}/snapshots/{snapshotId}

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

Returns a single snapshot info.

Authorizations

Path parameters

  • organizationIdstringrequired

    ID of the organization that owns the snapshot.

    format: uuid
  • serviceIdstringrequired

    ID of the service the snapshot was created from.

    format: uuid
  • snapshotIdstringrequired

    ID of the requested snapshot.

    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
    10 properties
    • idoptionalstring

      Unique snapshot ID.

      format: uuid
    • statusoptionaldoneorerrororin_progressorthrottled

      Status of the snapshot: 'done', 'error', 'in_progress', 'throttled'. 'throttled' means snapshot creation was rate-limited and will be retried.

    • serviceIdoptionalstring

      ID of the service the snapshot was created from.

    • startedAtoptionalstring

      Snapshot start timestamp. ISO-8601.

      format: date-time
    • finishedAtoptionalstring

      Snapshot finish timestamp. ISO-8601. Available only for finished snapshots

      format: date-time
    • sizeInBytesoptionalnumber

      Size of the snapshot in bytes.

    • durationInSecondsoptionalnumber

      Time in seconds it took to perform the snapshot. If the status is in_progress or throttled, this is the time in seconds since the snapshot started until now.

    • typeoptionalfull

      Snapshot type. Always "full" — snapshots never chain off a parent.

    • backupNameoptionalstring

      Snapshot name on the external backup bucket.

    • bucketoptionalAwsBackupBucketPropertiesorGcpBackupBucketPropertiesorAzureBackupBucketProperties

      Backup bucket where the snapshot is stored.

      3 variants

      One of the following:

Navigation