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.
/api/v1/console-backup/restoretse_sessionAPI key · cookierequiredapplication/jsonconfirm_namestringrequiredThe name of this console (confirm_name of the check)
namestringThe 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
Accepted
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
Error
codestringStable code of the refusal, when the route has codes
detailsstring[]Additional detail, e.g. per-field validation failures
errorstringrequiredHuman-readable error message