Skip to main content

HealthService

Health check operations.

Methods​

MethodDescription
Liveness(ctx)Check if API server process is alive
Ready(ctx)Check if server and dependencies are ready
Status(ctx)Detailed system status (components, NATS)

Usage​

// Simple liveness check (unauthenticated)
resp, err := client.Health.Liveness(ctx)

// Readiness check (unauthenticated)
resp, err := client.Health.Ready(ctx)

// Detailed status (requires auth)
resp, err := client.Health.Status(ctx)

Example​

See examples/sdk/client/health.go for a complete working example.

Permissions​

Liveness and Ready are unauthenticated. Status requires health:read permission.