Configuration of health checks endpoints

The health check endpoints are configured in the instance.properties file or as an environment variable:

IP filtering

Port number

instance.properties

iam.health.address

iam.health.port

Environment variable

IAM_HEALTH_ADDRESS

IAM_HEALTH_PORT

Purpose

Regular expression whitelisting allowed client IP addresses.

Port number of the endpoint.

Default

127.0.0.1

'empty' or undefined

Example

172\\.17\\.\\d+\\.\\d+|192\\.168\\.0\\.\\d+

8081

 
Notice

If the port number is empty or undefined, the health check endpoint is accessible on the same port as Airlock IAM. See also Health check endpoint security.

Availability in IAM modules

Readiness endpoints are available and configurable in the following Airlock IAM modules:

  • Loginapp
  • Transaction Approval

Configure Loginapp readiness health check endpoint

To configure the readiness health check endpoint in the Loginapp follow these steps:

  1. Go to:
    Loginapp >> Advanced Settings >> Readiness Health Check Endpoint
  2. Add the desired checks to the list.
  3. The Readiness Health Check Endpoint is configured.

The configActivation check is enabled by default and cannot be removed. If the Checks list is empty, the configActivation check remains active.

Transaction Approval readiness health check endpoint

To configure the readiness health check endpoint in the Transaction Approval follow these steps:

  1. Go to:
    Transaction Approval >> Advanced Settings >> Readiness Health Check Endpoint
  2. Add the desired checks to the list.
  3. The Readiness Health Check Endpoint is configured.

The configActivation check is enabled by default and cannot be removed. If the Checks list is empty, the configActivation check remains active.