Sign in
Pipeline

Cancel a pipeline

Cancel a running pipeline and all its non-terminal elements.

post/pipelines/{pipeline_id}/cancel

Path parameters

pipeline_idstring required

Response

Successful Response

idstring required
project_idstring required
user_idstring nullable
namestring required
descriptionstring nullable
status'pending' | 'running' | 'completed' | 'failed' | 'canceled' required
created_atstring date-time required
updated_atstring date-time required
errorstring nullable
error_code'CONFIGURATION_ERROR' | 'MODEL_ERROR' | 'SOLVER_ERROR' | 'EXECUTION_TIMEOUT' | 'SUBMISSION_FAILED' | 'INTERNAL_ERROR'

Machine-readable error codes for jobs.

created_by_emailstring nullable
organization_idstring required

Organization this pipeline belongs to.

Changes

No recorded changes to this endpoint across all 1 revision of this API.