Backups
Update a backup destination
Change a backup destination you added through the API, keeping its stored keys.
Updated
https://cloud.cahaves.com/api/destinations/{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: "8c0e2a4b-6d8f-4b1a-9c3e-5f7a9b1c3d5e"
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"
Body
application/jsonrequired
namestring
bucketstring
regionstring
endpointstring<uri>
An HTTPS S3-compatible endpoint with no path, query or credentials in it.
access_key_idstringwrite only
Required when adding. Left out of an update, the stored key is kept.
secret_access_keystringwrite only
Required when adding. Left out of an update, the stored key is kept.
Responses
application/json
The destination.
destinationobjectrequired
Leave the key fields out to keep the stored ones. The platform destination answers 409 with "Platform backup storage is managed by Cloud." A destination any schedule uses cannot move to another endpoint, bucket or region, and none can change while a backup to it is unfinished.