How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Ripple Labs Diagnostics API

Use these operations to view RippleNet Server health.| Operation | Method | Description || -- | -- | -- || [Check health](/products/payments-odl/api-docs/ripplenet/reference/openapi/diagnostics/checkhealth) | GET | Gets the health status of the xCurrent server. || [Check heartbeat](/products/payments-odl/api-docs/ripplenet/reference/openapi/diagnostics/checkheartbeat) | GET | Gets the health status of the xCurrent server's peers. |

Ripple Labs Diagnostics API is one of 36 APIs that Ripple Labs publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Diagnostics. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 2 operations across 2 paths, and defines 4 schemas. It is described by OpenAPI 3.2.0, at version 4.0.0.

Requests are made against a single base URL, //[domainPrefix].ripplexcurrent.com/v4.

2 operations 2 paths 4 schemas 2 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
4.0.0
Base URL
https://api.ripple.com
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Ripple Labs Diagnostics API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (Bearer). By default, every request must be authenticated.

  • Bearer — All operations require a Bearer access token in the Authorization header of each request. Learn about [authentication](/products/payments-odl/api-docs/ripplene…

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 2 GET. Each is listed below with its method, path, parameters, and response codes.

Diagnostics 2

Use these operations to view RippleNet Server health. | Operation | Method | Description | | -- | -- | -- | | [Check health](/products/payments-odl/api-docs/ripplenet/reference/op…

GET
/health
Check health
checkHealth → 200400
GET
/heartbeat
Check heartbeat
checkHeartbeat → 200400

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are RippleNetProblem (6 properties), Heartbeat (5 properties), Health (3 properties), HealthCheck (3 properties). Each schema is shown below with its type and property counts.

HealthCheck
object
Health check information for a single component.
3 properties
RippleNetProblem
object
Represents a request to create and update a payout method record.
6 properties
Health
object
Provides a high-level status of the health of the xCurrent server.
3 properties 1 required
Heartbeat
object
Provides the health status of the xCurrent server’s peers.
5 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ripple-labs-diagnostics-api-openapi.yml Raw ↑

Other APIs Ripple Labs publishes across the network.

Ripple Labs Addresses API
Ripple Labs API Credentials API
Ripple Labs Auditing API
Ripple Labs Authentication API
Ripple Labs Balances and statements API
Ripple Labs Balances API
Ripple Labs Beneficiary confirmation API
Ripple Labs Counterparties API
Ripple Labs Exchange transfers API
Ripple Labs Fees API
Ripple Labs Liquidations API
Ripple Labs Market Cap API
Where this information came from

This is an independent, third-party profile of Ripple Labs Diagnostics API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.