---
title: "CancelWorkflow"
method: POST
path: "/depot.ci.v1.CIService/CancelWorkflow"
tags: ["CIService"]
---

# CancelWorkflow

`POST /depot.ci.v1.CIService/CancelWorkflow`

## Request

- Base URL: `https://api.depot.dev`
- URL: `https://api.depot.dev/depot.ci.v1.CIService/CancelWorkflow`
- Auth: HTTP bearer

Cancels a queued or running workflow and all its child jobs.

## Headers

- `Connect-Protocol-Version` 1, required: Define the version of the Connect protocol
- `Connect-Timeout-Ms` number: Define the timeout, in ms

## Request body

- DepotCiV1CancelWorkflowRequest
  - `workflowId` string, required: Unique identifier for the workflow to cancel. Returned by `GetRunStatus` and `ListWorkflows`.

## Response `200`

Success

- DepotCiV1CancelWorkflowResponse
  - `workflowId` string: Unique identifier for the workflow. Matches the request `workflowId`.
  - `status` string: Updated workflow status. Should be "cancelled".

## Other responses

- `default`: Error

---

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