v3
latestOpenAPI 3.0.02026-08-081996601.2 MBPipeline Runs
Cancel pipeline run
Requests cancellation of an in-progress pipeline run. The run stops at the next checkpoint. It may take a moment to transition to the cancelled state. Runs that already completed, failed, or were cancelled cannot be cancelled again.
post/v2/pipelines/{pipeline_key}/runs/{run_id}/cancel
Path parameters
pipeline_keystring required
The unique key for the pipeline. You can provide the key, or the platform generates one.
Example:sharepoint-legal-ingest
The unique key of the pipeline.
run_idstring required
The unique identifier for a pipeline run.
Example:run_pip_abc_manual_550e8400
The unique identifier of the run.
Headers
Request-Timeoutinteger
The platform makes a best effort to complete the request in the specified seconds, or it times out.
Request-Timeout-Millisinteger
The platform makes a best effort to complete the request in the specified milliseconds, or it times out.
Response
Cancellation is requested.