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

Check a restore archive

Decrypts the archive with the recovery key, checks each file, applies the version rules, and gives the summary and the differences with this console. It refuses (409) an archive of another console, of a demo or production console of the other kind, or with another TSE_DB_ENCRYPTION_KEY or TSE_MESH_SUBNET: restore such an archive with ./timescale-enterprise.sh –restore. It writes nothing. The console never stores the key.

POST/api/v1/console-backup/restore/check
Authorization
tse_sessionAPI key · cookierequired
Request body
requiredapplication/json
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
200

OK

archive_idstringrequired
confirm_namestringrequired

The name of this console. The restore needs it as confirm_name

console_namestringrequired
created_atstring<date-time>required
filesinteger<int64>required
key_fingerprintstringrequired

The fingerprint of the recovery key that opened the archive

loaded_packsstring[]required
nowConsoleRestoreNowrequired

This console now, for the differences with the archive

Show properties
releasestringrequired
serversinteger<int64>required
servicesinteger<int64>required
releasestringrequired
running_workflowsConsoleRestoreWorkflow[]required

The workflows that ran at the time of the backup. The restore marks them interrupted

Show properties
Array of ConsoleRestoreWorkflow
idstringrequired
operationstringrequired
started_atstringrequired
target_namestring
serversinteger<int64>required
servicesinteger<int64>required
sizeinteger<int64>required

The size of the files of the archive, in bytes

tiersstring[]required
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/check' \
  -H 'Cookie: tse_session=YOUR_API_KEY' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "string",
  "recovery_key": "string",
  "target_id": "string",
  "upload_id": "string"
}'
Response
{
  "archive_id": "string",
  "confirm_name": "string",
  "console_name": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "files": 0,
  "key_fingerprint": "string",
  "loaded_packs": [
    "string"
  ],
  "now": {
    "release": "string",
    "servers": 0,
    "services": 0
  },
  "release": "string",
  "running_workflows": [
    {
      "id": "string",
      "operation": "string",
      "started_at": "string",
      "target_name": "string"
    }
  ],
  "servers": 0,
  "services": 0,
  "size": 0,
  "tiers": [
    "string"
  ]
}