Deployments
Cancel a deployment
Cancel a deployment that has not finished, at once or through the engine.
Updated
https://cloud.cahaves.com/api/deployments/{id}/cancel
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: "9d2c7e1b-4a6f-4b3e-8e0d-5f1a2c3b4d6e"
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 deployment, cancelled or marked for cancelling.
deploymentobjectrequired
A queued deployment never reached the engine, so it ends cancelled at once. One already handed to the engine is stopped there, and the answer keeps its in-progress status until the engine reports; display_status then reads cancelled.
A deployment that is done, error or cancelled answers 409 with "This deployment has already finished." A 502 means the engine did not stop it, and it is still running.