Reference
The reference section is the operator’s lookup material. Pages here are authoritative for the values, schemas, and contracts the platform enforces. Reach for them when you need the exact answer for an env var, an API field, or a UI surface, rather than a walkthrough.
Platform configuration
Section titled “Platform configuration” Configuration reference Every environment variable Checkstack reads at boot, grouped by purpose, with type, default, and effect.
UI tour Annotated walkthrough of every page in the UI - what each surface is for and the actions you can take from it.
Retention and limits Health check storage tiers, default retention windows, per-system overrides, and hardcoded platform ceilings.
Health and readiness probes The /.checkstack/health and /.checkstack/ready endpoints that orchestrators poll while the backend is booting.
Security and secrets
Section titled “Security and secrets” Secret encryption ENCRYPTION_MASTER_KEY generation, rotation, and the AES-256-GCM contract.
Authentication strategies SSO, SAML, LDAP, and group mapping setup.
API keys Generate, rotate, and revoke personal API keys for the public REST API.
API and integrations
Section titled “API and integrations” Public REST API The OpenAPI surface plus curl, JavaScript, and Python examples.
GitOps kinds Reference for every YAML kind a Checkstack GitOps provider can sync.
Script health checks The shell and inline TS/JS collectors that run on the satellite, with editor, ESM, and isolation details.