Purge app

POST/api/install/{app}/purge

Removes the app's containers and deletes its data volumes. The data does not come back. Protection: token and confirm_name equal to the app in the path.

Authorizations

Authorizationstringheaderrequired

The token you start the server with: homebutler serve --token <token>, or web.token in the config file. Send it as Authorization: Bearer <token>. When the server has a token, every /api/ route except the CORS preflight requires it, reads included.

Path parameters

appstringrequired

The app name from List apps.

Example: it-tools

Body

application/json

confirm_namestringrequired

The same value as the app in the path.

Response

200 · application/json

The app and its data are gone.

statusstringrequired

What happened.

Available options: installedfaileduninstalledpurged

appstringrequired

The app name.

issuesstring[]

Why a pre-flight check failed. Present when status is failed.

portstring

The host port.

pathstring

The folder with the app's compose file and data.

statestring

The containers' state after the install.

data_preservedboolean

true after an uninstall, false after a purge.

warningstring

Present when an earlier install's state couldn't be carried over, or when part of the data is in Docker volumes outside the app directory.

kept_volumesstring[]

Volumes that still exist after a purge. Present only when not empty.

unchecked_volumesstring[]

Volumes Docker couldn't be asked about during a purge. Present only when not empty.

cURLcURLPythonJavaScript

curl --request POST \
  --url 'http://localhost:8080/api/install/{app}/purge' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "confirm_name": "it-tools"
}'

{
  "status": "purged",
  "app": "it-tools",
  "data_preserved": false
}