mirror of
https://github.com/home-assistant/developers.home-assistant.git
synced 2025-07-25 18:26:29 +00:00
Document new options for supervisor backups (#1442)
This commit is contained in:
parent
41cbae2d62
commit
269a582faa
@ -716,6 +716,43 @@ Return a list of [Backups](api/supervisor/models.md#backup)
|
|||||||
|
|
||||||
</ApiEndpoint>
|
</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">
|
<ApiEndpoint path="/backups/new/full" method="post">
|
||||||
|
|
||||||
Create a full backup.
|
Create a full backup.
|
||||||
@ -779,6 +816,19 @@ Create a partial backup.
|
|||||||
|
|
||||||
</ApiEndpoint>
|
</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">
|
<ApiEndpoint path="/backups/reload" method="post">
|
||||||
|
|
||||||
Reload backup from storage.
|
Reload backup from storage.
|
||||||
|
Loading…
x
Reference in New Issue
Block a user