---
title: "Check heartbeat"
method: GET
path: "/heartbeat"
tags: ["Diagnostics"]
---

# Check heartbeat

`GET /heartbeat`

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

## Response `200`

Successful response.

- Heartbeat — Provides the health status of the xCurrent server’s peers.
  - `time_checked` string, date, required — Time at which the heartbeat was checked, as an ISO-8601 timestamp in UTC.
  - `xcurrent_node` string, 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_node` string — RippleNet address of the RippleNet server for which the heartbeat was checked.
  - `peer_heartbeat_results` object, required — Provides a list of peer RippleNet addresses and their health statuses.
  - `errors` string[], required — If applicable, provides one or more messages describing the error.

## Other responses

- `400` — Bad request.

---

[API](https://skmtc.net/ripple/apis/ripplenet-server-api.md) · [All operations](https://skmtc.net/ripple/apis/ripplenet-server-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ripple/ripplenet-server-api/revisions/7843f07ca150/schema)