Endpoints
For API endpoints marked with ๐ you need use an authorization header with a Bearer
token.
The token is available for add-ons and Home Assistant using the
SUPERVISOR_TOKEN
environment variable.
To see more details about each endpoint, click on it to expand it.
#
Addonsget
/addons
๐
post
/addons/reload
๐
get
/addons/<addon>/changelog
๐
get
/addons/<addon>/documentation
๐
get
/addons/<addon>/logs
๐
get
/addons/<addon>/icon
๐
get
/addons/<addon>/info
๐
post
/addons/<addon>/install
๐
get
/addons/<addon>/logo
๐
post
/addons/<addon>/options
๐
post
/addons/<addon>/options/validate
๐
post
/addons/<addon>/rebuild
๐
post
/addons/<addon>/restart
๐
post
/addons/<addon>/security
๐
post
/addons/<addon>/start
๐
get
/addons/<addon>/stats
๐
post
/addons/<addon>/stdin
๐
post
/addons/<addon>/stop
๐
post
/addons/<addon>/uninstall
๐
post
/addons/<addon>/update
๐
#
Audiopost
/audio/default/input
๐
post
/audio/default/output
๐
get
/audio/info
๐
get
/audio/logs
๐
post
/audio/mute/input
๐
post
/audio/mute/input/<application>
๐
post
/audio/mute/output
๐
post
/audio/mute/output/<application>
๐
post
/audio/profile
๐
post
/audio/reload
๐
post
/audio/restart
๐
get
/audio/stats
๐
post
/audio/update
๐
post
/audio/volume/input
๐
post
/audio/volume/input/<application>
๐
post
/audio/volume/output
๐
post
/audio/volume/output/<application>
๐
#
Authget
/auth
๐
post
/auth
๐
post
/auth/reset
๐
delete
/auth/cache
๐
#
CLIget
/cli/info
๐
get
/cli/stats
๐
post
/cli/update
๐
#
Coreget
/core/api
๐
post
/core/api
๐
post
/core/check
๐
get
/core/info
๐
get
/core/logs
๐
post
/core/options
๐
post
/core/rebuild
๐
post
/core/restart
๐
post
/core/start
๐
get
/core/stats
๐
post
/core/stop
๐
post
/core/update
๐
get
/core/websocket
๐
#
Discoveryget
/discovery
๐
post
/discovery
๐
get
/discovery/<uuid>
๐
delete
/discovery/<uuid>
๐
#
DNSget
/dns/info
๐
get
/dns/logs
๐
post
/dns/options
๐
post
/dns/reset
๐
post
/dns/restart
๐
get
/dns/stats
๐
post
/dns/update
๐
#
Dockerget
/docker/info
๐
get
/docker/registries
๐
post
/docker/registries
๐
delete
/docker/registries/<registry>
๐
#
Hardwareget
/hardware/info
๐
get
/hardware/audio
๐
post
/hardware/trigger
๐
#
Hostget
/host/info
๐
get
/host/logs
๐
post
/host/options
๐
post
/host/reboot
๐
post
/host/reload
๐
post
/host/service/<service>/start
๐
post
/host/service/<service>/stop
๐
post
/host/service/<service>/reload
๐
get
/host/services
๐
post
/host/shutdown
๐
#
ingressget
/ingress/panels
๐
post
/ingress/session
๐
post
/ingress/validate_session
๐
#
Miscget
/info
๐
#
Multicastget
/multicast/info
๐
get
/multicast/logs
๐
post
/multicast/restart
๐
get
/multicast/stats
๐
post
/multicast/update
๐
#
Networkget
/network/info
๐
get
/network/interface/<interface>/info
๐
post
/network/reload
๐
post
/network/interface/<interface>/update
๐
get
/network/interface/<interface>/accesspoints
๐
post
/network/interface/<interface>/vlan/<id>
๐
#
Observerget
/observer/info
๐
get
/observer/stats
๐
post
/observer/update
๐
#
OSpost
/os/config/sync
๐
get
/os/info
๐
post
/os/update
๐
#
Resolutionget
/resolution/info
๐
post
/resolution/suggestion/<uuid>
๐
delete
/resolution/suggestion/<uuid>
๐
delete
/resolution/issue/<uuid>
๐
#
Serviceget
/services
๐
get
/services/mqtt
๐
post
/services/mqtt
๐
delete
/services/mqtt
๐
get
/services/mysql
๐
post
/services/mysql
๐
delete
/services/mysql
๐
#
Snapshotget
/snapshots
๐
post
/snapshots/new/full
๐
post
/snapshots/new/upload
๐
post
/snapshots/new/partial
๐
post
/snapshots/reload
๐
get
/snapshots/<snapshot>/download
๐
get
/snapshots/<snapshot>/info
๐
delete
/snapshots/<snapshot>
๐
post
/snapshots/<snapshot>/restore/full
๐
post
/snapshots/<snapshot>/restore/partial
๐
#
Supervisorget
/supervisor/info
๐
get
/supervisor/logs
๐
post
/supervisor/options
๐
get
/supervisor/ping
๐
post
/supervisor/reload
๐
post
/supervisor/restart
๐
post
/supervisor/repair
๐
get
/supervisor/stats
๐
post
/supervisor/update
๐
#
PlaceholdersSome of the endpoints uses placeholders indicated with <...>
in the endpoint URL.
placeholder | description |
---|---|
addon | The slug for the addon, to get the slug you can call /addons , to call endpoints for the add-on calling the endpoints you can use self as the slug. |
application | The name of a application, call /audio/info to get the correct name |
interface | A valid interface name, example eth0 , to get the interface name you can call /network/info . You can use default to get the primary interface |
registry | A registry hostname defined in the container registry configuration, to get the hostname you can call /docker/registries |
service | The service name for a service on the host. |
snapshot | A valid snapshot slug, example skuwe823 , to get the slug you can call /snapshots |
suggestion | A valid suggestion, example clear_full_snapshot , to get the suggestion you can call /resolution |
uuid | The UUID of a discovery service, to get the UUID you can call /discovery |