Get watch list

GET/api/watch

Returns the watch list, whether a service is installed to poll it, and how many incidents are kept. The three come in one response because a list with no service polling it records nothing.

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.

Response

200 · application/json

The targets, the service and the retention.

targetsobject[]required

The watch list.

serviceobjectrequired

The service that polls the watch list.

retentionobjectrequired

How full the incident directory is.

cURLcURLPythonJavaScript

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

{
  "targets": [
    {
      "container": "flaky",
      "kind": "docker",
      "unit": "flaky",
      "added_at": "2026-10-25T11:58:28.036439838-07:00"
    }
  ],
  "service": {
    "installed": false,
    "unit": "/home/you/.config/systemd/user/dev.homebutler.watch.service"
  },
  "retention": {
    "kept": 0,
    "max": 200
  }
}