getHealth

General node health check.

Params

(0)

Result

(getHealthResult)

status

string

"healthy"

latestLedger

number

Most recent known ledger sequence

oldestLedger

number

Oldest ledger sequence kept in history

ledgerRetentionWindow

number

Maximum retention window configured. A full window state can be determined via: ledgerRetentionWindow = latestLedger - oldestLedger + 1

Example

Example request to the getHealth method

Request

cURL

curl -X POST \
-H 'Content-Type: application/json' \
-d '{
  "jsonrpc": "2.0",
  "id": 8675309,
  "method": "getHealth"
}' \
https://soroban-testnet.stellar.org | jq

JavaScript

let requestBody = {
  "jsonrpc": "2.0",
  "id": 8675309,
  "method": "getHealth"
}
let res = await fetch('https://soroban-testnet.stellar.org', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify(requestBody),
})
let json = await res.json()
console.log(json)

Python

import json, requests
res = requests.post('https://soroban-testnet.stellar.org', json={
    "jsonrpc": "2.0",
    "id": 8675309,
    "method": "getHealth"
})
print(json.dumps(res.json(), indent=4))

JSON

{
  "jsonrpc": "2.0",
  "id": 8675309,
  "method": "getHealth"
}

Result

{
  "jsonrpc": "2.0",
  "id": 8675309,
  "result": {
    "status": "healthy",
    "latestLedger": 51583040,
    "oldestLedger": 51565760,
    "ledgerRetentionWindow": 17281
  }
}