GET /health
The health check endpoint provides a simple way to verify that the API server is running and responding to requests.This endpoint is typically used by monitoring systems, load balancers, and orchestration platforms to ensure service availability.
Request
Response
Status message indicating the health of the server. Returns
"success" when the server is operational.Response Example
What This Endpoint Checks
The health check endpoint verifies:- Server Status: Confirms the API server is running and able to process HTTP requests
- Response Capability: Validates that the server can return properly formatted JSON responses
The health check uses the hapi-pulse plugin with a 10-second timeout to ensure timely responses for monitoring systems.
Status Codes
| Status Code | Description |
|---|---|
| 200 | Server is healthy and operational |
| 503 | Server is unavailable or not responding |