Diagnostics

Check health

Gets the health status of the xCurrent server.

get/health

Request

Base URL
//[domainPrefix].ripplexcurrent.com/v4 (relative, and it does not resolve against the document’s source URL)
Auth
API key in header Authorization
TypeScript
https://skmtc.dev/ripple/apis/ripplenet-server-api/docs/health/get.ts
A function with typed inputs. Its response is checked against the schema.

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"
}

Changes

No recorded changes to this operation across all 1 revision of this API.

Check health

Request

Response 200OK

Example response

Changes

Response