Skip to main content

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
🔒
get
/addons/<addon>/options/config
🔒
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

get
/auth
🔒
post
/auth
🔒
post
/auth/reset
🔒
delete
/auth/cache
🔒

Backup

get
/backups
🔒
post
/backups/new/full
🔒
post
/backups/new/upload
🔒
post
/backups/new/partial
🔒
post
/backups/reload
🔒
get
/backups/<backup>/download
🔒
get
/backups/<backup>/info
🔒
delete
/backups/<backup>
🔒
post
/backups/<backup>/restore/full
🔒
post
/backups/<backup>/restore/partial
🔒

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
🔒

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
🔒
post
/ingress/validate_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/<interface>/info
🔒
post
/network/reload
🔒
post
/network/interface/<interface>/update
🔒
get
/network/interface/<interface>/accesspoints
🔒
post
/network/interface/<interface>/vlan/<id>
🔒

Observer

get
/observer/info
🔒
get
/observer/stats
🔒
post
/observer/update
🔒

OS

post
/os/config/sync
🔒
get
/os/info
🔒
post
/os/update
🔒
get
/os/datadisk/list
🔒
post
/os/datadisk/move
🔒

Resolution

get
/resolution/info
🔒
post
/resolution/suggestion/<uuid>
🔒
delete
/resolution/suggestion/<uuid>
🔒
delete
/resolution/issue/<uuid>
🔒
post
/resolution/healthcheck
🔒
post
/resolution/check/<slug>/options
🔒
post
/resolution/check/<slug>/run
🔒

Service

get
/services
🔒
get
/services/mqtt
🔒
post
/services/mqtt
🔒
delete
/services/mqtt
🔒
get
/services/mysql
🔒
post
/services/mysql
🔒
delete
/services/mysql
🔒

Store

get
/store
🔒
get
/store/addons
🔒
get
/store/addons/<addon>
🔒
post
/store/addons/<addon>/install
🔒
post
/store/addons/<addon>/update
🔒
post
/store/reload
🔒
get
/store/repositories
🔒
get
/store/repositories/<repository>
🔒

Security

get
/security/info
🔒
post
/security/options
🔒

Supervisor

get
/supervisor/available_updates
🔒
get
/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
🔒

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 an 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.
backupA valid backup slug, example skuwe823, to get the slug you can call /backups
suggestionA valid suggestion, example clear_full_backup, to get the suggestion you can call /resolution
uuidThe UUID of a discovery service, to get the UUID you can call /discovery