Page tree
Skip to end of metadata
Go to start of metadata

Overview

FIXEdge Admin REST API is intended to be a pragmatic tool for on-the-fly tuning of the most common FIXEdge properties.

It offers REST interface to handle the following properties of FIXEdge:

  1. Referring to FIX message log:
    1. Retrieve FIX message log of specific / all sessions
    2. Output the acquired contents to text
  2. Get FIX session list:
    1. Retrieve the list of session definitions and their states
    2. Output the acquired contents to text
  3. Session Control

    1. Start and stop sessions
  4. Reset sequence No.

    1. Reset FIX sequence No. (incoming and outgoing)
  5. Set sequence No.

    1. Set an arbitrary value for the sequence number of a specific session
  6. Reload BL_Config.xml

  7. Send messages to session output queue

Installation

FIXEdge Admin REST API is a part of FIXEdge Server and is introduced in version 6.4.0 of FIXEdge. It's needed to enable AdminRESTAPI.Enabled parameter and set the values for all required AdminRESTAPI fields in FIXEdge.properties (See the "Properties" section).

Admin REST API is available via HTTPS protocol only so it's needed to configure a certificate and a private key which it uses for encryption. FIXEdge packages contain self-signed certificate and private key that can be used by Admin REST API. You can set up your own a self-signed certificate for the servers you're connecting to as described in the "Configuration of Admin REST API with self-signed SSL certificate" section below. 

Note: when you're connecting to a server that uses a self-signed certificate, you will be displayed a warning (see figure below). Click on the "Add Exception..." button to add the certificate to a set of trusted certificates.

If you use cURL to query Admin REST API you need to add parameter --insecure, e.g.

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

Properties

Properties to configure in FIXEdge.properties:

Field

Type

Description

Required

AdminRESTAPI.Enabledboolis admin REST API enabled or notNo, default = false
AdminRESTAPI.HTTPSServer.PortintTCP port to listenYes
AdminRESTAPI.HTTPSServer.PrivateKeystringpath to SSL private key fileYes
AdminRESTAPI.HTTPSServer.Certificatestringpath to SSL certificate fileYes
AdminRESTAPI.HTTPSServer.CertificateAuthoritystringpath to the file or directory containing the CA/root certificates. Can be empty if the OpenSSL builtin CA certificates are usedNo, default = ""

Example:

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

Configuration of Admin REST API with self-signed SSL certificate:

You need OpenSSL or LibreSSL installed on your system to follow this instruction.  For Windows systems you can get OpenSSL from Cygwin (www.cygwin.com). 

  1. Create CA root key
    openssl genrsa -out rootCA.key 2048
  2. Create root certificate
    openssl req -x509 -new -key rootCA.key -days 10000 -out rootCA.crt
    Answer the questions that openssl asks.  The duration of certificate will be 10000 days.
  3. Generate certificate signed with the created CA
    openssl genrsa -out AdminRESTAPI.key 2048
  4. Create certificate signing request
    openssl req -new -key AdminRESTAPI.key -out AdminRESTAPI.csr
  5. Sign the certificate with the root certificate
    openssl x509 -req -in AdminRESTAPI.csr -CA rootCA.crt -CAkey rootCA.key -CAcreateserial -out AdminRESTAPI.crt -days 5000

Documentation

FIXEdge Administrative REST API and SDK Documentation


  • No labels