Cancel Run

Ask a run to stop. A run still waiting to start is cancelled at once and answers status "cancelled". A running run stops at its next checkpoint and then reports status "cancelled". Finished runs are unaffected.

POST

Path

Path parameters

stringrequired

The run's id, from Run a Workflow or List Runs.

Headers

Optional headers

string

Optional. The id of a child organization of your API key's company to act on. Leave it out to act on the key's own company. See Child organizations.

Response fields

idstring

The run that was asked to stop.

statusstring

"cancelled" when the run had not started and was cancelled at once; otherwise the run status when the cancellation was requested, and the run reports "cancelled" once it stops.

Try this request

API Key

Request

curl --request POST \
  --url 'https://connect.mindcloud.co/v2/runs/Rm4pQ7sJt1Ve/cancel' \
  --header 'Authorization: Bearer $MINDCLOUD_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{}'

{
  "success": true,
  "data": {
    "id": "Rm4pQ7sJt1Ve",
    "status": "running"
  }
}