*Redundant API

Technical Article | TA-20201002-TP-37

VDG Sense | Tutorials | Failover

Introduction

The Redundant API solution is a way to keep an active API between the HTTP plugin and the Master server, by configuring a Slave server to be a backup API. If the Master server fails, and a Failover server takes over, the secondary API can contact the Failover server instead.

How it works

In the following example, we have a security site with 1 Master server and 2 Slave servers. 1 slave server also has an API connection to the master. A third party connects with the master server API. Finally, a Failover server is on stand-by.

 

If the Master server fails, the Failover server will temporary become new Master server.  Due to the redundant API solution, the slave server will now contact the Failover server instead. The third party can use the secondary connection to the slave server to connect to the API on the temporary Master.

Setup

The minimal requirements to make use of a redundant API solution:

  • 2 Servers with API license

    • 1 Master server  – Primary API

    • 1 Slave server     – Secondary API

  • 1 Failover server

To setup a redundant API solution, a correct failover configuration needs to be created first. The instructions of setting up a Failover solution can be found here.

When the failover has been correctly configured, the API plugin on the Slave server should be set to connect to the Master server. This can be done by logging in as administrator on the slave server and navigating to the “Plugins” tab. Open the HTTP Server plugin and use the Address field under the login section to enter the Master server IP addresss:

 

Related pages