Skip to main content
GET
List of Postgres service backups
Beta This endpoint is in beta. API contract is stable, and no breaking changes are expected in the future.

Returns a list of the base backups retained for a Postgres service, ordered by last modified date, newest first. Results are capped at limit (default and maximum 100) per page. Every response carries limit, totalCount and nextCursor; pass nextCursor as the cursor query parameter to fetch the next page, repeating until it is null. A Postgres service is recovered to a point in time rather than to a single backup, so restore it with the restore endpoint and a timestamp rather than with a backup key from this list.

Permission

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

Authorizations

Authorization
string
header
required

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

Path Parameters

organizationId
string<uuid>
required

ID of the organization that owns the Postgres service.

postgresId
string<uuid>
required

ID of the Postgres service the backups were created from.

Query Parameters

limit
integer
default:100

Maximum number of results to return.

Required range: 1 <= x <= 100
cursor
string

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

Response

Successful response

status
number

HTTP status code.

Example:

200

requestId
string<uuid>

Unique id assigned to every request. UUIDv4

result
object[]
limit
integer

Maximum number of results returned in this page.

totalCount
integer

Total number of results across all pages.

nextCursor
string | null

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

Last modified on October 2, 2026