supervisor/API.md

HassIO Server

Host Controll

Communicate over unix socket with a host daemon.

• commands

# info
-> {'os', 'version', 'current', 'level', 'hostname'}
# reboot
# shutdown
# host-update [v]
# supervisor-update [v]

# network info
# network hostname xy
# network wlan ssd xy
# network wlan password xy
# network int ip xy
# network int netmask xy
# network int route xy

level:

• 1: power functions
• 2: supervisor update
• 4: host update
• 8: network functions

Answer:

{}|OK|ERROR|WRONG

• {}: json
• OK: call was successfully
• ERROR: error on call
• WRONG: not supported

HassIO REST API

Interface for HomeAssistant to controll things from supervisor.

On error:

{
    "result": "error",
    "message": ""
}

On success

{
    "result": "ok",
    "data": { }
}

HassIO

• /supervisor/ping

• /supervisor/info

{
    "version": "INSTALL_VERSION",
    "current": "CURRENT_VERSION",
    "beta": "true|false",
    "addons": {}
}

• /supervisor/update Optional:

{
    "version": "VERSION"
}

• /supervisor/option

{
    "beta": "true|false"
}

Host

• /host/shutdown

• /host/reboot

• /host/info See HostControll info command.

{
    "os": "",
    "version": "",
    "current": "",
    "level": "",
    "hostname": "",
}

• /host/update Optional:

{
    "version": "VERSION"
}

Network

• /network/info

• /network/options

{
    "hostname": "",
    "mode": "dhcp|fixed",
    "ssid": "",
    "ip": "",
    "netmask": "",
    "gateway": ""
}

HomeAssistant

• /homeassistant/info

{
    "version": "INSTALL_VERSION",
    "current": "CURRENT_VERSION"
}

• /homeassistant/update Optional:

{
    "version": "VERSION"
}

REST API addons

• /addons/{addon}/info

{
    "version": "VERSION",
    "current": "CURRENT_VERSION",
    "state": "started|stopped",
    "boot": "auto|manual",
    "options": {},
}

• /addons/{addon}/options

{ }

• /addons/{addon}/start

• /addons/{addon}/stop

• /addons/{addon}/install Optional:

{
    "version": "VERSION"
}

• /addons/{addon}/uninstall

• /addons/{addon}/update Optional:

{
    "version": "VERSION"
}