Cancel Workflow

Cancel a running workflow.

Sends a cancellation request to the workflow. The workflow can handle the cancellation gracefully by catching the CancelledError.

Query parameters (handled by downstream service):

• run_id: Specific run ID to cancel

POST /api/v1/temporal-workflows/workflows/{workflow_id}/cancel

Cancel Workflow

cURL

curl --request POST \
  --url https://control-plane.kubiya.ai/api/v1/temporal-workflows/workflows/{workflow_id}/cancel \
  --header 'Authorization: Bearer <token>'

422

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

Authorization · string · header · required

Enter your Kubiya API token (format: Bearer )

Path Parameters

workflow_id · string · required

Response

200

application/json

Successful Response