Models

These models are describing objects that are getting returned from the supervisor API.

Addon

keytypedescription
namestringThe name of the add-on
slugstringThe slug for the add-on
advancedbooleantrue if it should only be visible to advanced users
descriptionstringThe description of the add-on
repositorystringThe repository the add-on came from
versionstringThe latest published version of the add-on
installedstringThe installed version of the add-on
availablebooleanfalse if you can not install the add-on
iconboolThe add-on has a icon file
logoboolThe add-on has a logo file
statestringThe state of the add-on (started, stopped)

Application

keytypedescription
namestringThe application name
indexintTODO: What is this?
stream_indexintTODO: What is this?
stream_typestringThe type of the stream (INPUT, OUTPUT)
volumefloatThe current volume
mutebooleantrue if the application is muted
addonstringThe add-on slug

Audio

keytypedescription
cardlistA list of Card models
inputlistA list of Audio device models
outputlistA list of Output device models
applicationlistA list of Application models

Audio device

keytypedescription
namestringThe name of the device
indexintTODO: What is this?
descriptionstringThe description of the device
volumefloatThe current volume
mutestringtrue if the device is muted
defaultstringtrue if the device is default
cardint or nullTODO: What is this?
applicationsstringA list of Application models

Audio profile

keytypedescription
namestringThe name of the profile
descriptionstringThe description of the profile
activebooleantrue if the profile is active

Card

keytypedescription
namestringThe name of the card
indexintTODO: What is this?
driverstringThe name of the card driver
profileslistA list of Audio profile models

Discovery

keytypedescription
addonstringThe add-on slug
servicestringThe service name
uuidstringThe UUID of the discovery
configdictThe configuration

Host Service

keytypedescription
namestringThe service name
descriptionstringThe service description
statestringThe service state

Network interface

keytypedescription
interfacestringThe interface name i.e eth0.
ip_addressstringThe IP address and the netmask in a X.X.X.X/XX format.
gatewaystringThe IP address of the gateway.
idstringThe ID of the interface.
typestringThe interface type.
nameserverslistA list containing the IP addresses of the configured nameservers as strings.
methodstringThe method used to set the IP can be "static" or "dhcp".
primarybooleantrue if it's the primary network interface.

Panel

keytypedescription
enablebooleantrue if it's enabled
iconstringThe sidebar icon
titlestringThe sidebar title
adminbooleantrue if it's for admin accounts only

Repository

keytypedescription
slugstringThe repository slug
namestringThe name of the repository
sourcestringThe URL to the repository
urlstring or nullURL for repository website
maintainerstringThe name of the repository maintainer

Service

keytypedescription
slugstringThe service slug
availablebooleantrue if the service is available
providerslistA list of providers for the service

Snapshot

keytypedescription
slugstringA generated slug for the snapshot
datestringA ISO date string representation of the date the snapshot was created
namestringThe name given to the snapshot
typestringThe type of snapshot (full, partial)
protectedbooleantrue if the snapshot is password protected

Snapshot details

keytypedescription
slugstringA generated slug for the snapshot
typestringThe type of snapshot (full, partial)
namestringThe name given to the snapshot
datestringA ISO date string representation of the date the snapshot was created
sizestringThe size of the snapshot in MB
protectedbooleantrue if the snapshot is password protected
homeassistantstringThe version of Home Assistant that was in use
addonslistA list of add-ons in the snapshot, addons are represented as a dictionary with these keys [slug,name,version,size]
repositorieslistA list of add-on repository URL's as strings
folderslistA list of strings representing directories

Stats

keytypedescription
cpu_percentfloatThe percentage of the CPU that is used
memory_usageintThe current memory usage in bytes
memory_limitintThe max allowed memory usage in bytes
memory_percentfloatThe percentage of the memory that is used
network_txintNetwork transmission usage
network_rxintNetwork receiver usage
blk_readintFile system read usage
blk_writeintFile system write usage

Issue

keytypedescription
uuidstrA generated uuid as issue ID
typestrType of the issue
contextstrIn which context the issue occorse
referencestr or nullDepend on the Context, a reference to a other Model

Suggestion

keytypedescription
uuidstrA generated uuid as suggestion ID
typestrType of the suggestion
contextstrIn which context the suggestion occorse
referencestr or nullDepend on the Context, a reference to a other Model
Last updated on