Backups

List backup storage

GET/backups/storage/

read Read: looks, changes nothing. Scopes

Where backups can be kept: folders on this server, or a folder in a storage bucket. Panel operators only.

Response

200 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

  • 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