HealthResource

Reference

HealthResource

Platform health checks

5 min Beginner

ReferenceAPI

HealthResource

Accessed via client.health, this resource provides basic health and readiness checks for the platform.

Both endpoints are unauthenticated — they work without credentials and are useful for connectivity verification and monitoring integrations.

1

Setup

Connect to the platform

# Cell 1 — Parameters
USERNAME = "_FILL_ME_IN_"  # Set your email before running

# Cell 2 — Connect
from graph_olap import GraphOLAPClient
client = GraphOLAPClient(username=USERNAME)

# Cell 3 — Provision
from notebook_setup import provision
personas, _ = provision(USERNAME)
analyst = personas["analyst"]
admin = personas["admin"]
ops = personas["ops"]
client = analyst

2

Health Check

Verify platform availability

check() -> HealthStatus

Basic health check. Returns simple health status without checking dependencies. No authentication required.

Returns: HealthStatus with the following fields:

Field	Type	Description
status	str	Health status (e.g., "ok")
version	str | None	API version string
database	str | None	Not set for basic health

health = client.health.check()

print(f"Status:  {health.status}")
print(f"Version: {health.version}")

ready() -> HealthStatus

Readiness check with database connectivity. Checks database connectivity in addition to basic health. No authentication required.

Returns: HealthStatus with all fields populated:

Field	Type	Description
status	str	Health status (e.g., "ok")
version	str | None	API version string
database	str | None	Database status (e.g., "ok")

ready = client.health.ready()

print(f"Status:   {ready.status}")
print(f"Version:  {ready.version}")
print(f"Database: {ready.database}")

Key Takeaways

• check() is a lightweight liveness probe -- use it to verify the API is reachable
• ready() also verifies database connectivity -- use it for deeper readiness checks
• Both endpoints are unauthenticated, making them safe for monitoring and load-balancer probes