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

Document new freeze and thaw APIs in supervisor (#1902)

Browse Source
This commit is contained in:
Mike Degatano 2023-09-09 04:54:50 -04:00 committed by GitHub
parent a350b7d818
commit 8f5c54cae0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 26 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -841,6 +841,32 @@ Reload backup from storage.
</ApiEndpoint> </ApiEndpoint>
<ApiEndpoint path="/backups/freeze" method="post">
Put Supervisor in a freeze state and prepare Home Assistant and addons for an external backup.
:::note
This does not take a backup. It prepares Home Assistant and addons for one but the expectation
is that the user is using an external tool to make the backup. Such as the snapshot feature in
KVM or Proxmox. The caller should call `/backups/thaw` when done.
:::
**Payload:**
| key | type | optional | description |
| ------- | ----- | -------- | ----------------------------------------------------------------------------- |
| timeout | int | True | Seconds before freeze times out and thaw begins automatically (default: 600). |
</ApiEndpoint>
<ApiEndpoint path="/backups/thaw" method="post">
End a freeze initiated by `/backups/freeze` and resume normal behavior in Home Assistant and addons.
</ApiEndpoint>
<ApiEndpoint path="/backups/<backup>/download" method="get"> <ApiEndpoint path="/backups/<backup>/download" method="get">
Download the backup file with the given slug. Download the backup file with the given slug.