Skip to content

Check health

Request

Gets the health status of the xCurrent server.

Security
Bearer
curl -i -X GET \
  https://docs.ripple.com/_mock/products/payments-odl/api-docs/ripplenet/reference/openapi/health \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Successful response.

Bodyapplication/json
healthybooleanrequired

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

Example:true
servicesArray of objects

List of services and their statuses returned by the health check.

detailstring

Reason for health check failure, if any.

Example:"Failed to perform health check"
Response
{
  "healthy": true,
  "services": [
    { … }
  ],
  "detail": "Failed to perform health check"
}