List servers

GET/api/servers

Lists the servers in your configuration. Use a name from this list as the server query parameter on the read routes, and as the path parameter of Get server status.

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 configured servers, in configuration order.

namestringrequired

The server's name in your config.

hoststringrequired

The server's address.

localbooleanrequired

true for the machine homebutler runs on.

cURLcURLPythonJavaScript

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

[
  {
    "name": "homelab",
    "host": "192.168.1.10",
    "local": true
  },
  {
    "name": "nas",
    "host": "192.0.2.10",
    "local": false
  }
]