Batch Terminate Executions

curl --request POST \
  --url https://control-plane.kubiya.ai/api/v1/executions/batch/terminate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "execution_ids": [
    "<string>"
  ],
  "reason": "<string>"
}
'

{
  "total_requested": 123,
  "total_succeeded": 123,
  "total_failed": 123,
  "results": [
    {
      "execution_id": "<string>",
      "success": true,
      "workflow_id": "<string>",
      "error": "<string>",
      "terminated_at": "2023-11-07T05:31:56Z"
    }
  ]
}

API Reference

Batch Terminate Executions

Terminate multiple executions in a single request.

This endpoint allows terminating multiple running executions at once. Each execution is processed independently, so some may succeed while others fail.

Args: request: FastAPI request object (contains kubiya_token in state) batch_request: Request body with list of execution IDs and termination reason organization: Current organization from auth db: Database session

Returns: BatchTerminateResponse with results for each execution

Note:

Maximum 100 executions per request
Each execution is terminated independently
Failed terminations don’t affect other executions in the batch

POST

api

executions

batch

terminate

Batch Terminate Executions

curl --request POST \
  --url https://control-plane.kubiya.ai/api/v1/executions/batch/terminate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "execution_ids": [
    "<string>"
  ],
  "reason": "<string>"
}
'

{
  "total_requested": 123,
  "total_succeeded": 123,
  "total_failed": 123,
  "results": [
    {
      "execution_id": "<string>",
      "success": true,
      "workflow_id": "<string>",
      "error": "<string>",
      "terminated_at": "2023-11-07T05:31:56Z"
    }
  ]
}

Authorizations

Authorization

string

header

required

Enter your Kubiya API token (format: Bearer )

Body

application/json

Request to terminate multiple executions

execution_ids

string[]

required

List of execution IDs to terminate

Required array length: 1 - 100 elements

reason

string

required

Termination reason

Required string length: 1 - 500

Response

Successful Response

Response after batch terminating executions

total_requested

integer

required

Total number of executions requested for termination

total_succeeded

integer

required

Number of successfully terminated executions

total_failed

integer

required

Number of failed terminations

results

BatchTerminateResult · object[]

required

Results for each execution

Show child attributes

Create Job Execution Update Job Execution Status V2

Documentation Index

Authorizations

Body

Response