Get overview

GET/api/overview

Reads every server in your configuration at once and returns one entry per server. A server that does not answer within four seconds is reported from its last successful reading with status set to stale, or as unavailable when it has never answered.

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

One reading per configured server. The example is shortened.

collected_atstring<date-time>required

When this response was assembled.

serversobject[]required

One entry per configured server, in configuration order.

cURLcURLPythonJavaScript

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

{
  "collected_at": "2026-10-25T18:57:47.088855825Z",
  "servers": [
    {
      "name": "nas",
      "host": "192.0.2.10",
      "local": false,
      "status": "unavailable",
      "failure_class": "authentication",
      "message": "The server refused the configured credentials."
    }
  ]
}