API health

All processes in Nexta should be started by checking the health using the health endpoint (GET /api/v3.0/health).

Public Nexta microservices are available via REST API that is located behind a gateway. Requests made to any Nexta endpoint are first received on the gateway, and then the message is emitted to a queue that a specified service listens to.

The health endpoint checks whether each of Nexta services is responding.

If the health endpoint returns the "Unhealthy" response and a 500 status code, then it is not recommended to proceed with any processes before the health is back to normal.

This is because Nexta services are interdependent.

Response	Meaning	Description	Next actions
200	Healthy	All Nexta services are healthy.	Continue the process execution.
500	Unhealthy	1 or more services are unhealthy.	Do not continue. Wait until healthy.