---
title: "Remove an install"
method: DELETE
path: "/v1/installs/{installId}"
tags: ["Installs"]
---

# Remove an install

`DELETE /v1/installs/{installId}`

## Request

- Base URL: `https://api.banksync.io`
- URL: `https://api.banksync.io/v1/installs/{installId}`
- Auth: one of:
  - API key in header `X-API-Key`
  - HTTP bearer

Remove an install, keeping or trashing what it made (`mode`). What it adopted or linked is never touched. A resource that cannot be removed yet is listed in `failures` and the install stays `removing`; calling again retries it.

## Path parameters

- `installId` string, required: Install id, from the list

## Query parameters

- `mode` 'keep' | 'trash', required: `keep`: what it made stays as ordinary resources. `trash`: what it made moves to trash, restorable. What it adopted or linked is never touched.

## Headers

- `Idempotency-Key` string: Makes a retry safe: the same key with the same request replays the first answer for 24 hours instead of running twice, and the same key with a different request is a 409 `IDEMPOTENCY_KEY_REUSED`. Refusals a retry can outlive — 408, 409, 423, 425, 429 and every 5xx — are never replayed, so retrying with the same key after the cause clears runs the request.

## Response `200`

The removal

- object
  - `success` true, required
  - `data` object, required
    - `install` object, required
      - `id` string, required: Install id — the `installId` other operations take
      - `name` string, required
      - `source` 'listing' | 'app' | 'workspace' | 'preset' | 'inline', required
      - `listingId` string, nullable, required
      - `releaseId` string, nullable, required
      - `blueprintId` string, nullable, required
      - `blueprintKey` string, nullable, required
      - `status` 'installing' | 'installed' | 'partial' | 'removing' | 'removed', required
      - `generation` integer, required
      - `error` string, nullable, required
      - `createdAt` string, nullable, required
      - `updatedAt` string, nullable, required
      - `removedAt` string, nullable, required
      - `removeMode` 'keep' | 'trash' | 'null', nullable, required
      - `planIncludesMore` boolean
    - `status` 'removing' | 'removed', required
    - `failures` object[], required
      - `resourceKey` string, required
      - `error` string, required

## Other responses

- `400`: Invalid input — `code` names it: `VALIDATION_FAILED`, `INVALID`, `INVALID_BLUEPRINT` (not a blueprint this workspace can read), `PORTABILITY_VIOLATION` (it still carries workspace ids), `UNSAFE_BLUEPRINT`, `INVALID_BINDINGS` (an input is missing or does not fit), `RESTORE_WINDOW_PASSED`; `details[]` names each field
- `401`: Unauthorized
- `403`: Forbidden — a missing `marketplace:read` / `marketplace:write` scope, a role below editor for a change, an installed app outside the public marketplace, an unverified listing already installed in ten workspaces (`INSTALL_CAP_REACHED`), or a template that needs more tables, feeds or enrichments than the workspace plan has left (`PLAN_LIMIT_REACHED`)
- `404`: Not found — something this workspace may not see answers exactly as something that does not exist; or the marketplace is not enabled for this workspace
- `409`: Conflict — it changed since you read it (`STALE`), it is busy or in the wrong state (`INVALID_STATE`), the listing cannot be installed (`NOT_INSTALLABLE`), a key is taken (`KEY_TAKEN`), or an existing container does not fit (`ADOPTION_CONFLICT`)
- `429`: Too many — the key’s rate limit, or a marketplace quota (`QUOTA_EXCEEDED`: 200 saved templates per workspace, 50 installs per hour). `Retry-After` says when to come back.
- `503`: The marketplace is temporarily unavailable; retry shortly

---

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