Basic health check

GET

/health

const url = 'http://localhost:8080/health';
const options = {method: 'GET', headers: {'X-Signature': '<X-Signature>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url http://localhost:8080/health \
  --header 'X-Signature: <X-Signature>'

Basic health check endpoint for monitoring

Authorizations

EthereumSignature
LegacyECDSA

Responses

200

Service is healthy

application/json

object

success

boolean

status

Overall health status

string

Allowed values: healthy degraded unhealthy

uptime

Human-readable uptime

string

checks

object

dhtReachable

DHT is reachable

boolean

storageWritable

Storage is writable

boolean

peersConnected

Peers are connected

boolean

memoryOk

Memory usage is acceptable

boolean

Example

{
  "success": true,
  "status": "healthy",
  "uptime": "1d 2h 30m 45s",
  "checks": {
    "dhtReachable": true,
    "storageWritable": true,
    "peersConnected": true,
    "memoryOk": true
  }
}