Skip to content

Commit 23209d9

Browse files
mdegat01mdegat01
authored
Document API options for excluding DB from backups (#1941)
1 parent 82d39c7 commit 23209d9

File tree

2 files changed

+61
-55
lines changed

2 files changed

+61
-55
lines changed

‎docs/api/supervisor/endpoints.md

Lines changed: 47 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -763,12 +763,13 @@ Create a full backup.
763763

764764
**Payload:**
765765

766-
| key | type | optional | description |
767-
| ---------- | -------------- | -------- | ---------------------------------------------- |
768-
| name | string | True | The name you want to give the backup |
769-
| password | string | True | The password you want to give the backup |
770-
| compressed | boolean | True | `false` to create uncompressed backups |
771-
| location | string or null | True | Name of a backup mount or `null` for /backup |
766+
| key | type | optional | description |
767+
| ------------------------------ | -------------- | -------- | ---------------------------------------------------- |
768+
| name | string | True | The name you want to give the backup |
769+
| password | string | True | The password you want to give the backup |
770+
| compressed | boolean | True | `false` to create uncompressed backups |
771+
| location | string or null | True | Name of a backup mount or `null` for /backup |
772+
| homeassistant_exclude_database | boolean | True | Exclude the Home Assistant database file from backup |
772773

773774
**Example response:**
774775

@@ -800,15 +801,16 @@ Create a partial backup.
800801

801802
**Payload:**
802803

803-
| key | type | optional | description |
804-
| ------------- | -------------- | -------- | ---------------------------------------------- |
805-
| name | string | True | The name you want to give the backup |
806-
| password | string | True | The password you want to give the backup |
807-
| homeassistant | boolean | True | Add home assistant core settings to the backup |
808-
| addons | list | True | A list of strings representing add-on slugs |
809-
| folders | list | True | A list of strings representing directories |
810-
| compressed | boolean | True | `false` to create uncompressed backups |
811-
| location | string or null | True | Name of a backup mount or `null` for /backup |
804+
| key | type | optional | description |
805+
| ------------------------------ | -------------- | -------- | ---------------------------------------------------- |
806+
| name | string | True | The name you want to give the backup |
807+
| password | string | True | The password you want to give the backup |
808+
| homeassistant | boolean | True | Add home assistant core settings to the backup |
809+
| addons | list | True | A list of strings representing add-on slugs |
810+
| folders | list | True | A list of strings representing directories |
811+
| compressed | boolean | True | `false` to create uncompressed backups |
812+
| location | string or null | True | Name of a backup mount or `null` for /backup |
813+
| homeassistant_exclude_database | boolean | True | Exclude the Home Assistant database file from backup |
812814

813815
**You need to supply at least one key in the payload.**
814816

@@ -990,22 +992,24 @@ Returns information about the Home Assistant core
990992

991993
**Returned data:**
992994

993-
| key | type | description |
994-
| ---------------- | -------------- | ---------------------------------------------------------- |
995-
| version | string | The installed core version |
996-
| version_latest | string | The latest published version in the active channel |
997-
| update_available | boolean | `true` if an update is available |
998-
| arch | string | The architecture of the host (armhf, aarch64, i386, amd64) |
999-
| machine | string | The machine type that is running the host |
1000-
| ip_address | string | The internal docker IP address to the supervisor |
1001-
| image | string | The container image that is running the core |
1002-
| boot | boolean | `true` if it should start on boot |
1003-
| port | int | The port Home Assistant is running on |
1004-
| ssl | boolean | `true` if Home Assistant is using SSL |
1005-
| watchdog | boolean | `true` if watchdog is enabled |
1006-
| wait_boot | int | Max time to wait during boot |
1007-
| audio_input | string or null | The description of the audio input device |
1008-
| audio_output | string or null | The description of the audio output device |
995+
| key | type | description |
996+
| ------------------------ | -------------- | ---------------------------------------------------------- |
997+
| version | string | The installed core version |
998+
| version_latest | string | The latest published version in the active channel |
999+
| update_available | boolean | `true` if an update is available |
1000+
| arch | string | The architecture of the host (armhf, aarch64, i386, amd64) |
1001+
| machine | string | The machine type that is running the host |
1002+
| ip_address | string | The internal docker IP address to the supervisor |
1003+
| image | string | The container image that is running the core |
1004+
| boot | boolean | `true` if it should start on boot |
1005+
| port | int | The port Home Assistant is running on |
1006+
| ssl | boolean | `true` if Home Assistant is using SSL |
1007+
| watchdog | boolean | `true` if watchdog is enabled |
1008+
| wait_boot | int | Max time to wait during boot |
1009+
| audio_input | string or null | The description of the audio input device |
1010+
| audio_output | string or null | The description of the audio output device |
1011+
| backups_exclude_database | boolean | Backups exclude Home Assistant database file by default |
1012+
10091013

10101014
**Example response:**
10111015

@@ -1044,17 +1048,18 @@ Passing `image`, `refresh_token`, `audio_input` or `audio_output` with `null` re
10441048

10451049
**Payload:**
10461050

1047-
| key | type | description |
1048-
| -------------- | -------------- | ----------------------------------- |
1049-
| boot | boolean | Start Core on boot |
1050-
| image | string or null | Name of custom image |
1051-
| port | int | The port that Home Assistant run on |
1052-
| ssl | boolean | `true` to enable SSL |
1053-
| watchdog | boolean | `true` to enable the watchdog |
1054-
| wait_boot | int | Time to wait for Core to startup |
1055-
| refresh_token | string or null | Token to authenticate with Core |
1056-
| audio_input | string or null | Profile name for audio input |
1057-
| audio_output | string or null | Profile name for audio output |
1051+
| key | type | description |
1052+
| ------------------------ | -------------- | ----------------------------------------------------------- |
1053+
| boot | boolean | Start Core on boot |
1054+
| image | string or null | Name of custom image |
1055+
| port | int | The port that Home Assistant run on |
1056+
| ssl | boolean | `true` to enable SSL |
1057+
| watchdog | boolean | `true` to enable the watchdog |
1058+
| wait_boot | int | Time to wait for Core to startup |
1059+
| refresh_token | string or null | Token to authenticate with Core |
1060+
| audio_input | string or null | Profile name for audio input |
1061+
| audio_output | string or null | Profile name for audio output |
1062+
| backups_exclude_database | boolean | `true` to exclude Home Assistant database file from backups |
10581063

10591064
**You need to supply at least one key in the payload.**
10601065

‎docs/api/supervisor/models.md

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -190,19 +190,20 @@ The `content` key of a backup object contains the following keys:
190190

191191
## Backup details
192192

193-
| key | type | description |
194-
| ------------- | -------------- | ------------------------------------------------------------------------------------------------------------------------ |
195-
| slug | string | A generated slug for the backup |
196-
| type | string | The type of backup (full, partial) |
197-
| name | string | The name given to the backup |
198-
| date | string | ISO date string representation of the date the backup was created |
199-
| size | string | The size of the backup in MB |
200-
| protected | boolean | `true` if the backup is password protected |
201-
| location | string or null | The name of the backup mount it's stored on. `null` if it's stored locally. |
202-
| homeassistant | string | The version of Home Assistant that was in use |
203-
| addons | list | A list of add-ons in the backup. Add-ons are represented as a dictionary with these keys [`slug`,`name`,`version`,`size`] |
204-
| repositories | list | A list of add-on repository URL's as strings |
205-
| folders | list | A list of strings representing directories |
193+
| key | type | description |
194+
| ------------------------------ | -------------- | ------------------------------------------------------------------------------------------------------------------------- |
195+
| slug | string | A generated slug for the backup |
196+
| type | string | The type of backup (full, partial) |
197+
| name | string | The name given to the backup |
198+
| date | string | ISO date string representation of the date the backup was created |
199+
| size | string | The size of the backup in MB |
200+
| protected | boolean | `true` if the backup is password protected |
201+
| location | string or null | The name of the backup mount it's stored on. `null` if it's stored locally. |
202+
| homeassistant | string | The version of Home Assistant that was in use |
203+
| addons | list | A list of add-ons in the backup. Add-ons are represented as a dictionary with these keys [`slug`,`name`,`version`,`size`] |
204+
| repositories | list | A list of add-on repository URL's as strings |
205+
| folders | list | A list of strings representing directories |
206+
| homeassistant_exclude_database | boolean | `true` if the Home Assistant database file was excluded from this backup |
206207

207208
## Stats
208209

0 commit comments

Comments
 (0)