> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Better Stack

> Better Stack provides monitoring, logging, and incident management solutions to help teams ensure the reliability and performance of their applications.

![Better Stack logo](https://mintcdn.com/composio-preview/6S5R4NszqpnVIZRD/images/toolkits/better_stack.svg?fit=max\&auto=format\&n=6S5R4NszqpnVIZRD\&q=85\&s=7cd844450a2b11886a3b1dfe0ceed878)

* **Category:** server monitoring
* **Auth:** API\_KEY
* **Composio-managed OAuth available?** N/A
* **Tools:** 117
* **Triggers:** 0
* **Slug:** `BETTER_STACK`
* **Version:** 20261101\_00

## Tools

> [accordion] Acknowledge Incident
>
> **Slug:** `BETTER_STACK_ACKNOWLEDGE_INCIDENT`
>
> Tool to acknowledge an ongoing incident. Use when you need to mark an incident as being worked on, which prevents further escalations. Acknowledging an incident signals that someone is actively addressing the issue.
>
> #### Input Parameters
>
> **incident\_id** `string` *required*
>
> The ID of the incident to acknowledge
>
> **acknowledged\_by** `string`
>
> Email or custom identifier of the person or system acknowledging the incident
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Batch create catalog records
>
> **Slug:** `BETTER_STACK_BATCH_CREATE_CATALOG_RECORDS`
>
> ##### Batch create catalog records Allows creation of multiple Catalog records at once. POST /api/v2/catalog/relations/\{relation\_id}/records/batch Requires a Better Stack Incidents API token with access to the resource.
>
> #### Input Parameters
>
> **records** `array` *required*
>
> Records sent as a raw JSON array. Each record contains an attributes array; entries contain attribute (id/name) and values (typed value or item\_id objects). Follows the single Catalog record creation format.
>
> **relation\_id** `string` *required*
>
> The ID of the Catalog relation you want to create records for.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Batch remove catalog records
>
> **Slug:** `BETTER_STACK_BATCH_REMOVE_CATALOG_RECORDS`
>
> ##### Batch remove catalog records Permanently deletes **all** existing Catalog records for a given relation. DELETE /api/v2/catalog/relations/\{relation\_id}/records/batch Requires a Better Stack Incidents API token with access to the resource.
>
> #### Input Parameters
>
> **relation\_id** `string` *required*
>
> The ID of the Catalog relation you want to delete records for.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Batch update catalog records
>
> **Slug:** `BETTER_STACK_BATCH_UPDATE_CATALOG_RECORDS`
>
> ##### Batch update catalog records Allows replacing **all** Catalog records for a given relation at once. This is a destructive operation and will remove all existing records for the relation before creating new ones. PUT /api/v2/catalog/relations/\{relation\_id}/records/batch Requires a Better Stack Incidents API token with access to the resource.
>
> #### Input Parameters
>
> **records** `array` *required*
>
> Array of records to be created. Each individual records follows the format for [creating a single Catalog record](https://betterstack.com/docs/uptime/api/create-catalog-record/).
>
> **relation\_id** `string` *required*
>
> The ID of the Catalog relation you want to replace records for.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Batch upsert catalog records
>
> **Slug:** `BETTER_STACK_BATCH_UPSERT_CATALOG_RECORDS`
>
> Create or partially update Catalog records in one atomic batch. Matches existing records by primary attribute values, regardless of value order; an empty primary attribute matches only an empty one. Matching records update only supplied attributes: omitted attributes retain their values, and an empty values array clears an attribute. Nonmatching inputs create records; existing records not matched by the batch remain unchanged. If any record cannot be saved, none are saved, including ambiguous matches or duplicate primary values within the batch. Returns records in input order and created/updated IDs. Requires a Better Stack Incidents API token with access to the relation.
>
> #### Input Parameters
>
> **records** `array` *required*
>
> Records to create or update. Each record contains an attributes array of objects with attribute (id and/or name) and values. Values contain type and type-specific fields, such as value for String or email for User. Omitted attributes keep their values; an empty values array clears an attribute.
>
> **relation\_id** `string` *required*
>
> The ID of the Catalog relation you want to create or update records for.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Bulk update on-call events
>
> **Slug:** `BETTER_STACK_BULK_UPDATE_ON_CALL_EVENTS`
>
> ##### Bulk update on-call schedule events Replace all current and future on-call events in a single on-call schedule: - Delete all events that start today at 0:00 UTC or later. - Create new events. All newly created events also must start today at 0:00 UTC or later. PUT /api/v2/on-calls/\{schedule\_id}/events Requires a Better Stack Incidents API token with access to the resource.
>
> #### Input Parameters
>
> **events** `array` *required*
>
> Events to create, each containing users (array of email addresses), starts\_at and ends\_at (ISO 8601 timestamps), and optional override (boolean). Replaces all events starting today at 00:00 UTC or later; new events must also start at or after that cutoff. Earlier events remain unchanged. Use the single-event structure: [https://betterstack.com/docs/uptime/api/create-on-call-calendar-event/](https://betterstack.com/docs/uptime/api/create-on-call-calendar-event/).
>
> **schedule\_id** `string` *required*
>
> The ID of the on-call schedule you want to replace events for. Use `default` to refer to the default on-call schedule for the team.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Amazon SNS integration
>
> **Slug:** `BETTER_STACK_CREATE_AMAZON_SNS_INTEGRATION`
>
> ##### Create Amazon SNS integration Returns either a newly created Amazon SNS integration, or validation errors. Subscribe a topic to the returned `url` to start receiving notifications, as described in the [Amazon SNS integration guide](https://betterstack.com/docs/uptime/integrations/integrating-with-better-uptime/amazon-sns/). Leave **Enable raw message delivery** off on that subscription, or every notification is rejected with `400`. POST /api/v2/amazon-sns Requires a Better Stack Incidents API token with access to the resource.
>
> #### Input Parameters
>
> **sms** `boolean`
>
> Send an SMS to the on-call person.
>
> **call** `boolean`
>
> Call the on-call person.
>
> **name** `string`
>
> The name of the Amazon SNS integration that you can see in the dashboard.
>
> **push** `boolean`
>
> Send a push notification to the on-call person.
>
> **email** `boolean`
>
> Send an e-mail to the on-call person.
>
> **paused** `boolean`
>
> Set to `true` to pause the integration, `false` to unpause it.
>
> **policy\_id** `string`
>
> ID of the escalation policy for incidents from this integration. Without one, incidents alert the current on-call person through the channels set by `call`, `sms`, `email`, and `push`.
>
> **team\_name** `string`
>
> Required if using [global API token](https://betterstack.com/docs/uptime/api/getting-started-with-uptime-api/#get-a-global-api-token) to specify the team which should own the resource
>
> **team\_wait** `integer`
>
> How long we wait before escalating the incident to the team. In seconds. Send `null` to never escalate to the team, or `0` to alert the whole team right away.
>
> **cause\_field** `object`
>
> Incident cause extraction object; defaults to the whole message. Required string keys: field\_target (sns\_envelope, body, json, xml, query\_string, header) and match\_type (match\_everything, match\_before, match\_after, match\_between, match\_regex). target\_field: dot path for json/query\_string, header name, XML CSS selector, or TopicArn/MessageId/Subject for sns\_envelope; unused for body. body/json/xml read the published message; query\_string/header read AWS's HTTPS request, not the message. match\_everything takes the whole value. match\_before/match\_after require string content and extract text before/after it. match\_regex requires a regex in content and extracts its match or capture group. match\_between requires string content\_before and content\_after delimiters.
>
> **title\_field** `object`
>
> How to extract a custom incident title, as a field object with the same keys as `cause_field`. Defaults to the notification's `Subject`, and `null` removes it to use the default title.
>
> **started\_rules** `array`
>
> The conditions `started_rule_type` checks, as an array of rule objects with the keys below. At least one rule is required when the type is `any` or `all`. Nested fields: started\_rules\[].rule\_target: Which part of the notification the rule checks: `sns_envelope` for the envelope, `body`, `json`, or `xml` for the message your publisher sent, or `query_string` or `header` for AWS's own HTTPS request, which never contains your message.; started\_rules\[].target\_field: Which value to read: a dot-separated path such as `alert.id` for `json` and `query_string`, a header name for `header`, a CSS selector for `xml`, or `TopicArn`, `MessageId`, or `Subject` for `sns_envelope`. Not used with `body`.; started\_rules\[].match\_type: How to compare the value with `content`: `contains`, `contains_not`, `equals`, `equals_not`, `matches_regex`, or `matches_regex_not`.; started\_rules\[].content: The value to compare with. Must be a valid regular expression for `matches_regex` and `matches_regex_not`.
>
> **critical\_alert** `boolean`
>
> Send a critical push notification that ignores the mute switch and Do Not Disturb mode.
>
> **resolved\_rules** `array`
>
> The conditions `resolved_rule_type` checks, as rule objects with the same keys as `started_rules`.
>
> **recovery\_period** `integer ("0" | "60" | "180" | "300" | "900" | "1800" | "3600" | "7200")`
>
> How long to wait after a notification matching `resolved_rules` arrives before marking an incident as resolved, in seconds: `0`, `60`, `180`, `300`, `900`, `1800`, `3600`, or `7200`. Has no effect while `resolved_rule_type` is `unused`.
>
> **started\_rule\_type** `string ("unused" | "any" | "all")`
>
> When notifications start an incident: `unused` always, `any` when at least one of `started_rules` matches, or `all` when all of them match. Defaults to `unused`.
>
> **acknowledged\_rules** `array`
>
> The conditions `acknowledged_rule_type` checks, as rule objects with the same keys as `started_rules`.
>
> **resolved\_rule\_type** `string ("unused" | "any" | "all")`
>
> When notifications resolve an incident: `unused` never, `any` when at least one of `resolved_rules` matches, or `all` when all of them match. Defaults to `unused`, and any other value requires `started_alert_id_field` and `resolved_alert_id_field`.
>
> **other\_started\_fields** `array`
>
> Extra values to extract when an incident starts, saved as incident metadata. Each field object has the same keys as `cause_field`, plus `name`. Nested fields: other\_started\_fields\[].name: The metadata key to save the extracted value under. Must be unique within the array.
>
> **other\_resolved\_fields** `array`
>
> Extra values to extract when an incident is resolved, with the same keys as `other_started_fields`.
>
> **acknowledged\_rule\_type** `string ("unused" | "any" | "all")`
>
> When notifications acknowledge an incident: `unused` never, `any` when at least one of `acknowledged_rules` matches, or `all` when all of them match. Defaults to `unused`, and any other value requires `started_alert_id_field` and `acknowledged_alert_id_field`.
>
> **started\_alert\_id\_field** `object`
>
> How to extract the alert ID from the notification that starts an incident, with the same keys as `cause_field`; later notifications acknowledge and resolve the incident by matching it. Required when `acknowledged_rule_type` or `resolved_rule_type` isn't `unused`, and defaults to the whole message.
>
> **resolved\_alert\_id\_field** `object`
>
> How to extract the alert ID from a notification that resolves an incident, with the same keys as `cause_field`. Required when `resolved_rule_type` isn't `unused`.
>
> **other\_acknowledged\_fields** `array`
>
> Extra values to extract when an incident is acknowledged, with the same keys as `other_started_fields`.
>
> **acknowledged\_alert\_id\_field** `object`
>
> How to extract the alert ID from a notification that acknowledges an incident, with the same keys as `cause_field`. Required when `acknowledged_rule_type` isn't `unused`.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create AWS CloudWatch integration
>
> **Slug:** `BETTER_STACK_CREATE_AWS_CLOUDWATCH_INTEGRATION`
>
> ##### Create AWS CloudWatch integration Returns either a newly created AWS CloudWatch integration, or validation errors. POST /api/v2/aws-cloudwatch-integrations Requires a Better Stack Incidents API token with access to the resource.
>
> #### Input Parameters
>
> **sms** `boolean`
>
> Send an SMS to the on-call person.
>
> **call** `boolean`
>
> Call the on-call person.
>
> **name** `string`
>
> The name of the AWS CloudWatch integration that you can see in the dashboard.
>
> **push** `boolean`
>
> Send a push notification to the on-call person.
>
> **email** `boolean`
>
> Send an e-mail to the on-call person.
>
> **paused** `boolean`
>
> Set to `true` to pause the integration, `false` to unpause it.
>
> **policy\_id** `string`
>
> ID of the escalation policy associated with the AWS CloudWatch integration.
>
> **team\_name** `string`
>
> Required if using [global API token](https://betterstack.com/docs/uptime/api/getting-started-with-uptime-api/#get-a-global-api-token) to specify the team which should own the resource
>
> **team\_wait** `integer`
>
> How long we wait before escalating the incident alert to the team. In seconds.
>
> **critical\_alert** `boolean`
>
> Send a critical push notification that ignores the mute switch and Do not Disturb mode.
>
> **recovery\_period** `integer`
>
> Has no effect for this integration, since an incident resolves as soon as AWS CloudWatch reports the alert as resolved.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create aws log group subscription
>
> **Slug:** `BETTER_STACK_CREATE_AWS_LOG_GROUP_SUBSCRIPTION`
>
> Create an override to subscribe or unsubscribe one CloudWatch log group. Requires an `aws` source with an AWS account already connected and a Telemetry API token with access to the source. Set subscribed to true to ingest the log group or false to skip it, overriding the source's automatic subscription setting. An override can be created before discovery of the log group; creating a duplicate region/name override returns HTTP 422.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Name of the CloudWatch log group, for example `/aws/lambda/checkout`.
>
> **region** `string` *required*
>
> AWS region of the log group, for example `us-east-1`.
>
> **source\_id** `string` *required*
>
> ID of an `aws` source with an AWS account already connected.
>
> **subscribed** `boolean` *required*
>
> Whether to ingest this log group. Set to `true` to subscribe or `false` to skip it.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Azure integration
>
> **Slug:** `BETTER_STACK_CREATE_AZURE_INTEGRATION`
>
> ##### Create Azure integration Returns either a newly created Azure integration, or validation errors. POST /api/v2/azure-integrations Requires a Better Stack Incidents API token with access to the resource.
>
> #### Input Parameters
>
> **sms** `boolean`
>
> Send an SMS to the on-call person.
>
> **call** `boolean`
>
> Call the on-call person.
>
> **name** `string`
>
> The name of the Azure integration that you can see in the dashboard.
>
> **push** `boolean`
>
> Send a push notification to the on-call person.
>
> **email** `boolean`
>
> Send an e-mail to the on-call person.
>
> **paused** `boolean`
>
> Set to `true` to pause the integration, `false` to unpause it.
>
> **policy\_id** `string`
>
> ID of the escalation policy associated with the Azure integration.
>
> **team\_name** `string`
>
> Required if using [global API token](https://betterstack.com/docs/uptime/api/getting-started-with-uptime-api/#get-a-global-api-token) to specify the team which should own the resource
>
> **team\_wait** `integer`
>
> How long we wait before escalating the incident alert to the team. In seconds.
>
> **critical\_alert** `boolean`
>
> Send a critical push notification that ignores the mute switch and Do not Disturb mode.
>
> **recovery\_period** `integer`
>
> Has no effect for this integration, since an incident resolves as soon as Azure reports the alert as resolved.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create catalog attribute
>
> **Slug:** `BETTER_STACK_CREATE_CATALOG_ATTRIBUTE`
>
> ##### Create catalog attribute Returns either a newly created Catalog attribute, or validation errors. POST /api/v2/catalog/relations/\{relation\_id}/attributes Requires a Better Stack Incidents API token with access to the resource.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> The name of the Catalog attribute.
>
> **primary** `boolean`
>
> Whether this is a primary attribute. Primary attributes are matched against the incident metadata key of the same name, the other attributes are added to matching incidents as metadata. Defaults to `false`.
>
> **position** `integer`
>
> The position of the attribute in the Catalog relation, lower values first. Defaults to `0`.
>
> **relation\_id** `string` *required*
>
> The ID of the Catalog relation you want to create an attribute for.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create catalog record
>
> **Slug:** `BETTER_STACK_CREATE_CATALOG_RECORD`
>
> ##### Create catalog record Returns either a newly created Catalog record, or validation errors. POST /api/v2/catalog/relations/\{relation\_id}/records Requires a Better Stack Incidents API token with access to the resource.
>
> #### Input Parameters
>
> **attributes** `array` *required*
>
> Record attributes: \[\{attribute: \{id or name}, values: \[\{type, value or item\_id/name/email}]}]. Attribute id/name and value identifiers are strings. Each value requires type: String, User, Team, Policy, Schedule, Endpoint, Source, SlackIntegration, LinearIntegration, JiraIntegration, MicrosoftTeamsWebhook, ZapierWebhook, NativeWebhook, or PagerDutyWebhook. String requires value. References require item\_id, name, or email (email for User); Endpoint references a monitor ID. Endpoint, SlackIntegration and ZapierWebhook cannot be referenced by name. Multiple values per attribute are supported.
>
> **relation\_id** `string` *required*
>
> The ID of the Catalog relation you want to create a record for.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create catalog relation
>
> **Slug:** `BETTER_STACK_CREATE_CATALOG_RELATION`
>
> ##### Create catalog relation Returns either a newly created Catalog relation, or validation errors. POST /api/v2/catalog/relations Requires a Better Stack Incidents API token with access to the resource.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> The name of the Catalog relation.
>
> **match\_mode** `string ("any" | "all")`
>
> `any`, the default, applies a record when at least one of its primary attribute values matches the incident's metadata. `all` applies it only when every primary attribute value matches, with an empty value matching anything.
>
> **description** `string`
>
> A description of the Catalog relation.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create chart
>
> **Slug:** `BETTER_STACK_CREATE_CHART`
>
> Create a chart on a specific dashboard. Requires a Telemetry API token. Only line\_chart supports multiple queries. funnel\_chart cannot be created through the API. For SQL queries, filter dt with \{\{start\_time}} and \{\{end\_time}}; \{\{time}} only groups timestamps into buckets. Overlapping positions cause automatic layout consolidation; the response may include warnings.
>
> #### Input Parameters
>
> **name** `string`
>
> The name of the chart.
>
> **width** `integer`
>
> The width of the chart in grid units. Defaults to 6 when omitted.
>
> **height** `integer`
>
> The height of the chart in grid units. Defaults to 4 when omitted.
>
> **queries** `array` *required*
>
> One or more query objects. Only line\_chart supports multiple queries. Use query\_type sql\_expression with sql\_query, tail\_query with where\_condition, or static\_text with static\_text. source\_variable defaults to source. query\_builder, pql\_expression, and funnel\_query are read-only.
>
> **settings** `object`
>
> A JSON object for chart-specific settings (e.g., units, stacking).
>
> **chart\_type** `string` *required*
>
> The type of chart to create (e.g., `line_chart`, `bar_chart`, `table_chart`).
>
> **description** `string`
>
> A description for the chart.
>
> **dashboard\_id** `integer` *required*
>
> The unique identifier of the dashboard.
>
> **vertical\_position** `integer`
>
> The vertical position of the chart on the dashboard grid (0-based). If omitted, the chart is auto-placed.
>
> **horizontal\_position** `integer`
>
> The horizontal position of the chart on the dashboard grid (0-based). If omitted, the chart is auto-placed.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create chart comment
>
> **Slug:** `BETTER_STACK_CREATE_CHART_COMMENT`
>
> ##### Create a chart comment Pins a comment to a point in time on a chart, the same comment you get by clicking the chart in the Better Stack interface. Use it to mark releases, deployments, and incidents on your charts from your own scripts. POST /api/v2/dashboards/\{dashboard\_id}/charts/\{chart\_id}/comments Requires a Telemetry API token with access to the resource.
>
> #### Input Parameters
>
> **content** `string` *required*
>
> The content of the comment. [Markdown](https://www.markdownguide.org/basic-syntax/) is supported for formatting.
>
> **chart\_id** `integer` *required*
>
> The unique identifier of the chart. Only a line chart can show comments.
>
> **timestamp** `string` *required*
>
> The point on the chart's time axis to pin the comment to, as a datetime such as `2026-08-17T12:34:56.789Z`. A datetime without a zone offset is read as UTC.
>
> **user\_email** `string`
>
> E-mail of a team member to tag in the comment. The mention goes in front of your content, and that team member is notified.
>
> **dashboard\_id** `integer` *required*
>
> The unique identifier of the dashboard.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create collector
>
> **Slug:** `BETTER_STACK_CREATE_COLLECTOR`
>
> ##### Create a collector Creates a new Better Stack collector. \[info] The `platform` and `data_region` attributes can only be set during creation and cannot be updated later. A custom bucket can only be added during creation; its key pair can be rotated with [Update collector](https://betterstack.com/docs/logs/api/update-a-collector/). \[/info] POST /api/v1/collectors Requires a Telemetry API token with access to the resource.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> A unique name for the collector.
>
> **note** `string`
>
> An optional note for the collector.
>
> **platform** `string ("docker" | "swarm" | "kubernetes")` *required*
>
> The platform where the collector will be installed. Valid options are `docker`, `swarm`, and `kubernetes`.
>
> **databases** `array`
>
> An array of database connection objects to be monitored by the collector.
>
> **team\_name** `string`
>
> Required if using a [global API token](https://betterstack.com/docs/logs/api/getting-started/#get-a-global-api-token) to specify the team that will own the collector.
>
> **data\_region** `string`
>
> The data region where the collector's data will be stored. If omitted, the organization's default region is used.
>
> **configuration** `object`
>
> Collector configuration: components (boolean flags), logs\_sample\_rate/traces\_sample\_rate (0-100), vrl\_transformation, disk\_batch\_size\_mb (minimum 256), memory\_batch\_size\_mb, when\_full (drop\_newest or block), log\_line\_length\_limit\_kb (4-128, default 8), services\_options, and namespaces\_options. Omitted components use provider defaults.
>
> **custom\_bucket** `object`
>
> Configuration for [storing data in your own S3-compatible bucket](https://betterstack.com/docs/logs/host-data-in-your-own-bucket/), as an object with the keys below. Nested fields: custom\_bucket.endpoint: The full URL endpoint of the S3-compatible bucket, with no path after the bucket name.  Example: `https://s3.us-east-1.amazonaws.com/storage-bucket`. ; custom\_bucket.access\_key\_id: The access key ID of the key pair that has permissions to access this bucket.; custom\_bucket.secret\_access\_key: The secret access key of the key pair that has permissions to access this bucket.; custom\_bucket.keep\_data\_after\_retention: Whether we should keep data in the bucket after the retention period instead of removing it. Defaults to `false`.
>
> **logs\_retention** `integer`
>
> Custom retention period for logs, in days. This is only available on select plans.
>
> **source\_group\_id** `integer`
>
> The ID of the resource group to assign the collector's associated sources to.
>
> **ingesting\_paused** `boolean`
>
> Set to `true` to create the collector in a paused state, preventing it from ingesting data.
>
> **live\_tail\_pattern** `string`
>
> A custom format for messages displayed in live tail, with columns wrapped in `{column}` brackets.   Example: `"PID: {message_json.pid} {level} {message}"`.   For details, see [Live tail docs](https://betterstack.com/docs/logs/using-logtail/formatting-logs/#live-tail-message-format).
>
> **metrics\_retention** `integer`
>
> Custom retention period for metrics, in days. This is only available on select plans.
>
> **user\_vector\_config** `string`
>
> A custom Vector configuration in YAML format to be merged with the collector's generated configuration.
>
> **source\_vrl\_transformation** `string`
>
> A [VRL program](https://betterstack.com/docs/logs/using-logtail/transforming-ingested-data/logs-vrl/) to be applied to logs server-side during ingestion.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create collector metric target
>
> **Slug:** `BETTER_STACK_CREATE_COLLECTOR_METRIC_TARGET`
>
> ##### Create a collector metric target Creates a new monitoring target on a collector. \[info] Each target kind accepts a specific set of connection fields. Sending a field that does not apply to the chosen kind (for example, `ssl_mode` on a `redis` target) will return a validation error. \[/info] POST /api/v1/collectors/\{collector\_id}/targets Requires a Telemetry API token with access to the resource.
>
> #### Input Parameters
>
> **tls** `string ("false" | "true" | "skip-verify" | "preferred")`
>
> The TLS mode for the connection. Required for `mysql`. Valid options are `false`, `true`, `skip-verify`, and `preferred`.
>
> **host** `string` *required*
>
> The hostname or IP address of the target.
>
> **kind** `string ("postgres" | "mysql" | "redis" | "mongodb" | "memcached" | "elasticsearch" | "nginx" | "apache" | "kafka" | "prometheus")` *required*
>
> The type of target. Valid options are `postgres`, `mysql`, `redis`, `mongodb`, `memcached`, `elasticsearch`, `nginx`, `apache`, `kafka`, and `prometheus`.
>
> **port** `integer`
>
> The port number. Required for database kinds, optional for process kinds.
>
> **scheme** `string ("http" | "https")`
>
> The connection scheme. Only accepted for `elasticsearch`. Valid options are `http` and `https`. Defaults to `http` if omitted.
>
> **api\_key** `string`
>
> An API key for authentication. Only accepted for `elasticsearch`. Write-only - never returned in responses.
>
> **enabled** `boolean`
>
> Set to `false` to create the target in a disabled state. Defaults to `true`.
>
> **service** `string`
>
> The service or container name. Required for `nginx`, `apache`, `kafka`, `prometheus`.
>
> **endpoint** `string`
>
> The full scrape URL, e.g. `http://10.0.0.5:9090/metrics`. Required for `prometheus` targets.
>
> **password** `string`
>
> The password for authentication. Only accepted for databases and `elasticsearch`. Write-only - never returned in responses.
>
> **ssl\_mode** `string ("disable" | "require" | "verify-ca")`
>
> The SSL mode for the connection. Required for `postgres`. Valid options are `disable`, `require`, and `verify-ca`.
>
> **username** `string`
>
> The username for authentication. Only accepted for databases and `elasticsearch`.
>
> **listen\_ip** `string`
>
> The IP address the process listens on. Only accepted for `nginx`, `apache`, and `kafka`.
>
> **collector\_id** `string` *required*
>
> Identifier of the collector.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create connection
>
> **Slug:** `BETTER_STACK_CREATE_CONNECTION`
>
> Create a ClickHouse connection using a global API token, not a team token. The password is returned only in this creation response and cannot be retrieved later. Connections are organization-wide; optionally scope data access with either team\_names or team\_ids, not both. Omit data\_region to create the connection in all regions; private cluster names are also accepted.
>
> #### Input Parameters
>
> **note** `string`
>
> A descriptive note for the connection.
>
> **team\_ids** `array`
>
> Array of team IDs to associate with the connection. Connections are organization-wide, but can be scoped to specific teams for data access control. Only one of `team_names` or `team_ids` should be provided.
>
> **team\_names** `array`
>
> Array of team names to associate with the connection. Connections are organization-wide, but can be scoped to specific teams for data access control. Only one of `team_names` or `team_ids` should be provided.
>
> **client\_type** `string` *required*
>
> Type of client connection. Currently only `clickhouse` is supported.
>
> **data\_region** `string`
>
> Data region or private cluster name to create the connection in.   Permitted values for most plans are: `us_east`, `germany`, `singapore`. Omit to create the connection in all regions.
>
> **valid\_until** `string`
>
> ISO 8601 timestamp when the connection expires.
>
> **ip\_allowlist** `array`
>
> Array of IP addresses or CIDR ranges that are allowed to use this connection.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create dashboard
>
> **Slug:** `BETTER_STACK_CREATE_DASHBOARD`
>
> ##### Create a dashboard Creates a new dashboard, including its variables and other properties. POST /api/v2/dashboards Requires a Telemetry API token with access to the resource.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> The name of the dashboard.
>
> **team\_name** `string`
>
> Required if using a [global API token](https://betterstack.com/docs/logs/api/getting-started/#get-a-global-api-token) to specify which team should own the resource.
>
> **variables** `array`
>
> Custom query variable objects with name, variable\_type, values, default\_values, sql\_definition, and allow\_multiple\_values. sql\_definition is required for select\_with\_sql. allow\_multiple\_values applies to select\_value and select\_with\_sql and defaults to false. Default variables (time, start\_time, end\_time, source) are created automatically if not provided.
>
> **date\_range\_to** `string`
>
> The end of the dashboard's date range.
>
> **date\_range\_from** `string`
>
> The start of the dashboard's date range.
>
> **refresh\_interval** `integer`
>
> Refresh interval in seconds. `0` means no refresh.
>
> **dashboard\_group\_id** `integer`
>
> The ID of a dashboard group to organize this dashboard.
>
> **source\_eligibility\_sql** `string`
>
> An SQL filter determining which sources can be used with this dashboard.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create dashboard alert
>
> **Slug:** `BETTER_STACK_CREATE_DASHBOARD_ALERT`
>
> ##### Create a dashboard alert Creates a new alert for a specific dashboard chart. POST /api/v2/dashboards/\{dashboard\_id}/charts/\{chart\_id}/alerts Requires a Telemetry API token with access to the resource.
>
> #### Input Parameters
>
> **sms** `boolean`
>
> Enable SMS notifications. Only used if `escalation_target` is not a policy.
>
> **call** `boolean`
>
> Enable phone call notifications. Only used if `escalation_target` is not a policy.
>
> **name** `string` *required*
>
> The name of the alert.
>
> **push** `boolean`
>
> Enable push notifications. Only used if `escalation_target` is not a policy.
>
> **email** `boolean`
>
> Enable e-mail notifications. Only used if `escalation_target` is not a policy.
>
> **value** `number`
>
> The numeric value for the alert condition. For `threshold` alerts, this is the static threshold. For `relative` alerts, this is the percentage change. Required for `threshold` and `relative` types unless `string_value` is set. A value of `0` is valid.
>
> **paused** `boolean`
>
> Set to `true` to create the alert in a paused state.
>
> **chart\_id** `integer` *required*
>
> The unique identifier of the chart.
>
> **metadata** `object`
>
> A key-value object for custom metadata to be included in incidents. Both keys and values must be strings. For details, see Metadata.
>
> **operator** `string ("equal" | "not_equal" | "higher_than" | "higher_than_or_equal" | "lower_than" | "lower_than_or_equal" | "increases_by" | "decreases_by" | "changes_by")`
>
> The comparison operator. Required for `threshold` and `relative` alerts. For `threshold`: `equal`, `not_equal`, `higher_than`, `higher_than_or_equal`, `lower_than`, `lower_than_or_equal`. For `relative`: `increases_by`, `decreases_by`, `changes_by`. Not used for `anomaly_rrcf` alerts.
>
> **alert\_type** `string ("threshold" | "relative" | "anomaly_rrcf")` *required*
>
> The type of alert. `threshold` for static values, `relative` for percentage changes, or `anomaly_rrcf` for ML-based anomaly detection.
>
> **source\_mode** `string ("source_variable" | "platforms_single_source" | "platforms_all_sources")`
>
> The mode for source selection. Valid values: `source_variable`, `platforms_single_source`, `platforms_all_sources`.
>
> **check\_period** `integer`
>
> How often to evaluate the alert condition, in seconds. Required for `threshold` and `relative` alert types. Not used for `anomaly_rrcf` alerts.
>
> **dashboard\_id** `integer` *required*
>
> The unique identifier of the dashboard.
>
> **query\_period** `integer`
>
> The time window in seconds for the data being analyzed. If not provided, falls back to `aggregation_interval`, then `check_period`.
>
> **series\_names** `array`
>
> An array of strings to filter the alert to specific data series. Cannot be combined with `series_names_except`. Send an empty array to alert on any series.
>
> **string\_value** `string`
>
> An alternative to `value` for `threshold` alerts when matching an exact string. If `string_value` is set, `value` is not required. Only valid with `equal` or `not_equal` operators.
>
> **incident\_name** `string`
>
> A custom name template for the incident created by this alert, in plain text. Supports the same variables as `incident_cause`, such as `{{alert_name}}` and `{{series_name}}`. When empty, the incident is named after the dashboard and the alert.
>
> **critical\_alert** `boolean`
>
> Enable critical push notifications that bypass Do Not Disturb. Only used if `escalation_target` is not a policy.
>
> **incident\_cause** `string`
>
> A custom description template for the incident created by this alert. Supports `{{value}}` placeholder.
>
> **anomaly\_trigger** `string ("any" | "higher" | "lower")`
>
> Defines which anomalies trigger an alert: `any` (both higher and lower), `higher`, or `lower`. Only for `anomaly_rrcf` alerts.
>
> **on\_missing\_data** `string ("treat_as_zero" | "dont_fire" | "treat_as_previous" | "start_incident")`
>
> What to do when the query returns no data: `treat_as_zero`, `dont_fire`, `treat_as_previous`, or `start_incident`. Only for `threshold` and `relative` alerts. Default: `dont_fire`.
>
> **recovery\_period** `integer`
>
> The duration in seconds that a condition must be resolved before an incident is recovered. A value of `0` recovers the incident immediately, `null` means never automatically recover an incident. Default: `60`.
>
> **source\_variable** `string`
>
> The variable name for the source selection. If not provided, derived automatically from the dashboard preset's source variable.
>
> **source\_platforms** `array`
>
> An array of platform names to filter the sources this alert runs on.
>
> **escalation\_target** `string`
>
> Defines where to send notifications. Defaults to `current_team`, for details see Escalation targets.
>
> **anomaly\_sensitivity** `number`
>
> How far the value must deviate from its predicted value to trigger an alert, from `1` to `10`. Higher values require a larger deviation and trigger fewer alerts. Shown as Significance in the app. Only for `anomaly_rrcf` alerts. Default: `5`.
>
> **confirmation\_period** `integer`
>
> The duration in seconds that a condition must be met before an alert is triggered. A value of `0` triggers the alert immediately. Default: `60`.
>
> **incident\_per\_series** `boolean`
>
> Whether a separate incident will be created for each data series that triggers the alert.
>
> **series\_names\_except** `array`
>
> An array of strings to alert on all data series except the listed ones. Cannot be combined with `series_names`.
>
> **aggregation\_interval** `integer`
>
> The size of data buckets in seconds for aggregating and evaluating the metric. If not provided, falls back to `query_period`, then `check_period`.
>
> **additional\_conditions** `array`
>
> An array of up to 4 additional conditions, each combined with the primary condition using logical AND, so the alert only fires where every condition is breached in the same time bucket. Each condition is an object with an `alert_type` of `threshold` or `relative`, an `operator`, a `value` or `string_value`, and an optional `series_names` or `series_names_except` scope. Anomaly detection cannot be used as an additional condition. Send an empty array to clear all additional conditions. See Multiple conditions for an example.
>
> **anomaly\_training\_range\_days** `integer`
>
> How many days of history the anomaly detection model is trained on, from `1` to `30`. Only for `anomaly_rrcf` alerts. Default: `7`.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create dashboard group
>
> **Slug:** `BETTER_STACK_CREATE_DASHBOARD_GROUP`
>
> ##### Create a dashboard group Creates a new dashboard group for organizing dashboards. POST /api/v2/dashboard-groups Requires a Telemetry API token with access to the resource.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> The name of the dashboard group.
>
> **team\_name** `string`
>
> Required if using a [global API token](https://betterstack.com/docs/logs/api/getting-started/#get-a-global-api-token) to specify which team should own the resource.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create dashboard section
>
> **Slug:** `BETTER_STACK_CREATE_DASHBOARD_SECTION`
>
> ##### Create a dashboard section Creates a new section on a specific dashboard. POST /api/v2/dashboards/\{dashboard\_id}/sections Requires a Telemetry API token with access to the resource.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> The name of the section.
>
> **collapsed** `boolean`
>
> Whether the section should be collapsed by default. Defaults to false at the provider when omitted.
>
> **explanation** `string`
>
> The explanation text shown for the section.
>
> **dashboard\_id** `integer` *required*
>
> The unique identifier of the dashboard.
>
> **vertical\_position** `integer`
>
> The vertical position of the section on the dashboard grid. If omitted, it's placed below all existing items.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Datadog integration
>
> **Slug:** `BETTER_STACK_CREATE_DATADOG_INTEGRATION`
>
> ##### Create Datadog integration Returns either a newly created Datadog integration, or validation errors. POST /api/v2/datadog-integrations Requires a Better Stack Incidents API token with access to the resource.
>
> #### Input Parameters
>
> **sms** `boolean`
>
> Send an SMS to the on-call person.
>
> **call** `boolean`
>
> Call the on-call person.
>
> **name** `string`
>
> The name of the Datadog integration that you can see in the dashboard.
>
> **push** `boolean`
>
> Send a push notification to the on-call person.
>
> **email** `boolean`
>
> Send an e-mail to the on-call person.
>
> **paused** `boolean`
>
> Set to `true` to pause the integration, `false` to unpause it.
>
> **policy\_id** `string`
>
> ID of the escalation policy associated with the Datadog integration.
>
> **team\_name** `string`
>
> Required if using [global API token](https://betterstack.com/docs/uptime/api/getting-started-with-uptime-api/#get-a-global-api-token) to specify the team which should own the resource
>
> **team\_wait** `integer`
>
> How long we wait before escalating the incident alert to the team. In seconds.
>
> **alerting\_rule** `string ("alert" | "alert_and_warn")`
>
> Should we alert only on alarms, or on both alarms and warnings. Possible values: `alert`, `alert_and_warn`. Defaults to `alert`.
>
> **critical\_alert** `boolean`
>
> Send a critical push notification that ignores the mute switch and Do not Disturb mode.
>
> **recovery\_period** `integer`
>
> Has no effect for this integration, since an incident resolves as soon as Datadog reports the alert as resolved.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Elastic integration
>
> **Slug:** `BETTER_STACK_CREATE_ELASTIC_INTEGRATION`
>
> ##### Create Elastic integration Returns either a newly created Elastic integration, or validation errors. POST /api/v2/elastic-integrations Requires a Better Stack Incidents API token with access to the resource.
>
> #### Input Parameters
>
> **sms** `boolean`
>
> Send an SMS to the on-call person.
>
> **call** `boolean`
>
> Call the on-call person.
>
> **name** `string`
>
> The name of the Elastic integration that you can see in the dashboard.
>
> **push** `boolean`
>
> Send a push notification to the on-call person.
>
> **email** `boolean`
>
> Send an e-mail to the on-call person.
>
> **paused** `boolean`
>
> Set to `true` to pause the integration, `false` to unpause it.
>
> **policy\_id** `string`
>
> ID of the escalation policy associated with the Elastic integration.
>
> **team\_name** `string`
>
> Required if using [global API token](https://betterstack.com/docs/uptime/api/getting-started-with-uptime-api/#get-a-global-api-token) to specify the team which should own the resource
>
> **team\_wait** `integer`
>
> How long we wait before escalating the incident alert to the team. In seconds.
>
> **critical\_alert** `boolean`
>
> Send a critical push notification that ignores the mute switch and Do not Disturb mode.
>
> **recovery\_period** `integer`
>
> Has no effect for this integration, since an incident resolves as soon as Elastic reports the alert as resolved.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create email integration
>
> **Slug:** `BETTER_STACK_CREATE_EMAIL_INTEGRATION`
>
> ##### Create e-mail integration Returns either a newly created e-mail integration, or validation errors. POST /api/v2/email-integrations Requires a Better Stack Incidents API token with access to the resource.
>
> #### Input Parameters
>
> **sms** `boolean`
>
> Send an SMS to the on-call person.
>
> **call** `boolean`
>
> Call the on-call person.
>
> **name** `string`
>
> The name of the e-mail integration that you can see in the dashboard.
>
> **push** `boolean`
>
> Send a push notification to the on-call person.
>
> **email** `boolean`
>
> Send an e-mail to the on-call person.
>
> **paused** `boolean`
>
> Set to `true` to pause the integration, `false` to unpause it.
>
> **policy\_id** `string`
>
> ID of the escalation policy for incidents from this integration. Without one, incidents alert the current on-call person through the channels set by `call`, `sms`, `email`, and `push`.
>
> **team\_name** `string`
>
> Required if using [global API token](https://betterstack.com/docs/uptime/api/getting-started-with-uptime-api/#get-a-global-api-token) to specify the team which should own the resource
>
> **team\_wait** `integer`
>
> How long we wait before escalating the incident to the team. In seconds. Send `null` to never escalate to the team, or `0` to alert the whole team right away.
>
> **cause\_field** `object`
>
> How to extract the incident cause from the e-mail that starts an incident, as a field object with the keys below. Defaults to the whole subject. Nested fields: cause\_field.field\_target: Which part of the e-mail to read: `from_email`, `subject`, or `body`.; cause\_field.match\_type: What to extract: `match_everything` takes the whole value, `match_before` the text before `content`, `match_after` the text after `content`, `match_between` the text between `content_before` and `content_after`, and `match_regex` the match of the regular expression in `content`, or its capture group.; cause\_field.content: The text to extract around for `match_before` and `match_after`, or the regular expression for `match_regex`. Required for those three.; cause\_field.content\_before: Where extraction starts for `match_between`. Required for `match_between`.; cause\_field.content\_after: Where extraction stops for `match_between`. Leave it empty to extract to the end.
>
> **title\_field** `object`
>
> How to extract a custom incident title, as a field object with the same keys as `cause_field`. Send `null` to remove it and use the default title.
>
> **started\_rules** `array`
>
> The conditions `started_rule_type` checks, as an array of rule objects with the keys below. At least one rule is required when the type is `any` or `all`. Nested fields: started\_rules\[].rule\_target: Which part of the e-mail the rule checks: `from_email`, `subject`, or `body`.; started\_rules\[].match\_type: How to compare the value with `content`: `contains`, `contains_not`, `equals`, `equals_not`, `matches_regex`, or `matches_regex_not`.; started\_rules\[].content: The value to compare with. Must be a valid regular expression for `matches_regex` and `matches_regex_not`.
>
> **critical\_alert** `boolean`
>
> Send a critical push notification that ignores the mute switch and Do Not Disturb mode.
>
> **resolved\_rules** `array`
>
> The conditions `resolved_rule_type` checks, as rule objects with the same keys as `started_rules`.
>
> **recovery\_period** `integer`
>
> How long to wait after an e-mail matching `resolved_rules` arrives before marking an incident as resolved, in seconds: `0`, `60`, `180`, `300`, `900`, `1800`, `3600`, or `7200`. Has no effect while `resolved_rule_type` is `unused`.
>
> **started\_rule\_type** `string ("unused" | "any" | "all")`
>
> When e-mails start an incident: `unused` always, `any` when at least one of `started_rules` matches, or `all` when all of them match. Defaults to `unused`.
>
> **acknowledged\_rules** `array`
>
> The conditions `acknowledged_rule_type` checks, as rule objects with the same keys as `started_rules`.
>
> **resolved\_rule\_type** `string ("unused" | "any" | "all")`
>
> When e-mails resolve an incident: `unused` never, `any` when at least one of `resolved_rules` matches, or `all` when all of them match. Defaults to `unused`, and any other value requires `started_alert_id_field` and `resolved_alert_id_field`.
>
> **other\_started\_fields** `array`
>
> Extra values to extract when an incident starts, saved as incident metadata. Each field object has the same keys as `cause_field`, plus `name`. Nested fields: other\_started\_fields\[].name: The metadata key to save the extracted value under. Must be unique within the array.
>
> **other\_resolved\_fields** `array`
>
> Extra values to extract when an incident is resolved, with the same keys as `other_started_fields`.
>
> **acknowledged\_rule\_type** `string ("unused" | "any" | "all")`
>
> When e-mails acknowledge an incident: `unused` never, `any` when at least one of `acknowledged_rules` matches, or `all` when all of them match. Defaults to `unused`, and any other value requires `started_alert_id_field` and `acknowledged_alert_id_field`.
>
> **started\_alert\_id\_field** `object`
>
> How to extract the alert ID from the e-mail that starts an incident, with the same keys as `cause_field`; later e-mails acknowledge and resolve the incident by matching it. Required when `acknowledged_rule_type` or `resolved_rule_type` isn't `unused`.
>
> **resolved\_alert\_id\_field** `object`
>
> How to extract the alert ID from an e-mail that resolves an incident, with the same keys as `cause_field`. Required when `resolved_rule_type` isn't `unused`.
>
> **other\_acknowledged\_fields** `array`
>
> Extra values to extract when an incident is acknowledged, with the same keys as `other_started_fields`.
>
> **acknowledged\_alert\_id\_field** `object`
>
> How to extract the alert ID from an e-mail that acknowledges an incident, with the same keys as `cause_field`. Required when `acknowledged_rule_type` isn't `unused`.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Escalation Policy
>
> **Slug:** `BETTER_STACK_CREATE_ESCALATION_POLICY`
>
> Creates a new escalation policy for incident management. Escalation policies define who gets notified and in what order when incidents occur. Supports multiple step types: 'escalation' (notify members), 'instructions' (guidance text), 'time\_branching' (route by schedule), and 'metadata\_branching' (route by incident metadata). For escalation steps, a valid urgency\_id from the Severities API is required.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Name of the escalation policy
>
> **steps** `array` *required*
>
> Ordered list of escalation policy steps
>
> **team\_name** `string`
>
> Team owning the policy (required with global API token)
>
> **repeat\_count** `integer`
>
> How many times to repeat the policy if unacknowledged
>
> **repeat\_delay** `integer`
>
> Seconds to wait between policy repetitions
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create exploration
>
> **Slug:** `BETTER_STACK_CREATE_EXPLORATION`
>
> ##### Create an exploration Creates a new exploration, including its chart, queries, and variables. POST /api/v2/explorations Requires a Telemetry API token with access to the resource.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> The name of the exploration. This is also set as the chart's name.
>
> **chart** `object` *required*
>
> An object defining the chart's type and settings. `chart_type` is required.
>
> **queries** `array` *required*
>
> One or more query objects. Only line\_chart supports multiple queries. query\_type must be sql\_expression (requires sql\_query), tail\_query (requires where\_condition), or static\_text (requires static\_text), compatible with chart\_type. query\_builder, pql\_expression and funnel\_query are read-only and cannot be created.
>
> **team\_name** `string`
>
> Required if using a [global API token](https://betterstack.com/docs/logs/api/getting-started/#get-a-global-api-token) to specify which team should own the resource.
>
> **variables** `array`
>
> An array of custom query variable objects. Default variables (`time`, `start_time`, `end_time`, `source`) are created automatically if not provided.
>
> **date\_range\_to** `string`
>
> The end of the exploration's date range. Defaults to now when omitted.
>
> **date\_range\_from** `string`
>
> The start of the exploration's date range. Defaults to now-3h when omitted.
>
> **exploration\_group\_id** `integer`
>
> The ID of an exploration group to organize this exploration. Use `0` to remove it from a group.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create exploration alert
>
> **Slug:** `BETTER_STACK_CREATE_EXPLORATION_ALERT`
>
> ##### Create an exploration alert Creates a new alert for a specific exploration. POST /api/v2/explorations/\{exploration\_id}/alerts Requires a Telemetry API token with access to the resource.
>
> #### Input Parameters
>
> **sms** `boolean`
>
> Enable SMS notifications. Only used if `escalation_target` is not a policy.
>
> **call** `boolean`
>
> Enable phone call notifications. Only used if `escalation_target` is not a policy.
>
> **name** `string` *required*
>
> The name of the alert.
>
> **push** `boolean`
>
> Enable push notifications. Only used if `escalation_target` is not a policy.
>
> **email** `boolean`
>
> Enable e-mail notifications. Only used if `escalation_target` is not a policy.
>
> **value** `number`
>
> The numeric value for the alert condition. For `threshold` alerts, this is the static threshold. For `relative` alerts, this is the percentage change. Required for `threshold` and `relative` types unless `string_value` is set. A value of `0` is valid.
>
> **paused** `boolean`
>
> Set to `true` to create the alert in a paused state.
>
> **metadata** `object`
>
> A key-value object for custom metadata to be included in incidents. Both keys and values must be strings. For details, see Metadata.
>
> **operator** `string ("equal" | "not_equal" | "higher_than" | "higher_than_or_equal" | "lower_than" | "lower_than_or_equal" | "increases_by" | "decreases_by" | "changes_by")`
>
> The comparison operator. Required for `threshold` and `relative` alerts. For `threshold`: `equal`, `not_equal`, `higher_than`, `higher_than_or_equal`, `lower_than`, `lower_than_or_equal`. For `relative`: `increases_by`, `decreases_by`, `changes_by`. Not used for `anomaly_rrcf` alerts.
>
> **alert\_type** `string ("threshold" | "relative" | "anomaly_rrcf")` *required*
>
> The type of alert. `threshold` for static values, `relative` for percentage changes, and `anomaly_rrcf` for ML-based anomaly detection.
>
> **source\_mode** `string ("source_variable" | "platforms_single_source" | "platforms_all_sources")`
>
> The mode for source selection. Valid values: `source_variable`, `platforms_single_source`, `platforms_all_sources`.
>
> **check\_period** `integer`
>
> How often to evaluate the alert condition, in seconds. Required for `threshold` and `relative` alert types. Not used for `anomaly_rrcf` alerts.
>
> **query\_period** `integer`
>
> The time window in seconds for the data being analyzed. If not provided, falls back to `aggregation_interval`, then `check_period`.
>
> **series\_names** `array`
>
> An array of strings to filter the alert to specific data series. Cannot be combined with `series_names_except`. Send an empty array to alert on any series.
>
> **string\_value** `string`
>
> An alternative to `value` for `threshold` alerts when matching an exact string. If `string_value` is set, `value` is not required. Only valid with `equal` or `not_equal` operators.
>
> **incident\_name** `string`
>
> A custom name template for the incident created by this alert, in plain text. Supports the same variables as `incident_cause`, such as `{{alert_name}}` and `{{series_name}}`. When empty, the incident is named after the exploration and the alert.
>
> **critical\_alert** `boolean`
>
> Enable critical push notifications that bypass Do Not Disturb. Only used if `escalation_target` is not a policy.
>
> **exploration\_id** `integer` *required*
>
> The unique identifier of the exploration to add the alert to.
>
> **incident\_cause** `string`
>
> A custom description template for the incident created by this alert. Supports `{{value}}` placeholder.
>
> **anomaly\_trigger** `string ("any" | "higher" | "lower")`
>
> Defines which anomalies trigger an alert: `any` (both higher and lower), `higher`, or `lower`. Only for `anomaly_rrcf` alerts.
>
> **on\_missing\_data** `string ("treat_as_zero" | "dont_fire" | "treat_as_previous" | "start_incident")`
>
> What to do when the query returns no data: `treat_as_zero`, `dont_fire`, `treat_as_previous`, or `start_incident`. Only for `threshold` and `relative` alerts. Default: `dont_fire`.
>
> **recovery\_period** `integer`
>
> The duration in seconds that a condition must be resolved before an incident is recovered. A value of `0` recovers the incident immediately, `null` means never automatically recover an incident. Default: `60`.
>
> **source\_variable** `string`
>
> The variable name for the source selection. If not provided, derived automatically from the exploration preset's source variable.
>
> **source\_platforms** `array`
>
> An array of platform names to filter the sources this alert runs on.
>
> **escalation\_target** `string`
>
> Defines where to send notifications. Defaults to `current_team`, for details see Escalation targets.
>
> **anomaly\_sensitivity** `number`
>
> How far the value must deviate from its predicted value to trigger an alert, from `1` to `10`. Higher values require a larger deviation and trigger fewer alerts. Shown as Significance in the app. Only for `anomaly_rrcf` alerts. Default: `5`.
>
> **confirmation\_period** `integer`
>
> The duration in seconds that a condition must be met before an alert is triggered. A value of `0` triggers the alert immediately. Default: `60`.
>
> **incident\_per\_series** `boolean`
>
> Whether a separate incident will be created for each data series that triggers the alert.
>
> **series\_names\_except** `array`
>
> An array of strings to alert on all data series except the listed ones. Cannot be combined with `series_names`.
>
> **aggregation\_interval** `integer`
>
> The size of data buckets in seconds for aggregating and evaluating the metric. If not provided, falls back to `query_period`, then `check_period`.
>
> **additional\_conditions** `array`
>
> An array of up to 4 additional conditions, each combined with the primary condition using logical AND, so the alert only fires where every condition is breached in the same time bucket. Each condition is an object with an `alert_type` of `threshold` or `relative`, an `operator`, a `value` or `string_value`, and an optional `series_names` or `series_names_except` scope. Anomaly detection cannot be used as an additional condition. Send an empty array to clear all additional conditions. See Multiple conditions for an example.
>
> **anomaly\_training\_range\_days** `integer`
>
> How many days of history the anomaly detection model is trained on, from `1` to `30`. Only for `anomaly_rrcf` alerts. Default: `7`.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create exploration group
>
> **Slug:** `BETTER_STACK_CREATE_EXPLORATION_GROUP`
>
> ##### Create an exploration group Creates a new exploration group for organizing explorations. POST /api/v2/exploration-groups Requires a Telemetry API token with access to the resource.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> The name of the exploration group.
>
> **team\_name** `string`
>
> Required if using a [global API token](https://betterstack.com/docs/logs/api/getting-started/#get-a-global-api-token) to specify which team should own the resource.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Google Monitoring integration
>
> **Slug:** `BETTER_STACK_CREATE_GOOGLE_MONITORING_INTEGRATION`
>
> ##### Create Google Monitoring integration Returns either a newly created Google Monitoring integration, or validation errors. POST /api/v2/google-monitoring-integrations Requires a Better Stack Incidents API token with access to the resource.
>
> #### Input Parameters
>
> **sms** `boolean`
>
> Send an SMS to the on-call person.
>
> **call** `boolean`
>
> Call the on-call person.
>
> **name** `string`
>
> The name of the Google Monitoring integration that you can see in the dashboard.
>
> **push** `boolean`
>
> Send a push notification to the on-call person.
>
> **email** `boolean`
>
> Send an e-mail to the on-call person.
>
> **paused** `boolean`
>
> Set to `true` to pause the integration, `false` to unpause it.
>
> **policy\_id** `string`
>
> ID of the escalation policy associated with the Google Monitoring integration.
>
> **team\_name** `string`
>
> Required if using [global API token](https://betterstack.com/docs/uptime/api/getting-started-with-uptime-api/#get-a-global-api-token) to specify the team which should own the resource
>
> **team\_wait** `integer`
>
> How long we wait before escalating the incident alert to the team. In seconds.
>
> **critical\_alert** `boolean`
>
> Send a critical push notification that ignores the mute switch and Do not Disturb mode.
>
> **recovery\_period** `integer`
>
> Has no effect for this integration, since an incident resolves as soon as Google Monitoring reports the alert as resolved.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Grafana integration
>
> **Slug:** `BETTER_STACK_CREATE_GRAFANA_INTEGRATION`
>
> ##### Create Grafana integration Returns either a newly created Grafana integration, or validation errors. POST /api/v2/grafana-integrations Requires a Better Stack Incidents API token with access to the resource.
>
> #### Input Parameters
>
> **sms** `boolean`
>
> Send an SMS to the on-call person.
>
> **call** `boolean`
>
> Call the on-call person.
>
> **name** `string`
>
> The name of the Grafana integration that you can see in the dashboard.
>
> **push** `boolean`
>
> Send a push notification to the on-call person.
>
> **email** `boolean`
>
> Send an e-mail to the on-call person.
>
> **paused** `boolean`
>
> Set to `true` to pause the integration, `false` to unpause it.
>
> **policy\_id** `string`
>
> ID of the escalation policy associated with the Grafana integration.
>
> **team\_name** `string`
>
> Required if using [global API token](https://betterstack.com/docs/uptime/api/getting-started-with-uptime-api/#get-a-global-api-token) to specify the team which should own the resource
>
> **team\_wait** `integer`
>
> How long we wait before escalating the incident alert to the team. In seconds.
>
> **critical\_alert** `boolean`
>
> Send a critical push notification that ignores the mute switch and Do not Disturb mode.
>
> **recovery\_period** `integer`
>
> Has no effect for this integration, since an incident resolves as soon as Grafana reports the alert as resolved.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Heartbeat
>
> **Slug:** `BETTER_STACK_CREATE_HEARTBEAT`
>
> Tool to create a new heartbeat monitor for cron jobs and scheduled tasks. Use when you need to set up monitoring for a service that should send regular heartbeat signals.
>
> #### Input Parameters
>
> **sms** `boolean`
>
> Should we send an SMS to the on-call person?
>
> **call** `boolean`
>
> Should we call the on-call person?
>
> **name** `string`
>
> The name of the service for this heartbeat
>
> **push** `boolean`
>
> Should we send a push notification to the on-call person?
>
> **email** `boolean`
>
> Should we send an email to the on-call person?
>
> **grace** `integer`
>
> Grace period for heartbeat fluctuation in seconds. Minimum value: 0. Recommended: 20% of period
>
> **paused** `boolean`
>
> Set to true to pause monitoring
>
> **period** `integer`
>
> How often should we expect this heartbeat in seconds. Minimum value: 30 seconds
>
> **team\_name** `string`
>
> Required if using global API token to specify the team which should own the resource
>
> **heartbeat\_group\_id** `integer`
>
> Set this attribute to add this heartbeat to a heartbeat group
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Heartbeat Group
>
> **Slug:** `BETTER_STACK_CREATE_HEARTBEAT_GROUP`
>
> Tool to create a new heartbeat group. Use when you need to organize related heartbeat checks under a single, logical group. Example prompt: "Create a new heartbeat group named 'Backend services'."
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Name of the group visible in the dashboard.
>
> **paused** `boolean`
>
> Set to true to pause monitoring for all existing heartbeats in the group; false (default) to resume monitoring.
>
> **team\_name** `string`
>
> Team which should own the resource. Required when using a global API token.
>
> **sort\_index** `integer`
>
> Zero-based index to control sort order of heartbeat groups.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Incident
>
> **Slug:** `BETTER_STACK_CREATE_INCIDENT`
>
> Tool to create a new incident and alert the on-call person. Use when you need to manually report an incident or trigger escalation workflows. The incident will be routed according to the specified escalation policy or default team settings.
>
> #### Input Parameters
>
> **sms** `boolean`
>
> Send SMS notification to on-call person
>
> **call** `boolean`
>
> Trigger phone call to on-call person
>
> **name** `string`
>
> Short incident title
>
> **email** `boolean`
>
> Send email notification to on-call person
>
> **summary** `string`
>
> Brief incident overview
>
> **metadata** `object`
>
> Custom metadata with key-value pairs for incident classification and routing
>
> **policy\_id** `string`
>
> Escalation policy identifier for routing the incident
>
> **team\_name** `string`
>
> Team owning the incident (required when using global API token)
>
> **team\_wait** `integer`
>
> Escalation delay in seconds before alerting entire team. Leave blank to disable team escalation.
>
> **description** `string`
>
> Detailed incident information
>
> **critical\_alert** `boolean`
>
> Send critical push notification that ignores mute switch and Do Not Disturb settings
>
> **requester\_email** `string`
>
> Email of user requesting the incident
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Incident Comment
>
> **Slug:** `BETTER_STACK_CREATE_INCIDENT_COMMENT`
>
> Tool to create a new comment on an incident. Use when you need to add documentation, updates, or notes to an existing incident in Better Stack.
>
> #### Input Parameters
>
> **content** `string` *required*
>
> The content of the comment. Markdown is supported for formatting.
>
> **incident\_id** `string` *required*
>
> The ID of the incident to add the comment to
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create incoming webhook
>
> **Slug:** `BETTER_STACK_CREATE_INCOMING_WEBHOOK`
>
> ##### Create incoming webhook Returns either a newly created incoming webhook, or validation errors. POST /api/v2/incoming-webhooks Requires a Better Stack Incidents API token with access to the resource.
>
> #### Input Parameters
>
> **sms** `boolean`
>
> Send an SMS to the on-call person.
>
> **call** `boolean`
>
> Call the on-call person.
>
> **name** `string`
>
> The name of the incoming webhook that you can see in the dashboard.
>
> **push** `boolean`
>
> Send a push notification to the on-call person.
>
> **email** `boolean`
>
> Send an e-mail to the on-call person.
>
> **paused** `boolean`
>
> Set to `true` to pause the integration, `false` to unpause it.
>
> **policy\_id** `string`
>
> ID of the escalation policy for incidents from this integration. Without one, incidents alert the current on-call person through the channels set by `call`, `sms`, `email`, and `push`.
>
> **team\_name** `string`
>
> Required if using [global API token](https://betterstack.com/docs/uptime/api/getting-started-with-uptime-api/#get-a-global-api-token) to specify the team which should own the resource
>
> **team\_wait** `integer`
>
> How long we wait before escalating the incident to the team. In seconds. Send `null` to never escalate to the team, or `0` to alert the whole team right away.
>
> **cause\_field** `object`
>
> Incident cause extraction object; omitted means Unknown cause. Required string keys: field\_target (query\_string, header, body, json, xml) and match\_type (match\_everything, match\_before, match\_after, match\_between, match\_regex). target\_field: dot path such as alert.id for json/query\_string, header name for header, or CSS selector for xml; unused for body. match\_everything takes the whole value. match\_before/match\_after require string content and extract text before/after it. match\_regex requires a regex in content and extracts its match or capture group. match\_between requires string content\_before and content\_after delimiters.
>
> **title\_field** `object`
>
> How to extract a custom incident title, as a field object with the same keys as `cause_field`. Send `null` to remove it and use the default title.
>
> **started\_rules** `array`
>
> The conditions `started_rule_type` checks, as an array of rule objects with the keys below. At least one rule is required when the type is `any` or `all`. Nested fields: started\_rules\[].rule\_target: Which part of the request the rule checks: `query_string`, `header`, `body`, `json`, or `xml`.; started\_rules\[].target\_field: Which value to read: a dot-separated path such as `alert.id` for `json` and `query_string`, a header name for `header`, or a CSS selector for `xml`. Not used with `body`.; started\_rules\[].match\_type: How to compare the value with `content`: `contains`, `contains_not`, `equals`, `equals_not`, `matches_regex`, or `matches_regex_not`.; started\_rules\[].content: The value to compare with. Must be a valid regular expression for `matches_regex` and `matches_regex_not`.
>
> **critical\_alert** `boolean`
>
> Send a critical push notification that ignores the mute switch and Do Not Disturb mode.
>
> **resolved\_rules** `array`
>
> The conditions `resolved_rule_type` checks, as rule objects with the same keys as `started_rules`.
>
> **recovery\_period** `integer ("0" | "60" | "180" | "300" | "900" | "1800" | "3600" | "7200")`
>
> How long to wait after a request matching `resolved_rules` arrives before marking an incident as resolved, in seconds: `0`, `60`, `180`, `300`, `900`, `1800`, `3600`, or `7200`. Has no effect while `resolved_rule_type` is `unused`.
>
> **started\_rule\_type** `string ("unused" | "any" | "all")`
>
> When requests start an incident: `unused` always, `any` when at least one of `started_rules` matches, or `all` when all of them match. Defaults to `unused`.
>
> **acknowledged\_rules** `array`
>
> The conditions `acknowledged_rule_type` checks, as rule objects with the same keys as `started_rules`.
>
> **resolved\_rule\_type** `string ("unused" | "any" | "all")`
>
> When requests resolve an incident: `unused` never, `any` when at least one of `resolved_rules` matches, or `all` when all of them match. Defaults to `unused`, and any other value requires `started_alert_id_field` and `resolved_alert_id_field`.
>
> **other\_started\_fields** `array`
>
> Extra values to extract when an incident starts, saved as incident metadata. Each field object has the same keys as `cause_field`, plus `name`. Nested fields: other\_started\_fields\[].name: The metadata key to save the extracted value under. Must be unique within the array.
>
> **other\_resolved\_fields** `array`
>
> Extra values to extract when an incident is resolved, with the same keys as `other_started_fields`.
>
> **acknowledged\_rule\_type** `string ("unused" | "any" | "all")`
>
> When requests acknowledge an incident: `unused` never, `any` when at least one of `acknowledged_rules` matches, or `all` when all of them match. Defaults to `unused`, and any other value requires `started_alert_id_field` and `acknowledged_alert_id_field`.
>
> **started\_alert\_id\_field** `object`
>
> How to extract the alert ID from the request that starts an incident, with the same keys as `cause_field`; later requests acknowledge and resolve the incident by matching it. Required when `acknowledged_rule_type` or `resolved_rule_type` isn't `unused`.
>
> **resolved\_alert\_id\_field** `object`
>
> How to extract the alert ID from a request that resolves an incident, with the same keys as `cause_field`. Required when `resolved_rule_type` isn't `unused`.
>
> **other\_acknowledged\_fields** `array`
>
> Extra values to extract when an incident is acknowledged, with the same keys as `other_started_fields`.
>
> **acknowledged\_alert\_id\_field** `object`
>
> How to extract the alert ID from a request that acknowledges an incident, with the same keys as `cause_field`. Required when `acknowledged_rule_type` isn't `unused`.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Metadata
>
> **Slug:** `BETTER_STACK_CREATE_METADATA`
>
> Tool to create or update a metadata record for a resource. Metadata provides key-value associations for resources like monitors, heartbeats, or incidents. Use when you need to tag or annotate resources with custom data. Existing values for the specified key will be completely replaced.
>
> #### Input Parameters
>
> **key** `string` *required*
>
> The metadata key identifier. This serves as the name for the metadata entry
>
> **values** `array` *required*
>
> Array of metadata values to associate with the key. Existing values for the given key will be completely replaced
>
> **owner\_id** `string` *required*
>
> The ID of the resource to update metadata for
>
> **owner\_type** `string ("Monitor" | "Heartbeat" | "Incident" | "WebhookIntegration" | "EmailIntegration" | "IncomingWebhook" | "CallRouting")` *required*
>
> Type of resource that owns this metadata. Must be one of: Monitor, Heartbeat, Incident, WebhookIntegration, EmailIntegration, IncomingWebhook, or CallRouting
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create metric
>
> **Slug:** `BETTER_STACK_CREATE_METRIC`
>
> ##### Create a metric Returns a newly created metric or label. POST /api/v2/sources/\{source\_id}/metrics Requires a Telemetry API token with access to the resource.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Metric name
>
> **source\_id** `integer` *required*
>
> Source for which to create a metric
>
> **team\_name** `string`
>
> Required if using [global API token](https://betterstack.com/docs/logs/api/getting-started/#get-a-global-api-token) to specify the team which should own the resource
>
> **aggregations** `array`
>
> Aggregations to apply to the metric. Omit or send an empty array to create a label instead. Valid aggregations are `avg`, `count`, `uniq`, `max`, `min`, `sum`, and `histogram`.
>
> **sql\_expression** `string` *required*
>
> SQL expression to use for the metric
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Monitor
>
> **Slug:** `BETTER_STACK_CREATE_MONITOR`
>
> Tool to create a new uptime monitor for a URL or service. Use when you need to set up monitoring for websites, APIs, servers, or network services. Supports multiple monitor types including HTTP/HTTPS status checks, keyword monitoring, ping, TCP/UDP, email protocols, DNS queries, and browser automation with Playwright.
>
> #### Input Parameters
>
> **sms** `boolean`
>
> Enable SMS notifications when monitor goes down or recovers. Default is false.
>
> **url** `string` *required*
>
> The URL or host to monitor. For HTTP/HTTPS monitors use full URL with protocol. For TCP/UDP/SMTP/POP/IMAP use hostname or IP. For DNS monitors use the domain to query.
>
> **call** `boolean`
>
> Enable phone call alerts when monitor goes down or recovers. Default is false.
>
> **port** `string`
>
> Port number for TCP, UDP, SMTP, POP, or IMAP monitors. Required for these monitor types.
>
> **push** `boolean`
>
> Enable push notifications when monitor goes down or recovers. Default is false.
>
> **email** `boolean`
>
> Enable email notifications when monitor goes down or recovers. Default is false.
>
> **paused** `boolean`
>
> If true, the monitor is created in paused state and will not perform checks. Default is false.
>
> **regions** `array`
>
> List of regions from which to perform checks. Available: us (United States), eu (Europe), as (Asia), au (Australia). Default is all regions.
>
> **policy\_id** `string`
>
> ID of the escalation policy to use for this monitor. Controls who gets notified and in what order.
>
> **team\_name** `string`
>
> Team which should own this monitor. Required when using a global API token.
>
> **team\_wait** `integer`
>
> Seconds to wait before escalating to the team after first notification. Default is 0 (notify team immediately).
>
> **verify\_ssl** `boolean`
>
> Verify SSL certificates for HTTPS monitors. If false, monitors will accept invalid/self-signed certificates. Default is true.
>
> **http\_method** `string ("GET" | "HEAD" | "POST" | "PUT" | "PATCH")`
>
> HTTP method for status/keyword monitors.
>
> **monitor\_type** `string ("status" | "expected_status_code" | "keyword" | "keyword_absence" | "ping" | "tcp" | "udp" | "smtp" | "pop" | "imap" | "dns" | "playwright")` *required*
>
> Type of monitor: status (HTTP/HTTPS), expected\_status\_code, keyword, keyword\_absence, ping (ICMP), tcp, udp, smtp, pop, imap, dns, or playwright (browser automation).
>
> **request\_body** `string`
>
> Body content to send with POST/PUT/PATCH requests. Required for DNS monitors (specify the DNS record type to query).
>
> **auth\_password** `string`
>
> Password for HTTP Basic Authentication. Used with auth\_username.
>
> **auth\_username** `string`
>
> Username for HTTP Basic Authentication. Used with auth\_password.
>
> **scenario\_name** `string`
>
> Name identifier for playwright monitor scenarios. Used to distinguish between different automation scripts.
>
> **critical\_alert** `boolean`
>
> If enabled, alerts will override Do Not Disturb settings and mute schedules. Use for critical monitors only.
>
> **maintenance\_to** `string`
>
> End time of daily maintenance window in HH:MM:SS format. Checks resume after this time.
>
> **check\_frequency** `integer`
>
> How often to check the monitor in seconds. Minimum is 30 seconds. Default is 30.
>
> **recovery\_period** `integer`
>
> Number of seconds the monitor must be up before automatically resolving any open incidents. Default is 0 (resolve immediately).
>
> **request\_timeout** `integer`
>
> Request timeout in seconds. For server monitors this is in milliseconds. Default varies by monitor type.
>
> **follow\_redirects** `boolean`
>
> Automatically follow HTTP redirects when checking status/keyword monitors. Default is false.
>
> **maintenance\_days** `array`
>
> Days of the week to skip monitoring checks during maintenance windows. Combine with maintenance\_from and maintenance\_to.
>
> **maintenance\_from** `string`
>
> Start time of daily maintenance window in HH:MM:SS format. Checks are skipped during this window on specified maintenance\_days.
>
> **monitor\_group\_id** `string`
>
> ID of the monitor group to assign this monitor to. Used for organizing monitors.
>
> **required\_keyword** `string`
>
> For keyword monitors: the text that must be present in the response. For keyword\_absence monitors: the text that must NOT be present.
>
> **playwright\_script** `string`
>
> JavaScript code for playwright monitor type. Defines browser automation scenario to execute during checks.
>
> **pronounceable\_name** `string` *required*
>
> Human-readable name for the monitor displayed in the dashboard.
>
> **confirmation\_period** `integer`
>
> How long in seconds to observe failures before creating an incident. Helps avoid false alerts from transient issues. Default is 0.
>
> **expiration\_policy\_id** `integer`
>
> ID of the escalation policy for SSL certificate and domain expiration alerts.
>
> **maintenance\_timezone** `string`
>
> Timezone for maintenance window times. Use IANA timezone database names.
>
> **environment\_variables** `object`
>
> Key-value pairs of environment variables accessible within playwright scripts. Useful for parameterizing automation scenarios.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Monitor Group
>
> **Slug:** `BETTER_STACK_CREATE_MONITOR_GROUP`
>
> Tool to create a new monitor group. Use when you need to organize related monitors under a single, logical group for better dashboard organization.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> The display name for the monitor group visible in the dashboard
>
> **paused** `boolean`
>
> When true, monitoring pauses for existing group monitors; false resumes monitoring
>
> **team\_name** `string`
>
> Required only when using a global API token to specify resource ownership
>
> **sort\_index** `integer`
>
> Numeric value controlling monitor group sort order
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create New Relic integration
>
> **Slug:** `BETTER_STACK_CREATE_NEW_RELIC_INTEGRATION`
>
> ##### Create New Relic integration Returns either a newly created New Relic integration, or validation errors. POST /api/v2/new-relic-integrations Requires a Better Stack Incidents API token with access to the resource.
>
> #### Input Parameters
>
> **sms** `boolean`
>
> Send an SMS to the on-call person.
>
> **call** `boolean`
>
> Call the on-call person.
>
> **name** `string`
>
> The name of the New Relic integration that you can see in the dashboard.
>
> **push** `boolean`
>
> Send a push notification to the on-call person.
>
> **email** `boolean`
>
> Send an e-mail to the on-call person.
>
> **paused** `boolean`
>
> Set to `true` to pause the integration, `false` to unpause it.
>
> **policy\_id** `string`
>
> ID of the escalation policy associated with the New Relic integration.
>
> **team\_name** `string`
>
> Required if using [global API token](https://betterstack.com/docs/uptime/api/getting-started-with-uptime-api/#get-a-global-api-token) to specify the team which should own the resource
>
> **team\_wait** `integer`
>
> How long we wait before escalating the incident alert to the team. In seconds.
>
> **alerting\_rule** `string ("alert" | "alert_and_warn")`
>
> Should we alert only on alarms, or on both alarms and warnings. Possible values: `alert`, `alert_and_warn`. Defaults to `alert`.
>
> **critical\_alert** `boolean`
>
> Send a critical push notification that ignores the mute switch and Do not Disturb mode.
>
> **recovery\_period** `integer`
>
> Has no effect for this integration, since an incident resolves as soon as New Relic reports the alert as resolved.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create on-call event
>
> **Slug:** `BETTER_STACK_CREATE_ON_CALL_EVENT`
>
> ##### Create an on-call schedule event Create a new event in the given on-call schedule. POST /api/v2/on-calls/\{schedule\_id}/events Requires a Better Stack Incidents API token with access to the resource.
>
> #### Input Parameters
>
> **users** `array` *required*
>
> List of e-mail addresses of users that will be on-call during this event. Each user must be a member of the schedule's team with a role that can respond to incidents, such as Responder.
>
> **ends\_at** `string` *required*
>
> End time of the event as an ISO 8601 date-time.
>
> **override** `boolean`
>
> Whether this event is an override. Override events take precedence over regular scheduled events. Defaults to `false`.
>
> **starts\_at** `string` *required*
>
> Start time of the event as an ISO 8601 date-time. Must be today at 0:00 UTC or later.
>
> **schedule\_id** `string` *required*
>
> The ID of the on-call schedule you want to create the event for. Use `default` to refer to the default on-call schedule for the team.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create On-Call Schedule
>
> **Slug:** `BETTER_STACK_CREATE_ON_CALL_SCHEDULE`
>
> Tool to create a new on-call schedule. Use when you need to set up a new on-call calendar for managing team rotations.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> The identifier for the on-call schedule
>
> **team\_name** `string`
>
> Team which should own the resource. Required when using a global API token.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create outgoing email
>
> **Slug:** `BETTER_STACK_CREATE_OUTGOING_EMAIL`
>
> ##### Create outgoing e-mail Returns either a newly created outgoing e-mail integration, or validation errors. See the [outgoing e-mails guide](https://betterstack.com/docs/uptime/integrations/integrating-with-better-uptime/outgoing-emails/) for the dashboard walkthrough. POST /api/v2/outgoing-emails Requires a Better Stack Incidents API token with access to the resource.
>
> #### Input Parameters
>
> **name** `string`
>
> The name of the outgoing e-mail integration that you can see in the dashboard.
>
> **team\_name** `string`
>
> Required if using a [global API token](https://betterstack.com/docs/uptime/api/getting-started-with-uptime-api/#get-a-global-api-token) to specify the team which should own the resource.
>
> **templates** `array`
>
> Per-event template objects with incident\_stage (started, acknowledged, resolved, reopened, comment) and optional subject, title, body strings. Empty fields use default copy. Supports \$NAME, \$STATUS, \$CAUSE, \$INCIDENT\_URL, \$RECIPIENT.\<key>, \$METADATA.Key and \$METADATA\_ARRAY. Example: \[\{"incident\_stage":"started","subject":"Incident: \$NAME"}]. Included stages are created/updated; omitted stages are removed. Omit templates entirely to leave existing templates untouched.
>
> **recipients** `array` *required*
>
> The addresses that receive incident e-mails. At least one recipient is required. Each entry is either a plain e-mail string, or an object with an `email` key plus your own custom attribute keys, which you can insert into templates with `$RECIPIENT.<key>`.  `json [label Plain strings and objects can be mixed] {   "recipients": [     "noc@client.com",     { "email": "ops@client.com", "first_name": "Sam", "team": "SRE" }   ] } `
>
> **on\_incident\_comment** `boolean`
>
> Whether to send an e-mail when a new comment is added to an incident. Defaults to `true`. At least one of the `on_incident_*` triggers must be enabled.
>
> **on\_incident\_started** `boolean`
>
> Whether to send an e-mail when an incident starts. Defaults to `true`.
>
> **on\_incident\_reopened** `boolean`
>
> Whether to send an e-mail when an incident is reopened. Defaults to `true`.
>
> **on\_incident\_resolved** `boolean`
>
> Whether to send an e-mail when an incident is resolved. Defaults to `true`.
>
> **on\_incident\_acknowledged** `boolean`
>
> Whether to send an e-mail when an incident is acknowledged. Defaults to `true`.
>
> **notify\_alongside\_primary\_responder** `boolean`
>
> Whether to notify recipients alongside the primary responder when no escalation policy is configured. Defaults to `true`.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Outgoing Webhook Integration
>
> **Slug:** `BETTER_STACK_CREATE_OUTGOING_WEBHOOK`
>
> Tool to create a new outgoing webhook integration. Use when you need to register an endpoint to receive event notifications from Better Stack.
>
> #### Input Parameters
>
> **url** `string` *required*
>
> The endpoint URL of the outgoing webhook integration.
>
> **name** `string` *required*
>
> The name of the outgoing webhook integration.
>
> **team\_name** `string`
>
> Required if using a global API token to specify the team which should own the resource.
>
> **trigger\_type** `string ("on_call_change" | "incident_change" | "monitor_change")` *required*
>
> The type of event that triggers the webhook.
>
> **on\_incident\_started** `boolean`
>
> Trigger when an incident starts (only if trigger\_type is 'incident\_change').
>
> **on\_incident\_resolved** `boolean`
>
> Trigger when an incident is resolved (only if trigger\_type is 'incident\_change').
>
> **on\_incident\_acknowledged** `boolean`
>
> Trigger when an incident is acknowledged (only if trigger\_type is 'incident\_change').
>
> **custom\_webhook\_template\_attributes** `object`
>
> Custom webhook template attributes such as HTTP method, headers, and body.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create PagerDuty integration
>
> **Slug:** `BETTER_STACK_CREATE_PAGERDUTY_INTEGRATION`
>
> ##### Create PagerDuty integration Returns either a newly created PagerDuty integration, or validation errors. POST /api/v2/pager-duty-webhooks Requires a Better Stack Incidents API token with access to the resource.
>
> #### Input Parameters
>
> **key** `string` *required*
>
> The PagerDuty routing key.
>
> **name** `string` *required*
>
> The name of the PagerDuty integration that you can see in the dashboard.
>
> **severity** `string ("info" | "warning" | "error" | "critical")` *required*
>
> The severity of PagerDuty alerts created for new incidents.
>
> **team\_name** `string`
>
> Required if using [global API token](https://betterstack.com/docs/uptime/api/getting-started-with-uptime-api/#get-a-global-api-token) to specify the team which should own the resource
>
> **notify\_alongside\_primary\_responder** `boolean`
>
> Whether to notify this integration alongside the primary responder when no escalation policy is configured. Defaults to `true`.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Escalation Policy Group
>
> **Slug:** `BETTER_STACK_CREATE_POLICY_GROUP`
>
> Tool to create a new escalation policy group. Use when you need to organize related escalation policies under a single logical group.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> The name of the group that you can see in the dashboard
>
> **team\_name** `string`
>
> Required only when using a global API token to designate the owning team
>
> **sort\_index** `integer`
>
> Specifies the ordering sequence for escalation policy groups
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Prometheus integration
>
> **Slug:** `BETTER_STACK_CREATE_PROMETHEUS_INTEGRATION`
>
> ##### Create Prometheus integration Returns either a newly created Prometheus integration, or validation errors. POST /api/v2/prometheus-integrations Requires a Better Stack Incidents API token with access to the resource.
>
> #### Input Parameters
>
> **sms** `boolean`
>
> Send an SMS to the on-call person.
>
> **call** `boolean`
>
> Call the on-call person.
>
> **name** `string`
>
> The name of the Prometheus integration that you can see in the dashboard.
>
> **push** `boolean`
>
> Send a push notification to the on-call person.
>
> **email** `boolean`
>
> Send an e-mail to the on-call person.
>
> **paused** `boolean`
>
> Set to `true` to pause the integration, `false` to unpause it.
>
> **policy\_id** `string`
>
> ID of the escalation policy associated with the Prometheus integration.
>
> **team\_name** `string`
>
> Required if using [global API token](https://betterstack.com/docs/uptime/api/getting-started-with-uptime-api/#get-a-global-api-token) to specify the team which should own the resource
>
> **team\_wait** `integer`
>
> How long we wait before escalating the incident alert to the team. In seconds.
>
> **critical\_alert** `boolean`
>
> Send a critical push notification that ignores the mute switch and Do not Disturb mode.
>
> **recovery\_period** `integer`
>
> Has no effect for this integration, since an incident resolves as soon as Prometheus reports the alert as resolved.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create schedule rotation
>
> **Slug:** `BETTER_STACK_CREATE_SCHEDULE_ROTATION`
>
> ##### Create an on-call schedule rotation Creates an on-call rotation. This creates consecutive on-call events for specified users, rotating through them until reaching the end date, and removes any existing non-override events within this range. Without `working_hours`, this only creates events that end after 0:00 UTC today. With `working_hours`, it creates events from now on, only inside the given windows. POST /api/v2/on-calls/\{schedule\_id}/rotation Requires a Better Stack Incidents API token with access to the resource.
>
> #### Input Parameters
>
> **users** `array` *required*
>
> List of e-mail addresses of users to include in the on-call rotation schedule
>
> **timezone** `string`
>
> Time zone the rotation's start time and working hours are interpreted in, for example `Europe/Prague`. Omit it and the rotation keeps the time zone it already had. Only a rotation that has never had one falls back to UTC.
>
> **team\_name** `string`
>
> Required if using [global API token](https://betterstack.com/docs/uptime/api/getting-started-with-uptime-api/#get-a-global-api-token) to specify the team which should own the resource.
>
> **schedule\_id** `string` *required*
>
> The ID of the on-call schedule you want to create the event for. Use `default` to refer to the default on-call schedule for the team.
>
> **working\_hours** `array`
>
> List of windows during which the rotation pages anyone, one object per day and window with `day`, `start_time` and `end_time`. `day` is one of `sunday`, `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`. Times are `HH:MM` on a 24-hour clock. An `end_time` that is not after `start_time` runs overnight, so `00:00` to `00:00` is the whole day. Several windows on one day are allowed. Omit the parameter for a rotation that is active around the clock. Omitting it on a rotation that has working hours removes them. See example below.
>
> **rotation\_length** `integer` *required*
>
> The length of the specified rotation period, must be an integer
>
> **end\_rotations\_at** `string` *required*
>
> End time of the rotations
>
> **rotation\_interval** `string ("hour" | "day" | "week")` *required*
>
> The rotation interval, must be one of: `hour`, `day`, `week`
>
> **start\_rotations\_at** `string` *required*
>
> Start time of the rotations
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create source
>
> **Slug:** `BETTER_STACK_CREATE_SOURCE`
>
> ##### Create a source Returns a newly created source. POST /api/v2/sources Requires a Telemetry API token with access to the resource.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Source name
>
> **platform** `string ("apache2" | "aws" | "aws_cloudwatch" | "aws_ecs" | "aws_elb" | "aws_fargate" | "azure" | "azure_logs" | "claude_platform" | "cloudflare_logpush" | "cloudflare_prometheus_exporter" | "cloudflare_worker" | "datadog_agent" | "digitalocean" | "docker" | "dokku" | "dotnet" | "elasticsearch" | "erlang" | "fastly" | "filebeat" | "flights" | "fluentbit" | "fluentd" | "fly_io" | "go" | "gcp" | "google_cloud_pubsub" | "haproxy" | "heroku" | "http" | "java" | "javascript" | "kubernetes" | "logstash" | "minio" | "mongodb" | "mysql" | "nginx" | "open_telemetry" | "php" | "postgresql" | "prometheus" | "prometheus_scrape" | "python" | "rabbitmq" | "redis" | "render" | "rsyslog" | "ruby" | "syslog-ng" | "traefik" | "ubuntu" | "vector" | "vercel_integration" | "winlogbeat")` *required*
>
> Source platform, one of: `apache2`, `aws`, `aws_cloudwatch`, `aws_ecs`, `aws_elb`, `aws_fargate`, `azure`, `azure_logs`, `claude_platform`, `cloudflare_logpush`, `cloudflare_prometheus_exporter`, `cloudflare_worker`, `datadog_agent`, `digitalocean`, `docker`, `dokku`, `dotnet`, `elasticsearch`, `erlang`, `fastly`, `filebeat`, `flights`, `fluentbit`, `fluentd`, `fly_io`, `go`, `gcp`, `google_cloud_pubsub`, `haproxy`, `heroku`, `http`, `java`, `javascript`, `kubernetes`, `logstash`, `minio`, `mongodb`, `mysql`, `nginx`, `open_telemetry`, `php`, `postgresql`, `prometheus`, `prometheus_scrape`, `python`, `rabbitmq`, `redis`, `render`, `rsyslog`, `ruby`, `syslog-ng`, `traefik`, `ubuntu`, `vector`, `vercel_integration`, `winlogbeat`.
>
> **team\_name** `string`
>
> Required if using [global API token](https://betterstack.com/docs/logs/api/getting-started/#get-a-global-api-token) to specify the team which should own the resource
>
> **data\_region** `string`
>
> Data region or private cluster name to create the source in.   Permitted values for most plans are: `us_east`, `germany`, `singapore`.
>
> **scrape\_urls** `array`
>
> URLs to scrape by `prometheus_scrape` platform and similar.
>
> **custom\_bucket** `object`
>
> Custom S3-compatible storage configuration: name (bucket name), endpoint (full bucket URL), access\_key\_id, secret\_access\_key, and keep\_data\_after\_retention (boolean).
>
> **logs\_retention** `integer`
>
> Data retention for logs in days. There might be additional charges for longer retention.
>
> **blocked\_metrics** `array`
>
> Metric names to mark as spam. Listed metrics are rejected during ingestion and aren't billed.
>
> **skip\_ssl\_verify** `boolean`
>
> Whether to skip SSL/TLS certificate verification for `prometheus_scrape` platform and similar. Set to `true` to disable verification.
>
> **source\_group\_id** `integer`
>
> The ID of the source group this source belongs to
>
> **ingesting\_paused** `boolean`
>
> Enable or disable ingesting for this source
>
> **live\_tail\_pattern** `string`
>
> Live tail message format with columns wrapped in `{column}` brackets.   Example: `"PID: {message_json.pid} {level} {message}"`.   For details, see [Live tail docs](https://betterstack.com/docs/logs/using-logtail/formatting-logs/#live-tail-message-format).
>
> **metrics\_retention** `integer`
>
> Data retention for metrics in days. There might be additional charges for longer retention.
>
> **scrape\_frequency\_secs** `integer`
>
> How often to scrape the URLs for `prometheus_scrape` platform and similar. Permitted values are 15, 30, 60, 120 or 300.
>
> **scrape\_request\_headers** `array`
>
> An array of request headers for `prometheus_scrape` platform and similar, with each object containing `name` and `value` fields.
>
> **vrl\_transformation\_logs** `string`
>
> The VRL code applied to logs during ingestion. Read more about [VRL transformations](https://betterstack.com/docs/logs/using-logtail/transforming-ingested-data/logs-vrl/).
>
> **vrl\_transformation\_spans** `string`
>
> The VRL code applied to traces (spans) during ingestion. Read more about [VRL transformations](https://betterstack.com/docs/logs/using-logtail/transforming-ingested-data/logs-vrl/).
>
> **scrape\_request\_basic\_auth\_user** `string`
>
> Basic auth username for `prometheus_scrape` platform and similar.
>
> **scrape\_request\_basic\_auth\_password** `string`
>
> Basic auth password for `prometheus_scrape` platform and similar.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Source Group
>
> **Slug:** `BETTER_STACK_CREATE_SOURCE_GROUP`
>
> Tool to create a new source group. Use when you have finalized the group name (and optional sort index) and need to organize related log sources under that group.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> The name of the group that you can see in the dashboard.
>
> **team\_name** `string`
>
> Required if using a global API token to specify the team which should own the resource.
>
> **sort\_index** `integer`
>
> Set sort\_index to specify how to sort your source groups. Must be non-negative.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Splunk integration
>
> **Slug:** `BETTER_STACK_CREATE_SPLUNK_INTEGRATION`
>
> ##### Create a Splunk integration Returns either a newly created Splunk On-Call integration, or validation errors. POST /api/v2/splunk-on-calls Requires a Better Stack Incidents API token with access to the resource.
>
> #### Input Parameters
>
> **url** `string` *required*
>
> The Splunk On-Call URL to which to post webhooks to.
>
> **name** `string`
>
> The name of the Splunk On-Call integration that you can see in the dashboard.
>
> **team\_name** `string`
>
> Required if using [global API token](https://betterstack.com/docs/uptime/api/getting-started-with-uptime-api/#get-a-global-api-token) to specify the team which should own the resource
>
> **notify\_alongside\_primary\_responder** `boolean`
>
> Whether to notify this integration alongside the primary responder when no escalation policy is configured. Defaults to `true`.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create status page
>
> **Slug:** `BETTER_STACK_CREATE_STATUS_PAGE`
>
> ##### Create status page Returns a newly created status page or validation errors. POST /api/v2/status-pages Requires a Better Stack Incidents API token with access to the resource.
>
> #### Input Parameters
>
> **theme** `string ("light" | "dark" | "system")`
>
> Color theme of your status page. Possible values: `light`, `dark`, `system`. Defaults to `light`. This only applies when the design is set to `v2`.
>
> **design** `string ("v1" | "v2")`
>
> Classic or modern status page design. Possible values: `v1`, `v2`. Defaults to `v1`.
>
> **layout** `string ("vertical" | "horizontal")`
>
> Header layout of your status page. Possible values: `vertical`, `horizontal`. Defaults to `vertical`. This only applies when the design is set to `v2`.
>
> **history** `integer`
>
> Number of days of history to display on the status page. Between `7` and `365`, defaults to `90`.
>
> **logo\_url** `string`
>
> A direct link to your company's logo, including the `https://` scheme. We download the image from it, and it must be under 20MB in size.
>
> **password** `string`
>
> Password for your status page, stored encrypted. Required when `password_enabled` is `true`. Sending a password turns protection on unless you also send `password_enabled`, and sending an empty password turns it off.
>
> **timezone** `string` *required*
>
> Timezone to display your status page in, for example `Tokyo` or `Europe/Prague`. Accepts IANA time zone IDs and the names in the [Rails TimeZone documentation](https://api.rubyonrails.org/classes/ActiveSupport/TimeZone.html ";_blank")
>
> **published** `boolean`
>
> Whether the status page is published and accessible. Defaults to `true`.
>
> **subdomain** `string` *required*
>
> Subdomain of your status page. It must be unique across Better Stack, up to 63 characters of letters, digits, dashes and underscores.
>
> **team\_name** `string`
>
> Team that should own the status page when using a global API token. Omit for a team-scoped token.
>
> **custom\_css** `string`
>
> Unleash your inner designer and tweak our status page design to fit your branding
>
> **company\_url** `string`
>
> URL of your company's website
>
> **contact\_url** `string`
>
> URL visitors can use to contact you in an emergency, for example `https://example.com/support` or `mailto:support@example.com`. Can be `null`.
>
> **require\_sso** `boolean`
>
> Require SSO sign-in to access your status page. Requires SSO to be configured for your organization and is mutually exclusive with password protection. Defaults to `false`.
>
> **announcement** `string`
>
> An announcement to show on your status page. Can be `null`.
>
> **company\_name** `string` *required*
>
> Name of your company, displayed on the status page.
>
> **ip\_allowlist** `array`
>
> Restrict access to your status page by IP address. Only visitors from specified IP addresses or CIDR ranges can view the status page. Entries starting with `#` are comments. This is a [billable feature](https://betterstack.com/pricing#status-pages ";_blank")
>
> **subscribable** `boolean`
>
> Whether visitors can subscribe to updates of your status page. Defaults to `false`.
>
> **whitelabeled** `boolean`
>
> Whether to remove the 'Powered by Better Stack' footer. Defaults to `false`. This is a [billable feature](https://betterstack.com/pricing#status-pages ";_blank")
>
> **custom\_domain** `string`
>
> A host name you own to serve the status page from, for example `status.walmine.com`. Add a CNAME record pointing it to `statuspage.betteruptime.com`. Can be `null`.
>
> **dark\_logo\_url** `string`
>
> A direct link to a dark version of your company's logo, including the `https://` scheme. We download the image from it, and it must be under 20MB in size.
>
> **navigation\_links** `array`
>
> Adjust the navigation links on your status page. Accepts an array of objects containing keys `text` and `href`:  • `text` is the navigation link label.  • `href` is the link. Use a full URL for external links. Use `/`, `/maintenance` and `/incidents` for built-in links.  At most 4 links are allowed. This only applies when the design is set to `v2`.
>
> **password\_enabled** `boolean`
>
> Whether to protect your status page with a password. Defaults to `false`.
>
> **automatic\_reports** `boolean`
>
> Whether to automatically create status page updates for new incidents. Defaults to `false`.
>
> **custom\_javascript** `string`
>
> Level up your status page by adding analytics, interactive features, or any other functionality you need
>
> **google\_analytics\_id** `string`
>
> Your own Google Analytics ID to track visits to your status page, for example `G-XXXXXXXX`. Must start with `G-`, `UA-` or `GTM-`.
>
> **min\_incident\_length** `integer`
>
> Hide incidents shorter than this many seconds from the status page. Defaults to `0`, which shows all incidents. Must be shorter than one year.
>
> **status\_page\_group\_id** `integer`
>
> The ID of the status page group to which this status page will belong. Can be `null`.
>
> **announcement\_embed\_css** `string`
>
> Custom CSS for the announcement embed.
>
> **announcement\_embed\_link** `string`
>
> URL the announcement embed links to. Defaults to your status page.
>
> **hide\_from\_search\_engines** `boolean`
>
> Whether to hide your status page from search engines. Defaults to `false`.
>
> **announcement\_embed\_visible** `boolean`
>
> Whether to show the announcement in the announcement embed. Defaults to `true`. Embed it on your website with `<script src="https://uptime.betterstack.com/widgets/announcement.js" data-id="YOUR_STATUS_PAGE_ID" async="async" type="text/javascript"></script>`.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Status Page Group
>
> **Slug:** `BETTER_STACK_CREATE_STATUS_PAGE_GROUP`
>
> Tool to create a new status page group. Use when you need to organize related status pages under a single logical group with a descriptive name.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> A descriptive label for the group visible in the dashboard.
>
> **team\_name** `string`
>
> Required only when using a global API token to designate which team owns the resource.
>
> **sort\_index** `integer`
>
> Numeric value controlling the sort order of status page groups.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Status Page Report
>
> **Slug:** `BETTER_STACK_CREATE_STATUS_PAGE_REPORT`
>
> Tool to create a new status page report (incident or maintenance). Use when you need to publish a status update about an ongoing incident or scheduled maintenance on a status page.
>
> #### Input Parameters
>
> **title** `string` *required*
>
> The title/name for the status page report
>
> **ends\_at** `string`
>
> ISO-8601 timestamp when the report/incident ends. Leave empty for ongoing incidents.
>
> **message** `string` *required*
>
> The initial status update text/message for this report
>
> **starts\_at** `string`
>
> ISO-8601 timestamp when the report/incident starts. If not provided, defaults to current time.
>
> **report\_type** `string ("manual" | "maintenance")`
>
> Type of report: 'manual' for incident reports or 'maintenance' for scheduled maintenance. Defaults to 'manual'.
>
> **published\_at** `string`
>
> ISO-8601 timestamp when the report should be published. If not provided, the report is published immediately.
>
> **status\_page\_id** `string` *required*
>
> The numeric ID of the status page (e.g., '221582'). Obtain this from the list\_status\_pages action.
>
> **affected\_resources** `array` *required*
>
> List of status page resources affected by this report, with their status. Each object must contain status\_page\_resource\_id and status fields. For maintenance reports, use status='maintenance'. For manual incident reports, use status='resolved', 'degraded', or 'downtime'.
>
> **notify\_subscribers** `boolean`
>
> Whether to send email notifications to status page subscribers. Defaults to false.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Status Page Resource
>
> **Slug:** `BETTER_STACK_CREATE_STATUS_PAGE_RESOURCE`
>
> Tool to create a new status page resource. Use when you need to add a monitor, heartbeat, or other resource to a status page for public visibility tracking.
>
> #### Input Parameters
>
> **position** `integer`
>
> Zero-indexed placement position on the status page (omit to append to end)
>
> **explanation** `string`
>
> Detailed help text displayed as an icon tooltip
>
> **public\_name** `string`
>
> Display name shown publicly on the status page
>
> **resource\_id** `string` *required*
>
> The identifier of the resource being added (Monitor, Heartbeat, etc.)
>
> **widget\_type** `string ("plain" | "history" | "response_times" | "chart_only")`
>
> Display format for the resource on the status page
>
> **resource\_type** `string ("Monitor" | "MonitorGroup" | "Heartbeat" | "HeartbeatGroup" | "WebhookIntegration" | "EmailIntegration" | "IncomingWebhook" | "ResourceGroup" | "LogsChart" | "CatalogReference")` *required*
>
> Type of resource to add to the status page
>
> **fixed\_position** `boolean`
>
> Prevents position reordering when true
>
> **status\_page\_id** `string` *required*
>
> The ID of the status page to add the resource to
>
> **mark\_as\_down\_for** `string ("any_incident" | "no_incident" | "incident_matching_metadata")`
>
> Condition that triggers marking the resource as down
>
> **mark\_as\_degraded\_for** `string ("any_incident" | "no_incident" | "incident_matching_metadata")`
>
> Condition that triggers marking the resource as degraded
>
> **status\_page\_section\_id** `integer`
>
> Section ID where the resource should be placed (defaults to first section if omitted)
>
> **mark\_as\_down\_metadata\_rule** `object`
>
> Metadata rule for status matching.
>
> **mark\_as\_degraded\_metadata\_rule** `object`
>
> Metadata rule for status matching.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Status Page Section
>
> **Slug:** `BETTER_STACK_CREATE_STATUS_PAGE_SECTION`
>
> Tool to create a new section on a status page. Use when organizing resources into logical groups (e.g., by datacenter or service type). Leave name blank to hide the section header.
>
> #### Input Parameters
>
> **name** `string`
>
> The name of the section. Leave blank to hide the section header.
>
> **position** `integer`
>
> The position of this section on your status page, indexed from zero. Defaults to the end if not specified.
>
> **status\_page\_id** `string` *required*
>
> The identifier for your status page where the section will be created.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create status page subscriber
>
> **Slug:** `BETTER_STACK_CREATE_STATUS_PAGE_SUBSCRIBER`
>
> ##### Create status page subscriber Creates a confirmed e-mail subscriber for a status page. Creating a subscriber who previously unsubscribed subscribes that e-mail again. Creating an e-mail address that is already actively subscribed returns `422`. POST /api/v2/status-pages/\{status\_page\_id}/subscribers Requires a Better Stack Incidents API token with access to the resource.
>
> #### Input Parameters
>
> **email** `string` *required*
>
> The subscriber e-mail address.
>
> **status\_page\_id** `string` *required*
>
> The ID of your status page.
>
> **status\_page\_resource\_ids** `array`
>
> The status page resources this subscriber receives updates for. Use `[]` for all resources. Each ID must be a resource of this status page other than a third party service. Get valid resource IDs from `GET /api/v2/status-pages/{status_page_id}/resources`.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Status Update
>
> **Slug:** `BETTER_STACK_CREATE_STATUS_UPDATE`
>
> Tool to create a new status update for an existing status report. Use when you need to post an update about the current state of an incident or maintenance. The update can include a message, affected resources with their status, and optionally notify subscribers.
>
> #### Input Parameters
>
> **message** `string`
>
> Message associated with the status update, providing details about the current state or actions taken.
>
> **published\_at** `string`
>
> ISO-8601 timestamp for publication time. If not provided, defaults to current time.
>
> **status\_page\_id** `string` *required*
>
> Your status page identifier. Obtain from list\_status\_pages action.
>
> **status\_report\_id** `string` *required*
>
> Your status page report identifier. Obtain from list\_status\_page\_reports action.
>
> **affected\_resources** `array` *required*
>
> Array of affected resources with their current status. Must contain at least one resource.
>
> **notify\_subscribers** `boolean`
>
> Send notification email to subscribers. Default is false.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Severity Level
>
> **Slug:** `BETTER_STACK_CREATE_URGENCIES`
>
> Tool to create a new severity level (urgency) for incident management. Use when you need to define notification preferences for different incident severity levels.
>
> #### Input Parameters
>
> **sms** `boolean` *required*
>
> Enables SMS notifications for new incidents at this severity level
>
> **call** `boolean` *required*
>
> Enables phone calls for new incidents at this severity level
>
> **name** `string` *required*
>
> The identifier for this severity level
>
> **push** `boolean` *required*
>
> Enables push notifications for new incidents at this severity level
>
> **email** `boolean` *required*
>
> Enables email notifications for new incidents at this severity level
>
> **team\_name** `string`
>
> Required only when using global API tokens to designate resource ownership
>
> **critical\_alert** `boolean`
>
> Sends critical alerts bypassing device mute settings
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Urgency Group
>
> **Slug:** `BETTER_STACK_CREATE_URGENCY_GROUP`
>
> Tool to create a new urgency group (severity group) for incident categorization. Use when you need to define severity levels for monitoring alerts and incidents.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> The name of the urgency group that you can see in the dashboard.
>
> **team\_name** `string`
>
> Required only when using a global API token to specify resource ownership. The team which should own the urgency group.
>
> **sort\_index** `integer`
>
> Determines the ordering of severity groups. Must be non-negative.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete alert
>
> **Slug:** `BETTER_STACK_DELETE_ALERT`
>
> ##### Remove an alert Permanently deletes an alert by its ID. DELETE /api/v2/alerts/\{id} Requires a Telemetry API token with access to the resource.
>
> #### Input Parameters
>
> **id** `integer` *required*
>
> The unique identifier of the alert to delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Amazon SNS integration
>
> **Slug:** `BETTER_STACK_DELETE_AMAZON_SNS_INTEGRATION`
>
> Permanently delete an Amazon SNS integration from Better Stack. Stops accepting topic notifications but leaves the AWS SNS subscription intact; remove that subscription separately in AWS. Returns no content on success. Requires a Better Stack Incidents API token with access to the resource.
>
> #### Input Parameters
>
> **amazon\_sns\_integration\_id** `string` *required*
>
> The ID of the Amazon SNS integration you want to delete
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete AWS CloudWatch integration
>
> **Slug:** `BETTER_STACK_DELETE_AWS_CLOUDWATCH_INTEGRATION`
>
> ##### Remove AWS CloudWatch integration Permanently deletes an existing AWS CloudWatch integration. DELETE /api/v2/aws-cloudwatch-integrations/\{aws\_cloudwatch\_integration\_id} Requires a Better Stack Incidents API token with access to the resource.
>
> #### Input Parameters
>
> **aws\_cloudwatch\_integration\_id** `string` *required*
>
> The ID of the AWS CloudWatch integration you want to delete
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete aws log group subscription
>
> **Slug:** `BETTER_STACK_DELETE_AWS_LOG_GROUP_SUBSCRIPTION`
>
> Delete a log group subscription override and restore automatic behavior. The log group follows the source's auto-subscribe setting afterward; deleting an override does not necessarily unsubscribe the log group. Requires an aws source with a connected AWS account and a Telemetry API token with access to the resource. Returns an empty response on success (HTTP 204).
>
> #### Input Parameters
>
> **id** `string` *required*
>
> ID of the log group subscription override
>
> **source\_id** `string` *required*
>
> ID of the `aws` source
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Azure integration
>
> **Slug:** `BETTER_STACK_DELETE_AZURE_INTEGRATION`
>
> ##### Remove Azure integration Permanently deletes an existing Azure integration. DELETE /api/v2/azure-integrations/\{azure\_integration\_id} Requires a Better Stack Incidents API token with access to the resource.
>
> #### Input Parameters
>
> **azure\_integration\_id** `string` *required*
>
> The ID of the Azure integration you want to delete
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete catalog attribute
>
> **Slug:** `BETTER_STACK_DELETE_CATALOG_ATTRIBUTE`
>
> ##### Remove catalog attribute Permanently deletes an existing Catalog attribute. DELETE /api/v2/catalog/relations/\{relation\_id}/attributes/\{attribute\_id} Requires a Better Stack Incidents API token with access to the resource.
>
> #### Input Parameters
>
> **relation\_id** `string` *required*
>
> The ID of the Catalog relation you want to delete an attribute for.
>
> **attribute\_id** `string` *required*
>
> The ID of the Catalog attribute you want to delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete catalog record
>
> **Slug:** `BETTER_STACK_DELETE_CATALOG_RECORD`
>
> ##### Remove catalog record Permanently deletes an existing Catalog record. DELETE /api/v2/catalog/relations/\{relation\_id}/records/\{record\_id} Requires a Better Stack Incidents API token with access to the resource.
>
> #### Input Parameters
>
> **record\_id** `string` *required*
>
> The ID of the Catalog record you want to delete.
>
> **relation\_id** `string` *required*
>
> The ID of the Catalog relation you want to delete a record for.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete catalog relation
>
> **Slug:** `BETTER_STACK_DELETE_CATALOG_RELATION`
>
> ##### Remove catalog relation Permanently deletes an existing Catalog relation. DELETE /api/v2/catalog/relations/\{relation\_id} Requires a Better Stack Incidents API token with access to the resource.
>
> #### Input Parameters
>
> **relation\_id** `string` *required*
>
> The ID of the Catalog relation you want to delete
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete chart
>
> **Slug:** `BETTER_STACK_DELETE_CHART`
>
> ##### Remove a chart Permanently deletes a chart from a dashboard. DELETE /api/v2/dashboards/\{dashboard\_id}/charts/\{id} Requires a Telemetry API token with access to the resource.
>
> #### Input Parameters
>
> **id** `integer` *required*
>
> The unique identifier of the chart to delete.
>
> **dashboard\_id** `integer` *required*
>
> The unique identifier of the dashboard.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete chart comment
>
> **Slug:** `BETTER_STACK_DELETE_CHART_COMMENT`
>
> Permanently remove a chart comment. Success returns no content. Requires a Telemetry API token with access to the resource. Team API tokens can remove only comments with api\_authored=true. With an OAuth token, the member's own comments can also be removed. Other members' comments and incident comments synced from Incidents return 403.
>
> #### Input Parameters
>
> **id** `integer` *required*
>
> The unique identifier of the comment to remove.
>
> **chart\_id** `integer` *required*
>
> The unique identifier of the chart.
>
> **dashboard\_id** `integer` *required*
>
> The unique identifier of the dashboard.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete collector
>
> **Slug:** `BETTER_STACK_DELETE_COLLECTOR`
>
> ##### Remove a collector Permanently deletes a collector. This action is irreversible and will also remove all associated configurations and stop data collection. The underlying sources and their data will be deleted asynchronously. DELETE /api/v1/collectors/\{id} Requires a Telemetry API token with access to the resource.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The unique identifier of the collector to delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete collector metric target
>
> **Slug:** `BETTER_STACK_DELETE_COLLECTOR_METRIC_TARGET`
>
> ##### Remove a collector metric target Permanently removes a collector target. The collector will stop monitoring this target on its next configuration sync. DELETE /api/v1/collectors/\{collector\_id}/targets/\{target\_id} Requires a Telemetry API token with access to the resource.
>
> #### Input Parameters
>
> **target\_id** `string` *required*
>
> Identifier of the target.
>
> **collector\_id** `string` *required*
>
> Identifier of the collector.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete connection
>
> **Slug:** `BETTER_STACK_DELETE_CONNECTION`
>
> Delete an existing ClickHouse connection by its ID. Requires a global API token; team-specific tokens are not supported. Returns no content on success, or 404 when the connection does not exist.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The ID of the connection to delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete dashboard
>
> **Slug:** `BETTER_STACK_DELETE_DASHBOARD`
>
> ##### Remove a dashboard Permanently deletes an existing dashboard. DELETE /api/v2/dashboards/\{id} Requires a Telemetry API token with access to the resource.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The unique identifier of the dashboard to delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete dashboard alert
>
> **Slug:** `BETTER_STACK_DELETE_DASHBOARD_ALERT`
>
> ##### Remove a dashboard alert Permanently deletes an alert from a dashboard chart. DELETE /api/v2/dashboards/\{dashboard\_id}/charts/\{chart\_id}/alerts/\{id} Requires a Telemetry API token with access to the resource.
>
> #### Input Parameters
>
> **id** `integer` *required*
>
> The unique identifier of the alert to delete.
>
> **chart\_id** `integer` *required*
>
> The unique identifier of the chart.
>
> **dashboard\_id** `integer` *required*
>
> The unique identifier of the dashboard.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete dashboard group
>
> **Slug:** `BETTER_STACK_DELETE_DASHBOARD_GROUP`
>
> ##### Remove a dashboard group Permanently deletes a dashboard group by its ID. \[info] Deleting a group does not delete the dashboards within it. Those dashboards will become ungrouped. \[/info] DELETE /api/v2/dashboard-groups/\{id} Requires a Telemetry API token with access to the resource.
>
> #### Input Parameters
>
> **id** `integer` *required*
>
> The unique identifier of the dashboard group to delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete dashboard section
>
> **Slug:** `BETTER_STACK_DELETE_DASHBOARD_SECTION`
>
> ##### Remove a dashboard section Permanently deletes a section from a dashboard. DELETE /api/v2/dashboards/\{dashboard\_id}/sections/\{id} Requires a Telemetry API token with access to the resource.
>
> #### Input Parameters
>
> **id** `integer` *required*
>
> The unique identifier of the section to delete.
>
> **dashboard\_id** `integer` *required*
>
> The unique identifier of the dashboard.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Datadog integration
>
> **Slug:** `BETTER_STACK_DELETE_DATADOG_INTEGRATION`
>
> ##### Remove Datadog integration Permanently deletes an existing Datadog integration. DELETE /api/v2/datadog-integrations/\{datadog\_integration\_id} Requires a Better Stack Incidents API token with access to the resource.
>
> #### Input Parameters
>
> **datadog\_integration\_id** `string` *required*
>
> The ID of the Datadog integration you want to delete
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Elastic integration
>
> **Slug:** `BETTER_STACK_DELETE_ELASTIC_INTEGRATION`
>
> ##### Remove Elastic integration Permanently deletes an existing Elastic integration. DELETE /api/v2/elastic-integrations/\{elastic\_integration\_id} Requires a Better Stack Incidents API token with access to the resource.
>
> #### Input Parameters
>
> **elastic\_integration\_id** `string` *required*
>
> The ID of the Elastic integration you want to delete
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete email integration
>
> **Slug:** `BETTER_STACK_DELETE_EMAIL_INTEGRATION`
>
> ##### Remove e-mail integration Permanently deletes an existing e-mail integration. DELETE /api/v2/email-integrations/\{email\_integration\_id} Requires a Better Stack Incidents API token with access to the resource.
>
> #### Input Parameters
>
> **email\_integration\_id** `string` *required*
>
> The ID of the e-mail integration you want to delete
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Escalation Policy
>
> **Slug:** `BETTER_STACK_DELETE_ESCALATION_POLICY`
>
> Tool to delete an escalation policy by ID. Use when you need to permanently remove an existing escalation policy after confirming its ID.
>
> #### Input Parameters
>
> **policy\_id** `integer` *required*
>
> The ID of the escalation policy you want to delete
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete exploration
>
> **Slug:** `BETTER_STACK_DELETE_EXPLORATION`
>
> ##### Remove an exploration Permanently deletes an exploration by its ID. \[warning] Deleting an exploration also permanently deletes its associated chart, queries, and any configured alerts. This action cannot be undone. \[/warning] DELETE /api/v2/explorations/\{id} Requires a Telemetry API token with access to the resource.
>
> #### Input Parameters
>
> **id** `integer` *required*
>
> The unique identifier of the exploration to delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete exploration alert
>
> **Slug:** `BETTER_STACK_DELETE_EXPLORATION_ALERT`
>
> ##### Remove an exploration alert Permanently deletes an alert by its ID. DELETE /api/v2/explorations/\{exploration\_id}/alerts/\{id} Requires a Telemetry API token with access to the resource.
>
> #### Input Parameters
>
> **id** `integer` *required*
>
> The unique identifier of the alert to delete.
>
> **exploration\_id** `integer` *required*
>
> The unique identifier of the exploration.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete exploration group
>
> **Slug:** `BETTER_STACK_DELETE_EXPLORATION_GROUP`
>
> ##### Remove an exploration group Permanently deletes an exploration group by its ID. \[info] Deleting a group does not delete the explorations within it. Those explorations will become ungrouped. \[/info] DELETE /api/v2/exploration-groups/\{id} Requires a Telemetry API token with access to the resource.
>
> #### Input Parameters
>
> **id** `integer` *required*
>
> The unique identifier of the exploration group to delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Google Monitoring integration
>
> **Slug:** `BETTER_STACK_DELETE_GOOGLE_MONITORING_INTEGRATION`
>
> ##### Remove Google Monitoring integration Permanently deletes an existing Google Monitoring integration. DELETE /api/v2/google-monitoring-integrations/\{google\_monitoring\_integration\_id} Requires a Better Stack Incidents API token with access to the resource.
>
> #### Input Parameters
>
> **google\_monitoring\_integration\_id** `string` *required*
>
> The ID of the Google Monitoring integration you want to delete
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Grafana integration
>
> **Slug:** `BETTER_STACK_DELETE_GRAFANA_INTEGRATION`
>
> ##### Remove Grafana integration Permanently deletes an existing Grafana integration. DELETE /api/v2/grafana-integrations/\{grafana\_integration\_id} Requires a Better Stack Incidents API token with access to the resource.
>
> #### Input Parameters
>
> **grafana\_integration\_id** `string` *required*
>
> The ID of the Grafana integration you want to delete
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Heartbeat
>
> **Slug:** `BETTER_STACK_DELETE_HEARTBEAT`
>
> Tool to permanently delete a heartbeat by ID. Use when you need to remove a heartbeat that is no longer needed.
>
> #### Input Parameters
>
> **heartbeat\_id** `string` *required*
>
> The unique ID of the heartbeat to delete. You can get this from the list heartbeats or get heartbeat actions.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Heartbeat Group
>
> **Slug:** `BETTER_STACK_DELETE_HEARTBEAT_GROUP`
>
> Tool to permanently delete a heartbeat group by ID. Use when you need to remove a heartbeat group that is no longer needed.
>
> #### Input Parameters
>
> **heartbeat\_group\_id** `string` *required*
>
> The ID of the heartbeat group to delete. Use list heartbeat groups to find available IDs.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Incident
>
> **Slug:** `BETTER_STACK_DELETE_INCIDENT`
>
> Tool to permanently delete an existing incident by ID. Use when you need to remove an incident from Better Stack Uptime.
>
> #### Input Parameters
>
> **incident\_id** `string` *required*
>
> The ID of the incident you want to delete
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Incident Comment
>
> **Slug:** `BETTER_STACK_DELETE_INCIDENT_COMMENT`
>
> Tool to delete an existing comment from an incident. Use when you need to remove a comment that was previously added via the API. Note: Only comments created via the API can be deleted; comments created in the UI cannot be deleted via the API.
>
> #### Input Parameters
>
> **comment\_id** `string` *required*
>
> The unique ID of the comment to delete. Note: Only API-created comments can be deleted.
>
> **incident\_id** `string` *required*
>
> The unique ID of the incident containing the comment
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete incoming webhook
>
> **Slug:** `BETTER_STACK_DELETE_INCOMING_WEBHOOK`
>
> ##### Remove incoming webhook Permanently deletes an existing incoming webhook. DELETE /api/v2/incoming-webhooks/\{incoming\_webhook\_id} Requires a Better Stack Incidents API token with access to the resource.
>
> #### Input Parameters
>
> **incoming\_webhook\_id** `string` *required*
>
> The ID of the incoming webhook you want to delete
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete metric
>
> **Slug:** `BETTER_STACK_DELETE_METRIC`
>
> ##### Remove a metric Permanently deletes an existing metric or label. DELETE /api/v2/sources/\{source\_id}/metrics/\{id} Requires a Telemetry API token with access to the resource.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> ID of the metric you want to delete
>
> **source\_id** `integer` *required*
>
> Source for which to delete a metric
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Monitor
>
> **Slug:** `BETTER_STACK_DELETE_MONITOR`
>
> Tool to permanently delete a monitor by ID from Better Stack Uptime. Use when you need to remove a monitor that is no longer needed.
>
> #### Input Parameters
>
> **monitor\_id** `string` *required*
>
> The unique ID of the monitor to delete. You can get this from the list monitors or get monitor actions.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Monitor Group
>
> **Slug:** `BETTER_STACK_DELETE_MONITOR_GROUP`
>
> Tool to permanently delete a monitor group by ID from Better Stack Uptime. Use when you need to remove a monitor group that is no longer needed.
>
> #### Input Parameters
>
> **monitor\_group\_id** `string` *required*
>
> The unique ID of the monitor group to permanently delete. You can get this from list monitor groups or create monitor group actions.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete New Relic integration
>
> **Slug:** `BETTER_STACK_DELETE_NEW_RELIC_INTEGRATION`
>
> ##### Remove New Relic integration Permanently deletes an existing New Relic integration. DELETE /api/v2/new-relic-integrations/\{new\_relic\_integration\_id} Requires a Better Stack Incidents API token with access to the resource.
>
> #### Input Parameters
>
> **new\_relic\_integration\_id** `string` *required*
>
> The ID of the New Relic integration you want to delete
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete on-call event
>
> **Slug:** `BETTER_STACK_DELETE_ON_CALL_EVENT`
>
> ##### Remove on-call schedule event Delete a single event from an on-call schedule. Events starting sooner than today at 0:00 UTC can't be deleted. DELETE /api/v2/on-calls/\{schedule\_id}/events/\{event\_id} Requires a Better Stack Incidents API token with access to the resource.
>
> #### Input Parameters
>
> **event\_id** `string` *required*
>
> The ID of the event to delete.
>
> **schedule\_id** `string` *required*
>
> The ID of the on-call schedule containing the event to delete. Use `default` to refer to the default on-call schedule for the team.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete On-Call Schedule
>
> **Slug:** `BETTER_STACK_DELETE_ON_CALL_SCHEDULE`
>
> Tool to permanently delete an on-call schedule by ID. Use when you need to remove an on-call calendar that is no longer needed.
>
> #### Input Parameters
>
> **schedule\_id** `string` *required*
>
> The unique ID of the on-call schedule to delete. You can get this from the list on-call schedules action.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete outgoing email
>
> **Slug:** `BETTER_STACK_DELETE_OUTGOING_EMAIL`
>
> ##### Remove outgoing e-mail Permanently deletes an outgoing e-mail integration. Returns an empty body with status `204 No Content` on success. DELETE /api/v2/outgoing-emails/\{integration\_id} Requires a Better Stack Incidents API token with access to the resource.
>
> #### Input Parameters
>
> **integration\_id** `string` *required*
>
> The ID of the outgoing e-mail integration.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Outgoing Webhook Integration
>
> **Slug:** `BETTER_STACK_DELETE_OUTGOING_WEBHOOK`
>
> Tool to delete an outgoing webhook integration by ID. Use when you need to permanently remove an existing webhook integration.
>
> #### Input Parameters
>
> **outgoing\_webhook\_id** `string` *required*
>
> The unique ID of the outgoing webhook integration to delete. You can get this from the list or create outgoing webhook actions.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete PagerDuty integration
>
> **Slug:** `BETTER_STACK_DELETE_PAGERDUTY_INTEGRATION`
>
> ##### Remove PagerDuty integration Permanently deletes an existing PagerDuty integration. DELETE /api/v2/pager-duty-webhooks/\{pager\_duty\_webhook\_id} Requires a Better Stack Incidents API token with access to the resource.
>
> #### Input Parameters
>
> **pager\_duty\_webhook\_id** `string` *required*
>
> The ID of the PagerDuty integration you want to delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Escalation Policy Group
>
> **Slug:** `BETTER_STACK_DELETE_POLICY_GROUP`
>
> Tool to delete an escalation policy group by ID. Use when you need to permanently remove an existing escalation policy group after confirming its ID.
>
> #### Input Parameters
>
> **policy\_group\_id** `integer` *required*
>
> The ID of the escalation policy group you want to delete
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Prometheus integration
>
> **Slug:** `BETTER_STACK_DELETE_PROMETHEUS_INTEGRATION`
>
> ##### Remove Prometheus integration Permanently deletes an existing Prometheus integration. DELETE /api/v2/prometheus-integrations/\{prometheus\_integration\_id} Requires a Better Stack Incidents API token with access to the resource.
>
> #### Input Parameters
>
> **prometheus\_integration\_id** `string` *required*
>
> The ID of the Prometheus integration you want to delete
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete schedule rotation
>
> **Slug:** `BETTER_STACK_DELETE_SCHEDULE_ROTATION`
>
> ##### Remove an on-call schedule rotation Remove an on-call rotation for a single schedule. This also removes all on-call events generated for this on-call rotation that end after 0:00 UTC today. DELETE /api/v2/on-calls/\{schedule\_id}/rotation Requires a Better Stack Incidents API token with access to the resource.
>
> #### Input Parameters
>
> **team\_name** `string`
>
> Required if using [global API token](https://betterstack.com/docs/uptime/api/getting-started-with-uptime-api/#get-a-global-api-token) to specify the team which should own the resource.
>
> **schedule\_id** `string` *required*
>
> The ID of the on-call schedule whose rotation should be removed. Use `default` to refer to the default on-call schedule for the team.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete source
>
> **Slug:** `BETTER_STACK_DELETE_SOURCE`
>
> ##### Remove a source Permanently deletes an existing source. DELETE /api/v2/sources/\{source\_id} Requires a Telemetry API token with access to the resource.
>
> #### Input Parameters
>
> **source\_id** `string` *required*
>
> Identifier of the source.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Source Group
>
> **Slug:** `BETTER_STACK_DELETE_SOURCE_GROUP`
>
> Tool to permanently delete a source group by ID from Better Stack Telemetry (Logs). Source groups are used to organize related log sources. Use this action when you need to remove a source group that is no longer needed. Note: This action requires a Telemetry API token (not an Uptime API token). Deleting a source group does not delete the sources within it - they will become ungrouped.
>
> #### Input Parameters
>
> **source\_group\_id** `string` *required*
>
> The unique ID of the source group to delete. You can get this from the list source groups or create source group actions.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Splunk integration
>
> **Slug:** `BETTER_STACK_DELETE_SPLUNK_INTEGRATION`
>
> ##### Remove Splunk integration Permanently deletes an existing Splunk On-Call integration. DELETE /api/v2/splunk-on-calls/\{splunk\_on\_call\_id} Requires a Better Stack Incidents API token with access to the resource.
>
> #### Input Parameters
>
> **splunk\_on\_call\_id** `string` *required*
>
> The ID of the Splunk On-Call integration you want to delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete status page
>
> **Slug:** `BETTER_STACK_DELETE_STATUS_PAGE`
>
> ##### Remove status page Permanently deletes an existing status page. DELETE /api/v2/status-pages/\{status\_page\_id} Requires a Better Stack Incidents API token with access to the resource.
>
> #### Input Parameters
>
> **status\_page\_id** `string` *required*
>
> The ID of the status page you want to delete
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Status Page Group
>
> **Slug:** `BETTER_STACK_DELETE_STATUS_PAGE_GROUP`
>
> Tool to delete a status page group by ID. Use when you need to permanently remove an existing status page group.
>
> #### Input Parameters
>
> **status\_page\_group\_id** `string` *required*
>
> The ID of the status page group you want to delete
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Status Page Report
>
> **Slug:** `BETTER_STACK_DELETE_STATUS_PAGE_REPORT`
>
> Tool to permanently delete a status page report by ID from Better Stack Uptime. Use this action when you need to remove an existing status page report that is no longer needed. The report will be permanently deleted and cannot be recovered.
>
> #### Input Parameters
>
> **report\_id** `string` *required*
>
> The numeric ID of the status report to delete (e.g., '824278'). Obtain this from the list\_status\_page\_reports action.
>
> **status\_page\_id** `string` *required*
>
> The numeric ID of the status page (e.g., '221582'). Obtain this from the list\_status\_pages action.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Status Page Resource
>
> **Slug:** `BETTER_STACK_DELETE_STATUS_PAGE_RESOURCE`
>
> Tool to delete an existing resource from a status page. Use when you need to permanently remove a resource (monitor or heartbeat) that is displayed on a status page.
>
> #### Input Parameters
>
> **resource\_id** `string` *required*
>
> The ID of the resource to delete from the status page
>
> **status\_page\_id** `string` *required*
>
> The ID of the status page that contains the resource
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Status Page Section
>
> **Slug:** `BETTER_STACK_DELETE_STATUS_PAGE_SECTION`
>
> Tool to permanently delete a status page section by ID. Use when you need to remove a section from a status page that is no longer needed. Sections organize resources on status pages for better visibility.
>
> #### Input Parameters
>
> **section\_id** `string` *required*
>
> The ID of the section to delete from the status page. You can get this from listing sections within a status page.
>
> **status\_page\_id** `string` *required*
>
> The ID of the status page that contains the section to delete. You can get this from the list status pages or get status page actions.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Status Update
>
> **Slug:** `BETTER_STACK_DELETE_STATUS_PAGE_STATUS_REPORT_STATUS_UPDATE`
>
> Tool to delete an existing status update from a status report. Use when you need to permanently remove a status update after confirming its ID.
>
> #### Input Parameters
>
> **status\_page\_id** `string` *required*
>
> The ID of the status page. You can get this from the list\_status\_pages action.
>
> **status\_report\_id** `string` *required*
>
> The ID of the status report containing the update. You can get this from the list\_status\_page\_reports action.
>
> **status\_update\_id** `string` *required*
>
> The ID of the status update to delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete status page subscriber
>
> **Slug:** `BETTER_STACK_DELETE_STATUS_PAGE_SUBSCRIBER`
>
> Remove an e-mail subscriber from a status page by subscriber ID. Creates an unsubscribe record for that e-mail address. Requires a Better Stack Incidents API token with access to the status page.
>
> #### Input Parameters
>
> **subscriber\_id** `string` *required*
>
> The ID of the subscriber.
>
> **status\_page\_id** `string` *required*
>
> The ID of your status page.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete status page subscriber by email
>
> **Slug:** `BETTER_STACK_DELETE_STATUS_PAGE_SUBSCRIBER_BY_EMAIL`
>
> Remove a status page subscriber by exact email address. Creates an unsubscribe record for that email address. Returns no content on success. Requires a Better Stack Incidents API token with access to the status page.
>
> #### Input Parameters
>
> **email** `string` *required*
>
> The exact subscriber e-mail address.
>
> **status\_page\_id** `string` *required*
>
> The ID of your status page.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete team member by email
>
> **Slug:** `BETTER_STACK_DELETE_TEAM_MEMBER_BY_EMAIL`
>
> Remove a team member or cancel a pending invitation by e-mail. This action cannot be undone. Admins cannot be removed through the API. Removing a billing\_admin requires a global API token because that role applies to every team. With a global token, provide team\_name to select the team. Sends email and optional team\_name as query parameters to the Better Stack organization API.
>
> #### Input Parameters
>
> **email** `string` *required*
>
> The email address of the team member to remove or invitation to cancel. Can be passed as a query parameter or in the request body.
>
> **team\_name** `string`
>
> Required if using a [global API token](https://betterstack.com/docs/uptime/api/getting-started-with-uptime-api/#get-a-global-api-token) to specify the team.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete team member by ID
>
> **Slug:** `BETTER_STACK_DELETE_TEAM_MEMBER_BY_ID`
>
> ##### Remove a team member from team by ID Removes a member from the team by their ID. This action cannot be undone. \[info] Removing a user with the `admin` role is not permitted via the API. Removing a user with the `billing_admin` role requires a global API token, because Billing admin applies to every team in your organization. \[/info] DELETE /api/v2/team-members/\{id} Requires a Better Stack Incidents API token with access to the resource.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The ID of the team member to remove.
>
> **team\_name** `string`
>
> Required if using a [global API token](https://betterstack.com/docs/uptime/api/getting-started-with-uptime-api/#get-a-global-api-token) to specify the team.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Severity
>
> **Slug:** `BETTER_STACK_DELETE_URGENCY`
>
> Tool to delete a severity (urgency) by ID. Use when you need to permanently remove an existing severity level after confirming its ID.
>
> #### Input Parameters
>
> **urgency\_id** `integer` *required*
>
> The ID of the severity you want to delete
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Urgency Group
>
> **Slug:** `BETTER_STACK_DELETE_URGENCY_GROUP`
>
> Tool to permanently delete an urgency group (severity group) by ID. Use when you need to remove an existing severity group that is no longer needed.
>
> #### Input Parameters
>
> **urgency\_group\_id** `string` *required*
>
> The ID of the urgency group (severity group) to delete. You can get this from the list urgency groups action.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Escalate Incident
>
> **Slug:** `BETTER_STACK_ESCALATE_INCIDENT`
>
> Tool to escalate an ongoing incident to a user, team, schedule, policy, or organization. Use when you need to route an active incident to the appropriate responders with specified notification channels (call, SMS, email, push).
>
> #### Input Parameters
>
> **sms** `boolean`
>
> Enable SMS notification
>
> **call** `boolean`
>
> Enable phone notification
>
> **push** `boolean`
>
> Enable push notification
>
> **email** `boolean`
>
> Enable email notification
>
> **team\_id** `integer`
>
> Team ID to escalate to (required when escalation\_type is Team, alternative to team\_name)
>
> **user\_id** `integer`
>
> User ID to escalate to (required when escalation\_type is User, alternative to user\_email)
>
> **metadata** `object`
>
> Additional metadata key-value pairs to attach to the escalation
>
> **policy\_id** `integer`
>
> Policy ID to escalate to (required when escalation\_type is Policy)
>
> **team\_name** `string`
>
> Team name to escalate to (required when escalation\_type is Team, alternative to team\_id)
>
> **user\_email** `string`
>
> User email to escalate to (required when escalation\_type is User, alternative to user\_id)
>
> **incident\_id** `string` *required*
>
> The identifier of the incident to escalate
>
> **schedule\_id** `integer`
>
> Schedule ID to escalate to (required when escalation\_type is Schedule)
>
> **critical\_alert** `boolean`
>
> Critical push notification (bypasses Do Not Disturb)
>
> **escalation\_type** `string ("User" | "Team" | "Schedule" | "Policy" | "Organization")` *required*
>
> Target type: User, Team, Schedule, Policy, or Organization. Determines which additional identifier field is required.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Export dashboard
>
> **Slug:** `BETTER_STACK_EXPORT_DASHBOARD`
>
> ##### Export a dashboard Retrieves the full configuration of a dashboard or a public template as a JSON object. This is useful for backing up dashboards or creating new dashboards via the [import endpoint](https://betterstack.com/docs/logs/api/dashboards/import/). This endpoint can be used to export both your [own dashboards](https://betterstack.com/docs/logs/api/dashboards/list/) and [dashboard templates](https://betterstack.com/docs/logs/api/dashboards/templates/). GET /api/v2/dashboards/\{id}/export Requires a Telemetry API token with access to the resource.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The unique identifier of the dashboard or template to export.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get alert
>
> **Slug:** `BETTER_STACK_GET_ALERT`
>
> ##### Get a single alert Retrieves a single alert by its ID from any context (dashboard or exploration). GET /api/v2/alerts/\{id} Requires a Telemetry API token with access to the resource.
>
> #### Input Parameters
>
> **id** `integer` *required*
>
> The unique integer identifier of the alert.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Amazon SNS integration
>
> **Slug:** `BETTER_STACK_GET_AMAZON_SNS_INTEGRATION`
>
> ##### Get Amazon SNS integration Returns a single Amazon SNS integration by ID. GET /api/v2/amazon-sns/\{amazon\_sns\_integration\_id} Requires a Better Stack Incidents API token with access to the resource.
>
> #### Input Parameters
>
> **amazon\_sns\_integration\_id** `string` *required*
>
> The ID of the Amazon SNS integration you want to get.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get AWS CloudWatch integration
>
> **Slug:** `BETTER_STACK_GET_AWS_CLOUDWATCH_INTEGRATION`
>
> ##### Get AWS CloudWatch integration Returns a single AWS CloudWatch integration by ID. GET /api/v2/aws-cloudwatch-integrations/\{aws\_cloudwatch\_integration\_id} Requires a Better Stack Incidents API token with access to the resource.
>
> #### Input Parameters
>
> **aws\_cloudwatch\_integration\_id** `string` *required*
>
> The ID of the AWS CloudWatch integration you want to get.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get aws log group subscription
>
> **Slug:** `BETTER_STACK_GET_AWS_LOG_GROUP_SUBSCRIPTION`
>
> Get one AWS log group subscription override, including its region, log group name and subscribed state. Requires an aws source with a connected AWS account and a Telemetry API token with access to that source.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> ID of the log group subscription override
>
> **source\_id** `string` *required*
>
> ID of the `aws` source
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Azure integration
>
> **Slug:** `BETTER_STACK_GET_AZURE_INTEGRATION`
>
> ##### Get Azure integration Returns a single Azure integration by ID. GET /api/v2/azure-integrations/\{azure\_integration\_id} Requires a Better Stack Incidents API token with access to the resource.
>
> #### Input Parameters
>
> **azure\_integration\_id** `string` *required*
>
> The ID of the Azure integration you want to get.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get catalog attribute
>
> **Slug:** `BETTER_STACK_GET_CATALOG_ATTRIBUTE`
>
> ##### Get catalog attribute Returns a single Catalog attribute by ID. GET /api/v2/catalog/relations/\{relation\_id}/attributes/\{attribute\_id} Requires a Better Stack Incidents API token with access to the resource.
>
> #### Input Parameters
>
> **relation\_id** `string` *required*
>
> The ID of the related Catalog relation.
>
> **attribute\_id** `string` *required*
>
> The ID of the Catalog attribute you want to get.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get catalog record
>
> **Slug:** `BETTER_STACK_GET_CATALOG_RECORD`
>
> ##### Get a single Catalog record Returns a single Catalog record by ID. GET /api/v2/catalog/relations/\{relation\_id}/records/\{record\_id} Requires a Better Stack Incidents API token with access to the resource.
>
> #### Input Parameters
>
> **record\_id** `string` *required*
>
> The ID of the Catalog record you want to get.
>
> **relation\_id** `string` *required*
>
> The ID of the related Catalog relation.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get catalog relation
>
> **Slug:** `BETTER_STACK_GET_CATALOG_RELATION`
>
> ##### Get catalog relation Returns a single Catalog relation by ID. GET /api/v2/catalog/relations/\{relation\_id} Requires a Better Stack Incidents API token with access to the resource.
>
> #### Input Parameters
>
> **relation\_id** `string` *required*
>
> The ID of the Catalog relation you want to get.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get chart
>
> **Slug:** `BETTER_STACK_GET_CHART`
>
> ##### Get a single chart Retrieves a single chart by its ID from a specific dashboard. GET /api/v2/dashboards/\{dashboard\_id}/charts/\{id} Requires a Telemetry API token with access to the resource.
>
> #### Input Parameters
>
> **id** `integer` *required*
>
> The unique identifier of the chart.
>
> **dashboard\_id** `integer` *required*
>
> The unique identifier of the dashboard.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get chart comment
>
> **Slug:** `BETTER_STACK_GET_CHART_COMMENT`
>
> ##### Get a single chart comment Returns a single comment from a chart. GET /api/v2/dashboards/\{dashboard\_id}/charts/\{chart\_id}/comments/\{id} Requires a Telemetry API token with access to the resource.
>
> #### Input Parameters
>
> **id** `integer` *required*
>
> The unique identifier of the comment.
>
> **chart\_id** `integer` *required*
>
> The unique identifier of the chart.
>
> **dashboard\_id** `integer` *required*
>
> The unique identifier of the dashboard.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get collector
>
> **Slug:** `BETTER_STACK_GET_COLLECTOR`
>
> ##### Get a single collector Retrieves details for a single collector by its ID. GET /api/v1/collectors/\{id} Requires a Telemetry API token with access to the resource.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The unique identifier of the collector.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get collector metric target
>
> **Slug:** `BETTER_STACK_GET_COLLECTOR_METRIC_TARGET`
>
> ##### Get a single collector metrics target Returns a single collector target by ID. GET /api/v1/collectors/\{collector\_id}/targets/\{target\_id} Requires a Telemetry API token with access to the resource.
>
> #### Input Parameters
>
> **target\_id** `string` *required*
>
> Identifier of the target.
>
> **collector\_id** `string` *required*
>
> Identifier of the collector.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get connection
>
> **Slug:** `BETTER_STACK_GET_CONNECTION`
>
> Retrieve details of a specific ClickHouse connection by ID. Requires a global API token. Returns connection settings and queryable sources; the password is returned only when creating a connection, not by this action.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The ID of the connection to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get dashboard
>
> **Slug:** `BETTER_STACK_GET_DASHBOARD`
>
> ##### Get a single dashboard Retrieves detailed information for a single dashboard by its ID, including its charts, sections, and variables. GET /api/v2/dashboards/\{id} Requires a Telemetry API token with access to the resource.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The unique identifier of the dashboard.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get dashboard alert
>
> **Slug:** `BETTER_STACK_GET_DASHBOARD_ALERT`
>
> ##### Get a single dashboard alert Retrieves a single alert by its ID, scoped to a specific dashboard chart. GET /api/v2/dashboards/\{dashboard\_id}/charts/\{chart\_id}/alerts/\{id} Requires a Telemetry API token with access to the resource.
>
> #### Input Parameters
>
> **id** `integer` *required*
>
> The unique identifier of the alert.
>
> **chart\_id** `integer` *required*
>
> The unique identifier of the chart.
>
> **dashboard\_id** `integer` *required*
>
> The unique identifier of the dashboard.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get dashboard group
>
> **Slug:** `BETTER_STACK_GET_DASHBOARD_GROUP`
>
> ##### Get a single dashboard group Retrieves a single dashboard group by its ID. GET /api/v2/dashboard-groups/\{id} Requires a Telemetry API token with access to the resource.
>
> #### Input Parameters
>
> **id** `integer` *required*
>
> The unique identifier of the dashboard group.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get dashboard section
>
> **Slug:** `BETTER_STACK_GET_DASHBOARD_SECTION`
>
> ##### Get a single dashboard section Retrieves a single section by its ID from a specific dashboard. GET /api/v2/dashboards/\{dashboard\_id}/sections/\{id} Requires a Telemetry API token with access to the resource.
>
> #### Input Parameters
>
> **id** `integer` *required*
>
> The unique identifier of the section.
>
> **dashboard\_id** `integer` *required*
>
> The unique identifier of the dashboard.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Datadog integration
>
> **Slug:** `BETTER_STACK_GET_DATADOG_INTEGRATION`
>
> ##### Get Datadog integration Returns a single Datadog integration by ID. GET /api/v2/datadog-integrations/\{datadog\_integration\_id} Requires a Better Stack Incidents API token with access to the resource.
>
> #### Input Parameters
>
> **datadog\_integration\_id** `string` *required*
>
> The ID of the Datadog integration you want to get.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Elastic integration
>
> **Slug:** `BETTER_STACK_GET_ELASTIC_INTEGRATION`
>
> ##### Get Elastic integration Returns a single Elastic integration by ID. GET /api/v2/elastic-integrations/\{elastic\_integration\_id} Requires a Better Stack Incidents API token with access to the resource.
>
> #### Input Parameters
>
> **elastic\_integration\_id** `string` *required*
>
> The ID of the Elastic integration you want to get.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get email integration
>
> **Slug:** `BETTER_STACK_GET_EMAIL_INTEGRATION`
>
> ##### Get e-mail integration Returns a single e-mail integration by ID. GET /api/v2/email-integrations/:email\_integration\_id Requires a Better Stack Incidents API token with access to the resource.
>
> #### Input Parameters
>
> **email\_integration\_id** `string` *required*
>
> The ID of the e-mail integration you want to get.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Escalation Policy
>
> **Slug:** `BETTER_STACK_GET_ESCALATION_POLICY`
>
> Get an escalation policy by ID, including its repeat settings, team information, and selected step details.
>
> #### Input Parameters
>
> **policy\_id** `string` *required*
>
> The ID of the escalation policy to retrieve
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get exploration
>
> **Slug:** `BETTER_STACK_GET_EXPLORATION`
>
> ##### Get a single exploration Retrieves a single exploration by its ID, including the full chart, query, and variable configurations. GET /api/v2/explorations/\{id} Requires a Telemetry API token with access to the resource.
>
> #### Input Parameters
>
> **id** `integer` *required*
>
> The unique identifier of the exploration.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get exploration alert
>
> **Slug:** `BETTER_STACK_GET_EXPLORATION_ALERT`
>
> ##### Get a single exploration alert Retrieves a single alert by its ID, scoped to a specific exploration. GET /api/v2/explorations/\{exploration\_id}/alerts/\{id} Requires a Telemetry API token with access to the resource.
>
> #### Input Parameters
>
> **id** `integer` *required*
>
> The unique identifier of the alert.
>
> **exploration\_id** `integer` *required*
>
> The unique identifier of the exploration.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get exploration group
>
> **Slug:** `BETTER_STACK_GET_EXPLORATION_GROUP`
>
> ##### Get a single exploration group Retrieves a single exploration group by its ID. GET /api/v2/exploration-groups/\{id} Requires a Telemetry API token with access to the resource.
>
> #### Input Parameters
>
> **id** `integer` *required*
>
> The unique identifier of the exploration group.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Google Monitoring integration
>
> **Slug:** `BETTER_STACK_GET_GOOGLE_MONITORING_INTEGRATION`
>
> ##### Get Google Monitoring integration Returns a single Google Monitoring integration by ID. GET /api/v2/google-monitoring-integrations/\{google\_monitoring\_integration\_id} Requires a Better Stack Incidents API token with access to the resource.
>
> #### Input Parameters
>
> **google\_monitoring\_integration\_id** `string` *required*
>
> The ID of the Google Monitoring integration you want to get.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Grafana integration
>
> **Slug:** `BETTER_STACK_GET_GRAFANA_INTEGRATION`
>
> ##### Get Grafana integration Returns a single Grafana integration by ID. GET /api/v2/grafana-integrations/\{grafana\_integration\_id} Requires a Better Stack Incidents API token with access to the resource.
>
> #### Input Parameters
>
> **grafana\_integration\_id** `string` *required*
>
> The ID of the Grafana integration you want to get.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Heartbeat
>
> **Slug:** `BETTER_STACK_GET_HEARTBEAT`
>
> Tool to get a single heartbeat by ID. Use when you need to fetch details of a specific heartbeat.
>
> #### Input Parameters
>
> **heartbeat\_id** `string` *required*
>
> The ID of the requested heartbeat
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Heartbeat Availability
>
> **Slug:** `BETTER_STACK_GET_HEARTBEAT_AVAILABILITY`
>
> Tool to retrieve availability summary for a specific heartbeat. Use when you need availability metrics for a heartbeat within an optional date range.
>
> #### Input Parameters
>
> **to\_date** `string`
>
> End date (inclusive) for the summary in YYYY-MM-DD format
>
> **from\_date** `string`
>
> Start date (inclusive) for the summary in YYYY-MM-DD format
>
> **heartbeat\_id** `string` *required*
>
> ID of the heartbeat to retrieve availability for
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Heartbeat Group
>
> **Slug:** `BETTER_STACK_GET_HEARTBEAT_GROUP`
>
> Tool to get a single heartbeat group by ID. Use when you need to fetch details of a specific heartbeat group.
>
> #### Input Parameters
>
> **heartbeat\_group\_id** `string` *required*
>
> The ID of the heartbeat group to retrieve
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Incident Comment
>
> **Slug:** `BETTER_STACK_GET_INCIDENT_COMMENT`
>
> Tool to get a single comment from an incident. Use when you need to retrieve details of a specific comment on a Better Stack incident.
>
> #### Input Parameters
>
> **comment\_id** `string` *required*
>
> The ID of the comment to retrieve
>
> **incident\_id** `string` *required*
>
> The ID of the incident containing the comment
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get incoming webhook
>
> **Slug:** `BETTER_STACK_GET_INCOMING_WEBHOOK`
>
> ##### Get incoming webhook Returns a single incoming webhook by ID. GET /api/v2/incoming-webhooks/:incoming\_webhook\_id Requires a Better Stack Incidents API token with access to the resource.
>
> #### Input Parameters
>
> **incoming\_webhook\_id** `string` *required*
>
> The ID of the incoming webhook you want to get.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Jira integration
>
> **Slug:** `BETTER_STACK_GET_JIRA_INTEGRATION`
>
> ##### Get Jira integration Returns a single Jira integration by ID. GET /api/v2/jira-integrations/:jira\_integration\_id Requires a Better Stack Incidents API token with access to the resource.
>
> #### Input Parameters
>
> **jira\_integration\_id** `string` *required*
>
> The ID of the Jira integration you want to get.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Monitor
>
> **Slug:** `BETTER_STACK_GET_MONITOR`
>
> Tool to get a single monitor. Use when you need full details of a specific monitor by its ID.
>
> #### Input Parameters
>
> **monitor\_id** `string` *required*
>
> The ID of the monitor to retrieve
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Monitor Availability
>
> **Slug:** `BETTER_STACK_GET_MONITOR_AVAILABILITY`
>
> Get an availability summary for a specific monitor over an optional date range, including uptime percentage, downtime, incident count, and incident duration statistics.
>
> #### Input Parameters
>
> **to\_date** `string`
>
> End date (inclusive) for the summary in YYYY-MM-DD format
>
> **from\_date** `string`
>
> Start date (inclusive) for the summary in YYYY-MM-DD format
>
> **monitor\_id** `string` *required*
>
> The ID of the monitor to retrieve availability for
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Monitor Group
>
> **Slug:** `BETTER_STACK_GET_MONITOR_GROUPS`
>
> Tool to get a single monitor group by ID. Use when you need to fetch details of a specific monitor group.
>
> #### Input Parameters
>
> **monitor\_group\_id** `string` *required*
>
> The ID of the monitor group to retrieve
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Monitor Group's Monitors
>
> **Slug:** `BETTER_STACK_GET_MONITOR_GROUPS_MONITORS`
>
> Tool to get all monitors belonging to a monitor group. Use when you need to retrieve all monitors within a specific monitor group, with optional pagination support.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number to return. Starts at 1.
>
> **per\_page** `integer`
>
> Number of monitors per page. Default is 50, maximum is 250.
>
> **monitor\_group\_id** `integer` *required*
>
> The ID of the monitor group to retrieve monitors for
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Monitor Response Times
>
> **Slug:** `BETTER_STACK_GET_MONITOR_RESPONSE_TIMES`
>
> Retrieves response time metrics for a specific uptime monitor, including DNS, connection, TLS handshake, and data transfer timings grouped by region. Results are limited to one record per region by default; an optional limit can request more.
>
> #### Input Parameters
>
> **to** `string`
>
> Optional end date (inclusive) for filtering response times in ISO 8601 format. If not specified, defaults to now.
>
> **from** `string`
>
> Optional start date (inclusive) for filtering response times in ISO 8601 format. If not specified, defaults to 24 hours ago.
>
> **limit** `integer`
>
> Maximum number of response time records to return per region. Defaults to 1 if not specified to prevent oversized responses.
>
> **monitor\_id** `string` *required*
>
> The unique numeric ID of the monitor to retrieve response times for. Obtain this from the list\_monitors action.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get New Relic integration
>
> **Slug:** `BETTER_STACK_GET_NEW_RELIC_INTEGRATION`
>
> ##### Get New Relic integration Returns a single New Relic integration by ID. GET /api/v2/new-relic-integrations/\{new\_relic\_integration\_id} Requires a Better Stack Incidents API token with access to the resource.
>
> #### Input Parameters
>
> **new\_relic\_integration\_id** `string` *required*
>
> The ID of the New Relic integration you want to get.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get on-call event
>
> **Slug:** `BETTER_STACK_GET_ON_CALL_EVENT`
>
> ##### Get a single on-call schedule event Get a single event from an on-call schedule. GET /api/v2/on-calls/\{schedule\_id}/events/\{event\_id} Requires a Better Stack Incidents API token with access to the resource.
>
> #### Input Parameters
>
> **event\_id** `string` *required*
>
> The ID of the event to return.
>
> **schedule\_id** `string` *required*
>
> The ID of the on-call schedule you want to get events for. Use `default` to refer to the default on-call schedule for the team.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get On-Call Schedule
>
> **Slug:** `BETTER_STACK_GET_ON_CALL_SCHEDULE`
>
> Tool to get a single on-call schedule by ID. Use when you need to retrieve who is currently on-call for a specific schedule. Optionally specify a date to check on-call status at a specific time.
>
> #### Input Parameters
>
> **date** `string`
>
> ISO-8601-formatted date or date-time for looking up on-call at a specific time
>
> **schedule\_id** `string` *required*
>
> The ID of the on-call schedule you want to get. Use 'default' if you want to get the default on-call
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get outgoing email
>
> **Slug:** `BETTER_STACK_GET_OUTGOING_EMAIL`
>
> ##### Get outgoing e-mail Returns a single outgoing e-mail integration by ID. GET /api/v2/outgoing-emails/\{integration\_id} Requires a Better Stack Incidents API token with access to the resource.
>
> #### Input Parameters
>
> **integration\_id** `string` *required*
>
> The ID of the outgoing e-mail integration.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Outgoing Webhook Integration
>
> **Slug:** `BETTER_STACK_GET_OUTGOING_WEBHOOK`
>
> Tool to get a single outgoing webhook integration by ID. Use when you need to retrieve details of a specific webhook integration.
>
> #### Input Parameters
>
> **outgoing\_webhook\_id** `string` *required*
>
> The ID of the Outgoing Webhook integration you want to get. You can get this from the list or create outgoing webhook actions.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get PagerDuty integration
>
> **Slug:** `BETTER_STACK_GET_PAGERDUTY_INTEGRATION`
>
> ##### Get PagerDuty integration Returns a single PagerDuty integration by ID. GET /api/v2/pager-duty-webhooks/\{pager\_duty\_webhook\_id} Requires a Better Stack Incidents API token with access to the resource.
>
> #### Input Parameters
>
> **pager\_duty\_webhook\_id** `string` *required*
>
> The ID of the PagerDuty integration you want to get.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Escalation Policy Group
>
> **Slug:** `BETTER_STACK_GET_POLICY_GROUP`
>
> Tool to get a single escalation policy group. Use when you need full details of a specific escalation policy group by its ID.
>
> #### Input Parameters
>
> **policy\_group\_id** `string` *required*
>
> The ID of the escalation policy group to retrieve
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get product usage
>
> **Slug:** `BETTER_STACK_GET_PRODUCT_USAGE`
>
> Retrieve organization usage or incurred cost for one product, itemized by resource. Requires a global API token. Discover product IDs and dimension names using the usage overview; dimension=cost returns incurred cost. Defaults to the last 30 days, without pagination, with a maximum requested range of 400 days. Buckets align to calendar days, weeks, months or quarters and may extend beyond the requested range. Non-day buckets use date\_from/date\_to instead of date. Future end dates are clamped to today.
>
> #### Input Parameters
>
> **to** `string`
>
> End date in the `YYYY-MM-DD` format, inclusive. Defaults to today. Future dates are clamped to today.
>
> **from** `string`
>
> Start date in the `YYYY-MM-DD` format, inclusive. Defaults to 29 days before `to`. The range between `from` and `to` can span at most 400 days.
>
> **product** `string` *required*
>
> The product `id` from the [usage overview](https://betterstack.com/docs/uptime/api/usage/overview/), for example `logs`, `traces`, `metrics`, or `monitors`.
>
> **dimension** `string`
>
> A dimension name from the [usage overview](https://betterstack.com/docs/uptime/api/usage/overview/), or `cost` for the product's incurred cost. Defaults to the product's `default_dimension`. Dimension names vary per product and plan, so discover them through the overview.
>
> **resolution** `string ("day" | "week" | "month" | "quarter")`
>
> Bucket size: `day`, `week`, `month`, or `quarter`. Defaults to `day`.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Prometheus integration
>
> **Slug:** `BETTER_STACK_GET_PROMETHEUS_INTEGRATION`
>
> ##### Get Prometheus integration Returns a single Prometheus integration by ID. GET /api/v2/prometheus-integrations/\{prometheus\_integration\_id} Requires a Better Stack Incidents API token with access to the resource.
>
> #### Input Parameters
>
> **prometheus\_integration\_id** `string` *required*
>
> The ID of the Prometheus integration you want to get.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get schedule rotation
>
> **Slug:** `BETTER_STACK_GET_SCHEDULE_ROTATION`
>
> ##### Get an on-call schedule rotation Returns the currently used on-call rotation for a single on-call schedule. GET /api/v2/on-calls/\{schedule\_id}/rotation Requires a Better Stack Incidents API token with access to the resource.
>
> #### Input Parameters
>
> **team\_name** `string`
>
> Required if using [global API token](https://betterstack.com/docs/uptime/api/getting-started-with-uptime-api/#get-a-global-api-token) to specify the team which owns the resource.
>
> **schedule\_id** `string` *required*
>
> The ID of the on-call schedule you want to get events for. Use `default` to refer to the default on-call schedule for the team.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Slack integration
>
> **Slug:** `BETTER_STACK_GET_SLACK_INTEGRATION`
>
> ##### Get Slack integration Returns a single Slack integration by ID. GET /api/v2/slack-integrations/\{slack\_integration\_id} Requires a Better Stack Incidents API token with access to the resource.
>
> #### Input Parameters
>
> **slack\_integration\_id** `string` *required*
>
> The ID of the Slack integration you want to get.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get source
>
> **Slug:** `BETTER_STACK_GET_SOURCE`
>
> ##### Get a single source Get a single source by its ID. GET /api/v2/sources/\{source\_id} Requires a Telemetry API token with access to the resource.
>
> #### Input Parameters
>
> **source\_id** `string` *required*
>
> Identifier of the source.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get source group
>
> **Slug:** `BETTER_STACK_GET_SOURCE_GROUP`
>
> ##### Get a single source group Get a single source group by its ID. GET /api/v1/source-groups/\{id} Requires a Telemetry API token with access to the resource.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The ID of the source group you want to get
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Splunk integration
>
> **Slug:** `BETTER_STACK_GET_SPLUNK_INTEGRATION`
>
> ##### Get Splunk integration Returns a single Splunk On-Call integration by ID. GET /api/v2/splunk-on-calls/\{splunk\_on\_call\_id} Requires a Better Stack Incidents API token with access to the resource.
>
> #### Input Parameters
>
> **splunk\_on\_call\_id** `string` *required*
>
> The ID of the Splunk On-Call integration you want to get.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Status Page
>
> **Slug:** `BETTER_STACK_GET_STATUS_PAGE`
>
> Tool to get a single status page by ID. Use when you need detailed information about a specific status page.
>
> #### Input Parameters
>
> **status\_page\_id** `string` *required*
>
> The ID of the status page to retrieve
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Status Page Group
>
> **Slug:** `BETTER_STACK_GET_STATUS_PAGE_GROUP`
>
> Tool to get a single status page group by ID. Use when you need to retrieve details of a specific status page group.
>
> #### Input Parameters
>
> **status\_page\_group\_id** `string` *required*
>
> The unique identifier for the specific status page group to retrieve
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Status Page Report
>
> **Slug:** `BETTER_STACK_GET_STATUS_PAGE_REPORT`
>
> Tool to get a single status page report by ID. Use when you need detailed information about a specific status report or incident.
>
> #### Input Parameters
>
> **report\_id** `string` *required*
>
> The numeric ID of the status report to retrieve (e.g., '824274').
>
> **status\_page\_id** `string` *required*
>
> The numeric ID of the status page (e.g., '221582'). Obtain this from the list\_status\_pages action.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Status Page Resource
>
> **Slug:** `BETTER_STACK_GET_STATUS_PAGE_RESOURCE`
>
> Tool to get a single status page resource by ID. Use when you need detailed information about a specific resource on a status page.
>
> #### Input Parameters
>
> **resource\_id** `string` *required*
>
> The ID of the status page resource
>
> **status\_page\_id** `string` *required*
>
> The ID of the status page
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Status Page Section
>
> **Slug:** `BETTER_STACK_GET_STATUS_PAGE_SECTION`
>
> Tool to get a single status page section. Use when you need details of a specific section within a status page by its ID.
>
> #### Input Parameters
>
> **section\_id** `string` *required*
>
> The ID of the section you want to get
>
> **status\_page\_id** `string` *required*
>
> The ID of your status page
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get status page subscriber
>
> **Slug:** `BETTER_STACK_GET_STATUS_PAGE_SUBSCRIBER`
>
> ##### Get status page subscriber Returns a single e-mail subscriber of your status page. GET /api/v2/status-pages/\{status\_page\_id}/subscribers/\{subscriber\_id} Requires a Better Stack Incidents API token with access to the resource.
>
> #### Input Parameters
>
> **subscriber\_id** `string` *required*
>
> The ID of the subscriber.
>
> **status\_page\_id** `string` *required*
>
> The ID of your status page.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Status Update
>
> **Slug:** `BETTER_STACK_GET_STATUS_UPDATE`
>
> Tool to get a single status update by its ID. Use when you need details of a specific status update for a status report on your status page.
>
> #### Input Parameters
>
> **status\_page\_id** `string` *required*
>
> The ID of your status page. Obtain from list\_status\_pages action.
>
> **status\_report\_id** `string` *required*
>
> The ID of your status page report. Obtain from list\_status\_page\_reports action.
>
> **status\_update\_id** `string` *required*
>
> The ID of your status update. Obtain from list\_status\_page\_status\_report\_status\_updates action or after creating a status update.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get team member
>
> **Slug:** `BETTER_STACK_GET_TEAM_MEMBER`
>
> ##### Get a single team member Returns a single team member by their ID. This endpoint does not return pending invitations. You can retrieve a specific member or invitation by providing an `email` query parameter in [List all team members API](https://betterstack.com/docs/uptime/api/team-members/list/). The `role` attribute is the team member's role **in the team your API token is scoped to**. A user with different roles in different teams returns different values depending on which team's token you use. Possible values: `admin`, `billing_admin`, `team_lead`, `responder`, `member`, or `custom`. `custom` is returned when the user has a non-system custom role. GET /api/v2/team-members/\{id} Requires a Better Stack Incidents API token with access to the resource.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The ID of the team member.
>
> **team\_name** `string`
>
> Required if using a [global API token](https://betterstack.com/docs/uptime/api/getting-started-with-uptime-api/#get-a-global-api-token) to specify the team.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Uptime API Token
>
> **Slug:** `BETTER_STACK_GET_UPTIME_API_TOKEN`
>
> Tool to retrieve the configured Uptime API token. Use when you need the Uptime API token for subsequent authenticated API calls.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Severity Level
>
> **Slug:** `BETTER_STACK_GET_URGENCY`
>
> Tool to get a single severity level (urgency) by ID. Use when you need to fetch details of a specific urgency configuration.
>
> #### Input Parameters
>
> **urgency\_id** `string` *required*
>
> The ID of the severity level you're interested in
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Urgency Group
>
> **Slug:** `BETTER_STACK_GET_URGENCY_GROUP`
>
> Tool to get a single urgency group (severity group) by ID. Use when you need to fetch details of a specific urgency group.
>
> #### Input Parameters
>
> **urgency\_group\_id** `string` *required*
>
> The ID of the urgency group (severity group) to retrieve. You can get this from the list urgency groups action.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get usage overview
>
> **Slug:** `BETTER_STACK_GET_USAGE_OVERVIEW`
>
> Get organization-wide product usage and incurred costs for an inclusive date range. Requires a global API token. Returns all products without pagination, including product IDs, dimensions and default dimensions for subsequent per-product usage queries. Defaults to the last 30 days when from/to are omitted.
>
> #### Input Parameters
>
> **to** `string`
>
> End date in the `YYYY-MM-DD` format, inclusive. Defaults to today. Future dates are clamped to today.
>
> **from** `string`
>
> Start date in the `YYYY-MM-DD` format, inclusive. Defaults to 29 days before `to`. The range between `from` and `to` can span at most 400 days.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Import dashboard
>
> **Slug:** `BETTER_STACK_IMPORT_DASHBOARD`
>
> Create a new dashboard from exported JSON, queuing its import asynchronously. Set name or data.name. The response is a minimal dashboard representation; charts and sections may not yet reflect their final imported configuration. Requires a Telemetry API token; global tokens also require team\_name.
>
> #### Input Parameters
>
> **data** `object` *required*
>
> The dashboard configuration data in JSON format, typically obtained from the [Export dashboard](https://betterstack.com/docs/logs/api/dashboards/export/) endpoint. This object can include a `name` key for the new dashboard. At least one of the top-level `name` parameter or `data.name` must be set.
>
> **name** `string`
>
> A name for the new dashboard. If not provided, the `name` field within the `data` parameter will be used. At least one of these `name` fields must be set.
>
> **team\_name** `string`
>
> Required if using [global API token](https://betterstack.com/docs/logs/api/getting-started/#get-a-global-api-token) to specify the team which should own the resource
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Invite team member
>
> **Slug:** `BETTER_STACK_INVITE_TEAM_MEMBER`
>
> Invite a user to your organization or add an existing member to another team. Authenticate with a global API token and team\_name, or a team-scoped Incidents API token. Assign role by name or role\_id from List roles (including custom roles); both must match if supplied together. Defaults to responder. Admin invitations are forbidden. Billing admin invitations require a global token because the role applies across the organization. Returns an invitation when sent (201), or existing member details if already in the team (200).
>
> #### Input Parameters
>
> **role** `string ("responder" | "member" | "team_lead" | "billing_admin")`
>
> The role to assign to the user. Defaults to responder. Use role\_id to assign a custom role. Assigning billing\_admin requires a global API token.
>
> **email** `string` *required*
>
> The e-mail address of the user to invite.
>
> **role\_id** `string`
>
> The ID of the role to assign, including custom roles, as returned by the [List roles API](https://betterstack.com/docs/uptime/api/roles/list/). Provide either `role` or `role_id`. If both are given they must reference the same role.
>
> **team\_name** `string`
>
> Required if using a [global API token](https://betterstack.com/docs/uptime/api/getting-started-with-uptime-api/#get-a-global-api-token) to specify the team.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List alerts
>
> **Slug:** `BETTER_STACK_LIST_ALERTS`
>
> List alerts accessible to the user across all dashboards and explorations. Returns one page; use page/per\_page and the returned pagination links to continue. Requires a Telemetry API token with access to the resource.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number for pagination.
>
> **per\_page** `integer`
>
> Number of items per page (max 250).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Amazon SNS integrations
>
> **Slug:** `BETTER_STACK_LIST_AMAZON_SNS_INTEGRATIONS`
>
> List one page of Amazon SNS integrations, optionally filtered by team. Use page/per\_page and returned pagination links to continue. Requires a Better Stack Incidents API token with access to the resource.
>
> #### Input Parameters
>
> **page** `integer`
>
> The page number to return, starting with `1`.
>
> **per\_page** `integer`
>
> Number of results per page. Defaults to `50`, maximum `250`.
>
> **team\_name** `string`
>
> Filter integrations belonging to a specified team when using [global API token](https://betterstack.com/docs/uptime/api/getting-started-with-uptime-api/#get-a-global-api-token).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List AWS CloudWatch Integrations
>
> **Slug:** `BETTER_STACK_LIST_AWS_CLOUDWATCH_INTEGRATIONS`
>
> Tool to list all AWS CloudWatch integrations. Use when you need to retrieve and inspect all configured AWS CloudWatch on-call integrations.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number to return. Starts at 1.
>
> **per\_page** `integer`
>
> Number of integrations per page. Default is 50, maximum is 250.
>
> **team\_name** `string`
>
> Filter integrations belonging to a specified team. Only valid when using a global API token.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List AWS log group subscriptions
>
> **Slug:** `BETTER_STACK_LIST_AWS_LOG_GROUP_SUBSCRIPTIONS`
>
> List one page of Amazon CloudWatch log group subscription overrides for an `aws` source with an AWS account already connected. Overrides specify whether Better Stack ingests each log group and take precedence over the source's auto-subscribe setting. Returns overrides, not every discovered log group. Use page/per\_page and returned pagination links to continue. Requires a Telemetry API token with access to the source.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number
>
> **per\_page** `integer`
>
> Number of subscriptions per page. Default 50, maximum 250.
>
> **source\_id** `string` *required*
>
> ID of the `aws` source with an AWS account already connected.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Azure Integrations
>
> **Slug:** `BETTER_STACK_LIST_AZURE_INTEGRATIONS`
>
> Tool to list all Azure integrations. Use when you need to retrieve and inspect all configured Azure on-call integrations.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number to return. Starts at 1.
>
> **per\_page** `integer`
>
> Number of integrations per page. Default is 50, maximum is 250.
>
> **team\_name** `string`
>
> Filter integrations belonging to a specified team. Only valid when using a global API token.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List catalog attributes
>
> **Slug:** `BETTER_STACK_LIST_CATALOG_ATTRIBUTES`
>
> ##### List catalog attributes Returns a list of all Catalog attributes for a [Catalog relation](https://betterstack.com/docs/uptime/api/list-all-catalog-relations/). GET /api/v2/catalog/relations/\{relation\_id}/attributes Requires a Better Stack Incidents API token with access to the resource.
>
> #### Input Parameters
>
> **relation\_id** `string` *required*
>
> The ID of the Catalog relation you want to get attributes for.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List catalog records
>
> **Slug:** `BETTER_STACK_LIST_CATALOG_RECORDS`
>
> List one page of Catalog records for a relation. Use page/per\_page and returned pagination links to continue. Requires a Better Stack Incidents API token with access to the resource.
>
> #### Input Parameters
>
> **page** `integer`
>
> The page number to return, starting with `1`.
>
> **per\_page** `integer`
>
> Number of results per page. Defaults to `50`, maximum `250`.
>
> **relation\_id** `string` *required*
>
> The ID of the Catalog relation you want to get records for.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Catalog Relations
>
> **Slug:** `BETTER_STACK_LIST_CATALOG_RELATIONS`
>
> Tool to list all catalog relations. Use when you need to retrieve all catalog relations, supports pagination.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number to return. Starts at 1.
>
> **per\_page** `integer`
>
> Number of resources per page. Default is 50, maximum is 250.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List chart comments
>
> **Slug:** `BETTER_STACK_LIST_CHART_COMMENTS`
>
> List one page of chart comments ordered by pinned time, oldest first. Use page/per\_page and returned pagination links to continue. Requires a Telemetry API token with access to the resource.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number for pagination.
>
> **chart\_id** `integer` *required*
>
> The unique identifier of the chart.
>
> **per\_page** `integer`
>
> Number of items per page (max 250).
>
> **dashboard\_id** `integer` *required*
>
> The unique identifier of the dashboard.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List charts
>
> **Slug:** `BETTER_STACK_LIST_CHARTS`
>
> ##### List all charts Retrieves a list of all charts on a specific dashboard. GET /api/v2/dashboards/\{dashboard\_id}/charts Requires a Telemetry API token with access to the resource.
>
> #### Input Parameters
>
> **dashboard\_id** `integer` *required*
>
> The unique identifier of the dashboard.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List collector hosts
>
> **Slug:** `BETTER_STACK_LIST_COLLECTOR_HOSTS`
>
> ##### List hosts where a collector is running Returns a list of hosts where the specified collector is running. GET /api/v1/collectors/\{id}/hosts Requires a Telemetry API token with access to the resource.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The unique identifier of the collector.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List collector metrics targets
>
> **Slug:** `BETTER_STACK_LIST_COLLECTOR_METRICS_TARGETS`
>
> List one page of metrics targets belonging to a collector. Use page/per\_page and returned pagination links to continue. Requires a Telemetry API token with access to the resource.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number for pagination.
>
> **per\_page** `integer`
>
> Number of items per page. Default 50, maximum 250.
>
> **collector\_id** `string` *required*
>
> Identifier of the collector.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List collectors
>
> **Slug:** `BETTER_STACK_LIST_COLLECTORS`
>
> List one page of collectors accessible by the authenticated user. Use page/per\_page and returned pagination links to continue. Requires a Telemetry API token with access to the collectors.
>
> #### Input Parameters
>
> **name** `string`
>
> Filter collectors by name (case-insensitive partial match).
>
> **page** `integer`
>
> Page number for pagination. Defaults to 1 when omitted.
>
> **per\_page** `integer`
>
> Number of items per page (max 250). Defaults to 50 when omitted.
>
> **team\_name** `string`
>
> Required if using a [global API token](https://betterstack.com/docs/logs/api/getting-started/#get-a-global-api-token) to filter for a specific team. If omitted, collectors from all teams in the organization are returned.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List connections
>
> **Slug:** `BETTER_STACK_LIST_CONNECTIONS`
>
> List one page of ClickHouse connections. Use page/per\_page and the returned pagination links to continue. Retrieve an individual connection for full details including data sources. Passwords are returned only when creating a connection. Requires a global Telemetry API token; team-specific tokens cannot authenticate this endpoint.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number for pagination
>
> **per\_page** `integer`
>
> Number of items per page (default: 50, max: 250)
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List dashboard alerts
>
> **Slug:** `BETTER_STACK_LIST_DASHBOARD_ALERTS`
>
> ##### List all alerts in a dashboard Retrieves all alerts associated with a specific dashboard chart. This endpoint is not paginated. GET /api/v2/dashboards/\{dashboard\_id}/charts/\{chart\_id}/alerts Requires a Telemetry API token with access to the resource.
>
> #### Input Parameters
>
> **chart\_id** `integer` *required*
>
> The unique identifier of the chart.
>
> **dashboard\_id** `integer` *required*
>
> The unique identifier of the dashboard.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List dashboard groups
>
> **Slug:** `BETTER_STACK_LIST_DASHBOARD_GROUPS`
>
> List one page of your team's dashboard groups. Use page/per\_page and the returned pagination links to continue. Requires a Telemetry API token with access to the resource.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number for pagination.
>
> **per\_page** `integer`
>
> Number of items per page (max 250).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List dashboards
>
> **Slug:** `BETTER_STACK_LIST_DASHBOARDS`
>
> List one page of the team's dashboards, optionally filtered by name or dashboard group. Returns summarized dashboard attributes, not full variables, charts, or sections; retrieve an individual dashboard for its full configuration. Use page/per\_page and the returned pagination links to continue. Requires a Telemetry API token.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number for pagination. Defaults to 1 at the provider.
>
> **query** `string`
>
> Search for dashboards by name.
>
> **per\_page** `integer`
>
> Number of items per page. Defaults to 50 at the provider; maximum 250.
>
> **dashboard\_group\_id** `integer`
>
> Filter dashboards by the ID of a dashboard group.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List dashboard sections
>
> **Slug:** `BETTER_STACK_LIST_DASHBOARD_SECTIONS`
>
> ##### List all dashboard sections Retrieves a list of all sections on a specific dashboard. This endpoint is not paginated; it returns all sections for a given dashboard in a single response. GET /api/v2/dashboards/\{dashboard\_id}/sections Requires a Telemetry API token with access to the resource.
>
> #### Input Parameters
>
> **dashboard\_id** `integer` *required*
>
> The unique identifier of the dashboard.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List dashboards in group
>
> **Slug:** `BETTER_STACK_LIST_DASHBOARDS_IN_GROUP`
>
> ##### List dashboards in a group Retrieves a paginated list of dashboards within a specific group. GET /api/v2/dashboard-groups/\{id}/dashboards Returns one page; use page/per\_page and the returned pagination links to continue. Requires a Telemetry API token with access to the resource.
>
> #### Input Parameters
>
> **id** `integer` *required*
>
> The unique identifier of the dashboard group.
>
> **page** `integer`
>
> Page number for pagination.
>
> **query** `string`
>
> Search for dashboards by name within the group.
>
> **per\_page** `integer`
>
> Number of items per page (max 250).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List dashboard templates
>
> **Slug:** `BETTER_STACK_LIST_DASHBOARD_TEMPLATES`
>
> ##### List dashboard templates Retrieves a list of all available dashboard templates. This endpoint is not paginated and returns all available templates in a single response. \[note] The `id` returned for each template can be used with the [Export dashboard](https://betterstack.com/docs/logs/api/dashboards/export/) endpoint to retrieve the full JSON configuration for that template. \[/note] GET /api/v2/dashboards/templates Requires a Telemetry API token with access to the resource.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Datadog Integrations
>
> **Slug:** `BETTER_STACK_LIST_DATADOG_INTEGRATIONS`
>
> Tool to list all Datadog integrations. Use when you need to retrieve and inspect all configured Datadog on-call integrations.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number to return. Starts at 1.
>
> **per\_page** `integer`
>
> Number of integrations per page. Default is 50, maximum is 250.
>
> **team\_name** `string`
>
> Filter integrations belonging to a specified team. Only valid when using a global API token.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Elastic Integrations
>
> **Slug:** `BETTER_STACK_LIST_ELASTIC_INTEGRATIONS`
>
> Tool to list Elastic integrations. Use when you need to retrieve and inspect all configured Elastic integrations.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number to return. Starts at 1.
>
> **per\_page** `integer`
>
> Number of integrations per page. Default is 50, maximum is 250.
>
> **team\_name** `string`
>
> Filter integrations by team name. Useful when using a global API token to narrow results to a specific team.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Email Integrations
>
> **Slug:** `BETTER_STACK_LIST_EMAIL_INTEGRATIONS`
>
> Tool to list email integrations. Use when you need to retrieve and inspect all configured email integrations with optional team filtering and pagination support.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number to return. Starts at 1.
>
> **team\_name** `string`
>
> Filter email integrations by team name. Useful when using a global API token to narrow results to a specific team.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List exploration alerts
>
> **Slug:** `BETTER_STACK_LIST_EXPLORATION_ALERTS`
>
> ##### List all alerts in an exploration Retrieves all alerts associated with a specific exploration. This endpoint is not paginated. GET /api/v2/explorations/\{exploration\_id}/alerts Requires a Telemetry API token with access to the resource.
>
> #### Input Parameters
>
> **exploration\_id** `integer` *required*
>
> The unique identifier of the exploration.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List exploration groups
>
> **Slug:** `BETTER_STACK_LIST_EXPLORATION_GROUPS`
>
> List one page of the team's exploration groups. Use page/per\_page and returned pagination links to continue. Requires a Telemetry API token with access to the resource.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number for pagination.
>
> **per\_page** `integer`
>
> Number of items per page (max 250).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List explorations
>
> **Slug:** `BETTER_STACK_LIST_EXPLORATIONS`
>
> List one page of your team's exploration summaries. Use page/per\_page and the returned pagination links to continue. For full chart, query, and variable configurations, retrieve an individual exploration. Requires a Telemetry API token with access to the resource.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number for pagination.
>
> **per\_page** `integer`
>
> Number of items per page (max 250).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List explorations in group
>
> **Slug:** `BETTER_STACK_LIST_EXPLORATIONS_IN_GROUP`
>
> ##### List explorations in a group Retrieves a paginated list of explorations within a specific group. GET /api/v2/exploration-groups/\{id}/explorations Returns one page; use page/per\_page and the returned pagination links to continue. Requires a Telemetry API token with access to the resource.
>
> #### Input Parameters
>
> **id** `integer` *required*
>
> The unique identifier of the exploration group.
>
> **page** `integer`
>
> Page number for pagination.
>
> **query** `string`
>
> Search for explorations by name within the group.
>
> **per\_page** `integer`
>
> Number of items per page (max 250).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Google Monitoring Integrations
>
> **Slug:** `BETTER_STACK_LIST_GOOGLE_MONITORING_INTEGRATIONS`
>
> Tool to list all Google Monitoring integrations. Use when you need to view your configured Google Monitoring on-call integrations with pagination support.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number to return. Starts at 1.
>
> **per\_page** `integer`
>
> Number of integrations per page. Default is 50, maximum is 250.
>
> **team\_name** `string`
>
> Filter integrations by team name. Only returns integrations belonging to the specified team. Useful when using a global API token to filter results.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Grafana Integrations
>
> **Slug:** `BETTER_STACK_LIST_GRAFANA_INTEGRATIONS`
>
> Tool to list all Grafana integrations. Use when you need to retrieve and inspect all configured Grafana integrations.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number for pagination. Defaults to 1.
>
> **team\_name** `string`
>
> Filter integrations belonging to a specified team. Only valid when using a global API token.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Heartbeat Groups
>
> **Slug:** `BETTER_STACK_LIST_HEARTBEAT_GROUPS`
>
> Lists a page of heartbeat groups, with optional team-name filtering and pagination controls.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number to return. Starts at 1.
>
> **per\_page** `integer`
>
> Number of heartbeat groups per page. Default is 50, maximum is 250.
>
> **team\_name** `string`
>
> Filter heartbeat groups belonging to a specified team when using global API token
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Heartbeats
>
> **Slug:** `BETTER_STACK_LIST_HEARTBEATS`
>
> Lists a page of configured uptime heartbeats, with optional pagination and team-name filtering.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number to return. Starts at 1.
>
> **team\_name** `string`
>
> Filter heartbeats belonging to a specific team. Only applicable when using a global API token.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Incidents Comments
>
> **Slug:** `BETTER_STACK_LIST_INCIDENTS_COMMENTS`
>
> Tool to list all comments on an incident. Use when you need to retrieve all comments associated with a Better Stack incident.
>
> #### Input Parameters
>
> **incident\_id** `string` *required*
>
> The ID of the incident to list comments for
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Incidents Timeline
>
> **Slug:** `BETTER_STACK_LIST_INCIDENTS_TIMELINE`
>
> Tool to retrieve all timeline events for an incident. Use when you need to get a chronological history of events, comments, responses, and changes for a specific incident in Better Stack. Returns all timeline items without pagination.
>
> #### Input Parameters
>
> **incident\_id** `string` *required*
>
> The ID of the incident to get timeline events for
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Incidents Uptime
>
> **Slug:** `BETTER_STACK_LIST_INCIDENTS_UPTIME`
>
> Tool to list all incidents with optional filtering by monitor, heartbeat, date range, or resolution status. Supports pagination with default of 10 per page and maximum of 50.
>
> #### Input Parameters
>
> **to** `string`
>
> Return incidents until a certain date (format YYYY-MM-DD)
>
> **from** `string`
>
> Return only incidents from a certain date (format YYYY-MM-DD)
>
> **page** `integer`
>
> Page number to return. Starts at 1.
>
> **per\_page** `integer`
>
> Number of incidents per page. Default is 10, maximum is 50.
>
> **resolved** `boolean`
>
> List only resolved or unresolved incidents. Use false to list active incidents
>
> **team\_name** `string`
>
> Filter incidents belonging to a specified team when using global API token
>
> **monitor\_id** `integer`
>
> Filter incidents belonging to a specified monitor
>
> **heartbeat\_id** `integer`
>
> Filter incidents belonging to a specified heartbeat
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List incoming webhooks
>
> **Slug:** `BETTER_STACK_LIST_INCOMING_WEBHOOKS`
>
> List one page of incoming webhooks. Use page/per\_page and returned pagination links to continue. Requires a Better Stack Incidents API token with access to the resource.
>
> #### Input Parameters
>
> **page** `integer`
>
> The page number to return, starting with `1`.
>
> **per\_page** `integer`
>
> Number of results per page. Defaults to `50`, maximum `250`.
>
> **team\_name** `string`
>
> Filter incoming webhooks belonging to a specified team when using [global API token](https://betterstack.com/docs/uptime/api/getting-started-with-uptime-api/#get-a-global-api-token).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Jira Integrations
>
> **Slug:** `BETTER_STACK_LIST_JIRA_INTEGRATIONS`
>
> List Jira integrations with optional team filtering and pagination.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number to return. Starts at 1.
>
> **per\_page** `integer`
>
> Number of integrations per page. Default is 50, maximum is 250.
>
> **team\_name** `string`
>
> Filter integrations belonging to a specified team. Only valid when using a global API token.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Metadata
>
> **Slug:** `BETTER_STACK_LIST_METADATA`
>
> List metadata records with optional filtering by team, owner resource ID, or owner resource type, and pagination.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number to return. Starts at 1.
>
> **owner\_id** `string`
>
> Targets metadata for a particular resource
>
> **per\_page** `integer`
>
> Number of metadata records per page. Default is 50, maximum is 250.
>
> **team\_name** `string`
>
> Filters results to a specific team (global tokens only)
>
> **owner\_type** `string ("Monitor" | "Heartbeat" | "Incident" | "WebhookIntegration" | "EmailIntegration" | "IncomingWebhook" | "CallRouting")`
>
> Owner types for metadata resources.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List metrics
>
> **Slug:** `BETTER_STACK_LIST_METRICS`
>
> List one page of metrics and labels for a specified source. Use page/per\_page and returned pagination links to continue. Requires a Telemetry API token with access to the resource.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number
>
> **per\_page** `integer`
>
> Number of metrics per page. Default 50, maximum 250.
>
> **source\_id** `integer` *required*
>
> Source for which to retrieve metrics
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List monitored databases
>
> **Slug:** `BETTER_STACK_LIST_MONITORED_DATABASES`
>
> ##### Lists databases monitored by a collector Returns a list of databases currently being monitored by the specified collector. \[info] For security reasons, passwords are never included in the API response. \[/info] GET /api/v1/collectors/\{id}/databases Requires a Telemetry API token with access to the resource.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The unique identifier of the collector.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Monitor Groups
>
> **Slug:** `BETTER_STACK_LIST_MONITOR_GROUPS`
>
> Tool to list all monitor groups. Use when you need to retrieve existing monitor groups with optional team filtering and pagination support.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number to return. Starts at 1.
>
> **per\_page** `integer`
>
> Number of monitor groups per page. Default is 50, maximum is 250.
>
> **team\_name** `string`
>
> Filters results to monitor groups belonging to a specified team when using a global API token
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Monitors
>
> **Slug:** `BETTER_STACK_LIST_MONITORS`
>
> Tool to list all monitors. Use when you need to retrieve existing uptime monitors with optional filtering by URL or name and pagination.
>
> #### Input Parameters
>
> **url** `string`
>
> Filter monitors by their URL property
>
> **page** `integer`
>
> Page number to return. Starts at 1.
>
> **per\_page** `integer`
>
> Number of monitors per page. Default is 50, maximum is 250.
>
> **pronounceable\_name** `string`
>
> Filter monitors by their pronounceable name property
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List New Relic Integrations
>
> **Slug:** `BETTER_STACK_LIST_NEW_RELIC_INTEGRATIONS`
>
> Tool to list New Relic integrations. Use when you need to retrieve and inspect all configured New Relic integrations with pagination support.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number to return. Starts at 1.
>
> **per\_page** `integer`
>
> Number of integrations per page. Default is 50, maximum is 250.
>
> **team\_name** `string`
>
> Filter integrations by team name. Useful when using a global API token to narrow results to a specific team.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List On-Call Schedule Events
>
> **Slug:** `BETTER_STACK_LIST_ON_CALL_EVENTS`
>
> Tool to list all events for a specific on-call schedule. Use when you need to retrieve the calendar of scheduled on-call periods for a team.
>
> #### Input Parameters
>
> **schedule\_id** `string` *required*
>
> Identifier for the on-call schedule. Use 'default' to reference the team's default schedule.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List On-Call Schedules
>
> **Slug:** `BETTER_STACK_LIST_ON_CALL_SCHEDULES`
>
> Tool to list all on-call schedules. Use when you need to retrieve all configured on-call calendars.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number to return. Starts at 1.
>
> **per\_page** `integer`
>
> Number of resources per page. Default is 50, maximum is 250.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List outgoing emails
>
> **Slug:** `BETTER_STACK_LIST_OUTGOING_EMAILS`
>
> List one page of outgoing e-mail integrations. Use page/per\_page and the returned pagination links to continue. Requires a Better Stack Incidents API token with access to the resource.
>
> #### Input Parameters
>
> **page** `integer`
>
> The page number to return, starting with `1`.
>
> **per\_page** `integer`
>
> Number of results per page. Defaults to `50`, maximum `250`.
>
> **team\_name** `string`
>
> Filter outgoing e-mail integrations belonging to a specified team when using a [global API token](https://betterstack.com/docs/uptime/api/getting-started-with-uptime-api/#get-a-global-api-token).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Outgoing Webhook Integrations
>
> **Slug:** `BETTER_STACK_LIST_OUTGOING_WEBHOOKS`
>
> Tool to list all outgoing webhook integrations. Use when you need to retrieve configured webhook endpoints for event notifications.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number to return. Starts at 1.
>
> **team\_name** `string`
>
> Filter outgoing webhooks belonging to a specified team. Only applicable when using a global API token.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List PagerDuty Webhooks
>
> **Slug:** `BETTER_STACK_LIST_PAGER_DUTY_WEBHOOKS`
>
> Tool to list PagerDuty integrations. Use when you need to retrieve and inspect all configured PagerDuty integrations.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number to return. Starts at 1.
>
> **per\_page** `integer`
>
> Number of integrations per page. Default is 50, maximum is 250.
>
> **team\_name** `string`
>
> Filter integrations by team name. Useful when using a global API token to narrow results to a specific team.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Escalation Policies
>
> **Slug:** `BETTER_STACK_LIST_POLICIES`
>
> Tool to list all escalation policies. Use when you need to retrieve existing escalation policies with optional filtering by team name.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number to return. Starts at 1.
>
> **per\_page** `integer`
>
> Number of policies per page. Default is 50, maximum is 250.
>
> **team\_name** `string`
>
> Filter escalation policies by team name when using global API token
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Escalation Policy Groups
>
> **Slug:** `BETTER_STACK_LIST_POLICY_GROUPS`
>
> Tool to list all escalation policy groups. Use when you need to retrieve existing policy groups with optional team filtering and pagination support.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number to return. Starts at 1.
>
> **per\_page** `integer`
>
> Number of policy groups per page. Default is 50, maximum is 250.
>
> **team\_name** `string`
>
> Filter policy groups belonging to a specified team when using global API token
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Prometheus Integrations
>
> **Slug:** `BETTER_STACK_LIST_PROMETHEUS_INTEGRATIONS`
>
> List configured Prometheus on-call integrations, with optional team filtering and pagination. Each request returns one page of results.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number to return. Starts at 1.
>
> **per\_page** `integer`
>
> Number of integrations per page. Default is 50, maximum is 250.
>
> **team\_name** `string`
>
> Filter integrations belonging to a specified team. Only valid when using a global API token.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List roles
>
> **Slug:** `BETTER_STACK_LIST_ROLES`
>
> List every organization role in one unpaginated response. Built-in roles (admin, billing\_admin, team\_lead, responder, member) are returned first, then custom roles. Custom roles share role='custom'; distinguish them by id and name. Pass a role's id as role\_id when inviting team members or updating their roles. Requires a Global or Uptime API token; no team\_name is needed, including for global tokens spanning multiple teams.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Single Incident
>
> **Slug:** `BETTER_STACK_LIST_SINGLE_INCIDENT`
>
> Tool to retrieve detailed information about a single incident by its ID. Use when you need to get the full details of a specific incident including its status, timeline, affected regions, and notification settings.
>
> #### Input Parameters
>
> **incident\_id** `string` *required*
>
> The ID of the incident to retrieve
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Slack Integrations
>
> **Slug:** `BETTER_STACK_LIST_SLACK_INTEGRATIONS`
>
> List configured Slack channel integrations, with optional team filtering and pagination. Each request returns one page of results.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number to return. Starts at 1.
>
> **per\_page** `integer`
>
> Number of integrations per page. Default is 50, maximum is 250.
>
> **team\_name** `string`
>
> Filter Slack integrations belonging to a specified team. Only valid when using a global API token.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List source groups
>
> **Slug:** `BETTER_STACK_LIST_SOURCE_GROUPS`
>
> List one page of your team's source groups. Use page/per\_page and returned pagination links to continue. Requires a Telemetry API token with access to the resource.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number
>
> **per\_page** `integer`
>
> Number of source groups per page. Default 50, maximum 250.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List sources
>
> **Slug:** `BETTER_STACK_LIST_SOURCES`
>
> List one page of your team's existing Telemetry sources. Use page/per\_page and the returned pagination links to continue. Includes source configuration and ingestion tokens. Requires a Telemetry API token with access to the sources.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number, starting at 1.
>
> **per\_page** `integer`
>
> Number of sources per page. Default 50, maximum 250.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List sources in group
>
> **Slug:** `BETTER_STACK_LIST_SOURCES_IN_GROUP`
>
> List one page of sources in a source group. Use page/per\_page and returned pagination links to continue. Requires a Telemetry API token with access to the resource.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The ID of the source group.
>
> **page** `integer`
>
> Page number
>
> **per\_page** `integer`
>
> Number of sources per page. Default 50, maximum 250.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Splunk On-Call Integrations
>
> **Slug:** `BETTER_STACK_LIST_SPLUNK_ON_CALL_INTEGRATIONS`
>
> List configured Splunk On-Call integrations, with optional team filtering and pagination. Each request returns one page of results.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number to return. Starts at 1.
>
> **per\_page** `integer`
>
> Number of integrations per page. Default is 50, maximum is 250.
>
> **team\_name** `string`
>
> Filter integrations belonging to a specified team. Only valid when using a global API token.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Status Page Groups
>
> **Slug:** `BETTER_STACK_LIST_STATUS_PAGE_GROUPS`
>
> Tool to list all status page groups. Use when you need to retrieve existing status page groups with optional pagination.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number to return. Starts at 1.
>
> **per\_page** `integer`
>
> Number of status page groups per page. Default is 50; maximum is 250.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Status Pages In Status Page Group
>
> **Slug:** `BETTER_STACK_LIST_STATUS_PAGE_GROUPS_STATUS_PAGES`
>
> Tool to list status pages within a specific status page group. Use when you need to retrieve all status pages belonging to a particular group with optional pagination.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number to return. Starts at 1.
>
> **group\_id** `string` *required*
>
> The ID of the status page group to list status pages from
>
> **per\_page** `integer`
>
> Number of status pages per page. Default is 50; maximum is 250.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Status Page Reports
>
> **Slug:** `BETTER_STACK_LIST_STATUS_PAGE_REPORTS`
>
> Tool to list all reports on a status page. Use when you need to retrieve existing status page reports with optional pagination via `page` and `per_page`.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number to return. Starts at 1.
>
> **per\_page** `integer`
>
> Number of reports per page. Default is 50, maximum is 250.
>
> **status\_page\_id** `string` *required*
>
> The numeric ID of the status page (e.g., '221582'). Obtain this from the list\_status\_pages action.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Status Page Report Status Updates
>
> **Slug:** `BETTER_STACK_LIST_STATUS_PAGE_REPORT_STATUS_UPDATES`
>
> Tool to list all status updates for a status page report. Use when you need to retrieve updates posted on a specific status page report with optional pagination.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number for pagination. Starts at 1.
>
> **per\_page** `integer`
>
> Number of items per page. Default is 50, maximum is 250.
>
> **report\_id** `string` *required*
>
> Identifier for your status page report. Obtain this from the list\_status\_page\_reports action.
>
> **status\_page\_id** `string` *required*
>
> Identifier for your status page. Obtain this from the list\_status\_pages action.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Status Pages
>
> **Slug:** `BETTER_STACK_LIST_STATUS_PAGES`
>
> Tool to list all your status pages. Use when you need to retrieve existing status pages with optional pagination.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number to return. Starts at 1.
>
> **per\_page** `integer`
>
> Number of status pages per page. Default is 50; maximum is 250.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Status Page Sections
>
> **Slug:** `BETTER_STACK_LIST_STATUS_PAGE_SECTIONS`
>
> List sections of a specific status page, with pagination.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number to return. Starts at 1.
>
> **per\_page** `integer`
>
> Number of sections per page. Default is 50, maximum is 250.
>
> **status\_page\_id** `string` *required*
>
> The identifier for your status page
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Status Page Resources
>
> **Slug:** `BETTER_STACK_LIST_STATUS_PAGES_RESOURCES`
>
> Tool to list all resources on a status page. Use when you need to retrieve existing resources with optional pagination.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number to return. Starts at 1.
>
> **per\_page** `integer`
>
> Number of resources per page. Default is 50; maximum is 250.
>
> **status\_page\_id** `string` *required*
>
> The ID of the status page
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List status page subscribers
>
> **Slug:** `BETTER_STACK_LIST_STATUS_PAGE_SUBSCRIBERS`
>
> ##### List status page subscribers Returns a list of the existing e-mail subscribers of your status page. GET /api/v2/status-pages/\{status\_page\_id}/subscribers Returns one page; use page/per\_page and the returned pagination links to continue. Requires a Better Stack Incidents API token with access to the resource.
>
> #### Input Parameters
>
> **page** `integer`
>
> The page number to return, starting with `1`.
>
> **per\_page** `integer`
>
> Number of results per page. Defaults to `50`, maximum `250`.
>
> **status\_page\_id** `string` *required*
>
> The ID of your status page.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List team members
>
> **Slug:** `BETTER_STACK_LIST_TEAM_MEMBERS`
>
> List one page of team members and pending invitations, or find one by email. Providing email returns a single member or invitation object. Otherwise, use page/per\_page and returned pagination links to continue. The role is team-specific: admin, billing\_admin, team\_lead, responder, member, or custom. A custom-role invitation returns null for role. Requires an Uptime or global API token; global tokens may require team\_name to select a team.
>
> #### Input Parameters
>
> **page** `integer`
>
> The page number to return, starting with `1`.
>
> **email** `string`
>
> Filter by a specific e-mail address. If provided, returns a single member or invitation object instead of a list.
>
> **per\_page** `integer`
>
> Number of results per page. Defaults to `50`, maximum `250`.
>
> **team\_name** `string`
>
> Required if using a [global API token](https://betterstack.com/docs/uptime/api/getting-started-with-uptime-api/#get-a-global-api-token) to specify the team.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Severity Levels
>
> **Slug:** `BETTER_STACK_LIST_URGENCIES`
>
> List incident severity levels (urgencies) and their notification settings, optionally filtered by team. Results are paginated.
>
> #### Input Parameters
>
> **team\_name** `string`
>
> Filters severities belonging to a specified team when using a global API token
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Urgency Groups
>
> **Slug:** `BETTER_STACK_LIST_URGENCY_GROUPS`
>
> Tool to list all urgency groups (severity groups). Use when you need to retrieve existing urgency groups with optional team filtering and pagination support.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number to return. Starts at 1.
>
> **per\_page** `integer`
>
> Number of urgency groups per page. Default is 50, maximum is 250.
>
> **team\_name** `string`
>
> Filter urgency groups belonging to a specified team when using global API token
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Reopen incident
>
> **Slug:** `BETTER_STACK_REOPEN_INCIDENT`
>
> Reopen a resolved incident, optionally identifying who reopened it. Requires a Better Stack Incidents API token with access to the incident. Shared incidents cannot be reopened by the receiving team (403). Returns 409 if the incident is not resolved, its monitor has another open incident, or the reopen window has expired.
>
> #### Input Parameters
>
> **incident\_id** `string` *required*
>
> The ID of the incident you want to reopen.
>
> **reopened\_by** `string`
>
> User e-mail or a custom identifier of the entity that reopened the incident.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Resolve Incident
>
> **Slug:** `BETTER_STACK_RESOLVE_INCIDENT`
>
> Tool to resolve an ongoing incident. Use when you need to mark an incident as resolved and close it. Resolving an incident signals that the issue has been fixed and stops any further escalations.
>
> #### Input Parameters
>
> **incident\_id** `string` *required*
>
> The ID of the incident to resolve
>
> **resolved\_by** `string`
>
> Email or custom identifier of the person or system resolving the incident
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update alert
>
> **Slug:** `BETTER_STACK_UPDATE_ALERT`
>
> ##### Update an alert Updates an existing alert by its ID. You only need to provide the fields you want to change. PATCH /api/v2/alerts/\{id} Requires a Telemetry API token with access to the resource.
>
> #### Input Parameters
>
> **id** `integer` *required*
>
> The unique identifier of the alert to update.
>
> **sms** `boolean`
>
> Enable SMS notifications. Only used if `escalation_target` is not a policy.
>
> **call** `boolean`
>
> Enable phone call notifications. Only used if `escalation_target` is not a policy.
>
> **name** `string`
>
> A new name for the alert.
>
> **push** `boolean`
>
> Enable push notifications. Only used if `escalation_target` is not a policy.
>
> **email** `boolean`
>
> Enable e-mail notifications. Only used if `escalation_target` is not a policy.
>
> **value** `number`
>
> The numeric value for the alert condition. For `threshold` alerts, this is the static threshold. For `relative` alerts, this is the percentage change. Required for `threshold` and `relative` types unless `string_value` is set. A value of `0` is valid.
>
> **paused** `boolean`
>
> Whether the alert should be paused or active.
>
> **metadata** `object`
>
> A key-value object for custom metadata to be included in incidents. Both keys and values must be strings. This will replace all existing metadata. For details, see Metadata.
>
> **operator** `string ("equal" | "not_equal" | "higher_than" | "higher_than_or_equal" | "lower_than" | "lower_than_or_equal" | "increases_by" | "decreases_by" | "changes_by")`
>
> The comparison operator. Required for `threshold` and `relative` alerts. For `threshold`: `equal`, `not_equal`, `higher_than`, `higher_than_or_equal`, `lower_than`, `lower_than_or_equal`. For `relative`: `increases_by`, `decreases_by`, `changes_by`. Not used for `anomaly_rrcf` alerts.
>
> **alert\_type** `string ("threshold" | "relative" | "anomaly_rrcf")`
>
> The type of alert. `threshold` for static values, `relative` for percentage changes, or `anomaly_rrcf` for ML-based anomaly detection. Cannot be changed after creation.
>
> **source\_mode** `string ("source_variable" | "platforms_single_source" | "platforms_all_sources")`
>
> The mode for source selection. Valid values: `source_variable`, `platforms_single_source`, `platforms_all_sources`.
>
> **check\_period** `integer`
>
> How often to evaluate the alert condition, in seconds. Required for `threshold` and `relative` alert types. Not used for `anomaly_rrcf` alerts.
>
> **query\_period** `integer`
>
> The time window in seconds for the data being analyzed. If not provided, falls back to `aggregation_interval`, then `check_period`.
>
> **series\_names** `array`
>
> An array of strings to filter the alert to specific data series. Cannot be combined with `series_names_except`. Send an empty array to alert on any series.
>
> **string\_value** `string`
>
> An alternative to `value` for `threshold` alerts when matching an exact string. If `string_value` is set, `value` is not required. Only valid with `equal` or `not_equal` operators.
>
> **incident\_name** `string`
>
> A custom name template for the incident created by this alert, in plain text. Supports the same variables as `incident_cause`, such as `{{alert_name}}` and `{{series_name}}`. When empty, the incident is named after the dashboard or exploration and the alert. Send `null` to clear it.
>
> **critical\_alert** `boolean`
>
> Enable critical push notifications that bypass Do Not Disturb. Only used if `escalation_target` is not a policy.
>
> **incident\_cause** `string`
>
> A custom description template for the incident created by this alert. Supports `{{value}}` placeholder.
>
> **anomaly\_trigger** `string ("any" | "higher" | "lower")`
>
> Defines which anomalies trigger an alert: `any` (both higher and lower), `higher`, or `lower`. Only for `anomaly_rrcf` alerts.
>
> **on\_missing\_data** `string ("treat_as_zero" | "dont_fire" | "treat_as_previous" | "start_incident")`
>
> What to do when the query returns no data: `treat_as_zero`, `dont_fire`, `treat_as_previous`, or `start_incident`. Only for `threshold` and `relative` alerts. Default: `dont_fire`.
>
> **recovery\_period** `integer`
>
> The duration in seconds that a condition must be resolved before an incident is recovered. A value of `0` recovers the incident immediately, `null` means never automatically recover an incident.
>
> **source\_variable** `string`
>
> The variable name for the source selection. If not provided, derived automatically from the dashboard/exploration preset's source variable.
>
> **source\_platforms** `array`
>
> An array of platform names to filter the sources this alert runs on.
>
> **escalation\_target** `string`
>
> Defines where to send notifications. Defaults to `current_team`, for details see Escalation targets.
>
> **anomaly\_sensitivity** `number`
>
> How far the value must deviate from its predicted value to trigger an alert, from `1` to `10`. Higher values require a larger deviation and trigger fewer alerts. Shown as Significance in the app. Only for `anomaly_rrcf` alerts. Default: `5`.
>
> **confirmation\_period** `integer`
>
> The duration in seconds that a condition must be met before an alert is triggered. A value of `0` triggers the alert immediately.
>
> **incident\_per\_series** `boolean`
>
> Whether a separate incident will be created for each data series that triggers the alert.
>
> **series\_names\_except** `array`
>
> An array of strings to alert on all data series except the listed ones. Cannot be combined with `series_names`.
>
> **aggregation\_interval** `integer`
>
> The size of data buckets in seconds for aggregating and evaluating the metric. If not provided, falls back to `query_period`, then `check_period`.
>
> **anomaly\_training\_range\_days** `integer`
>
> How many days of history the anomaly detection model is trained on, from `1` to `30`. Only for `anomaly_rrcf` alerts. Default: `7`.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Amazon SNS integration
>
> **Slug:** `BETTER_STACK_UPDATE_AMAZON_SNS_INTEGRATION`
>
> Update an existing Amazon SNS integration, sending only fields to change. Included rule/field collections replace their existing entries entirely; omit them to preserve existing entries. topic\_arn and subscription\_state are read-only. Requires a Better Stack Incidents API token with access to the resource.
>
> #### Input Parameters
>
> **sms** `boolean`
>
> Send an SMS to the on-call person.
>
> **call** `boolean`
>
> Call the on-call person.
>
> **name** `string`
>
> The name of the Amazon SNS integration that you can see in the dashboard.
>
> **push** `boolean`
>
> Send a push notification to the on-call person.
>
> **email** `boolean`
>
> Send an e-mail to the on-call person.
>
> **paused** `boolean`
>
> Set to `true` to pause the integration, `false` to unpause it.
>
> **policy\_id** `string`
>
> ID of the escalation policy for incidents from this integration, or `null` to remove it. Without one, incidents alert the current on-call person through the channels set by `call`, `sms`, `email`, and `push`.
>
> **team\_wait** `integer`
>
> How long we wait before escalating the incident to the team. In seconds. Send `null` to never escalate to the team, or `0` to alert the whole team right away.
>
> **cause\_field** `object`
>
> Cause extraction object. Required field\_target: sns\_envelope, body, json, xml, query\_string, header. body/json/xml read the publisher message; query\_string/header read AWS's HTTPS request, not the message. target\_field: dot path for json/query\_string, header name for header, CSS selector for xml, or TopicArn/MessageId/Subject for sns\_envelope; unused for body. Required match\_type: match\_everything (whole value), match\_before, match\_after, match\_between, match\_regex (match or capture group). content is required for match\_before/match\_after (boundary text) and match\_regex (regex). content\_before and content\_after are required for match\_between.
>
> **title\_field** `object`
>
> How to extract a custom incident title, as a field object with the same keys as `cause_field`. Send `null` to remove it and use the default title.
>
> **started\_rules** `array`
>
> The conditions `started_rule_type` checks, as an array of rule objects with the keys below. At least one rule is required when the type is `any` or `all`. Nested fields: started\_rules\[].rule\_target: Which part of the notification the rule checks: `sns_envelope` for the envelope, `body`, `json`, or `xml` for the message your publisher sent, or `query_string` or `header` for AWS's own HTTPS request, which never contains your message.; started\_rules\[].target\_field: Which value to read: a dot-separated path such as `alert.id` for `json` and `query_string`, a header name for `header`, a CSS selector for `xml`, or `TopicArn`, `MessageId`, or `Subject` for `sns_envelope`. Not used with `body`.; started\_rules\[].match\_type: How to compare the value with `content`: `contains`, `contains_not`, `equals`, `equals_not`, `matches_regex`, or `matches_regex_not`.; started\_rules\[].content: The value to compare with. Must be a valid regular expression for `matches_regex` and `matches_regex_not`.
>
> **critical\_alert** `boolean`
>
> Send a critical push notification that ignores the mute switch and Do Not Disturb mode.
>
> **resolved\_rules** `array`
>
> The conditions `resolved_rule_type` checks, as rule objects with the same keys as `started_rules`.
>
> **recovery\_period** `integer`
>
> How long to wait after a notification matching `resolved_rules` arrives before marking an incident as resolved, in seconds: `0`, `60`, `180`, `300`, `900`, `1800`, `3600`, or `7200`. Has no effect while `resolved_rule_type` is `unused`.
>
> **started\_rule\_type** `string ("unused" | "any" | "all")`
>
> When notifications start an incident: `unused` always, `any` when at least one of `started_rules` matches, or `all` when all of them match.
>
> **acknowledged\_rules** `array`
>
> The conditions `acknowledged_rule_type` checks, as rule objects with the same keys as `started_rules`.
>
> **resolved\_rule\_type** `string ("unused" | "any" | "all")`
>
> When notifications resolve an incident: `unused` never, `any` when at least one of `resolved_rules` matches, or `all` when all of them match. Any other value requires `started_alert_id_field` and `resolved_alert_id_field`.
>
> **other\_started\_fields** `array`
>
> Extra values to extract when an incident starts, saved as incident metadata. Each field object has the same keys as `cause_field`, plus `name`. Nested fields: other\_started\_fields\[].name: The metadata key to save the extracted value under. Must be unique within the array.
>
> **other\_resolved\_fields** `array`
>
> Extra values to extract when an incident is resolved, with the same keys as `other_started_fields`.
>
> **acknowledged\_rule\_type** `string ("unused" | "any" | "all")`
>
> When notifications acknowledge an incident: `unused` never, `any` when at least one of `acknowledged_rules` matches, or `all` when all of them match. Any other value requires `started_alert_id_field` and `acknowledged_alert_id_field`.
>
> **started\_alert\_id\_field** `object`
>
> How to extract the alert ID from the notification that starts an incident, with the same keys as `cause_field`; later notifications acknowledge and resolve the incident by matching it. Required when `acknowledged_rule_type` or `resolved_rule_type` isn't `unused`.
>
> **resolved\_alert\_id\_field** `object`
>
> How to extract the alert ID from a notification that resolves an incident, with the same keys as `cause_field`. Required when `resolved_rule_type` isn't `unused`.
>
> **amazon\_sns\_integration\_id** `string` *required*
>
> The ID of the Amazon SNS integration you want to update
>
> **other\_acknowledged\_fields** `array`
>
> Extra values to extract when an incident is acknowledged, with the same keys as `other_started_fields`.
>
> **acknowledged\_alert\_id\_field** `object`
>
> How to extract the alert ID from a notification that acknowledges an incident, with the same keys as `cause_field`. Required when `acknowledged_rule_type` isn't `unused`.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update AWS CloudWatch integration
>
> **Slug:** `BETTER_STACK_UPDATE_AWS_CLOUDWATCH_INTEGRATION`
>
> ##### Update AWS CloudWatch integration Update an existing AWS CloudWatch integration. Send only the parameters you wish to change (eg. `paused`). PATCH /api/v2/aws-cloudwatch-integrations/\{aws\_cloudwatch\_integration\_id} Requires a Better Stack Incidents API token with access to the resource.
>
> #### Input Parameters
>
> **sms** `boolean`
>
> Send an SMS to the on-call person.
>
> **call** `boolean`
>
> Call the on-call person.
>
> **name** `string`
>
> The name of the AWS CloudWatch integration that you can see in the dashboard.
>
> **push** `boolean`
>
> Send a push notification to the on-call person.
>
> **email** `boolean`
>
> Send an e-mail to the on-call person.
>
> **paused** `boolean`
>
> Set to `true` to pause the integration, `false` to unpause it.
>
> **policy\_id** `string`
>
> ID of the escalation policy associated with the AWS CloudWatch integration.
>
> **team\_wait** `integer`
>
> How long we wait before escalating the incident alert to the team. In seconds.
>
> **critical\_alert** `boolean`
>
> Send a critical push notification that ignores the mute switch and Do not Disturb mode.
>
> **recovery\_period** `integer`
>
> Has no effect for this integration, since an incident resolves as soon as AWS CloudWatch reports the alert as resolved.
>
> **aws\_cloudwatch\_integration\_id** `string` *required*
>
> The ID of the AWS CloudWatch integration you want to update
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update AWS log group subscription
>
> **Slug:** `BETTER_STACK_UPDATE_AWS_LOG_GROUP_SUBSCRIPTION`
>
> Subscribe or unsubscribe an existing AWS log group override. Set subscribed to true to ingest the log group or false to skip it. The override takes precedence over automatic subscription. Requires an aws source with a connected AWS account and a Telemetry API token with access to the resource.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> ID of the log group subscription override
>
> **source\_id** `string` *required*
>
> ID of the `aws` source
>
> **subscribed** `boolean` *required*
>
> Whether to ingest this log group. Set to `true` to subscribe or `false` to skip it.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Azure integration
>
> **Slug:** `BETTER_STACK_UPDATE_AZURE_INTEGRATION`
>
> ##### Update Azure integration Update an existing Azure integration. Send only the parameters you wish to change (eg. `paused`). PATCH /api/v2/azure-integrations/\{azure\_integration\_id} Requires a Better Stack Incidents API token with access to the resource.
>
> #### Input Parameters
>
> **sms** `boolean`
>
> Send an SMS to the on-call person.
>
> **call** `boolean`
>
> Call the on-call person.
>
> **name** `string`
>
> The name of the Azure integration that you can see in the dashboard.
>
> **push** `boolean`
>
> Send a push notification to the on-call person.
>
> **email** `boolean`
>
> Send an e-mail to the on-call person.
>
> **paused** `boolean`
>
> Set to `true` to pause the integration, `false` to unpause it.
>
> **policy\_id** `string`
>
> ID of the escalation policy associated with the Azure integration.
>
> **team\_wait** `integer`
>
> How long we wait before escalating the incident alert to the team. In seconds.
>
> **critical\_alert** `boolean`
>
> Send a critical push notification that ignores the mute switch and Do not Disturb mode.
>
> **recovery\_period** `integer`
>
> Has no effect for this integration, since an incident resolves as soon as Azure reports the alert as resolved.
>
> **azure\_integration\_id** `string` *required*
>
> The ID of the Azure integration you want to update
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update catalog attribute
>
> **Slug:** `BETTER_STACK_UPDATE_CATALOG_ATTRIBUTE`
>
> ##### Update catalog attribute Update an existing Catalog attribute. PATCH /api/v2/catalog/relations/\{relation\_id}/attributes/\{attribute\_id} Requires a Better Stack Incidents API token with access to the resource.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> The name of the Catalog attribute. Required on every update, even when it doesn't change.
>
> **primary** `boolean`
>
> Whether this is a primary attribute. Primary attributes are matched against the incident metadata key of the same name, the other attributes are added to matching incidents as metadata.
>
> **position** `integer`
>
> The position of the attribute in the Catalog relation, lower values first.
>
> **relation\_id** `string` *required*
>
> The ID of the Catalog relation you want to update an attribute for.
>
> **attribute\_id** `string` *required*
>
> The ID of the Catalog attribute you want to update.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update catalog record
>
> **Slug:** `BETTER_STACK_UPDATE_CATALOG_RECORD`
>
> Update a Catalog record, replacing all its attribute values. Attributes omitted from the supplied array become empty. Requires a Better Stack Incidents API token with access to the relation and record.
>
> #### Input Parameters
>
> **record\_id** `string` *required*
>
> The ID of the Catalog record you want to update.
>
> **attributes** `array` *required*
>
> The attributes for the Catalog record, in the same format as when [creating a Catalog record](https://betterstack.com/docs/uptime/api/create-catalog-record/). Replaces all of the record's values, so an attribute you leave out ends up empty.
>
> **relation\_id** `string` *required*
>
> The ID of the Catalog relation you want to update a record for.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update catalog relation
>
> **Slug:** `BETTER_STACK_UPDATE_CATALOG_RELATION`
>
> ##### Update catalog relation Update an existing Catalog relation. PATCH /api/v2/catalog/relations/\{relation\_id} Requires a Better Stack Incidents API token with access to the resource.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> The name of the Catalog relation. Required on every update, even when it doesn't change.
>
> **match\_mode** `string ("any" | "all")`
>
> `any` applies a record when at least one of its primary attribute values matches the incident's metadata. `all` applies it only when every primary attribute value matches, with an empty value matching anything.
>
> **description** `string`
>
> A description of the Catalog relation.
>
> **relation\_id** `string` *required*
>
> The ID of the Catalog relation you want to update
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update chart
>
> **Slug:** `BETTER_STACK_UPDATE_CHART`
>
> ##### Update a chart Updates an existing chart by its ID. You only need to provide the fields you want to change. \[info] When updating `queries`, the entire array will be replaced with the one you provide. Partial updates to queries are not supported. \[/info] PATCH /api/v2/dashboards/\{dashboard\_id}/charts/\{id} Requires a Telemetry API token with access to the resource.
>
> #### Input Parameters
>
> **id** `integer` *required*
>
> The unique identifier of the chart to update.
>
> **name** `string`
>
> A new name for the chart.
>
> **width** `integer`
>
> A new width in grid units.
>
> **height** `integer`
>
> A new height in grid units.
>
> **queries** `array`
>
> A new array of query objects replacing the entire existing array. Partial query updates are not supported.
>
> **settings** `object`
>
> A new JSON object for chart-specific settings (e.g., units, stacking). This will replace the entire existing settings object.
>
> **chart\_type** `string`
>
> A new type for the chart. The new type must be compatible with the chart's existing queries.
>
> **description** `string`
>
> A new description for the chart.
>
> **dashboard\_id** `integer` *required*
>
> The unique identifier of the dashboard.
>
> **vertical\_position** `integer`
>
> A new vertical position.
>
> **horizontal\_position** `integer`
>
> A new horizontal position.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update chart comment
>
> **Slug:** `BETTER_STACK_UPDATE_CHART_COMMENT`
>
> Update a chart comment's Markdown content or pinned time; send only changed fields. API-authored comments can be updated. With OAuth, the token's team member can also update their own comments. Other comments, including synced incident comments, return 403. user\_email is not accepted; change mentions by sending the whole content. Requires a Telemetry API token with access.
>
> #### Input Parameters
>
> **id** `integer` *required*
>
> The unique identifier of the comment to update.
>
> **content** `string`
>
> The new content of the comment. [Markdown](https://www.markdownguide.org/basic-syntax/) is supported for formatting.
>
> **chart\_id** `integer` *required*
>
> The unique identifier of the chart.
>
> **timestamp** `string`
>
> The new point on the chart's time axis to pin the comment to, as a datetime such as `2026-08-17T13:00:00Z`.
>
> **dashboard\_id** `integer` *required*
>
> The unique identifier of the dashboard.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update collector
>
> **Slug:** `BETTER_STACK_UPDATE_COLLECTOR`
>
> ##### Update a collector Updates an existing collector. Only the provided parameters will be changed. \[warning] The `platform` and `data_region` attributes are immutable and cannot be changed after a collector is created. A custom bucket can only be added when creating a collector. \[/warning] PATCH /api/v1/collectors/\{id} Requires a Telemetry API token with access to the resource.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The unique identifier of the collector to update.
>
> **name** `string`
>
> A new unique name for the collector.
>
> **note** `string`
>
> A new note for the collector. Send `null` to clear the existing note.
>
> **databases** `array`
>
> An array of database objects to add, update, or remove. To remove a database, include its `id` and set `_destroy: true`.
>
> **configuration** `object`
>
> An object containing detailed configuration options to update. Only the keys provided in this object will be modified, including inside `components`. For a full list of options, see the `configuration` object section in the [Create collector API documentation](https://betterstack.com/docs/logs/api/create-a-collector/). Send `false` in `components` to turn a component off. If you send the legacy `metrics_databases` without `metrics_cluster`, it can also set whichever of `metrics_postgres`, `metrics_mysql`, `metrics_elasticsearch` and `metrics_pgbouncer` you leave out, so send those four explicitly.
>
> **custom\_bucket** `object`
>
> Rotates the key pair of the custom bucket the collector already uses. Send only `access_key_id` and `secret_access_key`. We verify the new pair against the bucket first; if that fails, the whole request is rejected with a 422 and nothing is changed. A bucket shared with other collectors or sources is rotated for all of them. Send the new pair before deactivating the old one to rotate without downtime.
>
> **logs\_retention** `integer`
>
> Custom retention period for logs, in days. This is only available on select plans.
>
> **source\_group\_id** `integer`
>
> The ID of the resource group to assign the collector's associated sources to. Send `0` or `null` to remove the assignment.
>
> **ingesting\_paused** `boolean`
>
> Set to `true` to pause data ingestion, or `false` to resume.
>
> **live\_tail\_pattern** `string`
>
> A custom format for messages displayed in live tail, with columns wrapped in `{column}` brackets. Example: `"PID: {message_json.pid} {level} {message}"`. Send `null` to clear.   For details, see [Live tail docs](https://betterstack.com/docs/logs/using-logtail/formatting-logs/#live-tail-message-format).
>
> **metrics\_retention** `integer`
>
> Custom retention period for metrics, in days. This is only available on select plans.
>
> **user\_vector\_config** `string`
>
> A custom Vector configuration in YAML format. Send `null` to remove.
>
> **source\_vrl\_transformation** `string`
>
> A [VRL program](https://betterstack.com/docs/logs/using-logtail/transforming-ingested-data/logs-vrl/) to be applied to logs server-side. Send `null` to remove.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update collector metric target
>
> **Slug:** `BETTER_STACK_UPDATE_COLLECTOR_METRIC_TARGET`
>
> ##### Update a collector metrics target Updates an existing collector target. Only include the fields you want to change - omitted fields are preserved. \[info] The `kind` field cannot be changed after creation. To switch to a different kind, remove the target and create a new one. \[/info] \[info] Changing any connection field resets the target's status to `pending` so the collector can re-verify the connection. Connection fields are `host`, `port`, `username`, `password`, `ssl_mode`, `tls`, `scheme`, `listen_ip`, `endpoint`, `api_key`. \[/info] PATCH /api/v1/collectors/\{collector\_id}/targets/\{target\_id} Requires a Telemetry API token with access to the resource.
>
> #### Input Parameters
>
> **tls** `string ("false" | "true" | "skip-verify" | "preferred")`
>
> The TLS mode for the connection. Valid options are `false`, `true`, `skip-verify`, and `preferred`. Only for `mysql`.
>
> **host** `string`
>
> The hostname or IP address of the target.
>
> **port** `integer`
>
> The port number.
>
> **scheme** `string ("http" | "https")`
>
> The connection scheme. Valid options are `http` and `https`. Only for `elasticsearch`.
>
> **api\_key** `string`
>
> An API key for authentication. Write-only - never returned in responses. Only for `elasticsearch`.
>
> **enabled** `boolean`
>
> Set to `false` to disable the target, or `true` to re-enable it.
>
> **service** `string`
>
> The service or container name.
>
> **endpoint** `string`
>
> The full scrape URL. Only for `prometheus`.
>
> **password** `string`
>
> The password for authentication. Write-only - never returned in responses.
>
> **ssl\_mode** `string ("disable" | "require" | "verify-ca")`
>
> The SSL mode for the connection. Valid options are `disable`, `require`, and `verify-ca`. Only for `postgres`.
>
> **username** `string`
>
> The username for authentication.
>
> **listen\_ip** `string`
>
> The IP address the process listens on. Only for `nginx`, `apache`, `kafka`.
>
> **target\_id** `string` *required*
>
> Identifier of the target.
>
> **collector\_id** `string` *required*
>
> Identifier of the collector.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update dashboard
>
> **Slug:** `BETTER_STACK_UPDATE_DASHBOARD`
>
> ##### Update a dashboard Updates an existing dashboard by its ID. You only need to provide the fields you want to change. PATCH /api/v2/dashboards/\{id} Requires a Telemetry API token with access to the resource.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The unique identifier of the dashboard to update.
>
> **name** `string`
>
> A new name for the dashboard.
>
> **variables** `array`
>
> Array of variable objects. Custom variables missing from this array are removed; system variables are kept. Resend values for listed variables or their selection is cleared. Omitted variable\_type, default\_values, sql\_definition, structured\_value and allow\_multiple\_values are kept; null clears these except variable\_type. Changing variable\_type drops old default\_values, sql\_definition and structured\_value.
>
> **date\_range\_to** `string`
>
> A new end for the dashboard's date range.
>
> **date\_range\_from** `string`
>
> A new start for the dashboard's date range.
>
> **refresh\_interval** `integer`
>
> A new refresh interval in seconds.
>
> **dashboard\_group\_id** `integer`
>
> A new dashboard group ID. Use `0` or `null` to remove from a group.
>
> **source\_eligibility\_sql** `string`
>
> A new SQL filter for source eligibility.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update dashboard alert
>
> **Slug:** `BETTER_STACK_UPDATE_DASHBOARD_ALERT`
>
> ##### Update a dashboard alert Updates an existing alert on a dashboard chart. You only need to provide the fields you want to change. PATCH /api/v2/dashboards/\{dashboard\_id}/charts/\{chart\_id}/alerts/\{id} Requires a Telemetry API token with access to the resource.
>
> #### Input Parameters
>
> **id** `integer` *required*
>
> The unique identifier of the alert to update.
>
> **sms** `boolean`
>
> Enable SMS notifications. Only used if `escalation_target` is not a policy.
>
> **call** `boolean`
>
> Enable phone call notifications. Only used if `escalation_target` is not a policy.
>
> **name** `string`
>
> A new name for the alert.
>
> **push** `boolean`
>
> Enable push notifications. Only used if `escalation_target` is not a policy.
>
> **email** `boolean`
>
> Enable e-mail notifications. Only used if `escalation_target` is not a policy.
>
> **value** `number`
>
> The numeric value for the alert condition. For `threshold` alerts, this is the static threshold. For `relative` alerts, this is the percentage change. Required for `threshold` and `relative` types unless `string_value` is set. A value of `0` is valid.
>
> **paused** `boolean`
>
> Whether the alert should be paused or active.
>
> **chart\_id** `integer` *required*
>
> The unique identifier of the chart.
>
> **metadata** `object`
>
> A key-value object for custom metadata to be included in incidents. Both keys and values must be strings. This will replace all existing metadata.
>
> **operator** `string ("equal" | "not_equal" | "higher_than" | "higher_than_or_equal" | "lower_than" | "lower_than_or_equal" | "increases_by" | "decreases_by" | "changes_by")`
>
> The comparison operator. Required for `threshold` and `relative` alerts. For `threshold`: `equal`, `not_equal`, `higher_than`, `higher_than_or_equal`, `lower_than`, `lower_than_or_equal`. For `relative`: `increases_by`, `decreases_by`, `changes_by`. Not used for `anomaly_rrcf` alerts.
>
> **alert\_type** `string ("threshold" | "relative" | "anomaly_rrcf")`
>
> The type of alert. `threshold` for static values, `relative` for percentage changes, or `anomaly_rrcf` for ML-based anomaly detection. Cannot be changed after creation.
>
> **source\_mode** `string ("source_variable" | "platforms_single_source" | "platforms_all_sources")`
>
> The mode for source selection. Valid values: `source_variable`, `platforms_single_source`, `platforms_all_sources`.
>
> **check\_period** `integer`
>
> How often to evaluate the alert condition, in seconds. Required for `threshold` and `relative` alert types. Not used for `anomaly_rrcf` alerts.
>
> **dashboard\_id** `integer` *required*
>
> The unique identifier of the dashboard.
>
> **query\_period** `integer`
>
> The time window in seconds for the data being analyzed. If not provided, falls back to `aggregation_interval`, then `check_period`.
>
> **series\_names** `array`
>
> An array of strings to filter the alert to specific data series. Cannot be combined with `series_names_except`. Send an empty array to alert on any series.
>
> **string\_value** `string`
>
> An alternative to `value` for `threshold` alerts when matching an exact string. If `string_value` is set, `value` is not required. Only valid with `equal` or `not_equal` operators.
>
> **incident\_name** `string`
>
> A custom name template for the incident created by this alert, in plain text. Supports the same variables as `incident_cause`, such as `{{alert_name}}` and `{{series_name}}`. When empty, the incident is named after the dashboard and the alert. Send `null` to clear it.
>
> **critical\_alert** `boolean`
>
> Enable critical push notifications that bypass Do Not Disturb. Only used if `escalation_target` is not a policy.
>
> **incident\_cause** `string`
>
> A custom description template for the incident created by this alert. Supports `{{value}}` placeholder.
>
> **anomaly\_trigger** `string ("any" | "higher" | "lower")`
>
> Defines which anomalies trigger an alert: `any` (both higher and lower), `higher`, or `lower`. Only for `anomaly_rrcf` alerts.
>
> **on\_missing\_data** `string ("treat_as_zero" | "dont_fire" | "treat_as_previous" | "start_incident")`
>
> What to do when the query returns no data: `treat_as_zero`, `dont_fire`, `treat_as_previous`, or `start_incident`. Only for `threshold` and `relative` alerts. Default: `dont_fire`.
>
> **recovery\_period** `integer`
>
> The duration in seconds that a condition must be resolved before an incident is recovered. A value of `0` recovers the incident immediately, `null` means never automatically recover an incident.
>
> **source\_variable** `string`
>
> The variable name for the source selection. If not provided, derived automatically from the dashboard preset's source variable.
>
> **source\_platforms** `array`
>
> An array of platform names to filter the sources this alert runs on.
>
> **escalation\_target** `string`
>
> Defines where to send notifications. Defaults to `current_team`.
>
> **anomaly\_sensitivity** `number`
>
> How far the value must deviate from its predicted value to trigger an alert, from `1` to `10`. Higher values require a larger deviation and trigger fewer alerts. Shown as Significance in the app. Only for `anomaly_rrcf` alerts. Default: `5`.
>
> **confirmation\_period** `integer`
>
> The duration in seconds that a condition must be met before an alert is triggered. A value of `0` triggers the alert immediately.
>
> **incident\_per\_series** `boolean`
>
> Whether a separate incident will be created for each data series that triggers the alert.
>
> **series\_names\_except** `array`
>
> An array of strings to alert on all data series except the listed ones. Cannot be combined with `series_names`.
>
> **aggregation\_interval** `integer`
>
> The size of data buckets in seconds for aggregating and evaluating the metric. If not provided, falls back to `query_period`, then `check_period`.
>
> **additional\_conditions** `array`
>
> An array of up to 4 additional conditions, each combined with the primary condition using logical AND, so the alert only fires where every condition is breached in the same time bucket. Each condition is an object with an `alert_type` of `threshold` or `relative`, an `operator`, a `value` or `string_value`, and an optional `series_names` or `series_names_except` scope. Anomaly detection cannot be used as an additional condition. Send an empty array to clear all additional conditions. See [Multiple conditions](https://betterstack.com/docs/logs/api/dashboard-alerts/create/) on the create page for an example.
>
> **anomaly\_training\_range\_days** `integer`
>
> How many days of history the anomaly detection model is trained on, from `1` to `30`. Only for `anomaly_rrcf` alerts. Default: `7`.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update dashboard group
>
> **Slug:** `BETTER_STACK_UPDATE_DASHBOARD_GROUP`
>
> ##### Update a dashboard group Updates an existing dashboard group by its ID. PATCH /api/v2/dashboard-groups/\{id} Requires a Telemetry API token with access to the resource.
>
> #### Input Parameters
>
> **id** `integer` *required*
>
> The unique identifier of the dashboard group to update.
>
> **name** `string`
>
> A new name for the dashboard group.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update dashboard section
>
> **Slug:** `BETTER_STACK_UPDATE_DASHBOARD_SECTION`
>
> ##### Update a dashboard section Updates an existing section by its ID. You only need to provide the fields you want to change. PATCH /api/v2/dashboards/\{dashboard\_id}/sections/\{id} Requires a Telemetry API token with access to the resource.
>
> #### Input Parameters
>
> **id** `integer` *required*
>
> The unique identifier of the section to update.
>
> **name** `string`
>
> A new name for the section.
>
> **collapsed** `boolean`
>
> A new collapsed state for the section.
>
> **explanation** `string`
>
> A new explanation text for the section.
>
> **dashboard\_id** `integer` *required*
>
> The unique identifier of the dashboard.
>
> **vertical\_position** `integer`
>
> A new vertical position for the section.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Datadog integration
>
> **Slug:** `BETTER_STACK_UPDATE_DATADOG_INTEGRATION`
>
> ##### Update Datadog integration Update an existing Datadog integration. Send only the parameters you wish to change (eg. `paused`). PATCH /api/v2/datadog-integrations/\{datadog\_integration\_id} Requires a Better Stack Incidents API token with access to the resource.
>
> #### Input Parameters
>
> **sms** `boolean`
>
> Send an SMS to the on-call person.
>
> **call** `boolean`
>
> Call the on-call person.
>
> **name** `string`
>
> The name of the Datadog integration that you can see in the dashboard.
>
> **push** `boolean`
>
> Send a push notification to the on-call person.
>
> **email** `boolean`
>
> Send an e-mail to the on-call person.
>
> **paused** `boolean`
>
> Set to `true` to pause the integration, `false` to unpause it.
>
> **policy\_id** `string`
>
> ID of the escalation policy associated with the Datadog integration.
>
> **team\_wait** `integer`
>
> How long we wait before escalating the incident alert to the team. In seconds.
>
> **alerting\_rule** `string ("alert" | "alert_and_warn")`
>
> Should we alert only on alarms, or on both alarms and warnings. Possible values: `alert`, `alert_and_warn`. Defaults to `alert`.
>
> **critical\_alert** `boolean`
>
> Send a critical push notification that ignores the mute switch and Do not Disturb mode.
>
> **recovery\_period** `integer`
>
> Has no effect for this integration, since an incident resolves as soon as Datadog reports the alert as resolved.
>
> **datadog\_integration\_id** `string` *required*
>
> The ID of the Datadog integration you want to update
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Elastic integration
>
> **Slug:** `BETTER_STACK_UPDATE_ELASTIC_INTEGRATION`
>
> ##### Update Elastic integration Update an existing Elastic integration. Send only the parameters you wish to change (eg. `paused`). PATCH /api/v2/elastic-integrations/\{elastic\_integration\_id} Requires a Better Stack Incidents API token with access to the resource.
>
> #### Input Parameters
>
> **sms** `boolean`
>
> Send an SMS to the on-call person.
>
> **call** `boolean`
>
> Call the on-call person.
>
> **name** `string`
>
> The name of the Elastic integration that you can see in the dashboard.
>
> **push** `boolean`
>
> Send a push notification to the on-call person.
>
> **email** `boolean`
>
> Send an e-mail to the on-call person.
>
> **paused** `boolean`
>
> Set to `true` to pause the integration, `false` to unpause it.
>
> **policy\_id** `string`
>
> ID of the escalation policy associated with the Elastic integration.
>
> **team\_wait** `integer`
>
> How long we wait before escalating the incident alert to the team. In seconds.
>
> **critical\_alert** `boolean`
>
> Send a critical push notification that ignores the mute switch and Do not Disturb mode.
>
> **recovery\_period** `integer`
>
> Has no effect for this integration, since an incident resolves as soon as Elastic reports the alert as resolved.
>
> **elastic\_integration\_id** `string` *required*
>
> The ID of the Elastic integration you want to update
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update email integration
>
> **Slug:** `BETTER_STACK_UPDATE_EMAIL_INTEGRATION`
>
> Update an existing e-mail integration; send only fields you wish to change. Included rules and field configurations are replaced entirely, deleting previous entries. Send all entries to retain them; omit the attribute to leave it unchanged. Requires a Better Stack Incidents API token with access to the resource.
>
> #### Input Parameters
>
> **sms** `boolean`
>
> Send an SMS to the on-call person.
>
> **call** `boolean`
>
> Call the on-call person.
>
> **name** `string`
>
> The name of the e-mail integration that you can see in the dashboard.
>
> **push** `boolean`
>
> Send a push notification to the on-call person.
>
> **email** `boolean`
>
> Send an e-mail to the on-call person.
>
> **paused** `boolean`
>
> Set to `true` to pause the integration, `false` to unpause it.
>
> **policy\_id** `string`
>
> ID of the escalation policy for incidents from this integration, or `null` to remove it. Without one, incidents alert the current on-call person through the channels set by `call`, `sms`, `email`, and `push`.
>
> **team\_wait** `integer`
>
> How long we wait before escalating the incident to the team. In seconds. Send `null` to never escalate to the team, or `0` to alert the whole team right away.
>
> **cause\_field** `object`
>
> How to extract the incident cause from the e-mail that starts an incident, as a field object with the keys below. Nested fields: cause\_field.field\_target: Which part of the e-mail to read: `from_email`, `subject`, or `body`.; cause\_field.match\_type: What to extract: `match_everything` takes the whole value, `match_before` the text before `content`, `match_after` the text after `content`, `match_between` the text between `content_before` and `content_after`, and `match_regex` the match of the regular expression in `content`, or its capture group.; cause\_field.content: The text to extract around for `match_before` and `match_after`, or the regular expression for `match_regex`. Required for those three.; cause\_field.content\_before: Where extraction starts for `match_between`. Required for `match_between`.; cause\_field.content\_after: Where extraction stops for `match_between`. Leave it empty to extract to the end.
>
> **title\_field** `object`
>
> How to extract a custom incident title, as a field object with the same keys as `cause_field`. Send `null` to remove it and use the default title.
>
> **started\_rules** `array`
>
> The conditions `started_rule_type` checks, as an array of rule objects with the keys below. At least one rule is required when the type is `any` or `all`. Nested fields: started\_rules\[].rule\_target: Which part of the e-mail the rule checks: `from_email`, `subject`, or `body`.; started\_rules\[].match\_type: How to compare the value with `content`: `contains`, `contains_not`, `equals`, `equals_not`, `matches_regex`, or `matches_regex_not`.; started\_rules\[].content: The value to compare with. Must be a valid regular expression for `matches_regex` and `matches_regex_not`.
>
> **critical\_alert** `boolean`
>
> Send a critical push notification that ignores the mute switch and Do Not Disturb mode.
>
> **resolved\_rules** `array`
>
> The conditions `resolved_rule_type` checks, as rule objects with the same keys as `started_rules`.
>
> **recovery\_period** `integer`
>
> How long to wait after an e-mail matching `resolved_rules` arrives before marking an incident as resolved, in seconds: `0`, `60`, `180`, `300`, `900`, `1800`, `3600`, or `7200`. Has no effect while `resolved_rule_type` is `unused`.
>
> **started\_rule\_type** `string ("unused" | "any" | "all")`
>
> When e-mails start an incident: `unused` always, `any` when at least one of `started_rules` matches, or `all` when all of them match.
>
> **acknowledged\_rules** `array`
>
> The conditions `acknowledged_rule_type` checks, as rule objects with the same keys as `started_rules`.
>
> **resolved\_rule\_type** `string ("unused" | "any" | "all")`
>
> When e-mails resolve an incident: `unused` never, `any` when at least one of `resolved_rules` matches, or `all` when all of them match. Any other value requires `started_alert_id_field` and `resolved_alert_id_field`.
>
> **email\_integration\_id** `string` *required*
>
> The ID of the e-mail integration you want to update
>
> **other\_started\_fields** `array`
>
> Extra values to extract when an incident starts, saved as incident metadata. Each field object has the same keys as `cause_field`, plus `name`. Nested fields: other\_started\_fields\[].name: The metadata key to save the extracted value under. Must be unique within the array.
>
> **other\_resolved\_fields** `array`
>
> Extra values to extract when an incident is resolved, with the same keys as `other_started_fields`.
>
> **acknowledged\_rule\_type** `string ("unused" | "any" | "all")`
>
> When e-mails acknowledge an incident: `unused` never, `any` when at least one of `acknowledged_rules` matches, or `all` when all of them match. Any other value requires `started_alert_id_field` and `acknowledged_alert_id_field`.
>
> **started\_alert\_id\_field** `object`
>
> How to extract the alert ID from the e-mail that starts an incident, with the same keys as `cause_field`; later e-mails acknowledge and resolve the incident by matching it. Required when `acknowledged_rule_type` or `resolved_rule_type` isn't `unused`.
>
> **resolved\_alert\_id\_field** `object`
>
> How to extract the alert ID from an e-mail that resolves an incident, with the same keys as `cause_field`. Required when `resolved_rule_type` isn't `unused`.
>
> **other\_acknowledged\_fields** `array`
>
> Extra values to extract when an incident is acknowledged, with the same keys as `other_started_fields`.
>
> **acknowledged\_alert\_id\_field** `object`
>
> How to extract the alert ID from an e-mail that acknowledges an incident, with the same keys as `cause_field`. Required when `acknowledged_rule_type` isn't `unused`.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Escalation Policy
>
> **Slug:** `BETTER_STACK_UPDATE_ESCALATION_POLICY`
>
> Tool to update an existing escalation policy. Use when you need to modify policy attributes like name, repeat settings, or escalation steps. Only the fields you provide will be updated (partial updates supported).
>
> #### Input Parameters
>
> **name** `string`
>
> The name of this escalation policy
>
> **steps** `array`
>
> An array of escalation policy steps to replace existing steps
>
> **policy\_id** `string` *required*
>
> The ID of the escalation policy to update
>
> **repeat\_count** `integer`
>
> How many times to repeat the escalation policy if unacknowledged
>
> **repeat\_delay** `integer`
>
> How long in seconds to wait before each repetition
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update exploration
>
> **Slug:** `BETTER_STACK_UPDATE_EXPLORATION`
>
> ##### Update an exploration Updates an existing exploration by its ID. You only need to provide the fields you want to change. \[info] When updating nested resources like `queries` or `variables`, the entire array will be replaced with the one you provide. \[/info] PATCH /api/v2/explorations/\{id} Requires a Telemetry API token with access to the resource.
>
> #### Input Parameters
>
> **id** `integer` *required*
>
> The unique identifier of the exploration to update.
>
> **name** `string`
>
> A new name for the exploration.
>
> **chart** `object`
>
> An object to update the chart's configuration. The entire object is replaced.
>
> **queries** `array`
>
> An array of query objects to replace the existing queries.
>
> **variables** `array`
>
> An array of variable objects to replace the existing custom variables.
>
> **date\_range\_to** `string`
>
> A new end for the exploration's date range.
>
> **date\_range\_from** `string`
>
> A new start for the exploration's date range.
>
> **exploration\_group\_id** `integer`
>
> A new exploration group ID. Use `0` or `null` to remove from a group.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update exploration alert
>
> **Slug:** `BETTER_STACK_UPDATE_EXPLORATION_ALERT`
>
> ##### Update an exploration alert Updates an existing alert by its ID. You only need to provide the fields you want to change. PATCH /api/v2/explorations/\{exploration\_id}/alerts/\{id} Requires a Telemetry API token with access to the resource.
>
> #### Input Parameters
>
> **id** `integer` *required*
>
> The unique identifier of the alert to update.
>
> **sms** `boolean`
>
> Enable SMS notifications. Only used if `escalation_target` is not a policy.
>
> **call** `boolean`
>
> Enable phone call notifications. Only used if `escalation_target` is not a policy.
>
> **name** `string`
>
> A new name for the alert.
>
> **push** `boolean`
>
> Enable push notifications. Only used if `escalation_target` is not a policy.
>
> **email** `boolean`
>
> Enable e-mail notifications. Only used if `escalation_target` is not a policy.
>
> **value** `number`
>
> The numeric value for the alert condition. For `threshold` alerts, this is the static threshold. For `relative` alerts, this is the percentage change. Required for `threshold` and `relative` types unless `string_value` is set. A value of `0` is valid.
>
> **paused** `boolean`
>
> Whether the alert should be paused or active.
>
> **metadata** `object`
>
> A key-value object for custom metadata to be included in incidents. Both keys and values must be strings. This will replace all existing metadata.
>
> **operator** `string ("equal" | "not_equal" | "higher_than" | "higher_than_or_equal" | "lower_than" | "lower_than_or_equal" | "increases_by" | "decreases_by" | "changes_by")`
>
> The comparison operator. Required for `threshold` and `relative` alerts. For `threshold`: `equal`, `not_equal`, `higher_than`, `higher_than_or_equal`, `lower_than`, `lower_than_or_equal`. For `relative`: `increases_by`, `decreases_by`, `changes_by`. Not used for `anomaly_rrcf` alerts.
>
> **alert\_type** `string ("threshold" | "relative" | "anomaly_rrcf")`
>
> The type of alert. `threshold` for static values, `relative` for percentage changes, or `anomaly_rrcf` for ML-based anomaly detection. Cannot be changed after creation.
>
> **source\_mode** `string ("source_variable" | "platforms_single_source" | "platforms_all_sources")`
>
> The mode for source selection. Valid values: `source_variable`, `platforms_single_source`, `platforms_all_sources`.
>
> **check\_period** `integer`
>
> How often to evaluate the alert condition, in seconds. Required for `threshold` and `relative` alert types. Not used for `anomaly_rrcf` alerts.
>
> **query\_period** `integer`
>
> The time window in seconds for the data being analyzed. If not provided, falls back to `aggregation_interval`, then `check_period`.
>
> **series\_names** `array`
>
> An array of strings to filter the alert to specific data series. Cannot be combined with `series_names_except`. Send an empty array to alert on any series.
>
> **string\_value** `string`
>
> An alternative to `value` for `threshold` alerts when matching an exact string. If `string_value` is set, `value` is not required. Only valid with `equal` or `not_equal` operators.
>
> **incident\_name** `string`
>
> A custom name template for the incident created by this alert, in plain text. Supports the same variables as `incident_cause`, such as `{{alert_name}}` and `{{series_name}}`. When empty, the incident is named after the exploration and the alert. Send `null` to clear it.
>
> **critical\_alert** `boolean`
>
> Enable critical push notifications that bypass Do Not Disturb. Only used if `escalation_target` is not a policy.
>
> **exploration\_id** `integer` *required*
>
> The unique identifier of the exploration.
>
> **incident\_cause** `string`
>
> A custom description template for the incident created by this alert. Supports `{{value}}` placeholder.
>
> **anomaly\_trigger** `string ("any" | "higher" | "lower")`
>
> Defines which anomalies trigger an alert: `any` (both higher and lower), `higher`, or `lower`. Only for `anomaly_rrcf` alerts.
>
> **on\_missing\_data** `string ("treat_as_zero" | "dont_fire" | "treat_as_previous" | "start_incident")`
>
> What to do when the query returns no data: `treat_as_zero`, `dont_fire`, `treat_as_previous`, or `start_incident`. Only for `threshold` and `relative` alerts. Default: `dont_fire`.
>
> **recovery\_period** `integer`
>
> The duration in seconds that a condition must be resolved before an incident is recovered. A value of `0` recovers the incident immediately, `null` means never automatically recover an incident.
>
> **source\_variable** `string`
>
> The variable name for the source selection. If not provided, derived automatically from the exploration preset's source variable.
>
> **source\_platforms** `array`
>
> An array of platform names to filter the sources this alert runs on.
>
> **escalation\_target** `string`
>
> Defines where to send notifications. Defaults to `current_team`.
>
> **anomaly\_sensitivity** `number`
>
> How far the value must deviate from its predicted value to trigger an alert, from `1` to `10`. Higher values require a larger deviation and trigger fewer alerts. Shown as Significance in the app. Only for `anomaly_rrcf` alerts. Default: `5`.
>
> **confirmation\_period** `integer`
>
> The duration in seconds that a condition must be met before an alert is triggered. A value of `0` triggers the alert immediately.
>
> **incident\_per\_series** `boolean`
>
> Whether a separate incident will be created for each data series that triggers the alert.
>
> **series\_names\_except** `array`
>
> An array of strings to alert on all data series except the listed ones. Cannot be combined with `series_names`.
>
> **aggregation\_interval** `integer`
>
> The size of data buckets in seconds for aggregating and evaluating the metric. If not provided, falls back to `query_period`, then `check_period`.
>
> **additional\_conditions** `array`
>
> An array of up to 4 additional conditions, each combined with the primary condition using logical AND, so the alert only fires where every condition is breached in the same time bucket. Each condition is an object with an `alert_type` of `threshold` or `relative`, an `operator`, a `value` or `string_value`, and an optional `series_names` or `series_names_except` scope. Anomaly detection cannot be used as an additional condition. Send an empty array to clear all additional conditions. See [Multiple conditions](https://betterstack.com/docs/logs/api/exploration-alerts/create/) on the create page for an example.
>
> **anomaly\_training\_range\_days** `integer`
>
> How many days of history the anomaly detection model is trained on, from `1` to `30`. Only for `anomaly_rrcf` alerts. Default: `7`.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update exploration group
>
> **Slug:** `BETTER_STACK_UPDATE_EXPLORATION_GROUP`
>
> ##### Update an exploration group Updates an existing exploration group by its ID. PATCH /api/v2/exploration-groups/\{id} Requires a Telemetry API token with access to the resource.
>
> #### Input Parameters
>
> **id** `integer` *required*
>
> The unique identifier of the exploration group to update.
>
> **name** `string`
>
> A new name for the exploration group.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Google Monitoring integration
>
> **Slug:** `BETTER_STACK_UPDATE_GOOGLE_MONITORING_INTEGRATION`
>
> ##### Update Google Monitoring integration Update an existing Google Monitoring integration. Send only the parameters you wish to change (eg. `paused`). PATCH /api/v2/google-monitoring-integrations/\{google\_monitoring\_integration\_id} Requires a Better Stack Incidents API token with access to the resource.
>
> #### Input Parameters
>
> **sms** `boolean`
>
> Send an SMS to the on-call person.
>
> **call** `boolean`
>
> Call the on-call person.
>
> **name** `string`
>
> The name of the Google Monitoring integration that you can see in the dashboard.
>
> **push** `boolean`
>
> Send a push notification to the on-call person.
>
> **email** `boolean`
>
> Send an e-mail to the on-call person.
>
> **paused** `boolean`
>
> Set to `true` to pause the integration, `false` to unpause it.
>
> **policy\_id** `string`
>
> ID of the escalation policy associated with the Google Monitoring integration.
>
> **team\_wait** `integer`
>
> How long we wait before escalating the incident alert to the team. In seconds.
>
> **critical\_alert** `boolean`
>
> Send a critical push notification that ignores the mute switch and Do not Disturb mode.
>
> **recovery\_period** `integer`
>
> Has no effect for this integration, since an incident resolves as soon as Google Monitoring reports the alert as resolved.
>
> **google\_monitoring\_integration\_id** `string` *required*
>
> The ID of the Google Monitoring integration you want to update
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Grafana integration
>
> **Slug:** `BETTER_STACK_UPDATE_GRAFANA_INTEGRATION`
>
> ##### Update Grafana integration Update an existing Grafana integration. Send only the parameters you wish to change (eg. `paused`). PATCH /api/v2/grafana-integrations/\{grafana\_integration\_id} Requires a Better Stack Incidents API token with access to the resource.
>
> #### Input Parameters
>
> **sms** `boolean`
>
> Send an SMS to the on-call person.
>
> **call** `boolean`
>
> Call the on-call person.
>
> **name** `string`
>
> The name of the Grafana integration that you can see in the dashboard.
>
> **push** `boolean`
>
> Send a push notification to the on-call person.
>
> **email** `boolean`
>
> Send an e-mail to the on-call person.
>
> **paused** `boolean`
>
> Set to `true` to pause the integration, `false` to unpause it.
>
> **policy\_id** `string`
>
> ID of the escalation policy associated with the Grafana integration.
>
> **team\_wait** `integer`
>
> How long we wait before escalating the incident alert to the team. In seconds.
>
> **critical\_alert** `boolean`
>
> Send a critical push notification that ignores the mute switch and Do not Disturb mode.
>
> **recovery\_period** `integer`
>
> Has no effect for this integration, since an incident resolves as soon as Grafana reports the alert as resolved.
>
> **grafana\_integration\_id** `string` *required*
>
> The ID of the Grafana integration you want to update
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Heartbeat
>
> **Slug:** `BETTER_STACK_UPDATE_HEARTBEAT`
>
> Tool to update an existing heartbeat configuration. Use after retrieving a heartbeat and choosing which fields to change.
>
> #### Input Parameters
>
> **sms** `boolean`
>
> Whether to send an SMS to the on-call person
>
> **call** `boolean`
>
> Whether to call the on-call person on failure
>
> **name** `string`
>
> The name of the service for this heartbeat
>
> **push** `boolean`
>
> Whether to send a push notification on failure
>
> **email** `boolean`
>
> Whether to send an email to the on-call person
>
> **grace** `integer`
>
> Acceptable delay beyond period in seconds (min 0)
>
> **paused** `boolean`
>
> Set true to pause monitoring; false to resume
>
> **period** `integer`
>
> How often to expect the heartbeat in seconds (min 30)
>
> **policy\_id** `string`
>
> ID of the escalation policy to assign
>
> **team\_wait** `integer`
>
> Seconds to wait before escalating alert to team. Leave blank to disable team escalation.
>
> **sort\_index** `integer`
>
> Index position within a heartbeat group
>
> **heartbeat\_id** `string` *required*
>
> The ID of the heartbeat to update
>
> **critical\_alert** `boolean`
>
> Send a critical push ignoring mute and Do Not Disturb
>
> **maintenance\_to** `string`
>
> End of maintenance window each day (HH:MM:SS)
>
> **maintenance\_days** `array`
>
> Days for daily maintenance window. Use both days for overnight windows.
>
> **maintenance\_from** `string`
>
> Start of maintenance window each day (HH:MM:SS)
>
> **heartbeat\_group\_id** `string`
>
> ID of the heartbeat group to assign
>
> **maintenance\_timezone** `string`
>
> Timezone for maintenance window. See Rails TimeZone list.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Heartbeat Group
>
> **Slug:** `BETTER_STACK_UPDATE_HEARTBEAT_GROUP`
>
> Updates an existing heartbeat group's properties. Use to rename a group, change its display order, or pause/resume monitoring for all heartbeats in the group.
>
> #### Input Parameters
>
> **name** `string`
>
> New name for the heartbeat group visible in the dashboard.
>
> **paused** `boolean`
>
> Set to true to pause monitoring for all heartbeats in this group; false to resume monitoring.
>
> **sort\_index** `integer`
>
> Zero-based index to control the display order of heartbeat groups in the dashboard.
>
> **heartbeat\_group\_id** `string` *required*
>
> The ID of the heartbeat group to update. Use list heartbeat groups to find available IDs.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Incident Comment
>
> **Slug:** `BETTER_STACK_UPDATE_INCIDENT_COMMENT`
>
> Tool to update an existing comment on an incident. Use when you need to modify the content of a comment that was previously added to a Better Stack incident.
>
> #### Input Parameters
>
> **content** `string` *required*
>
> The updated content of the comment. Markdown is supported for formatting.
>
> **comment\_id** `string` *required*
>
> The ID of the comment to update
>
> **incident\_id** `string` *required*
>
> The ID of the incident containing the comment
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update incoming webhook
>
> **Slug:** `BETTER_STACK_UPDATE_INCOMING_WEBHOOK`
>
> Update an incoming webhook, sending only the fields to change. Included \*\_rules and \*\_fields collections replace their stored entries entirely; omit a collection to preserve its existing entries. Requires a Better Stack Incidents API token with access to the resource.
>
> #### Input Parameters
>
> **sms** `boolean`
>
> Send an SMS to the on-call person.
>
> **call** `boolean`
>
> Call the on-call person.
>
> **name** `string`
>
> The name of the incoming webhook that you can see in the dashboard.
>
> **push** `boolean`
>
> Send a push notification to the on-call person.
>
> **email** `boolean`
>
> Send an e-mail to the on-call person.
>
> **paused** `boolean`
>
> Set to `true` to pause the integration, `false` to unpause it.
>
> **policy\_id** `string`
>
> ID of the escalation policy for incidents from this integration, or `null` to remove it. Without one, incidents alert the current on-call person through the channels set by `call`, `sms`, `email`, and `push`.
>
> **team\_wait** `integer`
>
> How long we wait before escalating the incident to the team. In seconds. Send `null` to never escalate to the team, or `0` to alert the whole team right away.
>
> **cause\_field** `object`
>
> Cause extraction object; without one incidents show Unknown cause. Required field\_target: query\_string, header, body, json, xml. target\_field: dot path such as alert.id for json/query\_string, header name for header, CSS selector for xml; unused for body. Required match\_type: match\_everything (whole value), match\_before, match\_after, match\_between, match\_regex (match or capture group). content is required for match\_before/match\_after (boundary text) and match\_regex (regex). content\_before and content\_after are required for match\_between.
>
> **title\_field** `object`
>
> How to extract a custom incident title, as a field object with the same keys as `cause_field`. Send `null` to remove it and use the default title.
>
> **started\_rules** `array`
>
> The conditions `started_rule_type` checks, as an array of rule objects with the keys below. At least one rule is required when the type is `any` or `all`. Nested fields: started\_rules\[].rule\_target: Which part of the request the rule checks: `query_string`, `header`, `body`, `json`, or `xml`.; started\_rules\[].target\_field: Which value to read: a dot-separated path such as `alert.id` for `json` and `query_string`, a header name for `header`, or a CSS selector for `xml`. Not used with `body`.; started\_rules\[].match\_type: How to compare the value with `content`: `contains`, `contains_not`, `equals`, `equals_not`, `matches_regex`, or `matches_regex_not`.; started\_rules\[].content: The value to compare with. Must be a valid regular expression for `matches_regex` and `matches_regex_not`.
>
> **critical\_alert** `boolean`
>
> Send a critical push notification that ignores the mute switch and Do Not Disturb mode.
>
> **resolved\_rules** `array`
>
> The conditions `resolved_rule_type` checks, as rule objects with the same keys as `started_rules`.
>
> **recovery\_period** `integer`
>
> How long to wait after a request matching `resolved_rules` arrives before marking an incident as resolved, in seconds: `0`, `60`, `180`, `300`, `900`, `1800`, `3600`, or `7200`. Has no effect while `resolved_rule_type` is `unused`.
>
> **started\_rule\_type** `string ("unused" | "any" | "all")`
>
> When requests start an incident: `unused` always, `any` when at least one of `started_rules` matches, or `all` when all of them match.
>
> **acknowledged\_rules** `array`
>
> The conditions `acknowledged_rule_type` checks, as rule objects with the same keys as `started_rules`.
>
> **resolved\_rule\_type** `string ("unused" | "any" | "all")`
>
> When requests resolve an incident: `unused` never, `any` when at least one of `resolved_rules` matches, or `all` when all of them match. Any other value requires `started_alert_id_field` and `resolved_alert_id_field`.
>
> **incoming\_webhook\_id** `string` *required*
>
> The ID of the incoming webhook you want to update
>
> **other\_started\_fields** `array`
>
> Extra values to extract when an incident starts, saved as incident metadata. Each field object has the same keys as `cause_field`, plus `name`. Nested fields: other\_started\_fields\[].name: The metadata key to save the extracted value under. Must be unique within the array.
>
> **other\_resolved\_fields** `array`
>
> Extra values to extract when an incident is resolved, with the same keys as `other_started_fields`.
>
> **acknowledged\_rule\_type** `string ("unused" | "any" | "all")`
>
> When requests acknowledge an incident: `unused` never, `any` when at least one of `acknowledged_rules` matches, or `all` when all of them match. Any other value requires `started_alert_id_field` and `acknowledged_alert_id_field`.
>
> **started\_alert\_id\_field** `object`
>
> How to extract the alert ID from the request that starts an incident, with the same keys as `cause_field`; later requests acknowledge and resolve the incident by matching it. Required when `acknowledged_rule_type` or `resolved_rule_type` isn't `unused`.
>
> **resolved\_alert\_id\_field** `object`
>
> How to extract the alert ID from a request that resolves an incident, with the same keys as `cause_field`. Required when `resolved_rule_type` isn't `unused`.
>
> **other\_acknowledged\_fields** `array`
>
> Extra values to extract when an incident is acknowledged, with the same keys as `other_started_fields`.
>
> **acknowledged\_alert\_id\_field** `object`
>
> How to extract the alert ID from a request that acknowledges an incident, with the same keys as `cause_field`. Required when `acknowledged_rule_type` isn't `unused`.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Jira integration
>
> **Slug:** `BETTER_STACK_UPDATE_JIRA_INTEGRATION`
>
> ##### Update Jira integration Update an existing Jira integration. Send only the parameters you wish to change (eg. `name`). PATCH /api/v2/jira-integrations/\{jira\_integration\_id} Requires a Better Stack Incidents API token with access to the resource.
>
> #### Input Parameters
>
> **name** `string`
>
> The name of the Jira integration that you can see in the dashboard.
>
> **jira\_fields** `object`
>
> Values for new Jira issues, keyed by Jira field ID. Most values are objects with value (Jira option ID) and label (display name); multi-value fields such as labels/components take arrays of these objects. Text fields take strings and number fields take numbers. Fetch the integration to use existing jira\_fields as a template.
>
> **jira\_project\_key** `string`
>
> The key of the target Jira project, e.g. `ABC` for issues like `ABC-123`.
>
> **jira\_issue\_type\_id** `string`
>
> The ID of the target Jira issue type.
>
> **jira\_integration\_id** `string` *required*
>
> The ID of the Jira integration you want to update
>
> **automatic\_issue\_creation** `boolean`
>
> Create a Jira issue every time an incident occurs.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update metric
>
> **Slug:** `BETTER_STACK_UPDATE_METRIC`
>
> ##### Update a metric Updates an existing metric or label. At least one of `name`, `sql_expression`, or `aggregations` must be provided. PATCH /api/v2/sources/\{source\_id}/metrics/\{id} Requires a Telemetry API token with access to the resource.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> ID of the metric you want to update
>
> **name** `string`
>
> Metric name
>
> **source\_id** `integer` *required*
>
> Source for which to update a metric
>
> **build\_type** `string ("new_data" | "historical_logs")`
>
> How to process historical data. `new_data` (default) applies the change going forward. `historical_logs` reprocesses retained logs.
>
> **aggregations** `array`
>
> Aggregations to apply to the metric. Set to `[]` to change into a label. \
> &#x20;Valid aggregations are `avg`, `count`, `uniq`, `max`, `min`, `sum`, and `histogram`
>
> **sql\_expression** `string`
>
> SQL expression to use for the metric
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Monitor
>
> **Slug:** `BETTER_STACK_UPDATE_MONITOR`
>
> Tool to update an existing uptime monitor configuration. Use when you need to modify settings of an existing monitor such as check frequency, notification preferences, URLs, or monitoring behavior.
>
> #### Input Parameters
>
> **sms** `boolean`
>
> Enable SMS notifications when monitor goes down or recovers.
>
> **url** `string`
>
> The URL or host to monitor. For HTTP/HTTPS monitors use full URL with protocol. For TCP/UDP/SMTP/POP/IMAP use hostname or IP. For DNS monitors use the domain to query.
>
> **call** `boolean`
>
> Enable phone call alerts when monitor goes down or recovers.
>
> **port** `string`
>
> Port number for TCP, UDP, SMTP, POP, or IMAP monitors. Required for these monitor types.
>
> **push** `boolean`
>
> Enable push notifications to on-call personnel when monitor goes down or recovers.
>
> **email** `boolean`
>
> Enable email notifications when monitor goes down or recovers.
>
> **paused** `boolean`
>
> If true, the monitor is paused and will not perform checks. If false, monitoring resumes.
>
> **regions** `array`
>
> List of regions from which to perform checks. Available: us (United States), eu (Europe), as (Asia), au (Australia).
>
> **policy\_id** `string`
>
> ID of the escalation policy to use for this monitor. Controls who gets notified and in what order.
>
> **team\_wait** `integer`
>
> Seconds to wait before escalating to the team after first notification. Leave blank to disable team escalation.
>
> **ip\_version** `string ("ipv4" | "ipv6")`
>
> IP version to use for checks.
>
> **monitor\_id** `string` *required*
>
> The ID of the monitor to update
>
> **verify\_ssl** `boolean`
>
> Verify SSL certificates for HTTPS monitors. If false, monitors will accept invalid/self-signed certificates.
>
> **http\_method** `string ("GET" | "HEAD" | "POST" | "PUT" | "PATCH")`
>
> HTTP method for status/keyword monitors.
>
> **monitor\_type** `string ("status" | "expected_status_code" | "keyword" | "keyword_absence" | "ping" | "tcp" | "udp" | "smtp" | "pop" | "imap" | "dns" | "playwright")`
>
> Type of monitor to create or update.
>
> **request\_body** `string`
>
> Body content to send with POST/PUT/PATCH requests. Required for DNS monitors (specify the DNS record type to query).
>
> **auth\_password** `string`
>
> Password for HTTP Basic Authentication. Used with auth\_username.
>
> **auth\_username** `string`
>
> Username for HTTP Basic Authentication. Used with auth\_password.
>
> **scenario\_name** `string`
>
> Name identifier for playwright monitor scenarios. Used to distinguish between different automation scripts.
>
> **critical\_alert** `boolean`
>
> If enabled, alerts will override Do Not Disturb settings and mute schedules. Use for critical monitors only.
>
> **maintenance\_to** `string`
>
> End time of daily maintenance window in HH:MM:SS format. Checks resume after this time.
>
> **ssl\_expiration** `integer`
>
> Advance warning in days before SSL certificate expiration. Allowed values: 1, 2, 3, 7, 14, 30, or 60.
>
> **check\_frequency** `integer`
>
> How often to check the monitor in seconds. Minimum is 30 seconds. Default is 30.
>
> **recovery\_period** `integer`
>
> Number of seconds the monitor must be up before automatically resolving any open incidents.
>
> **request\_headers** `array`
>
> List of HTTP headers to send with the check request.
>
> **request\_timeout** `integer`
>
> Request timeout in milliseconds for server/port monitors or seconds for other types.
>
> **follow\_redirects** `boolean`
>
> Automatically follow HTTP redirects when checking status/keyword monitors.
>
> **maintenance\_days** `array`
>
> Days of the week to skip monitoring checks during maintenance windows. Combine with maintenance\_from and maintenance\_to.
>
> **maintenance\_from** `string`
>
> Start time of daily maintenance window in HH:MM:SS format. Checks are skipped during this window on specified maintenance\_days.
>
> **monitor\_group\_id** `string`
>
> ID of the monitor group to assign this monitor to. Used for organizing monitors.
>
> **remember\_cookies** `boolean`
>
> Whether to remember cookies across checks and redirects.
>
> **required\_keyword** `string`
>
> For keyword monitors: the text that must be present in the response. For keyword\_absence monitors: the text that must NOT be present. Required for keyword and UDP monitor types.
>
> **domain\_expiration** `integer`
>
> Advance warning in days before domain expiration. Allowed values: 1, 2, 3, 7, 14, 30, or 60.
>
> **playwright\_script** `string`
>
> JavaScript code for playwright monitor type. Defines browser automation scenario to execute during checks.
>
> **pronounceable\_name** `string`
>
> Human-readable name for the monitor displayed in the dashboard.
>
> **confirmation\_period** `integer`
>
> How long in seconds to observe failures before creating an incident. Helps avoid false alerts from transient issues.
>
> **expiration\_policy\_id** `integer`
>
> ID of the escalation policy for SSL certificate and domain expiration alerts. Null sends email to team.
>
> **maintenance\_timezone** `string`
>
> Timezone for maintenance window times. Use Rails TimeZone values. Defaults to UTC.
>
> **environment\_variables** `object`
>
> Key-value pairs of environment variables accessible within playwright scripts. Useful for parameterizing automation scenarios.
>
> **expected\_status\_codes** `array`
>
> Array of acceptable HTTP status codes for successful checks. Used with expected\_status\_code monitor type.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Monitor Group
>
> **Slug:** `BETTER_STACK_UPDATE_MONITOR_GROUP`
>
> Updates an existing monitor group's properties. Use to rename a group, change its display order, or pause/resume monitoring for all monitors in the group.
>
> #### Input Parameters
>
> **name** `string`
>
> Display name for the monitor group visible in the dashboard.
>
> **paused** `boolean`
>
> Set to true to pause monitoring for any existing monitors in the group; false to resume monitoring.
>
> **sort\_index** `integer`
>
> Numeric value controlling monitor group sort order in the dashboard.
>
> **monitor\_group\_id** `string` *required*
>
> The ID of the monitor group to update. Use list monitor groups to find available IDs.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update New Relic integration
>
> **Slug:** `BETTER_STACK_UPDATE_NEW_RELIC_INTEGRATION`
>
> ##### Update New Relic integration Update an existing New Relic integration. Send only the parameters you wish to change (eg. `paused`). PATCH /api/v2/new-relic-integrations/\{new\_relic\_integration\_id} Requires a Better Stack Incidents API token with access to the resource.
>
> #### Input Parameters
>
> **sms** `boolean`
>
> Send an SMS to the on-call person.
>
> **call** `boolean`
>
> Call the on-call person.
>
> **name** `string`
>
> The name of the New Relic integration that you can see in the dashboard.
>
> **push** `boolean`
>
> Send a push notification to the on-call person.
>
> **email** `boolean`
>
> Send an e-mail to the on-call person.
>
> **paused** `boolean`
>
> Set to `true` to pause the integration, `false` to unpause it.
>
> **policy\_id** `string`
>
> ID of the escalation policy associated with the New Relic integration.
>
> **team\_wait** `integer`
>
> How long we wait before escalating the incident alert to the team. In seconds.
>
> **alerting\_rule** `string ("alert" | "alert_and_warn")`
>
> Should we alert only on alarms, or on both alarms and warnings. Possible values: `alert`, `alert_and_warn`. Defaults to `alert`.
>
> **critical\_alert** `boolean`
>
> Send a critical push notification that ignores the mute switch and Do not Disturb mode.
>
> **recovery\_period** `integer`
>
> Has no effect for this integration, since an incident resolves as soon as New Relic reports the alert as resolved.
>
> **new\_relic\_integration\_id** `string` *required*
>
> The ID of the New Relic integration you want to update
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update on-call event
>
> **Slug:** `BETTER_STACK_UPDATE_ON_CALL_EVENT`
>
> ##### Update on-call schedule event Update a single event in the given on-call schedule. Events starting sooner than today at 0:00 UTC can't be updated. PATCH /api/v2/on-calls/\{schedule\_id}/events/\{event\_id} Requires a Better Stack Incidents API token with access to the resource.
>
> #### Input Parameters
>
> **users** `array`
>
> List of e-mail addresses of the users that will be on-call during this event. Each user must be a member of the schedule's team with a role that can respond to incidents, such as Responder.
>
> **ends\_at** `string`
>
> End time of the event as an ISO 8601 timestamp.
>
> **event\_id** `string` *required*
>
> The ID of the event you want to update.
>
> **override** `boolean`
>
> Whether this event is an override. Override events take precedence over regular scheduled events.
>
> **starts\_at** `string`
>
> Start time of the event as an ISO 8601 timestamp, e.g. 2025-01-01T09:45:00Z. Must be today at 0:00 UTC or later.
>
> **schedule\_id** `string` *required*
>
> The ID of the on-call schedule that the event is part of. Use `default` to refer to the default on-call schedule for the team.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update On-Call Schedule
>
> **Slug:** `BETTER_STACK_UPDATE_ON_CALL_SCHEDULE`
>
> Tool to update an on-call schedule's name. Use when you need to rename an existing on-call calendar.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> The name of the schedule
>
> **schedule\_id** `string` *required*
>
> The ID of the on-call schedule you want to update
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update outgoing email
>
> **Slug:** `BETTER_STACK_UPDATE_OUTGOING_EMAIL`
>
> ##### Update outgoing e-mail Updates an existing outgoing e-mail integration. Only the parameters you send are changed. Returns the updated integration, or validation errors. Sending `recipients` replaces the whole recipient list. PATCH /api/v2/outgoing-emails/\{integration\_id} Requires a Better Stack Incidents API token with access to the resource.
>
> #### Input Parameters
>
> **name** `string`
>
> The name of the outgoing e-mail integration that you can see in the dashboard.
>
> **templates** `array`
>
> Per-event message templates. See [Create outgoing e-mail](https://betterstack.com/docs/uptime/api/create-outgoing-email-integration/) for the shape, variables, and replace semantics.
>
> **recipients** `array`
>
> The addresses that receive incident e-mails. Each entry is either a plain e-mail string, or an object with an `email` key plus your own custom attribute keys. Replaces the whole recipient list when sent. See [Create outgoing e-mail](https://betterstack.com/docs/uptime/api/create-outgoing-email-integration/) for the full shape.
>
> **integration\_id** `string` *required*
>
> The ID of the outgoing e-mail integration.
>
> **on\_incident\_comment** `boolean`
>
> Whether to send an e-mail when a new comment is added to an incident. At least one of the `on_incident_*` triggers must stay enabled.
>
> **on\_incident\_started** `boolean`
>
> Whether to send an e-mail when an incident starts.
>
> **on\_incident\_reopened** `boolean`
>
> Whether to send an e-mail when an incident is reopened.
>
> **on\_incident\_resolved** `boolean`
>
> Whether to send an e-mail when an incident is resolved.
>
> **on\_incident\_acknowledged** `boolean`
>
> Whether to send an e-mail when an incident is acknowledged.
>
> **notify\_alongside\_primary\_responder** `boolean`
>
> Whether to notify recipients alongside the primary responder when no escalation policy is configured.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Outgoing Webhook Integration
>
> **Slug:** `BETTER_STACK_UPDATE_OUTGOING_WEBHOOK`
>
> Tool to update an existing outgoing webhook integration. Use when you need to modify the configuration of a webhook endpoint.
>
> #### Input Parameters
>
> **url** `string`
>
> Webhook destination URL
>
> **name** `string`
>
> Integration display name
>
> **on\_incident\_started** `boolean`
>
> Trigger on incident creation
>
> **outgoing\_webhook\_id** `string` *required*
>
> The ID of the Outgoing Webhook integration you want to update
>
> **on\_incident\_reopened** `boolean`
>
> Trigger when incident reopened
>
> **on\_incident\_resolved** `boolean`
>
> Trigger when incident resolved
>
> **on\_incident\_acknowledged** `boolean`
>
> Trigger when incident acknowledged
>
> **custom\_webhook\_template\_attributes** `object`
>
> Custom webhook template attributes such as HTTP method, headers, and body.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update PagerDuty integration
>
> **Slug:** `BETTER_STACK_UPDATE_PAGERDUTY_INTEGRATION`
>
> ##### Update PagerDuty integration Update an existing PagerDuty integration. Send only the parameters you wish to change (eg. `name`). PATCH /api/v2/pager-duty-webhooks/\{pager\_duty\_webhook\_id} Requires a Better Stack Incidents API token with access to the resource.
>
> #### Input Parameters
>
> **key** `string`
>
> The PagerDuty routing key.
>
> **name** `string`
>
> The name of the PagerDuty integration that you can see in the dashboard.
>
> **severity** `string ("info" | "warning" | "error" | "critical")`
>
> The severity of PagerDuty alerts created for new incidents. Possible values: `info`, `warning`, `error`, `critical`.
>
> **pager\_duty\_webhook\_id** `string` *required*
>
> The ID of the PagerDuty integration you want to update.
>
> **notify\_alongside\_primary\_responder** `boolean`
>
> Whether to notify this integration alongside the primary responder when no escalation policy is configured. Defaults to `true`.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Escalation Policy Group
>
> **Slug:** `BETTER_STACK_UPDATE_POLICY_GROUP`
>
> Updates an existing escalation policy group's properties. Use to rename a group or change its display order.
>
> #### Input Parameters
>
> **name** `string`
>
> New name for the escalation policy group visible in the dashboard.
>
> **sort\_index** `integer`
>
> Zero-based index to control the display order of escalation policy groups in the dashboard.
>
> **policy\_group\_id** `string` *required*
>
> The ID of the escalation policy group to update. Use list policy groups to find available IDs.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Prometheus integration
>
> **Slug:** `BETTER_STACK_UPDATE_PROMETHEUS_INTEGRATION`
>
> ##### Update Prometheus integration Update an existing Prometheus integration. Send only the parameters you wish to change (eg. `paused`). PATCH /api/v2/prometheus-integrations/\{prometheus\_integration\_id} Requires a Better Stack Incidents API token with access to the resource.
>
> #### Input Parameters
>
> **sms** `boolean`
>
> Send an SMS to the on-call person.
>
> **call** `boolean`
>
> Call the on-call person.
>
> **name** `string`
>
> The name of the Prometheus integration that you can see in the dashboard.
>
> **push** `boolean`
>
> Send a push notification to the on-call person.
>
> **email** `boolean`
>
> Send an e-mail to the on-call person.
>
> **paused** `boolean`
>
> Set to `true` to pause the integration, `false` to unpause it.
>
> **policy\_id** `string`
>
> ID of the escalation policy associated with the Prometheus integration.
>
> **team\_wait** `integer`
>
> How long we wait before escalating the incident alert to the team. In seconds.
>
> **critical\_alert** `boolean`
>
> Send a critical push notification that ignores the mute switch and Do not Disturb mode.
>
> **recovery\_period** `integer`
>
> Has no effect for this integration, since an incident resolves as soon as Prometheus reports the alert as resolved.
>
> **prometheus\_integration\_id** `string` *required*
>
> The ID of the Prometheus integration you want to update
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update slack integration
>
> **Slug:** `BETTER_STACK_UPDATE_SLACK_INTEGRATION`
>
> Update an existing Slack integration's explicitly provided settings. Lists replace the whole list. Connect Slack in the Better Stack dashboard first.
>
> #### Input Parameters
>
> **alert\_options** `array`
>
> Replaces the teams and escalation policies Slack users can alert. A team is `{"type": "team", "id": 7}` with the booleans `call`, `sms`, `email`, `push` and `critical_alert`, each `false` when left out. An escalation policy is `{"type": "policy", "id": 73}`. The provider ignores read-only keys from GET (`name`, `team_id`, `team_name`), so GET options can be sent back unchanged.
>
> **notify\_on\_pause** `boolean`
>
> Notify when a resource is paused.
>
> **private\_channel** `boolean`
>
> Make the incident channels private. Needs at least one entry in `channel_invitees`.
>
> **channel\_invitees** `array`
>
> Who to always invite into the incident channel when `integration_type` is `channel`. Replaces the whole list. Each object has a `type` and an `id`; `type` is `user`, `on_call_calendar`, or `slack_user_group`.
>
> **integration\_type** `string ("verbose" | "thread" | "channel")`
>
> How incidents are posted. `verbose` posts every incident to the single connected channel, `thread` starts a thread per incident in it, and `channel` creates a new channel per incident. `thread` and `channel` need a paid plan.
>
> **ai\_sre\_on\_mention** `boolean`
>
> Start an AI SRE conversation when Better Stack is tagged.
>
> **notify\_on\_resolve** `boolean`
>
> Notify when an incident is resolved.
>
> **channel\_display\_name** `string`
>
> The name shown for the connected channel in Better Stack. Send `null` to show the channel's own name.
>
> **post\_timeline\_events** `boolean`
>
> Post incident timeline events about e-mails, phone calls, and integrations. Applies when `integration_type` is `thread` or `channel`.
>
> **slack\_integration\_id** `string` *required*
>
> The ID of the Slack integration you want to update.
>
> **on\_call\_notifications** `boolean`
>
> Notify the channel when the primary responder changes.
>
> **invite\_new\_slack\_users** `boolean`
>
> Invite new Slack users into your Better Stack team as responders.
>
> **post\_incident\_metadata** `boolean`
>
> Post incident metadata.
>
> **post\_status\_page\_updates** `boolean`
>
> Post status page updates. Turning it off clears `status_page_update_resources`.
>
> **direct\_message\_on\_mention** `boolean`
>
> Send a direct message to people tagged in incident comments.
>
> **alert\_all\_teams\_and\_policies** `boolean`
>
> Let Slack users alert every team and escalation policy. Set it to `false` to allow only the ones in `alert_options`.
>
> **status\_page\_update\_resources** `array`
>
> Replaces the affected resources for status page updates. Each object has a `type` and an `id`; an empty list posts updates for every resource of the integration's team. Needs `post_status_page_updates` turned on.
>
> **notify\_alongside\_primary\_responder** `boolean`
>
> Notify this integration alongside the primary responder when no escalation policy is configured.
>
> **restrict\_incident\_creation\_to\_channel** `boolean`
>
> Allow creating incidents only by the members of the connected channel.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update source
>
> **Slug:** `BETTER_STACK_UPDATE_SOURCE`
>
> ##### Update a source Updates an existing source. Send only the parameters you wish to change (e.g. `name` ) PATCH /api/v2/sources/\{source\_id} Requires a Telemetry API token with access to the resource.
>
> #### Input Parameters
>
> **name** `string`
>
> Source name
>
> **source\_id** `string` *required*
>
> Identifier of the source.
>
> **scrape\_urls** `array`
>
> URLs to scrape by `prometheus_scrape` platform and similar.
>
> **aws\_role\_arn** `string`
>
> For aws sources: CloudFormation IntegrationRoleArn. Send together with aws\_external\_id.
>
> **custom\_bucket** `object`
>
> Rotates the key pair of the custom bucket the source already uses. Send only `access_key_id` and `secret_access_key`. We verify the new pair against the bucket first; if that fails, the whole request is rejected with a 422 and nothing is changed. A bucket shared by several sources is rotated for all of them. Send the new pair before deactivating the old one to rotate without downtime. A custom bucket can only be added when [creating a source](https://betterstack.com/docs/logs/api/create-a-source/).
>
> **aws\_account\_id** `string`
>
> Link an already connected AWS account instead of sending aws\_role\_arn and aws\_external\_id.
>
> **gcp\_account\_id** `string`
>
> Link an already connected Google Cloud project instead of sending gcp\_project\_id and gcp\_project\_number.
>
> **gcp\_project\_id** `string`
>
> For gcp sources: Google Cloud project ID. Send together with gcp\_project\_number.
>
> **logs\_retention** `integer`
>
> Data retention for logs in days. There might be additional charges for longer retention.
>
> **aws\_external\_id** `string`
>
> For aws sources: CloudFormation ExternalId for STS assume-role trust. Send together with aws\_role\_arn.
>
> **blocked\_metrics** `array`
>
> Metric names to mark as spam. Listed metrics are rejected during ingestion and aren't billed.
>
> **skip\_ssl\_verify** `boolean`
>
> Whether to skip SSL/TLS certificate verification for `prometheus_scrape` platform and similar. Set to `true` to disable verification.
>
> **source\_group\_id** `integer`
>
> The ID of the source group this source belongs to
>
> **ingesting\_paused** `boolean`
>
> Enable or disable ingesting for this source
>
> **live\_tail\_pattern** `string`
>
> Live tail message format with columns wrapped in `{column}` brackets.   Example: `"PID: {message_json.pid} {level} {message}"`.   For details, see [Live tail docs](https://betterstack.com/docs/logs/using-logtail/formatting-logs/#live-tail-message-format).
>
> **metrics\_retention** `integer`
>
> Data retention for metrics in days. There might be additional charges for longer retention.
>
> **gcp\_project\_number** `string`
>
> For gcp sources: Google Cloud project number. Send together with gcp\_project\_id.
>
> **scrape\_frequency\_secs** `integer ("15" | "30" | "60" | "120" | "300")`
>
> How often to scrape the URLs for `prometheus_scrape` platform and similar. Permitted values are 15, 30, 60, 120 or 300.
>
> **scrape\_request\_headers** `array`
>
> An array of request headers for `prometheus_scrape` platform and similar, with each object containing `name` and `value` fields.
>
> **aws\_auto\_sub\_log\_groups** `boolean`
>
> Only for `aws` sources. Whether Better Stack automatically subscribes newly discovered Amazon CloudWatch log groups for ingestion. Defaults to `true`. Set to `false` to subscribe log groups yourself.
>
> **vrl\_transformation\_logs** `string`
>
> The VRL code applied to logs during ingestion. Send an empty string to remove the transformation, or `null` to reset it to the platform default. Read more about [VRL transformations](https://betterstack.com/docs/logs/using-logtail/transforming-ingested-data/logs-vrl/).
>
> **vrl\_transformation\_spans** `string`
>
> The VRL code applied to traces (spans) during ingestion. Send an empty string to remove the transformation. Read more about [VRL transformations](https://betterstack.com/docs/logs/using-logtail/transforming-ingested-data/logs-vrl/).
>
> **scrape\_request\_basic\_auth\_user** `string`
>
> Basic auth username for `prometheus_scrape` platform and similar.
>
> **scrape\_request\_basic\_auth\_password** `string`
>
> Basic auth password for `prometheus_scrape` platform and similar.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Source Group
>
> **Slug:** `BETTER_STACK_UPDATE_SOURCE_GROUP`
>
> Update an existing source group in Better Stack Logs/Telemetry. Use this to rename a source group or change its sort order. Requires a Telemetry API token (different from Uptime API token).
>
> #### Input Parameters
>
> **name** `string`
>
> The new display name of the source group
>
> **sort\_index** `integer`
>
> Order index to control group sorting. Must be non-negative.
>
> **source\_group\_id** `string` *required*
>
> The ID of the source group you want to update
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Splunk integration
>
> **Slug:** `BETTER_STACK_UPDATE_SPLUNK_INTEGRATION`
>
> ##### Update Splunk integration Update an existing Splunk On-Call integration. Send only the parameters you wish to change (eg. `name`). PATCH /api/v2/splunk-on-calls/\{splunk\_on\_call\_id} Requires a Better Stack Incidents API token with access to the resource.
>
> #### Input Parameters
>
> **url** `string`
>
> The Splunk On-Call URL to which to post webhooks to.
>
> **name** `string`
>
> The name of the Splunk On-Call integration that you can see in the dashboard.
>
> **splunk\_on\_call\_id** `string` *required*
>
> The ID of the Splunk On-Call integration you want to update.
>
> **notify\_alongside\_primary\_responder** `boolean`
>
> Whether to notify this integration alongside the primary responder when no escalation policy is configured. Defaults to `true`.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Status Page Group
>
> **Slug:** `BETTER_STACK_UPDATE_STATUS_PAGE_GROUP`
>
> Tool to update an existing status page group. Use when you need to modify the name or display order of a status page group.
>
> #### Input Parameters
>
> **name** `string`
>
> A descriptive label for the group visible in the dashboard.
>
> **sort\_index** `integer`
>
> Numeric value determining the group's display order.
>
> **status\_page\_group\_id** `string` *required*
>
> The ID of the status page group to update. Use list status page groups to find available IDs.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Status Page Report
>
> **Slug:** `BETTER_STACK_UPDATE_STATUS_PAGE_REPORT`
>
> Tool to update an existing status page report. Use when you need to modify the title, timing, or affected resources of an existing incident or maintenance report.
>
> #### Input Parameters
>
> **title** `string`
>
> The updated title/name for the status page report
>
> **ends\_at** `string`
>
> ISO-8601 timestamp when the report concludes. Required for maintenance-type reports.
>
> **report\_id** `string` *required*
>
> The numeric ID of the status report to update (e.g., '824282').
>
> **starts\_at** `string`
>
> ISO-8601 timestamp when the report becomes active. Defaults to current time if not provided.
>
> **status\_page\_id** `string` *required*
>
> The numeric ID of the status page (e.g., '221582'). Obtain this from the list\_status\_pages action.
>
> **affected\_resources** `array`
>
> List of status page resources affected by this report, with their status. Each object must contain status\_page\_resource\_id and status fields.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Status Page Resource
>
> **Slug:** `BETTER_STACK_UPDATE_STATUS_PAGE_RESOURCE`
>
> Tool to update an existing status page resource. Use when you need to modify the display name, position, widget type, or other properties of a resource on a status page.
>
> #### Input Parameters
>
> **position** `integer`
>
> Zero-indexed placement; unspecified defaults to end position
>
> **explanation** `string`
>
> Helper text displayed as an icon
>
> **public\_name** `string`
>
> How the resource appears on your public status page
>
> **resource\_id** `string` *required*
>
> The specific resource requiring modification
>
> **widget\_type** `string ("plain" | "history" | "response_times" | "chart_only")`
>
> Display format options: plain, history, response\_times, or chart\_only
>
> **resource\_type** `string ("Monitor" | "MonitorGroup" | "Heartbeat" | "HeartbeatGroup" | "WebhookIntegration" | "EmailIntegration" | "IncomingWebhook" | "ResourceGroup" | "LogsChart" | "CatalogReference")`
>
> Type of resource on the status page
>
> **fixed\_position** `boolean`
>
> Boolean preventing position reordering when enabled
>
> **status\_page\_id** `string` *required*
>
> The identifier of your status page
>
> **mark\_as\_down\_for** `string ("any_incident" | "no_incident" | "incident_matching_metadata")`
>
> Incident impact settings: any\_incident, no\_incident, or incident\_matching\_metadata
>
> **mark\_as\_degraded\_for** `string ("any_incident" | "no_incident" | "incident_matching_metadata")`
>
> Degraded status trigger: any\_incident, no\_incident, or incident\_matching\_metadata
>
> **status\_page\_section\_id** `string`
>
> Section assignment (defaults to first section if omitted)
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Status Pages
>
> **Slug:** `BETTER_STACK_UPDATE_STATUS_PAGES`
>
> Tool to update an existing status page configuration. Use when modifying settings like company info, appearance, access control, or display preferences.
>
> #### Input Parameters
>
> **theme** `string ("light" | "dark" | "system")`
>
> Theme options for status pages (v2 only).
>
> **design** `string ("v1" | "v2")`
>
> Design version options for status pages.
>
> **layout** `string ("vertical" | "horizontal")`
>
> Layout options for status pages (v2 only).
>
> **history** `integer`
>
> Number of days to display on the status page. Between 7 and 365 days
>
> **logo\_url** `string`
>
> URL of the logo image. Image should be under 20MB
>
> **password** `string`
>
> Password for accessing the status page (when password\_enabled is true)
>
> **timezone** `string`
>
> Timezone in Rails TimeZone format
>
> **subdomain** `string`
>
> Subdomain for the status page. Must be globally unique
>
> **custom\_css** `string`
>
> Custom CSS to apply to the status page
>
> **company\_url** `string`
>
> URL of the company homepage
>
> **contact\_url** `string`
>
> URL for contact or support page
>
> **announcement** `string`
>
> Announcement text to display on the status page
>
> **company\_name** `string`
>
> Company name shown on the status page
>
> **ip\_allowlist** `array`
>
> List of IP addresses allowed to access the page
>
> **subscribable** `boolean`
>
> Whether visitors can subscribe for updates
>
> **custom\_domain** `string`
>
> Custom domain for the status page
>
> **status\_page\_id** `string` *required*
>
> Identifier for the status page being modified
>
> **navigation\_links** `array`
>
> Custom navigation links for the status page
>
> **password\_enabled** `boolean`
>
> Whether a password is required to view the page
>
> **automatic\_reports** `boolean`
>
> Whether automatic reports are enabled
>
> **custom\_javascript** `string`
>
> Custom JavaScript to apply to the status page
>
> **google\_analytics\_id** `string`
>
> Google Analytics tracking ID
>
> **min\_incident\_length** `integer`
>
> Minimum incident duration in seconds to be displayed
>
> **status\_page\_group\_id** `string`
>
> ID of the status page group to assign this page to
>
> **hide\_from\_search\_engines** `boolean`
>
> Whether the page should be hidden from search engines
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Status Page Section
>
> **Slug:** `BETTER_STACK_UPDATE_STATUS_PAGE_SECTION`
>
> Tool to update an existing status page section. Use when reorganizing sections or changing their display. Leave name blank to hide the section header.
>
> #### Input Parameters
>
> **name** `string`
>
> Section title. Omit to hide the header.
>
> **position** `integer`
>
> Zero-indexed placement on the status page. Unspecified adds to end.
>
> **section\_id** `string` *required*
>
> The section identifier you want to modify.
>
> **status\_page\_id** `string` *required*
>
> The identifier for your status page.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Status Update
>
> **Slug:** `BETTER_STACK_UPDATE_STATUS_PAGE_STATUS_REPORT_STATUS_UPDATE`
>
> Tool to update an existing status update for a status report. Use when you need to modify the message, affected resources, or other details of a previously created status update.
>
> #### Input Parameters
>
> **message** `string`
>
> Message associated with the status update, providing details about the current state or actions taken.
>
> **published\_at** `string`
>
> ISO-8601 timestamp for publication time. If not provided, uses the original published time.
>
> **status\_page\_id** `string` *required*
>
> Your status page identifier. Obtain from list\_status\_pages action.
>
> **status\_report\_id** `string` *required*
>
> Your status page report identifier. Obtain from list\_status\_page\_reports action.
>
> **status\_update\_id** `string` *required*
>
> Your status update identifier. Obtain from list\_status\_page\_report\_status\_updates action.
>
> **affected\_resources** `array`
>
> Array of affected resources with their current status. If provided, must contain at least one resource.
>
> **notify\_subscribers** `boolean`
>
> Send notification email to subscribers. Default is false.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update status page subscriber
>
> **Slug:** `BETTER_STACK_UPDATE_STATUS_PAGE_SUBSCRIBER`
>
> ##### Update status page subscriber Updates which status page resources an e-mail subscriber receives notifications for. Only `status_page_resource_ids` can be changed. To change an e-mail address, remove the old subscriber and create a new one. PATCH /api/v2/status-pages/\{status\_page\_id}/subscribers/\{subscriber\_id} Requires a Better Stack Incidents API token with access to the resource.
>
> #### Input Parameters
>
> **subscriber\_id** `string` *required*
>
> The ID of the subscriber.
>
> **status\_page\_id** `string` *required*
>
> The ID of your status page.
>
> **status\_page\_resource\_ids** `array` *required*
>
> The status page resources this subscriber receives updates for. Use `[]` for all resources. Each ID must be a resource of this status page other than a third party service. Get valid resource IDs from `GET /api/v2/status-pages/{status_page_id}/resources`.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update team member role
>
> **Slug:** `BETTER_STACK_UPDATE_TEAM_MEMBER_ROLE`
>
> Change an existing team member's role using an ID from List roles. Supports custom roles, returned as role=custom. Requires a global API token with team\_name, or a team-scoped Incidents API token. Changes to or from admin are forbidden; changes to or from billing\_admin require a global token and apply across all the member's teams. Pending invitations cannot use this operation. Assigning the current role returns the member unchanged (HTTP 200).
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The ID of the team member, as returned by the [List](https://betterstack.com/docs/uptime/api/team-members/list/) or [Get](https://betterstack.com/docs/uptime/api/team-members/get/) team members API. Pending invitations cannot have their role changed this way — cancel and re-invite them instead.
>
> **role\_id** `string` *required*
>
> The ID of the role to assign, as returned by the [List roles API](https://betterstack.com/docs/uptime/api/roles/list/). Custom roles are supported. The response returns `role` as `custom` for a custom role.
>
> **team\_name** `string`
>
> Required if using a [global API token](https://betterstack.com/docs/uptime/api/getting-started-with-uptime-api/#get-a-global-api-token) to specify the team. Ignored for team-scoped Incidents API tokens.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Severity Level
>
> **Slug:** `BETTER_STACK_UPDATE_URGENCIES`
>
> Update a severity level (urgency) by ID, providing its name and SMS, call, email, and push notification settings.
>
> #### Input Parameters
>
> **sms** `boolean` *required*
>
> Enables SMS notifications for new incidents at this severity level
>
> **call** `boolean` *required*
>
> Enables phone calls for new incidents at this severity level
>
> **name** `string` *required*
>
> The identifier for this severity level
>
> **push** `boolean` *required*
>
> Enables push notifications for new incidents at this severity level
>
> **email** `boolean` *required*
>
> Enables email notifications for new incidents at this severity level
>
> **urgency\_id** `string` *required*
>
> The ID of the severity level to update
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Urgency Group
>
> **Slug:** `BETTER_STACK_UPDATE_URGENCY_GROUP`
>
> Tool to update an existing urgency group (severity group). Use when you need to modify the name or sort order of a severity group.
>
> #### Input Parameters
>
> **name** `string`
>
> The display name for the group visible in the dashboard.
>
> **sort\_index** `integer`
>
> Determines the sorting order of the severity group. Must be non-negative.
>
> **urgency\_group\_id** `string` *required*
>
> The ID of the urgency group (severity group) to update. You can get this from the list urgency groups action.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
