Health check

GET

/api/health

Public lightweight liveness probe. Confirms API process is running only and does not check dependencies.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

API Key

Add parameter in header

X-API-Key

Example:

X-API-Key: ********************

🟢200

application/json

Service is healthy

Bodyapplication/json

🔴503

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://my.xentree.ai/api/health' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Success

{
    "status": "healthy",
    "timestamp": "2026-06-30T10:05:12.510486+00:00",
    "services": {
        "application": "running"
    }
}

Modified at 2026-08-18 02:15:24