Explore documentation
  1. Welcome to Incidents 👋
  2. Frequently Asked Questions
  3. On-call scheduling and alerting
    1. Get started
    2. Slack and other integrations ↗
    3. Tag on-call in Slack
    4. Mobile apps ↗
    5. Connecting external calendars
    6. Advanced guide
  4. Incident management
    1. Get started
    2. AI SRE investigations
    3. Post mortems
    4. Metadata & Catalog
    5. Screening alerts
    6. Reporting ↗
  5. Monitoring
    1. Get started
    2. Working with monitors
    3. Customizing monitors
    4. Monitor types
  6. Status pages
    1. Get started
    2. Advanced guide
  7. Incidents API
    1. Getting an API token
    2. Pagination
    3. Monitors
    4. Heartbeats
    5. On-call & incidents
    6. Status pages
    7. Metadata
    8. Integrations
      1. New Relic
      2. Datadog
      3. AWS CloudWatch
      4. Amazon SNS
      5. Microsoft Azure
      6. Google Monitoring
      7. Grafana
      8. Elastic
      9. Prometheus
        1. List Prometheus integrations GET
        2. Get Prometheus integration GET
        3. Create Prometheus integration POST
        4. Update Prometheus integration PATCH
        5. Remove Prometheus integration DELETE
      10. E-mail
      11. Incoming webhooks
      12. Atlassian Jira
      13. Slack
      14. Outgoing webhooks
      15. Outgoing e‑mails
      16. Splunk On-Call
      17. PagerDuty
      18. Catalog
    9. Team members
    10. Organization roles
    11. Usage
    12. Reporting

Get Prometheus integration

Returns a single Prometheus integration by ID.

GET https://incidents.betterstack.com/api/v2/prometheus-integrations/{prometheus_integration_id}

URL parameters

prometheus_integration_id
required string

The ID of the Prometheus integration you want to get.

Headers

Authorization
required string

Bearer $TOKEN

200

Returns a single Prometheus integration

Response body

{
  "data": {
    "id": "37",
    "type": "prometheus_integration",
    "attributes": {
      "call": false,
      "sms": true,
      "email": true,
      "team_wait": 180,
      "recovery_period": null,
      "policy_id": null,
      "push": false,
      "critical_alert": false,
      "name": "Prometheus alerts",
      "webhook_url": "https://incidents.betterstack.com/api/v1/prometheus/webhook/[token]",
      "team_name": "Testing",
      "paused": false
    }
  }
}

Response attributes

id
string

The ID of the Prometheus integration.

type
string

Always prometheus_integration.

attributes.call
boolean

Whether to call the on-call person.

attributes.sms
boolean

Whether to send an SMS to the on-call person.

attributes.email
boolean

Whether to send an e-mail to the on-call person.

attributes.team_wait
integer or null

How long we wait before escalating the incident to the team in seconds, 0 to alert the whole team right away, or null to never escalate to the team.

attributes.recovery_period
integer or null

A recovery period in seconds, or null when none is set, which this integration doesn't use since incidents resolve as soon as Prometheus reports the alert as resolved.

attributes.policy_id
integer or null

ID of the escalation policy for incidents from this integration, or null when incidents alert the on-call person directly.

attributes.push
boolean

Whether to send a push notification to the on-call person.

attributes.critical_alert
boolean

Whether to send a critical push notification that ignores the mute switch and Do Not Disturb mode.

attributes.name
string or null

The name of the Prometheus integration shown in the dashboard, or null when no name is set.

attributes.webhook_url
string

The URL to point your Prometheus webhook to.

attributes.team_name
string

The team this integration belongs to.

attributes.paused
boolean

Whether the Prometheus integration is paused, which makes it ignore incoming alerts.

Example cURL

Example
curl --request GET \
  --url https://incidents.betterstack.com/api/v2/prometheus-integrations/37 \
  --header "Authorization: Bearer $TOKEN"


Previous article

List Prometheus integrations

Next article

Create Prometheus integration