Abort a pipeline run

Cancel a pipeline run that is pending or running. The run and any of its non-terminal steps transition to aborted.

Aborting an already-terminal run (completed, completed_with_warnings, failed, or aborted) is a no-op.

POST /projects/{project_id}/pipeline-runs/{pipeline_run_id}/abort

Abort a pipeline run

Python

import requests

url = "https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/pipeline-runs/{pipeline_run_id}/abort/"

headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, headers=headers)

print(response.text)

200

{
  "status": "aborted"
}

Authorizations

BearerAuthTokenAuth

Authorization · string · header · required

Use Authorization: Bearer

Path Parameters

project_id · string<uuid> · required

UUID of the project

pipeline_run_id · string<uuid> · required

UUID of the pipeline run

Response

200

application/json

Abort accepted

status · string

Example:

"aborted"