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

Update API docs to reflect latest changes (#1502)

Browse Source
This commit is contained in:
Franck Nijhof 2020-02-11 23:09:23 +01:00 committed by GitHub
parent d78689554a
commit aa1f08fe8a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 27 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

53
API.md
View File

@ -1,6 +1,6 @@
# Hass.io # Supervisor
## Hass.io RESTful API ## Supervisor RESTful API
Interface for Home Assistant to control things from supervisor. Interface for Home Assistant to control things from supervisor.
@ -22,9 +22,10 @@ On success / Code 200:
} }
``` ```
For access to API you need set the `X-HASSIO-KEY` they will be available for Add-ons/HomeAssistant with environment `HASSIO_TOKEN`. For access to API you need use a authorization header with a `Bearer` token.
They are available for Add-ons and the Home Assistant using the `SUPERVISOR_TOKEN` environment variable.
### Hass.io ### Supervisor
- GET `/supervisor/ping` - GET `/supervisor/ping`
@ -285,7 +286,7 @@ return:
### HassOS ### HassOS
- GET `/hassos/info` - GET `/os/info`
```json ```json
{ {
@ -298,7 +299,7 @@ return:
} }
``` ```
- POST `/hassos/update` - POST `/os/update`
```json ```json
{ {
@ -306,7 +307,7 @@ return:
} }
``` ```
- POST `/hassos/update/cli` - POST `/os/update/cli`
```json ```json
{ {
@ -314,7 +315,7 @@ return:
} }
``` ```
- POST `/hassos/config/sync` - POST `/os/config/sync`
Load host configs from a USB stick. Load host configs from a USB stick.
@ -363,7 +364,7 @@ Trigger an udev reload
### Home Assistant ### Home Assistant
- GET `/homeassistant/info` - GET `/core/info`
```json ```json
{ {
@ -382,7 +383,7 @@ Trigger an udev reload
} }
``` ```
- POST `/homeassistant/update` - POST `/core/update`
Optional: Optional:
@ -392,23 +393,23 @@ Optional:
} }
``` ```
- GET `/homeassistant/logs` - GET `/core/logs`
Output is the raw Docker log. Output is the raw Docker log.
- POST `/homeassistant/restart` - POST `/core/restart`
- POST `/homeassistant/check` - POST `/core/check`
- POST `/homeassistant/start` - POST `/core/start`
- POST `/homeassistant/stop` - POST `/core/stop`
- POST `/homeassistant/rebuild` - POST `/core/rebuild`
- POST `/homeassistant/options` - POST `/core/options`
```json ```json
{ {
"image": "Optional|null", "image": "Optional|null",
"last_version": "Optional for custom image|null", "last_version": "Optional for custom image|null",
"port": "port for access hass", "port": "port for access core",
"ssl": "bool", "ssl": "bool",
"refresh_token": "", "refresh_token": "",
"watchdog": "bool", "watchdog": "bool",
@ -418,15 +419,15 @@ Output is 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.
- POST/GET `/homeassistant/api` - POST/GET `/core/api`
Proxy to real home-assistant instance. Proxy to the Home Assistant Core instance.
- GET `/homeassistant/websocket` - GET `/core/websocket`
Proxy to real websocket instance. Proxy to Home Assistant Core websocket.
- GET `/homeassistant/stats` - GET `/core/stats`
```json ```json
{ {
@ -441,13 +442,13 @@ Proxy to real websocket instance.
} }
``` ```
### RESTful for API addons ### RESTful for API add-ons
If an add-on will call itself, you can use `/addons/self/...`. If an add-on will call itself, you can use `/addons/self/...`.
- GET `/addons` - GET `/addons`
Get all available addons. Get all available add-ons.
```json ```json
{ {
@ -500,7 +501,7 @@ Get all available addons.
"stage": "stable|experimental|deprecated", "stage": "stable|experimental|deprecated",
"arch": ["armhf", "aarch64", "i386", "amd64"], "arch": ["armhf", "aarch64", "i386", "amd64"],
"machine": "[raspberrypi2, tinker]", "machine": "[raspberrypi2, tinker]",
"homeassistant": "null|min Home Assistant version", "homeassistant": "null|min Home Assistant Core version",
"repository": "12345678|null", "repository": "12345678|null",
"version": "null|VERSION_INSTALLED", "version": "null|VERSION_INSTALLED",
"last_version": "LAST_VERSION", "last_version": "LAST_VERSION",