Skip to main content

API Reference

StatiBeat ships a generated OpenAPI contract for the scoped /api/v1 API.

The customer-facing contract is available in two docs-site-friendly forms:

Which APIs are documented publicly​

The public API reference includes two supported audiences:

  • public: anonymous or magic-link flows used by status-page visitors, subscribers, feed/view managers, and management links
  • customer: authenticated customer-admin APIs used to manage pages, incidents, maintenance, API tokens, SSO, domains, and related configuration

Some endpoints are intentionally not part of the public contract even though they exist in the backend. We keep operational and security-sensitive routes out of the public docs surface on purpose.

Examples of intentionally non-public routes include:

  • Slack shared-install and route-sync operations
  • Slack reminder claim operations
  • notification-event and attempt inspection routes
  • repair or migration utilities used for operational recovery
  • internal managed-service routes

Contract artifacts​

There are two generated OpenAPI artifacts in the backend repo:

  • application/backend/docs/openapi_public.json
  • application/backend/docs/openapi.json

Use the public artifact for customer docs and integrations. Treat the full artifact as an engineering and internal-support reference.

Notes​

  • The OpenAPI contract is generated from the registered route tree, so path and method coverage stay aligned with the server implementation.
  • The docs site intentionally points at the public contract rather than the full internal/admin surface.