Skip to main content
Version: 2.2

Healthcheck endpoints

The healthcheck endpoint is accessed through:

GET /health

This endpoint provides information about the health of the application and returns HTTP Status 200 OK to indicate overall system health, component statuses (probes), and relevant details.

For an example of the healthcheck in use, see Verify that ADS is running.

Healthcheck probes

ADS reports its health status during different stages of its lifecycle to ensure its robustness in an orchestrated deployment.

In this regard, ADS exposes three types of probes to check the health of a container through the following probes:

ProbesDescriptionFailure Action
/health/livenessChecks if the application is healthy.Restarts the container to revive the application.
/health/readinessDetermines if the container is ready to start accepting traffic.Excludes the container from service endpoints if failing.
/health/startupVerifies if the application within a container has started.Stops the container if the check fails and follows the pod's restart policy.