Endpoint: https://api.validate.bankersalmanac.com/actuator/health

Overview 

It is a REST(full) API endpoint that checks the API itself and all critical dependencies.

It is an HTTP GET request.

API Health Check endpoint returns the check results as the response.

Software, QA and Dev ops teams use this endpoint to monitor the health of an API using a monitoring tool like TESTFULLY.

Also known as a heartbeat, this endpoint will indicate whether the application is currently running.

The response will simply indicate that the status is “UP” when it’s running. {“status”:”UP”}

Endpoint inputs

No request body.

Response modifications

No modification can be done to the response.

Response outcomes

Field Name	Description	Format
status	Status of the application. UP — The component or subsystem is working as expected. DOWN — The component is not working. OUT_OF_SERVICE — The component is out of service temporarily. UNKNOWN — The component state is unknown	Alpha