Get Health
An endpoint used to verify the availability and operational status of the API service. It allows monitoring systems, load balancers, and clients to quickly determine whether the service is running and able to accept requests.
Health check
Request Samples
curl
-L -X GET 'https://test-api.billeroo.com/health' \
-H 'Authorization: {integratorToken}' \
-H 'Content-Type: application/json' \
200 Successful Response
403 Forbidden
401 Unauthorized Request
Response Samples
{
"timestamp": "2026-02-11 11:24:16.632 +0000",
"status": 200,
"message": "OK",
"path": "/health"
}
{
"timestamp": "2026-02-11 11:10:37.218 +0000",
"status": 403,
"error": "Forbidden",
"messages": "Access Denied",
"path": "/health"
},
{
"timestamp": "2026-02-11 11:10:37.218 +0000",
"status": 401,
"error": "Unauthorized",
"path": "/health"
}