Uninstall an add-on
supervisor_uninstall_addonPermanently uninstall a Home Assistant add-on and delete its data after explicit confirmation. Blocks removing Supervisor itself; use for add-ons no longer needed, not for temporary stops.
Instructions
Uninstall an add-on and its persistent data after an explicit confirmation.
Calls POST /addons/<slug>/uninstall. Refuses to run at all against
nexus's own add-on (its real slug, or the alias Supervisor resolves to
the caller itself — see self_protection.is_own_addon) — checked first,
with no Supervisor request made either way, before even the
confirmation gate: nexus removing itself is never the right tool for
that regardless of confirm. Otherwise, without confirm=True nothing
is removed; the call only returns an error asking for confirmation
(ADR-0003 D1).
Use when: permanently removing an add-on that is no longer needed.
Not for: temporarily stopping it while keeping its data and config — use
supervisor_stop_addon.
Returns: Supervisor's uninstall-job result when confirmed.
Errors: {"error": "invalid_slug"} for a bad slug; {"error": "self_addon_uninstall_blocked", "message": ...} when
slug is nexus's own add-on; returns {"error": "confirmation_required", "message": ..., "action": ...} when confirm
is false; {"error": "HTTP <status>", "detail": ...} on a Supervisor
API error.
Limits: WARNING: deletes the add-on's data with no separate backup step;
requires confirm=True.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| slug | Yes | Add-on slug to uninstall, e.g. from `supervisor_list_addons`. | |
| confirm | No | Set true to actually uninstall the add-on and its data. False (default) performs no action. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||