latestOpenAPI 3.0.02026-08-06102185472.3 KB

7843f07ca150

Diagnostics

Check health

Gets the health status of the xCurrent server.

get/health

Response

Successful response.

healthyboolean required

If set to true, the xCurrent server is up and running. If set to false, the xCurrent server is down.

detailstring

Reason for health check failure, if any.

Example response

{
  "healthy": true,
  "services": [
    {
      "service": "database",
      "detail": "Message queue unreachable."
    }
  ],
  "detail": "Failed to perform health check"
}