REST API authentication
Last updated Jun 15, 2026
On this page
The Beacon API uses bearer tokens scoped to a workspace.
Creating a token
Settings → API tokens → New token. Tokens are shown once at creation — store them in your secrets manager, not your repo.
Using a token
curl https://api.beaconsoftware.example/v1/monitors \
-H "Authorization: Bearer bcn_live_xxxxxxxx"
Scopes
| Scope | Allows |
|---|---|
read | List monitors, incidents, check results |
write | Create/update monitors and maintenance windows |
admin | Manage tokens, members, escalation policies |
Rate limit: 120 requests/minute per token, 429 with a Retry-After header past that. Tokens can be revoked instantly from the same settings page.