Pular para o conteúdo

Check health

Requisição

Gets the health status of the xCurrent server.

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

Respostas

Successful response.

Corpoapplication/json
healthybooleanobrigatório

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

Exemplo:true
servicesArray of objects

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

detailstring

Reason for health check failure, if any.

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