A REST API
for your sites, incidents and reports.
The REST API at /api/v1 reads your sites, their status, incidents with their evidence, reports, status pages and alert channels, and a write key can also change sites and maintenance windows. A key acts as the member who made it.
- Read keys on every plan
- Write keys from Agency
curl https://app.beamfar.com/api/v1/sites \
-H "Authorization: Bearer bfk_..."The API documentation lists every request.
How it works
A key, a request, and your monitoring is in your own tools.
Make a key
An owner or admin makes one on API keys: a name, a scope (read or write) and an optional expiry. The full key is shown once.
Call the API
Send it as a bearer token to /api/v1. The documentation lists every request.
Build on it
Read keys on every plan; from Agency, write keys manage sites and maintenance windows.
What you get
Scoped keys
Read or write, with an optional expiry, acting as the member who made them.
Shown once, kept as a hash
A lost key cannot be recovered: revoke it and make another.
Never billing or members
No key can reach billing, members, invitations, exports, branding, status page changes or the organisation settings.
Also for AI assistants
The same keys open twelve read-only tools over MCP for your AI assistant.
Which plans include it
Every plan reads; Agency and Agency Plus also write.
- FreeIncludedRead only
- SoloIncludedRead only
- TeamIncludedRead only
- AgencyIncludedRead and write
- Agency PlusIncludedRead and write
Questions about the API
What can a write key change?
Sites and maintenance windows, and it can acknowledge incidents. Write keys come with Agency and Agency Plus.
Where is the documentation?
In the API documentation, with every request and its answer.
Read your monitoring from your own code.
Add your sites: checking starts as soon as you do.
No card for the Free plan.