Platform

Uninstall a deployment

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.

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

Path parameters

idstring required

Request body

purge_databoolean

When true, the agent also wipes the deployment's data volume (docker compose down --volumes).

confirmboolean

Required by clients that want to be explicit; not enforced server-side.

Response

Uninstall enqueued

Changes

No recorded changes to this operation across all 1 revision of this API.