Send wake packet

POST/api/wake/{name}

Sends a Wake-on-LAN magic packet to one target. Protection: token. A target without a broadcast address in the config uses 255.255.255.255.

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.

Path parameters

namestringrequired

The wake target name, from List wake targets.

Example: desktop

Response

200 · application/json

The packet was sent.

actionstringrequired

wake.

macstringrequired

The MAC address.

broadcaststringrequired

The address the packet went to.

statusstringrequired

sent.

Available options: sent

cURL

curl --request POST \
  --url 'http://localhost:8080/api/wake/{name}' \
  --header 'Authorization: Bearer <token>'

{
  "action": "wake",
  "mac": "AA:BB:CC:DD:EE:FF",
  "broadcast": "127.0.0.255",
  "status": "sent"
}