---
title: "Cancel Deployment"
method: POST
path: "/api/deploy/{deployment_id}/cancel"
tags: ["deploy"]
---

# Cancel Deployment

`POST /api/deploy/{deployment_id}/cancel`

## Request

- Base URL: `https://api.maritime.sh` (the document declares no server; this is the origin it was published from)
- URL: `https://api.maritime.sh/api/deploy/{deployment_id}/cancel`
- Auth: HTTP bearer

Persist cancellation intent for the worker instead of cancelling a request task.

## Path parameters

- `deployment_id` string, required

## Response `200`

Successful Response

- DeploymentResponse
  - `id` string, required
  - `agentId` string, required
  - `status` string, required
  - `commitSha` string, nullable
  - `buildLog` string, nullable
  - `startedAt` string, date-time, required
  - `completedAt` string, date-time, nullable
  - `failureKind` string, nullable
  - `errorCode` string, nullable
  - `errorTitle` string, nullable
  - `errorMessage` string, nullable
  - `errorAction` string, nullable

## Other responses

- `422`: Validation Error

---

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