API Reference

The production API is hosted at https://api.probed.dev. Use the interactive reference or OpenAPI JSON to find the exact request and response for each operation.

Call the current API

The current API uses Connect RPC. JSON requests use HTTP POST, Content-Type: application/json, and this endpoint shape:

https://api.probed.dev/rpc/<fully-qualified-service>/<Method>

Service names retain the openstatus namespace: this is part of the wire contract, not a different API host. Operations cover monitors, status pages, reports, maintenance, notifications, and private locations. Use the reference to check which fields each operation accepts; dashboard fields are not automatically available in every API operation.

List your monitors

Create a read-only API key in the workspace you want to inspect. Make it available as PROBED_API_KEY through your local secret mechanism, then run:

curl --fail-with-body --silent --show-error \
  'https://api.probed.dev/rpc/openstatus.monitor.v1.MonitorService/ListMonitors' \
  --header "x-openstatus-key: ${PROBED_API_KEY:?Set PROBED_API_KEY first}" \
  --header 'Content-Type: application/json' \
  --data '{"limit":10,"offset":0}'

This POST reads data; it does not create a monitor. The response groups monitors into httpMonitors, tcpMonitors, dnsMonitors, icmpMonitors, and grpcMonitors, with totalSize for pagination. Empty or default-valued fields may be omitted from JSON. Increase offset to read the next page; limit accepts 1–100.

The credential selects the workspace. Do not add an invented workspace ID to the request or reuse another workspace's resource IDs. Keep the key and returned private configuration out of public logs and browser code.

Authentication and errors

Send your API key in x-openstatus-key or Authorization: Bearer, using one mechanism per request. Read-only keys support reads; write scope also includes read access. A key can stop working when it expires, is revoked, or its creator loses active workspace membership.

Connect errors have a JSON code and message. Check the HTTP status and body: unauthenticated means the credential was not accepted; permission_denied means access is insufficient; invalid_argument means the request needs correction. A missing resource may belong to another workspace rather than being globally absent. For HTTP 429, honor Retry-After instead of immediately repeating requests.

OAuth access tokens issued for the MCP resource are restricted to /mcp; use an API key for these RPC calls. For assistant-driven workflows, see Connect an MCP client.

Legacy REST API

The /v1 REST API is deprecated. Existing integrations can consult its OpenAPI document; new integrations should use the current API above. Upstream SDKs, CLIs, and Terraform providers are not a substitute for checking Probed's endpoint and contract.