---
title: "Cancel a pipeline"
method: POST
path: "/pipelines/{pipeline_id}/cancel"
tags: ["Pipeline"]
---

# Cancel a pipeline

`POST /pipelines/{pipeline_id}/cancel`

## Request

- Base URL: `https://api.ionworks.com`
- URL: `https://api.ionworks.com/pipelines/{pipeline_id}/cancel`
- Auth: none declared

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

## Path parameters

- `pipeline_id` string, uuid, required

## Response `200`

Successful Response

- Pipeline: Model for representing a pipeline in API list responses (without elements).
  - `status` 'pending' | 'running' | 'completed' | 'failed' | 'canceled', required
  - `id` string, required
  - `project_id` string, required
  - `user_id` string, nullable
  - `name` string, required
  - `description` string, nullable
  - `options` PipelineOptions: Options for pipeline execution behavior.
    - `live_progress_updates` boolean, nullable: If True, save checkpoint progress to database during job execution. If None, the worker picks a default based on job type.
  - `created_at` string, date-time, required
  - `updated_at` string, date-time, required
  - `error` string, nullable
  - `error_code` 'CONFIGURATION_ERROR' | 'MODEL_ERROR' | 'SOLVER_ERROR' | 'MAX_BACKWARD_JUMPS_EXCEEDED' | 'EXECUTION_TIMEOUT' | 'SUBMISSION_FAILED' | 'INTERNAL_ERROR': Machine-readable error codes for jobs.
  - `created_by_email` string, nullable
  - `organization_id` string, required: Organization this pipeline belongs to.
  - `is_terminal` boolean, required: Whether the pipeline has settled and will not transition again.
  - `is_failed` boolean, required: Whether the pipeline settled on anything other than success. Derived as terminal-minus-success, so a new non-success terminal status is classified without editing this method.

## Other responses

- `422`: Validation Error

## Changes

- **2026-09-30** `ea3d377fec1a`: 1 breaking, 1 warning
  - for the `path` request parameter `pipeline_id`, the format changed from no format to `uuid`
  - added the new `MAX_BACKWARD_JUMPS_EXCEEDED` enum value to the `error_code/anyOf[subschema #1: JobErrorCode]/` response property for the response status `200`
- **2026-09-14** `7baccf056192`: 2 info
  - added the required property `is_failed` to the response with the `200` status
  - added the required property `is_terminal` to the response with the `200` status

[Operation history](https://skmtc.dev/ionworks/apis/ionworks-api/changes/pipelines/:pipeline_id/cancel/post.md)

---

[API](https://skmtc.dev/ionworks/apis/ionworks-api.md) - [All operations](https://skmtc.dev/ionworks/apis/ionworks-api/llms.txt) - [OpenAPI document](https://skmtc.dev/ionworks/apis/ionworks-api/revisions/abebbbc5f60a?raw)