danvics/watchyourlan
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
watchyourlan/docs/API.md
yaoresugi 986e952ac4 /を入れるの忘れてた
2025-12-19 00:22:18 +09:00

1.5 KiB
Raw Blame History

API

GET {BASE_PATH}/api/all

Returns all hosts in json.

GET {BASE_PATH}/api/history

Returns all History. Not recommended, the output can be a lot.

GET {BASE_PATH}/api/history/:mac/:date

Returns only history of a device with this mac filtered by date. date format can be anything from 2 to 2025-07 to 2025-07-26.

GET {BASE_PATH}/api/history/:mac?num=20

Returns only last 20 lines of history of a device with this mac.

GET {BASE_PATH}/api/host/:id

Returns host with this id in json.

GET {BASE_PATH}/api/port/:addr/:port

Gets state of one port of addr. Returns true if port is open or false otherwise.

Request example 
# No base path
curl "http://0.0.0.0:8840/api/port/192.168.2.2/8844"

# Generic form
curl "http://0.0.0.0:8840/{BASE_PATH}/api/port/192.168.2.2/8844"


GET {BASE_PATH}/api/edit/:id/:name/*known

Edit host with ID id. Can change name. known is optional, when set to toggle will change Known state.

GET {BASE_PATH}/api/host/del/:id

Remove host with ID id.

GET {BASE_PATH}/api/notify_test

Send test notification.

GET {BASE_PATH}/api/status/*iface

Show status (Total number of hosts, online/offline, known/unknown). The iface parameter is optional and shows status for one interface only. For all interfaces just call {BASE_PATH}/api/status/.