diff --git a/docs/api/supervisor/endpoints.md b/docs/api/supervisor/endpoints.md index ceb460a4..1b06cf6e 100644 --- a/docs/api/supervisor/endpoints.md +++ b/docs/api/supervisor/endpoints.md @@ -716,6 +716,43 @@ Return a list of [Backups](api/supervisor/models.md#backup) + + +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 +} +``` + + + Create a full backup. @@ -779,6 +816,19 @@ Create a partial backup. + +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.** + + + Reload backup from storage.