Services
Deploy a service
Start a deployment of a service, one at a time for each service.
Updated
https://cloud.cahaves.com/api/services/{id}/deploy
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
The service's id.
Example: "0b9e4d2a-7c13-4f6e-a8d5-3e1c9b7f2a40"
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/jsonoptional
titlestring | null
A label for the deployment, shown in its list.
Responses
application/json
The deployment, accepted.
deploymentobjectrequired
Answers 202 with the deployment as it is queued. Follow it with Get a deployment, or read its build log over the log socket.
A service allows one deployment at a time. A deployment already running, unfinished backup work, an unconfirmed volume attachment and a suspended account each answer 409 with a fixed sentence, listed in Errors.
Deploying a paid service is paid work: an organization not in good standing, or stopped for billing, answers 409 with a reason. A deployment of a paid service still queued or building when its organization is stopped for billing ends cancelled, reading "Deployment cancelled because paid services in this organization are stopped for billing."