API Keys

Create API keys in your workspace settings in the dashboard. Give each integration a recognizable name and only the scopes it needs.

Scopes

A read scope authorizes supported read operations. A write scope authorizes supported mutations and also includes read access. Choose read-only access for an integration that does not need to change anything. Keys act within the workspace that issued them, subject to the endpoint's authorization checks.

Send the credential

The API accepts x-openstatus-key or Authorization: Bearer with your API key. The x-openstatus-key header name is retained by Probed for compatibility with the API implementation. Send one credential mechanism per request.

Keep keys in your secret manager or runtime environment. Do not put them in browser code, URLs, logs, public repositories, or status-page messages. Revoke a key when an integration no longer needs access and replace it if exposed.

See the API reference for the current endpoint schemas.