🔌 Connect & Verify
Confirm the server is up, what profile it's running, and what build you're talking to — before anything else.
client.health()
# HealthResponse(status="ok", profile="free", node_id="node-7f3a...")
client.status()
# StatusResponse(profile="free", role="coordinator",
# query_quota=QueryQuota(cost_remaining=1000000, ...))
client.ready()
# ReadyReport(is_ready=True, checks={
# "storage": True, "wal": True, "ingest_queue": True, ...})
client.version()
# VersionInfo(version="2.0.0", commit="a1b2c3d", build_profile="release")
client.stats()
# Stats(records=11, states=11, snapshot_rows=11, log_leaves=4, tokens=0)
client.list_modules()
# {"modules": ["aml", "maritime", "sanctions", "sigma"]}| Method | What it returns | Use it for |
|---|---|---|
health() | liveness + profile + node id | load-balancer probe |
status() | profile, role, query quota | pre-flight a batch job |
ready() | 9-condition readiness report | Kubernetes readinessProbe |
version() | build-info | migration / capability checks |
stats() | engine-wide counts | health dashboards |
list_modules() | installed extension packs | feature negotiation |
Async mirrors exist for every method in this page (
ahealth(),astatus(),aready(),aversion(),astats()). Theaprefix is the only difference.
Next: Schema Management — register the Person, Transaction, and CaseDoc types the Shadow Ledger investigation needs.