Save notification channels

PUT/api/config/notify

Sets or removes notification channels in the config file. Protection: token. Each key of channels is a channel name from notify in Get config. Send a secret as {"value": "..."} to set it or {"clear": true} to remove it. A secret you leave out stays as it is. An empty value clears it.

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.

channelsobjectrequired

The channels to change, by name.

Response

200 · application/json

The channels 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/notify' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "revision": "de00b31a091f1c29664eba416271abe6acc33d96ed0dcf954cec6f9c0fd7cc9a",
  "channels": {
    "ntfy": {
      "values": {
        "url": "http://127.0.0.1:8601"
      },
      "secrets": {
        "topic": {
          "value": "topic"
        }
      }
    }
  }
}'

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