Check alerts

GET/api/alerts

Compares CPU, memory and each disk with the thresholds in alerts: of your config. It reads and compares only: nothing is sent and nothing is recorded.

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.

Query parameters

serverstring

The name of a remote server from List servers. homebutler runs the command on it over SSH and returns its answer. Leave it out, name the local server, or name a server that is not in the config, to read this machine.

Example: nas

Response

200 · application/json

Each reading with its threshold and a status of ok, warning or critical. The example is shortened.

cpuobjectrequired

memoryobjectrequired

disksobject[]required

One entry per mounted disk.

cURLcURLPythonJavaScript

curl --request GET \
  --url 'http://localhost:8080/api/alerts?server=nas' \
  --header 'Authorization: Bearer <token>'

{
  "cpu": {
    "status": "ok",
    "current": 15.8,
    "threshold": 90
  },
  "memory": {
    "status": "ok",
    "current": 36.43,
    "threshold": 85
  },
  "disks": [
    {
      "mount": "/",
      "status": "ok",
      "current": 7,
      "threshold": 90
    }
  ]
}