Skip to main content
Version: 1.0.0

nyxd control API

Minimal HTTP API for nyxd, served on a Unix domain socket (default /run/nyxd/nyxd.sock). There is no TCP listener by default.

Calling the API

curl -sS --unix-socket /run/nyxd/nyxd.sock http://localhost/v1/ping

Replace /run/nyxd/nyxd.sock with your socket path or NYXD_SOCKET / nyx -socket.

Authentication: none today (local trust). Socket permissions are typically 0660.

Errors: many routes use text/plain bodies from http.Error; JSON endpoints return application/json on success.