Get app status

GET/api/install/{app}

Returns whether one catalogue app is installed and, when it is, whether its containers are running. An app that was never installed answers installed: false with status 200.

Authorizations

Authorizationstringheader

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

Response

200 · application/json

The install state.

appstringrequired

The app name.

installedbooleanrequired

true when homebutler installed the app.

statestring

The containers' state, such as running or stopped. Present only when installed is true.

cURL

curl --request GET \
  --url 'http://localhost:8080/api/install/{app}' \
  --header 'Authorization: Bearer <token>'

{
  "app": "it-tools",
  "installed": true,
  "state": "running"
}