---
title: "Uninstall a deployment"
method: POST
path: "/platform/deployments/{id}/uninstall"
tags: ["Platform"]
---

# Uninstall a deployment

`POST /platform/deployments/{id}/uninstall`

## Request

- Base URL: `https://api.imprezahost.com/v1`
- URL: `https://api.imprezahost.com/v1/platform/deployments/{id}/uninstall`
- Auth: API key in header `X-API-Key` and API key in header `X-API-Secret`

Enqueues an uninstall command for the agent. Idempotent — if the
deployment is already in `uninstalling` or `uninstalled`, the
endpoint returns 202 without queuing a second command.

Works transparently for both catalog and custom deployments.

## Path parameters

- `id` string, required

## Request body

- object
  - `purge_data` boolean: When `true`, the agent also wipes the deployment's data volume (`docker compose down --volumes`).
  - `confirm` boolean: Required by clients that want to be explicit; not enforced server-side.

## Response `202`

Uninstall enqueued

## Other responses

- `401`: Invalid or missing API credentials
- `404`: Resource not found

---

[API](https://skmtc.dev/imprezahost/apis/impreza-host-public-api.md) · [All operations](https://skmtc.dev/imprezahost/apis/impreza-host-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/imprezahost/apis/impreza-host-public-api/revisions/db86511f604f?raw)