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-09 18:36:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

Document new backup location options (#1777)

Browse Source
This commit is contained in:
Mike Degatano 2023-05-21 09:06:17 -04:00 committed by GitHub
parent 30def44683
commit df69143c32
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 29 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -761,11 +761,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 |
| 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 |
**Example response:**
@ -797,14 +798,15 @@ 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 |
| addons | list | True | A list of strings representing add-on slugs |
| folders | list | True | A list of strings representing directories |
| compressed | boolean | True | `false` to create uncompressed backups |
| 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 |
| addons | list | True | A list of strings representing add-on slugs |
| 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 |
**You need to supply at least one key in the payload.**
@ -1769,6 +1771,20 @@ Returns information about mounts configured in Supervisor
</ApiEndpoint>
<ApiEndpoint path="/mounts/options" method="post">
Set mount manager options
**Payload:**
| key | type | optional | description |
| -------------------- | -------------- | -------- | -------------------------------------------- |
| default_backup_mount | string or null | True | Name of a backup mount or `null` for /backup |
**You need to supply at least one key in the payload.**
</ApiEndpoint>
<ApiEndpoint path="/mounts" method="post">
Add a new mount in Supervisor and mount it