Skip to main content
POST
Cancel deployment

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Request body schema.

uuid
string<uuid>
required

Identifier of the deployment to cancel.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$

Response

Successful response

deployment
Deployment · object
required

Deployment row at the time the cancel signal was sent. The status will flip to cancelled once the workflow's nonCancellable scope finishes writing the terminal row; clients should refetch shortly after.