AdGuardDNS/doc/debughttp.md
Andrey Meshkov b6a98906a5 Sync v2.0
2022-08-26 14:18:35 +03:00

1.5 KiB

AdGuard DNS Debug HTTP API

The AdGuard DNS debug HTTP API is served on LISTEN_PORT and contains various private debugging information.

Contents

GET /dnsdb/csv

The CSV dump of the current DNSDB statistics. Example of the output:

example.com,A,NOERROR,93.184.216.34,42
example.com,AAAA,NOERROR,2606:2800:220:1:248:1893:25c8:1946,123

The response is sent with the Transfer-Encoding set to chunked and with an HTTP trailer named X-Error which describes errors that might have occurred during the database dump.

NOTE: For legacy software reasons, despite the endpoint being a GET one, it rotates the database, and so changes the internal state.

GET /health-check

A simple health check API. Always responds with a 200 OK status and the plain-text body OK.

GET /metrics

Prometheus metrics HTTP API. See the metrics page for more details.

GET /debug/pprof

The HTTP interface of Go's PProf HTTP API.