Save wake targets

PUT/api/config/wake

Adds, changes or removes Wake-on-LAN targets in the config file. Protection: token. A wake target is usable as soon as it is saved, so restart_needed is absent.

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.

targetsobject[]required

The targets to add, change or remove.

Response

200 · application/json

The targets 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/wake' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "revision": "de00b31a091f1c29664eba416271abe6acc33d96ed0dcf954cec6f9c0fd7cc9a",
  "targets": [
    {
      "name": "nas",
      "mac": "11:22:33:44:55:66",
      "broadcast": "127.0.0.255"
    }
  ]
}'

{
  "saved": true,
  "revision": "a98893f99695e4cde28d74934671b5ca88a938dd7c0e28cdb2f80ea598f44409"
}