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-06-07 02:36:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

Document force options in supervisor endpoints (#2260)

Browse Source
This commit is contained in:
Mike Degatano 2024-10-08 16:01:08 -04:00 committed by GitHub
parent a4bde2c9d1
commit d46aa77cc3
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 24 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -1228,6 +1228,7 @@ Rebuild the Home Assistant core container
| key | type | optional | description | | key | type | optional | description |
| --------- | ---------- | -------- | -------------------------------- | | --------- | ---------- | -------- | -------------------------------- |
| safe_mode | boolean | True | Rebuild Core into safe mode | | safe_mode | boolean | True | Rebuild Core into safe mode |
| force | boolean | True | Force rebuild during a Home Assistant offline db migration |
</ApiEndpoint> </ApiEndpoint>
@ -1239,6 +1240,7 @@ Restart the Home Assistant core container
| key | type | optional | description | | key | type | optional | description |
| --------- | ---------- | -------- | -------------------------------- | | --------- | ---------- | -------- | -------------------------------- |
| safe_mode | boolean | True | Restart Core into safe mode | | safe_mode | boolean | True | Restart Core into safe mode |
| force | boolean | True | Force restart during a Home Assistant offline db migration |
</ApiEndpoint> </ApiEndpoint>
@ -1269,6 +1271,13 @@ Returns a [Stats model](api/supervisor/models.md#stats) for the Home Assistant c
<ApiEndpoint path="/core/stop" method="post"> <ApiEndpoint path="/core/stop" method="post">
Stop the Home Assistant core container Stop the Home Assistant core container
**Payload:**
| key | type | optional | description |
| --------- | ---------- | -------- | -------------------------------- |
| force | boolean | True | Force stop during a Home Assistant offline db migration |
</ApiEndpoint> </ApiEndpoint>
<ApiEndpoint path="/core/update" method="post"> <ApiEndpoint path="/core/update" method="post">
@ -1807,6 +1816,14 @@ Set host options
<ApiEndpoint path="/host/reboot" method="post"> <ApiEndpoint path="/host/reboot" method="post">
Reboot the host Reboot the host
**Payload:**
| key | type | optional | description |
| --------- | ---------- | -------- | --------------------------------------------------------- |
| force | boolean | True | Force reboot during a Home Assistant offline db migration |
</ApiEndpoint> </ApiEndpoint>
<ApiEndpoint path="/host/reload" method="post"> <ApiEndpoint path="/host/reload" method="post">
@ -1852,6 +1869,13 @@ Get information about host services.
<ApiEndpoint path="/host/shutdown" method="post"> <ApiEndpoint path="/host/shutdown" method="post">
Shutdown the host Shutdown the host
**Payload:**
| key | type | optional | description |
| --------- | ---------- | -------- | ----------------------------------------------------------- |
| force | boolean | True | Force shutdown during a Home Assistant offline db migration |
</ApiEndpoint> </ApiEndpoint>
### Ingress ### Ingress