Skip to content
ClickHouse Docs
ClickHouse DocsClickHouse Docs
49.6kGet Started

List of service snapshots

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

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

Returns a list of snapshots for the service, most recent first. Results are capped at limit (default 250) per page; the server may return fewer and caps the value at its own maximum. Every response carries limit, totalCount and nextCursor; pass nextCursor as the cursor query parameter to fetch the next page, repeating until it is null.

Permission

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

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

Query parameters

  • limitoptionalinteger

    Maximum number of results to return.

    minimum: 1
    Default: 250
  • cursoroptionalstring

    Opaque cursor from a previous response's nextCursor, marking where to resume the list.

Response

JSON

200

Successful response

JSON
  • statusoptionalnumber

    HTTP status code.

    Example: 200
  • requestIdoptionalstring

    Unique id assigned to every request. UUIDv4

    format: uuid
  • resultoptionalarray ofobject
    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:

      • AwsBackupBucketProperties
        4 properties
        • bucketProvideroptionalAWS

          Bucket provider

        • bucketPathoptionalstring

          Bucket path

        • iamRoleArnoptionalstring

          AWS IAM Role

        • iamRoleSessionNameoptionalstring

          AWS IAM Role

      • GcpBackupBucketProperties
        3 properties
        • bucketProvideroptionalGCP

          Bucket provider

        • bucketPathoptionalstring

          Bucket path

        • accessKeyIdoptionalstring

          Access Key ID (HMAC key)

      • AzureBackupBucketProperties
        2 properties
        • bucketProvideroptionalAZURE

          Bucket provider

        • containerNameoptionalstring

          Container Name

  • limitoptionalinteger

    Maximum number of results returned in this page.

  • totalCountoptionalinteger | null

    Total number of results across all pages. It has only informative value, thus is not guaranteed and it is provided on a best-effort basis. Null if the total count is unknown.

  • nextCursoroptionalstring | null

    Cursor for the next page, to be sent as the cursor query parameter. Null on the last page.

Report an issue
Navigation