Retrieves an alert

GET

alerts

{id}

Retrieves an alert

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

{
  "data": {
    "id": "<string>",
    "type": "alerts",
    "attributes": {
      "source": "rootly",
      "summary": "<string>",
      "created_at": "<string>",
      "updated_at": "<string>",
      "noise": "noise",
      "status": "open",
      "description": "<string>",
      "services": [
        {
          "name": "<string>",
          "created_at": "<string>",
          "updated_at": "<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>"
            }
          ],
          "alert_broadcast_enabled": true,
          "alert_broadcast_channel": {
            "id": "<string>",
            "name": "<string>"
          },
          "incident_broadcast_enabled": true,
          "incident_broadcast_channel": {
            "id": "<string>",
            "name": "<string>"
          }
        }
      ],
      "groups": [
        {
          "name": "<string>",
          "created_at": "<string>",
          "updated_at": "<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>"
            }
          ],
          "alert_broadcast_enabled": true,
          "alert_broadcast_channel": {
            "id": "<string>",
            "name": "<string>"
          },
          "incident_broadcast_enabled": true,
          "incident_broadcast_channel": {
            "id": "<string>",
            "name": "<string>"
          },
          "auto_add_members_when_attached": true
        }
      ],
      "environments": [
        {
          "name": "<string>",
          "created_at": "<string>",
          "updated_at": "<string>",
          "slug": "<string>",
          "description": "<string>",
          "notify_emails": [
            "<string>"
          ],
          "color": "<string>",
          "position": 123,
          "slack_channels": [
            {
              "id": "<string>",
              "name": "<string>"
            }
          ],
          "slack_aliases": [
            {
              "id": "<string>",
              "name": "<string>"
            }
          ]
        }
      ],
      "service_ids": [
        "<string>"
      ],
      "group_ids": [
        "<string>"
      ],
      "environment_ids": [
        "<string>"
      ],
      "external_id": "<string>",
      "external_url": "<string>",
      "alert_urgency_id": "<string>",
      "group_leader_alert_id": "<string>",
      "grouping_metadata": {},
      "is_group_leader_alert": true,
      "labels": [
        {
          "key": "<string>",
          "value": "<string>"
        }
      ],
      "data": {},
      "deduplication_key": "<string>",
      "alert_field_values_attributes": [
        {
          "alert_field_id": "<string>",
          "value": "<string>"
        }
      ]
    },
    "source": "rootly"
  }
}

Authorizations

Authorization

string

header

required

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

Path Parameters

string

required

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

Response

alert found with group_member_alerts included

data

object

required

Show child attributes

data.id

string

required

Unique ID of the alert

data.type

enum<string>

required

Available options:

alerts

data.attributes

object

required

Show child attributes

data.attributes.source

enum<string>

required

The source of the alert

Available options:

rootly,

manual,

api,

heartbeat,

web,

slack,

email,

workflow,

live_call_routing,

pagerduty,

opsgenie,

victorops,

pagertree,

datadog,

nobl9,

zendesk,

asana,

clickup,

sentry,

rollbar,

jira,

honeycomb,

service_now,

linear,

grafana,

alertmanager,

google_cloud,

generic_webhook,

cloud_watch,

azure,

splunk,

chronosphere,

app_optics,

bug_snag,

monte_carlo,

nagios,

prtg,

catchpoint,

app_dynamics,

checkly,

new_relic,

gitlab

data.attributes.summary

string

required

The summary of the alert

data.attributes.created_at

string

required

Date of creation

data.attributes.updated_at

string

required

Date of last update

data.attributes.noise

enum<string> | null

Whether the alert is marked as noise

Available options:

noise,

not_noise

data.attributes.status

enum<string>

The status of the alert

Available options:

open,

triggered,

acknowledged,

resolved

data.attributes.description

string | null

The description of the alert

data.attributes.services

object[]

Services attached to the alert

Show child attributes

data.attributes.services.name

string

required

The name of the service

data.attributes.services.created_at

string

required

Date of creation

data.attributes.services.updated_at

string

required

Date of last update

data.attributes.services.slug

string

The slug of the service

data.attributes.services.description

string | null

The description of the service

data.attributes.services.public_description

string | null

The public description of the service

data.attributes.services.notify_emails

string[] | null

Emails attached to the service

data.attributes.services.color

string | null

The hex color of the service

data.attributes.services.position

integer | null

Position of the service

data.attributes.services.backstage_id

string | null

The Backstage entity id associated to this service. eg: :namespace/:kind/:entity_name

data.attributes.services.external_id

string | null

The external id associated to this service

data.attributes.services.pagerduty_id

string | null

The PagerDuty service id associated to this service

data.attributes.services.opsgenie_id

string | null

The Opsgenie service id associated to this service

data.attributes.services.cortex_id

string | null

The Cortex group id associated to this service

data.attributes.services.service_now_ci_sys_id

string | null

The Service Now CI sys id associated to this service

data.attributes.services.github_repository_name

string | null

The GitHub repository name associated to this service. eg: rootlyhq/my-service

data.attributes.services.github_repository_branch

string | null

The GitHub repository branch associated to this service. eg: main

data.attributes.services.gitlab_repository_name

string | null

The GitLab repository name associated to this service. eg: rootlyhq/my-service

data.attributes.services.gitlab_repository_branch

string | null

The GitLab repository branch associated to this service. eg: main

data.attributes.services.environment_ids

string[] | null

Environments associated with this service

data.attributes.services.service_ids

string[] | null

Services dependent on this service

data.attributes.services.owner_group_ids

string[] | null

Owner Teams associated with this service

data.attributes.services.owner_user_ids

integer[] | null

Owner Users associated with this service

data.attributes.services.alert_urgency_id

string | null

The alert urgency id of the service

data.attributes.services.alerts_email_enabled

boolean | null

Enable alerts through email

data.attributes.services.alerts_email_address

string | null

Email generated to send alerts to

data.attributes.services.slack_channels

object[] | null

Slack Channels associated with this service

Show child attributes

data.attributes.services.slack_channels.id

string

required

Slack channel ID

data.attributes.services.slack_channels.name

string

required

Slack channel name

data.attributes.services.slack_aliases

object[] | null

Slack Aliases associated with this service

Show child attributes

data.attributes.services.slack_aliases.id

string

required

Slack alias ID

data.attributes.services.slack_aliases.name

string

required

Slack alias name

data.attributes.services.alert_broadcast_enabled

boolean | null

Enable alerts to be broadcasted to a specific channel

data.attributes.services.alert_broadcast_channel

object

Slack channel to broadcast alerts to

Show child attributes

data.attributes.services.alert_broadcast_channel.id

string

Slack channel ID

data.attributes.services.alert_broadcast_channel.name

string

Slack channel name

data.attributes.services.incident_broadcast_enabled

boolean | null

Enable incidents to be broadcasted to a specific channel

data.attributes.services.incident_broadcast_channel

object

Slack channel to broadcast incidents to

Show child attributes

data.attributes.services.incident_broadcast_channel.id

string

Slack channel ID

data.attributes.services.incident_broadcast_channel.name

string

Slack channel name

data.attributes.groups

object[]

Groups attached to the alert

Show child attributes

data.attributes.groups.name

string

required

The name of the team

data.attributes.groups.created_at

string

required

Date of creation

data.attributes.groups.updated_at

string

required

Date of last update

data.attributes.groups.slug

string

data.attributes.groups.description

string | null

The description of the team

data.attributes.groups.notify_emails

string[] | null

Emails to attach to the team

data.attributes.groups.color

string | null

The hex color of the team

data.attributes.groups.position

integer | null

Position of the team

data.attributes.groups.backstage_id

string | null

The Backstage entity id associated to this team. eg: :namespace/:kind/:entity_name

data.attributes.groups.external_id

string | null

The external id associated to this team

data.attributes.groups.pagerduty_id

string | null

The PagerDuty group id associated to this team

data.attributes.groups.pagerduty_service_id

string | null

The PagerDuty service id associated to this team

data.attributes.groups.opsgenie_id

string | null

The Opsgenie group id associated to this team

data.attributes.groups.victor_ops_id

string | null

The VictorOps group id associated to this team

data.attributes.groups.pagertree_id

string | null

The PagerTree group id associated to this team

data.attributes.groups.cortex_id

string | null

The Cortex group id associated to this team

data.attributes.groups.service_now_ci_sys_id

string | null

The Service Now CI sys id associated to this team

data.attributes.groups.user_ids

integer[] | null

The user ids of the members of this team.

data.attributes.groups.admin_ids

integer[] | null

The user ids of the admins of this team. These users must also be present in user_ids attribute.

data.attributes.groups.alerts_email_enabled

boolean | null

Enable alerts through email

data.attributes.groups.alerts_email_address

string | null

Email generated to send alerts to

data.attributes.groups.alert_urgency_id

string | null

The alert urgency id of the team

data.attributes.groups.slack_channels

object[] | null

Slack Channels associated with this team

Show child attributes

data.attributes.groups.slack_channels.id

string

required

Slack channel ID

data.attributes.groups.slack_channels.name

string

required

Slack channel name

data.attributes.groups.slack_aliases

object[] | null

Slack Aliases associated with this team

Show child attributes

data.attributes.groups.slack_aliases.id

string

required

Slack alias ID

data.attributes.groups.slack_aliases.name

string

required

Slack alias name

data.attributes.groups.alert_broadcast_enabled

boolean | null

Enable alerts to be broadcasted to a specific channel

data.attributes.groups.alert_broadcast_channel

object

Slack channel to broadcast alerts to

Show child attributes

data.attributes.groups.alert_broadcast_channel.id

string

Slack channel ID

data.attributes.groups.alert_broadcast_channel.name

string

Slack channel name

data.attributes.groups.incident_broadcast_enabled

boolean | null

Enable incidents to be broadcasted to a specific channel

data.attributes.groups.incident_broadcast_channel

object

Slack channel to broadcast incidents to

Show child attributes

data.attributes.groups.incident_broadcast_channel.id

string

Slack channel ID

data.attributes.groups.incident_broadcast_channel.name

string

Slack channel name

data.attributes.groups.auto_add_members_when_attached

boolean | null

Auto add members to incident channel when team is attached

data.attributes.environments

object[]

Environments attached to the alert

Show child attributes

data.attributes.environments.name

string

required

The name of the environment

data.attributes.environments.created_at

string

required

Date of creation

data.attributes.environments.updated_at

string

required

Date of last update

data.attributes.environments.slug

string

The slug of the environment

data.attributes.environments.description

string | null

The description of the environment

data.attributes.environments.notify_emails

string[] | null

Emails attached to the environment

data.attributes.environments.color

string | null

The hex color of the environment

data.attributes.environments.position

integer | null

Position of the environment

data.attributes.environments.slack_channels

object[] | null

Slack Channels associated with this environment

Show child attributes

data.attributes.environments.slack_channels.id

string

required

Slack channel ID

data.attributes.environments.slack_channels.name

string

required

Slack channel name

data.attributes.environments.slack_aliases

object[] | null

Slack Aliases associated with this environment

Show child attributes

data.attributes.environments.slack_aliases.id

string

required

Slack alias ID

data.attributes.environments.slack_aliases.name

string

required

Slack alias name

data.attributes.service_ids

string[] | null

The Service ID's to attach to the alert. If your organization has On-Call enabled and your notification target is a Service. This field will be automatically set for you.

data.attributes.group_ids

string[] | null

The Group ID's to attach to the alert. If your organization has On-Call enabled and your notification target is a Group. This field will be automatically set for you.

data.attributes.environment_ids

string[] | null

The Environment ID's to attach to the alert

data.attributes.external_id

string | null

External ID

data.attributes.external_url

string | null

External Url

data.attributes.alert_urgency_id

string | null

The ID of the alert urgency

data.attributes.group_leader_alert_id

string | null

The ID of the group leader alert

data.attributes.grouping_metadata

object

The grouping metadata of the alert

data.attributes.is_group_leader_alert

boolean | null

Whether the alert is a group leader alert

data.attributes.labels

(object | null)[]

Show child attributes

data.attributes.labels.key

string

required

Key of the tag

data.attributes.labels.value

string

required

Value of the tag

data.attributes.data

object

Additional data

data.attributes.deduplication_key

string | null

Alerts sharing the same deduplication key are treated as a single alert.

data.attributes.alert_field_values_attributes

(object | null)[]

Custom alert field values to create with the alert

Show child attributes

data.attributes.alert_field_values_attributes.alert_field_id

string

required

ID of the custom alert field

data.attributes.alert_field_values_attributes.value

string

required

Value for the alert field

data.source

enum<string>

The source of the alert

Available options:

rootly,

manual,

api,

heartbeat,

web,

slack,

email,

workflow,

live_call_routing,

pagerduty,

opsgenie,

victorops,

pagertree,

datadog,

nobl9,

zendesk,

asana,

clickup,

sentry,

rollbar,

jira,

honeycomb,

service_now,

linear,

grafana,

alertmanager,

google_cloud,

generic_webhook,

cloud_watch,

azure,

splunk,

chronosphere,

app_optics,

bug_snag,

monte_carlo,

nagios,

prtg,

catchpoint,

app_dynamics,

checkly,

new_relic,

gitlab

Update alertUpdates an alert

⌘I

Retrieves an alert

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

{
  "data": {
    "id": "<string>",
    "type": "alerts",
    "attributes": {
      "source": "rootly",
      "summary": "<string>",
      "created_at": "<string>",
      "updated_at": "<string>",
      "noise": "noise",
      "status": "open",
      "description": "<string>",
      "services": [
        {
          "name": "<string>",
          "created_at": "<string>",
          "updated_at": "<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>"
            }
          ],
          "alert_broadcast_enabled": true,
          "alert_broadcast_channel": {
            "id": "<string>",
            "name": "<string>"
          },
          "incident_broadcast_enabled": true,
          "incident_broadcast_channel": {
            "id": "<string>",
            "name": "<string>"
          }
        }
      ],
      "groups": [
        {
          "name": "<string>",
          "created_at": "<string>",
          "updated_at": "<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>"
            }
          ],
          "alert_broadcast_enabled": true,
          "alert_broadcast_channel": {
            "id": "<string>",
            "name": "<string>"
          },
          "incident_broadcast_enabled": true,
          "incident_broadcast_channel": {
            "id": "<string>",
            "name": "<string>"
          },
          "auto_add_members_when_attached": true
        }
      ],
      "environments": [
        {
          "name": "<string>",
          "created_at": "<string>",
          "updated_at": "<string>",
          "slug": "<string>",
          "description": "<string>",
          "notify_emails": [
            "<string>"
          ],
          "color": "<string>",
          "position": 123,
          "slack_channels": [
            {
              "id": "<string>",
              "name": "<string>"
            }
          ],
          "slack_aliases": [
            {
              "id": "<string>",
              "name": "<string>"
            }
          ]
        }
      ],
      "service_ids": [
        "<string>"
      ],
      "group_ids": [
        "<string>"
      ],
      "environment_ids": [
        "<string>"
      ],
      "external_id": "<string>",
      "external_url": "<string>",
      "alert_urgency_id": "<string>",
      "group_leader_alert_id": "<string>",
      "grouping_metadata": {},
      "is_group_leader_alert": true,
      "labels": [
        {
          "key": "<string>",
          "value": "<string>"
        }
      ],
      "data": {},
      "deduplication_key": "<string>",
      "alert_field_values_attributes": [
        {
          "alert_field_id": "<string>",
          "value": "<string>"
        }
      ]
    },
    "source": "rootly"
  }
}

Overview

AlertEvents

AlertFields

AlertGroups

AlertRoutes

AlertRoutingRules

AlertUrgencies

AlertSources

Alerts

Audits

Authorizations

CatalogEntities

CatalogEntityProperties

CatalogFields

Catalogs

Causes

Communications Groups

Communications Stages

Communications Templates

Communications Types

[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