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

Start a console restore

Checks the archive as the check does, and needs the name of this console. Refused (409) while a workflow or a console backup runs. From the start, the console refuses new workflows, enrollments and console backups. It backs up its current state (Core and Logs) to the directory pre-restore of the local backup directory, stages the archive, and restarts its container. After the restart, every user logs in again. Poll get-console-restore for the state.

POST/api/v1/console-backup/restore
Authorization
tse_sessionAPI key · cookierequired
Request body
requiredapplication/json
confirm_namestringrequired

The name of this console (confirm_name of the check)

namestring

The name of the archive on the target

recovery_keystringrequired

The recovery key (AGE-SECRET-KEY-1...). The console keeps it in memory for the restore only; it never stores or logs it

target_idstring

The target of the archive. Set target_id and name, or upload_id

upload_idstring

The id of an uploaded archive

Responses
202

Accepted

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

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 POST 'https://console.example.com/api/v1/console-backup/restore' \
  -H 'Cookie: tse_session=YOUR_API_KEY' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "confirm_name": "string",
  "name": "string",
  "recovery_key": "string",
  "target_id": "string",
  "upload_id": "string"
}'
Response
{
  "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"
}