minimusdocs
Help center

Backups

Add backup storage

POST/backups/storage/

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

kind local needs a folder; kind s3 needs a storage (a storage connection from Settings → Storage). Panel operators only.

Body

  • namestringrequired
  • kindstringrequired
    • local - This server
    • s3 - Object storage

    One of: "local" "s3"

  • folderstring
  • storagestring (uuid)can be null
  • is_defaultboolean

    Ticked when a backup is started by hand.

Response

201 OK

  • idstring (uuid)requiredread-only
  • namestringrequired
  • kindstringrequired
    • local - This server
    • s3 - Object storage

    One of: "local" "s3"

  • folderstring
  • storagestring (uuid)can be null
  • storage_namestringrequiredread-only
  • is_defaultboolean

    Ticked when a backup is started by hand.

  • locationstringrequiredread-only
  • schedulesstring[]requiredread-only
  • last_checked_atstring (date-time)requiredread-onlycan be null
  • last_check_okbooleanrequiredread-onlycan be null
  • last_check_messagestringrequiredread-only
  • created_atstring (date-time)requiredread-only
  • updated_atstring (date-time)requiredread-only

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.
  • 429 Slow down: wait the seconds in the Retry-After header, then try again.

What each error means