Skip to content

Cancel Deployment

POST
/api/deployments/{deployment_id}/cancel

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

Parameters

Path Parameters

deployment_id
required
string format: uuid

Query Parameters

organization_id
required
string format: uuid

Responses

204

Successful Response

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string