Sign in
backups

restore central server configuration from backup

<h3>Administrator restores the central server configuration from backup.</h3> <p>This endpoint can also return metadata in the error response. The metadata array contains the output of a failed backup restore script.</p>
put/backups/{filename}/restore

Request

  • Base URL: /api/v1 (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/v1/backups/{filename}/restore
  • Auth: API key in header Authorization

Path parameters

filenamestring filename required

filename of the backup

Response

restore was successful

hsm_tokens_logged_outboolean

whether any hsm tokens were logged out during the restore process

Changes

No recorded changes to this operation across all 50 revisions of this API.