Cancel Bulk Job — POST /api/v1/agents/pipelines/bulk-jobs/{bulk_job_id}/cancel
Cancel Bulk Job
Cancel a bulk job: its tasks that have NOT started return at their first line without creating a pipeline; running pipelines keep their own Stop. Idempotent (an already-cancelled job answers 200 and records nothing new); a finished job is a 409. One analysis.bulk_cancelled per project.
Endpoint: POST /api/v1/agents/pipelines/bulk-jobs/{bulk_job_id}/cancel
Authentication: Send a signed-in user’s access token in Authorization: Bearer <access token>, or an API key in X-API-Key: <API key>.
- Your role must be QA engineer or higher.
Parameters
Section titled “Parameters”| Name | In | Required | Type | Default | Description |
|---|---|---|---|---|---|
bulk_job_id | path | yes | string (uuid) | ||
X-API-Key | header | no | string or null | API key, as an alternative to the access token (see Authentication). |
Request body
Section titled “Request body”No request body.
Responses
Section titled “Responses”| Status | Meaning | Body |
|---|---|---|
200 | Successful Response | BulkJobRead (application/json) |
422 | Validation Error | HTTPValidationError (application/json) |
Errors this endpoint returns, read from its source code:
404409
It can also return 401 if your credential is missing or expired, 403 if your credential does not allow this request, and 404 if the item does not exist or you cannot see it. Your role, your project membership and the key’s scope decide what a credential allows. See Errors and retries.
More details
Section titled “More details”- Group: Agents
- Operation ID:
cancel_bulk_job_api_v1_agents_pipelines_bulk_jobs__bulk_job_id__cancel_post - Source code:
backend/app/routers/agents.py, line 1051 - Specification: OpenAPI JSON