Skip to main content

Restore this instance from a remote

POST 
/api/restore_instance

Replaces every setting, user, role, project, template group and catalog subscription on this grid with what's in the remote instance repository. A fully destructive, one-shot action with no merge and no undo; the frontend is expected to have the operator confirm that before this is ever called.

Authenticates with the instance's own backup SSH key rather than with the acting user's - restoring the whole grid is an instance-level operation, not a personal one.

Gated on Backup settings; also requires Server settings here, since the restore is only actually finished once the frontend's follow-up restart_grid call succeeds, and that route needs Server settings itself - the one role that can trigger a restore should be guaranteed able to complete it.

Request​

Responses​

Successful Response