stellar-sdk/com.soneso.stellar.sdk.rpc.responses/GetHealthResponse

GetHealthResponse

@Serializable

data class GetHealthResponse(val status: String, val latestLedger: Long? = null, val oldestLedger: Long? = null, val ledgerRetentionWindow: Long? = null)

Response for JSON-RPC method getHealth.

General node health check endpoint. The RPC server will return a 200 OK response if the node is healthy, with additional metadata about the ledger state.

Constructors

GetHealthResponse

constructor(status: String, latestLedger: Long? = null, oldestLedger: Long? = null, ledgerRetentionWindow: Long? = null)

Properties

latestLedger

val latestLedger: Long?

The latest ledger known to the node. May be null if the node hasn't synced any ledgers yet.

ledgerRetentionWindow

val ledgerRetentionWindow: Long?

The ledger retention window configured for the node. Represents how many ledgers the node keeps in storage. May be null if not configured.

oldestLedger

val oldestLedger: Long?

The oldest ledger stored by the node. May be null if the node hasn't synced any ledgers yet.

status

val status: String

Health status. Expected to be "healthy" when the node is operational.

GetHealthResponse

See also

Constructors

Properties