minimusdocs
Help center

Backups

Get the backups overview

GET/backups/overview/

read Read: looks, changes nothing. Scopes

What a backup can hold (with sizes), the choices for schedules and storage, free disk space, the last and next backup, and what the signed-in account may do. Panel operators only.

Response

200 OK

  • componentsobject[]required
    • keystringrequired

      What components lists when you choose what to back up.

    • labelstringrequired
    • descriptionstringrequired
    • kindstringrequired
      • data - data
      • logs - logs
      • files - files

      One of: "data" "logs" "files"

    • kind_labelstringrequired
    • requiresstring[]required

      Other parts always backed up with this one.

    • availablebooleanrequired
    • unavailable_reasonstringrequired
    • sensitivebooleanrequired

      Holds passwords or keys.

    • size_bytesintegerrequired
    • rowsintegerrequiredcan be null

      Null when unknown, and for files.

  • scopesobject[]required
    • valuestringrequired
    • labelstringrequired
  • frequenciesobject[]required
    • valuestringrequired
    • labelstringrequired
  • compressionsobject[]required
    • valuestringrequired
    • labelstringrequired
  • destination_kindsobject[]required
    • valuestringrequired
    • labelstringrequired
  • diskobjectrequired
    • pathstringrequired
    • total_bytesinteger
    • free_bytesinteger
    • errorstring

      Only when the folder cannot be read.

  • pg_dumpstringrequiredcan be null

    The database dump tool's version, if installed.

  • storedobjectrequired
    • countintegerrequired
    • size_bytesintegerrequired
  • healthobjectrequired
    • last_success_atstring (date-time)requiredcan be null
    • last_success_sizeintegerrequiredcan be null
    • last_failure_atstring (date-time)requiredcan be null
    • next_run_atstring (date-time)requiredcan be null
    • next_planstringrequiredcan be null

      The schedule that runs next.

    • runningbooleanrequired
    • warningstringrequiredcan be null
  • canobjectrequired

    What the signed-in account may do here.

    • runbooleanrequired
    • downloadbooleanrequired
    • deletebooleanrequired
    • manage_schedulesbooleanrequired
    • manage_storagebooleanrequired
    • restorebooleanrequired

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