kresctl(8)

📦
version 6.5.0 · 4 versions
, in arch rolling

💖 kresctl(8) — control Knot Resolver 6.5.0, bestie 💖

✨ NAME ✨

kresctl — Control Knot Resolver 6.5.0, the full caching DNSSEC-enabled resolver. It's literally the remote-control bestie for your resolver 👑.

🌸 SYNOPSIS 🌸

kresctl [-s|--socket API_SOCKET] <command> <args>

Okay so basically: optional socket flag, then a <command>, then whatever <args> that command wants. Periodt 💅.

💜 DESCRIPTION 💜

kresctl is a control tool for Knot Resolver, a DNSSEC-enabled full caching resolver. Not me being obsessed with DNSSEC, but here we are 🫶.

You can use kresctl to control and inspect the configuration of running Knot Resolver via its HTTP API. Main character energy fr fr.

Full documentation is available at https://www.knot-resolver.cz/documentation/latest/ or in package documentation — available as the knot-resolver-doc package in most distributions. Go read it, bestie, iykyk 📚✨.

💅 OPTIONS 💅

The available options are:

  • -s <api_socket>, --socket <api_socket> — Specify how to connect to a running Knot Resolver. Accepts path to Unix-domain socket or host:port. Defaults to /var/run/knot-resolver/kres-api.sock. Some commands do not require communication with the running resolver. In such cases, the value of this option is ignored and the command may succeed even if the socket is invalid.
  • -h, --help — Print help message and exit. So iconic of it.

🎀 COMMANDS 🎀

🛠️ config [-d|--delete] [--stdin] json_ptr [new_value]

config [-d|--delete] [--stdin] json_ptr [new_value]

Get or modify resolver's runtime configuration. The way this works is lowkey a little JSON-pointer situation:

json_ptr follows RFC 6901 and specifies, which part of the configuration will the tool operate on. This argument is required. When not given any additional options or arguments, prints the current configured value. Equivalent to GET method in the underlying HTTP API.

When -d or --delete is provided, kresctl tries to remove the runtime configuration subtree. The operation fails if it renders the configuration invalid. Equivalent to the DELETE method in the HTTP API.

When --stdin or new_value are provided, the new value (from the argument or from reading stdin) is put into the configuration at the given json_ptr. The operation fails if it renders the configuration invalid. Equivalent to PUT method in the underlying HTTP API.

🛑 stop

stop

Gracefully stops the running resolver. It's giving clean exit, no drama 💅.

🦋 SEE ALSO 🦋

👑 AUTHORS 👑

kresd developers are mentioned in the AUTHORS file in the distribution. Respect the devs 👑.

source: CZ.NIC · version: 6.5.0 · date: 2026-10-01 · manual: kresctl(8) — byeee bestie, mwah 🫶✨💖

📦 where this page comes from