Skip to content
Install

Cancel an in-progress build

POST
/deployments/{id}/cancel
curl --request POST \
--url https://example.com/deployments/example/cancel \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "additionalProperty": "example" }'

Auth: authenticated (scope: deploy)

id
required
string
Media typeapplication/json
object
key
additional properties

Example generated

{
"additionalProperty": "example"
}

OK

Media typeapplication/json
object
deploymentId
required
string
message
required
string
success
required
boolean
key
additional properties

Example generated

{
"deploymentId": "example",
"message": "example",
"success": true
}