Sign in

v1

latestOpenAPI 3.1.02026-07-22106199311.5 KB
Pipeline Execution

Pipeline termination

Cancel an executed pipeline, optionally forcing the termination

patch/v1/projects/{projectId}/pipeline-executions/{pipelineExecutionId}

Path parameters

projectIdstring required

The UUID of the pipeline's project

pipelineExecutionIdstring uuid required

ID of the pipeline execution, as returned when executing a pipeline

Request body

forceUpdateboolean required

If true, the execution will be forcefully terminated

status'CANCELLED' required

Cancel pipeline execution by updating status to CANCELLED

Example request

{
  "status": "CANCELLED"
}

Response

Pipeline execution cancelled (or hard cancelled) successfully

pipelineExecutionIdstring uuid

Identifier of executing pipeline

Example response

{
  "pipelineExecutionId": "1398aa31-af57-4a6a-9752-27c2e8556c3f"
}