Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Document force options in supervisor endpoints #2260

Merged
merged 1 commit into from
Oct 8, 2024
Merged

Document force options in supervisor endpoints #2260

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions docs/api/supervisor/endpoints.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1226,6 +1226,7 @@ Rebuild the Home Assistant core container
| key | type | optional | description |
| --------- | ---------- | -------- | -------------------------------- |
| safe_mode | boolean | True | Rebuild Core into safe mode |
| force | boolean | True | Force rebuild during a Home Assistant offline db migration |

</ApiEndpoint>

Expand All @@ -1237,6 +1238,7 @@ Restart the Home Assistant core container
| key | type | optional | description |
| --------- | ---------- | -------- | -------------------------------- |
| safe_mode | boolean | True | Restart Core into safe mode |
| force | boolean | True | Force restart during a Home Assistant offline db migration |

</ApiEndpoint>

Expand Down Expand Up @@ -1267,6 +1269,13 @@ Returns a [Stats model](api/supervisor/models.md#stats) for the Home Assistant c

<ApiEndpoint path="/core/stop" method="post">
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 path="/core/update" method="post">
Expand Down Expand Up @@ -1805,6 +1814,14 @@ Set host options

<ApiEndpoint path="/host/reboot" method="post">
Reboot the host

**Payload:**

| key | type | optional | description |
| --------- | ---------- | -------- | --------------------------------------------------------- |
| force | boolean | True | Force reboot during a Home Assistant offline db migration |


</ApiEndpoint>

<ApiEndpoint path="/host/reload" method="post">
Expand Down Expand Up @@ -1850,6 +1867,13 @@ Get information about host services.

<ApiEndpoint path="/host/shutdown" method="post">
Shutdown the host

**Payload:**

| key | type | optional | description |
| --------- | ---------- | -------- | ----------------------------------------------------------- |
| force | boolean | True | Force shutdown during a Home Assistant offline db migration |

</ApiEndpoint>

### Ingress
Expand Down