Snapshot

List of service snapshots

This endpoint is in beta. API contract is stable, and no breaking changes are expected in the future. <br /><br /> 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.

get/v1/organizations/{organizationId}/services/{serviceId}/snapshots

Request

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

Path parameters

organizationIdstring uuid required

ID of the organization that owns the snapshot.

serviceIdstring uuid required

ID of the service the snapshot was created from.

Query parameters

limitinteger

Maximum number of results to return.

cursorstring

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

Response

Successful response

statusnumber

HTTP status code.

requestIdstring uuid

Unique id assigned to every request. UUIDv4

limitinteger

Maximum number of results returned in this page.

totalCountinteger nullable

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.

nextCursorstring nullable

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

Example response

{
  "status": 200
}

Changes

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