danvics/watchyourlan
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

APIのドキュメント変更した

Browse source
This commit is contained in:
yaoresugi 2025-10-20 23:40:31 +09:00
parent 4d69c29bbe
commit 0503c1e72e
1 changed files with 16 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

28
docs/API.md
View file

@ -1,64 +1,68 @@
## API ## API
```http ```http
GET /api/all GET {BASE_PATH}/api/all
``` ```
Returns all hosts in `json`. Returns all hosts in `json`.
```http ```http
GET /api/history GET {BASE_PATH}/api/history
``` ```
Returns all History. Not recommended, the output can be a lot. Returns all History. Not recommended, the output can be a lot.
```http ```http
GET /api/history/:mac/:date 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`. 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`.
```http ```http
GET /api/history/:mac?num=20 GET {BASE_PATH}/api/history/:mac?num=20
``` ```
Returns only last 20 lines of history of a device with this `mac`. Returns only last 20 lines of history of a device with this `mac`.
```http ```http
GET /api/host/:id GET {BASE_PATH}/api/host/:id
``` ```
Returns host with this `id` in `json`. Returns host with this `id` in `json`.
```http ```http
GET /api/port/:addr/:port GET {BASE_PATH}/api/port/:addr/:port
``` ```
Gets state of one `port` of `addr`. Returns `true` if port is open or `false` otherwise. Gets state of one `port` of `addr`. Returns `true` if port is open or `false` otherwise.
<details> <details>
<summary>Request example</summary> <summary>Request example</summary>
```bash ```bash
curl http://0.0.0.0:8840/api/port/192.168.2.2/8844 # 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"
``` ```
</details><br> </details><br>
```http ```http
GET /api/edit/:id/:name/*known 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. Edit host with ID `id`. Can change `name`. `known` is optional, when set to `toggle` will change Known state.
```http ```http
GET /api/host/del/:id GET {BASE_PATH}/api/host/del/:id
``` ```
Remove host with ID `id`. Remove host with ID `id`.
```http ```http
GET /api/notify_test GET {BASE_PATH}/api/notify_test
``` ```
Send test notification. Send test notification.
```http ```http
GET /api/status/*iface 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 `/api/status/`. 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/`.