BSV blockchainBSV blockchain

Liveness probe — is the process alive?

GET/health/live

Response

Process is alive.

status"ok" | "degraded" | "error"
liveboolean
readyboolean
serviceobject
Show service properties
namestring
advertisableFQDNstring
portinteger
network"main" | "test"
startedAtstring<date-time>
uptimeMsinteger
topicManagerCountinteger
lookupServiceCountinteger
checksobject[]
Show checks properties
namestring
scope"live" | "ready"
criticalboolean
status"ok" | "degraded" | "error"
messagestring
detailsobject
durationMsinteger
contextobject

Process is not alive.

status"ok" | "degraded" | "error"
liveboolean
readyboolean
serviceobject
Show service properties
namestring
advertisableFQDNstring
portinteger
network"main" | "test"
startedAtstring<date-time>
uptimeMsinteger
topicManagerCountinteger
lookupServiceCountinteger
checksobject[]
Show checks properties
namestring
scope"live" | "ready"
criticalboolean
status"ok" | "degraded" | "error"
messagestring
detailsobject
durationMsinteger
contextobject
Request
curl -X GET "https://{fqdn}/health/live"
Response
{
  "status": "ok",
  "live": true,
  "ready": true,
  "service": {
    "name": "string",
    "advertisableFQDN": "string",
    "port": 0,
    "network": "main",
    "startedAt": "1970-01-01T00:00:00.000Z",
    "uptimeMs": 0,
    "topicManagerCount": 0,
    "lookupServiceCount": 0
  },
  "checks": [
    {
      "name": "string",
      "scope": "live",
      "critical": true,
      "status": "ok",
      "message": "string",
      "details": {},
      "durationMs": 0
    }
  ],
  "context": {}
}