GET
/
v1
/
alerts
List alerts
curl --request GET \
  --url https://api.rootly.com/v1/alerts \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "source": "rootly",
      "type": "alerts",
      "attributes": {
        "noise": "noise",
        "source": "rootly",
        "status": "open",
        "summary": "<string>",
        "description": "<string>",
        "services": [
          {
            "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>"
            ],
            "owner_group_ids": [
              "<string>"
            ],
            "owner_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>"
          }
        ],
        "groups": [
          {
            "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>"
          }
        ],
        "environments": [
          {
            "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>"
          }
        ],
        "service_ids": [
          "<string>"
        ],
        "group_ids": [
          "<string>"
        ],
        "environment_ids": [
          "<string>"
        ],
        "external_id": "<string>",
        "external_url": "<string>",
        "alert_urgency_id": "<string>",
        "labels": [
          {
            "key": "<string>",
            "value": "<string>"
          }
        ],
        "data": {},
        "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

​
include
enum<string>

comma separated if needed. eg: environments,services,groups

Available options:
environments,
services,
groups,
responders,
incidents,
events,
alert_urgency,
heartbeat,
live_call_router,
alert_group,
group_leader_alert,
group_member_alerts,
alert_field_values,
alerting_targets,
escalation_policies,
alert_call_recording,
alert_urgency
​
filter[status]
string
​
page[number]
integer
​
page[size]
integer

Response

200 - application/vnd.api+json

filter by status

The response is of type object.