---
title: "Cancel a queued or running deployment (the live release stays live)"
method: POST
path: "/api/computers/{id}/deployments/{deploymentId}/cancel"
tags: ["deploys"]
---

# Cancel a queued or running deployment (the live release stays live)

`POST /api/computers/{id}/deployments/{deploymentId}/cancel`

## Request

- Base URL: `https://www.orgo.ai`
- URL: `https://www.orgo.ai/api/computers/{id}/deployments/{deploymentId}/cancel`
- Auth: HTTP bearer

## Path parameters

- `id` string, required
- `deploymentId` string, uuid, required

## Response `200`

Cancelled (a queued one) or being cancelled (a running one).

- Deployment
  - `id` string, uuid, required
  - `project_id` string, uuid, required
  - `trigger` 'push' | 'manual' | 'rollback' | 'redeploy', required
  - `state` 'queued' | 'running' | 'succeeded' | 'failed' | 'cancelled' | 'superseded', required
  - `phase` 'preparing' | 'cloning' | 'detecting' | 'installing' | 'building' | 'starting' | 'health_check' | 'live' | 'null', nullable
  - `branch` string, required
  - `source_version` string, nullable: An Ingot repo’s: the changeset it builds, once known (the one asked for, else the one the runner found newest on main). A rollback: the changeset of the release it went back to.
  - `commit_sha` string, nullable
  - `commit_message` string, nullable
  - `commit_author` string, nullable
  - `framework` string, nullable
  - `error_code` string, nullable: Failed: build_timeout, runner_lost, computer_not_running, github_token, clone_failed, detect_failed, install_failed, build_failed, docker_unavailable, start_failed, health_check_failed, release_gone, apply_failed, ingot_missing.
  - `error` string, nullable
  - `rollback_of` string, uuid, nullable
  - `current` boolean: This deployment is the project’s live one. After a rollback it is the rollback, not the deployment it went back to.
  - `release_live` boolean: Its release is the one live now, through this deployment or another of the same release (a rollback to it, or the one this rollback went back to). Nothing to roll back to or build again.
  - `can_rollback` boolean: Its release is still on the computer and is not the one live now.
  - `created_at` string, date-time
  - `started_at` string, date-time, nullable
  - `finished_at` string, date-time, nullable

## Other responses

- `404`: Not found on this computer.
- `409`: Already finished (NOT_ACTIVE).
- `429`: Over one of the account's rate limits (rate_limited): `limit` names it, `retry_after` and Retry-After say how many seconds to wait. Limits are per account (the workspace owner when the request acts on a computer or a workspace) and set by its plan (x-rate-limits).

## Changes

- **2026-10-30** `afb6f0ee1aac`: 1 info
  - added the non-success response with the status `429`
- **2026-10-26** `68dbea0d710c`: 1 info
  - added the optional property `source_version` to the response with the `200` status
- **2026-10-18** `dcaee154d80e`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/orgo/apis/orgo-api/changes/api/computers/:id/deployments/:deploymentId/cancel/post.md)

---

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