Modifying the REST API Server Port

*This documentation section describes the LifeKeeper Web Management Console (LKWMC). Refer to the LifeKeeper Web Management Console for an overview.

By default, the REST API server listens for client connections on TCP port 5000. If necessary (e.g., if there is a conflict caused by a different process listening on the same port), this port number may be changed.

To change the port number, follow these steps:

1. On each LifeKeeper cluster node, open the /etc/default/LifeKeeper file using a text editor:

<LKROOT>\etc\default\LifeKeeper

and add an entry of the following form (or modify the entry if it already exists):

RESTAPI_PORT=<REST API Server TCP Port>

where <REST API Server TCP Port> is a valid TCP port in the range 1-65535 which is not already in use. For example, to set the REST API server port to TCP port 5010, the following entry would be added:

RESTAPI_PORT=5010

*It is important to make this modification to <LKROOT>\etc\default\LifeKeeper on all nodes in the LifeKeeper cluster.

2. Restart the LifeKeeper REST API and the LifeKeeper Web Management Console service.
   Run the Windows service and right-click on the LifeKeeper REST API and the LifeKeeper Web Management Console service individually and select Restart.

*It is important to restart the GUI server service so that its configuration is updated appropriately to send API requests to the correct port.

Rules must be changed based on the new port number in the environment where the firewall is enabled.

The following shows the steps to change the Inbound Rules in the Windows Defender Firewall based on the new port number.

1. Open Windows Defender Firewall with Advanced Security console .
2. Click Inbound Rules in the right pane.
3. Right-click the LifeKeeper REST API from the list of rules and click Properties.
4. Move to the Protocol and Ports.
5. Change the existing port number to the new port number in the Protocol and Specific local ports.
6. Click Apply and then OK to save the setting.