Explore documentation
  1. Welcome to Uptime 👋
  2. Frequently Asked Questions
  3. Monitoring
    1. Get started with monitoring
    2. Working with monitors
    3. Customizing monitors
    4. Monitor types
  4. On-call scheduling and alerting
    1. Get started with on-call
    2. Sending alerts to Slack ↗
    3. Connecting external calendars
    4. Advanced on-call setup
  5. Incidents
    1. Working with incidents
    2. Create incidents manually
    3. Post mortems
    4. Incident silencing
    5. Incident metadata
  6. Status pages
    1. Get started with status pages
    2. Working with status pages
  7. Integrations
    1. Integrating with Better Stack
  8. Team and account management
    1. Team management
    2. Account settings
    3. Audit logs
  9. API
    1. Get started with API
  10. Monitors API
    1. Monitors
    2. Monitor groups
    3. Heartbeats
    4. Heartbeat groups
  11. On-call & Incidents API
    1. On-call calendar
    2. Escalation policies
    3. Severities
    4. Incidents
      1. List all incidents GET
      2. List a single incident GET
      3. List of incident timeline events GET
      4. Create a new incident POST
      5. Acknowledge an ongoing incident POST
      6. Resolve an ongoing incident POST
      7. Delete an existing incident DELETE
      8. Incidents API response params
    5. Comments
  12. Integrations API
    1. New Relic Integrations
    2. Datadog Integrations
    3. AWS CloudWatch Integrations
    4. Azure Integrations
    5. Google Monitoring Integrations
    6. Grafana Integrations
    7. Prometheus Integrations
    8. Email integrations
    9. Incoming webhooks
    10. Splunk On-Call integrations
    11. PagerDuty Integrations
  13. Status pages API
    1. Status pages
    2. Status page sections
    3. Status page resources
    4. Status page reports
    5. Status page report updates
  14. Other API
    1. Metadata

Create a new incident

This will create a new incident and alert the current on-call person.

POST https://uptime.betterstack.com/api/v2/incidents

Headers

Authorization
required string

Bearer $TEAM_TOKEN

Content_Type
string

application/json

Body parameters

requester_email
string

E-mail of the user who requested the incident

name
string

Short name of the incident

summary
string

Brief summary of the incident

description
string

Full description of the incident

call
boolean

Should we call the on-call person?

sms
boolean

Should we send an SMS to the on-call person?

email
boolean

Should we send an email to the on-call person?

push
boolean

Should we send a push notification to the on-call person?

team_wait
integer

How long to wait before escalating the incident alert to the team. Leave blank to disable escalating to the entire team. In seconds.

policy_id
string

The ID of the escalation policy with which you'd like to escalate this incident

201

The incident was succesfully created

Response body

{
  "data": {
    "id": "123456789",
    "type": "incident",
    "attributes": {
      "name": "uptime homepage",
      "url": "https://uptime.betterstack.com/",
      "http_method": "get",
      "cause": "Status 500",
      "incident_group_id": null,
      "started_at": "2020-03-09T17:37:56.662Z",
      "acknowledged_at": null,
      "acknowledged_by": null,
      "resolved_at": null,
      "resolved_by": null,
      "response_content": "\n404 Not Found\n\nNot Found\nThe requested URL /fail was not found on this server.\n",
      "response_options": "{}",
      "regions": [
        "us",
        "eu",
        "as",
        "au"
      ],
      "response_url": null,
      "screenshot_url": null,
      "origin_url": null,
      "escalation_policy_id": null,
      "call": true,
      "sms": true,
      "email": true,
      "push": true
    },
    "relationships": {
      "monitor": {
        "data": {
          "id": "2",
          "type": "monitor"
        }
      }
    }
  }
}
404

Authentication failed

Example cURL

Example
curl --request POST \
  --url https://uptime.betterstack.com/api/v2/incidents \
  --header "Authorization: Bearer $TEAM_TOKEN" \
  --header 'Content-Type: application/json' \
  --data '{"summary": "Test incident", "requester_email": "my-great-email@example.com", "description": "No need to worry, everything is fine, this is just testing the great Uptime API."}'

Previous article

List of incident timeline events

Next article

Acknowledge an ongoing incident