v29

latestOpenAPI 3.1.0raw.githubusercontent.com2026-03-233765161.7 KB

v1 data

Cancel an ingest job and all its sub-jobs

Cancel a running or queued ingestion job and all of its descendant sub-jobs.

Jobs that are already completed ('done') or failed ('error') will not be affected.
Cancelled jobs will be skipped by the ingester when Cloud Tasks delivers them.

**Request Parameters:**
- job_id (str, required): The root job ID to cancel (returned from /ingest)

**Response:**
- job_id (str): The root job ID
- cancelled_count (int): Number of jobs cancelled (parent + descendants)
- status (str): 'cancelled' if any jobs were cancelled, 'already_terminal' if all were already done/error

Requires JWT authentication.

post/v1/data/job/cancel

Request body

job_idstring required

Unique identifier for the job to cancel

Example request

{
  "job_id": "456e7890-e89b-12d3-a456-426614174001"
}

Response

Successful Response

job_idstring required

The root job ID that was cancelled

cancelled_countinteger required

Number of jobs cancelled (including descendants)

statusstring required

Result status: 'cancelled' or 'already_terminal'

Example response

{
  "cancelled_count": 5,
  "job_id": "456e7890-e89b-12d3-a456-426614174001",
  "status": "cancelled"
}