---
title: "Cancel Workflow"
method: POST
path: "/api/workflow/{name}/cancel"
tags: ["Workflow API"]
---

# Cancel Workflow

`POST /api/workflow/{name}/cancel`

## Request

- The document declares no server URL.
- Auth: none declared

Cancels the workflow.

## Path parameters

- `name` string, required

## Query parameters

- `message` string, nullable
- `force` boolean

## Headers

- `x-osmo-user` string, nullable

## Response `200`

Successful Response

- CancelResponse: Object storing workflow name.
  - `name` string, required

## Other responses

- `422`: Validation Error

## Changes

- **2026-08-03** `b9d312a13f5d`: 2 info
  - added the optional property `detail/items/ctx` to the response with the `422` status
  - added the optional property `detail/items/input` to the response with the `422` status
- **2026-04-08** `a8157dc3279d`: 4 info
  - `header` request parameter `x-osmo-user` list-of-types was widened by adding types `null`
  - `query` request parameter `message` list-of-types was widened by adding types `null`
  - for the `header` request parameter `x-osmo-user`, the type was generalized from `string` to no type
  - for the `query` request parameter `message`, the type was generalized from `string` to no type
- **2026-02-27** `3b4b243276b5`: 1 warning
  - deleted the `header` request parameter `x-osmo-roles`

[Operation history](https://skmtc.dev/nvidia/apis/nvidia-corporation-osmo-api/changes/api/workflow/:name/cancel/post.md)

---

[API](https://skmtc.dev/nvidia/apis/nvidia-corporation-osmo-api.md) - [All operations](https://skmtc.dev/nvidia/apis/nvidia-corporation-osmo-api/llms.txt) - [OpenAPI document](https://skmtc.dev/nvidia/apis/nvidia-corporation-osmo-api/revisions/845585a71dbb?raw)