minimusdocs
Help center

Backups

Restore from a backup

POST/backups/runs/{id}/restore/

manage Delete and money: deletes, credits, servers or panel settings. Scopes

Prepares a restore from a stored backup and answers with a backup import (201). Then check it and restore it with the backup import calls. Panel operators only.

Path parameters

  • idstring (uuid)required

    A UUID string identifying this Backup.

Response

201 OK

  • idstringrequired
  • filenamestringrequired
  • size_bytesintegerrequired
  • receivedintegerrequired

    Bytes uploaded so far.

  • statusstringrequired
    • uploading - uploading
    • ready - ready
    • restoring - restoring
    • completed - completed
    • failed - failed

    One of: "uploading" "ready" "restoring" "completed" "failed"

  • phasestringrequired
  • messagestringrequired
  • created_bystringrequired
  • created_atstringrequired
  • updated_atstringrequired
  • encryptedboolean
  • archiveobjectrequired

    What the file holds; empty until it is checked.

    • created_atstring
    • scopestring
    • contents_labelstring
    • componentsobject[]

      {key, label, kind} for each part the file holds.

    • filesstring[]
    • databaseobject
    • panel_imagestring
    • adminsobject[]

      {username, is_active} of the administrators in the file.

    • admins_knownboolean
    • accountsobject
    • problemstringcan be null

      Why this file cannot be restored here, if it cannot.

  • optionsobjectrequired

    What the restore was asked to do.

  • outcomeobjectrequired

    What the restore did, once it has finished.

  • chunk_bytesinteger

    Only when the upload starts: send the file in pieces of at most this size.

  • expected_offsetinteger

    Only when a piece was not written: send again from this byte.

  • adminsobject

    Only after a check: the file's administrators against this panel's.

    • knownbooleanrequired

      False for older backups that do not record their administrators.

    • theirsstring[]required
    • minestring[]required
    • only_theirsstring[]required
    • only_minestring[]required
    • differbooleanrequired
    • none_in_backupbooleanrequired

Errors

  • 400 Something sent is not valid. Each field that is wrong is named with what is wrong.
  • 401 No credential, or one that is wrong, expired or revoked.
  • 403 The account, or the key's or app's scopes, may not do this.
  • 404 Nothing with this id, or nothing the account can see.
  • 409 Not now: the answer says why.
  • 429 Slow down: wait the seconds in the Retry-After header, then try again.

What each error means