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-23 01:06:30 +00:00
Code Issues Packages Projects Releases Wiki Activity

Document new options for supervisor backups (#1442)

Browse Source
This commit is contained in:
Mike Degatano 2022-10-17 07:45:47 -04:00 committed by GitHub
parent 41cbae2d62
commit 269a582faa
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 50 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -716,6 +716,43 @@ Return a list of [Backups](api/supervisor/models.md#backup)
</ApiEndpoint>
<ApiEndpoint path="/backups/info" method="get">
Return information about backup manager.
**Returned data:**
| key | type | description |
| ---------------- | ---------- | ---------------------------------------------------- |
| backups | list | A list of [Backups](api/supervisor/models.md#backup) |
| days_until_stale | int | Number of days until a backup is considered stale |
**Example response:**
```json
{
"backups": [
{
"slug": "skuwe823",
"date": "2020-09-30T20:25:34.273Z",
"name": "Awesome backup",
"type": "partial",
"size": 44,
"protected": true,
"compressed": true,
"content": {
"homeassistant": true,
"addons": ["awesome_addon"],
"folders": ["ssl", "media"]
}
}
],
"days_until_stale": 30
}
```
</ApiEndpoint>
<ApiEndpoint path="/backups/new/full" method="post">
Create a full backup.
@ -779,6 +816,19 @@ Create a partial backup.
</ApiEndpoint>
<ApiEndpoint path="/backups/options" method="post">
Update options for backup manager, you need to supply at least one of the payload keys to the API call.
**Payload:**
| key | type | description |
| ---------------- | -------------- | ----------------------------------------------------- |
| days_until_stale | int | Set number of days until a backup is considered stale |
**You need to supply at least one key in the payload.**
</ApiEndpoint>
<ApiEndpoint path="/backups/reload" method="post">
Reload backup from storage.