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.
/api/v1/console-backup/restore/checktse_sessionAPI key · cookierequiredapplication/jsonnamestringThe name of the archive on the target
recovery_keystringrequiredThe recovery key (AGE-SECRET-KEY-1...). The console keeps it in memory for the restore only; it never stores or logs it
target_idstringThe target of the archive. Set target_id and name, or upload_id
upload_idstringThe id of an uploaded archive
OK
archive_idstringrequiredconfirm_namestringrequiredThe name of this console. The restore needs it as confirm_name
console_namestringrequiredcreated_atstring<date-time>requiredfilesinteger<int64>requiredkey_fingerprintstringrequiredThe fingerprint of the recovery key that opened the archive
loaded_packsstring[]requirednowConsoleRestoreNowrequiredThis console now, for the differences with the archive
Show propertiesHide properties
releasestringrequiredserversinteger<int64>requiredservicesinteger<int64>requiredreleasestringrequiredrunning_workflowsConsoleRestoreWorkflow[]requiredThe workflows that ran at the time of the backup. The restore marks them interrupted
Show propertiesHide properties
ConsoleRestoreWorkflowidstringrequiredoperationstringrequiredstarted_atstringrequiredtarget_namestringserversinteger<int64>requiredservicesinteger<int64>requiredsizeinteger<int64>requiredThe size of the files of the archive, in bytes
tiersstring[]requiredError
codestringStable code of the refusal, when the route has codes
detailsstring[]Additional detail, e.g. per-field validation failures
errorstringrequiredHuman-readable error message