Launch offer: 50% off.Paid plans only.See pricing
Skip to content

Documentation

Reference

Status API

Status summary endpoint and subscription channel integration.


Overview

Use status endpoints to surface platform health and incident communication in your own tools.

Endpoints

  • GET /api/status/summary
  • POST /api/status/subscribe

Summary response model

{
  "overallStatus": "operational",
  "summary": "All systems operational",
  "generatedAt": "2026-03-05T12:00:00Z",
  "environment": "production",
  "groups": []
}

Subscribe request

{
  "email": "ops@example.com",
  "channel": "email"
}

Integration patterns

  • Pull status on dashboards every 60-300 seconds.
  • Push updates to incident channels after severity transitions.
  • Keep timestamps in UTC for cross-region consistency.

Alerting guidance

  • Alert on transition from operational to degraded.
  • Suppress repeated alerts for unchanged incident phase.
  • Link alerts to runbooks and postmortems.

Related docs

  • Incident communication: /docs/reference/incident-comms
  • Trust center: /trust
  • Public status page: /status