From 7e76189ae8966218da7a34b224add39ef8f42e34 Mon Sep 17 00:00:00 2001 From: Mike Degatano Date: Fri, 1 Mar 2024 11:10:56 -0500 Subject: [PATCH] Document device wipe API (#2097) * 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 --- docs/api/supervisor/endpoints.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/docs/api/supervisor/endpoints.md b/docs/api/supervisor/endpoints.md index 1f3eb621..1d038616 100644 --- a/docs/api/supervisor/endpoints.md +++ b/docs/api/supervisor/endpoints.md @@ -2361,6 +2361,25 @@ Move datadisk to a new location, **This will also reboot the device!** + + +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. + + + Returns information about your board if it has features or settings