minimusdocs
Help center

Backups

Run a backup schedule now

POST/backups/schedules/{id}/run/

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

Starts a backup from this schedule in the background and answers with it (202). Refused (409) while the schedule is already running. Panel operators only.

Path parameters

  • idstring (uuid)required

    A UUID string identifying this Backup Schedule.

Response

202 OK

  • 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

  • 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