Skip to main content
POST
/
v1
/
pulses
Creates a pulse
curl --request POST \
  --url https://api.rootly.com/v1/pulses \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/vnd.api+json' \
  --data '
{
  "data": {
    "type": "pulses",
    "attributes": {
      "summary": "<string>",
      "source": "<string>",
      "service_ids": [
        "<string>"
      ],
      "environment_ids": [
        "<string>"
      ],
      "started_at": "2023-11-07T05:31:56Z",
      "ended_at": "2023-11-07T05:31:56Z",
      "external_url": "<string>",
      "labels": [
        {
          "key": "<string>",
          "value": "<string>"
        }
      ],
      "refs": [
        {
          "key": "<string>",
          "value": "<string>"
        }
      ],
      "data": {}
    }
  }
}
'
{
  "data": {
    "id": "e7935633-24b2-47b5-b819-6f1efa783c37",
    "type": "pulses",
    "attributes": {
      "short_id": null,
      "source": "k8s",
      "summary": "Deploy k8s",
      "labels": [
        {
          "key": "status",
          "value": "succeeded"
        }
      ],
      "refs": [
        {
          "key": "sha",
          "value": "cd62148cbc5eb42168fe99fdb50a364e12b206ac"
        },
        {
          "key": "image",
          "value": "registry.rootly.com/rootly/my-service:cd6214"
        }
      ],
      "services": [
        {
          "id": "c81eb2ec-7d75-4a1a-9b22-4af8d63b0a62",
          "alert_broadcast_channel": {},
          "alert_broadcast_enabled": false,
          "alert_urgency_id": null,
          "alerts_email_address": "[email protected]",
          "alerts_email_enabled": false,
          "backstage_id": null,
          "color": "#F4CFD1",
          "cortex_id": null,
          "created_at": "2025-12-04T10:26:46.922-08:00",
          "datadog_id": null,
          "deleted_at": null,
          "description": "Consequatur ducimus veritatis quae.",
          "external_id": null,
          "github_repository_branch": "master",
          "github_repository_name": null,
          "gitlab_repository_branch": "master",
          "gitlab_repository_name": null,
          "heroku_app_name": null,
          "incident_broadcast_channel": {},
          "incident_broadcast_enabled": false,
          "incidents_count": 0,
          "kubernetes_deployment_name": null,
          "name": "Debitis rerum perspiciatis laudantium.",
          "notify_emails": [],
          "opsgenie_id": null,
          "opsgenie_team_id": null,
          "opslevel_id": null,
          "pagerduty_id": null,
          "position": 1,
          "public_description": null,
          "service_now_ci_sys_id": null,
          "show_uptime": true,
          "show_uptime_last_days": 60,
          "slack_aliases": [],
          "slack_channels": [],
          "slug": "debitis-rerum-perspiciatis-laudantium",
          "status": "operational",
          "team_id": 400,
          "updated_at": "2025-12-04T10:26:46.922-08:00"
        }
      ],
      "environments": [
        {
          "id": "c5b7f6c5-d4db-4aab-99f4-53644c7db35b",
          "color": "#d5d5fb",
          "created_at": "2025-12-04T10:26:46.936-08:00",
          "deleted_at": null,
          "description": "In praesentium voluptatem illo.",
          "external_id": null,
          "incidents_count": 0,
          "name": "Sit et magnam voluptate.",
          "notify_emails": [],
          "position": 1,
          "slack_aliases": [],
          "slack_channels": [],
          "slug": "sit-et-magnam-voluptate",
          "team_id": 400,
          "updated_at": "2025-12-04T10:26:46.936-08:00"
        }
      ],
      "data": {
        "url": "https://additionaldata.com"
      },
      "external_url": "https://external-url.com",
      "started_at": "2025-12-04T10:17:27.000-08:00",
      "ended_at": "2025-12-04T10:19:27.000-08:00",
      "created_at": "2025-12-04T10:26:48.220-08:00",
      "updated_at": "2025-12-04T10:26:48.220-08:00"
    }
  }
}

Authorizations

Authorization
string
header
required

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

Body

application/vnd.api+json
data
object
required

Response

pulse created

data
object
required