jeans/developers.home-assistant
jeans/developers.home-assistant
1
0
Fork 0
mirror of https://github.com/home-assistant/developers.home-assistant.git synced 2025-07-26 10:46:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add missing options to Supervisor's core/options endpoint (#1146)

Browse Source
This commit is contained in:
Stefan Agner 2021-11-30 18:18:14 +00:00 committed by GitHub
parent c34b75731a
commit 448c7c2335
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
docs/api/supervisor/endpoints.md
View File

@ -960,18 +960,20 @@ Update options for Home Assistant, you need to supply at least one of the payloa
You need to call `/core/restart` after updating the options. You need to call `/core/restart` after updating the options.
:::tip :::tip
Passing `image` with `null` and `version_latest` with `null` resets these options. Passing `image`, `refresh_token`, `audio_input` or `audio_output` with `null` resets the option.
::: :::
**Payload:** **Payload:**
| key | type | description | | key | type | description |
| -------------- | -------------- | ----------------------------------- | | -------------- | -------------- | ----------------------------------- |
| image | string | Name of custom image or null | | boot | boolean | Start Core on boot |
| version_latest | string or null | Optional for custom image or null | | image | string or null | Name of custom image |
| port | string | The port that Home Assistant run on | | port | int | The port that Home Assistant run on |
| ssl | boolean | `true` if SSL is enabled | | ssl | boolean | `true` to enable SSL |
| watchdog | boolean | `true` if watchdog is enabled | | watchdog | boolean | `true` to enable the watchdog |
| wait_boot | int | Time to wait for Core to startup |
| refresh_token | string or null | Token to authenticate with Core |
| audio_input | string or null | Profile name for audio input | | audio_input | string or null | Profile name for audio input |
| audio_output | string or null | Profile name for audio output | | audio_output | string or null | Profile name for audio output |