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

Clean api doc (#1782)

Browse Source 
* Clean supervisor

* Indent snapshot

* Clean host

* Indent host services

* Indent HassOS

* Clean hardware

* Clean home assistant

* Clean add-ons

* Clean ingress

* Clean discovery

* Clean services

* Clean mqtt

* Clean mysql

* Clean misc

* Clean dns

* Clean cli

* Clean observer

* Clean multicast

* Clean audio

* Clean auth
This commit is contained in:
Martin Hjelmare 2020-09-14 17:04:15 +02:00 committed by GitHub
parent ca60a69b22
commit 0761885ebb
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 781 additions and 781 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
API.md
View File

@ -32,11 +32,11 @@ The token is available for add-ons and Home Assistant using the
- GET `/supervisor/ping` - GET `/supervisor/ping`
This API call don't need a token. This API call doesn't need a token.
- GET `/supervisor/info` - GET `/supervisor/info`
Shows the installed add-ons from `addons`. `addons` returns all the installed add-ons.
```json ```json
{ {
@ -357,7 +357,7 @@ Load host configurations from an USB stick.
- POST `/hardware/trigger` - POST `/hardware/trigger`
Trigger an UDEV reload. Trigger a UDEV reload.
### Home Assistant ### Home Assistant
@ -417,11 +417,11 @@ Output is the raw Docker log.
} }
``` ```
Image with `null` and `version_latest` with `null` reset this options. Passing `image` with `null` and `version_latest` with `null` resets these options.
- POST/GET `/core/api` - POST/GET `/core/api`
Proxy to the Home Assistant Core instance. Proxy to Home Assistant Core instance.
- GET `/core/websocket` - GET `/core/websocket`
@ -501,7 +501,7 @@ _All options are optional._
The result will be a updated object. The result will be a updated object.
### RESTful for API add-ons ### RESTful API for 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/...`.
@ -637,7 +637,7 @@ Get all available add-ons.
} }
``` ```
Reset custom network, audio and options, set it to `null`. To reset customized network/audio/options, set it `null`.
- POST `/addons/{addon}/security` - POST `/addons/{addon}/security`
@ -713,7 +713,7 @@ Return a list of enabled panels.
- VIEW `/ingress/{token}` - VIEW `/ingress/{token}`
Ingress WebUI for this add-on. The add-on need support for the Home Assistant Ingress WebUI for this add-on. The add-on needs support for the Home Assistant
authentication system. Needs an ingress session as cookie. authentication system. Needs an ingress session as cookie.
### discovery ### discovery