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. Slack Integrations
    11. Splunk On-Call integrations
    12. 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

Incidents API response params

Response body parameters

Parameter Type Values
data Object Contains information about the incident. (see data table below)
included Object Contains information about included entity that triggered the incident. Not present when listing multiple incidents. (see included table below)

Namespace data

Parameter Type Values
id String The id of the incident
type String incident
attributes Object Attributes object (see below)
attributes.name String Name of the incident
attributes.url String URL of the incident
attributes.http_method String Which HTTP method was used
attributes.cause String What caused the incident
attributes.incident_group_id Integer ID of the incident group. Can be null
attributes.started_at String (ISO DateTime format) When the incident started
attributes.acknowledged_at String (ISO DateTime format) When was the incident acknowledged
attributes.acknowledged_by String Who acknowledged the incident
attributes.resolved_at String (ISO DateTime format) When was the incident resolved
attributes.resolved_by String Who resolved the incident
attributes.status String Current status of the incident. Valid values: Unconfirmed, Started, Acknowledged, Resolved, Validating
attributes.response_content String Content of the response that triggered the incident
attributes.response_options JSON string Response metadata of the response performed by the monitor
attributes.regions Array of strings Region of the performed check. Valid values: us eu as au
attributes.response_url String Link to the text/source code snapshot of your site during the incident - similar to screenshot_url, but not rendered
attributes.screenshot_url String URL of the screenshot taken at the time of the incident
attributes.origin_url String URL of the integration that caused the incident
attributes.escalation_policy_id String ID of the escalation policy that is in place
attributes.call Boolean Should we call the on-call person?
attributes.sms Boolean Should we send an SMS to the on-call person?
attributes.email Boolean Should we send an email to the on-call person?
attributes.push Boolean Should we send a push notification to the on-call person?
attributes.metadata Object Metadata key-value pairs
attributes.metadata.* String Metadata value for given key
relationships Object Relationships object (see below)
relationships.monitor Object Monitor object (see below)
relationships.monitor.data Object Monitor Data object contains information about the monitor which triggered the incident)
relationships.monitor.data.id String Id of the monitor which triggered the incident
relationships.monitor.type String monitor
relationships.heartbeat Object Heartbeat object (see below)
relationships.heartbeat.data Object Heartbeat Data object contains information about the heartbeat which triggered the incident)
relationships.heartbeat.data.id String Id of the heartbeat which triggered the incident
relationships.heartbeat.type String heartbeat
relationships.webhook_integration Object Webhook integration object (see below)
relationships.webhook_integration.data Object Webhook integration Data object contains information about the integration which triggered the incident, also present for incidents triggered by Dashboard alert)
relationships.webhook_integration.data.id String Id of the webhook integration which triggered the incident
relationships.webhook_integration.type String webhook_integration

Namespace included

Parameter Type Values
id String Id of the monitor or heartbeat which triggered the incident
type String monitor or heartbeat
attributes Object Attributes object (see Monitor API response or Heartbeat API response for details)

Previous article

Delete an existing incident

Next article

List all comments