jeans/supervisor
jeans/supervisor
1
0
Fork 0
mirror of https://github.com/home-assistant/supervisor.git synced 2025-07-21 16:16:31 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update api description

Browse Source
This commit is contained in:
pvizeli 2017-04-06 11:02:45 +02:00
parent ab6ac77149
commit 4399888ce7
1 changed files with 72 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

90
hassio_api/README.md
View File

@ -64,17 +64,27 @@ On success
```json ```json
{ {
"version": INSTALL_VERSION, "version": "INSTALL_VERSION",
"current": CURRENT_VERSION "current": "CURRENT_VERSION",
"beta": "true|false",
"addons": {}
} }
``` ```
- `/supervisor/update` - `/supervisor/update`
Payload: {"version": "0.XX"} Optional:
If version is None it read last version from server. ```json
{
"version": "VERSION"
}
```
- `/supervisor/option` - `/supervisor/option`
Payload: {"beta": true|false} ```json
{
"beta": "true|false"
}
```
### Host ### Host
@ -83,19 +93,39 @@ Payload: {"beta": true|false}
- `/host/reboot` - `/host/reboot`
- `/host/info` - `/host/info`
See HostControll info command. See HostControll info command.
```json
{
"os": "",
"version": "",
"level": "",
"hostname": "",
}
```
- `/host/update` - `/host/update`
On some device we support host upates. Like ResinOS. Optional:
```json
{
"version": "VERSION"
}
```
### Network ### Network
- `/network/info` - `/network/info`
- `/network/options` - `/network/options`
Payload: {'hostname': '', 'mode': 'dhcp|fixed', 'ssid': '', 'ip': '', 'netmask': '', 'gateway': ''} ```json
{
"hostname": "",
"mode": "dhcp|fixed",
"ssid": "",
"ip": "",
"netmask": "",
"gateway": ""
}
```
### HomeAssistant ### HomeAssistant
@ -103,31 +133,55 @@ Payload: {'hostname': '', 'mode': 'dhcp|fixed', 'ssid': '', 'ip': '', 'netmask':
```json ```json
{ {
"version": INSTALL_VERSION, "version": "INSTALL_VERSION",
"current": CURRENT_VERSION "current": "CURRENT_VERSION"
} }
``` ```
- `/homeassistant/update` - `/homeassistant/update`
Payload: {"version": "0.XX.Y"} Optional:
If version is None it read last version from server. ```json
{
"version": "VERSION"
}
```
### REST API addons ### REST API addons
- `/addons/info` - `/addons/{addon}/info`
```json
{
"version": "VERSION",
"current": "CURRENT_VERSION",
"state": "started|stopped",
"boot": "auto|manual",
"options": {},
}
```
- `/addons/{addon}/options` - `/addons/{addon}/options`
Payload: {'options': {}} ```json
{ }
```
- `/addons/{addon}/start` - `/addons/{addon}/start`
- `/addons/{addon}/stop` - `/addons/{addon}/stop`
- `/addons/{addon}/install` - `/addons/{addon}/install`
Payload: {"version": "x.x"} Optional:
```json
{
"version": "VERSION"
}
```
- `/addons/{addon}/uninstall` - `/addons/{addon}/uninstall`
- `/addons/{addon}/update` - `/addons/{addon}/update`
Payload: {"version": "x.x"} Optional:
If version is None it read last version from server. ```json
{
"version": "VERSION"
}
```