Get config

GET/api/config

Returns the settings the dashboard shows: servers, Proxmox endpoints, alert thresholds, wake targets and notification channels. Secrets are never returned. A credential appears as a set flag, and a notification field that is not a secret appears with its value. When the server has a token, the response carries a revision to send back with a save.

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 current settings.

pathstringrequired

The config file in use, or (defaults) when there is none.

serversobject[]required

The servers.

proxmoxobject[]required

The Proxmox endpoints.

alertsobjectrequired

The alert thresholds in percent.

wakeobject[]required

The wake targets.

notifyobject[]required

Every channel homebutler has, configured or not.

editablebooleanrequired

true when the server has a token, which is what enables the save routes.

transport_warningstringrequired

A warning when the token travels over plain HTTP on a public address. Empty otherwise.

revisionstring

Send this back with a save. Present only when editable is true and the config file exists. It is valid until the file changes or the server restarts.

cURLcURLPythonJavaScript

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

{
  "alerts": {
    "cpu": 90,
    "disk": 90,
    "memory": 85
  },
  "editable": true,
  "notify": [
    {
      "channel": "telegram",
      "configured": false,
      "fields": [
        {
          "name": "bot_token",
          "secret": true,
          "set": false
        },
        {
          "name": "chat_id"
        }
      ]
    },
    {
      "channel": "slack",
      "configured": false,
      "fields": [
        {
          "name": "webhook_url",
          "secret": true,
          "set": false
        }
      ]
    },
    {
      "channel": "discord",
      "configured": false,
      "fields": [
        {
          "name": "webhook_url",
          "secret": true,
          "set": false
        }
      ]
    },
    {
      "channel": "webhook",
      "configured": true,
      "fields": [
        {
          "name": "url",
          "secret": true,
          "set": true
        }
      ]
    },
    {
      "channel": "ntfy",
      "configured": false,
      "fields": [
        {
          "name": "url"
        },
        {
          "name": "topic",
          "secret": true,
          "set": false
        },
        {
          "name": "token",
          "secret": true,
          "optional": true,
          "set": false
        }
      ]
    },
    {
      "channel": "gotify",
      "configured": false,
      "fields": [
        {
          "name": "url"
        },
        {
          "name": "token",
          "secret": true,
          "set": false
        }
      ]
    }
  ],
  "path": "/home/you/.config/homebutler/config.yaml",
  "proxmox": [
    {
      "action_token_id": "power@pve!action",
      "action_token_in_file": false,
      "action_token_set": true,
      "host": "127.0.0.1",
      "name": "pve",
      "port": 8699,
      "token_id": "monitoring@pve!readonly",
      "token_in_file": false,
      "token_set": true
    }
  ],
  "revision": "5dc27a5248d989362c784ef6616e8bcd949b22c5d7ff8ae1a1d3ff022a5ad009",
  "servers": [
    {
      "auth": "key",
      "host": "192.168.1.10",
      "key": "",
      "local": true,
      "name": "homelab",
      "password_set": false,
      "port": 0,
      "user": ""
    },
    {
      "auth": "key",
      "host": "192.0.2.10",
      "key": "",
      "local": false,
      "name": "nas",
      "password_set": false,
      "port": 0,
      "user": "admin"
    }
  ],
  "transport_warning": "",
  "wake": [
    {
      "broadcast": "127.0.0.255",
      "mac": "AA:BB:CC:DD:EE:FF",
      "name": "desktop"
    }
  ]
}