Skip to content
OpenStatus openstatus

Reference Documentation

📖 Reference

Section titled “📖 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

Section titled “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

Section titled “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

Section titled “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

Section titled “Infrastructure & Tools”
CLI Reference Complete command-line interface documentation
Terraform Provider Infrastructure as code with Terraform
Private Location Self-hosted monitoring agent reference

API Documentation

Section titled “API Documentation”

For programmatic access to openstatus:

  • REST API - Full REST API reference with interactive examples
Section titled “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