Overview

Cancels an in-progress pipeline run. Use this endpoint when you need to stop an execution that is taking too long, consuming unexpected resources, or was triggered by mistake.

Path Parameters

Example

Cancel a Running Execution

POST /platform/pipeline/1b33ad2f_33d3_4837_9eeb_83c82c8b909d/pipeline_run/b3c4d5e6_7f8a_9b0c_1d2e_3f4a5b6c7d8e/cancel

Response (200 OK):

{
  "detail": "Pipeline run cancelled successfully.",
  "airflow_status": true
}

Error Responses

404 Not Found

{
  "msg": "Pipeline run not found."
}

409 Conflict — Run Not Cancellable

Returned when the run is already in a terminal state (SUCCESS, FAILED, or CANCELLED).

{
  "msg": "Pipeline run is not in a cancellable state.",
  "current_status": "SUCCESS"
}

500 Internal Server Error

{
  "msg": "There was an error cancelling the pipeline run.",
  "error": "Unexpected error"
}

Response Fields

When to Cancel

Use Cases

Cancel a Long-Running Execution

# 1. Check the current status
GET /platform/pipeline/1b33ad2f_33d3_4837_9eeb_83c82c8b909d/pipeline_run/b3c4d5e6_7f8a_9b0c_1d2e_3f4a5b6c7d8e

# 2. If status is RUNNING, cancel it
POST /platform/pipeline/1b33ad2f_33d3_4837_9eeb_83c82c8b909d/pipeline_run/b3c4d5e6_7f8a_9b0c_1d2e_3f4a5b6c7d8e/cancel

Cancel and Re-trigger a Run

# Cancel the current run
POST /platform/pipeline/{pipelineId}/pipeline_run/{runId}/cancel

# Then re-execute the pipeline
POST /platform/pipeline/execute

Notes

• Only runs with last_status: RUNNING can be cancelled
• After cancellation, the last_status transitions to CANCELLED
• To check the current status of a run before cancelling, use GET /platform/pipeline/:pipelineId/pipeline_run/:runId
• To view the full execution history, use GET /platform/pipeline/:pipelineId/pipeline_run