Skip to main content

Overview

This endpoint reports application liveness, uptime and cluster connectivity. Use an RPC request to check that upstreams answer.

Endpoint

Response

Returns a JSON object containing instance health information:
string
required
Application liveness status (“healthy” when this endpoint responds)
string
required
ISO 8601 timestamp of the health check
integer
required
Time in seconds since the Lasso RPC instance started
string
required
Current version of Lasso RPC
object
required
Cluster connectivity and status information

Response Example

Cluster Status Values

The cluster.status field indicates the overall health of your cluster deployment:
Clustering is not enabled. Instance is running independently.
The current snapshot reports at least as many responding nodes as expected.
Fewer nodes respond than expected, but at least ceil(nodes_total / 2) respond.
The responding count is below ceil(nodes_total / 2).
unavailable means no usable topology snapshot exists; stale means its age exceeds five seconds. snapshot_status and snapshot_age_ms expose that freshness. nodes_configured reports the configured expected count when set; nodes_total is at least the connected count. These diagnostics do not make a live request to every upstream. This is the behavior of the released health controller and topology status function.

Readiness

GET /api/ready with no parameters reports whether this replica can serve as well as its peers: configuration loaded, catalog published, and distribution running when clustering is configured. It returns HTTP 200 when it can and HTTP 503 with a reason when it can’t. It ignores upstream state, because an upstream outage affects every replica alike and would otherwise take the whole fleet out of service. Point your load balancer here. Add profile, and optionally chain, for the strict check on one route:
It returns HTTP 200 with status: "ready" when every selected chain has an eligible HTTP upstream and a fresh head observation, and HTTP 503 with status: "not_ready" otherwise. Omit chain to check every chain in the profile; omit profile to use public. Each item in checks includes chain_id, status, and a reason: no_eligible_upstream, stale_or_missing_head, or null when ready. An unknown profile or chain returns reason: "profile_or_chain_not_configured". Both checks read local state and make no upstream request, so they don’t prove a particular RPC method will succeed. Monitor an upstream-backed request separately.

Use Cases

Load Balancer Health Checks

Configure your load balancer to poll this endpoint:

Monitoring and Alerts

Integrate with monitoring systems to track uptime and cluster status:

Cluster Health Monitoring

Monitor cluster connectivity in distributed deployments:

Notes

  • This endpoint responds immediately and does not perform heavy computation
  • It does not make a live upstream RPC call; pair it with provider and routing monitoring
  • A healthy response confirms application availability, not that every upstream is usable
  • When clustering is disabled, cluster.enabled is false and cluster.status is standalone