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-19 23:36:28 +00:00
Code Issues Packages Projects Releases Wiki Activity

Document device wipe API (#2097)

Browse Source 
* Document device wipe API

* Tweak wording

* Remove trailing space

* Change doc to mention os level settings wipe

* Replace you with user as this is API doc

* Mention boot config preserved
This commit is contained in:
Mike Degatano 2024-03-01 11:10:56 -05:00 committed by GitHub
parent 30e88c9d97
commit 7e76189ae8
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 19 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -2361,6 +2361,25 @@ Move datadisk to a new location, **This will also reboot the device!**
</ApiEndpoint>
<ApiEndpoint path="/os/datadisk/wipe" method="post">
Wipe the datadisk including all user data and settings, **This will also reboot the device!** This API requires an admin token
This API will wipe all config/settings for addons, Home Assistant and the Operating
System and any locally stored data in config, backups, media, etc. The machine will
reboot during this.
After the reboot completes the latest stable version of Home Assistant and Supervisor
will be downloaded. Once the process is complete the user will see onboarding, like
during initial setup.
This wipe also includes network settings. So after the reboot the user may need to
reconfigure those in order to access Home Assistant again.
The operating system version as well as its boot configuration will be preserved.
</ApiEndpoint>
<ApiEndpoint path="/os/boards/{board}" method="get">
Returns information about your board if it has features or settings