Skip to main content
POST
/
api
/
v1
/
executions
/
{execution_id}
/
terminate
Terminate Execution
curl --request POST \
  --url https://control-plane.kubiya.ai/api/v1/executions/{execution_id}/terminate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "reason": "<string>"
}
'
{
  "success": true,
  "workflow_id": "<string>",
  "terminated_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Enter your Kubiya API token (format: Bearer )

Path Parameters

​
execution_id
string
required

Body

application/json

Request to terminate a running workflow

​
reason
string
required

Termination reason

Required string length: 1 - 500

Response

Successful Response

Response after terminating a workflow

​
success
boolean
required

Whether termination was successful

​
workflow_id
string
required

Workflow ID that was terminated

​
terminated_at
string<date-time>
required

Termination timestamp