Something went wrong. Try again.
[READ-ONLY] Mirror of https://github.com/openstatusHQ/openstatus. 🫖 Status page with uptime monitoring & API monitoring as code 🫖 openstatus.dev
bun drizzle-orm monitoring monitoring-as-code nextjs observability on-call open-source shadcn-ui status-page statuspage synthetic-monitoring tinybird turso uptime uptime-checker uptime-monitor
Something went wrong. Try again.
2.1 kB · 49 lines
YAML
1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950openapi: 3.1.0info: description: OpenStatus is a open-source status page platform with global uptime monitoring. The OpenStatus API allows you to interact with the OpenStatus platform programmatically. To get started you need to create an account on https://www.openstatus.dev/ and create an api token in your settings. Requests are rate limited per API key or token (600 per minute, 100 per 10 seconds); exceeding a limit returns HTTP 429 with a Retry-After header. See https://www.openstatus.dev/docs/reference/api-rate-limits. title: OpenStatus API version: v2.0.0 contact: email: ping@openstatus.dev url: https://www.openstatus.devservers: - url: https://api.openstatus.dev description: ProductionexternalDocs: description: OpenStatus Documentation url: https://www.openstatus.dev/docscomponents: securitySchemes: ApiKeyAuth: type: apiKey in: header name: x-openstatus-keysecurity: - ApiKeyAuth: []tags: - name: MonitorService description: | Create, update, delete, and query monitors. Supports HTTP, TCP, and DNS monitor types with configurable check intervals, regions, assertions, and alerting thresholds. - name: StatusPageService description: | Manage public status pages with components, component groups, and email subscribers. Includes endpoints for retrieving full page content and aggregated status. - name: NotificationService description: | Configure notification channels (Slack, Discord, PagerDuty, email, webhooks, etc.) and associate them with monitors. Supports 12 notification providers. - name: StatusReportService description: | Create and manage incident reports with status updates. Reports follow a lifecycle: investigating -> identified -> monitoring -> resolved. - name: MaintenanceService description: | Schedule maintenance windows for status page components. Subscribers can be notified automatically when maintenance is created. - name: HealthService description: Health check endpoint for load balancer probes. No authentication required.