Save servers

PUT/api/config/servers

Adds, changes, renames or removes servers in the config file. Protection: token. A field you leave out stays as it is. The key file of a server is not settable here. Moving a server to a new address returns a notice, because the new address is trusted the first time homebutler connects to 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.

serversobject[]required

The servers to add, change or remove.

Response

200 · application/json

The servers 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.

cURL

curl --request PUT \
  --url 'http://localhost:8080/api/config/servers' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "revision": "de00b31a091f1c29664eba416271abe6acc33d96ed0dcf954cec6f9c0fd7cc9a",
  "servers": [
    {
      "name": "pi",
      "host": "192.0.2.30",
      "user": "pi",
      "port": 22,
      "auth": "key"
    }
  ]
}'

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