Skip to content
ClickHouse Docs
ClickHouse DocsClickHouse Docs

List of Postgres service backups

GET/v1/organizations/{organizationId}/postgres/{postgresId}/backups
API playground

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 between the service's earliestRestoreTime and now, rather than with a backup key from this list.

Permission

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

Authorizations

Path parameters

  • organizationIdstringrequired

    ID of the organization that owns the Postgres service.

    format: uuid
  • postgresIdstringrequired

    ID of the Postgres service the backups were created from.

    format: uuid

Query parameters

  • limitoptionalinteger

    Maximum number of results to return.

    maximum: 100, minimum: 1
    Default: 100
  • 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
    3 properties
    • keystringrequired

      Identifier of the base backup.

      Example: "basebackups_005/000000010000000000000002_backup_stop_sentinel.json"
    • statusstringrequired

      Status of the backup. Only completed backups are listed, so this is always ready.

    • lastModifiedstringrequired

      Time the backup finished. ISO-8601. This is not the earliest point a service can be restored to; use earliestRestoreTime on the Postgres service for that.

      format: date-time
      Example: "2026-03-31T18:17:37Z"
  • 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.