For the complete documentation index, see llms.txt. This page is also available as Markdown.

Health

Health check endpoints for monitoring platform subsystem status, including whether feature-flag rollouts are live.

The Platform API exposes health endpoints for monitoring the status of platform subsystems. These endpoints require no authentication and are designed for external health monitors and alerting systems.

The health endpoints are served by the API but are not included in the published OpenAPI schema.

Liveness

GET /health

Basic liveness check. Returns 200 with {"status": "ok"} when the service process is responsive.

Feature-Flag Health

Reports whether feature-flag changes are live. Feature flags control staged rollouts: dark launches, per-workspace ramps, kill switches, and rollbacks. When flag evaluation is not live, changes to those flags silently have no effect - everything resolves to built-in defaults - so a monitoring team relying on a kill switch or a staged rollout needs to know that state.

GET /health/flags

No authentication required.

Response

Field
Type
Description

provider_registered

boolean

Whether flag evaluation is available in this environment

provider_ready

boolean

Whether flag evaluation initialized successfully

env_enabled

boolean

Whether the environment gate for flag evaluation is enabled

runtime_controllable

boolean

true only when all three conditions above hold - flag changes take effect at runtime

reason

string

Human-readable explanation of the current state

Example Response (Healthy)

Example Response (Inert)

Usage

Point health monitors at this endpoint if you rely on feature flags for dark launches, per-workspace ramps, or kill switches. When runtime_controllable is false, flag changes will not take effect - all flags resolve to their built-in defaults.

Last updated

Was this helpful?