Reference Documentation

📖 Reference

Reference documentation provides technical specifications and detailed information about openstatus components, APIs, and configuration options. This is where you look up exact parameter names, return types, and available options.

When to use reference docs

Reference documentation is ideal when you:

• Need to look up specific API endpoints or parameters
• Want to know all available configuration options
• Are looking for technical specifications
• Need to understand data structures and types

Monitor Types

Detailed specifications for each monitor type:

HTTP Monitor Complete reference for HTTP/HTTPS endpoint monitoring

TCP Monitor TCP port monitoring specifications

DNS Monitor DNS resolution monitoring reference

Components & Features

Status Page Status page configuration options

Status Report Status report specifications

Subscriber Status page subscriber reference

Incident Incident management reference

Notification Notification channel specifications

Infrastructure & Tools

CLI Reference Complete command-line interface documentation

Terraform Provider Infrastructure as code with Terraform

Private Location Self-hosted monitoring agent reference

Programmatic Access

Manage openstatus from your own scripts, infrastructure, or AI assistants:

REST API Full REST API reference with interactive examples

CLI Manage monitors and pages from the command line

MCP Server Connect Claude, Cursor, and other AI assistants via Model Context Protocol

Related sections

• Tutorials - Learn how to use these features step-by-step
• How-to guides - Practical examples of common use cases
• Explanations - Understand the concepts behind the reference material