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

Get the restore state

The restore that runs now, and the latest restore of this console for the banner of the admins.

GET/api/v1/console-backup/restore
Authorization
tse_sessionAPI key · cookierequired
Responses
200

OK

jobConsoleRestoreJobrequired
Show properties
archive_created_atstring<date-time>
archive_idstring
archive_namestring
errorstring
pre_restore_backupstring

The backup of the state before the restore, in the directory pre-restore of the local backup directory

started_atstring<date-time>
started_bystring
statestringrequired

running: the console backs up its current state and stages the archive. restarting: the console stops its container; Docker starts it again with the restored state. failed: the restore stopped; error has the reason, and the console did not change

Allowed:idlerunningfailedrestarting
stepstring

The step of a running restore: backing_up or staging

last_restoreConsoleRestoreLast

The latest restore of this console. Not set: the console was never restored

Show properties
archive_created_atstring<date-time>required

The time of the backup that the console was restored from

archive_idstringrequired
dismissedbooleanrequired

An admin dismissed the banner of the restore

errorstring

The reason of a failed restore

releasestringrequired

The release of the archive

restored_atstring<date-time>required

The first start after the restore. Each session from before this time was ended. For a failed restore: the time of the failed swap

restored_bystringrequired
statusstringrequired

applied: the console runs on the files of the archive. failed: the swap failed and rolled back; the console runs on its files from before the restore, and error has the reason

Allowed:appliedfailed
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/restore' \
  -H 'Cookie: tse_session=YOUR_API_KEY' \
  -H 'Accept: application/json'
Response
{
  "job": {
    "archive_created_at": "2019-08-24T14:15:22Z",
    "archive_id": "string",
    "archive_name": "string",
    "error": "string",
    "pre_restore_backup": "string",
    "started_at": "2019-08-24T14:15:22Z",
    "started_by": "string",
    "state": "idle",
    "step": "string"
  },
  "last_restore": {
    "archive_created_at": "2019-08-24T14:15:22Z",
    "archive_id": "string",
    "dismissed": true,
    "error": "string",
    "release": "string",
    "restored_at": "2019-08-24T14:15:22Z",
    "restored_by": "string",
    "status": "applied"
  }
}