status API — Beaam reference
26 of Beaam's 119 capabilities: Current health, incidents, and the public status page. Generated from the live capability manifest.
check-coverage#
Check 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 requiredread-onlymcp
| 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-stats#
Detection stats — True-positive / false-alarm counts, incident and suppression totals — how well Beaam is deciding what's worth your attention.
auth requiredread-onlymcp
Takes no input.
explain-incident#
Explain 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 requiredread-onlymcp
| Field | Type | Required | Description |
|---|---|---|---|
incidentId | string | yes | The incident to explain. |
get-collector-health#
Get collector health — Return collector health for the user's integrations — whether Beaam is successfully collecting, when it last succeeded, and the last error.
auth requiredread-onlymcp
| Field | Type | Required | Description |
|---|---|---|---|
integrationIds | array | no | Limit to these integration ids; omit for all of the user's. |
get-dashboard-revision#
Get a dashboard revision — Return a compact change cursor for one or more live dashboard scopes, without returning or modifying monitored data.
auth requiredread-only
| Field | Type | Required | Description |
|---|---|---|---|
revisionKeys | array | yes |
get-health-grid#
Get 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 requiredread-onlymcp
| 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-timeline#
Get 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 requiredread-onlymcp
| 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-stats#
Get ingest stats — Return OTLP ingest volume (requests, datapoints, bytes) per stack over a look-back window.
auth requiredread-onlymcp
| Field | Type | Required | Description |
|---|---|---|---|
windowHours | number | no | Look-back window in hours (default 24, max 720). |
get-monitoring-health#
Get 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 requiredread-onlymcp
Takes no input.
get-navigation-summary#
Get navigation summary — Return the active organization's broken and degraded watched-service counts for navigation attention state.
auth requiredread-only
Takes no input.
get-now-overview#
Get the Now overview — Return the active organization's complete Now dashboard: service and incident state, collection health, activation, stacks, recent changes, and unfinished planned connections.
auth requiredread-only
Takes no input.
get-public-status#
Get a published status page — Return the deliberately limited service health and recent incidents for an explicitly published public status token.
publicread-only
| Field | Type | Required | Description |
|---|---|---|---|
token | string | yes | Revocable public status identifier. |
get-service#
Get a service — Return one service's full detail — display name, type, external id, current health state, source, and sensible defaults.
auth requiredread-onlymcp
| Field | Type | Required | Description |
|---|---|---|---|
serviceId | string | yes | The service id to fetch. |
get-service-detail#
Get service detail payload — Return the active organization's bounded service workbench payload.
auth requiredread-only
| Field | Type | Required | Description |
|---|---|---|---|
serviceId | string | yes | |
includeStacks | boolean | yes |
get-status-board#
Get 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 requiredread-onlymcp
Takes no input.
list-assistant-connections#
List connected AI assistants — Return the AI clients connected to this Beaam account over MCP — each one's name, when it was authorized, when it last called a tool, and whether it has asked anything yet. No token or secret material is returned.
auth requiredread-onlymcp
Takes no input.
list-detection-rules#
List 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 requiredread-onlymcp
| Field | Type | Required | Description |
|---|---|---|---|
serviceId | string | yes |
list-integration-rules#
List 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 requiredread-onlymcp
| Field | Type | Required | Description |
|---|---|---|---|
provider | string | no | Return rules for every monitorable service type of this provider (e.g. cloudflare). |
serviceType | string | no | Return rules for just this service type (e.g. mongodb.cluster). |
list-services#
List 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 requiredread-onlymcp
| 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-metrics#
Query metrics — Return recent OTel metrics for a stack from the telemetry store, optionally filtered to one metric.
auth requiredread-onlymcp
| 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). |
rename-service#
Rename a service — Give a watched service a name of your own, or send an empty name to restore the provider's. The provider's name is remembered underneath, so re-discovery will not overwrite yours.
auth requireddestructivemcp
| Field | Type | Required | Description |
|---|---|---|---|
serviceId | string | yes | The service to rename. |
name | string | no | What to call it. Send an empty string to restore the provider's own name. |
set-detection-rule#
Set 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 requireddestructivemcp
| 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-rule#
Set 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 requireddestructivemcp
| 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-status#
Configure 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-mute#
Mute 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 requireddestructivemcp
| 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-watched#
Watch 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 requireddestructivemcp
| Field | Type | Required | Description |
|---|---|---|---|
serviceId | string | yes | The service to change. |
watched | boolean | yes | true to watch it, false to stop collecting entirely. |
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. Calling conventions and the response envelope are on the reference index.
Other categories: integrations (41), history (12), account (40).
Back to the API reference