Skip to content

Run a backup now

Start a backup from a schedule outside its timer.

Updated

post

https://cloud.cahaves.com/api/backup-schedules/{id}/run

Authorization

cahaves.cloud.sessionstringcookierequired

The session cookie Cloud sets when a customer signs in to the console with GitHub or Google. It is HttpOnly, so scripts cannot read it, and there are no API keys or tokens yet.

Path parameters

idstring<uuid>required

Example: "1d3f5b7a-9c1e-4d2f-8a4b-6c8e0a2b4d6f"

Headers

X-Cloud-Organizationstring<uuid>

The id of the organization the request works in, one the signed-in customer owns. Left out or empty, the request works in their oldest organization. Any other value answers 404 with `reason: "organization"`. A customer with no organization yet gets 409 "Create an organization first." from every route that works in one.

Example: "2f6c8e0a-4b1d-4e7f-9a3c-5d7e9f1b3a5c"

Responses

application/json

The backup run, accepted.

backup_runobjectrequired

Runs whether or not the schedule's timer is enabled, and the next timed run does not move. Follow the run with Get a backup.

A service runs one backup at a time, so unfinished backup work answers 409, as do a deployment in progress, an unconfirmed volume attachment, a suspended account and a destination that is not configured.