Skip to main content

openstatus-api

Call the openstatus public API (ConnectRPC, JSON over HTTP) to manage monitors, status pages, status reports, and maintenance windows. Use when building integrations, automating monitoring as code, or driving openstatus from a script outside an MCP client.

Source facts

Repository
openstatusHQ/openstatus
Last source activity
June 6, 2026 at 20:11
Detected SKILL.md language
English
Stars
9,177
Forks
788

Install options

The review-first prompt is selected by default. You can switch to a direct command or download a local copy.

Review the source files

Read SKILL.md and any companion files shown by SkillsMP before deciding whether to install.

Showing SKILL.md

SKILL.md
Source instructions · Read-only preview
name
openstatus-api
description
Call the openstatus public API (ConnectRPC, JSON over HTTP) to manage monitors, status pages, status reports, and maintenance windows. Use when building integrations, automating monitoring as code, or driving openstatus from a script outside an MCP client.
# openstatus API The openstatus API is a typed, JSON-over-HTTP layer powered by ConnectRPC. The base URL is `https://api.openstatus.dev`. Every action the dashboard performs is reachable from the API — same workspace, same audit log, same single API key. ## Auth Send the API key as the `x-openstatus-key` header. Generate one in **Settings → API Tokens**. ``` x-openstatus-key: os_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx ``` ## Example: list monitors ```bash curl https://api.openstatus.dev/rpc/openstatus.v1.MonitorService/ListMonitors \ -X POST \ -H "Content-Type: application/json" \ -H "x-openstatus-key: $OPENSTATUS_API_KEY" \ -d '{}' ``` ConnectRPC accepts both JSON and protobuf. POST is required even for read operations. ## Schema - OpenAPI explorer (machine-readable description): <https://api.openstatus.dev/openapi> - Reference docs: <https://www.openstatus.dev/docs> ## SDKs - Node SDK: <https://jsr.io/@openstatus/sdk-node> - Terraform provider: see <https://www.openstatus.dev/tooling> ## When to use this vs MCP - API → programmatic integrations, CI/CD, scripts. - MCP server (`openstatus-mcp` skill) → chat-shaped AI clients that need to read and update status pages.
View on GitHub