Health check endpoint

Detailed health check for the system

GET /api/server/health

Health check endpoint

cURL

curl --request GET \
  --url http://localhost:3000/api/server/health

200

{
  "status": "OK",
  "version": "<string>",
  "timestamp": "2023-11-07T05:31:56Z",
  "dependencies": {
    "agents": "healthy"
  }
}

Response

200

application/json

System is healthy

status · string

Example:

"OK"

version · string

timestamp · string<date-time>

dependencies · object

Show child attributes