Save alert thresholds

PUT/api/config/alerts

Changes the CPU, memory or disk threshold in the config file. Protection: token. Send the revision from Get config. A save changes only the fields you send. A running watch or alerts process reads thresholds when it starts, so restart_needed names the ones to restart.

Authorizations

Authorizationstringheaderrequired

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.

Body

application/json

revisionstringrequired

The revision from Get config.

cpunumber

The new CPU threshold in percent.

memorynumber

The new memory threshold in percent.

disknumber

The new disk threshold in percent.

Response

200 · application/json

The thresholds were saved.

savedbooleanrequired

true.

revisionstringrequired

The revision of the file as saved. Use it for the next save.

restart_neededstring[]

The processes that read this setting at start and need a restart to use it.

noticesstring[]

Things that are true about the save and worth knowing.

cURLcURLPythonJavaScript

curl --request PUT \
  --url 'http://localhost:8080/api/config/alerts' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "revision": "de00b31a091f1c29664eba416271abe6acc33d96ed0dcf954cec6f9c0fd7cc9a",
  "cpu": 91
}'

{
  "saved": true,
  "revision": "e1f870168b857bb64a55869ef60c659e39e636a94198af3b51e47f63cbacadf2",
  "restart_needed": [
    "watch",
    "alerts"
  ]
}