- Category: server monitoring
- Auth: API_KEY
- Composio-managed OAuth available? N/A
- Tools: 117
- Triggers: 0
- Slug:
BETTER_STACK - Version: 20261101_00
Tools
Acknowledge Incident
Acknowledge Incident
Batch create catalog records
Batch create catalog records
BETTER_STACK_BATCH_CREATE_CATALOG_RECORDSBatch 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
Output
Batch remove catalog records
Batch remove catalog records
BETTER_STACK_BATCH_REMOVE_CATALOG_RECORDSBatch 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
Output
Batch update catalog records
Batch update catalog records
BETTER_STACK_BATCH_UPDATE_CATALOG_RECORDSBatch 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
Output
Batch upsert catalog records
Batch upsert catalog records
BETTER_STACK_BATCH_UPSERT_CATALOG_RECORDSCreate 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
Output
Bulk update on-call events
Bulk update on-call events
BETTER_STACK_BULK_UPDATE_ON_CALL_EVENTSBulk 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
default to refer to the default on-call schedule for the team.Output
Create Amazon SNS integration
Create Amazon SNS integration
BETTER_STACK_CREATE_AMAZON_SNS_INTEGRATIONCreate 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. 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
call, sms, email, and push.null to never escalate to the team, or 0 to alert the whole team right away.cause_field. Defaults to the notification’s Subject, and null removes it to use the default title.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.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.unused always, any when at least one of started_rules matches, or all when all of them match. Defaults to unused.acknowledged_rule_type checks, as rule objects with the same keys as started_rules.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.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_started_fields.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.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.cause_field. Required when resolved_rule_type isn’t unused.other_started_fields.cause_field. Required when acknowledged_rule_type isn’t unused.Output
Create AWS CloudWatch integration
Create AWS CloudWatch integration
BETTER_STACK_CREATE_AWS_CLOUDWATCH_INTEGRATIONCreate 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
Output
Create aws log group subscription
Create aws log group subscription
BETTER_STACK_CREATE_AWS_LOG_GROUP_SUBSCRIPTIONCreate 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
Output
Create Azure integration
Create Azure integration
BETTER_STACK_CREATE_AZURE_INTEGRATIONCreate 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
Output
Create catalog attribute
Create catalog attribute
BETTER_STACK_CREATE_CATALOG_ATTRIBUTECreate 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
false.Output
Create catalog record
Create catalog record
BETTER_STACK_CREATE_CATALOG_RECORDCreate 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
Output
Create catalog relation
Create catalog relation
BETTER_STACK_CREATE_CATALOG_RELATIONCreate 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
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.Output
Create chart
Create chart
BETTER_STACK_CREATE_CHARTCreate 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
Output
Create chart comment
Create chart comment
BETTER_STACK_CREATE_CHART_COMMENTCreate 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
2026-08-17T12:34:56.789Z. A datetime without a zone offset is read as UTC.Output
Create collector
Create collector
BETTER_STACK_CREATE_COLLECTORCreate 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. [/info] POST /api/v1/collectors Requires a Telemetry API token with access to the resource.
Input Parameters
docker, swarm, and kubernetes.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.{column} brackets. Example: "PID: {message_json.pid} {level} {message}". For details, see Live tail docs.Output
Create collector metric target
Create collector metric target
BETTER_STACK_CREATE_COLLECTOR_METRIC_TARGETCreate 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
mysql. Valid options are false, true, skip-verify, and preferred.postgres, mysql, redis, mongodb, memcached, elasticsearch, nginx, apache, kafka, and prometheus.elasticsearch. Valid options are http and https. Defaults to http if omitted.elasticsearch. Write-only - never returned in responses.elasticsearch. Write-only - never returned in responses.postgres. Valid options are disable, require, and verify-ca.Output
Create connection
Create connection
BETTER_STACK_CREATE_CONNECTIONCreate 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
team_names or team_ids should be provided.team_names or team_ids should be provided.us_east, germany, singapore. Omit to create the connection in all regions.Output
Create dashboard
Create dashboard
BETTER_STACK_CREATE_DASHBOARDCreate 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
Output
Create dashboard alert
Create dashboard alert
BETTER_STACK_CREATE_DASHBOARD_ALERTCreate 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
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.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.threshold for static values, relative for percentage changes, or anomaly_rrcf for ML-based anomaly detection.source_variable, platforms_single_source, platforms_all_sources.threshold and relative alert types. Not used for anomaly_rrcf alerts.aggregation_interval, then check_period.series_names_except. Send an empty array to alert on any series.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_cause, such as {{alert_name}} and {{series_name}}. When empty, the incident is named after the dashboard and the alert.escalation_target is not a policy.{{value}} placeholder.any (both higher and lower), higher, or lower. Only for anomaly_rrcf alerts.treat_as_zero, dont_fire, treat_as_previous, or start_incident. Only for threshold and relative alerts. Default: dont_fire.0 recovers the incident immediately, null means never automatically recover an incident. Default: 60.current_team, for details see Escalation targets.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.0 triggers the alert immediately. Default: 60.series_names.query_period, then check_period.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.1 to 30. Only for anomaly_rrcf alerts. Default: 7.Output
Create dashboard group
Create dashboard group
BETTER_STACK_CREATE_DASHBOARD_GROUPCreate 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
Output
Create dashboard section
Create dashboard section
BETTER_STACK_CREATE_DASHBOARD_SECTIONCreate 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
Output
Create Datadog integration
Create Datadog integration
BETTER_STACK_CREATE_DATADOG_INTEGRATIONCreate 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
alert, alert_and_warn. Defaults to alert.Output
Create Elastic integration
Create Elastic integration
BETTER_STACK_CREATE_ELASTIC_INTEGRATIONCreate 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
Output
Create email integration
Create email integration
BETTER_STACK_CREATE_EMAIL_INTEGRATIONCreate 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
call, sms, email, and push.null to never escalate to the team, or 0 to alert the whole team right away.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.cause_field. Send null to remove it and use the default title.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.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.unused always, any when at least one of started_rules matches, or all when all of them match. Defaults to unused.acknowledged_rule_type checks, as rule objects with the same keys as started_rules.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.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_started_fields.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.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.cause_field. Required when resolved_rule_type isn’t unused.other_started_fields.cause_field. Required when acknowledged_rule_type isn’t unused.Output
Create Escalation Policy
Create Escalation Policy
BETTER_STACK_CREATE_ESCALATION_POLICYCreates 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
Output
Create exploration
Create exploration
BETTER_STACK_CREATE_EXPLORATIONCreate 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
time, start_time, end_time, source) are created automatically if not provided.0 to remove it from a group.Output
Create exploration alert
Create exploration alert
BETTER_STACK_CREATE_EXPLORATION_ALERTCreate 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
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.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.threshold for static values, relative for percentage changes, and anomaly_rrcf for ML-based anomaly detection.source_variable, platforms_single_source, platforms_all_sources.threshold and relative alert types. Not used for anomaly_rrcf alerts.aggregation_interval, then check_period.series_names_except. Send an empty array to alert on any series.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_cause, such as {{alert_name}} and {{series_name}}. When empty, the incident is named after the exploration and the alert.escalation_target is not a policy.{{value}} placeholder.any (both higher and lower), higher, or lower. Only for anomaly_rrcf alerts.treat_as_zero, dont_fire, treat_as_previous, or start_incident. Only for threshold and relative alerts. Default: dont_fire.0 recovers the incident immediately, null means never automatically recover an incident. Default: 60.current_team, for details see Escalation targets.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.0 triggers the alert immediately. Default: 60.series_names.query_period, then check_period.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.1 to 30. Only for anomaly_rrcf alerts. Default: 7.Output
Create exploration group
Create exploration group
BETTER_STACK_CREATE_EXPLORATION_GROUPCreate 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
Output
Create Google Monitoring integration
Create Google Monitoring integration
BETTER_STACK_CREATE_GOOGLE_MONITORING_INTEGRATIONCreate 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
Output
Create Grafana integration
Create Grafana integration
BETTER_STACK_CREATE_GRAFANA_INTEGRATIONCreate 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
Output
Create Heartbeat
Create Heartbeat
BETTER_STACK_CREATE_HEARTBEATTool 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
Output
Create Heartbeat Group
Create Heartbeat Group
BETTER_STACK_CREATE_HEARTBEAT_GROUPTool 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
Output
Create Incident
Create Incident
BETTER_STACK_CREATE_INCIDENTTool 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
Output
Create Incident Comment
Create Incident Comment
Create incoming webhook
Create incoming webhook
BETTER_STACK_CREATE_INCOMING_WEBHOOKCreate 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
call, sms, email, and push.null to never escalate to the team, or 0 to alert the whole team right away.cause_field. Send null to remove it and use the default title.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.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.unused always, any when at least one of started_rules matches, or all when all of them match. Defaults to unused.acknowledged_rule_type checks, as rule objects with the same keys as started_rules.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.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_started_fields.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.cause_field; later requests acknowledge and resolve the incident by matching it. Required when acknowledged_rule_type or resolved_rule_type isn’t unused.cause_field. Required when resolved_rule_type isn’t unused.other_started_fields.cause_field. Required when acknowledged_rule_type isn’t unused.Output
Create Metadata
Create Metadata
BETTER_STACK_CREATE_METADATATool 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
Output
Create metric
Create metric
BETTER_STACK_CREATE_METRICCreate 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
avg, count, uniq, max, min, sum, and histogram.Output
Create Monitor
Create Monitor
BETTER_STACK_CREATE_MONITORTool 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
Output
Create Monitor Group
Create Monitor Group
Create New Relic integration
Create New Relic integration
BETTER_STACK_CREATE_NEW_RELIC_INTEGRATIONCreate 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
alert, alert_and_warn. Defaults to alert.Output
Create on-call event
Create on-call event
BETTER_STACK_CREATE_ON_CALL_EVENTCreate 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
false.default to refer to the default on-call schedule for the team.Output
Create On-Call Schedule
Create On-Call Schedule
Create outgoing email
Create outgoing email
BETTER_STACK_CREATE_OUTGOING_EMAILCreate outgoing e-mail Returns either a newly created outgoing e-mail integration, or validation errors. See the outgoing e-mails guide for the dashboard walkthrough. POST /api/v2/outgoing-emails Requires a Better Stack Incidents API token with access to the resource.
Input Parameters
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" } ] } true. At least one of the on_incident_* triggers must be enabled.true.Output
Create Outgoing Webhook Integration
Create Outgoing Webhook Integration
Create PagerDuty integration
Create PagerDuty integration
BETTER_STACK_CREATE_PAGERDUTY_INTEGRATIONCreate 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
true.Output
Create Escalation Policy Group
Create Escalation Policy Group
Create Prometheus integration
Create Prometheus integration
BETTER_STACK_CREATE_PROMETHEUS_INTEGRATIONCreate 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
Output
Create schedule rotation
Create schedule rotation
BETTER_STACK_CREATE_SCHEDULE_ROTATIONCreate 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
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.default to refer to the default on-call schedule for the team.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.Output
Create source
Create source
BETTER_STACK_CREATE_SOURCECreate a source Returns a newly created source. POST /api/v2/sources Requires a Telemetry API token with access to the resource.
Input Parameters
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.us_east, germany, singapore.prometheus_scrape platform and similar. Set to true to disable verification.{column} brackets. Example: "PID: {message_json.pid} {level} {message}". For details, see Live tail docs.prometheus_scrape platform and similar. Permitted values are 15, 30, 60, 120 or 300.prometheus_scrape platform and similar, with each object containing name and value fields.Output
Create Source Group
Create Source Group
Create Splunk integration
Create Splunk integration
BETTER_STACK_CREATE_SPLUNK_INTEGRATIONCreate 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
true.Output
Create status page
Create status page
BETTER_STACK_CREATE_STATUS_PAGECreate 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
light, dark, system. Defaults to light. This only applies when the design is set to v2.vertical, horizontal. Defaults to vertical. This only applies when the design is set to v2.https:// scheme. We download the image from it, and it must be under 20MB in size.password_enabled is true. Sending a password turns protection on unless you also send password_enabled, and sending an empty password turns it off.Tokyo or Europe/Prague. Accepts IANA time zone IDs and the names in the Rails TimeZone documentationhttps://example.com/support or mailto:support@example.com. Can be null.false.# are comments. This is a billable featurefalse. This is a billable featurestatus.walmine.com. Add a CNAME record pointing it to statuspage.betteruptime.com. Can be null.https:// scheme. We download the image from it, and it must be under 20MB in size.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.G-XXXXXXXX. Must start with G-, UA- or GTM-.0, which shows all incidents. Must be shorter than one year.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
Create Status Page Group
Create Status Page Group
Create Status Page Report
Create Status Page Report
BETTER_STACK_CREATE_STATUS_PAGE_REPORTTool 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
Output
Create Status Page Resource
Create Status Page Resource
BETTER_STACK_CREATE_STATUS_PAGE_RESOURCETool 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
Output
Create Status Page Section
Create Status Page Section
BETTER_STACK_CREATE_STATUS_PAGE_SECTIONTool 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
Output
Create status page subscriber
Create status page subscriber
BETTER_STACK_CREATE_STATUS_PAGE_SUBSCRIBERCreate 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
[] 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
Create Status Update
Create Status Update
BETTER_STACK_CREATE_STATUS_UPDATETool 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
Output
Create Severity Level
Create Severity Level
Create Urgency Group
Create Urgency Group
BETTER_STACK_CREATE_URGENCY_GROUPTool 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
Output
Delete alert
Delete alert
Delete Amazon SNS integration
Delete Amazon SNS integration
BETTER_STACK_DELETE_AMAZON_SNS_INTEGRATIONPermanently 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
Output
Delete AWS CloudWatch integration
Delete AWS CloudWatch integration
BETTER_STACK_DELETE_AWS_CLOUDWATCH_INTEGRATIONRemove 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
Output
Delete aws log group subscription
Delete aws log group subscription
BETTER_STACK_DELETE_AWS_LOG_GROUP_SUBSCRIPTIONDelete 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
Output
Delete Azure integration
Delete Azure integration
Delete catalog attribute
Delete catalog attribute
Delete catalog record
Delete catalog record
Delete catalog relation
Delete catalog relation
Delete chart
Delete chart
Delete chart comment
Delete chart comment
BETTER_STACK_DELETE_CHART_COMMENTPermanently 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
Output
Delete collector
Delete collector
BETTER_STACK_DELETE_COLLECTORRemove 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
Output
Delete collector metric target
Delete collector metric target
BETTER_STACK_DELETE_COLLECTOR_METRIC_TARGETRemove 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
Output
Delete connection
Delete connection
Delete dashboard
Delete dashboard
Delete dashboard alert
Delete dashboard alert
Delete dashboard group
Delete dashboard group
BETTER_STACK_DELETE_DASHBOARD_GROUPRemove 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
Output
Delete dashboard section
Delete dashboard section
Delete Datadog integration
Delete Datadog integration
Delete Elastic integration
Delete Elastic integration
Delete email integration
Delete email integration
Delete Escalation Policy
Delete Escalation Policy
Delete exploration
Delete exploration
BETTER_STACK_DELETE_EXPLORATIONRemove 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
Output
Delete exploration alert
Delete exploration alert
Delete exploration group
Delete exploration group
BETTER_STACK_DELETE_EXPLORATION_GROUPRemove 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
Output
Delete Google Monitoring integration
Delete Google Monitoring integration
BETTER_STACK_DELETE_GOOGLE_MONITORING_INTEGRATIONRemove 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
Output
Delete Grafana integration
Delete Grafana integration
Delete Heartbeat
Delete Heartbeat
Delete Heartbeat Group
Delete Heartbeat Group
Delete Incident
Delete Incident
Delete Incident Comment
Delete Incident Comment
BETTER_STACK_DELETE_INCIDENT_COMMENTTool 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
Output
Delete incoming webhook
Delete incoming webhook
Delete metric
Delete metric
Delete Monitor
Delete Monitor
Delete Monitor Group
Delete Monitor Group
BETTER_STACK_DELETE_MONITOR_GROUPTool 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
Output
Delete New Relic integration
Delete New Relic integration
Delete on-call event
Delete on-call event
BETTER_STACK_DELETE_ON_CALL_EVENTRemove 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
default to refer to the default on-call schedule for the team.Output
Delete On-Call Schedule
Delete On-Call Schedule
Delete outgoing email
Delete outgoing email
BETTER_STACK_DELETE_OUTGOING_EMAILRemove 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
Output
Delete Outgoing Webhook Integration
Delete Outgoing Webhook Integration
BETTER_STACK_DELETE_OUTGOING_WEBHOOKTool to delete an outgoing webhook integration by ID. Use when you need to permanently remove an existing webhook integration.Input Parameters
Output
Delete PagerDuty integration
Delete PagerDuty integration
Delete Escalation Policy Group
Delete Escalation Policy Group
Delete Prometheus integration
Delete Prometheus integration
Delete schedule rotation
Delete schedule rotation
BETTER_STACK_DELETE_SCHEDULE_ROTATIONRemove 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
default to refer to the default on-call schedule for the team.Output
Delete source
Delete source
Delete Source Group
Delete Source Group
BETTER_STACK_DELETE_SOURCE_GROUPTool 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
Output
Delete Splunk integration
Delete Splunk integration
Delete status page
Delete status page
Delete Status Page Group
Delete Status Page Group
Delete Status Page Report
Delete Status Page Report
BETTER_STACK_DELETE_STATUS_PAGE_REPORTTool 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
Output
Delete Status Page Resource
Delete Status Page Resource
Delete Status Page Section
Delete Status Page Section
BETTER_STACK_DELETE_STATUS_PAGE_SECTIONTool 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
Output
Delete Status Update
Delete Status Update
BETTER_STACK_DELETE_STATUS_PAGE_STATUS_REPORT_STATUS_UPDATETool 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
Output
Delete status page subscriber
Delete status page subscriber
Delete status page subscriber by email
Delete status page subscriber by email
Delete team member by email
Delete team member by email
BETTER_STACK_DELETE_TEAM_MEMBER_BY_EMAILRemove 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
Output
Delete team member by ID
Delete team member by ID
BETTER_STACK_DELETE_TEAM_MEMBER_BY_IDRemove 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
Output
Delete Severity
Delete Severity
Delete Urgency Group
Delete Urgency Group
BETTER_STACK_DELETE_URGENCY_GROUPTool 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
Output
Escalate Incident
Escalate Incident
BETTER_STACK_ESCALATE_INCIDENTTool 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
Output
Export dashboard
Export dashboard
BETTER_STACK_EXPORT_DASHBOARDExport 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. This endpoint can be used to export both your own dashboards and dashboard templates. GET /api/v2/dashboards/{id}/export Requires a Telemetry API token with access to the resource.
Input Parameters
Output
Get alert
Get alert
Get Amazon SNS integration
Get Amazon SNS integration
Get AWS CloudWatch integration
Get AWS CloudWatch integration
Get aws log group subscription
Get aws log group subscription
Get Azure integration
Get Azure integration
Get catalog attribute
Get catalog attribute
Get catalog record
Get catalog record
Get catalog relation
Get catalog relation
Get chart
Get chart
Get chart comment
Get chart comment
Get collector
Get collector
Get collector metric target
Get collector metric target
Get connection
Get connection
Get dashboard
Get dashboard
Get dashboard alert
Get dashboard alert
Get dashboard group
Get dashboard group
Get dashboard section
Get dashboard section
Get Datadog integration
Get Datadog integration
Get Elastic integration
Get Elastic integration
Get email integration
Get email integration
Get Escalation Policy
Get Escalation Policy
Get exploration
Get exploration
Get exploration alert
Get exploration alert
Get exploration group
Get exploration group
Get Google Monitoring integration
Get Google Monitoring integration
BETTER_STACK_GET_GOOGLE_MONITORING_INTEGRATIONGet 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
Output
Get Grafana integration
Get Grafana integration
Get Heartbeat
Get Heartbeat
Get Heartbeat Availability
Get Heartbeat Availability
Get Heartbeat Group
Get Heartbeat Group
Get Incident Comment
Get Incident Comment
Get incoming webhook
Get incoming webhook
Get Jira integration
Get Jira integration
Get Monitor
Get Monitor
Get Monitor Availability
Get Monitor Availability
Get Monitor Group
Get Monitor Group
Get Monitor Group's Monitors
Get Monitor Group's Monitors
Get Monitor Response Times
Get Monitor Response Times
BETTER_STACK_GET_MONITOR_RESPONSE_TIMESRetrieves 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
Output
Get New Relic integration
Get New Relic integration
Get on-call event
Get on-call event
BETTER_STACK_GET_ON_CALL_EVENTGet 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
default to refer to the default on-call schedule for the team.Output
Get On-Call Schedule
Get On-Call Schedule
BETTER_STACK_GET_ON_CALL_SCHEDULETool 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
Output
Get outgoing email
Get outgoing email
Get Outgoing Webhook Integration
Get Outgoing Webhook Integration
BETTER_STACK_GET_OUTGOING_WEBHOOKTool to get a single outgoing webhook integration by ID. Use when you need to retrieve details of a specific webhook integration.Input Parameters
Output
Get PagerDuty integration
Get PagerDuty integration
Get Escalation Policy Group
Get Escalation Policy Group
Get product usage
Get product usage
BETTER_STACK_GET_PRODUCT_USAGERetrieve 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
YYYY-MM-DD format, inclusive. Defaults to today. Future dates are clamped to today.YYYY-MM-DD format, inclusive. Defaults to 29 days before to. The range between from and to can span at most 400 days.id from the usage overview, for example logs, traces, metrics, or monitors.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.day, week, month, or quarter. Defaults to day.Output
Get Prometheus integration
Get Prometheus integration
Get schedule rotation
Get schedule rotation
BETTER_STACK_GET_SCHEDULE_ROTATIONGet 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
default to refer to the default on-call schedule for the team.Output
Get Slack integration
Get Slack integration
Get source
Get source
Get source group
Get source group
Get Splunk integration
Get Splunk integration
Get Status Page
Get Status Page
Get Status Page Group
Get Status Page Group
Get Status Page Report
Get Status Page Report
Get Status Page Resource
Get Status Page Resource
Get Status Page Section
Get Status Page Section
Get status page subscriber
Get status page subscriber
Get Status Update
Get Status Update
BETTER_STACK_GET_STATUS_UPDATETool 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
Output
Get team member
Get team member
BETTER_STACK_GET_TEAM_MEMBERGet 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. 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
Output
Get Uptime API Token
Get Uptime API Token
Get Severity Level
Get Severity Level
Get Urgency Group
Get Urgency Group
Get usage overview
Get usage overview
BETTER_STACK_GET_USAGE_OVERVIEWGet 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
YYYY-MM-DD format, inclusive. Defaults to today. Future dates are clamped to today.YYYY-MM-DD format, inclusive. Defaults to 29 days before to. The range between from and to can span at most 400 days.Output
Import dashboard
Import dashboard
BETTER_STACK_IMPORT_DASHBOARDCreate 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
name key for the new dashboard. At least one of the top-level name parameter or data.name must be set.name field within the data parameter will be used. At least one of these name fields must be set.Output
Invite team member
Invite team member
BETTER_STACK_INVITE_TEAM_MEMBERInvite 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 or role_id. If both are given they must reference the same role.Output
List alerts
List alerts
List Amazon SNS integrations
List Amazon SNS integrations
BETTER_STACK_LIST_AMAZON_SNS_INTEGRATIONSList 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
Output
List AWS CloudWatch Integrations
List AWS CloudWatch Integrations
List AWS log group subscriptions
List AWS log group subscriptions
BETTER_STACK_LIST_AWS_LOG_GROUP_SUBSCRIPTIONSList 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
Output
List Azure Integrations
List Azure Integrations
List catalog attributes
List catalog attributes
BETTER_STACK_LIST_CATALOG_ATTRIBUTESList catalog attributes Returns a list of all Catalog attributes for a Catalog relation. GET /api/v2/catalog/relations/{relation_id}/attributes Requires a Better Stack Incidents API token with access to the resource.
Input Parameters
Output
List catalog records
List catalog records
List Catalog Relations
List Catalog Relations
List chart comments
List chart comments
List charts
List charts
List collector hosts
List collector hosts
List collector metrics targets
List collector metrics targets
List collectors
List collectors
BETTER_STACK_LIST_COLLECTORSList 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
Output
List connections
List connections
BETTER_STACK_LIST_CONNECTIONSList 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
Output
List dashboard alerts
List dashboard alerts
BETTER_STACK_LIST_DASHBOARD_ALERTSList 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
Output
List dashboard groups
List dashboard groups
List dashboards
List dashboards
BETTER_STACK_LIST_DASHBOARDSList 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
Output
List dashboard sections
List dashboard sections
BETTER_STACK_LIST_DASHBOARD_SECTIONSList 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
Output
List dashboards in group
List dashboards in group
BETTER_STACK_LIST_DASHBOARDS_IN_GROUPList 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
Output
List dashboard templates
List dashboard templates
BETTER_STACK_LIST_DASHBOARD_TEMPLATESList 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 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
List Datadog Integrations
List Datadog Integrations
List Elastic Integrations
List Elastic Integrations
List Email Integrations
List Email Integrations
BETTER_STACK_LIST_EMAIL_INTEGRATIONSTool 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
Output
List exploration alerts
List exploration alerts
List exploration groups
List exploration groups
List explorations
List explorations
BETTER_STACK_LIST_EXPLORATIONSList 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
Output
List explorations in group
List explorations in group
BETTER_STACK_LIST_EXPLORATIONS_IN_GROUPList 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
Output
List Google Monitoring Integrations
List Google Monitoring Integrations
BETTER_STACK_LIST_GOOGLE_MONITORING_INTEGRATIONSTool to list all Google Monitoring integrations. Use when you need to view your configured Google Monitoring on-call integrations with pagination support.Input Parameters
Output
List Grafana Integrations
List Grafana Integrations
List Heartbeat Groups
List Heartbeat Groups
List Heartbeats
List Heartbeats
List Incidents Comments
List Incidents Comments
List Incidents Timeline
List Incidents Timeline
List Incidents Uptime
List Incidents Uptime
List incoming webhooks
List incoming webhooks
BETTER_STACK_LIST_INCOMING_WEBHOOKSList 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
Output
List Jira Integrations
List Jira Integrations
List Metadata
List Metadata
BETTER_STACK_LIST_METADATAList metadata records with optional filtering by team, owner resource ID, or owner resource type, and pagination.Input Parameters
Output
List metrics
List metrics
List monitored databases
List monitored databases
BETTER_STACK_LIST_MONITORED_DATABASESLists 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
Output
List Monitor Groups
List Monitor Groups
List Monitors
List Monitors
List New Relic Integrations
List New Relic Integrations
BETTER_STACK_LIST_NEW_RELIC_INTEGRATIONSTool to list New Relic integrations. Use when you need to retrieve and inspect all configured New Relic integrations with pagination support.Input Parameters
Output
List On-Call Schedule Events
List On-Call Schedule Events
List On-Call Schedules
List On-Call Schedules
List outgoing emails
List outgoing emails
BETTER_STACK_LIST_OUTGOING_EMAILSList 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
Output
List Outgoing Webhook Integrations
List Outgoing Webhook Integrations
List PagerDuty Webhooks
List PagerDuty Webhooks
List Escalation Policies
List Escalation Policies
List Escalation Policy Groups
List Escalation Policy Groups
List Prometheus Integrations
List Prometheus Integrations
List roles
List roles
BETTER_STACK_LIST_ROLESList 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
List Single Incident
List Single Incident
List Slack Integrations
List Slack Integrations
List source groups
List source groups
List sources
List sources
List sources in group
List sources in group
List Splunk On-Call Integrations
List Splunk On-Call Integrations
List Status Page Groups
List Status Page Groups
List Status Pages In Status Page Group
List Status Pages In Status Page Group
List Status Page Reports
List Status Page Reports
BETTER_STACK_LIST_STATUS_PAGE_REPORTSTool 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
Output
List Status Page Report Status Updates
List Status Page Report Status Updates
BETTER_STACK_LIST_STATUS_PAGE_REPORT_STATUS_UPDATESTool 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
Output
List Status Pages
List Status Pages
List Status Page Sections
List Status Page Sections
List Status Page Resources
List Status Page Resources
List status page subscribers
List status page subscribers
BETTER_STACK_LIST_STATUS_PAGE_SUBSCRIBERSList 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
Output
List team members
List team members
BETTER_STACK_LIST_TEAM_MEMBERSList 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
Output
List Severity Levels
List Severity Levels
List Urgency Groups
List Urgency Groups
Reopen incident
Reopen incident
BETTER_STACK_REOPEN_INCIDENTReopen 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
Output
Resolve Incident
Resolve Incident
Update alert
Update alert
BETTER_STACK_UPDATE_ALERTUpdate 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
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.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.threshold for static values, relative for percentage changes, or anomaly_rrcf for ML-based anomaly detection. Cannot be changed after creation.source_variable, platforms_single_source, platforms_all_sources.threshold and relative alert types. Not used for anomaly_rrcf alerts.aggregation_interval, then check_period.series_names_except. Send an empty array to alert on any series.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_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.escalation_target is not a policy.{{value}} placeholder.any (both higher and lower), higher, or lower. Only for anomaly_rrcf alerts.treat_as_zero, dont_fire, treat_as_previous, or start_incident. Only for threshold and relative alerts. Default: dont_fire.0 recovers the incident immediately, null means never automatically recover an incident.current_team, for details see Escalation targets.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.0 triggers the alert immediately.series_names.query_period, then check_period.1 to 30. Only for anomaly_rrcf alerts. Default: 7.Output
Update Amazon SNS integration
Update Amazon SNS integration
BETTER_STACK_UPDATE_AMAZON_SNS_INTEGRATIONUpdate 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
null to remove it. Without one, incidents alert the current on-call person through the channels set by call, sms, email, and push.null to never escalate to the team, or 0 to alert the whole team right away.cause_field. Send null to remove it and use the default title.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.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.unused always, any when at least one of started_rules matches, or all when all of them match.acknowledged_rule_type checks, as rule objects with the same keys as started_rules.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.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_started_fields.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.cause_field; later notifications acknowledge and resolve the incident by matching it. Required when acknowledged_rule_type or resolved_rule_type isn’t unused.cause_field. Required when resolved_rule_type isn’t unused.other_started_fields.cause_field. Required when acknowledged_rule_type isn’t unused.Output
Update AWS CloudWatch integration
Update AWS CloudWatch integration
BETTER_STACK_UPDATE_AWS_CLOUDWATCH_INTEGRATIONUpdate 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
Output
Update AWS log group subscription
Update AWS log group subscription
BETTER_STACK_UPDATE_AWS_LOG_GROUP_SUBSCRIPTIONSubscribe 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
Output
Update Azure integration
Update Azure integration
BETTER_STACK_UPDATE_AZURE_INTEGRATIONUpdate 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
Output
Update catalog attribute
Update catalog attribute
BETTER_STACK_UPDATE_CATALOG_ATTRIBUTEUpdate 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
Output
Update catalog record
Update catalog record
BETTER_STACK_UPDATE_CATALOG_RECORDUpdate 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
Output
Update catalog relation
Update catalog relation
BETTER_STACK_UPDATE_CATALOG_RELATIONUpdate 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
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.Output
Update chart
Update chart
BETTER_STACK_UPDATE_CHARTUpdate 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
Output
Update chart comment
Update chart comment
BETTER_STACK_UPDATE_CHART_COMMENTUpdate 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
2026-08-17T13:00:00Z.Output
Update collector
Update collector
BETTER_STACK_UPDATE_COLLECTORUpdate 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 and set _destroy: true.components. For a full list of options, see the configuration object section in the Create collector API documentation. 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.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.0 or null to remove the assignment.{column} brackets. Example: "PID: {message_json.pid} {level} {message}". Send null to clear. For details, see Live tail docs.null to remove.Output
Update collector metric target
Update collector metric target
BETTER_STACK_UPDATE_COLLECTOR_METRIC_TARGETUpdate 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
false, true, skip-verify, and preferred. Only for mysql.http and https. Only for elasticsearch.elasticsearch.disable, require, and verify-ca. Only for postgres.Output
Update dashboard
Update dashboard
BETTER_STACK_UPDATE_DASHBOARDUpdate 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
Output
Update dashboard alert
Update dashboard alert
BETTER_STACK_UPDATE_DASHBOARD_ALERTUpdate 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
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.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.threshold for static values, relative for percentage changes, or anomaly_rrcf for ML-based anomaly detection. Cannot be changed after creation.source_variable, platforms_single_source, platforms_all_sources.threshold and relative alert types. Not used for anomaly_rrcf alerts.aggregation_interval, then check_period.series_names_except. Send an empty array to alert on any series.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_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.escalation_target is not a policy.{{value}} placeholder.any (both higher and lower), higher, or lower. Only for anomaly_rrcf alerts.treat_as_zero, dont_fire, treat_as_previous, or start_incident. Only for threshold and relative alerts. Default: dont_fire.0 recovers the incident immediately, null means never automatically recover an incident.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.0 triggers the alert immediately.series_names.query_period, then check_period.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 on the create page for an example.1 to 30. Only for anomaly_rrcf alerts. Default: 7.Output
Update dashboard group
Update dashboard group
Update dashboard section
Update dashboard section
BETTER_STACK_UPDATE_DASHBOARD_SECTIONUpdate 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
Output
Update Datadog integration
Update Datadog integration
BETTER_STACK_UPDATE_DATADOG_INTEGRATIONUpdate 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
alert, alert_and_warn. Defaults to alert.Output
Update Elastic integration
Update Elastic integration
BETTER_STACK_UPDATE_ELASTIC_INTEGRATIONUpdate 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
Output
Update email integration
Update email integration
BETTER_STACK_UPDATE_EMAIL_INTEGRATIONUpdate 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
null to remove it. Without one, incidents alert the current on-call person through the channels set by call, sms, email, and push.null to never escalate to the team, or 0 to alert the whole team right away.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.cause_field. Send null to remove it and use the default title.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.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.unused always, any when at least one of started_rules matches, or all when all of them match.acknowledged_rule_type checks, as rule objects with the same keys as started_rules.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.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_started_fields.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.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.cause_field. Required when resolved_rule_type isn’t unused.other_started_fields.cause_field. Required when acknowledged_rule_type isn’t unused.Output
Update Escalation Policy
Update Escalation Policy
Update exploration
Update exploration
BETTER_STACK_UPDATE_EXPLORATIONUpdate 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
Output
Update exploration alert
Update exploration alert
BETTER_STACK_UPDATE_EXPLORATION_ALERTUpdate 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
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.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.threshold for static values, relative for percentage changes, or anomaly_rrcf for ML-based anomaly detection. Cannot be changed after creation.source_variable, platforms_single_source, platforms_all_sources.threshold and relative alert types. Not used for anomaly_rrcf alerts.aggregation_interval, then check_period.series_names_except. Send an empty array to alert on any series.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_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.escalation_target is not a policy.{{value}} placeholder.any (both higher and lower), higher, or lower. Only for anomaly_rrcf alerts.treat_as_zero, dont_fire, treat_as_previous, or start_incident. Only for threshold and relative alerts. Default: dont_fire.0 recovers the incident immediately, null means never automatically recover an incident.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.0 triggers the alert immediately.series_names.query_period, then check_period.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 on the create page for an example.1 to 30. Only for anomaly_rrcf alerts. Default: 7.Output
Update exploration group
Update exploration group
Update Google Monitoring integration
Update Google Monitoring integration
BETTER_STACK_UPDATE_GOOGLE_MONITORING_INTEGRATIONUpdate 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
Output
Update Grafana integration
Update Grafana integration
BETTER_STACK_UPDATE_GRAFANA_INTEGRATIONUpdate 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
Output
Update Heartbeat
Update Heartbeat
Update Heartbeat Group
Update Heartbeat Group
BETTER_STACK_UPDATE_HEARTBEAT_GROUPUpdates 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
Output
Update Incident Comment
Update Incident Comment
Update incoming webhook
Update incoming webhook
BETTER_STACK_UPDATE_INCOMING_WEBHOOKUpdate 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
null to remove it. Without one, incidents alert the current on-call person through the channels set by call, sms, email, and push.null to never escalate to the team, or 0 to alert the whole team right away.cause_field. Send null to remove it and use the default title.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.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.unused always, any when at least one of started_rules matches, or all when all of them match.acknowledged_rule_type checks, as rule objects with the same keys as started_rules.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.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_started_fields.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.cause_field; later requests acknowledge and resolve the incident by matching it. Required when acknowledged_rule_type or resolved_rule_type isn’t unused.cause_field. Required when resolved_rule_type isn’t unused.other_started_fields.cause_field. Required when acknowledged_rule_type isn’t unused.Output
Update Jira integration
Update Jira integration
BETTER_STACK_UPDATE_JIRA_INTEGRATIONUpdate 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
Output
Update metric
Update metric
BETTER_STACK_UPDATE_METRICUpdate 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
new_data (default) applies the change going forward. historical_logs reprocesses retained logs.[] to change into a label. Valid aggregations are
avg, count, uniq, max, min, sum, and histogramOutput
Update Monitor
Update Monitor
BETTER_STACK_UPDATE_MONITORTool 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
Output
Update Monitor Group
Update Monitor Group
BETTER_STACK_UPDATE_MONITOR_GROUPUpdates 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
Output
Update New Relic integration
Update New Relic integration
BETTER_STACK_UPDATE_NEW_RELIC_INTEGRATIONUpdate 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
alert, alert_and_warn. Defaults to alert.Output
Update on-call event
Update on-call event
BETTER_STACK_UPDATE_ON_CALL_EVENTUpdate 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
default to refer to the default on-call schedule for the team.Output
Update On-Call Schedule
Update On-Call Schedule
Update outgoing email
Update outgoing email
BETTER_STACK_UPDATE_OUTGOING_EMAILUpdate 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
email key plus your own custom attribute keys. Replaces the whole recipient list when sent. See Create outgoing e-mail for the full shape.on_incident_* triggers must stay enabled.Output
Update Outgoing Webhook Integration
Update Outgoing Webhook Integration
Update PagerDuty integration
Update PagerDuty integration
BETTER_STACK_UPDATE_PAGERDUTY_INTEGRATIONUpdate 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
info, warning, error, critical.true.Output
Update Escalation Policy Group
Update Escalation Policy Group
Update Prometheus integration
Update Prometheus integration
BETTER_STACK_UPDATE_PROMETHEUS_INTEGRATIONUpdate 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
Output
Update slack integration
Update slack integration
BETTER_STACK_UPDATE_SLACK_INTEGRATIONUpdate an existing Slack integration’s explicitly provided settings. Lists replace the whole list. Connect Slack in the Better Stack dashboard first.Input Parameters
{"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.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.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.null to show the channel’s own name.integration_type is thread or channel.false to allow only the ones in alert_options.type and an id; an empty list posts updates for every resource of the integration’s team. Needs post_status_page_updates turned on.Output
Update source
Update source
BETTER_STACK_UPDATE_SOURCEUpdate 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
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.prometheus_scrape platform and similar. Set to true to disable verification.{column} brackets. Example: "PID: {message_json.pid} {level} {message}". For details, see Live tail docs.prometheus_scrape platform and similar. Permitted values are 15, 30, 60, 120 or 300.prometheus_scrape platform and similar, with each object containing name and value fields.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.null to reset it to the platform default. Read more about VRL transformations.Output
Update Source Group
Update Source Group
Update Splunk integration
Update Splunk integration
BETTER_STACK_UPDATE_SPLUNK_INTEGRATIONUpdate 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
true.Output
Update Status Page Group
Update Status Page Group
Update Status Page Report
Update Status Page Report
BETTER_STACK_UPDATE_STATUS_PAGE_REPORTTool 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
Output
Update Status Page Resource
Update Status Page Resource
BETTER_STACK_UPDATE_STATUS_PAGE_RESOURCETool 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
Output
Update Status Pages
Update Status Pages
Update Status Page Section
Update Status Page Section
Update Status Update
Update Status Update
BETTER_STACK_UPDATE_STATUS_PAGE_STATUS_REPORT_STATUS_UPDATETool 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
Output
Update status page subscriber
Update status page subscriber
BETTER_STACK_UPDATE_STATUS_PAGE_SUBSCRIBERUpdate 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
[] 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
Update team member role
Update team member role
BETTER_STACK_UPDATE_TEAM_MEMBER_ROLEChange 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
role as custom for a custom role.Output
Update Severity Level
Update Severity Level
Update Urgency Group
Update Urgency Group
BETTER_STACK_UPDATE_URGENCY_GROUPTool to update an existing urgency group (severity group). Use when you need to modify the name or sort order of a severity group.