Skip to content

Get a backup

One backup run, with its status and the state of its stored file.

Updated

get

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

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: "3e5a7c9e-1b3d-4f5a-9b7c-8d0e2f4a6b8c"

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 run.

backup_runobjectrequired

status says how the backup went; artifact_state says what has become of the stored file since. A run that is done stays done even after its file is deleted.