halon-api loads the non-reloadable configuration from
It is described by, and can be validated with, the
JSON schema (included in our Visual Studio Code integration).
The default startup configuration file in
/opt/halon/api/share can normally be used as a base:
$ cp /opt/halon/api/share/api.yaml /etc/halon/
188.8.131.52.1. Authentication directives¶
The secret that needs to be sent in the request using the X-API-Key header.
184.108.40.206.2. Listener directives¶
The API must have one or more listen directives, which specify which TCP port and address to listen on. Required.
Which TCP port to listen on. Required.
IPv4 or IPv6 address to listen on. The default is to listen to all IPv4 and IPv6 addresses.
The X.509 certificate and private key. The private key and certificate should have either a
pki: certificate: data: |- -----BEGIN CERTIFICATE----- ... privatekey: data: |- -----BEGIN PRIVATE KEY----- ...