Sign in

Cancel a pipeline run (operator)

post/pipelines/{pipelineId}/runs/{runId}/cancel

Request

  • Base URL: /api/v1 (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/v1/pipelines/{pipelineId}/runs/{runId}/cancel
  • Auth: HTTP bearer

Path parameters

pipelineIdstring required
runIdstring required

Response

Cancelled run

idstring required
pipeline_idstring required
org_idstring required
status'idle' | 'running' | 'completed' | 'errored' | 'cancelled' required
current_stageinteger required
total_stagesinteger required
created_bystring required
started_atstring date-time required
finished_atstring date-time nullable
created_atstring date-time required
updated_atstring date-time required

Changes

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