Get the restore state
The restore that runs now, and the latest restore of this console for the banner of the admins.
/api/v1/console-backup/restoretse_sessionAPI key · cookierequiredOK
jobConsoleRestoreJobrequiredShow propertiesHide properties
archive_created_atstring<date-time>archive_idstringarchive_namestringerrorstringpre_restore_backupstringThe backup of the state before the restore, in the directory pre-restore of the local backup directory
started_atstring<date-time>started_bystringstatestringrequiredrunning: 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
idlerunningfailedrestartingstepstringThe step of a running restore: backing_up or staging
last_restoreConsoleRestoreLastThe latest restore of this console. Not set: the console was never restored
Show propertiesHide properties
archive_created_atstring<date-time>requiredThe time of the backup that the console was restored from
archive_idstringrequireddismissedbooleanrequiredAn admin dismissed the banner of the restore
errorstringThe reason of a failed restore
releasestringrequiredThe release of the archive
restored_atstring<date-time>requiredThe first start after the restore. Each session from before this time was ended. For a failed restore: the time of the failed swap
restored_bystringrequiredstatusstringrequiredapplied: 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
appliedfailedError
codestringStable code of the refusal, when the route has codes
detailsstring[]Additional detail, e.g. per-field validation failures
errorstringrequiredHuman-readable error message