Workflow executions

Cancel an execution

Changed on

Cancels a running execution.

post/workflows/executions/{id}/cancel

Request

  • Base URL
    https://api.nullplatform.com
  • URL
    https://api.nullplatform.com/workflows/executions/{id}/cancel
  • Auth
    HTTP bearer

Path parameters

idstring required

The execution id.

Request body

reasonstring

Example request

{
  "reason": "superseded by a newer run"
}

Response

The cancellation was accepted.

acceptedtrue

Example response

{
  "execution": {
    "id": "exec_8f3a1b2c4d5e",
    "workflowId": "wf_ifWBbWfpug0n",
    "revision": 3,
    "aliasName": "live",
    "error": {
      "code": "HTTP_500"
    }
  }
}

Changes