API Reference
The nyxd control API is documented as an OpenAPI 3 specification.
- Download/view spec: openapi.yaml
- Source in repository:
docs/openapi.yaml
Use with tooling
You can inspect the spec with tools like:
- Swagger Editor
- Redocly CLI
- OpenAPI Generator
Example:
curl -sS http://localhost:8080/healthz
For endpoint behavior and operational examples, see Usage.