Cancel workflow execution

Cancels a workflow, stopping its execution permanently

Path Params
uuid
required

Unique identifier of the workflow to cancel

Body Params

Cancel workflow request

string
length ≤ 500

optional reason for the cancel

boolean
Defaults to false

Force immediate execution, clearing pending commands and interrupting running steps

Headers
string

32 bytes buffer (24 randomly generated bytes by the client + 8 bytes epoch timestamp seconds) encoded to hex:

const nonce = Buffer.alloc(32); nonce.fill(crypto.randomBytes(24), 0, 24);

const nowEpochSeconds = Math.floor(new Date().getTime() / 1000); const t = BigInt(nowEpochSeconds); nonce.writeBigInt64BE(t, 24);

Responses

Language
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json