diff --git a/README.md b/README.md index e12d19b..3a09b86 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,9 @@ - [build](#build) - [configure](#configure) - [example](#example) +- [requests responses](#requests-responses) + - [/api/settings](#settings) + - [/api/settings/file](#settingsfile) ## routes @@ -35,3 +38,46 @@ SERVER_PORT=8090 SYSTEM_INITIALIZATION=rc ``` + +## requests-responses + +### settings + +#### `/api/settings` + +```json +{ + "cache_size": 10000, + "hosts": { + "185.130.83.26": "gitea.home.com", + "192.168.3.1": "router.home.com", + "192.168.3.113": [ + "samba.home.com", + "gitea.home.com", + "navidrome.home.com" + ], + "192.168.3.119": [ + "immich.home.com", + "jellyfin.home.com", + "portainer.home.com" + ], + "192.168.3.155": "dns.home.com" + }, + "resolv": [ + "192.168.3.1", + "109.194.32.1", + "5.3.3.3", + "8.8.8.8" + ] +} +``` + +### settingsfile + +#### `/api/settings/file` + +``` +resolv-file=/etc/dnsmasq.conf.d/resolv.conf +addn-hosts=/etc/dnsmasq.conf.d/hosts +cache-size=10000 +```