Stop an add-on
supervisor_stop_addonStop a running Home Assistant add-on without uninstalling it, taking services like an MQTT broker offline until started again. Refuses to stop Nexus's own add-on.
Instructions
Stop a running add-on.
Calls POST /addons/<slug>/stop. The add-on — e.g. an MQTT broker other
integrations depend on — becomes unavailable until started again.
Refuses to run at all against nexus's own add-on (by its real slug or
the literal alias Supervisor resolves to the caller itself): nexus
stopping itself would cut off the very connection carrying this call,
with no guarantee the response ever comes back, and — unlike
supervisor_restart_addon — leaves nexus down until someone starts it
again some other way.
Use when: taking one add-on offline without uninstalling it.
Not for: removing it entirely — use supervisor_uninstall_addon; for
bringing it back — use supervisor_start_addon; for a brief restart of
nexus itself — use supervisor_restart_addon instead, which is allowed.
Returns: Supervisor's stop-job result.
Errors: {"error": "invalid_slug"} for a bad slug; {"error": "self_addon_stop_blocked", "message": ...} when
slug is nexus's own add-on; {"error": "SUPERVISOR_TOKEN not set — Nexus must run as HA add-on for Supervisor API"} when the token env var
is missing; {"error": "HTTP <status>", "detail": ...} if the slug is
unknown.
Limits: interrupts the add-on's availability, and anything depending on
it, until it is started again.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| slug | Yes | Add-on slug to stop, e.g. from `supervisor_list_addons`. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||