Update name and remove/add blank lines

This commit is contained in:
Fabian Affolter 2017-07-26 22:34:20 +02:00
parent 6455ad14a7
commit 4e902af937
No known key found for this signature in database
GPG Key ID: E23CD2DD36A4397F

65
API.md
View File

@ -1,10 +1,11 @@
# HassIO Server # Hass.io Server
## HassIO REST API ## Hass.io RESTful API
Interface for HomeAssistant to control things from supervisor. Interface for Home Assistant to control things from supervisor.
On error: On error:
```json ```json
{ {
"result": "error", "result": "error",
@ -12,7 +13,8 @@ On error:
} }
``` ```
On success On success:
```json ```json
{ {
"result": "ok", "result": "ok",
@ -20,10 +22,9 @@ On success
} }
``` ```
### HassIO ### Hass.io
- GET `/supervisor/ping` - GET `/supervisor/ping`
- GET `/supervisor/info` - GET `/supervisor/info`
The addons from `addons` are only installed one. The addons from `addons` are only installed one.
@ -54,7 +55,9 @@ The addons from `addons` are only installed one.
``` ```
- POST `/supervisor/update` - POST `/supervisor/update`
Optional: Optional:
```json ```json
{ {
"version": "VERSION" "version": "VERSION"
@ -62,6 +65,7 @@ Optional:
``` ```
- POST `/supervisor/options` - POST `/supervisor/options`
```json ```json
{ {
"beta_channel": "true|false", "beta_channel": "true|false",
@ -78,11 +82,12 @@ Reload addons/version.
- GET `/supervisor/logs` - GET `/supervisor/logs`
Output the raw docker log Output is the raw docker log.
### Security ### Security
- GET `/security/info` - GET `/security/info`
```json ```json
{ {
"initialize": "bool", "initialize": "bool",
@ -91,6 +96,7 @@ Output the raw docker log
``` ```
- POST `/security/options` - POST `/security/options`
```json ```json
{ {
"password": "xy" "password": "xy"
@ -98,6 +104,7 @@ Output the raw docker log
``` ```
- POST `/security/totp` - POST `/security/totp`
```json ```json
{ {
"password": "xy" "password": "xy"
@ -117,6 +124,7 @@ Return QR-Code
### Backup/Snapshot ### Backup/Snapshot
- GET `/snapshots` - GET `/snapshots`
```json ```json
{ {
"snapshots": [ "snapshots": [
@ -132,6 +140,7 @@ Return QR-Code
- POST `/snapshots/reload` - POST `/snapshots/reload`
- POST `/snapshots/new/full` - POST `/snapshots/new/full`
```json ```json
{ {
"name": "Optional" "name": "Optional"
@ -139,6 +148,7 @@ Return QR-Code
``` ```
- POST `/snapshots/new/partial` - POST `/snapshots/new/partial`
```json ```json
{ {
"name": "Optional", "name": "Optional",
@ -150,6 +160,7 @@ Return QR-Code
- POST `/snapshots/reload` - POST `/snapshots/reload`
- GET `/snapshots/{slug}/info` - GET `/snapshots/{slug}/info`
```json ```json
{ {
"slug": "SNAPSHOT ID", "slug": "SNAPSHOT ID",
@ -174,10 +185,9 @@ Return QR-Code
``` ```
- POST `/snapshots/{slug}/remove` - POST `/snapshots/{slug}/remove`
- POST `/snapshots/{slug}/restore/full` - POST `/snapshots/{slug}/restore/full`
- POST `/snapshots/{slug}/restore/partial` - POST `/snapshots/{slug}/restore/partial`
```json ```json
{ {
"homeassistant": "bool", "homeassistant": "bool",
@ -187,14 +197,14 @@ Return QR-Code
``` ```
### Host ### Host
- POST `/host/reload` - POST `/host/reload`
- POST `/host/shutdown` - POST `/host/shutdown`
- POST `/host/reboot` - POST `/host/reboot`
- GET `/host/info` - GET `/host/info`
See HostControl info command. See HostControl info command.
```json ```json
{ {
"type": "", "type": "",
@ -207,7 +217,9 @@ See HostControl info command.
``` ```
- POST `/host/update` - POST `/host/update`
Optional: Optional:
```json ```json
{ {
"version": "VERSION" "version": "VERSION"
@ -217,6 +229,7 @@ Optional:
### Network ### Network
- GET `/network/info` - GET `/network/info`
```json ```json
{ {
"hostname": "" "hostname": ""
@ -224,6 +237,7 @@ Optional:
``` ```
- POST `/network/options` - POST `/network/options`
```json ```json
{ {
"hostname": "", "hostname": "",
@ -235,7 +249,7 @@ Optional:
} }
``` ```
### HomeAssistant ### Home Assistant
- GET `/homeassistant/info` - GET `/homeassistant/info`
@ -250,7 +264,9 @@ Optional:
``` ```
- POST `/homeassistant/update` - POST `/homeassistant/update`
Optional: Optional:
```json ```json
{ {
"version": "VERSION" "version": "VERSION"
@ -259,11 +275,11 @@ Optional:
- GET `/homeassistant/logs` - GET `/homeassistant/logs`
Output the raw docker log Output is the raw Docker log.
- POST `/homeassistant/restart` - POST `/homeassistant/restart`
- POST `/homeassistant/options` - POST `/homeassistant/options`
```json ```json
{ {
"devices": [], "devices": [],
@ -274,11 +290,11 @@ Output the raw docker log
Image with `null` and last_version with `null` reset this options. Image with `null` and last_version with `null` reset this options.
### REST API addons ### RESTful for API addons
- GET `/addons` - GET `/addons`
Get all available addons Get all available addons.
```json ```json
{ {
@ -312,8 +328,8 @@ Get all available addons
``` ```
- POST `/addons/reload` - POST `/addons/reload`
- GET `/addons/{addon}/info` - GET `/addons/{addon}/info`
```json ```json
{ {
"name": "xy bla", "name": "xy bla",
@ -340,6 +356,7 @@ Get all available addons
- GET `/addons/{addon}/logo` - GET `/addons/{addon}/logo`
- POST `/addons/{addon}/options` - POST `/addons/{addon}/options`
```json ```json
{ {
"boot": "auto|manual", "boot": "auto|manual",
@ -358,7 +375,9 @@ For reset custom network settings, set it `null`.
- POST `/addons/{addon}/stop` - POST `/addons/{addon}/stop`
- POST `/addons/{addon}/install` - POST `/addons/{addon}/install`
Optional: Optional:
```json ```json
{ {
"version": "VERSION" "version": "VERSION"
@ -368,7 +387,9 @@ Optional:
- POST `/addons/{addon}/uninstall` - POST `/addons/{addon}/uninstall`
- POST `/addons/{addon}/update` - POST `/addons/{addon}/update`
Optional: Optional:
```json ```json
{ {
"version": "VERSION" "version": "VERSION"
@ -377,15 +398,16 @@ Optional:
- GET `/addons/{addon}/logs` - GET `/addons/{addon}/logs`
Output the raw docker log Output is the raw Docker log.
- POST `/addons/{addon}/restart` - POST `/addons/{addon}/restart`
## Host Control ## Host Control
Communicate over unix socket with a host daemon. Communicate over UNIX socket with a host daemon.
- commands - commands
``` ```
# info # info
-> {'type', 'version', 'last_version', 'features', 'hostname'} -> {'type', 'version', 'last_version', 'features', 'hostname'}
@ -404,7 +426,8 @@ Communicate over unix socket with a host daemon.
# network int route xy # network int route xy
``` ```
features: Features:
- shutdown - shutdown
- reboot - reboot
- update - update