Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

curl --insecure https://fixedge.host:8903/sessions

Properties

...

Configuration parameters

The properties can be configured in FIXEdge.properties:

FieldTypeDescriptionRequired

AdminRESTAPI.Enabled

bool

is admin REST API enabled or not

No, default = false

AdminRESTAPI.ServerMode

enum

admin REST API server modes:

  • HTTPS
  • HTTP
No, default = HTTPS

AdminRESTAPI.BindAddress

string

define specific network interface for listening


Info

The parameter was introduced in FIXEdge 6.9.0

No, default = "0.0.0.0" (all interfaces)

AdminRESTAPI.Port

intTCP port to listenYes (if
Admin REST API enabled
AdminRESTAPI.Enabled = true)

AdminRESTAPI.HTTPSServer.Port

int

TCP port to listen

Info
No. 

Property is deprecated,

 use AdminRESTAPI.Port instead

No

AdminRESTAPI.HTTPSServer.PrivateKey

stringpath to SSL private key
file (absolute paths are allowed)
file Yes (
for HTTPS server only
if AdminRESTAPI.ServerMode = HTTPS)

AdminRESTAPI.HTTPSServer.Certificate

stringpath to SSL certificate
file (absolute paths are allowed)Yes (for HTTPS server only
fileYes (if AdminRESTAPI.ServerMode = HTTPS)

AdminRESTAPI.HTTPSServer.CertificateAuthority

stringpath to the file or directory containing the CA/root certificates.
Can be empty if the OpenSSL builtin CA certificates are
used (absolute paths are allowed)
usedNo
, default = ""

AdminRESTAPI.BindAddress parameter and absolute paths are available since FIXEdge 6.9.0.

Example:

Code Block
AdminRESTAPI.Enabled = true
AdminRESTAPI.HTTPSServer.Port = 8903
AdminRESTAPI.HTTPSServer.PrivateKey = ../FIXEdge1/conf/AdminRESTAPI.key
AdminRESTAPI.HTTPSServer.Certificate = ../FIXEdge1/conf/AdminRESTAPI.crt 

...