Reading statistics from NetoDNS API

About the NetoDNS API

The NetoDNS API is a very simple API endpoint that provides client-side statistics from a running NetoDNS instance. By default, the API listens on TCP port 8080. The API is unauthenticated and read-only. For a production deployment, access to the API port on NetoDNS should be restricted by network access, or the API should be disabled if it is not needed.

Per-device statistics are calculated pre-filter and pre-downsample.

Configuring the NetoDNS API

environment variable configuration settings

NETO_API__ENABLED=true  
NETO_API__PORT=8080  

For more details on how to modify the configuration of NetoDNS, see see: Install NetoDNS (container) or Install NetoDNS (Linux package)

Reading statistics with the NetoDNS API

Read statistics from port 8080 on the NetoDNS host using this endpoint: /api/v1/stats/rate

On your local system: http://localhost:8080/api/v1/stats/rate

If you cannot access this port when NetoDNS is running, ensure you do not have a local firewall in place that is blocking the port, you have mapped the container port 8080 to a local port if you are using the NetoDNS container, and you have not disabled or changed the port in the NetoDNS configuration.

Using curl to read statistics from NetoDNS running on localhost

curl localhost:8080/api/v1/stats/rate