Volumes
Attach a volume
Attach a named volume to an application, applied at its next deploy.
Updated
https://cloud.cahaves.com/api/volumes
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.
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
namestringrequired
mount_pathstringrequired
An absolute path. A segment that is only dots is refused.
service_idstring<uuid>required
backup_interval_hoursinteger | null
Daily is 24, weekly 168, every 30 days 720, and null schedules no archive. Absent is 24. An archive is scheduled only when platform backup storage is configured.
Allowed values: 24168720null
Responses
application/json
The attached volume.
volumeobjectrequired
Deploy the application afterwards: the mount applies at its next deploy. A 202 means the attachment is recorded but not yet confirmed; send the same request again to complete it. Until it is confirmed, the service cannot be deployed, stopped, started, changed or backed up.
backup_interval_hours defaults to 24 and schedules an automatic archive of the volume when platform backup storage is configured; send null for none.