Skip to main content

Authentication

The Management API uses API keys for authentication. API keys are scoped to your organization and provide full access to manage all resources within it.

Creating an API Key​

  1. Log in to Beepr at https://beepr.io
  2. Navigate to API Keys in the main menu
  3. Click Create API Key
  4. Give your key a descriptive name (e.g., "Ansible deploy", "Terraform")
  5. Copy and securely store the key — you won't be able to see it again

Using Your API Key​

Include your API key in the Authorization header with a Bearer prefix:

curl -H "Authorization: Bearer bpr_your_api_key_here" \
  https://beepr.io/api/v1/alert_groups

Key Format​

API keys start with bpr_ followed by a random string. This prefix helps identify Beepr keys in your configuration and allows secret scanners to detect accidentally exposed keys.

Security Best Practices​

  • Store API keys in environment variables or a secrets manager
  • Use separate keys for different environments or automation tools
  • Rotate keys periodically by creating new ones and deleting old ones
  • Never commit API keys to version control

Revoking a Key​

To revoke an API key, navigate to API Keys in the web interface and click Delete next to the key you want to remove. This takes effect immediately.