Skip to main content
All Monitoring API endpoints require authentication with a workspace API key, except for the health check endpoint (GET /health). The key must include the Read monitoring data (monitoring:read) scope.

Required role

Only workspace owners and admins can create and manage workspace API keys. Regular workspace members don’t have access to the Secrets page in workspace settings. To learn about workspace roles, see Managing your workspace members.

Workspace API key

Include your workspace API key in the api_key header with all requests:

Example request

Get your workspace API key

  1. Click your workspace name at the bottom left and click Settings.
  2. Click Secrets in the sidebar.
  3. Click + Create API Key.
  4. Enter a name for the key and an optional description, select the Read monitoring data permission, then click Create Key.
  5. Copy the key immediately and store it securely.
For the full guide, see Managing workspace secrets.
Your API key provides access to your workspace data. Treat it like a password and don’t share it or commit it to version control.