v1

latestOpenAPI 3.0.02026-08-06102185472.3 KB

Diagnostics

Check heartbeat

Gets the health status of the xCurrent server's peers. This request requires authorization. The timeout for this operation is 5 seconds.

get/heartbeat

Response

Successful response.

time_checkedstring date required

Time at which the heartbeat was checked, as an ISO-8601 timestamp in UTC.

xcurrent_nodestring required

RippleNet address of the RippleNet server for which the heartbeat was checked. (Deprecated in favor of 'ripplenet_node' field, has exactly the same value).

ripplenet_nodestring

RippleNet address of the RippleNet server for which the heartbeat was checked.

peer_heartbeat_resultsobject required

Provides a list of peer RippleNet addresses and their health statuses.

errorsstring[] required

If applicable, provides one or more messages describing the error.

Example response

{
  "time_checked": "2019-10-01",
  "xcurrent_node": "rn.us.ny.new_york",
  "ripplenet_node": "rn.us.ny.new_york"
}