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

List backup archives

Reads the sidecars of each target, so the list also shows the archives that are newer than the store, and the archives of other consoles.

GET/api/v1/console-backup/archives
Authorization
tse_sessionAPI key · cookierequired
Query parameters
target_idstring

List only this target

Responses
200

OK

archivesBackupArchiveItem[]required

The archives of each target, the newest first

Show properties
Array of BackupArchiveItem
archive_idstringrequired
check_failedbooleanrequired

The read-back after the upload did not match

console_idstringrequired
console_namestringrequired
created_atstring<date-time>required
last_checkBackupArchiveCheck

The last check on demand

Show properties
atstring<date-time>required
errorstring
okbooleanrequired

The archive read back from the target matches the size and the SHA-256 of its sidecar

manualbooleanrequired

An admin started the backup; no schedule made it

namestringrequired
recipientsBackupArchiveRecipient[]required

The keys that can open the archive

Show properties
Array of BackupArchiveRecipient
fingerprintstringrequired
labelstringrequired

current key, earlier key (<date>) or unknown key

releasestringrequired
schedule_idstring
sizeinteger<int64>required

The size of the archive object. -1: the target has the sidecar, but no archive

target_idstringrequired
target_namestringrequired
this_consolebooleanrequired

The archive is of this console. An archive of another console can only be downloaded

tiersstring[]required
targetsBackupTargetListStatus[]required

The targets of the list, with an error for a target that the console could not list

Show properties
Array of BackupTargetListStatus
errorstring

Why the console could not list the target, or the sidecars that do not read. The archive of a sidecar that does not read does not show

target_idstringrequired
target_namestringrequired
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/console-backup/archives' \
  -H 'Cookie: tse_session=YOUR_API_KEY' \
  -H 'Accept: application/json'
Response
{
  "archives": [
    {
      "archive_id": "string",
      "check_failed": true,
      "console_id": "string",
      "console_name": "string",
      "created_at": "2019-08-24T14:15:22Z",
      "last_check": {
        "at": "2019-08-24T14:15:22Z",
        "error": "string",
        "ok": true
      },
      "manual": true,
      "name": "string",
      "recipients": [
        {
          "fingerprint": "string",
          "label": "string"
        }
      ],
      "release": "string",
      "schedule_id": "string",
      "size": 0,
      "target_id": "string",
      "target_name": "string",
      "this_console": true,
      "tiers": [
        "string"
      ]
    }
  ],
  "targets": [
    {
      "error": "string",
      "target_id": "string",
      "target_name": "string"
    }
  ]
}