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.

Addons

get
/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
๐Ÿ”’

Audio

post
/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>
๐Ÿ”’

Auth

post
/auth
๐Ÿ”’
post
/auth/reset
๐Ÿ”’
delete
/auth/cache
๐Ÿ”’

CLI

get
/cli/info
๐Ÿ”’
get
/cli/stats
๐Ÿ”’
post
/cli/update
๐Ÿ”’

Core

get
/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
๐Ÿ”’

Discovery

get
/discovery
๐Ÿ”’
post
/discovery
๐Ÿ”’
get
/discovery/<uuid>
๐Ÿ”’
delete
/discovery/<uuid>
๐Ÿ”’

DNS

get
/dns/info
๐Ÿ”’
get
/dns/logs
๐Ÿ”’
post
/dns/options
๐Ÿ”’
post
/dns/reset
๐Ÿ”’
post
/dns/restart
๐Ÿ”’
get
/dns/stats
๐Ÿ”’
post
/dns/update
๐Ÿ”’

Docker

get
/docker/info
๐Ÿ”’
get
/docker/registries
๐Ÿ”’
post
/docker/registries
๐Ÿ”’
delete
/docker/registries/<registry>
๐Ÿ”’

Hardware

get
/hardware/info
๐Ÿ”’
get
/hardware/audio
๐Ÿ”’
post
/hardware/trigger
๐Ÿ”’

Host

get
/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
๐Ÿ”’

ingress

get
/ingress/panels
๐Ÿ”’
post
/ingress/session
๐Ÿ”’

Misc

get
/info
๐Ÿ”’

Multicast

get
/multicast/info
๐Ÿ”’
get
/multicast/logs
๐Ÿ”’
post
/multicast/restart
๐Ÿ”’
get
/multicast/stats
๐Ÿ”’
post
/multicast/update
๐Ÿ”’

Network

get
/network/info
๐Ÿ”’
get
/network/<interface>/info
๐Ÿ”’
post
/network/<interface>/update
๐Ÿ”’

Observer

get
/observer/info
๐Ÿ”’
get
/observer/stats
๐Ÿ”’
post
/observer/update
๐Ÿ”’

OS

post
/os/config/sync
๐Ÿ”’
get
/os/info
๐Ÿ”’
post
/os/update
๐Ÿ”’

Resolution

get
/resolution/info
๐Ÿ”’
post
/resolution/suggestion/<uuid>
๐Ÿ”’
delete
/resolution/suggestion/<uuid>
๐Ÿ”’
delete
/resolution/issue/<uuid>
๐Ÿ”’

Service

get
/services
๐Ÿ”’
get
/services/mqtt
๐Ÿ”’
post
/services/mqtt
๐Ÿ”’
delete
/services/mqtt
๐Ÿ”’
get
/services/mysql
๐Ÿ”’
post
/services/mysql
๐Ÿ”’
delete
/services/mysql
๐Ÿ”’

Snapshot

get
/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
๐Ÿ”’

Supervisor

get
/supervisor/info
๐Ÿ”’
get
/supervisor/logs
๐Ÿ”’
post
/supervisor/options
๐Ÿ”’
get
/supervisor/ping
๐Ÿ”“
post
/supervisor/reload
๐Ÿ”’
post
/supervisor/repair
๐Ÿ”’
get
/supervisor/stats
๐Ÿ”’
post
/supervisor/update
๐Ÿ”’

Placeholders

Some of the endpoints uses placeholders indicated with <...> in the endpoint URL.

placeholderdescription
addonThe 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 selfas the slug.
applicationThe name of a application, call /audio/info to get the correct name
interfaceA valid interface name, example eth0, to get the interface name you can call /network/info. You can use default to get the primary interface
registryA registry hostname defined in the container registry configuration, to get the hostname you can call /docker/registries
serviceThe service name for a service on the host.
snapshotA valid snapshot slug, example skuwe823, to get the slug you can call /snapshots
suggestionA valid suggestion, example clear_full_snapshot, to get the suggestion you can call /resolution
uuidThe UUID of a discovery service, to get the UUID you can call /discovery
Last updated on