Skip to content

Logger: REST API

Built-in webserver with REST API to search domains, clients and more... Basic authentication is supported.

Configuration Options

  • listen-ip (string)

    Listening IP address

  • listen-port (integer)

    Listening port

  • basic-auth-enable (boolean)

    Enable or disable basic authentication

  • basic-auth-login (string)

    Default login username for basic auth

  • basic-auth-pwd (string)

    Default password for basic auth

  • tls-support (boolean)

    Enable TLS support

  • tls-min-version (string)

    Minimum TLS version (defaults to 1.2)

  • cert-file (string)

    Path to certificate server file

  • key-file (string)

    Path to private key server file

  • top-n (integer)

    Default number of items returned for top stats queries

  • chan-buffer-size (integer)

    Specifies the maximum number of packets that can be buffered before discarding additional packets. Set to zero to use the default global value.

Default Values

restapi:
  listen-ip: 0.0.0.0
  listen-port: 8080
  basic-auth-enable: true
  basic-auth-login: admin
  basic-auth-pwd: changeme
  tls-support: true
  tls-min-version: 1.2
  cert-file: "./tests/testsdata/server.crt"
  key-file: "./tests/testsdata/server.key"
  top-n: 100
  chan-buffer-size: 0

REST API Reference

The DNS-collector REST API logger worker exposes several endpoints to query collected statistics, metrics, client IPs, domain lists, and flagged suspicious traffic in real-time.