...
| Field | Type | Description | Required | ||
|---|---|---|---|---|---|
AdminRESTAPI.Enabled | bool | is admin REST API enabled or not | No, default = false | ||
AdminRESTAPI.ServerMode | enum | admin REST API server modes:
| No, default = HTTPS | ||
AdminRESTAPI.BindAddress | string | define specific network interface for listening
| No, default = "0.0.0.0" (all interfaces) | ||
AdminRESTAPI.Port | int | TCP port to listen | Yes (if AdminRESTAPI.Enabled = true) | ||
AdminRESTAPI.HTTPSServer.Port | int | TCP port to listen
| No | ||
AdminRESTAPI.HTTPSServer.PrivateKey | string | path to SSL private key file | Yes (if AdminRESTAPI.ServerMode = HTTPS) | ||
AdminRESTAPI.HTTPSServer.Certificate | string | path to SSL certificate file | Yes (if AdminRESTAPI.ServerMode = HTTPS) | ||
AdminRESTAPI.HTTPSServer.CertificateAuthority | string | path to the file or directory containing the CA/root certificates. Can be empty if the OpenSSL builtin CA certificates are used | No | ||
AdminRESTAPI.HeartBeatIntervalS | int | determines the interval at which FIXEdge C++ sends heartbeat messages to FIXICC H2 (in seconds) | 30 |
Configuration Example:
| Code Block |
|---|
AdminRESTAPI.Enabled = true AdminRESTAPI.Port = 8903 AdminRESTAPI.HTTPSServer.PrivateKey = ../FIXEdge1/conf/AdminRESTAPI.key AdminRESTAPI.HTTPSServer.Certificate = ../FIXEdge1/conf/AdminRESTAPI.crt |
...