Coolify Octri Demo
POST/deployments/{uuid}/cancel

Cancel a deployment

Cancels a deployment by UUID. Use this operation to stop a deployment that has not already finished, failed, or been cancelled. The 200 response includes the deployment UUID, status, and a confirmation message.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter
uuidstringrequired
The UUID of the deployment to cancel.

5 status codes
200Returns an object containing the deployment UUID, its status, and a confirmation message.
deployment_uuidstringoptional
messagestringoptional
statusstringoptional
400Returned when the deployment has already finished, failed, or been cancelled and cannot be cancelled.
messagestringoptional
401Returned when the request is unauthenticated.
messagestringoptional
403Returned when the authenticated user does not have permission to cancel the deployment.
messagestringoptional
404Returned when the deployment resource is not found.
messagestringoptional

Error handling

A 400 is returned when the deployment is already finished, failed, or cancelled, and a 401 is returned when the request is unauthenticated. A 403 is returned when the authenticated user does not have permission to cancel the deployment; a 404 indicates that the deployment resource was not found. The uuid path parameter must identify the deployment to cancel.