`apply-monitoring-plan`#

Apply an approved monitoring plan — Apply a plan-monitoring result. Answer every returned question using only its stored option values; then Beaam watches selected URLs and guides credentialed connections one at a time. Give the user next.url, poll check-oauth-connect with next.state, then call next-connection. Single-use.

auth requireddestructivemcp

Field	Type	Required	Description
`planId`	`string`	yes	The planId returned by plan-monitoring. Single-use and expires in 30 minutes.
`answers`	`object`	no	Answers to any questions returned by plan-monitoring. Values must be copied exactly from each question's options.

`begin-aws-connect`#

Begin 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 requiredmcp

Takes no input.

`begin-oauth-connect`#

Start 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 requiredmcp

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.
`stackId`	`string`	no	Stack to attach the resulting integration to, from list-stacks.

`check-aws-registration`#

Check 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 requiredread-onlymcp

Field	Type	Required	Description
`externalId`	`string`	yes

`check-oauth-connect`#

Check 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 requiredread-onlymcp

Field	Type	Required	Description
`state`	`string`	yes	The `state` returned by begin-oauth-connect.

`connect-aws`#

Connect 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 requiredmcp

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-cloudflare`#

Connect 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 requiredmcp

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 the imported resources ('all') or none ('none', default). 'all' is all-or-nothing: if the estate does not fit your plan's watch limit, Beaam watches none and asks you to choose, rather than picking for you.

`connect-digitalocean`#

Connect DigitalOcean — Watch a DigitalOcean account's resource health, Droplet pressure and backups, deployments, scaling, databases, Kubernetes, load balancers, and certificates within a bounded API budget.

auth requiredmcp

Field	Type	Required	Description
`accessToken`	`string`	no	DigitalOcean personal access token. Beaam imports the account's Droplets, load balancers, apps, managed databases, Kubernetes clusters, autoscale pools, and certificates. 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 DigitalOcean resources to; defaults to your default stack.

`connect-hostinger`#

Connect Hostinger — Watch a Hostinger account's VPS — suspended by Hostinger, stopped, or destroyed.

auth requiredmcp

Field	Type	Required	Description
`oauthCode`	`string`	no	Authorization code from the Hostinger OAuth callback. Use begin-oauth-connect instead of calling this directly.
`oauthState`	`string`	no	The single-use state that began the authorization.
`apiToken`	`string`	no	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-http`#

Connect HTTP endpoint — Add a URL to monitor. Beaam will ping it every minute and alert if it goes down.

auth requiredmcp

Field	Type	Required	Description
`url`	`string`	yes	URL to monitor, e.g. https://example.com
`acceptableStatuses`	`string`	no	Healthy HTTP codes or ranges, e.g. 200-399,404. Defaults to 200-399.
`expectedBody`	`string`	no	Optional exact text that must appear in the response body.
`stackId`	`string`	no	Stack to attach this endpoint to; defaults to your default stack.

`connect-mcp`#

Connect MCP server — Add a remote MCP server to monitor. Beaam validates the initialize + tools/list handshake every minute and alerts if it breaks.

auth requiredmcp

Field	Type	Required
`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-mongodb`#

Connect 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 requiredmcp

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 the imported resources ('all') or none ('none', default). 'all' is all-or-nothing: if the estate does not fit your plan's watch limit, Beaam watches none and asks you to choose, rather than picking for you.

`connect-neon`#

Connect Neon — Watch a Neon account's projects — disabled computes and failed control-plane operations.

auth requiredmcp

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.
`watch`	`string`	no	Start watching the imported resources ('all') or none ('none', default). 'all' is all-or-nothing: if the estate does not fit your plan's watch limit, Beaam watches none and asks you to choose, rather than picking for you.

`connect-netlify`#

Connect Netlify — Watch a Netlify account's sites — deploys that failed, so a change you thought shipped is not silently missing.

auth requiredmcp

Field	Type	Required	Description
`accessToken`	`string`	no	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. Omit when connecting over OAuth.
`oauthCode`	`string`	no	Authorization code from the Netlify 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 sites to; defaults to your default stack.

`connect-polar`#

Connect Polar — Watch a Polar organization's subscription payment health — how many subscriptions have stopped paying.

auth requiredmcp

Field	Type	Required	Description
`accessToken`	`string`	no	Polar Organization Access Token (polar_oat_…), created in your organization's settings with the read scopes listed by the Polar integration. Beaam watches revenue operations and webhook delivery health. Stored encrypted; only read endpoints are called. Omit when connecting over OAuth.
`oauthCode`	`string`	no	Authorization code from the Polar 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 organization to; defaults to your default stack.

`connect-resend`#

Connect Resend — Watch a Resend account's send API failures, quota usage, domain DNS readiness, and delivery reputation.

auth requiredmcp

Field	Type	Required	Description
`oauthCode`	`string`	no	Authorization code from the Resend OAuth callback. Use begin-oauth-connect instead of calling this directly.
`oauthState`	`string`	no	The single-use state that began the authorization.
`apiKey`	`string`	no	Resend API key (re_…). Beaam reads account logs and each sending domain's deliverability and DNS readiness. Resend requires a Full access key for these read endpoints; Beaam never sends mail. Stored encrypted.
`stackId`	`string`	no	Stack to attach these domains to; defaults to your default stack.

`connect-sentry`#

Connect Sentry — Connect Sentry using an auth token with project:read and org:read scopes. Discovers all projects and returns connected / error.

auth requiredmcp

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-stripe`#

Connect Stripe — Connect Stripe using a restricted key with read access to Account, Events, and Webhook Endpoints. Starts account, payment, billing, payout, fraud, and webhook monitoring immediately.

auth requiredmcp

Field	Type	Required	Description
`secretKey`	`string`	yes	Stripe restricted key (rk_live_... or rk_test_...) with read access to Account, Events, and Webhook Endpoints.
`stackId`	`string`	no	Stack to attach this Stripe connection to; defaults to your default stack.

`connect-supabase`#

Connect 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 requiredmcp

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 the imported resources ('all') or none ('none', default). 'all' is all-or-nothing: if the estate does not fit your plan's watch limit, Beaam watches none and asks you to choose, rather than picking for you.

`connect-vercel`#

Connect Vercel — Watch a Vercel account's projects — production deploys that failed, without firing for preview builds.

auth requiredmcp

Field	Type	Required	Description
`accessToken`	`string`	no	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.
`oauthCode`	`string`	no	Authorization code from the Vercel integration callback. Use begin-oauth-connect instead of calling this directly.
`oauthState`	`string`	no	The single-use state that began the Vercel authorization.
`stackId`	`string`	no	Stack to attach these projects to; defaults to your default stack.
`watch`	`string`	no	Start watching the imported resources ('all') or none ('none', default). 'all' is all-or-nothing: if the estate does not fit your plan's watch limit, Beaam watches none and asks you to choose, rather than picking for you.

`create-stack`#

Create 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 requiredmcp

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-integration`#

Delete an integration — Remove an integration and everything associated with it — its services, history, incidents, alerts, and stored credentials. Irreversible.

auth requireddestructivemcp

Field	Type	Required	Description
`integrationId`	`string`	yes	Integration id to remove.

`delete-stack`#

Delete 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 requireddestructivemcp

Field	Type	Required	Description
`stackId`	`string`	yes	The stack to delete.

`get-integration-catalog`#

List 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.

publicread-onlymcp

Takes no input.

`list-connections`#

List connections — Return the user's connected integration instances (accounts) with each one's status, collection mode, check interval, and whether it needs reconnecting. Filter by provider or stack.

auth requiredread-onlymcp

Field	Type	Required	Description
`provider`	`string`	no	Only return connections for this provider (e.g. 'cloudflare').
`stackId`	`string`	no	Only return connections in this stack.
`activeOnly`	`boolean`	no	Only return active connections (default false).

`list-integrations`#

List integrations — Return the catalog of integrations to choose from — available ones (connectable now, like Cloudflare), planned ones, and any temporarily withdrawn — with whether the signed-in user has each connected.

auth requiredread-onlymcp

Field	Type	Required	Description
`stackId`	`string`	no	Count connections within this stack only.

`list-planned-connections`#

List 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 requiredread-onlymcp

Takes no input.

`list-stacks`#

List stacks — Return the signed-in user's stacks — each one a logical app + environment that integrations attach to and telemetry is grouped under.

auth requiredread-onlymcp

Takes no input.

`next-connection`#

Get 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 requireddestructivemcp

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.
`stackId`	`string`	no	Target stack returned by apply-monitoring-plan.

`plan-monitoring`#

Plan what Beaam would monitor in a project — Build a monitoring plan from safe project evidence: repo paths, dependencies, env-var names, public URLs, API hosts, and authenticated CLI checks. Returns new connections, existing coverage, unsupported items, and questions to answer. Records a short-lived plan but connects nothing.

auth requiredmcp

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-integration`#

Re-discover a connection now — Look for resources created since this connection was last checked, and add any new ones as unwatched services.

auth requireddestructivemcp

Field	Type	Required	Description
`integrationId`	`string`	yes	The connection to re-discover.

`remove-missing-services`#

Remove 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 requireddestructivemcp

Field	Type	Required	Description
`integrationId`	`string`	no	Only remove missing services from this integration. Omit to remove all of them.

`rename-stack`#

Rename a stack — Change a stack's display name. Its slug — the OTel service.namespace your exporters send to — is deliberately left alone.

auth requireddestructivemcp

Field	Type	Required	Description
`stackId`	`string`	yes	The stack to rename.
`name`	`string`	yes	New display name.

`resolve-oauth-connect`#

Resolve an OAuth connect link — Turn a connect state into the provider's consent URL, after checking the link belongs to you and has not expired or been used.

auth requiredread-onlymcp

Field	Type	Required	Description
`state`	`string`	yes	The connect state from begin-oauth-connect. Single-use and short-lived.

`revoke-ingest-key`#

Revoke 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 requireddestructive

Field	Type	Required	Description
`stackId`	`string`	yes	The stack whose ingest key to revoke.

`rotate-ingest-key`#

Rotate 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 requireddestructive

Field	Type	Required	Description
`stackId`	`string`	yes	The stack whose ingest key to rotate.

`set-collector-mode`#

Set 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 requireddestructivemcp

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-stack`#

Move 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 requireddestructivemcp

Field	Type	Required	Description
`serviceIds`	`array`	yes	The service ids to move.
`stackId`	`string`	yes	The stack to move them into.

`set-watchlist`#

Set 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 requireddestructivemcp

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-settings`#

Update integration settings — Edit an integration's friendly name and/or its check interval (seconds). Invalid values are ignored.

auth requireddestructivemcp

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).

`vote-integration`#

Vote for an integration — Vote for an integration Beaam has not built yet, or withdraw a vote. Tells the roadmap what to build next.

auth requiredmcp

Field	Type	Required	Description
`provider`	`string`	yes	The planned integration to vote for, e.g. 'firebase' or 'railway'. Use list-integrations to see what is on the roadmap.
`vote`	`boolean`	no	True to vote (default); false to withdraw a vote you already cast.

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: status (26), history (12), account (40).

Back to the API reference

apply-monitoring-plan#

begin-aws-connect#

begin-oauth-connect#

check-aws-registration#

check-oauth-connect#

connect-aws#

connect-cloudflare#

connect-digitalocean#

connect-hostinger#

connect-http#

connect-mcp#

connect-mongodb#

connect-neon#

connect-netlify#

connect-polar#

connect-resend#

connect-sentry#

connect-stripe#

connect-supabase#

connect-vercel#

create-stack#

delete-integration#

delete-stack#

get-integration-catalog#

list-connections#

list-integrations#

list-planned-connections#

list-stacks#

next-connection#

plan-monitoring#

rediscover-integration#

remove-missing-services#

rename-stack#

resolve-oauth-connect#

revoke-ingest-key#

rotate-ingest-key#

set-collector-mode#

set-service-stack#

set-watchlist#

update-integration-settings#

vote-integration#

Related

status operations

history operations

API conventions

`apply-monitoring-plan`#

`begin-aws-connect`#

`begin-oauth-connect`#

`check-aws-registration`#

`check-oauth-connect`#

`connect-aws`#

`connect-cloudflare`#

`connect-digitalocean`#

`connect-hostinger`#

`connect-http`#

`connect-mcp`#

`connect-mongodb`#

`connect-neon`#

`connect-netlify`#

`connect-polar`#

`connect-resend`#

`connect-sentry`#

`connect-stripe`#

`connect-supabase`#

`connect-vercel`#

`create-stack`#

`delete-integration`#

`delete-stack`#

`get-integration-catalog`#

`list-connections`#

`list-integrations`#

`list-planned-connections`#

`list-stacks`#

`next-connection`#

`plan-monitoring`#

`rediscover-integration`#

`remove-missing-services`#

`rename-stack`#

`resolve-oauth-connect`#

`revoke-ingest-key`#

`rotate-ingest-key`#

`set-collector-mode`#

`set-service-stack`#

`set-watchlist`#

`update-integration-settings`#

`vote-integration`#