mirror of
https://github.com/home-assistant/developers.home-assistant.git
synced 2025-07-10 10:56:28 +00:00
Document API options for excluding DB from backups (#1941)
This commit is contained in:
parent
82d39c795b
commit
23209d9e53
@ -764,11 +764,12 @@ Create a full backup.
|
||||
**Payload:**
|
||||
|
||||
| key | type | optional | description |
|
||||
| ---------- | -------------- | -------- | ---------------------------------------------- |
|
||||
| ------------------------------ | -------------- | -------- | ---------------------------------------------------- |
|
||||
| name | string | True | The name you want to give the backup |
|
||||
| password | string | True | The password you want to give the backup |
|
||||
| compressed | boolean | True | `false` to create uncompressed backups |
|
||||
| location | string or null | True | Name of a backup mount or `null` for /backup |
|
||||
| homeassistant_exclude_database | boolean | True | Exclude the Home Assistant database file from backup |
|
||||
|
||||
**Example response:**
|
||||
|
||||
@ -801,7 +802,7 @@ Create a partial backup.
|
||||
**Payload:**
|
||||
|
||||
| key | type | optional | description |
|
||||
| ------------- | -------------- | -------- | ---------------------------------------------- |
|
||||
| ------------------------------ | -------------- | -------- | ---------------------------------------------------- |
|
||||
| name | string | True | The name you want to give the backup |
|
||||
| password | string | True | The password you want to give the backup |
|
||||
| homeassistant | boolean | True | Add home assistant core settings to the backup |
|
||||
@ -809,6 +810,7 @@ Create a partial backup.
|
||||
| folders | list | True | A list of strings representing directories |
|
||||
| compressed | boolean | True | `false` to create uncompressed backups |
|
||||
| location | string or null | True | Name of a backup mount or `null` for /backup |
|
||||
| homeassistant_exclude_database | boolean | True | Exclude the Home Assistant database file from backup |
|
||||
|
||||
**You need to supply at least one key in the payload.**
|
||||
|
||||
@ -991,7 +993,7 @@ Returns information about the Home Assistant core
|
||||
**Returned data:**
|
||||
|
||||
| key | type | description |
|
||||
| ---------------- | -------------- | ---------------------------------------------------------- |
|
||||
| ------------------------ | -------------- | ---------------------------------------------------------- |
|
||||
| version | string | The installed core version |
|
||||
| version_latest | string | The latest published version in the active channel |
|
||||
| update_available | boolean | `true` if an update is available |
|
||||
@ -1006,6 +1008,8 @@ Returns information about the Home Assistant core
|
||||
| wait_boot | int | Max time to wait during boot |
|
||||
| audio_input | string or null | The description of the audio input device |
|
||||
| audio_output | string or null | The description of the audio output device |
|
||||
| backups_exclude_database | boolean | Backups exclude Home Assistant database file by default |
|
||||
|
||||
|
||||
**Example response:**
|
||||
|
||||
@ -1045,7 +1049,7 @@ Passing `image`, `refresh_token`, `audio_input` or `audio_output` with `null` re
|
||||
**Payload:**
|
||||
|
||||
| key | type | description |
|
||||
| -------------- | -------------- | ----------------------------------- |
|
||||
| ------------------------ | -------------- | ----------------------------------------------------------- |
|
||||
| boot | boolean | Start Core on boot |
|
||||
| image | string or null | Name of custom image |
|
||||
| port | int | The port that Home Assistant run on |
|
||||
@ -1055,6 +1059,7 @@ Passing `image`, `refresh_token`, `audio_input` or `audio_output` with `null` re
|
||||
| refresh_token | string or null | Token to authenticate with Core |
|
||||
| audio_input | string or null | Profile name for audio input |
|
||||
| audio_output | string or null | Profile name for audio output |
|
||||
| backups_exclude_database | boolean | `true` to exclude Home Assistant database file from backups |
|
||||
|
||||
**You need to supply at least one key in the payload.**
|
||||
|
||||
|
@ -191,7 +191,7 @@ The `content` key of a backup object contains the following keys:
|
||||
## Backup details
|
||||
|
||||
| key | type | description |
|
||||
| ------------- | -------------- | ------------------------------------------------------------------------------------------------------------------------ |
|
||||
| ------------------------------ | -------------- | ------------------------------------------------------------------------------------------------------------------------- |
|
||||
| slug | string | A generated slug for the backup |
|
||||
| type | string | The type of backup (full, partial) |
|
||||
| name | string | The name given to the backup |
|
||||
@ -203,6 +203,7 @@ The `content` key of a backup object contains the following keys:
|
||||
| addons | list | A list of add-ons in the backup. Add-ons are represented as a dictionary with these keys [`slug`,`name`,`version`,`size`] |
|
||||
| repositories | list | A list of add-on repository URL's as strings |
|
||||
| folders | list | A list of strings representing directories |
|
||||
| homeassistant_exclude_database | boolean | `true` if the Home Assistant database file was excluded from this backup |
|
||||
|
||||
## Stats
|
||||
|
||||
|
Loading…
x
Reference in New Issue
Block a user