runs

Cancel runs in bulk

Cancels up to 100 runs in one environment.

Supports two modes:

  • By IDs: provide run_ids in the request body to cancel specific runs. Query filters are ignored.
  • By filter: omit run_ids and use the query parameters to match runs.

Only runs with status scheduled, queued or started are cancelled; other selected runs are skipped. A selection of more than 100 cancellable runs returns 422.

Required permission: runs.cancel.

post/v1/projects/{project_id}/runs/bulk-cancel

Request

  • Base URL: https://api.connic.co
  • URL: https://api.connic.co/v1/projects/{project_id}/runs/bulk-cancel
  • Auth: HTTP bearer

Path parameters

project_idstring uuid required

ID of the project the API key belongs to.

Query parameters

environment_idstring uuid required

Environment to cancel runs in; only its runs are selected.

deployment_idstring uuid nullable

Only runs executed by this deployment.

start_datestring date-time nullable

Only runs queued at or after this time; applies only together with end_date.

end_datestring date-time nullable

Only runs queued at or before this time; applies only together with start_date.

status_filterRunStatus[] nullable

Only runs in these statuses. Only scheduled, queued and started runs can be cancelled, so other values match no runs.

guardrail_outcomestring[] nullable

Only runs with at least one guardrail intervention of these outcomes.

agent_namestring nullable

Only runs of this agent.

test_namestring[] nullable

Filter by A/B test variant names; use base for runs without a variant

exclude_test_runsboolean

Exclude runs with a test name

searchstring nullable

Run search text or filter expression, as in GET /runs.

Request body

run_idsstring[] nullable

IDs of the runs to cancel, at most 100. Omit or send null to select runs with the query filters instead; an empty list is rejected.

Response

Successful Response

okboolean required

Whether the operation succeeded.

cancelled_countinteger required

Number of runs cancelled.

Changes

No recorded changes to this operation across all 2 revisions of this API.