Get health status

Method GET https://<client-api-host>/api/v3.1/health

Returns the runtime health state and the level of this service.

Authorization

Public — no authentication required

This operation takes no parameters and no request body.

200 application/json Schema V31Health

Service is healthy.

Request cURL JavaScript

GET /health

curl https://<client-api-host>/api/v3.1/health

GET /health

const response = await fetch("https://<client-api-host>/api/v3.1/health", {
  method: "GET",
});

Response

json 200

{
  "status": "ok",
  "service": "client-api-v3",
  "level": "v3.1"
}