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

Get a backup run

Get a run of the console backups.

GET/api/v1/console-backup/runs/{id}
Authorization
tse_sessionAPI key · cookierequired
Path parameters
idstringrequired
Responses
200

OK

archive_namestring

The archive of the run. A run that failed its read-back check also has an archive (check_failed)

errorstring
finished_atstring<date-time>
idstringrequired
schedule_idstring

The schedule of the run. Not set for a manual run

sizeinteger<int64>required

The size of the archive in bytes

started_atstring<date-time>required
started_bystringrequired
statusstringrequired

skipped: a scheduled run found a backup running; error has the reason. archived: the run that made the archive of a restore. Only a restored console has it

Allowed:runningsucceededfailedskippedarchived
target_idstringrequired
tiersstring[]required
triggerstringrequired

manual: an admin started the backup. schedule: a schedule started it at its tick. change: a backup after changes ran the schedule

Allowed:manualschedulechange
warningstring

A problem that did not fail the run, for example a delete of the retention that the target refused

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/runs/string' \
  -H 'Cookie: tse_session=YOUR_API_KEY' \
  -H 'Accept: application/json'
Response
{
  "archive_name": "string",
  "error": "string",
  "finished_at": "2019-08-24T14:15:22Z",
  "id": "string",
  "schedule_id": "string",
  "size": 0,
  "started_at": "2019-08-24T14:15:22Z",
  "started_by": "string",
  "status": "running",
  "target_id": "string",
  "tiers": [
    "string"
  ],
  "trigger": "manual",
  "warning": "string"
}