Skip to content
You're viewing documentation for v2026.11.11-beta. It may be out of date.Go to latest
TimescaleDB Enterprise
Esc
↑↓navigate↵open⌘Jpreview

List backups on a server

List pgbackrest backups on a server.

GET/api/v1/servers/{id}/backups
Authorization
tse_sessionAPI key · cookierequired
Path parameters
idstringrequired
Query parameters
liveboolean
Responses
200

OK

captured_atstring<date-time>
errorstring
stanzasStanzaInfo[]required
Show properties
Array of StanzaInfo
backupsStanzaBackupInfo[]required
Show properties
Array of StanzaBackupInfo
annotationsobject
archive_stopstring
checksum_errorsboolean

True when pgBackRest found invalid page checksums in the backup: some data files of the database are corrupt

database_idinteger<int64>
database_size_bytesinteger<int64>required
labelstringrequired
olderboolean

True for a backup of a database id older than the newest of its repo, from before a PostgreSQL major upgrade. It restores only into a new service on pg_version, never in place

pg_versionstring
prior_checksum_errorsboolean

True when a backup that this backup depends on (its full, and the diff of an incr) has invalid page checksums. A restore of this backup restores the corrupt files of that backup too, so it is refused like a backup with checksum_errors

repointeger<int64>
size_bytesinteger<int64>required

Bytes that this backup stored in the repo, after compression. The files of the backups that it depends on are not included

start_timestringrequired
stop_timestringrequired
typestringrequired
coverageStanzaCoverageJSON
Show properties
assumes_archivingbooleanrequired
earlieststringrequired
endstringrequired
nowstringrequired
reposRepoCoverageJSON[]required
Show properties
Array of RepoCoverageJSON
backupsCoveredBackupJSON[]required
Show properties
Array of CoveredBackupJSON
checksum_errorsboolean

True when pgBackRest found invalid page checksums in the backup, or in a backup that it depends on (its full, and the diff of an incr). A restore of it is refused unless allow_checksum_errors is set

labelstringrequired
stop_timestringrequired
current_tliinteger<int32>required
min 0
database_idinteger<int64>

The pgBackRest database id of this coverage

earlieststringrequired
grant_fingerprintstring

The license grant fingerprint of a fork or recover that restores this database id: the cluster that the copy has. Only a live scan of the backups gives it

kindstringrequired
Allowed:localremote
olderboolean

True for a database id older than the newest of the stanza, from before a PostgreSQL major upgrade. Its times restore only into a new service on pg_version, and its coverage ends at its newest backup

pg_versionstring

The PostgreSQL major of the database id

repointeger<int64>required
wal_maxstringrequired
wal_minstringrequired
database_idinteger<int64>
namestringrequired
pg_versionstring
statusstringrequired
Allowed:okerror
wal_maxstring
wal_minstring
wal_rangesStanzaWalRange[]
Show properties
Array of StanzaWalRange
database_idinteger<int64>
maxstringrequired
minstringrequired
repointeger<int64>required
statusstringrequired
Allowed:okerrornot_installed
default

Error

codestring

Stable code of the refusal, when the route has codes

detailsstring[]

Additional detail, e.g. per-field validation failures

errorstringrequired

Human-readable error message

Request
curl -X GET 'https://console.example.com/api/v1/servers/string/backups' \
  -H 'Cookie: tse_session=YOUR_API_KEY' \
  -H 'Accept: application/json'
Response
{
  "captured_at": "2019-08-24T14:15:22Z",
  "error": "string",
  "stanzas": [
    {
      "backups": [
        {
          "annotations": {
            "property1": "string",
            "property2": "string"
          },
          "archive_stop": "string",
          "checksum_errors": true,
          "database_id": 0,
          "database_size_bytes": 0,
          "label": "string",
          "older": true,
          "pg_version": "string",
          "prior_checksum_errors": true,
          "repo": 0,
          "size_bytes": 0,
          "start_time": "string",
          "stop_time": "string",
          "type": "string"
        }
      ],
      "coverage": {
        "assumes_archiving": true,
        "earliest": "string",
        "end": "string",
        "now": "string",
        "repos": [
          {
            "backups": [
              {
                "checksum_errors": true,
                "label": "string",
                "stop_time": "string"
              }
            ],
            "current_tli": 0,
            "database_id": 0,
            "earliest": "string",
            "grant_fingerprint": "string",
            "kind": "local",
            "older": true,
            "pg_version": "string",
            "repo": 0,
            "wal_max": "string",
            "wal_min": "string"
          }
        ]
      },
      "database_id": 0,
      "name": "string",
      "pg_version": "string",
      "status": "ok",
      "wal_max": "string",
      "wal_min": "string",
      "wal_ranges": [
        {
          "database_id": 0,
          "max": "string",
          "min": "string",
          "repo": 0
        }
      ]
    }
  ],
  "status": "ok"
}