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.0.0, at version 2.0.
Requests are made against 2 base URLs: https://api.sandbox.palisade.co, https://api.palisade.co.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Ripple Labs Diagnostics API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as Authorization (TokenAuth).
By default, every request must be authenticated.
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.
Use these operations to view RippleNet Server health. | Operation | Method | Description | | -- | -- | -- | | [Check health](/products/payments-odl/api-docs/ripplenet/reference/op…
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), HealthCheck (3 properties), Health (3 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Ripple Labs 12
Other APIs Ripple Labs publishes across the network.