Explore documentation
  1. Welcome to Uptime 👋
  2. Frequently Asked Questions
  3. On-call scheduling and alerting
    1. Get started
    2. Slack and other integrations ↗
    3. Connecting external calendars
    4. Advanced guide
  4. Incidents
    1. Get started
    2. Advanced guide
    3. 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. Uptime API
    1. Getting an API token
    2. Monitors
    3. Heartbeats
    4. On-call & incidents
      1. On-call schedule
      2. On-call schedule events
      3. On-call schedule rotations
      4. Escalation policies
      5. Escalation policy groups
      6. Severities
      7. Severity groups
      8. Incidents
        1. List incidents GET
        2. Get incident GET
        3. List incident timeline GET
        4. Create incident POST
        5. Acknowledge incident POST
        6. Resolve incident POST
        7. Reopen incident POST
        8. Escalate incident POST
        9. Remove incident DELETE
        10. Response attributes
      9. Comments
    5. Status pages
    6. Metadata
    7. Integrations
    8. Team members

Response attributes

Parameter Type Values
data Object Contains information about the incident. See Data namespace below.
included Object Contains information about included entity that triggered the incident. Not present when listing multiple incidents. See Included namespace below.
relationships Array of Object Contains data for entities included in the incident. See Relationships namespace below.

Namespace data

Parameter Type Values
id String The ID of the incident.
type String incident
attributes Object Attributes object. See below.

Attributes

Parameter Type Values
name String Name of the incident.
url String URL of the incident.
http_method String Which HTTP method was used.
cause String What caused the incident.
incident_group_id Integer ID of the incident group. Can be null.
started_at String (ISO DateTime format) When the incident started.
acknowledged_at String (ISO DateTime format) When was the incident acknowledged.
acknowledged_by String Who acknowledged the incident.
resolved_at String (ISO DateTime format) When was the incident resolved.
resolved_by String Who resolved the incident.
status String Current status of the incident. Valid values: Unconfirmed, Started, Acknowledged, Resolved, Validating.
team_name String The team this incident is in.
response_content String Body of the response that triggered the incident. Only present if the response is shorter than 500 bytes. Also see response_url.
response_url String Link to the body of the response that triggered the incident. Only present if the response is at least 500 bytes in size, otherwise the body is inlined as response_content.
response_options JSON string Response metadata of the response performed by the monitor.
regions Array of strings Region of the performed check. Valid values: us eu as au.
screenshot_url String URL of the screenshot taken at the time of the incident.
origin_url String URL of the integration that caused the incident.
escalation_policy_id String ID of the escalation policy that is in place.
ssl_certificate_expires_at String (ISO DateTime format) Time at which the SSL certificate will expire (only present if the incident is about a certificate expiration).
domain_expires_at String (ISO DateTime format) Time at which the domain will expire (only present if the incident is about a domain expiration).
call Boolean Call the on-call person.
sms Boolean Send an SMS to the on-call person.
email Boolean Send an email to the on-call person.
push Boolean Send a push notification to the on-call person.
critical_alert Boolean Send a critical alert push notification to the on-call person. Falls back to a regular push notification, if critical alerts are not supported.
slack_channels Array of strings List of Slack channel names created for this incident (channel-type Slack integrations).
metadata Object Metadata key-value pairs.
metadata.*.[] MetadataValue Array of metadata values for given key. See the MetadataValue section below for details about metadata value attributes.

MetadataValue

Parameter Type Values
type String Type of the metadata value, possible values are String, User, Team, Policy, Schedule, SlackIntegration, LinearIntegration, JiraIntegration, MicrosoftTeamsWebhook, ZapierWebhook, NativeWebhook, or PagerDutyWebhook. Default: String.
value String String value of the metadata value object. Used only if type is String.
item_id String ID of the item referenced by the metadata value. Used with all types except String. A name or an email attribute (see below) can be used instead when creating or updating metadata values.
name String Name of the referenced item. Used with all types except String.
email String Email of the user referenced by the metadata value. Used with User type.

Namespace included

Parameter Type Values
id String ID of the monitor or heartbeat which triggered the incident.
type String monitor or heartbeat

Namespace relationships

Parameter Type Values
monitor Object Monitor object. See below.
monitor.data Object Monitor Data object contains information about the monitor which triggered the incident.
monitor.data.id String ID of the monitor which triggered the incident.
monitor.type String monitor
heartbeat Object Heartbeat object. See below.
heartbeat.data Object Heartbeat Data object contains information about the heartbeat which triggered the incident.
heartbeat.data.id String ID of the heartbeat which triggered the incident.
heartbeat.type String heartbeat
webhook_integration Object Webhook integration object. See below.
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.
webhook_integration.data.id String ID of the webhook integration which triggered the incident.
webhook_integration.type String webhook_integration

Previous article

Remove incident

Next article

List comments