minimusdocs
Help center

Backups

List backups

GET/backups/runs/

read Read: looks, changes nothing. Scopes

Backups made by hand and by schedules, newest first, a page at a time. Panel operators only.

Query parameters

  • include_deletedboolean

    true to list deleted backups too.

  • pageinteger

    A page number within the paginated result set.

  • page_sizeinteger

    Number of results to return per page.

  • planstring

    Only backups of this schedule (its id), or manual for those started by hand.

  • statusstring

    Only these statuses, comma-separated: pending, running, uploading, completed, failed, cancelled.

Response

200 OK

  • countintegerrequired

    How many there are in all, on every page.

  • nextstring (uri)can be null

    The next page, or null on the last one.

  • previousstring (uri)can be null

    The page before, or null on the first one.

  • resultsobject[]required
    • idstring (uuid)requiredread-only
    • planstring (uuid)requiredread-onlycan be null
    • plan_namestringrequiredread-only
    • triggerstringrequiredread-only
    • trigger_labelstringrequiredread-only
    • scopestringrequiredread-only
    • componentsanyrequiredread-only

      The component keys this backup holds.

    • component_labelsstring[]requiredread-only
    • contents_labelstringrequiredread-only
    • encryptedbooleanrequiredread-only
    • compressionintegerrequiredread-only
    • statusstringrequiredread-only
    • status_labelstringrequiredread-only
    • phasestringrequiredread-only
    • bytes_doneintegerrequiredread-only
    • messagestringrequiredread-only
    • filenamestringrequiredread-only
    • size_bytesintegerrequiredread-only
    • sha256stringrequiredread-only
    • copiesobject[]requiredread-only
      • idstring (uuid)requiredread-only
      • destinationstring (uuid)can be null
      • destination_namestringrequired
      • kindstringrequired
        • local - This server
        • s3 - Object storage

        One of: "local" "s3"

      • kind_labelstringrequiredread-only
      • locationstring

        File path on this server, or object key.

      • statusstring
        • pending - Waiting
        • storing - Copying
        • stored - Stored
        • failed - Failed
        • deleted - Deleted

        One of: "pending" "storing" "stored" "failed" "deleted"

      • status_labelstringrequiredread-only
      • messagestring
      • stored_atstring (date-time)can be null
    • deleted_atstring (date-time)requiredread-onlycan be null
    • deleted_reasonstringrequiredread-only
    • can_downloadbooleanrequiredread-only
    • created_by_usernamestringrequiredread-only
    • created_atstring (date-time)requiredread-only
    • updated_atstring (date-time)requiredread-only
    • started_atstring (date-time)requiredread-onlycan be null
    • finished_atstring (date-time)requiredread-onlycan be null

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