Health check endpoints, responses, and security

The following table shows the endpoints available for health checks:

• The health check endpoint consists of a list of different checks:
• Liveness endpoint: has a fixed list of checks, which is currently not configurable. The configurationActivation check is not included in this list. Liveness checks will therefore report Airlock IAM to be UP, even if the configuration was not loaded yet.
• Readiness endpoint: health checks can be configured in the Config Editor for the Loginapp and the Transaction Approval modules. The configurationActivation check is always part of the checks and cannot be removed.

The response to a health check request can be UP or DOWN. This is also indicated by the HTTP response status code:

Health check endpoints also provide a JSON response body, which is intended to be human-readable and indicate which check failed.

The health check endpoints have been designed for the following usage:

• If an IAM module (adminapp, loginapp, ...) is configured in the instance properties file, it automatically provides the liveness endpoint.
• The Loginapp and the Transaction Approval automatically check whether the configuration can be activated in the readiness endpoint.
• Even if an IAM module has no configuration, it is considered to be in a correct state regarding the liveness endpoint.
• The liveness endpoint reports all modules as UP during configuration activation.
• If there is no configuration for an IAM module or if the activation fails, the readiness endpoint reports status DOWN.

• Eclipse MicroProfile Health v3.0