POST /v1/automation/runs/{runID}/cancel

POST/v1/automation/runs/{runID}/cancel

Authorization

bearerAuthbearerAuthrequired

apiKeyAuthapiKeyAuthrequired

Path parameters

runIDstringrequired

Request body

requiredapplication/json

reasonstring

Responses

200OK

created_atstring

errorany

event_idstring

idstringrequired

inputany

outputany

statusstringrequired

stepsRunStepItem[] | null

Show properties

Array of RunStepItem

attemptinteger<int32>required

created_atstring

errorany

finished_atstring

idstringrequired

inputany

max_attemptsinteger<int32>required

node_idstringrequired

node_typestringrequired

outputany

run_idstringrequired

scheduled_atstring

started_atstring

statusstringrequired

updated_atstring

workflow_idstringrequired

workflow_version_idstringrequired

defaultError

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

Request

curl -X POST "/v1/automation/runs/string/cancel" \
  -H "Content-Type: application/json" \
  -d '{
  "reason": "string"
}'

const response = await fetch("/v1/automation/runs/string/cancel", {
  method: "POST",
  headers: {
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "reason": "string"
})
});

import requests

response = requests.post(
    "/v1/automation/runs/string/cancel",
    headers={
        "Content-Type": "application/json"
    },
    json={
  "reason": "string"
},
)

Response

{
  "created_at": "string",
  "error": "string",
  "event_id": "string",
  "id": "string",
  "input": "string",
  "output": "string",
  "status": "string",
  "steps": [
    {
      "attempt": 0,
      "created_at": "string",
      "error": "string",
      "finished_at": "string",
      "id": "string",
      "input": "string",
      "max_attempts": 0,
      "node_id": "string",
      "node_type": "string",
      "output": "string",
      "run_id": "string",
      "scheduled_at": "string",
      "started_at": "string",
      "status": "string",
      "updated_at": "string"
    }
  ],
  "updated_at": "string",
  "workflow_id": "string",
  "workflow_version_id": "string"
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}