List pulses - Rootly

GET

pulses

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

{
  "data": [
    {
      "id": "<string>",
      "type": "pulses",
      "attributes": {
        "source": "<string>",
        "summary": "<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>"
            ],
            "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>"
          }
        ],
        "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>"
          }
        ],
        "external_url": "<string>",
        "labels": [
          {
            "key": "<string>",
            "value": "<string>"
          }
        ],
        "refs": [
          {
            "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

string

filter[source]

string

filter[services]

string

filter[environments]

string

filter[labels]

string

filter[refs]

string

filter[started_at][gt]

string

filter[started_at][gte]

string

filter[started_at][lt]

string

filter[started_at][lte]

string

filter[ended_at][gt]

string

filter[ended_at][gte]

string

filter[ended_at][lt]

string

filter[ended_at][lte]

string

filter[created_at][gt]

string

filter[created_at][gte]

string

filter[created_at][lt]

string

filter[created_at][lte]

string

page[number]

integer

page[size]

integer

Response

200 - application/vnd.api+json

success

data

object[]

required

data.id

string

required

Unique ID of the pulse

data.type

enum<string>

required

Available options:

pulses

data.attributes

object

required

data.attributes.summary

string

required

The summary of the pulse

data.attributes.created_at

string

required

Date of creation

data.attributes.updated_at

string

required

Date of last update

data.attributes.source

string | null

The source of the pulse (eg: k8s)

data.attributes.services

object[]

Services attached to the pulse

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.owners_group_ids

string[] | null

Owner Teams associated with this service

data.attributes.services.owners_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

data.attributes.services.slack_aliases

object[] | null

Slack Aliases associated with this service

data.attributes.environments

object[]

Environments attached to the pulse

data.attributes.external_url

string | null

The external url of the pulse

data.attributes.labels

array

data.attributes.refs

array

data.attributes.data

object | null

Additional data

links

object

required

Was this page helpful?

Creates a pulseCreates a new pulse from provided data

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

{
  "data": [
    {
      "id": "<string>",
      "type": "pulses",
      "attributes": {
        "source": "<string>",
        "summary": "<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>"
            ],
            "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>"
          }
        ],
        "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>"
          }
        ],
        "external_url": "<string>",
        "labels": [
          {
            "key": "<string>",
            "value": "<string>"
          }
        ],
        "refs": [
          {
            "key": "<string>",
            "value": "<string>"
          }
        ],
        "data": {},
        "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