// api reference
Beaam has no hand-maintained REST surface. Every feature is a capability, and every capability is reachable identically from the API, the CLI, and MCP. This page is generated from the same manifest those clients read.
Every operation goes through one dispatcher. The capability name is the path; the body is its input.
curl -X POST https://app.beaam.app/api/v1/list-stacks \
-H "Authorization: Bearer $BEAAM_API_KEY" \
-H "Content-Type: application/json" \
-d '{}'Create a key under Settings → API keys. Responses share one envelope, so a client written once works for every capability:
{ "ok": true, "data": { ... } }
{ "ok": false, "error": { "message": "..." } }The machine-readable source of this page is/api/v1/manifest — fetch it to generate a typed client rather than writing one by hand.
Badges. read-only makes no changes ·destructive changes or removes something you already have ·mcp is exposed to assistants through the MCP connector ·public needs no authentication.
Current health, incidents, and the public status page.
check-coverageCheck monitoring coverage — Given components found in a repository, report which are already watched by Beaam and which are not — with the exact call that would start watching each gap.
auth required read-only mcp
| Field | Type | Required | Description |
|---|---|---|---|
candidates | array | yes | Components found locally that may need monitoring. Each is { kind, name, url?, source? }. Detection happens on the caller's machine; this capability only judges coverage. |
stackId | string | no | Limit the comparison to one stack; defaults to every watched service. |
detection-statsDetection stats — True-positive / false-alarm counts, incident and suppression totals — how well Beaam is deciding what's worth your attention.
auth required read-only mcp
Takes no input.
explain-incidentExplain an incident — Explain why an incident happened in one sentence — the correlated services, learned lead/lag history, and any control-plane change (deploy, scaling, config) that preceded the failure. Uses AI narration only if your organization has enabled it; otherwise returns the same evidence deterministically.
auth required read-only mcp
| Field | Type | Required | Description |
|---|---|---|---|
incidentId | string | yes | The incident to explain. |
get-collector-healthGet collector health — Return collector health for the user's integrations — whether Beaam is successfully collecting, when it last succeeded, and the last error.
auth required read-only mcp
| Field | Type | Required | Description |
|---|---|---|---|
integrationIds | array | no | Limit to these integration ids; omit for all of the user's. |
get-health-gridGet the health heatmap — Return per-service health buckets across a window for every watched service of a connection — the heatmap view, ordered worst-first. Shows whether services failed together, which the exception view cannot.
auth required read-only mcp
| Field | Type | Required | Description |
|---|---|---|---|
integrationId | string | yes | The connection to chart. |
from | string | no | ISO start of the window. |
to | string | no | ISO end of the window. |
buckets | integer | no | Columns across the window (max 168). |
limit | integer | no | Max service rows, worst first (max 40). |
get-health-timelineGet an integration's health timeline — Summarize an integration's health over a time window (up to 7 days): worst-state timeline buckets, plus the events inside the window — state changes, alerts sent, and newly discovered services.
auth required read-only mcp
| Field | Type | Required | Description |
|---|---|---|---|
integrationId | string | yes | The connection to summarize. |
window | string | no | Relative window, e.g. the last 24h. Ignored when from/to are given. |
from | string | no | Window start (ISO 8601). Default: 6 hours ago. |
to | string | no | Window end (ISO 8601). Default: now. |
buckets | integer | no | Timeline resolution (default 72, max 200). |
get-ingest-statsGet ingest stats — Return OTLP ingest volume (requests, datapoints, bytes) per stack over a look-back window.
auth required read-only mcp
| Field | Type | Required | Description |
|---|---|---|---|
windowHours | number | no | Look-back window in hours (default 24, max 720). |
get-monitoring-healthGet monitoring health — Report whether Beaam's own collection is healthy — per integration, flagging any whose collector has errored or gone silent — plus the freshest check time.
auth required read-only mcp
Takes no input.
get-public-statusGet a published status page — Return the deliberately limited service health and recent incidents for an explicitly published public status token.
public read-only
| Field | Type | Required | Description |
|---|---|---|---|
token | string | yes | Revocable public status identifier. |
get-serviceGet a service — Return one service's full detail — display name, type, external id, current health state, source, and sensible defaults.
auth required read-only mcp
| Field | Type | Required | Description |
|---|---|---|---|
serviceId | string | yes | The service id to fetch. |
get-status-boardGet the status board — Return everything the status board shows in one call: watched services, connections, open incidents, recent alerts, and when Beaam last checked.
auth required read-only mcp
Takes no input.
list-detection-rulesList a service's alert rules — Return the alert rules Beaam uses to decide whether to alert for a service — the sensible defaults plus any overrides — with each rule's threshold, severity, and hysteresis.
auth required read-only mcp
| Field | Type | Required | Description |
|---|---|---|---|
serviceId | string | yes |
list-integration-rulesList provider-level alert rules — Return the default alert rules for a provider or service type (applied to all its services), with each rule's threshold, severity, and whether it's been customised.
auth required read-only mcp
| Field | Type | Required | Description |
|---|---|---|---|
provider | string | no | Return rules for every monitorable service type of this provider (e.g. aws). |
serviceType | string | no | Return rules for just this service type (e.g. mongodb.cluster). |
list-servicesList services — Return the services Beaam has discovered for the signed-in user, with each one's current health state and whether it's being watched. Pass watchedOnly to limit to watched services.
auth required read-only mcp
| Field | Type | Required | Description |
|---|---|---|---|
watchedOnly | boolean | no | Only return services Beaam is actively watching. |
stackId | string | no | Only return services in this stack. |
integrationIds | array | no | Only return services belonging to these integrations. |
query-metricsQuery metrics — Return recent OTel metrics for a stack from the telemetry store, optionally filtered to one metric.
auth required read-only mcp
| Field | Type | Required | Description |
|---|---|---|---|
stackId | string | no | Stack to query; defaults to your first stack. |
metricName | string | no | Filter to one metric. |
limit | integer | no | Max rows (default 100). |
set-detection-ruleSet a service's alert rule — Change a service's alert rule: set its threshold, its level (degraded/broken), enable/disable it, or reset it to the default. Pass serviceId and metric.
auth required destructive mcp
| Field | Type | Required | Description |
|---|---|---|---|
serviceId | string | yes | |
metric | string | yes | The rule's metric, e.g. sentry.errors_per_5m. |
threshold | number | no | New threshold (numeric rules only). |
enabled | boolean | no | Turn this rule on or off for the service. |
severity | string | no | Level raised when it fires: degraded (warm) or broken. |
reset | boolean | no | Remove the override and restore the default. |
set-integration-ruleSet a provider-level alert rule — Change the default alert rule for a service type (applies to all its services): set threshold, its level (degraded/broken), enable/disable, or reset. Individual services can still override.
auth required destructive mcp
| Field | Type | Required | Description |
|---|---|---|---|
serviceType | string | yes | The service type these defaults apply to, e.g. mongodb.cluster. |
metric | string | yes | The rule's metric, e.g. mongodb.disk_used_percent. |
threshold | number | no | New default threshold (numeric rules only). |
enabled | boolean | no | Turn this rule on or off for all services of the type. |
severity | string | no | Level raised when it fires: degraded (warm) or broken. |
reset | boolean | no | Remove the provider-level override (back to Beaam's default). |
set-public-statusConfigure public status publishing — Publish or unpublish a stack status page, choose its limited contents, or rotate its revocable public identifier.
auth required
| Field | Type | Required | Description |
|---|---|---|---|
stackId | string | yes | |
enabled | boolean | yes | |
showServiceNames | boolean | no | |
showIncidents | boolean | no | |
rotateToken | boolean | no | Issue a new public identifier and revoke the old URL. |
set-service-muteMute a service — Stop sending alerts for one service for a bounded time (max 24h), while it keeps being checked and incidents keep opening. Pass minutes: 0 to unmute.
auth required destructive mcp
| Field | Type | Required | Description |
|---|---|---|---|
serviceId | string | yes | The service to mute. |
minutes | integer | yes | How long to stay quiet, up to 1440 (24h). 0 unmutes. |
set-service-watchedWatch or unwatch one service — Start or stop watching a single service. Stopping ends collection for it — use set-service-mute instead to keep the record while silencing alerts.
auth required destructive mcp
| Field | Type | Required | Description |
|---|---|---|---|
serviceId | string | yes | The service to change. |
watched | boolean | yes | true to watch it, false to stop collecting entirely. |
Connect providers, choose what is watched, and tune thresholds.
apply-monitoring-planApply an approved monitoring plan — Execute a plan from plan-monitoring: watch every public URL immediately, then walk the user through credentialed providers one at a time. Give them `next.url`, poll check-oauth-connect with `next.state`, then call next-connection. Anything left is remembered, so stopping early is safe. Single-use.
auth required destructive mcp
| Field | Type | Required | Description |
|---|---|---|---|
planId | string | yes | The planId returned by plan-monitoring. Single-use and expires in 30 minutes. |
begin-aws-connectBegin an AWS connection — Start connecting an AWS account: returns a one-click CloudFormation URL and an external ID. Give the user the URL to open and create the stack, then poll check-aws-registration with the external ID; once registered, call connect-aws.
auth required mcp
Takes no input.
begin-oauth-connectStart connecting a provider with OAuth — Begin an OAuth connection and return a URL for the user to open. They approve in their browser; no API token is created or pasted. Give the user the URL, then poll check-oauth-connect with the returned `state` to find out when they are done — do not ask them to tell you.
auth required mcp
| Field | Type | Required | Description |
|---|---|---|---|
provider | string | yes | Integration id, e.g. "cloudflare". |
returnTo | string | no | Path to return the user to afterwards; defaults to the integration screen. |
check-aws-registrationCheck AWS auto-registration — Check whether the CloudFormation stack from begin-aws-connect has reported its AWS account ID yet. Poll every few seconds after the user creates the stack; when status is 'registered', call connect-aws with the returned accountId.
auth required read-only mcp
| Field | Type | Required | Description |
|---|---|---|---|
externalId | string | yes |
check-oauth-connectCheck an OAuth connection in progress — Check whether the user has finished approving the URL from begin-oauth-connect. Poll every few seconds using the `state` it returned. `pending` means keep waiting; `connected` is done; `failed` carries the reason; `expired` carries a fresh `url` to offer instead of starting over.
auth required read-only mcp
| Field | Type | Required | Description |
|---|---|---|---|
state | string | yes | The `state` returned by begin-oauth-connect. |
connect-awsConnect an AWS account — Finish connecting AWS with the 12-digit account ID and the external ID from begin-aws-connect. Returns connected, pending (stack still creating — retry in ~30s), or error. Discovered AWS services are watched automatically.
auth required mcp
| Field | Type | Required | Description |
|---|---|---|---|
accountId | string | yes | Your 12-digit AWS account ID. |
externalId | string | yes | The external ID from begin-aws-connect. |
stackId | string | no | Stack to attach this AWS connection to; defaults to your default stack. |
connect-cloudflareConnect Cloudflare — Connect Cloudflare with a read-only API token. Imports Workers, Pages projects, zones, R2 buckets, KV namespaces, D1 databases, Queues and Durable Object namespaces across every account the token reaches; pass watch:'all' to start watching them immediately, or follow up with set-watchlist.
auth required mcp
| Field | Type | Required | Description |
|---|---|---|---|
apiToken | string | no | Cloudflare API token with read access. Create one at https://dash.cloudflare.com/profile/api-tokens. Beaam imports every Workers script, Pages project, zone, R2 bucket, KV namespace, D1 database, Queue and Durable Object namespace the token can see, across every account it reaches. Stored encrypted; only read endpoints are called. |
oauthCode | string | no | Authorization code from Cloudflare's OAuth callback. Supplied by Beaam's callback route; leave unset when connecting with an API token. |
oauthState | string | no | The matching single-use state value from Beaam's OAuth callback. |
stackId | string | no | Stack to attach this Cloudflare connection to; defaults to your default stack. |
watch | string | no | Start watching every imported resource immediately ('all') or none ('none', default). With 'none', follow up with set-watchlist to pick resources. |
connect-digitaloceanConnect DigitalOcean — Watch a DigitalOcean account's Droplets — powered off, archived, or destroyed.
auth required mcp
| Field | Type | Required | Description |
|---|---|---|---|
accessToken | string | no | DigitalOcean personal access token. Beaam imports every Droplet the token can see and tracks each one's lifecycle state. Read scope is enough. Stored encrypted. Omit when connecting over OAuth. |
oauthCode | string | no | Authorization code from the DigitalOcean OAuth callback. Use begin-oauth-connect instead of calling this directly. |
oauthState | string | no | The single-use state that began the authorization. |
stackId | string | no | Stack to attach these Droplets to; defaults to your default stack. |
connect-hostingerConnect Hostinger — Watch a Hostinger account's VPS — suspended by Hostinger, stopped, or destroyed.
auth required mcp
| Field | Type | Required | Description |
|---|---|---|---|
apiToken | string | yes | Hostinger API token from hPanel. Beaam imports every VPS the token can see and tracks each one's state — alerting immediately if Hostinger suspends it. Read access is enough. Stored encrypted. |
stackId | string | no | Stack to attach these VPS to; defaults to your default stack. |
connect-httpConnect HTTP endpoint — Add a URL to monitor. Beaam will ping it every minute and alert if it goes down.
auth required mcp
| Field | Type | Required | Description |
|---|---|---|---|
url | string | yes | URL to monitor, e.g. https://example.com |
stackId | string | no | Stack to attach this endpoint to; defaults to your default stack. |
connect-mcpConnect MCP server — Add a remote MCP server to monitor. Beaam validates the initialize + tools/list handshake every minute and alerts if it breaks.
auth required mcp
| Field | Type | Required | Description |
|---|---|---|---|
url | string | yes | |
transport | string | yes | |
authType | string | yes | |
authToken | string | no | |
authUsername | string | no | |
authPassword | string | no | |
authHeaderName | string | no | |
authHeaderValue | string | no | |
stackId | string | no |
connect-mongodbConnect MongoDB Atlas — Connect MongoDB Atlas using a read-only service account (Client ID + Secret). Discovers your clusters; pass watch:'all' to start watching them immediately, or follow up with set-watchlist.
auth required mcp
| Field | Type | Required | Description |
|---|---|---|---|
clientId | string | yes | MongoDB Atlas service account Client ID (Organization → Access Manager → Applications). |
clientSecret | string | yes | MongoDB Atlas service account Client Secret. Shown once at creation; stored encrypted. |
stackId | string | no | Stack to attach this MongoDB Atlas connection to; defaults to your default stack. |
watch | string | no | Start watching every discovered cluster immediately ('all') or none ('none', default). With 'none', follow up with set-watchlist to pick clusters. |
connect-neonConnect Neon — Watch a Neon account's projects — disabled computes and failed control-plane operations.
auth required mcp
| Field | Type | Required | Description |
|---|---|---|---|
apiKey | string | yes | Neon API key. Beaam imports every project the key can see and watches each one's computes and control-plane operations. Read access is enough. Stored encrypted. |
stackId | string | no | Stack to attach these projects to; defaults to your default stack. |
connect-netlifyConnect Netlify — Watch a Netlify account's sites — deploys that failed, so a change you thought shipped is not silently missing.
auth required mcp
| Field | Type | Required | Description |
|---|---|---|---|
accessToken | string | yes | Netlify personal access token. Beaam imports every site the token can see and watches each site's recent deploys for failures. Read access is enough. Stored encrypted. |
stackId | string | no | Stack to attach these sites to; defaults to your default stack. |
connect-polarConnect Polar — Watch a Polar organization's subscription payment health — how many subscriptions have stopped paying.
auth required mcp
| Field | Type | Required | Description |
|---|---|---|---|
accessToken | string | yes | Polar Organization Access Token (polar_oat_…), created in your organization's settings with read access to organizations, subscriptions and events. Beaam watches the organization's subscription payment health. Stored encrypted; only read endpoints are called. |
stackId | string | no | Stack to attach this organization to; defaults to your default stack. |
connect-resendConnect Resend — Watch a Resend account's sending domains — bounce rate, complaint rate, and whether each domain can still send.
auth required mcp
| Field | Type | Required | Description |
|---|---|---|---|
apiKey | string | yes | Resend API key (re_…). Beaam reads each sending domain's deliverability — bounce rate, complaint rate — and whether the domain is still verified. Read access is enough; Beaam never sends mail. Stored encrypted. |
stackId | string | no | Stack to attach these domains to; defaults to your default stack. |
connect-sentryConnect Sentry — Connect Sentry using an auth token with project:read and org:read scopes. Discovers all projects and returns connected / error.
auth required mcp
| Field | Type | Required | Description |
|---|---|---|---|
authToken | string | no | Sentry auth token with project:read and org:read scopes. Omit when connecting over OAuth. |
oauthCode | string | no | Authorization code from the Sentry OAuth callback. Use begin-oauth-connect instead of calling this directly. |
oauthState | string | no | The single-use state that began the authorization. |
baseUrl | string | no | Sentry base URL for self-hosted instances (default: https://sentry.io). |
stackId | string | no | Stack to attach this Sentry connection to; defaults to your default stack. |
connect-stripeConnect Stripe — Connect Stripe using a restricted secret key with read access to Events and Account. Discovers the account and starts monitoring payment failures.
auth required mcp
| Field | Type | Required | Description |
|---|---|---|---|
secretKey | string | yes | Stripe restricted secret key (sk_live_... or sk_test_...) with read access to Events and Account. |
stackId | string | no | Stack to attach this Stripe connection to; defaults to your default stack. |
connect-supabaseConnect Supabase — Connect Supabase with a personal access token. Imports every project in your organization; pass watch:'all' to start watching them immediately, or follow up with set-watchlist.
auth required mcp
| Field | Type | Required | Description |
|---|---|---|---|
accessToken | string | no | Supabase personal access token (sbp_…). Create one at https://supabase.com/dashboard/account/tokens. Beaam imports every project in the org. Stored encrypted. Omit when connecting over OAuth. |
oauthCode | string | no | Authorization code from the Supabase OAuth callback. Use begin-oauth-connect instead of calling this directly. |
oauthState | string | no | The single-use state that began the authorization. |
stackId | string | no | Stack to attach this Supabase connection to; defaults to your default stack. |
watch | string | no | Start watching every imported project immediately ('all') or none ('none', default). With 'none', follow up with set-watchlist to pick projects. |
connect-vercelConnect Vercel — Watch a Vercel account's projects — production deploys that failed, without firing for preview builds.
auth required mcp
| Field | Type | Required | Description |
|---|---|---|---|
accessToken | string | yes | Vercel access token. Beaam imports every project the token reaches — personal and every team — and watches production deploys for failures. Read access is enough. Stored encrypted. |
stackId | string | no | Stack to attach these projects to; defaults to your default stack. |
create-stackCreate a stack — Create a stack — a group of services you think of together. Pass withIngestKey to also mint a one-time OTLP ingest key; otherwise the stack is grouping only and a key can be minted later.
auth required mcp
| Field | Type | Required | Description |
|---|---|---|---|
name | string | yes | Display name, e.g. 'Acme Production'. |
environment | string | no | e.g. production / staging. |
withIngestKey | boolean | no | Also mint an OTLP ingest key, returned once. Off by default — a stack is a grouping first, and telemetry ingest is opt-in. |
delete-integrationDelete an integration — Remove an integration and everything associated with it — its services, history, incidents, alerts, and stored credentials. Irreversible.
auth required destructive mcp
| Field | Type | Required | Description |
|---|---|---|---|
integrationId | string | yes | Integration id to remove. |
delete-stackDelete a stack — Delete an empty stack. Refuses while it still holds services or connections — move those first — and refuses to delete your only stack.
auth required destructive mcp
| Field | Type | Required | Description |
|---|---|---|---|
stackId | string | yes | The stack to delete. |
get-integration-catalogList everything Beaam can monitor — The public catalog of Beaam integrations — what each one watches, which signals can raise an incident, and what else is collected for context. Includes integrations on the roadmap (planned) and any temporarily withdrawn.
public read-only mcp
Takes no input.
list-connectionsList connections — Return the user's connected integration instances (accounts) with each one's status, collection mode, and check interval. Filter by provider or stack.
auth required read-only mcp
| Field | Type | Required | Description |
|---|---|---|---|
provider | string | no | Only return connections for this provider (e.g. 'aws'). |
stackId | string | no | Only return connections in this stack. |
activeOnly | boolean | no | Only return active connections (default false). |
list-integrationsList integrations — Return the catalog of integrations to choose from — available ones (connectable now, like AWS) and planned ones — with whether the signed-in user has each connected.
auth required read-only mcp
| Field | Type | Required | Description |
|---|---|---|---|
stackId | string | no | Count connections within this stack only. |
list-planned-connectionsList planned connections not yet made — List the providers an approved monitoring plan proposed that are still not connected. Read-only; use next-connection to actually walk through them.
auth required read-only mcp
Takes no input.
list-stacksList stacks — Return the signed-in user's stacks — each one a logical app + environment that integrations attach to and telemetry is grouped under.
auth required read-only mcp
Takes no input.
next-connectionGet the next thing to connect — The next provider from an approved plan that is not connected yet, with a one-click URL. Call after apply-monitoring-plan, then again each time check-oauth-connect reports connected, until status is 'done'. Pass `dismiss` only if the user says they do not want that provider.
auth required destructive mcp
| Field | Type | Required | Description |
|---|---|---|---|
dismiss | string | no | Provider id to stop asking about, e.g. "sentry". Use only when the user says they do not want it. |
plan-monitoringPlan what Beaam would monitor in a project — Given evidence about a project (filenames, dependencies, env var names, public URLs), return what Beaam would connect and watch, what it cannot, and any questions that need answering first. Read-only — it plans, it never connects.
auth required mcp
| Field | Type | Required | Description |
|---|---|---|---|
evidence | object | yes | What the project reveals about itself. Gather with get-integration-catalog's `detect` rules. Send env var NAMES only — never values, and never read a credential file. |
rediscover-integrationRe-discover a connection now — Look for resources created since this connection was last checked, and add any new ones as unwatched services.
auth required destructive mcp
| Field | Type | Required | Description |
|---|---|---|---|
integrationId | string | yes | The connection to re-discover. |
remove-missing-servicesRemove services that no longer exist — Permanently remove services that the provider no longer has, along with their history. Only affects services already detected as missing by re-discovery.
auth required destructive mcp
| Field | Type | Required | Description |
|---|---|---|---|
integrationId | string | no | Only remove missing services from this integration. Omit to remove all of them. |
rename-stackRename a stack — Change a stack's display name. Its slug — the OTel service.namespace your exporters send to — is deliberately left alone.
auth required destructive mcp
| Field | Type | Required | Description |
|---|---|---|---|
stackId | string | yes | The stack to rename. |
name | string | yes | New display name. |
revoke-ingest-keyRevoke a stack's ingest key — Disable a stack's OTLP ingest key immediately; the stack stops accepting telemetry until you rotate to a new key.
auth required destructive
| Field | Type | Required | Description |
|---|---|---|---|
stackId | string | yes | The stack whose ingest key to revoke. |
rotate-ingest-keyRotate a stack's ingest key — Generate a new OTLP ingest key for a stack and invalidate the old one. Returns the new key once.
auth required destructive
| Field | Type | Required | Description |
|---|---|---|---|
stackId | string | yes | The stack whose ingest key to rotate. |
set-collector-modeSet collection mode — Switch an integration between pull (scheduled polling) and push (real-time metric stream). Switching to push rotates and returns a one-time stack ingest key.
auth required destructive mcp
| Field | Type | Required | Description |
|---|---|---|---|
integrationId | string | yes | Integration to reconfigure. |
mode | string | yes | pull = Beaam polls on a schedule; push = real-time metric stream into Beaam ingest. |
set-service-stackMove services to a stack — Move one or more services into a stack, so the list groups by the application they belong to rather than by the account they were discovered in. Services whose telemetry you push yourself get their stack from the ingest key and can't be moved here.
auth required destructive mcp
| Field | Type | Required | Description |
|---|---|---|---|
serviceIds | array | yes | The service ids to move. |
stackId | string | yes | The stack to move them into. |
set-watchlistSet the watchlist — Choose which discovered services Beaam watches for an integration. Pass the integration id and the service ids to watch; the rest are unwatched.
auth required destructive mcp
| Field | Type | Required | Description |
|---|---|---|---|
integrationId | string | yes | |
serviceIds | array | no | The service ids to watch; all others are unwatched. |
stackId | string | no | If set, assert the integration belongs to this stack. |
update-integration-settingsUpdate integration settings — Edit an integration's friendly name and/or its check interval (seconds). Invalid values are ignored.
auth required destructive mcp
| Field | Type | Required | Description |
|---|---|---|---|
integrationId | string | yes | Integration to update. |
displayName | string | no | Friendly name (trimmed, max 80 chars). |
pollIntervalSeconds | integer | no | Check cadence in seconds (15–3600). |
Past incidents, alerts sent, and detection statistics.
acknowledge-incidentAcknowledge an incident — Mark an incident as being handled ("I'm on it"), or clear that. Quiets Beaam about it while you work on it.
auth required destructive mcp
| Field | Type | Required | Description |
|---|---|---|---|
incidentId | string | yes | The incident to acknowledge. |
acknowledged | boolean | no | True to acknowledge ("I'm on it"); false to clear it. |
get-incidentGet an incident — Fetch a single incident by id, with its current state and acknowledgement/snooze status.
auth required read-only mcp
| Field | Type | Required | Description |
|---|---|---|---|
incidentId | string | yes | The incident to fetch. |
list-alertsList alerts — Return the alerts Beaam has sent, newest first, with each alert's review state (real incident, false alarm, or unreviewed).
auth required read-only mcp
| Field | Type | Required | Description |
|---|---|---|---|
unreviewedOnly | boolean | no | Only alerts not yet tagged real / false-alarm. |
limit | integer | no | Max rows, newest first (default 50, max 200). |
list-checksList checks — Return recent poll results (checks) for the user's services — newest first — optionally filtered to one or more services and a closed time window. Reports when the window predates the 30-day raw-retention limit, so an empty result is never mistaken for a quiet period.
auth required read-only mcp
| Field | Type | Required | Description |
|---|---|---|---|
serviceId | string | no | Limit to one service. |
serviceIds | array | no | Limit to these services. |
since | string | no | ISO timestamp; only return checks at or after this time. |
until | string | no | ISO timestamp; only return checks strictly before this time. With `since`, selects a closed window. |
limit | integer | no | Max rows, newest first (default 100, max 2000). |
list-incidentsList incidents — Return the signed-in user's incidents (the times Beaam decided something was genuinely wrong), newest first.
auth required read-only mcp
| Field | Type | Required | Description |
|---|---|---|---|
openOnly | boolean | no | Only currently-open incidents. |
limit | integer | no | Max rows (default 50). |
list-recent-changesList recent changes — Return recent control-plane changes across your connected providers — deploys, config edits, scaling and pauses — newest first.
auth required read-only mcp
| Field | Type | Required | Description |
|---|---|---|---|
limit | number | no | How many changes to return (1–50, default 10). |
integrationId | string | no | Only changes from this connection. Omit for the whole estate. |
list-suppressionsList suppressions — Return what Beaam noticed but chose not to alert on (and why), newest first.
auth required read-only mcp
| Field | Type | Required | Description |
|---|---|---|---|
limit | integer | no | Max rows (default 50). |
review-alertReview an alert — Mark a past alert as a real incident or a false alarm, so Beaam can track and tune its accuracy.
auth required destructive mcp
| Field | Type | Required | Description |
|---|---|---|---|
alertId | string | yes | |
wasReal | boolean | yes | True if it was a real incident. |
snooze-incidentSnooze an incident — Stay quiet about an incident for a while ("not now"). Pass minutes to snooze, or 0 to clear it.
auth required destructive mcp
| Field | Type | Required | Description |
|---|---|---|---|
incidentId | string | yes | The incident to snooze. |
minutes | integer | yes | How long to stay quiet, in minutes. 0 (or less) clears the snooze. Capped at one week. |
Profile, organizations, notification channels, API keys, and billing.
accept-invitationAccept an invitation — Accept an organization invitation using its token. Joins the org and makes it your active organization.
auth required
| Field | Type | Required | Description |
|---|---|---|---|
token | string | yes | The invitation token from the accept link. |
acknowledge-welcomeAcknowledge the welcome — Record that this account has seen its welcome message, so it is shown once and never again.
auth required mcp
Takes no input.
cancel-subscriptionCancel subscription — Cancel the caller's Solo subscription at the end of the current billing period (downgrade to Free). Access continues until period end.
auth required destructive
Takes no input.
create-api-keyCreate an API key — Create a personal API key for the public API and the hosted MCP server. The secret is shown once at creation.
auth required
| Field | Type | Required | Description |
|---|---|---|---|
name | string | yes | A label to recognise this key, e.g. 'Claude MCP'. |
expiresInDays | integer | no | Days until the key expires. Omit or 0 for a key that never expires. |
create-checkoutStart Solo checkout — Create a secure Polar checkout session for the signed-in Beaam account's $19/month Solo plan.
auth required
| Field | Type | Required | Description |
|---|---|---|---|
entryPoint | string | no | Optional label for where the upgrade was started (e.g. integrations_hub, sidebar_meter). |
create-organizationCreate an organization — Create a new organization (a separate workspace with its own integrations, members, and plan) and switch to it.
auth required
| Field | Type | Required | Description |
|---|---|---|---|
name | string | yes | A name for the new organization. |
delete-accountDelete account — Permanently delete your Beaam account and associated monitoring data after password reauthentication. Irreversible.
auth required destructive
| Field | Type | Required | Description |
|---|---|---|---|
password | string | yes | Current password, used for recent reauthentication. |
confirm | string | yes | Must equal "DELETE MY ACCOUNT". |
delete-all-dataDelete all integrations and data — Remove every integration and all monitoring data (services, history, incidents, alerts, credentials). Notification channels are kept. Pass confirm:"DELETE". Irreversible.
auth required destructive
| Field | Type | Required | Description |
|---|---|---|---|
confirm | string | yes | Must equal "DELETE" to proceed. Guards against accidental wipes. |
delete-notification-channelDelete notification channel — Delete one of the user's notification channels by id.
auth required destructive mcp
| Field | Type | Required | Description |
|---|---|---|---|
id | string | yes | Channel id to delete. |
delete-organizationDelete an organization — Permanently delete an organization and all of its data (integrations, services, history, members). Owner only.
auth required destructive
| Field | Type | Required | Description |
|---|---|---|---|
confirmName | string | yes | The organization's exact name, to confirm deletion. |
orgId | string | no | Organization to delete. Defaults to your active organization. |
get-activation-progressGet activation progress — Show whether this account has connected monitoring, received its first real signal, and verified its default alert path.
auth required read-only mcp
Takes no input.
get-billingGet billing & plan — Return the active organization's effective plan and usage, plus the caller's own account plan and available billing actions.
auth required read-only
Takes no input.
invite-memberInvite a member — Invite someone to your active organization by email and get a one-time link to share. Owners and admins only.
auth required
| Field | Type | Required | Description |
|---|---|---|---|
email | string | yes | Email address of the person to invite. |
role | string | no | Role to grant. Defaults to member. |
join-waitlistJoin the waitlist — Add an email address to the Beaam waitlist.
public
| Field | Type | Required | Description |
|---|---|---|---|
email | string | yes | Email to add to the waitlist. |
source | string | null | no | Where they signed up. |
list-api-keysList API keys — Return the caller's API keys — name, prefix, created and last-used times, and whether revoked. Never returns the secret.
auth required read-only
Takes no input.
list-devicesList mobile devices — Return the user's mobile devices registered for push alerts — platform, device name, and when each was last seen. Use unregister-device to remove one.
auth required read-only mcp
Takes no input.
list-membersList organization members — List the members of your active organization (with roles), plus pending invitations if you can manage members.
auth required read-only
Takes no input.
list-notification-channelsList notification channels — Return the user's configured notification channels (email/SMS/push/Slack/webhook), each with its destination, enabled state, and whether it's in the global default set. Pass serviceId to also get that service's routing.
auth required read-only mcp
| Field | Type | Required | Description |
|---|---|---|---|
serviceId | string | no | If set, also return this service's routing (global default vs custom channel set). |
list-organizationsList organizations — List the organizations you belong to, your role in each, and which one is currently active.
auth required read-only
Takes no input.
list-paymentsList payments — Return past payments for the signed-in account, newest first, with amount, status and a receipt link where one exists.
auth required read-only
Takes no input.
preview-invitationPreview an invitation — Look up an organization invitation by token to see the organization, invited email, and role.
public read-only
| Field | Type | Required | Description |
|---|---|---|---|
token | string | yes | The invitation token from the accept link. |
record-product-eventRecord a product journey event — Record a non-sensitive setup, integration-selection, or upgrade-intent event for the signed-in account.
auth required
| Field | Type | Required | Description |
|---|---|---|---|
event | string | yes | A user-intent funnel event. Outcome milestones are recorded by Beaam itself. |
properties | object | no | Optional non-sensitive context such as provider or entry_point. |
register-deviceRegister mobile device — Enroll a mobile device for push alerts using its Expo push token. Creates the push notification channel on first registration; re-registering the same token just refreshes it.
auth required mcp
| Field | Type | Required | Description |
|---|---|---|---|
expoPushToken | string | yes | The device's Expo push token, e.g. ExponentPushToken[xxxx]. |
platform | string | yes | |
deviceName | string | no | Human label for the device, e.g. "Nick's iPhone". |
remove-memberRemove a member — Remove a member from your active organization, revoking their access. Owners and admins only.
auth required destructive
| Field | Type | Required | Description |
|---|---|---|---|
userId | string | yes | The user id of the member to remove. |
rename-organizationRename an organization — Rename an organization (defaults to your active one). Owners and admins only.
auth required
| Field | Type | Required | Description |
|---|---|---|---|
name | string | yes | The new organization name. |
orgId | string | no | Organization to rename. Defaults to your active organization. |
resume-subscriptionResume subscription — Undo a scheduled cancellation so the caller's Solo subscription renews as normal instead of ending at the current period.
auth required
Takes no input.
revoke-api-keyRevoke an API key — Revoke a personal API key by id; it stops working immediately.
auth required destructive
| Field | Type | Required | Description |
|---|---|---|---|
id | string | yes | The API key id to revoke. |
revoke-invitationRevoke an invitation — Revoke a pending invitation to your active organization, invalidating its link. Owners and admins only.
auth required
| Field | Type | Required | Description |
|---|---|---|---|
inviteId | string | yes | The id of the pending invitation to revoke. |
save-notification-channelSave notification channel — Create or update a notification channel. type is email, sms, push, slack, or webhook; destination is an email address, E.164 phone, or https:// webhook URL. SMS channels require the Solo plan. Push channels can only be updated here — they're created by registering a device.
auth required destructive mcp
| Field | Type | Required | Description |
|---|---|---|---|
id | string | no | Existing channel id to update; omit to create. |
type | string | yes | |
label | string | yes | Human label, e.g. 'On-call SMS'. |
destination | string | yes | Email address, E.164 phone number, or https:// webhook URL (slack = a Slack incoming webhook; webhook = any endpoint that accepts a JSON POST). Ignored for push (delivery goes to registered devices). |
enabled | boolean | no | Whether this channel can fire. |
isDefault | boolean | no | Include in the global default routing set used by services with no override. |
send-test-alertSend a test alert — Send a harmless test alert through your real notification channels (email, SMS, push, Slack, or webhook) and report whether each delivery worked. Omit channelId to test all enabled default channels.
auth required mcp
| Field | Type | Required | Description |
|---|---|---|---|
channelId | string | no | Test a single channel by id. Omit to test every enabled default channel. |
set-ai-explanationsSet AI incident explanations — Turn AI incident explanations on or off for your organization. When on, Beaam may send a short incident evidence summary to an LLM to write a one-sentence explanation; when off, no incident data is ever sent to an LLM.
auth required
| Field | Type | Required | Description |
|---|---|---|---|
enabled | boolean | yes | Turn AI incident explanations on or off for the organization. |
orgId | string | no | Organization to change. Defaults to your active organization. |
set-service-notificationsSet service notifications — Choose how a service's alerts route: 'global' uses the default channels; 'custom' uses the given channelIds. Pass the service id and mode.
auth required destructive mcp
| Field | Type | Required | Description |
|---|---|---|---|
serviceId | string | yes | |
mode | string | yes | global = use the default channel set; custom = use channelIds. |
channelIds | array | no | Channel ids to route to when mode is custom. |
switch-organizationSwitch active organization — Make one of your organizations the active one for the current session. You must be a member of it.
auth required
| Field | Type | Required | Description |
|---|---|---|---|
orgId | string | yes | The organization to make active. |
unregister-deviceUnregister mobile device — Remove a mobile device from push alerting, by device id or by its Expo push token. Removing the last device also removes the push notification channel; registering again restores it.
auth required destructive mcp
| Field | Type | Required | Description |
|---|---|---|---|
deviceId | string | no | Device id from list-devices. |
expoPushToken | string | no | Alternatively, the device's own Expo push token. |
Because these come from one registry, the MCP connector exposes the same operations to an assistant, and anything added to Beaam appears on every surface at once rather than being ported to each.
Back to docs