Eclipse MicroProfile Health Check API

Since; 5.181 

Provided version of the API: MicroProfile Health Check 1.0


The Health Check API was created to allow easier probing of the state of computing nodes with a cloud infrastructure environment.

A full overview for the reasoning behind the API can be found in the README for the source code repository.

The complete specification is maintained in the same repository

REST Endpoint

The MicroProfile Healthchecks API defines that a REST endpoint be available from the root context at '/health', and that upon invocation all registered health checks are performed and the results aggregated.

The '/health' endpoint is available under each HTTP(S) listener for a Payara Server or Payara Micro instance, which by default is:

This endpoint is not available until an application has been deployed.