Reference Overview
This section is the source of truth for openstatus configuration. Use it to look up exact field names, types, defaults, and behaviour — not to learn how to do something. For task-oriented walkthroughs, see the how-to guides; for learning paths, see the tutorials.
Monitors
How each monitor type runs checks and what you can configure on it.
- HTTP Monitor — URL, method, headers, body, assertions, regions.
- TCP Monitor — host:port checks for non-HTTP services.
- DNS Monitor — record-type assertions for A, AAAA, CNAME, MX, NS, TXT.
Status pages
Public surfaces for communicating service health.
- Status Page — page settings, custom domains, IP restrictions, themes, locales.
- Page Components — monitor-linked and static components, component groups, ordering.
- Status Report — incident updates and the state machine they drive.
- Maintenance — scheduled maintenance windows.
- Subscriber — email subscribers to a status page.
Alerting
- Notification Channels — Slack, Discord, Email, SMS, WhatsApp, Telegram, PagerDuty, OpsGenie, Google Chat, Grafana OnCall, Ntfy, and generic webhooks.
- Incident — auto-generated incident objects, trigger thresholds, and lifecycle states.
Probing infrastructure
- Location — every public region, its provider, and the IPv4/IPv6 addresses to allowlist.
- Private Location — fields for a customer-deployed probe and the API surface that manages it.
Tooling
- CLI — every command, subcommand, and flag in the
openstatusCLI. - Terraform Provider — resource and data source schemas for
openstatusHQ/openstatus. - MCP Server — tools and transport for the openstatus Model Context Protocol server.
HTTP API
The HTTP API has its own dedicated documentation, generated from the OpenAPI schema:
- API Reference (current) — the OpenAPI document, machine-readable, always up to date with the deployed server.
- API Reference V1 (deprecated) — the legacy V1 surface; kept available for existing integrations.