API

Options below contained in api object in the config file.

id null (string, null)

Instance ID for API.

worker-id null (string, null)

Worker ID, hostname if not specified. This option supports environment variables.

Options below contained in http object in the config file. You can use Wizard to generate config for this object.

enabled false (boolean)

Enable or disable HTTP API.

host "127.0.0.1" (string)

Bind host (IP address) for HTTP API. Common useful options:

• 127.0.0.1 - access from local computer only.
• 0.0.0.0 - any IPv4 address.
• :: - any IPv4 and IPv6 address.

port 0 (number)

Bind port. Default value 0 is a valid option but not too useful because the API will bind to a random port on each start, you must choose the port.

access-token null (string, null)

Access token.

restricted true (boolean)

Enable (only if access token set) or disable full access to HTTP API.