API documentation — openstatus

Cited by

Facts read from this source

• API protocol Report an error

  “The openstatus API is a typed, JSON-over-HTTP layer powered by ConnectRPC. Every action the dashboard performs is reachable from the API — same workspace, same audit log, same single API key.”

• API key generation Report an error

  “Generate a key from Settings > General > API Keys.”

• API key shared surfaces Report an error

  “Use a single key across the API, CLI, Terraform, and MCP server.”

• API manageable resources Report an error

  “Manage monitors, status pages, status reports, maintenance windows, and notification channels.”

• Openapi explorer Report an error

  “Inspect the full schema in the OpenAPI explorer.”

• Node sdk Report an error

  “The openstatus Node SDK is a fully typed TypeScript and JavaScript client for the API — no hand-written fetch calls, no codegen step. Works in Node and Deno.”

• API auth header Report an error

  “Pass x-openstatus-key on every request.”

• API audit log Report an error

  “Every mutation lands in the audit log under actor_type = 'apiKey' with the key that made it, so you can trace any change back to a key and the user who created it.”

• Cli Report an error

  “Want a terminal interface or YAML config? See the CLI.”

• Terraform provider Report an error

  “Managing infrastructure in HCL? Use the Terraform provider.”

• Mcp server Report an error

  “Want Claude or ChatGPT to call your workspace? See the MCP server.”

• Openapi spec URL Report an error

  “Yes. The full schema is browsable at api.openstatus.dev/openapi and is the source of truth for the Node SDK and any generated clients.”

• Sdk docs URL Report an error

  “Full schema and methods in the API reference. SDK docs at jsr.io/@openstatus/sdk-node.”

• Sdk other languages Report an error

  “Reach out if you want us to port it to another language.”

• API method shape Report an error

  “Every method is a POST to /rpc/openstatus.v1.<Service>/<Method>.”

• API endpoint Report an error

  “curl https://api.openstatus.dev/rpc/openstatus.v1.MonitorService/ListMonitors”

Scores citing this record

• The Agency Developer API, monitoring as code & team administration
• The Customer Support Lead API, monitoring as code & team administration
• The E-Commerce Operations Manager API, monitoring as code & team administration
• The SaaS Platform Engineer API, monitoring as code & team administration
• The Information Security Officer API, monitoring as code & team administration
• The Skeptic API, monitoring as code & team administration