Run watch check

POST/api/watch/check

Inspects every Docker target on the watch list once and records an incident for each one that restarted since the last check. Protection: token. Adding a container that already exists records its state, so its first check compares against that state. The first check of a container that did not exist when it was added sets its baseline and records nothing. Targets of another kind appear in skipped, because a one-shot check inspects Docker only.

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.

Response

200 · application/json

How many targets were checked, and the incidents this check recorded.

checkedintegerrequired

The number of targets inspected.

incidentsobject[]

The incidents this check recorded. Absent when there were none.

skippedobject[]

Targets a one-shot check cannot inspect.

cURLcURLPythonJavaScript

curl --request POST \
  --url 'http://localhost:8080/api/watch/check' \
  --header 'Authorization: Bearer <token>'

{
  "checked": 1
}