Sign in
Beta
Batch Processing

Cancel Batch Job

Changed on

Cancel a running batch processing job.

Stops processing and marks all pending items as cancelled. Items currently being processed may complete depending on their state.

post/api/v1/beta/batch-processing/{job_id}/cancel

Request

  • The document declares no server URL.
  • Auth: HTTP bearer

Path parameters

job_idstring required

Query parameters

project_idstring uuid nullable
organization_idstring uuid nullable

Headers

temporal-namespacestring nullable

Cookies

sessionstring nullable

Request body

reasonstring nullable

Optional reason for cancelling the job

Response

Successful Response

job_idstring required

ID of the cancelled job

status'pending' | 'running' | 'dispatched' | 'completed' | 'failed' | 'cancelled' required

Status of a batch processing job.

processed_itemsinteger required

Number of items processed before cancellation

messagestring required

Confirmation message

Changes