{ "info": { "name": "Beaam API", "description": "Every Beaam API capability published in the reference, generated from the same manifest. Set the apiKey collection variable after importing; public operations override collection authentication automatically.", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "version": { "major": 1, "minor": 0, "patch": 0 } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://app.beaam.app", "type": "string" }, { "key": "apiKey", "value": "", "type": "string" } ], "item": [ { "name": "Status", "description": "Current health, incidents, and the public status page.", "item": [ { "name": "check-coverage", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"candidates\": [\n {\n \"kind\": \"replace_with_kind\",\n \"name\": \"replace_with_name\",\n \"url\": \"https://example.com\",\n \"source\": \"replace_with_source\"\n }\n ],\n \"stackId\": \"00000000-0000-4000-8000-000000000000\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/check-coverage", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "check-coverage" ] }, "description": "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.\n\nCapability: `check-coverage`" }, "response": [] }, { "name": "detection-stats", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/detection-stats", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "detection-stats" ] }, "description": "True-positive / false-alarm counts, incident and suppression totals — how well Beaam is deciding what's worth your attention.\n\nCapability: `detection-stats`" }, "response": [] }, { "name": "explain-incident", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"incidentId\": \"00000000-0000-4000-8000-000000000000\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/explain-incident", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "explain-incident" ] }, "description": "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.\n\nCapability: `explain-incident`" }, "response": [] }, { "name": "get-collector-health", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"integrationIds\": [\n \"00000000-0000-4000-8000-000000000000\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/get-collector-health", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "get-collector-health" ] }, "description": "Return collector health for the user's integrations — whether Beaam is successfully collecting, when it last succeeded, and the last error.\n\nCapability: `get-collector-health`" }, "response": [] }, { "name": "get-dashboard-revision", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"revisionKeys\": [\n \"replace_with_key\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/get-dashboard-revision", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "get-dashboard-revision" ] }, "description": "Return a compact change cursor for one or more live dashboard scopes, without returning or modifying monitored data.\n\nCapability: `get-dashboard-revision`" }, "response": [] }, { "name": "get-health-grid", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"integrationId\": \"00000000-0000-4000-8000-000000000000\",\n \"from\": \"2026-01-01T00:00:00.000Z\",\n \"to\": \"2026-01-01T00:00:00.000Z\",\n \"buckets\": 25,\n \"limit\": 25\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/get-health-grid", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "get-health-grid" ] }, "description": "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.\n\nCapability: `get-health-grid`" }, "response": [] }, { "name": "get-health-timeline", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"integrationId\": \"00000000-0000-4000-8000-000000000000\",\n \"window\": \"1h\",\n \"from\": \"2026-01-01T00:00:00.000Z\",\n \"to\": \"2026-01-01T00:00:00.000Z\",\n \"buckets\": 25\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/get-health-timeline", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "get-health-timeline" ] }, "description": "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.\n\nCapability: `get-health-timeline`" }, "response": [] }, { "name": "get-ingest-stats", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"windowHours\": 1\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/get-ingest-stats", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "get-ingest-stats" ] }, "description": "Return OTLP ingest volume (requests, datapoints, bytes) per stack over a look-back window.\n\nCapability: `get-ingest-stats`" }, "response": [] }, { "name": "get-monitoring-health", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/get-monitoring-health", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "get-monitoring-health" ] }, "description": "Report whether Beaam's own collection is healthy — per integration, flagging any whose collector has errored or gone silent — plus the freshest check time.\n\nCapability: `get-monitoring-health`" }, "response": [] }, { "name": "get-navigation-summary", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/get-navigation-summary", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "get-navigation-summary" ] }, "description": "Return the active organization's broken and degraded watched-service counts for navigation attention state.\n\nCapability: `get-navigation-summary`" }, "response": [] }, { "name": "get-now-overview", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/get-now-overview", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "get-now-overview" ] }, "description": "Return the active organization's complete Now dashboard: service and incident state, collection health, activation, stacks, recent changes, and unfinished planned connections.\n\nCapability: `get-now-overview`" }, "response": [] }, { "name": "get-public-status", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"token\": \"replace_with_token\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/get-public-status", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "get-public-status" ] }, "description": "Return the deliberately limited service health and recent incidents for an explicitly published public status token.\n\nCapability: `get-public-status`", "auth": { "type": "noauth" } }, "response": [] }, { "name": "get-service", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"serviceId\": \"00000000-0000-4000-8000-000000000000\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/get-service", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "get-service" ] }, "description": "Return one service's full detail — display name, type, external id, current health state, source, and sensible defaults.\n\nCapability: `get-service`" }, "response": [] }, { "name": "get-service-detail", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"serviceId\": \"00000000-0000-4000-8000-000000000000\",\n \"includeStacks\": false\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/get-service-detail", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "get-service-detail" ] }, "description": "Return the active organization's bounded service workbench payload.\n\nCapability: `get-service-detail`" }, "response": [] }, { "name": "get-status-board", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/get-status-board", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "get-status-board" ] }, "description": "Return everything the status board shows in one call: watched services, connections, open incidents, recent alerts, and when Beaam last checked.\n\nCapability: `get-status-board`" }, "response": [] }, { "name": "list-assistant-connections", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/list-assistant-connections", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "list-assistant-connections" ] }, "description": "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.\n\nCapability: `list-assistant-connections`" }, "response": [] }, { "name": "list-detection-rules", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"serviceId\": \"00000000-0000-4000-8000-000000000000\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/list-detection-rules", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "list-detection-rules" ] }, "description": "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.\n\nCapability: `list-detection-rules`" }, "response": [] }, { "name": "list-integration-rules", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"provider\": \"cloudflare\",\n \"serviceType\": \"replace_with_service_type\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/list-integration-rules", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "list-integration-rules" ] }, "description": "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.\n\nCapability: `list-integration-rules`" }, "response": [] }, { "name": "list-service-edges", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"serviceId\": \"00000000-0000-4000-8000-000000000000\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/list-service-edges", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "list-service-edges" ] }, "description": "Show the correlation Beaam has learned for one service from your own history — which services it tends to go bad before, and which tend to go bad before it — with any verdict you have given.\n\nCapability: `list-service-edges`" }, "response": [] }, { "name": "list-services", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"watchedOnly\": false,\n \"stackId\": \"00000000-0000-4000-8000-000000000000\",\n \"integrationIds\": [\n \"00000000-0000-4000-8000-000000000000\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/list-services", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "list-services" ] }, "description": "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.\n\nCapability: `list-services`" }, "response": [] }, { "name": "query-metrics", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"stackId\": \"00000000-0000-4000-8000-000000000000\",\n \"metricName\": \"replace_with_metric_name\",\n \"limit\": 25\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/query-metrics", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "query-metrics" ] }, "description": "Return recent OTel metrics for a stack from the telemetry store, optionally filtered to one metric.\n\nCapability: `query-metrics`" }, "response": [] }, { "name": "rename-service", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"serviceId\": \"00000000-0000-4000-8000-000000000000\",\n \"name\": \"replace_with_name\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/rename-service", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "rename-service" ] }, "description": "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.\n\nCapability: `rename-service`\n\nThis operation changes or removes an existing resource. Review the example values before sending it." }, "response": [] }, { "name": "review-correlation-edge", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"fromService\": \"replace_with_from_service\",\n \"toService\": \"replace_with_to_service\",\n \"verdict\": \"confirmed\",\n \"note\": \"replace_with_note\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/review-correlation-edge", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "review-correlation-edge" ] }, "description": "Tell Beaam whether a correlation it learned from your history is a real dependency or a coincidence. A confirmed pair is trusted below the usual thresholds; a rejected one is never used again.\n\nCapability: `review-correlation-edge`" }, "response": [] }, { "name": "set-detection-rule", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"serviceId\": \"00000000-0000-4000-8000-000000000000\",\n \"metric\": \"replace_with_metric\",\n \"threshold\": 1,\n \"enabled\": false,\n \"severity\": \"degraded\",\n \"reset\": false\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/set-detection-rule", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "set-detection-rule" ] }, "description": "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.\n\nCapability: `set-detection-rule`\n\nThis operation changes or removes an existing resource. Review the example values before sending it." }, "response": [] }, { "name": "set-integration-rule", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"serviceType\": \"replace_with_service_type\",\n \"metric\": \"replace_with_metric\",\n \"threshold\": 1,\n \"enabled\": false,\n \"severity\": \"degraded\",\n \"reset\": false\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/set-integration-rule", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "set-integration-rule" ] }, "description": "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.\n\nCapability: `set-integration-rule`\n\nThis operation changes or removes an existing resource. Review the example values before sending it." }, "response": [] }, { "name": "set-public-status", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"stackId\": \"00000000-0000-4000-8000-000000000000\",\n \"enabled\": false,\n \"showServiceNames\": false,\n \"showIncidents\": false,\n \"rotateToken\": false\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/set-public-status", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "set-public-status" ] }, "description": "Publish or unpublish a stack status page, choose its limited contents, or rotate its revocable public identifier.\n\nCapability: `set-public-status`" }, "response": [] }, { "name": "set-service-mute", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"serviceId\": \"00000000-0000-4000-8000-000000000000\",\n \"minutes\": 25\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/set-service-mute", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "set-service-mute" ] }, "description": "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.\n\nCapability: `set-service-mute`\n\nThis operation changes or removes an existing resource. Review the example values before sending it." }, "response": [] }, { "name": "set-service-watched", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"serviceId\": \"00000000-0000-4000-8000-000000000000\",\n \"watched\": false\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/set-service-watched", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "set-service-watched" ] }, "description": "Start or stop watching a single service. Stopping ends collection for it — use set-service-mute instead to keep the record while silencing alerts.\n\nCapability: `set-service-watched`\n\nThis operation changes or removes an existing resource. Review the example values before sending it." }, "response": [] } ] }, { "name": "Integrations", "description": "Connect providers, choose what is watched, and tune thresholds.", "item": [ { "name": "apply-monitoring-plan", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"planId\": \"00000000-0000-4000-8000-000000000000\",\n \"answers\": {\n \"productionUrls\": [\n \"https://example.com\"\n ],\n \"confirmedProviders\": [\n \"replace_with_confirmed_provider\"\n ],\n \"confirmedUnreachableUrls\": [\n \"https://example.com\"\n ],\n \"accountSelections\": [\n {\n \"questionId\": \"provider-account:cloudflare\",\n \"value\": \"replace_with_value\"\n }\n ],\n \"stackId\": \"00000000-0000-4000-8000-000000000000\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/apply-monitoring-plan", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "apply-monitoring-plan" ] }, "description": "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.\n\nCapability: `apply-monitoring-plan`\n\nThis operation changes or removes an existing resource. Review the example values before sending it." }, "response": [] }, { "name": "begin-aws-connect", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/begin-aws-connect", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "begin-aws-connect" ] }, "description": "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.\n\nCapability: `begin-aws-connect`" }, "response": [] }, { "name": "begin-oauth-connect", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"provider\": \"cloudflare\",\n \"returnTo\": \"replace_with_return_to\",\n \"stackId\": \"00000000-0000-4000-8000-000000000000\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/begin-oauth-connect", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "begin-oauth-connect" ] }, "description": "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.\n\nCapability: `begin-oauth-connect`" }, "response": [] }, { "name": "check-aws-registration", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"externalId\": \"00000000-0000-4000-8000-000000000000\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/check-aws-registration", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "check-aws-registration" ] }, "description": "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.\n\nCapability: `check-aws-registration`" }, "response": [] }, { "name": "check-oauth-connect", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"state\": \"replace_with_state\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/check-oauth-connect", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "check-oauth-connect" ] }, "description": "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.\n\nCapability: `check-oauth-connect`" }, "response": [] }, { "name": "connect-aws", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"accountId\": \"00000000-0000-4000-8000-000000000000\",\n \"externalId\": \"00000000-0000-4000-8000-000000000000\",\n \"stackId\": \"00000000-0000-4000-8000-000000000000\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/connect-aws", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "connect-aws" ] }, "description": "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.\n\nCapability: `connect-aws`" }, "response": [] }, { "name": "connect-cloudflare", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"apiToken\": \"replace_with_token\",\n \"oauthCode\": \"replace_with_oauth_code\",\n \"oauthState\": \"replace_with_oauth_state\",\n \"stackId\": \"00000000-0000-4000-8000-000000000000\",\n \"watch\": \"all\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/connect-cloudflare", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "connect-cloudflare" ] }, "description": "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.\n\nCapability: `connect-cloudflare`" }, "response": [] }, { "name": "connect-digitalocean", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"accessToken\": \"replace_with_token\",\n \"oauthCode\": \"replace_with_oauth_code\",\n \"oauthState\": \"replace_with_oauth_state\",\n \"stackId\": \"00000000-0000-4000-8000-000000000000\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/connect-digitalocean", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "connect-digitalocean" ] }, "description": "Watch a DigitalOcean account's resource health, Droplet pressure and backups, deployments, scaling, databases, Kubernetes, load balancers, and certificates within a bounded API budget.\n\nCapability: `connect-digitalocean`" }, "response": [] }, { "name": "connect-hostinger", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"oauthCode\": \"replace_with_oauth_code\",\n \"oauthState\": \"replace_with_oauth_state\",\n \"apiToken\": \"replace_with_token\",\n \"stackId\": \"00000000-0000-4000-8000-000000000000\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/connect-hostinger", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "connect-hostinger" ] }, "description": "Watch a Hostinger account's VPS — suspended by Hostinger, stopped, or destroyed.\n\nCapability: `connect-hostinger`" }, "response": [] }, { "name": "connect-http", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"url\": \"https://example.com\",\n \"acceptableStatuses\": \"replace_with_acceptable_statuses\",\n \"expectedBody\": \"replace_with_expected_body\",\n \"stackId\": \"00000000-0000-4000-8000-000000000000\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/connect-http", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "connect-http" ] }, "description": "Add a URL to monitor. Beaam will ping it every minute and alert if it goes down.\n\nCapability: `connect-http`" }, "response": [] }, { "name": "connect-mcp", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"url\": \"https://example.com\",\n \"transport\": \"sse\",\n \"authType\": \"none\",\n \"authToken\": \"replace_with_token\",\n \"authUsername\": \"replace_with_auth_username\",\n \"authPassword\": \"replace_with_password\",\n \"authHeaderName\": \"replace_with_auth_header_name\",\n \"authHeaderValue\": \"replace_with_auth_header_value\",\n \"stackId\": \"00000000-0000-4000-8000-000000000000\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/connect-mcp", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "connect-mcp" ] }, "description": "Add a remote MCP server to monitor. Beaam validates the initialize + tools/list handshake every minute and alerts if it breaks.\n\nCapability: `connect-mcp`" }, "response": [] }, { "name": "connect-mongodb", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"clientId\": \"00000000-0000-4000-8000-000000000000\",\n \"clientSecret\": \"replace_with_secret\",\n \"stackId\": \"00000000-0000-4000-8000-000000000000\",\n \"watch\": \"all\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/connect-mongodb", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "connect-mongodb" ] }, "description": "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.\n\nCapability: `connect-mongodb`" }, "response": [] }, { "name": "connect-neon", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"apiKey\": \"replace_with_key\",\n \"stackId\": \"00000000-0000-4000-8000-000000000000\",\n \"watch\": \"all\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/connect-neon", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "connect-neon" ] }, "description": "Watch a Neon account's projects — disabled computes and failed control-plane operations.\n\nCapability: `connect-neon`" }, "response": [] }, { "name": "connect-netlify", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"accessToken\": \"replace_with_token\",\n \"oauthCode\": \"replace_with_oauth_code\",\n \"oauthState\": \"replace_with_oauth_state\",\n \"stackId\": \"00000000-0000-4000-8000-000000000000\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/connect-netlify", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "connect-netlify" ] }, "description": "Watch a Netlify account's sites — deploys that failed, so a change you thought shipped is not silently missing.\n\nCapability: `connect-netlify`" }, "response": [] }, { "name": "connect-polar", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"accessToken\": \"replace_with_token\",\n \"oauthCode\": \"replace_with_oauth_code\",\n \"oauthState\": \"replace_with_oauth_state\",\n \"stackId\": \"00000000-0000-4000-8000-000000000000\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/connect-polar", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "connect-polar" ] }, "description": "Watch a Polar organization's subscription payment health — how many subscriptions have stopped paying.\n\nCapability: `connect-polar`" }, "response": [] }, { "name": "connect-resend", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"oauthCode\": \"replace_with_oauth_code\",\n \"oauthState\": \"replace_with_oauth_state\",\n \"apiKey\": \"replace_with_key\",\n \"stackId\": \"00000000-0000-4000-8000-000000000000\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/connect-resend", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "connect-resend" ] }, "description": "Watch a Resend account's send API failures, quota usage, domain DNS readiness, and delivery reputation.\n\nCapability: `connect-resend`" }, "response": [] }, { "name": "connect-sentry", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"authToken\": \"replace_with_token\",\n \"oauthCode\": \"replace_with_oauth_code\",\n \"oauthState\": \"replace_with_oauth_state\",\n \"baseUrl\": \"https://example.com\",\n \"stackId\": \"00000000-0000-4000-8000-000000000000\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/connect-sentry", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "connect-sentry" ] }, "description": "Connect Sentry using an auth token with project:read and org:read scopes. Discovers all projects and returns connected / error.\n\nCapability: `connect-sentry`" }, "response": [] }, { "name": "connect-stripe", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"secretKey\": \"replace_with_secret\",\n \"stackId\": \"00000000-0000-4000-8000-000000000000\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/connect-stripe", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "connect-stripe" ] }, "description": "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.\n\nCapability: `connect-stripe`" }, "response": [] }, { "name": "connect-supabase", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"accessToken\": \"replace_with_token\",\n \"oauthCode\": \"replace_with_oauth_code\",\n \"oauthState\": \"replace_with_oauth_state\",\n \"stackId\": \"00000000-0000-4000-8000-000000000000\",\n \"watch\": \"all\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/connect-supabase", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "connect-supabase" ] }, "description": "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.\n\nCapability: `connect-supabase`" }, "response": [] }, { "name": "connect-vercel", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"accessToken\": \"replace_with_token\",\n \"oauthCode\": \"replace_with_oauth_code\",\n \"oauthState\": \"replace_with_oauth_state\",\n \"stackId\": \"00000000-0000-4000-8000-000000000000\",\n \"watch\": \"all\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/connect-vercel", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "connect-vercel" ] }, "description": "Watch a Vercel account's projects — production deploys that failed, without firing for preview builds.\n\nCapability: `connect-vercel`" }, "response": [] }, { "name": "create-stack", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"replace_with_name\",\n \"environment\": \"replace_with_environment\",\n \"withIngestKey\": false\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/create-stack", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "create-stack" ] }, "description": "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.\n\nCapability: `create-stack`" }, "response": [] }, { "name": "delete-integration", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"integrationId\": \"00000000-0000-4000-8000-000000000000\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/delete-integration", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "delete-integration" ] }, "description": "Remove an integration and everything associated with it — its services, history, incidents, alerts, and stored credentials. Irreversible.\n\nCapability: `delete-integration`\n\nThis operation changes or removes an existing resource. Review the example values before sending it." }, "response": [] }, { "name": "delete-stack", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"stackId\": \"00000000-0000-4000-8000-000000000000\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/delete-stack", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "delete-stack" ] }, "description": "Delete an empty stack. Refuses while it still holds services or connections — move those first — and refuses to delete your only stack.\n\nCapability: `delete-stack`\n\nThis operation changes or removes an existing resource. Review the example values before sending it." }, "response": [] }, { "name": "get-integration-catalog", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/get-integration-catalog", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "get-integration-catalog" ] }, "description": "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.\n\nCapability: `get-integration-catalog`", "auth": { "type": "noauth" } }, "response": [] }, { "name": "list-connections", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"provider\": \"cloudflare\",\n \"stackId\": \"00000000-0000-4000-8000-000000000000\",\n \"activeOnly\": false\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/list-connections", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "list-connections" ] }, "description": "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.\n\nCapability: `list-connections`" }, "response": [] }, { "name": "list-integrations", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"stackId\": \"00000000-0000-4000-8000-000000000000\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/list-integrations", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "list-integrations" ] }, "description": "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.\n\nCapability: `list-integrations`" }, "response": [] }, { "name": "list-planned-connections", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/list-planned-connections", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "list-planned-connections" ] }, "description": "List the providers an approved monitoring plan proposed that are still not connected. Read-only; use next-connection to actually walk through them.\n\nCapability: `list-planned-connections`" }, "response": [] }, { "name": "list-stacks", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/list-stacks", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "list-stacks" ] }, "description": "Return the signed-in user's stacks — each one a logical app + environment that integrations attach to and telemetry is grouped under.\n\nCapability: `list-stacks`" }, "response": [] }, { "name": "next-connection", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"dismiss\": \"replace_with_dismiss\",\n \"stackId\": \"00000000-0000-4000-8000-000000000000\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/next-connection", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "next-connection" ] }, "description": "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.\n\nCapability: `next-connection`\n\nThis operation changes or removes an existing resource. Review the example values before sending it." }, "response": [] }, { "name": "plan-monitoring", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"evidence\": {\n \"files\": [\n \"replace_with_file\"\n ],\n \"dependencies\": [\n \"replace_with_dependencie\"\n ],\n \"envVars\": [\n \"replace_with_env_var\"\n ],\n \"urls\": [\n \"https://example.com\"\n ],\n \"apiHosts\": [\n \"replace_with_api_host\"\n ],\n \"cli\": [\n {\n \"command\": \"replace_with_command\",\n \"authenticated\": false\n }\n ],\n \"providerAccounts\": [\n {\n \"provider\": \"cloudflare\",\n \"accountKey\": \"replace_with_key\"\n }\n ],\n \"stackId\": \"00000000-0000-4000-8000-000000000000\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/plan-monitoring", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "plan-monitoring" ] }, "description": "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.\n\nCapability: `plan-monitoring`" }, "response": [] }, { "name": "rediscover-integration", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"integrationId\": \"00000000-0000-4000-8000-000000000000\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/rediscover-integration", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "rediscover-integration" ] }, "description": "Look for resources created since this connection was last checked, and add any new ones as unwatched services.\n\nCapability: `rediscover-integration`\n\nThis operation changes or removes an existing resource. Review the example values before sending it." }, "response": [] }, { "name": "remove-missing-services", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"integrationId\": \"00000000-0000-4000-8000-000000000000\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/remove-missing-services", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "remove-missing-services" ] }, "description": "Permanently remove services that the provider no longer has, along with their history. Only affects services already detected as missing by re-discovery.\n\nCapability: `remove-missing-services`\n\nThis operation changes or removes an existing resource. Review the example values before sending it." }, "response": [] }, { "name": "rename-stack", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"stackId\": \"00000000-0000-4000-8000-000000000000\",\n \"name\": \"replace_with_name\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/rename-stack", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "rename-stack" ] }, "description": "Change a stack's display name. Its slug — the OTel service.namespace your exporters send to — is deliberately left alone.\n\nCapability: `rename-stack`\n\nThis operation changes or removes an existing resource. Review the example values before sending it." }, "response": [] }, { "name": "resolve-oauth-connect", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"state\": \"replace_with_state\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/resolve-oauth-connect", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "resolve-oauth-connect" ] }, "description": "Turn a connect state into the provider's consent URL, after checking the link belongs to you and has not expired or been used.\n\nCapability: `resolve-oauth-connect`" }, "response": [] }, { "name": "revoke-ingest-key", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"stackId\": \"00000000-0000-4000-8000-000000000000\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/revoke-ingest-key", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "revoke-ingest-key" ] }, "description": "Disable a stack's OTLP ingest key immediately; the stack stops accepting telemetry until you rotate to a new key.\n\nCapability: `revoke-ingest-key`\n\nThis operation changes or removes an existing resource. Review the example values before sending it." }, "response": [] }, { "name": "rotate-ingest-key", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"stackId\": \"00000000-0000-4000-8000-000000000000\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/rotate-ingest-key", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "rotate-ingest-key" ] }, "description": "Generate a new OTLP ingest key for a stack and invalidate the old one. Returns the new key once.\n\nCapability: `rotate-ingest-key`\n\nThis operation changes or removes an existing resource. Review the example values before sending it." }, "response": [] }, { "name": "set-collector-mode", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"integrationId\": \"00000000-0000-4000-8000-000000000000\",\n \"mode\": \"pull\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/set-collector-mode", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "set-collector-mode" ] }, "description": "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.\n\nCapability: `set-collector-mode`\n\nThis operation changes or removes an existing resource. Review the example values before sending it." }, "response": [] }, { "name": "set-service-stack", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"serviceIds\": [\n \"00000000-0000-4000-8000-000000000000\"\n ],\n \"stackId\": \"00000000-0000-4000-8000-000000000000\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/set-service-stack", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "set-service-stack" ] }, "description": "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.\n\nCapability: `set-service-stack`\n\nThis operation changes or removes an existing resource. Review the example values before sending it." }, "response": [] }, { "name": "set-watchlist", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"integrationId\": \"00000000-0000-4000-8000-000000000000\",\n \"serviceIds\": [\n \"00000000-0000-4000-8000-000000000000\"\n ],\n \"stackId\": \"00000000-0000-4000-8000-000000000000\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/set-watchlist", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "set-watchlist" ] }, "description": "Choose which discovered services Beaam watches for an integration. Pass the integration id and the service ids to watch; the rest are unwatched.\n\nCapability: `set-watchlist`\n\nThis operation changes or removes an existing resource. Review the example values before sending it." }, "response": [] }, { "name": "suggest-http-checks", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"provider\": \"cloudflare\",\n \"serviceId\": \"00000000-0000-4000-8000-000000000000\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/suggest-http-checks", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "suggest-http-checks" ] }, "description": "List watched sites whose provider only reports deploys (for example Netlify or Cloudflare Pages), with the URL to add as an HTTP check so Beaam also notices when the site stops answering.\n\nCapability: `suggest-http-checks`" }, "response": [] }, { "name": "update-integration-settings", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"integrationId\": \"00000000-0000-4000-8000-000000000000\",\n \"displayName\": \"replace_with_display_name\",\n \"pollIntervalSeconds\": 1\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/update-integration-settings", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "update-integration-settings" ] }, "description": "Edit an integration's friendly name and/or its check interval (seconds). Invalid values are ignored.\n\nCapability: `update-integration-settings`\n\nThis operation changes or removes an existing resource. Review the example values before sending it." }, "response": [] }, { "name": "vote-integration", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"provider\": \"cloudflare\",\n \"vote\": false\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/vote-integration", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "vote-integration" ] }, "description": "Vote for an integration Beaam has not built yet, or withdraw a vote. Tells the roadmap what to build next.\n\nCapability: `vote-integration`" }, "response": [] } ] }, { "name": "History", "description": "Past incidents, alerts sent, and detection statistics.", "item": [ { "name": "acknowledge-incident", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"incidentId\": \"00000000-0000-4000-8000-000000000000\",\n \"acknowledged\": false\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/acknowledge-incident", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "acknowledge-incident" ] }, "description": "Mark an incident as being handled (\"I'm on it\"), or clear that. Quiets Beaam about it while you work on it.\n\nCapability: `acknowledge-incident`\n\nThis operation changes or removes an existing resource. Review the example values before sending it." }, "response": [] }, { "name": "add-incident-note", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"incidentId\": \"00000000-0000-4000-8000-000000000000\",\n \"body\": \"replace_with_body\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/add-incident-note", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "add-incident-note" ] }, "description": "Record what happened on an incident — the cause, what was done, or what is still unknown. Notes are permanent and cannot be edited or deleted, so they keep what was believed at the time.\n\nCapability: `add-incident-note`" }, "response": [] }, { "name": "cancel-incident-reminder", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"incidentId\": \"00000000-0000-4000-8000-000000000000\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/cancel-incident-reminder", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "cancel-incident-reminder" ] }, "description": "Withdraw your pending reminder about an incident, so no reminder push is sent. Says whether there was one to cancel.\n\nCapability: `cancel-incident-reminder`" }, "response": [] }, { "name": "get-history-overview", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/get-history-overview", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "get-history-overview" ] }, "description": "Return the active organization's bounded History page payload.\n\nCapability: `get-history-overview`" }, "response": [] }, { "name": "get-incident", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"incidentId\": \"00000000-0000-4000-8000-000000000000\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/get-incident", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "get-incident" ] }, "description": "Fetch a single incident by id, with its current state and acknowledgement/snooze status.\n\nCapability: `get-incident`" }, "response": [] }, { "name": "get-service-history", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"serviceId\": \"00000000-0000-4000-8000-000000000000\",\n \"since\": \"2026-01-01T00:00:00.000Z\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/get-service-history", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "get-service-history" ] }, "description": "Return a service's complete retained-window uptime and latency summary, bounded chart series, latest check, and collapsed state runs.\n\nCapability: `get-service-history`" }, "response": [] }, { "name": "get-service-timeline", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"serviceId\": \"00000000-0000-4000-8000-000000000000\",\n \"hours\": 1,\n \"from\": \"2026-01-01T00:00:00.000Z\",\n \"to\": \"2026-01-01T00:00:00.000Z\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/get-service-timeline", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "get-service-timeline" ] }, "description": "What happened around one service, in order — the deploys and config changes across its stack alongside the incidents it opened and resolved, so a change and the failure that followed it read as one sequence.\n\nCapability: `get-service-timeline`" }, "response": [] }, { "name": "list-active-problems", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/list-active-problems", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "list-active-problems" ] }, "description": "Everything open right now, grouped into events (related incidents together) and ordered by what needs you first: unanswered, then most severe, then largest, then most recent.\n\nCapability: `list-active-problems`" }, "response": [] }, { "name": "list-alerts", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"unreviewedOnly\": false,\n \"incidentId\": \"00000000-0000-4000-8000-000000000000\",\n \"limit\": 25\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/list-alerts", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "list-alerts" ] }, "description": "Return the alerts Beaam has sent, newest first, with each alert's review state (real incident, false alarm, or unreviewed).\n\nCapability: `list-alerts`" }, "response": [] }, { "name": "list-checks", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"serviceId\": \"00000000-0000-4000-8000-000000000000\",\n \"serviceIds\": [\n \"00000000-0000-4000-8000-000000000000\"\n ],\n \"since\": \"2026-01-01T00:00:00.000Z\",\n \"until\": \"2026-01-01T00:00:00.000Z\",\n \"limit\": 25\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/list-checks", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "list-checks" ] }, "description": "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.\n\nCapability: `list-checks`" }, "response": [] }, { "name": "list-incidents", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"openOnly\": false,\n \"limit\": 25,\n \"serviceId\": \"00000000-0000-4000-8000-000000000000\",\n \"before\": \"replace_with_before\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/list-incidents", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "list-incidents" ] }, "description": "Return the signed-in user's incidents (the times Beaam decided something was genuinely wrong), newest first.\n\nCapability: `list-incidents`" }, "response": [] }, { "name": "list-recent-changes", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"limit\": 25,\n \"integrationId\": \"00000000-0000-4000-8000-000000000000\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/list-recent-changes", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "list-recent-changes" ] }, "description": "Return recent control-plane changes across your connected providers — deploys, config edits, scaling and pauses — newest first.\n\nCapability: `list-recent-changes`" }, "response": [] }, { "name": "list-suppressions", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"limit\": 25\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/list-suppressions", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "list-suppressions" ] }, "description": "Return what Beaam noticed but chose not to alert on (and why), newest first.\n\nCapability: `list-suppressions`" }, "response": [] }, { "name": "record-deploy", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"stack\": \"replace_with_stack\",\n \"version\": \"replace_with_version\",\n \"service\": \"replace_with_service\",\n \"summary\": \"replace_with_summary\",\n \"occurredAt\": \"2026-01-01T00:00:00.000Z\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/record-deploy", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "record-deploy" ] }, "description": "Tell Beaam you deployed, so it can offer that as the explanation when something breaks shortly afterwards. Use it from CI, or anywhere a provider cannot report deploys for you — a VPS, a container host, a manual release.\n\nCapability: `record-deploy`" }, "response": [] }, { "name": "review-alert", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"alertId\": \"00000000-0000-4000-8000-000000000000\",\n \"incidentId\": \"00000000-0000-4000-8000-000000000000\",\n \"wasReal\": false\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/review-alert", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "review-alert" ] }, "description": "Mark a past alert — or every alert of one incident — as a real incident or a false alarm, so Beaam can track and tune its accuracy.\n\nCapability: `review-alert`\n\nThis operation changes or removes an existing resource. Review the example values before sending it." }, "response": [] }, { "name": "set-incident-reminder", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"incidentId\": \"00000000-0000-4000-8000-000000000000\",\n \"minutes\": 25\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/set-incident-reminder", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "set-incident-reminder" ] }, "description": "Get one push on your own phone later, only if the incident hasn't resolved by then. Asking again moves the reminder; it never repeats. 5 minutes to 24 hours ahead.\n\nCapability: `set-incident-reminder`" }, "response": [] }, { "name": "snooze-incident", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"incidentId\": \"00000000-0000-4000-8000-000000000000\",\n \"minutes\": 25\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/snooze-incident", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "snooze-incident" ] }, "description": "Stay quiet about an incident for a while (\"not now\"). Pass minutes to snooze, or 0 to clear it.\n\nCapability: `snooze-incident`\n\nThis operation changes or removes an existing resource. Review the example values before sending it." }, "response": [] } ] }, { "name": "Account", "description": "Profile, organizations, notification channels, API keys, and billing.", "item": [ { "name": "accept-invitation", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"token\": \"replace_with_token\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/accept-invitation", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accept-invitation" ] }, "description": "Accept an organization invitation using its token. Joins the org and makes it your active organization.\n\nCapability: `accept-invitation`" }, "response": [] }, { "name": "acknowledge-welcome", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/acknowledge-welcome", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "acknowledge-welcome" ] }, "description": "Record that this account has seen its welcome message, so it is shown once and never again.\n\nCapability: `acknowledge-welcome`" }, "response": [] }, { "name": "cancel-maintenance-window", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"windowId\": \"00000000-0000-4000-8000-000000000000\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/cancel-maintenance-window", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "cancel-maintenance-window" ] }, "description": "Remove a planned quiet period so alerts resume. Cancelling an active window restores alerting immediately.\n\nCapability: `cancel-maintenance-window`" }, "response": [] }, { "name": "cancel-subscription", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/cancel-subscription", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "cancel-subscription" ] }, "description": "Cancel the caller's Solo subscription at the end of the current billing period (downgrade to Free). Access continues until period end.\n\nCapability: `cancel-subscription`\n\nThis operation changes or removes an existing resource. Review the example values before sending it." }, "response": [] }, { "name": "create-api-key", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"replace_with_name\",\n \"expiresInDays\": 25\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/create-api-key", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "create-api-key" ] }, "description": "Create a personal API key for the public API and the hosted MCP server. The secret is shown once at creation.\n\nCapability: `create-api-key`" }, "response": [] }, { "name": "create-checkout", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"entryPoint\": \"replace_with_entry_point\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/create-checkout", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "create-checkout" ] }, "description": "Create a secure Polar checkout session for the signed-in Beaam account's $19/month Solo plan.\n\nCapability: `create-checkout`" }, "response": [] }, { "name": "create-organization", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"replace_with_name\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/create-organization", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "create-organization" ] }, "description": "Create a new organization (a separate workspace with its own integrations, members, and plan) and switch to it.\n\nCapability: `create-organization`" }, "response": [] }, { "name": "delete-account", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"password\": \"replace_with_password\",\n \"confirm\": \"replace_with_confirm\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/delete-account", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "delete-account" ] }, "description": "Permanently delete your Beaam account and associated monitoring data after password reauthentication. Irreversible.\n\nCapability: `delete-account`\n\nThis operation changes or removes an existing resource. Review the example values before sending it." }, "response": [] }, { "name": "delete-all-data", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"confirm\": \"replace_with_confirm\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/delete-all-data", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "delete-all-data" ] }, "description": "Remove every integration and all monitoring data (services, history, incidents, alerts, credentials). Notification channels are kept. Pass confirm:\"DELETE\". Irreversible.\n\nCapability: `delete-all-data`\n\nThis operation changes or removes an existing resource. Review the example values before sending it." }, "response": [] }, { "name": "delete-notification-channel", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"00000000-0000-4000-8000-000000000000\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/delete-notification-channel", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "delete-notification-channel" ] }, "description": "Delete one of the user's notification channels by id.\n\nCapability: `delete-notification-channel`\n\nThis operation changes or removes an existing resource. Review the example values before sending it." }, "response": [] }, { "name": "delete-organization", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"confirmName\": \"replace_with_confirm_name\",\n \"orgId\": \"00000000-0000-4000-8000-000000000000\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/delete-organization", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "delete-organization" ] }, "description": "Permanently delete an organization and all of its data (integrations, services, history, members). Owner only.\n\nCapability: `delete-organization`\n\nThis operation changes or removes an existing resource. Review the example values before sending it." }, "response": [] }, { "name": "end-live-activity", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"activityId\": \"00000000-0000-4000-8000-000000000000\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/end-live-activity", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "end-live-activity" ] }, "description": "Tell Beaam an iOS Live Activity has ended on the device, so it stops sending it updates. Used by the Beaam iPhone app.\n\nCapability: `end-live-activity`" }, "response": [] }, { "name": "get-activation-progress", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/get-activation-progress", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "get-activation-progress" ] }, "description": "Show whether this account has connected monitoring, received its first real signal, and verified its default alert path.\n\nCapability: `get-activation-progress`" }, "response": [] }, { "name": "get-alert-route", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"serviceId\": \"00000000-0000-4000-8000-000000000000\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/get-alert-route", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "get-alert-route" ] }, "description": "Show exactly which notification channels an alert on a service would reach: for a degraded incident, and for a broken one (which adds the organization's defaults). Lists any SMS channel the plan won't text.\n\nCapability: `get-alert-route`" }, "response": [] }, { "name": "get-billing", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/get-billing", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "get-billing" ] }, "description": "Return the active organization's effective plan and usage, plus the caller's own account plan and available billing actions.\n\nCapability: `get-billing`" }, "response": [] }, { "name": "get-live-activity-support", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/get-live-activity-support", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "get-live-activity-support" ] }, "description": "Whether this Beaam server can update iOS Live Activities, so the iPhone app knows whether to start one. Used by the Beaam iPhone app.\n\nCapability: `get-live-activity-support`" }, "response": [] }, { "name": "get-webhook-signing-secret", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"channelId\": \"00000000-0000-4000-8000-000000000000\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/get-webhook-signing-secret", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "get-webhook-signing-secret" ] }, "description": "Return the Standard Webhooks signing secret for one of your webhook notification channels, so your endpoint can verify that a request really came from Beaam.\n\nCapability: `get-webhook-signing-secret`" }, "response": [] }, { "name": "invite-member", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"email\": \"user@example.com\",\n \"role\": \"admin\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/invite-member", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "invite-member" ] }, "description": "Invite someone to your active organization by email and get a one-time link to share. Owners and admins only.\n\nCapability: `invite-member`" }, "response": [] }, { "name": "join-waitlist", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"email\": \"user@example.com\",\n \"source\": \"replace_with_source\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/join-waitlist", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "join-waitlist" ] }, "description": "Add an email address to the Beaam waitlist.\n\nCapability: `join-waitlist`", "auth": { "type": "noauth" } }, "response": [] }, { "name": "list-api-keys", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/list-api-keys", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "list-api-keys" ] }, "description": "Return the caller's API keys — name, prefix, created and last-used times, and whether revoked. Never returns the secret.\n\nCapability: `list-api-keys`" }, "response": [] }, { "name": "list-devices", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/list-devices", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "list-devices" ] }, "description": "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.\n\nCapability: `list-devices`" }, "response": [] }, { "name": "list-maintenance-windows", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"includePast\": false\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/list-maintenance-windows", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "list-maintenance-windows" ] }, "description": "Show the planned periods when alerts are withheld, and which of them is silencing you right now.\n\nCapability: `list-maintenance-windows`" }, "response": [] }, { "name": "list-members", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/list-members", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "list-members" ] }, "description": "List the members of your active organization (with roles), plus pending invitations if you can manage members.\n\nCapability: `list-members`" }, "response": [] }, { "name": "list-notification-channels", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"serviceId\": \"00000000-0000-4000-8000-000000000000\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/list-notification-channels", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "list-notification-channels" ] }, "description": "Return the user's notification channels (email/SMS/push/Slack/webhook): destination, enabled state, why Beaam disabled it, whether it's a default, and its latest test result. Pass serviceId to also get that service's routing.\n\nCapability: `list-notification-channels`" }, "response": [] }, { "name": "list-organizations", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/list-organizations", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "list-organizations" ] }, "description": "List the organizations you belong to, your role in each, and which one is currently active.\n\nCapability: `list-organizations`" }, "response": [] }, { "name": "list-payments", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/list-payments", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "list-payments" ] }, "description": "Return past payments for the signed-in account, newest first, with amount, status and a receipt link where one exists.\n\nCapability: `list-payments`" }, "response": [] }, { "name": "preview-invitation", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"token\": \"replace_with_token\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/preview-invitation", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "preview-invitation" ] }, "description": "Look up an organization invitation by token to see the organization, invited email, and role.\n\nCapability: `preview-invitation`", "auth": { "type": "noauth" } }, "response": [] }, { "name": "record-product-event", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"event\": \"setup_started\",\n \"properties\": {\n \"key\": \"replace_with_value\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/record-product-event", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "record-product-event" ] }, "description": "Record a non-sensitive setup, integration-selection, or upgrade-intent event for the signed-in account.\n\nCapability: `record-product-event`" }, "response": [] }, { "name": "register-device", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"expoPushToken\": \"replace_with_token\",\n \"platform\": \"ios\",\n \"deviceName\": \"replace_with_device_name\",\n \"replaceExisting\": false\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/register-device", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "register-device" ] }, "description": "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. A confirmed replaceExisting request moves the physical device from a previous account.\n\nCapability: `register-device`" }, "response": [] }, { "name": "register-live-activity", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"incidentId\": \"00000000-0000-4000-8000-000000000000\",\n \"activityId\": \"00000000-0000-4000-8000-000000000000\",\n \"pushToken\": \"replace_with_token\",\n \"apnsEnvironment\": \"production\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/register-live-activity", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "register-live-activity" ] }, "description": "Register an iOS Live Activity's push token for an open incident, so Beaam can update it and end it when the incident resolves. Used by the Beaam iPhone app.\n\nCapability: `register-live-activity`" }, "response": [] }, { "name": "remove-member", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"userId\": \"00000000-0000-4000-8000-000000000000\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/remove-member", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "remove-member" ] }, "description": "Remove a member from your active organization, revoking their access. Owners and admins only.\n\nCapability: `remove-member`\n\nThis operation changes or removes an existing resource. Review the example values before sending it." }, "response": [] }, { "name": "rename-organization", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"replace_with_name\",\n \"orgId\": \"00000000-0000-4000-8000-000000000000\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/rename-organization", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "rename-organization" ] }, "description": "Rename an organization (defaults to your active one). Owners and admins only.\n\nCapability: `rename-organization`" }, "response": [] }, { "name": "resume-subscription", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/resume-subscription", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "resume-subscription" ] }, "description": "Undo a scheduled cancellation so the caller's Solo subscription renews as normal instead of ending at the current period.\n\nCapability: `resume-subscription`" }, "response": [] }, { "name": "revoke-api-key", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"00000000-0000-4000-8000-000000000000\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/revoke-api-key", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "revoke-api-key" ] }, "description": "Revoke a personal API key by id; it stops working immediately.\n\nCapability: `revoke-api-key`\n\nThis operation changes or removes an existing resource. Review the example values before sending it." }, "response": [] }, { "name": "revoke-assistant-connection", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"clientId\": \"00000000-0000-4000-8000-000000000000\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/revoke-assistant-connection", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "revoke-assistant-connection" ] }, "description": "End one AI client's access to this Beaam account. Its live tokens are revoked and any pending authorization is discarded, so it stops working immediately. Other connected clients are unaffected; reconnecting means authorizing again.\n\nCapability: `revoke-assistant-connection`\n\nThis operation changes or removes an existing resource. Review the example values before sending it." }, "response": [] }, { "name": "revoke-invitation", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"inviteId\": \"00000000-0000-4000-8000-000000000000\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/revoke-invitation", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "revoke-invitation" ] }, "description": "Revoke a pending invitation to your active organization, invalidating its link. Owners and admins only.\n\nCapability: `revoke-invitation`" }, "response": [] }, { "name": "rotate-webhook-signing-secret", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"channelId\": \"00000000-0000-4000-8000-000000000000\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/rotate-webhook-signing-secret", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "rotate-webhook-signing-secret" ] }, "description": "Issue a new Standard Webhooks signing secret for one of your webhook notification channels. The change takes effect immediately and the previous secret stops working, so update your endpoint at the same time.\n\nCapability: `rotate-webhook-signing-secret`\n\nThis operation changes or removes an existing resource. Review the example values before sending it." }, "response": [] }, { "name": "save-notification-channel", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"00000000-0000-4000-8000-000000000000\",\n \"type\": \"email\",\n \"label\": \"replace_with_label\",\n \"destination\": \"replace_with_destination\",\n \"enabled\": false,\n \"isDefault\": false,\n \"smsConsent\": false\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/save-notification-channel", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "save-notification-channel" ] }, "description": "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.\n\nCapability: `save-notification-channel`\n\nThis operation changes or removes an existing resource. Review the example values before sending it." }, "response": [] }, { "name": "schedule-maintenance-window", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"startsAt\": \"2026-01-01T00:00:00.000Z\",\n \"endsAt\": \"2026-01-01T00:00:00.000Z\",\n \"reason\": \"replace_with_reason\",\n \"scope\": \"org\",\n \"stackId\": \"00000000-0000-4000-8000-000000000000\",\n \"serviceId\": \"00000000-0000-4000-8000-000000000000\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/schedule-maintenance-window", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "schedule-maintenance-window" ] }, "description": "Plan a period when Beaam should not page you — a deploy or migration. Incidents are still detected and recorded; only the alert is withheld, with your reason attached. Never silences the checks that tell you Beaam itself stopped watching.\n\nCapability: `schedule-maintenance-window`\n\nThis operation changes or removes an existing resource. Review the example values before sending it." }, "response": [] }, { "name": "send-test-alert", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"channelId\": \"00000000-0000-4000-8000-000000000000\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/send-test-alert", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "send-test-alert" ] }, "description": "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.\n\nCapability: `send-test-alert`" }, "response": [] }, { "name": "set-ai-explanations", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"enabled\": false,\n \"orgId\": \"00000000-0000-4000-8000-000000000000\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/set-ai-explanations", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "set-ai-explanations" ] }, "description": "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.\n\nCapability: `set-ai-explanations`" }, "response": [] }, { "name": "set-service-notifications", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"serviceId\": \"00000000-0000-4000-8000-000000000000\",\n \"mode\": \"global\",\n \"channelIds\": [\n \"00000000-0000-4000-8000-000000000000\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/set-service-notifications", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "set-service-notifications" ] }, "description": "Choose how a service's alerts route: 'global' uses the default channels; 'custom' uses the given channelIds. Pass the service id and mode.\n\nCapability: `set-service-notifications`\n\nThis operation changes or removes an existing resource. Review the example values before sending it." }, "response": [] }, { "name": "switch-organization", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"orgId\": \"00000000-0000-4000-8000-000000000000\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/switch-organization", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "switch-organization" ] }, "description": "Make one of your organizations the active one for the current session. You must be a member of it.\n\nCapability: `switch-organization`" }, "response": [] }, { "name": "unregister-device", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"deviceId\": \"00000000-0000-4000-8000-000000000000\",\n \"expoPushToken\": \"replace_with_token\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/unregister-device", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "unregister-device" ] }, "description": "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.\n\nCapability: `unregister-device`\n\nThis operation changes or removes an existing resource. Review the example values before sending it." }, "response": [] } ] } ] }