Openstatus API
Apps & Automationopenstatus-apiOpenstatus API is an Agent Skill for apps & automation published in the openstatusHQ/openstatus repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.
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.
How to use this skill
Bring this guide into your coding agent with a prompt tailored to the tool you use.
- Open your project in Codex.
- Copy and paste the prompt below.
- Review files and risks before approving any action.
Inspect the Agent Skill at https://github.com/openstatusHQ/openstatus/blob/HEAD/apps/web/public/.well-known/agent-skills/openstatus-api/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/openstatus-api, but wait for my approval before writing files or running scripts.
Copying this prompt does not install or run the skill. Review third-party files before use.
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
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-mcpskill) → chat-shaped AI clients that need to read and update status pages.