Cancel Deployment
POST
/api/deployments/{deployment_id}/cancel
const url = 'https://example.com/api/deployments/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/cancel?organization_id=2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url 'https://example.com/api/deployments/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/cancel?organization_id=2489E9AD-2EE2-8E00-8EC9-32D5F69181C0' \ --header 'Authorization: Bearer <token>'Cancel a deployment.
Inserts a ‘force_cancel’ control_map_actions row and sets firmware_deployments.status = FAILED with error_message = ‘Cancelled by operator’. Idempotent: if the deployment is already FAILED the operation is a no-op and 204 is still returned.
Authorizations
Section titled “ Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “ Path Parameters ” deployment_id
required
Deployment Id
string format: uuid
Query Parameters
Section titled “ Query Parameters ” organization_id
required
Organization Id
string format: uuid
Responses
Section titled “ Responses ”Successful Response
Validation Error
Media type application/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Example generated
{ "detail": [ { "ctx": {}, "input": "example", "loc": [ "example" ], "msg": "example", "type": "example" } ]}