Better Stack integration: operations for AI agents
Better Stack connects to Type.com as an integration. This page lists the 312 operations documented for Claude and Codex in Type.com: 131 read, 81 write, 100 destructive.
About Better Stack
Better Stack provides monitoring, logging, and incident management solutions to help teams ensure the reliability and performance of their applications.
Categories: Developer Tools & IT
How to connect Better Stack to Type.com
- Access
- Organization connection: one shared account for the workspace.
To add the connection, follow the steps in Space connections.
Documented operations
312 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.
312 operations listed.
Incidents API
- Read
List monitors
Returns list of all your monitors.
GET /api/v2/monitors - Read
Monitor availability
Returns availability summary for a specific monitor.
GET /api/v2/monitors/{monitor_id}/sla - Read
Get monitor
Returns a single monitor.
GET /api/v2/monitors/{monitor_id} - Read
Monitor response times
Returns the response times for a monitor (last 24h).
GET /api/v2/monitors/{monitor_id}/response-times - Read
List heartbeats
Returns a list of all your heartbeats.
GET /api/v2/heartbeats - Read
List monitor groups
Returns a list of all your monitor groups.
GET /api/v2/monitor-groups - Read
List on-call schedules
List all on-call schedules.
GET /api/v2/on-calls - Read
List status pages
Returns a list of all your status pages.
GET /api/v2/status-pages - Read
List New Relic integrations
Returns a list of all your New Relic integrations.
GET /api/v2/new-relic-integrations - Read
List metadata
List metadata for given incident, monitor, or other resources.
GET /api/v3/metadata - Read
Get a heartbeat's availability summary
Returns availability summary for a specific heartbeat.
GET /api/v2/heartbeats/{heartbeat_id}/availability - Read
Get a single heartbeat
Returns a single heartbeat by ID.
GET /api/v2/heartbeats/{heartbeat_id} - Read
Get on-call schedule
Returns a single on-call schedule by ID.
GET /api/v2/on-calls/{schedule_id} - Read
Get status page
Returns a single status page by ID.
GET /api/v2/status-pages/{status_page_id} - Read
List monitors in group
Returns monitors belonging to the given monitor group.
GET /api/v2/monitor-groups/{monitor_group_id}/monitors - Read
Get an on-call schedule rotation
Returns the currently used on-call rotation for a single on-call schedule.
GET /api/v2/on-calls/{schedule_id}/rotation - Read
Get monitor group
Returns a single monitor group by ID.
GET /api/v2/monitor-groups/{monitor_group_id} - Read
List Amazon SNS integrations
Returns a list of all your Amazon SNS integrations.
GET /api/v2/amazon-sns - Read
List AWS CloudWatch integrations
Returns a list of all your AWS CloudWatch integrations.
GET /api/v2/aws-cloudwatch-integrations - Read
List Azure integrations
Returns a list of all your Azure integrations.
GET /api/v2/azure-integrations - Read
List catalog relations
Returns a list of all your Catalog relations.
GET /api/v2/catalog/relations - Read
List comments
List all comments under an incident. This endpoint does not support pagination and returns all comments instead.
GET /api/v2/incidents/{incident_id}/comments - Read
List Datadog integrations
Returns a list of all your Datadog integrations.
GET /api/v2/datadog-integrations - Read
List Elastic integrations
Returns a list of all your Elastic integrations.
GET /api/v2/elastic-integrations - Read
List e-mail integrations
Returns a list of all your e-mail integrations.
GET /api/v2/email-integrations - Read
List escalation policies
Returns a list of existing escalation policies.
GET /api/v3/policies - Read
List escalation policy groups
Returns a list of all your escalation policy groups.
GET /api/v2/policy-groups - Read
List heartbeat groups
Returns a list of all your heartbeat groups.
GET /api/v2/heartbeat-groups - Read
List severity groups
Returns a list of all your severity groups.
GET /api/v2/urgency-groups - Read
List status updates per report
Returns a list of status updates for your status page report.
GET /api/v2/status-pages/{status_page_id}/status-reports/{status_report_id}/status-updates - Read
List Google Monitoring integrations
Returns a list of all your Google Monitoring integrations.
GET /api/v2/google-monitoring-integrations - Read
List Grafana integrations
Returns a list of all your Grafana integrations.
GET /api/v2/grafana-integrations - Read
List incidents
List all incidents with the option to filter incidents by monitor.
GET /api/v3/incidents - Read
List incoming webhooks
Returns a list of all your incoming webhooks.
GET /api/v2/incoming-webhooks - Read
List Jira integrations
Returns a list of all your Jira integrations.
GET /api/v2/jira-integrations - Read
List outgoing e-mails
Returns a list of all your outgoing e-mail integrations.
GET /api/v2/outgoing-emails - Read
List outgoing webhooks
Returns a list of all your Outgoing Webhook integrations.
GET /api/v2/outgoing-webhooks - Read
List PagerDuty integrations
Returns a list of all your PagerDuty integrations.
GET /api/v2/pager-duty-webhooks - Read
List Prometheus integrations
Returns a list of all your Prometheus integrations.
GET /api/v2/prometheus-integrations - Read
List severities
Returns a list of existing severities.
GET /api/v2/urgencies - Read
List Slack integrations
Returns a list of all your Slack integrations.
GET /api/v2/slack-integrations - Read
List Splunk integrations
Returns a list of all your Splunk On-Call integrations.
GET /api/v2/splunk-on-calls - Read
List status page groups
Returns a list of all your status page groups.
GET /api/v2/status-page-groups - Read
List status page reports
Returns a list of existing reports on your status page.
GET /api/v2/status-pages/{status_page_id}/status-reports - Read
List status page resources
Returns a list of the existing resources of your status page.
GET /api/v2/status-pages/{status_page_id}/resources - Read
List status page sections
Returns a list of the sections of your status page.
GET /api/v2/status-pages/{status_page_id}/sections - Read
List status page subscribers
Returns a list of the existing e-mail subscribers of your status page.
GET /api/v2/status-pages/{status_page_id}/subscribers - Read
List on-call schedule events
List events of a single on-call schedule. This endpoint does not support pagination and returns all events instead.
GET /api/v2/on-calls/{schedule_id}/events - Read
List status pages in a group
Returns status pages belonging to the given status page group.
GET /api/v2/status-page-groups/{status_page_group_id}/status-pages - Read
Get New Relic integration
Returns a single New Relic integration by ID.
GET /api/v2/new-relic-integrations/{new_relic_integration_id} - Read
Get escalation policy
Returns a single escalation policy by ID.
GET /api/v3/policies/{policy_id} - Read
Get heartbeat group
Returns an existing heartbeat group by ID.
GET /api/v2/heartbeat-groups/{heartbeat_group_id} - Read
Get severity
Returns a single severity by ID.
GET /api/v2/urgencies/{urgency_id} - Read
Get status page report
Returns a single status page report.
GET /api/v2/status-pages/{status_page_id}/status-reports/{status_report_id} - Read
Get status page resource
Returns a single status page resource.
GET /api/v2/status-pages/{status_page_id}/resources/{resource_id} - Read
Get status page subscriber
Returns a single e-mail subscriber of your status page.
GET /api/v2/status-pages/{status_page_id}/subscribers/{subscriber_id} - Read
Get status update
Returns a single status page report update.
GET /api/v2/status-pages/{status_page_id}/status-reports/{status_report_id}/status-updates/{status_update_id} - Read
Get escalation policy group
Returns a single escalation policy group by ID.
GET /api/v2/policy-groups/{policy_group_id} - Read
Get a single on-call schedule event
Get a single event from an on-call schedule.
GET /api/v2/on-calls/{schedule_id}/events/{event_id} - Read
Get severity group
Returns a single severity group by ID.
GET /api/v2/urgency-groups/{urgency_group_id} - Read
Get status page group
Returns a single status page group by ID.
GET /api/v2/status-page-groups/{status_page_group_id} - Read
Get status page section
Returns a single status page section.
GET /api/v2/status-pages/{status_page_id}/sections/{section_id} - Read
Get comment
This will return an existing comment.
GET /api/v2/incidents/{incident_id}/comments/{comment_id} - Read
Get incident
Returns a single incident by ID.
GET /api/v3/incidents/{incident_id} - Read
List catalog attributes
Returns a list of all Catalog attributes for a Catalog relation.
GET /api/v2/catalog/relations/{relation_id}/attributes - Read
List catalog records
Returns a list of all your Catalog records for a Catalog relation.
GET /api/v2/catalog/relations/{relation_id}/records - Read
List incident timeline
Returns a list of timeline items for the given incident. This endpoint does not support pagination and returns all timeline items instead.
GET /api/v3/incidents/{incident_id}/timeline - Read
Get Amazon SNS integration
Returns a single Amazon SNS integration by ID.
GET /api/v2/amazon-sns/{amazon_sns_integration_id} - Read
Get AWS CloudWatch integration
Returns a single AWS CloudWatch integration by ID.
GET /api/v2/aws-cloudwatch-integrations/{aws_cloudwatch_integration_id} - Read
Get Azure integration
Returns a single Azure integration by ID.
GET /api/v2/azure-integrations/{azure_integration_id} - Read
Get a single Catalog record
Returns a single Catalog record by ID.
GET /api/v2/catalog/relations/{relation_id}/records/{record_id} - Read
Get catalog relation
Returns a single Catalog relation by ID.
GET /api/v2/catalog/relations/{relation_id} - Read
Get Datadog integration
Returns a single Datadog integration by ID.
GET /api/v2/datadog-integrations/{datadog_integration_id} - Read
Get Elastic integration
Returns a single Elastic integration by ID.
GET /api/v2/elastic-integrations/{elastic_integration_id} - Read
Get e-mail integration
Returns a single e-mail integration by ID.
GET /api/v2/email-integrations/{email_integration_id} - Read
Get Google Monitoring integration
Returns a single Google Monitoring integration by ID.
GET /api/v2/google-monitoring-integrations/{google_monitoring_integration_id} - Read
Get Grafana integration
Returns a single Grafana integration by ID.
GET /api/v2/grafana-integrations/{grafana_integration_id} - Read
Get incoming webhook
Returns a single incoming webhook by ID.
GET /api/v2/incoming-webhooks/{incoming_webhook_id} - Read
Get Jira integration
Returns a single Jira integration by ID.
GET /api/v2/jira-integrations/{jira_integration_id} - Read
Get outgoing e-mail
Returns a single outgoing e-mail integration by ID.
GET /api/v2/outgoing-emails/{integration_id} - Read
Get outgoing webhook
Returns a single Outgoing Webhook integration by ID.
GET /api/v2/outgoing-webhooks/{outgoing_webhook_id} - Read
Get PagerDuty integration
Returns a single PagerDuty integration by ID.
GET /api/v2/pager-duty-webhooks/{pager_duty_webhook_id} - Read
Get Prometheus integration
Returns a single Prometheus integration by ID.
GET /api/v2/prometheus-integrations/{prometheus_integration_id} - Read
Get Slack integration
Returns a single Slack integration by ID.
GET /api/v2/slack-integrations/{slack_integration_id} - Read
Get Splunk integration
Returns a single Splunk On-Call integration by ID.
GET /api/v2/splunk-on-calls/{splunk_on_call_id} - Read
Get catalog attribute
Returns a single Catalog attribute by ID.
GET /api/v2/catalog/relations/{relation_id}/attributes/{attribute_id} - Write
Create monitor
Returns a newly created monitor or validation errors.
POST /api/v2/monitors - Write
Create a heartbeat
Returns either a newly created heartbeat, or validation errors.
POST /api/v2/heartbeats - Write
Create status page
Returns a newly created status page or validation errors.
POST /api/v2/status-pages - Write
Create New Relic integration
Returns either a newly created New Relic integration, or validation errors.
POST /api/v2/new-relic-integrations - Write
Create an on-call schedule
Create a new on-call schedule. Returns either the new schedule, or validation errors.
POST /api/v2/on-calls - Write
Update status page
Update an existing status page. Send only the parameters you wish to change (e.g. company_url)
PATCH /api/v2/status-pages/{status_page_id} - Write
Update an on-call schedule
Update an existing on-call schedule.
PATCH /api/v2/on-calls/{schedule_id} - Write
Acknowledge incident
This will acknowledge an ongoing incident, preventing further escalations.
POST /api/v3/incidents/{incident_id}/acknowledge - Write
Batch create catalog records
Allows creation of multiple Catalog records at once.
POST /api/v2/catalog/relations/{relation_id}/records/batch - Write
Create comment
This will create a new comment.
POST /api/v2/incidents/{incident_id}/comments - Write
Create escalation policy group
Returns either a newly created escalation policy group, or validation errors.
POST /api/v2/policy-groups - Write
Create incident
This will create a new incident and alert the current on-call person.
POST /api/v3/incidents - Write
Create severity group
Returns either a newly created severity group, or validation errors.
POST /api/v2/urgency-groups - Write
Create status page report
Returns the newly created status page report.
POST /api/v2/status-pages/{status_page_id}/status-reports - Write
Create status page resource
Returns a newly created status page resource.
POST /api/v2/status-pages/{status_page_id}/resources - Write
Create status page section
Returns a newly created status page section.
POST /api/v2/status-pages/{status_page_id}/sections - Write
Create status update
Returns the newly created status page report update.
POST /api/v2/status-pages/{status_page_id}/status-reports/{status_report_id}/status-updates - Write
Create status page subscriber
Creates a confirmed e-mail subscriber for a status page.
POST /api/v2/status-pages/{status_page_id}/subscribers - Write
Create Amazon SNS integration
Returns either a newly created Amazon SNS integration, or validation errors. Subscribe a topic to the returned url to start receiving notifications, as described in the Amazon SNS integration guide. Leave Enable raw message delivery off on that subscription, or every notification is rejected with 400.
POST /api/v2/amazon-sns - Write
Create AWS CloudWatch integration
Returns either a newly created AWS CloudWatch integration, or validation errors.
POST /api/v2/aws-cloudwatch-integrations - Write
Create Azure integration
Returns either a newly created Azure integration, or validation errors.
POST /api/v2/azure-integrations - Write
Create catalog record
Returns either a newly created Catalog record, or validation errors.
POST /api/v2/catalog/relations/{relation_id}/records - Write
Create catalog relation
Returns either a newly created Catalog relation, or validation errors.
POST /api/v2/catalog/relations - Write
Create Datadog integration
Returns either a newly created Datadog integration, or validation errors.
POST /api/v2/datadog-integrations - Write
Create Elastic integration
Returns either a newly created Elastic integration, or validation errors.
POST /api/v2/elastic-integrations - Write
Create e-mail integration
Returns either a newly created e-mail integration, or validation errors.
POST /api/v2/email-integrations - Write
Create Google Monitoring integration
Returns either a newly created Google Monitoring integration, or validation errors.
POST /api/v2/google-monitoring-integrations - Write
Create Grafana integration
Returns either a newly created Grafana integration, or validation errors.
POST /api/v2/grafana-integrations - Write
Create incoming webhook
Returns either a newly created incoming webhook, or validation errors.
POST /api/v2/incoming-webhooks - Write
Create an on-call schedule event
Create a new event in the given on-call schedule.
POST /api/v2/on-calls/{schedule_id}/events - Write
Create 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 - Write
Create outgoing webhook
Returns either a newly created Outgoing Webhook integration, or validation errors.
POST /api/v2/outgoing-webhooks - Write
Create PagerDuty integration
Returns either a newly created PagerDuty integration, or validation errors.
POST /api/v2/pager-duty-webhooks - Write
Create Prometheus integration
Returns either a newly created Prometheus integration, or validation errors.
POST /api/v2/prometheus-integrations - Write
Create severity
Returns either a newly created severity, or validation errors.
POST /api/v2/urgencies - Write
Create a Splunk integration
Returns either a newly created Splunk On-Call integration, or validation errors.
POST /api/v2/splunk-on-calls - Write
Create status page group
Returns either a newly created status page group, or validation errors.
POST /api/v2/status-page-groups - Write
Escalate incident
This will escalate an ongoing incident to another team member, a team, different escalation policy, or the whole organization.
POST /api/v3/incidents/{incident_id}/escalate - Write
Reopen incident
This will reopen a resolved incident.
POST /api/v3/incidents/{incident_id}/reopen - Write
Resolve incident
This will resolve an ongoing incident.
POST /api/v3/incidents/{incident_id}/resolve - Write
Update comment
This will update an existing comment.
PATCH /api/v2/incidents/{incident_id}/comments/{comment_id} - Write
Update status page subscriber
Updates which status page resources an e-mail subscriber receives notifications for.
PATCH /api/v2/status-pages/{status_page_id}/subscribers/{subscriber_id} - Write
Update escalation policy group
Update the attributes of an existing escalation policy group. Send only the parameters you wish to change (e.g. name).
PATCH /api/v2/policy-groups/{policy_group_id} - Write
Update severity group
Update the attributes of an existing severity group. Send only the parameters you wish to change (e.g. name).
PATCH /api/v2/urgency-groups/{urgency_group_id} - Write
Update status page report
Update an existing status page report. Send only the parameters you wish to change (e.g. title). You can't change report_type or the affected resources here. A manual report's affected resources change with each new status update.
PATCH /api/v2/status-pages/{status_page_id}/status-reports/{status_report_id} - Write
Update status page resource
Update an existing status page resource. Send only the parameters you wish to change (e.g. public_name), and note that resource_id and resource_type should be sent together.
PATCH /api/v2/status-pages/{status_page_id}/resources/{resource_id} - Write
Update status page section
Update an existing status page section. Send only the parameters you wish to change (e.g. name)
PATCH /api/v2/status-pages/{status_page_id}/sections/{section_id} - Write
Update catalog relation
Update an existing Catalog relation.
PATCH /api/v2/catalog/relations/{relation_id} - Write
Update Jira integration
Update an existing Jira integration. Send only the parameters you wish to change (eg. name).
PATCH /api/v2/jira-integrations/{jira_integration_id} - Write
Update on-call schedule event
Update a single event in the given on-call schedule.
PATCH /api/v2/on-calls/{schedule_id}/events/{event_id} - Write
Update outgoing webhook
Update an existing Outgoing Webhook integration. Send only the parameters you wish to change (eg. name).
PATCH /api/v2/outgoing-webhooks/{outgoing_webhook_id} - Write
Update PagerDuty integration
Update an existing PagerDuty integration. Send only the parameters you wish to change (eg. name).
PATCH /api/v2/pager-duty-webhooks/{pager_duty_webhook_id} - Write
Update Splunk integration
Update an existing Splunk On-Call integration. Send only the parameters you wish to change (eg. name).
PATCH /api/v2/splunk-on-calls/{splunk_on_call_id} - Write
Update status page group
Update the attributes of an existing status page group. Send only the parameters you wish to change (e.g., name).
PATCH /api/v2/status-page-groups/{status_page_group_id} - Write
Create catalog attribute
Returns either a newly created Catalog attribute, or validation errors.
POST /api/v2/catalog/relations/{relation_id}/attributes - Write
Update catalog attribute
Update an existing Catalog attribute.
PATCH /api/v2/catalog/relations/{relation_id}/attributes/{attribute_id} - Destructive
Remove monitor
Permanently deletes an existing monitor.
DELETE /api/v2/monitors/{monitor_id} - Destructive
Update monitor
Update existing monitor configuration. Send only the parameters you wish to change (eg. url)
PATCH /api/v2/monitors/{monitor_id} - Destructive
Batch remove catalog records
Permanently deletes all existing Catalog records for a given relation.
DELETE /api/v2/catalog/relations/{relation_id}/records/batch - Destructive
Create monitor group
Returns either a newly created monitor group, or validation errors.
POST /api/v2/monitor-groups - Destructive
Remove comment
Permanently delete a comment from an incident.
DELETE /api/v2/incidents/{incident_id}/comments/{comment_id} - Destructive
Remove heartbeat group
Permanently deletes an existing heartbeat group.
DELETE /api/v2/heartbeat-groups/{heartbeat_group_id} - Destructive
Remove monitor group
Permanently deletes an existing monitor group.
DELETE /api/v2/monitor-groups/{monitor_group_id} - Destructive
Remove status page
Permanently deletes an existing status page.
DELETE /api/v2/status-pages/{status_page_id} - Destructive
Remove status update
Permanently deletes a status page report update.
DELETE /api/v2/status-pages/{status_page_id}/status-reports/{status_report_id}/status-updates/{status_update_id} - Destructive
Remove heartbeat
Permanently deletes an existing heartbeat.
DELETE /api/v2/heartbeats/{heartbeat_id} - Destructive
Remove New Relic integration
Permanently deletes an existing New Relic integration.
DELETE /api/v2/new-relic-integrations/{new_relic_integration_id} - Destructive
Remove on-call schedule
Permanently deletes an existing on-call schedule.
DELETE /api/v2/on-calls/{schedule_id} - Destructive
Update metadata
Create, update, or remove metadata values for specified key for given incident, monitor, or other resources.
POST /api/v3/metadata - Destructive
Update monitor group
Update the attributes of an existing monitor group. Send only the parameters you wish to change (e.g. name).
PATCH /api/v2/monitor-groups/{monitor_group_id} - Destructive
Update heartbeat
Update an existing heartbeat configuration. Send only the parameters you wish to change (e.g. name)
PATCH /api/v2/heartbeats/{heartbeat_id} - Destructive
Update New Relic integration
Update an existing New Relic integration. Send only the parameters you wish to change (eg. paused).
PATCH /api/v2/new-relic-integrations/{new_relic_integration_id} - Destructive
Batch update catalog records
Allows replacing all Catalog records for a given relation at once. This is a destructive operation and will remove all existing records for the relation before creating new ones.
PUT /api/v2/catalog/relations/{relation_id}/records/batch - Destructive
Batch upsert catalog records
Creates or updates multiple Catalog records at once, so you can send the same records again without creating duplicates.
PATCH /api/v2/catalog/relations/{relation_id}/records/batch - Destructive
Bulk update on-call schedule events
Replace all current and future on-call events in a single on-call schedule:
PUT /api/v2/on-calls/{schedule_id}/events - Destructive
Create heartbeat group
Returns either a newly created heartbeat group, or validation errors.
POST /api/v2/heartbeat-groups - Destructive
Create escalation policy
Returns either a newly created escalation policy, or validation errors.
POST /api/v3/policies - Destructive
Create an on-call schedule rotation
Creates an on-call rotation. This creates consecutive on-call events for specified users, rotating through them until reaching the end date, and removes any existing non-override events within this range. Without working_hours, this only creates events that end after 0:00 UTC today. With working_hours, it creates events from now on, only inside the given windows.
POST /api/v2/on-calls/{schedule_id}/rotation - Destructive
Remove Amazon SNS integration
Permanently deletes an existing Amazon SNS integration.
DELETE /api/v2/amazon-sns/{amazon_sns_integration_id} - Destructive
Remove escalation policy group
Permanently deletes an existing escalation policy group.
DELETE /api/v2/policy-groups/{policy_group_id} - Destructive
Remove incident
This will permanently delete an existing incident.
DELETE /api/v3/incidents/{incident_id} - Destructive
Remove severity group
Permanently deletes an existing severity group.
DELETE /api/v2/urgency-groups/{urgency_group_id} - Destructive
Remove status page report
Permanently deletes an existing status page report.
DELETE /api/v2/status-pages/{status_page_id}/status-reports/{status_report_id} - Destructive
Remove status page resource
Permanently deletes an existing status page resource.
DELETE /api/v2/status-pages/{status_page_id}/resources/{resource_id} - Destructive
Remove status page section
Permanently deletes an existing status page section.
DELETE /api/v2/status-pages/{status_page_id}/sections/{section_id} - Destructive
Remove AWS CloudWatch integration
Permanently deletes an existing AWS CloudWatch integration.
DELETE /api/v2/aws-cloudwatch-integrations/{aws_cloudwatch_integration_id} - Destructive
Remove Azure integration
Permanently deletes an existing Azure integration.
DELETE /api/v2/azure-integrations/{azure_integration_id} - Destructive
Remove catalog record
Permanently deletes an existing Catalog record.
DELETE /api/v2/catalog/relations/{relation_id}/records/{record_id} - Destructive
Remove catalog relation
Permanently deletes an existing Catalog relation.
DELETE /api/v2/catalog/relations/{relation_id} - Destructive
Remove Datadog integration
Permanently deletes an existing Datadog integration.
DELETE /api/v2/datadog-integrations/{datadog_integration_id} - Destructive
Remove Elastic integration
Permanently deletes an existing Elastic integration.
DELETE /api/v2/elastic-integrations/{elastic_integration_id} - Destructive
Remove e-mail integration
Permanently deletes an existing e-mail integration.
DELETE /api/v2/email-integrations/{email_integration_id} - Destructive
Remove escalation policy
Permanently deletes an existing escalation policy. A policy still used by monitors, heartbeats, integrations or other resources can't be deleted until you point them to another escalation policy.
DELETE /api/v3/policies/{policy_id} - Destructive
Remove Google Monitoring integration
Permanently deletes an existing Google Monitoring integration.
DELETE /api/v2/google-monitoring-integrations/{google_monitoring_integration_id} - Destructive
Remove incoming webhook
Permanently deletes an existing incoming webhook.
DELETE /api/v2/incoming-webhooks/{incoming_webhook_id} - Destructive
Remove on-call schedule event
Delete a single event from an on-call schedule.
DELETE /api/v2/on-calls/{schedule_id}/events/{event_id} - Destructive
Remove outgoing e-mail
Permanently deletes an outgoing e-mail integration. Returns an empty body with status 204 No Content on success.
DELETE /api/v2/outgoing-emails/{integration_id} - Destructive
Remove outgoing webhook
Permanently deletes an existing Outgoing Webhook integration.
DELETE /api/v2/outgoing-webhooks/{outgoing_webhook_id} - Destructive
Remove PagerDuty integration
Permanently deletes an existing PagerDuty integration.
DELETE /api/v2/pager-duty-webhooks/{pager_duty_webhook_id} - Destructive
Remove Prometheus integration
Permanently deletes an existing Prometheus integration.
DELETE /api/v2/prometheus-integrations/{prometheus_integration_id} - Destructive
Remove severity
Permanently deletes an existing severity.
DELETE /api/v2/urgencies/{urgency_id} - Destructive
Remove Splunk integration
Permanently deletes an existing Splunk On-Call integration.
DELETE /api/v2/splunk-on-calls/{splunk_on_call_id} - Destructive
Remove status page group
Permanently deletes an existing status page group.
DELETE /api/v2/status-page-groups/{status_page_group_id} - Destructive
Remove Grafana integration
Permanently deletes an existing Grafana integration.
DELETE /api/v2/grafana-integrations/{grafana_integration_id} - Destructive
Remove status page subscriber (DELETE variant)
Removes an e-mail subscriber from a status page. You can remove the subscriber by ID or by exact e-mail address.
DELETE /api/v2/status-pages/{status_page_id}/subscribers/{subscriber_id} - Destructive
Remove status page subscriber (DELETE variant)
Removes an e-mail subscriber from a status page. You can remove the subscriber by ID or by exact e-mail address.
DELETE /api/v2/status-pages/{status_page_id}/subscribers - Destructive
Remove an on-call schedule rotation
Remove an on-call rotation for a single schedule. This also removes all on-call events generated for this on-call rotation that end after 0:00 UTC today.
DELETE /api/v2/on-calls/{schedule_id}/rotation - Destructive
Update Amazon SNS integration
Update an existing Amazon SNS integration. Send only the parameters you wish to change, such as name.
PATCH /api/v2/amazon-sns/{amazon_sns_integration_id} - Destructive
Update heartbeat group
Update the attributes of an existing heartbeat group. Send only the parameters you wish to change (e.g. name)
PATCH /api/v2/heartbeat-groups/{heartbeat_group_id} - Destructive
Update status update
Update an existing status page report update. Send only the parameters you wish to change (e.g. message).
PATCH /api/v2/status-pages/{status_page_id}/status-reports/{status_report_id}/status-updates/{status_update_id} - Destructive
Update AWS CloudWatch integration
Update an existing AWS CloudWatch integration. Send only the parameters you wish to change (eg. paused).
PATCH /api/v2/aws-cloudwatch-integrations/{aws_cloudwatch_integration_id} - Destructive
Update Azure integration
Update an existing Azure integration. Send only the parameters you wish to change (eg. paused).
PATCH /api/v2/azure-integrations/{azure_integration_id} - Destructive
Update catalog record
Update an existing Catalog record.
PATCH /api/v2/catalog/relations/{relation_id}/records/{record_id} - Destructive
Update Datadog integration
Update an existing Datadog integration. Send only the parameters you wish to change (eg. paused).
PATCH /api/v2/datadog-integrations/{datadog_integration_id} - Destructive
Update Elastic integration
Update an existing Elastic integration. Send only the parameters you wish to change (eg. paused).
PATCH /api/v2/elastic-integrations/{elastic_integration_id} - Destructive
Update e-mail integration
Update an existing e-mail integration. Send only the parameters you wish to change (eg. name).
PATCH /api/v2/email-integrations/{email_integration_id} - Destructive
Update escalation policy
Update an existing escalation policy. Send only the parameters you wish to change (eg. name).
PATCH /api/v3/policies/{policy_id} - Destructive
Update Google Monitoring integration
Update an existing Google Monitoring integration. Send only the parameters you wish to change (eg. paused).
PATCH /api/v2/google-monitoring-integrations/{google_monitoring_integration_id} - Destructive
Update Grafana integration
Update an existing Grafana integration. Send only the parameters you wish to change (eg. paused).
PATCH /api/v2/grafana-integrations/{grafana_integration_id} - Destructive
Update incoming webhook
Update an existing incoming webhook. Send only the parameters you wish to change (eg. name).
PATCH /api/v2/incoming-webhooks/{incoming_webhook_id} - Destructive
Update outgoing e-mail
Updates an existing outgoing e-mail integration. Only the parameters you send are changed. Returns the updated integration, or validation errors.
PATCH /api/v2/outgoing-emails/{integration_id} - Destructive
Update Prometheus integration
Update an existing Prometheus integration. Send only the parameters you wish to change (eg. paused).
PATCH /api/v2/prometheus-integrations/{prometheus_integration_id} - Destructive
Update severity
Update an existing severity.
PATCH /api/v2/urgencies/{urgency_id} - Destructive
Update Slack integration
Update an existing Slack integration. Every setting on the integration's Configure page can be changed here. Send only the parameters you wish to change, e.g. integration_type. Lists like alert_options replace the whole list.
PATCH /api/v2/slack-integrations/{slack_integration_id} - Destructive
Remove catalog attribute
Permanently deletes an existing Catalog attribute.
DELETE /api/v2/catalog/relations/{relation_id}/attributes/{attribute_id}
Telemetry API
- Read
List all alerts
Returns a paginated list of all alerts accessible by the user, across all dashboards and explorations.
GET /api/v2/alerts - Read
List all connections
Returns a paginated list of ClickHouse connections. For extra details, such as individual data sources, see Get a single connection API.
GET /api/v1/connections - Read
List all dashboards
Returns a paginated list of your team's dashboards.
GET /api/v2/dashboards - Read
List all explorations
Retrieves a paginated list of your team's explorations.
GET /api/v2/explorations - Read
List all sources
Returns a list of your team's existing sources.
GET /api/v2/sources - Read
Get a single alert
Retrieves a single alert by its ID from any context (dashboard or exploration).
GET /api/v2/alerts/{id} - Read
AWS log group subscriptions (GET variant)
Control which Amazon CloudWatch log groups Better Stack ingests for an aws source. These endpoints manage per-log-group subscription overrides. To subscribe every newly discovered log group automatically, set aws_auto_sub_log_groups when you update the source.
GET /api/v2/sources/{source_id}/aws-log-group-subscriptions - Read
AWS log group subscriptions (GET variant)
Control which Amazon CloudWatch log groups Better Stack ingests for an aws source. These endpoints manage per-log-group subscription overrides. To subscribe every newly discovered log group automatically, set aws_auto_sub_log_groups when you update the source.
GET /api/v2/sources/{source_id}/aws-log-group-subscriptions/{id} - Read
List all comments on a chart
Returns a paginated list of a chart's comments, ordered by the point in time each one is pinned to, oldest first.
GET /api/v2/dashboards/{dashboard_id}/charts/{chart_id}/comments - Read
List all charts
Retrieves a list of all charts on a specific dashboard.
GET /api/v2/dashboards/{dashboard_id}/charts - Read
Get a single connection
Retrieves the details of a specific ClickHouse connection.
GET /api/v1/connections/{id} - Read
List all alerts in a dashboard
Retrieves all alerts associated with a specific dashboard chart. This endpoint is not paginated.
GET /api/v2/dashboards/{dashboard_id}/charts/{chart_id}/alerts - Read
List dashboards in a group
Retrieves a paginated list of dashboards within a specific group.
GET /api/v2/dashboard-groups/{id}/dashboards - Read
List all dashboard groups
Retrieves a paginated list of your team's dashboard groups.
GET /api/v2/dashboard-groups - Read
List all dashboard sections
Retrieves a list of all sections on a specific dashboard. This endpoint is not paginated; it returns all sections for a given dashboard in a single response.
GET /api/v2/dashboards/{dashboard_id}/sections - Read
Export a dashboard
Retrieves the full configuration of a dashboard or a public template as a JSON object. This is useful for backing up dashboards or creating new dashboards via the import endpoint.
GET /api/v2/dashboards/{id}/export - Read
Get a single dashboard
Retrieves detailed information for a single dashboard by its ID, including its charts, sections, and variables.
GET /api/v2/dashboards/{id} - Read
List dashboard templates
Retrieves a list of all available dashboard templates. This endpoint is not paginated and returns all available templates in a single response.
GET /api/v2/dashboards/templates - Read
List all alerts in an exploration
Retrieves all alerts associated with a specific exploration. This endpoint is not paginated.
GET /api/v2/explorations/{exploration_id}/alerts - Read
List explorations in a group
Retrieves a paginated list of explorations within a specific group.
GET /api/v2/exploration-groups/{id}/explorations - Read
List all exploration groups
Retrieves a paginated list of your team's exploration groups.
GET /api/v2/exploration-groups - Read
Get a single exploration
Retrieves a single exploration by its ID, including the full chart, query, and variable configurations.
GET /api/v2/explorations/{id} - Read
Get a single source
Get a single source by its ID.
GET /api/v2/sources/{source_id} - Read
List all collectors
Returns a paginated list of collectors accessible by the authenticated user.
GET /api/v1/collectors - Read
List all metrics
Returns a list of metrics and labels for a specified source.
GET /api/v2/sources/{source_id}/metrics - Read
List all source groups
Returns a list of your team's existing source groups.
GET /api/v1/source-groups - Read
List collector metrics targets
Returns a paginated list of all targets belonging to a collector.
GET /api/v1/collectors/{collector_id}/targets - Read
Get a single chart comment
Returns a single comment from a chart.
GET /api/v2/dashboards/{dashboard_id}/charts/{chart_id}/comments/{id} - Read
Get a single chart
Retrieves a single chart by its ID from a specific dashboard.
GET /api/v2/dashboards/{dashboard_id}/charts/{id} - Read
Lists databases monitored by a collector
Returns a list of databases currently being monitored by the specified collector.
GET /api/v1/collectors/{id}/databases - Read
List hosts where a collector is running
Returns a list of hosts where the specified collector is running.
GET /api/v1/collectors/{id}/hosts - Read
Get a single dashboard alert
Retrieves a single alert by its ID, scoped to a specific dashboard chart.
GET /api/v2/dashboards/{dashboard_id}/charts/{chart_id}/alerts/{id} - Read
Get a single dashboard group
Retrieves a single dashboard group by its ID.
GET /api/v2/dashboard-groups/{id} - Read
Get a single dashboard section
Retrieves a single section by its ID from a specific dashboard.
GET /api/v2/dashboards/{dashboard_id}/sections/{id} - Read
Get a single exploration alert
Retrieves a single alert by its ID, scoped to a specific exploration.
GET /api/v2/explorations/{exploration_id}/alerts/{id} - Read
Get a single exploration group
Retrieves a single exploration group by its ID.
GET /api/v2/exploration-groups/{id} - Read
Get a single collector
Retrieves details for a single collector by its ID.
GET /api/v1/collectors/{id} - Read
Get a single collector metrics target
Returns a single collector target by ID.
GET /api/v1/collectors/{collector_id}/targets/{target_id} - Read
Get a single source group
Get a single source group by its ID.
GET /api/v1/source-groups/{id} - Read
List sources in a source group
Returns a list of all sources in a specific source group.
GET /api/v1/source-groups/{id}/sources - Write
Connect source to your AWS account
Connects an AWS account to an existing aws source, so we can enumerate your AWS resources and manage CloudWatch log group subscriptions.
PATCH /api/v2/sources/{source_id} - Write
Connect source to your GCP project
Connects a Google Cloud project to an existing gcp source, so we can discover metrics, manage log sinks, and enrich your Google Cloud resources.
PATCH /api/v2/sources/{source_id} - Write
Create a connection
Creates a new ClickHouse connection.
POST /api/v1/connections - Write
Create a source
Returns a newly created source.
POST /api/v2/sources - Write
Create a dashboard alert
Creates a new alert for a specific dashboard chart.
POST /api/v2/dashboards/{dashboard_id}/charts/{chart_id}/alerts - Write
Create a dashboard
Creates a new dashboard, including its variables and other properties.
POST /api/v2/dashboards - Write
Import a dashboard
Creates a new dashboard from an exported JSON.
POST /api/v2/dashboards/import - Write
Create an exploration alert
Creates a new alert for a specific exploration.
POST /api/v2/explorations/{exploration_id}/alerts - Write
Create an exploration
Creates a new exploration, including its chart, queries, and variables.
POST /api/v2/explorations - Write
Create a chart comment
Pins a comment to a point in time on a chart, the same comment you get by clicking the chart in the Better Stack interface. Use it to mark releases, deployments, and incidents on your charts from your own scripts.
POST /api/v2/dashboards/{dashboard_id}/charts/{chart_id}/comments - Write
Update a chart comment
Updates the content of a chart comment, or moves it to a different point in time. You only need to provide the fields you want to change.
PATCH /api/v2/dashboards/{dashboard_id}/charts/{chart_id}/comments/{id} - Write
Create a chart
Creates a new chart on a specific dashboard.
POST /api/v2/dashboards/{dashboard_id}/charts - Write
Create a collector
Creates a new Better Stack collector.
POST /api/v1/collectors - Write
Create a source group
Returns either a newly created source group, or validation errors.
POST /api/v1/source-groups - Write
Create a collector metric target
Creates a new monitoring target on a collector.
POST /api/v1/collectors/{collector_id}/targets - Write
Create a metric
Returns a newly created metric or label.
POST /api/v2/sources/{source_id}/metrics - Write
Create a dashboard group
Creates a new dashboard group for organizing dashboards.
POST /api/v2/dashboard-groups - Write
Update a dashboard group
Updates an existing dashboard group by its ID.
PATCH /api/v2/dashboard-groups/{id} - Write
Create a dashboard section
Creates a new section on a specific dashboard.
POST /api/v2/dashboards/{dashboard_id}/sections - Write
Update a dashboard section
Updates an existing section by its ID. You only need to provide the fields you want to change.
PATCH /api/v2/dashboards/{dashboard_id}/sections/{id} - Write
Create an exploration group
Creates a new exploration group for organizing explorations.
POST /api/v2/exploration-groups - Write
Update an exploration group
Updates an existing exploration group by its ID.
PATCH /api/v2/exploration-groups/{id} - Write
Update a source group
Updates an existing source group. Always send name, even when you only change sort_index.
PATCH /api/v1/source-groups/{id} - Write
Update a metric
Updates an existing metric or label. At least one of name, sql_expression, or aggregations must be provided.
PATCH /api/v2/sources/{source_id}/metrics/{id} - Destructive
Remove an alert
Permanently deletes an alert by its ID.
DELETE /api/v2/alerts/{id} - Destructive
Update an alert
Updates an existing alert by its ID. You only need to provide the fields you want to change.
PATCH /api/v2/alerts/{id} - Destructive
AWS log group subscriptions (POST variant)
Control which Amazon CloudWatch log groups Better Stack ingests for an aws source. These endpoints manage per-log-group subscription overrides. To subscribe every newly discovered log group automatically, set aws_auto_sub_log_groups when you update the source.
POST /api/v2/sources/{source_id}/aws-log-group-subscriptions - Destructive
AWS log group subscriptions (PATCH variant)
Control which Amazon CloudWatch log groups Better Stack ingests for an aws source. These endpoints manage per-log-group subscription overrides. To subscribe every newly discovered log group automatically, set aws_auto_sub_log_groups when you update the source.
PATCH /api/v2/sources/{source_id}/aws-log-group-subscriptions/{id} - Destructive
AWS log group subscriptions (DELETE variant)
Control which Amazon CloudWatch log groups Better Stack ingests for an aws source. These endpoints manage per-log-group subscription overrides. To subscribe every newly discovered log group automatically, set aws_auto_sub_log_groups when you update the source.
DELETE /api/v2/sources/{source_id}/aws-log-group-subscriptions/{id} - Destructive
Remove a connection
Deletes an existing ClickHouse connection.
DELETE /api/v1/connections/{id} - Destructive
Remove a dashboard
Permanently deletes an existing dashboard.
DELETE /api/v2/dashboards/{id} - Destructive
Update a dashboard
Updates an existing dashboard by its ID. You only need to provide the fields you want to change.
PATCH /api/v2/dashboards/{id} - Destructive
Remove a source
Permanently deletes an existing source.
DELETE /api/v2/sources/{source_id} - Destructive
Remove a source group
Permanently deletes an existing source group.
DELETE /api/v1/source-groups/{id} - Destructive
Remove an exploration
Permanently deletes an exploration by its ID.
DELETE /api/v2/explorations/{id} - Destructive
Update an exploration
Updates an existing exploration by its ID. You only need to provide the fields you want to change.
PATCH /api/v2/explorations/{id} - Destructive
Update a source
Updates an existing source. Send only the parameters you wish to change (e.g. name )
PATCH /api/v2/sources/{source_id} - Destructive
Remove a chart comment
Permanently removes a comment from a chart.
DELETE /api/v2/dashboards/{dashboard_id}/charts/{chart_id}/comments/{id} - Destructive
Remove a chart
Permanently deletes a chart from a dashboard.
DELETE /api/v2/dashboards/{dashboard_id}/charts/{id} - Destructive
Update a chart
Updates an existing chart by its ID. You only need to provide the fields you want to change.
PATCH /api/v2/dashboards/{dashboard_id}/charts/{id} - Destructive
Remove a dashboard alert
Permanently deletes an alert from a dashboard chart.
DELETE /api/v2/dashboards/{dashboard_id}/charts/{chart_id}/alerts/{id} - Destructive
Update a dashboard alert
Updates an existing alert on a dashboard chart. You only need to provide the fields you want to change.
PATCH /api/v2/dashboards/{dashboard_id}/charts/{chart_id}/alerts/{id} - Destructive
Remove a dashboard group
Permanently deletes a dashboard group by its ID.
DELETE /api/v2/dashboard-groups/{id} - Destructive
Remove a dashboard section
Permanently deletes a section from a dashboard.
DELETE /api/v2/dashboards/{dashboard_id}/sections/{id} - Destructive
Remove a collector
Permanently deletes a collector. This action is irreversible and will also remove all associated configurations and stop data collection. The underlying sources and their data will be deleted asynchronously.
DELETE /api/v1/collectors/{id} - Destructive
Remove a metric
Permanently deletes an existing metric or label.
DELETE /api/v2/sources/{source_id}/metrics/{id} - Destructive
Remove an exploration alert
Permanently deletes an alert by its ID.
DELETE /api/v2/explorations/{exploration_id}/alerts/{id} - Destructive
Update an exploration alert
Updates an existing alert by its ID. You only need to provide the fields you want to change.
PATCH /api/v2/explorations/{exploration_id}/alerts/{id} - Destructive
Remove an exploration group
Permanently deletes an exploration group by its ID.
DELETE /api/v2/exploration-groups/{id} - Destructive
Remove a collector metric target
Permanently removes a collector target. The collector will stop monitoring this target on its next configuration sync.
DELETE /api/v1/collectors/{collector_id}/targets/{target_id} - Destructive
Update a collector
Updates an existing collector. Only the provided parameters will be changed.
PATCH /api/v1/collectors/{id} - Destructive
Update a collector metrics target
Updates an existing collector target. Only include the fields you want to change - omitted fields are preserved.
PATCH /api/v1/collectors/{collector_id}/targets/{target_id}
Organization/team/usage API
- Read
List roles
Lists all roles in your organization — the five built-in roles (admin, billing_admin, team_lead, responder, member) and any custom roles. Use a role's id with the Update team member role or Invite team member APIs.
GET /api/v2/roles - Read
List all team members
List all team members and pending invitations.
GET /api/v2/team-members - Read
Get usage overview
Retrieve your organization's usage and incurred cost across Better Stack products, itemized down to individual sources, applications, and billing line items. The usage API returns the same data as the Usage page in your billing settings.
GET /api/v2/usage - Read
Get a single team member
Returns a single team member by their ID. This endpoint does not return pending invitations.
GET /api/v2/team-members/{id} - Read
Get usage per product
Retrieve your organization's usage and incurred cost across Better Stack products, itemized down to individual sources, applications, and billing line items. The usage API returns the same data as the Usage page in your billing settings.
GET /api/v2/usage/{product} - Write
Invite a team member
Invites a new user to your organization. Invites existing team members to more teams.
POST /api/v2/team-members - Destructive
Update team member role
Changes a team member's role. Reference the target role by its ID, which you can get from the List roles API.
POST /api/v2/team-members/{id}/change-role/{role_id} - Destructive
Remove a team member from team by e-mail
Removes a member from the team, or cancels a pending invitation, by their email address. This action cannot be undone.
DELETE /api/v2/team-members - Destructive
Remove a team member from team by ID
Removes a member from the team by their ID. This action cannot be undone.
DELETE /api/v2/team-members/{id}
No operations match.
See How connections work for access and permissions, or browse all integrations.