List incidents

GET

incidents

curl --request GET \
  --url https://api.rootly.com/v1/incidents \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": "<string>",
      "type": "incidents",
      "attributes": {
        "title": "<string>",
        "kind": "<string>",
        "slug": "<string>",
        "parent_incident_id": "<string>",
        "duplicate_incident_id": "<string>",
        "summary": "<string>",
        "private": false,
        "severity": {
          "data": {
            "id": "<string>",
            "type": "severities",
            "attributes": {
              "name": "<string>",
              "slug": "<string>",
              "description": "<string>",
              "severity": "critical",
              "color": "<string>",
              "position": 123,
              "notify_emails": [
                "<string>"
              ],
              "slack_channels": [
                {
                  "id": "<string>",
                  "name": "<string>"
                }
              ],
              "slack_aliases": [
                {
                  "id": "<string>",
                  "name": "<string>"
                }
              ],
              "created_at": "<string>",
              "updated_at": "<string>"
            }
          }
        },
        "environments": [
          {
            "data": {
              "id": "<string>",
              "type": "environments",
              "attributes": {
                "name": "<string>",
                "slug": "<string>",
                "description": "<string>",
                "notify_emails": [
                  "<string>"
                ],
                "color": "<string>",
                "position": 123,
                "slack_channels": [
                  {
                    "id": "<string>",
                    "name": "<string>"
                  }
                ],
                "slack_aliases": [
                  {
                    "id": "<string>",
                    "name": "<string>"
                  }
                ],
                "created_at": "<string>",
                "updated_at": "<string>"
              }
            }
          }
        ],
        "incident_types": [
          {
            "data": {
              "id": "<string>",
              "type": "incident_types",
              "attributes": {
                "name": "<string>",
                "slug": "<string>",
                "description": "<string>",
                "color": "<string>",
                "position": 123,
                "notify_emails": [
                  "<string>"
                ],
                "slack_channels": [
                  {
                    "id": "<string>",
                    "name": "<string>"
                  }
                ],
                "slack_aliases": [
                  {
                    "id": "<string>",
                    "name": "<string>"
                  }
                ],
                "created_at": "<string>",
                "updated_at": "<string>"
              }
            }
          }
        ],
        "services": [
          {
            "data": {
              "id": "<string>",
              "type": "services",
              "attributes": {
                "name": "<string>",
                "slug": "<string>",
                "description": "<string>",
                "public_description": "<string>",
                "notify_emails": [
                  "<string>"
                ],
                "color": "<string>",
                "position": 123,
                "backstage_id": "<string>",
                "external_id": "<string>",
                "pagerduty_id": "<string>",
                "opsgenie_id": "<string>",
                "cortex_id": "<string>",
                "service_now_ci_sys_id": "<string>",
                "github_repository_name": "<string>",
                "github_repository_branch": "<string>",
                "gitlab_repository_name": "<string>",
                "gitlab_repository_branch": "<string>",
                "environment_ids": [
                  "<string>"
                ],
                "service_ids": [
                  "<string>"
                ],
                "owners_group_ids": [
                  "<string>"
                ],
                "owners_user_ids": [
                  123
                ],
                "alert_urgency_id": "<string>",
                "alerts_email_enabled": true,
                "alerts_email_address": "<string>",
                "slack_channels": [
                  {
                    "id": "<string>",
                    "name": "<string>"
                  }
                ],
                "slack_aliases": [
                  {
                    "id": "<string>",
                    "name": "<string>"
                  }
                ],
                "created_at": "<string>",
                "updated_at": "<string>"
              }
            }
          }
        ],
        "functionalities": [
          {
            "data": {
              "id": "<string>",
              "type": "functionalities",
              "attributes": {
                "name": "<string>",
                "slug": "<string>",
                "description": "<string>",
                "public_description": "<string>",
                "notify_emails": [
                  "<string>"
                ],
                "color": "<string>",
                "backstage_id": "<string>",
                "external_id": "<string>",
                "pagerduty_id": "<string>",
                "opsgenie_id": "<string>",
                "opsgenie_team_id": "<string>",
                "cortex_id": "<string>",
                "service_now_ci_sys_id": "<string>",
                "position": 123,
                "environment_ids": [
                  "<string>"
                ],
                "service_ids": [
                  "<string>"
                ],
                "owners_group_ids": [
                  "<string>"
                ],
                "owners_user_ids": [
                  123
                ],
                "slack_channels": [
                  {
                    "id": "<string>",
                    "name": "<string>"
                  }
                ],
                "slack_aliases": [
                  {
                    "id": "<string>",
                    "name": "<string>"
                  }
                ],
                "created_at": "<string>",
                "updated_at": "<string>"
              }
            }
          }
        ],
        "groups": [
          {
            "data": {
              "id": "<string>",
              "type": "groups",
              "attributes": {
                "name": "<string>",
                "slug": "<string>",
                "description": "<string>",
                "notify_emails": [
                  "<string>"
                ],
                "color": "<string>",
                "position": 123,
                "backstage_id": "<string>",
                "external_id": "<string>",
                "pagerduty_id": "<string>",
                "pagerduty_service_id": "<string>",
                "opsgenie_id": "<string>",
                "victor_ops_id": "<string>",
                "pagertree_id": "<string>",
                "cortex_id": "<string>",
                "service_now_ci_sys_id": "<string>",
                "user_ids": [
                  123
                ],
                "admin_ids": [
                  123
                ],
                "alerts_email_enabled": true,
                "alerts_email_address": "<string>",
                "alert_urgency_id": "<string>",
                "slack_channels": [
                  {
                    "id": "<string>",
                    "name": "<string>"
                  }
                ],
                "slack_aliases": [
                  {
                    "id": "<string>",
                    "name": "<string>"
                  }
                ],
                "created_at": "<string>",
                "updated_at": "<string>"
              }
            }
          }
        ],
        "labels": {},
        "slack_channel_id": "<string>",
        "slack_channel_name": "<string>",
        "slack_channel_url": "<string>",
        "mitigation_message": "<string>",
        "resolution_message": "<string>",
        "cancellation_message": "<string>",
        "scheduled_for": "<string>",
        "scheduled_until": "<string>",
        "retrospective_progress_status": "not_started",
        "in_triage_at": "<string>",
        "started_at": "<string>",
        "detected_at": "<string>",
        "acknowledged_at": "<string>",
        "mitigated_at": "<string>",
        "resolved_at": "<string>",
        "cancelled_at": "<string>",
        "created_at": "<string>",
        "updated_at": "<string>"
      }
    }
  ],
  "links": {
    "self": "<string>",
    "first": "<string>",
    "prev": "<string>",
    "next": "<string>",
    "last": "<string>"
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

page[number]

integer

page[size]

integer

filter[search]

string

filter[kind]

string

filter[status]

string

filter[private]

string

filter[user_id]

integer

filter[severity]

string

filter[severity_id]

string

filter[labels]

string

filter[types]

string

filter[type_ids]

string

filter[environments]

string

filter[environment_ids]

string

filter[functionalities]

string

filter[functionality_ids]

string

filter[services]

string

filter[service_ids]

string

filter[teams]

string

filter[team_ids]

string

filter[cause]

string

filter[cause_ids]

string

filter[custom_field_selected_option_ids]

string

filter[created_at][gt]

string

filter[created_at][gte]

string

filter[created_at][lt]

string

filter[created_at][lte]

string

filter[updated_at][gt]

string

filter[updated_at][gte]

string

filter[updated_at][lt]

string

filter[updated_at][lte]

string

filter[started_at][gt]

string

filter[started_at][gte]

string

filter[started_at][lt]

string

filter[started_at][lte]

string

filter[detected_at][gt]

string

filter[detected_at][gte]

string

filter[detected_at][lt]

string

filter[detected_at][lte]

string

filter[acknowledged_at][gt]

string

filter[acknowledged_at][gte]

string

filter[acknowledged_at][lt]

string

filter[acknowledged_at][lte]

string

filter[mitigated_at][gt]

string

filter[mitigated_at][gte]

string

filter[mitigated_at][lt]

string

filter[mitigated_at][lte]

string

filter[resolved_at][gt]

string

filter[resolved_at][gte]

string

filter[resolved_at][lt]

string

filter[resolved_at][lte]

string

filter[closed_at][gt]

string

filter[closed_at][gte]

string

filter[closed_at][lt]

string

filter[closed_at][lte]

string

filter[in_triage_at][gt]

string

filter[in_triage_at][gte]

string

filter[in_triage_at][lt]

string

filter[in_triage_at][lte]

string

sort

enum<string>

comma separated if needed. eg: created_at,updated_at

Available options:

created_at,

-created_at,

updated_at,

-updated_at

include

enum<string>

comma separated if needed. eg: sub_statuses,causes,subscribers

Available options:

sub_statuses,

causes,

subscribers,

roles,

slack_messages,

environments,

incident_types,

services,

functionalities,

groups,

events,

action_items,

custom_field_selections,

feedbacks,

incident_post_mortem

Response

200 - application/vnd.api+json

success

data

object[]

required

data.id

string

required

Unique ID of the incident

data.type

enum<string>

required

Available options:

incidents

data.attributes

object

required

data.attributes.title

string

required

The title of the incident

data.attributes.slug

string

required

The slug of the incident

data.attributes.created_at

string

required

Date of creation

data.attributes.updated_at

string

required

Date of last update

data.attributes.kind

string

The kind of the incident

data.attributes.parent_incident_id

string | null

ID of parent incident

data.attributes.duplicate_incident_id

string | null

ID of duplicated incident

data.attributes.summary

string | null

The summary of the incident

data.attributes.private

boolean | null

default:false

Create an incident as private

data.attributes.severity

object

The Severity of the incident

data.attributes.environments

object[] | null

The Environments of the incident

data.attributes.incident_types

object[] | null

The Incident Types of the incident

data.attributes.services

object[] | null

The Services of the incident

data.attributes.functionalities

object[] | null

The Functionalities of the incident

data.attributes.groups

object[] | null

The Teams of to the incident

data.attributes.labels

object | null

Labels to attach to the incidents. eg: {"platform":"osx", "version": "1.29"}

data.attributes.slack_channel_id

string | null

Slack channel id

data.attributes.slack_channel_name

string | null

Slack channel name

data.attributes.slack_channel_url

string | null

Slack channel url

data.attributes.mitigation_message

string | null

How was the incident mitigated?

data.attributes.resolution_message

string | null

How was the incident resolved?

data.attributes.cancellation_message

string | null

Why was the incident cancelled?

data.attributes.scheduled_for

string | null

Date of when the maintenance begins

data.attributes.scheduled_until

string | null

Date of when the maintenance ends

data.attributes.retrospective_progress_status

enum<string> | null

The status of the retrospective progress

Available options:

not_started,

active,

completed,

skipped

data.attributes.in_triage_at

string | null

Date of triage

data.attributes.started_at

string | null

Date of start

data.attributes.detected_at

string | null

Date of detection

data.attributes.acknowledged_at

string | null

Date of acknowledgment

data.attributes.mitigated_at

string | null

Date of mitigation

data.attributes.resolved_at

string | null

Date of resolution

data.attributes.cancelled_at

string | null

Date of cancellation

links

object

required

Was this page helpful?

Creates an incidentCreates a new incident from provided data

curl --request GET \
  --url https://api.rootly.com/v1/incidents \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": "<string>",
      "type": "incidents",
      "attributes": {
        "title": "<string>",
        "kind": "<string>",
        "slug": "<string>",
        "parent_incident_id": "<string>",
        "duplicate_incident_id": "<string>",
        "summary": "<string>",
        "private": false,
        "severity": {
          "data": {
            "id": "<string>",
            "type": "severities",
            "attributes": {
              "name": "<string>",
              "slug": "<string>",
              "description": "<string>",
              "severity": "critical",
              "color": "<string>",
              "position": 123,
              "notify_emails": [
                "<string>"
              ],
              "slack_channels": [
                {
                  "id": "<string>",
                  "name": "<string>"
                }
              ],
              "slack_aliases": [
                {
                  "id": "<string>",
                  "name": "<string>"
                }
              ],
              "created_at": "<string>",
              "updated_at": "<string>"
            }
          }
        },
        "environments": [
          {
            "data": {
              "id": "<string>",
              "type": "environments",
              "attributes": {
                "name": "<string>",
                "slug": "<string>",
                "description": "<string>",
                "notify_emails": [
                  "<string>"
                ],
                "color": "<string>",
                "position": 123,
                "slack_channels": [
                  {
                    "id": "<string>",
                    "name": "<string>"
                  }
                ],
                "slack_aliases": [
                  {
                    "id": "<string>",
                    "name": "<string>"
                  }
                ],
                "created_at": "<string>",
                "updated_at": "<string>"
              }
            }
          }
        ],
        "incident_types": [
          {
            "data": {
              "id": "<string>",
              "type": "incident_types",
              "attributes": {
                "name": "<string>",
                "slug": "<string>",
                "description": "<string>",
                "color": "<string>",
                "position": 123,
                "notify_emails": [
                  "<string>"
                ],
                "slack_channels": [
                  {
                    "id": "<string>",
                    "name": "<string>"
                  }
                ],
                "slack_aliases": [
                  {
                    "id": "<string>",
                    "name": "<string>"
                  }
                ],
                "created_at": "<string>",
                "updated_at": "<string>"
              }
            }
          }
        ],
        "services": [
          {
            "data": {
              "id": "<string>",
              "type": "services",
              "attributes": {
                "name": "<string>",
                "slug": "<string>",
                "description": "<string>",
                "public_description": "<string>",
                "notify_emails": [
                  "<string>"
                ],
                "color": "<string>",
                "position": 123,
                "backstage_id": "<string>",
                "external_id": "<string>",
                "pagerduty_id": "<string>",
                "opsgenie_id": "<string>",
                "cortex_id": "<string>",
                "service_now_ci_sys_id": "<string>",
                "github_repository_name": "<string>",
                "github_repository_branch": "<string>",
                "gitlab_repository_name": "<string>",
                "gitlab_repository_branch": "<string>",
                "environment_ids": [
                  "<string>"
                ],
                "service_ids": [
                  "<string>"
                ],
                "owners_group_ids": [
                  "<string>"
                ],
                "owners_user_ids": [
                  123
                ],
                "alert_urgency_id": "<string>",
                "alerts_email_enabled": true,
                "alerts_email_address": "<string>",
                "slack_channels": [
                  {
                    "id": "<string>",
                    "name": "<string>"
                  }
                ],
                "slack_aliases": [
                  {
                    "id": "<string>",
                    "name": "<string>"
                  }
                ],
                "created_at": "<string>",
                "updated_at": "<string>"
              }
            }
          }
        ],
        "functionalities": [
          {
            "data": {
              "id": "<string>",
              "type": "functionalities",
              "attributes": {
                "name": "<string>",
                "slug": "<string>",
                "description": "<string>",
                "public_description": "<string>",
                "notify_emails": [
                  "<string>"
                ],
                "color": "<string>",
                "backstage_id": "<string>",
                "external_id": "<string>",
                "pagerduty_id": "<string>",
                "opsgenie_id": "<string>",
                "opsgenie_team_id": "<string>",
                "cortex_id": "<string>",
                "service_now_ci_sys_id": "<string>",
                "position": 123,
                "environment_ids": [
                  "<string>"
                ],
                "service_ids": [
                  "<string>"
                ],
                "owners_group_ids": [
                  "<string>"
                ],
                "owners_user_ids": [
                  123
                ],
                "slack_channels": [
                  {
                    "id": "<string>",
                    "name": "<string>"
                  }
                ],
                "slack_aliases": [
                  {
                    "id": "<string>",
                    "name": "<string>"
                  }
                ],
                "created_at": "<string>",
                "updated_at": "<string>"
              }
            }
          }
        ],
        "groups": [
          {
            "data": {
              "id": "<string>",
              "type": "groups",
              "attributes": {
                "name": "<string>",
                "slug": "<string>",
                "description": "<string>",
                "notify_emails": [
                  "<string>"
                ],
                "color": "<string>",
                "position": 123,
                "backstage_id": "<string>",
                "external_id": "<string>",
                "pagerduty_id": "<string>",
                "pagerduty_service_id": "<string>",
                "opsgenie_id": "<string>",
                "victor_ops_id": "<string>",
                "pagertree_id": "<string>",
                "cortex_id": "<string>",
                "service_now_ci_sys_id": "<string>",
                "user_ids": [
                  123
                ],
                "admin_ids": [
                  123
                ],
                "alerts_email_enabled": true,
                "alerts_email_address": "<string>",
                "alert_urgency_id": "<string>",
                "slack_channels": [
                  {
                    "id": "<string>",
                    "name": "<string>"
                  }
                ],
                "slack_aliases": [
                  {
                    "id": "<string>",
                    "name": "<string>"
                  }
                ],
                "created_at": "<string>",
                "updated_at": "<string>"
              }
            }
          }
        ],
        "labels": {},
        "slack_channel_id": "<string>",
        "slack_channel_name": "<string>",
        "slack_channel_url": "<string>",
        "mitigation_message": "<string>",
        "resolution_message": "<string>",
        "cancellation_message": "<string>",
        "scheduled_for": "<string>",
        "scheduled_until": "<string>",
        "retrospective_progress_status": "not_started",
        "in_triage_at": "<string>",
        "started_at": "<string>",
        "detected_at": "<string>",
        "acknowledged_at": "<string>",
        "mitigated_at": "<string>",
        "resolved_at": "<string>",
        "cancelled_at": "<string>",
        "created_at": "<string>",
        "updated_at": "<string>"
      }
    }
  ],
  "links": {
    "self": "<string>",
    "first": "<string>",
    "prev": "<string>",
    "next": "<string>",
    "last": "<string>"
  }
}

Overview

AlertEvents

AlertGroups

AlertRoutingRules

AlertUrgencies

AlertSources

Alerts

Audits

Authorizations

CatalogEntities

CatalogEntityProperties

CatalogFields

Catalogs

Causes

[DEPRECATED] CustomFieldOptions

[DEPRECATED] CustomFields

CustomForms

DashboardPanels

Dashboards

Environments

EscalationPolicies

EscalationLevelsPolicies

EscalationLevelsPath

EscalationLevels

EscalationPaths

FormFieldOptions

FormFieldPlacementConditions

FormFieldPlacements

FormFieldPositions

FormFields

FormSetConditions

FormSets

Functionalities

WorkflowTasks

[DEPRECATED] WorkflowCustomFieldSelections

WorkflowFormFieldConditions

WorkflowGroups

WorkflowRuns

Workflows

Heartbeats

IncidentActionItems

[DEPRECATED] IncidentCustomFieldSelections

IncidentEventFunctionalities

IncidentEventServices

IncidentEvents

IncidentFeedbacks

IncidentFormFieldSelections

IncidentPermissionSetBooleans

IncidentPermissionSetResources

IncidentPermissionSets

IncidentRetrospectives

IncidentRetrospectiveSteps

IncidentRoleTasks

IncidentRoles

IncidentStatusPageEvents

IncidentSubStatuses

IncidentTypes

Incidents

IpRanges

LiveCallRouters

OnCallRoles

OnCallShadows

OverrideShifts

PlaybookTasks

Playbooks

RetrospectiveTemplates

Pulses

RetrospectiveConfigurations

RetrospectiveProcessGroupSteps

RetrospectiveProcessGroups

RetrospectiveProcesses

RetrospectiveSteps

Roles

ScheduleRotationActiveDays

ScheduleRotationUsers

ScheduleRotations

Schedules

Shifts

Secrets

Services