Skip to main content
POST
Cancel workflow run

Authorizations

X-API-Key
string
header
required

Workflow engine API access key.

Path Parameters

run_id
string
required

Run ID.

Body

application/json
reason
string

Optional cancel reason. When provided, it is stored as the run error message.

Response

Workflow run result.

code

Business code. A successful response is usually success or 200.

message
string

Response message.

tips
string | null

Details. Defaults to null.

data
object