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": {
      "source": "<string>",
      "summary": "<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": "54bbfa24-83d1-4b8b-a47b-75831586d19f",
    "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": "b2bcf45d-4797-4b2b-a0da-7f28413959b6",
          "alert_broadcast_channel": {},
          "alert_broadcast_enabled": false,
          "alert_urgency_id": null,
          "alerts_email_address": "service-a2f888103a579bf8aea3159ba433c062@email.rootly.com",
          "alerts_email_enabled": false,
          "backstage_id": null,
          "color": "#FAEBB7",
          "cortex_id": null,
          "created_at": "2025-11-27T00:11:41.940-08:00",
          "datadog_id": null,
          "deleted_at": null,
          "description": "Animi qui omnis minus.",
          "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": "Accusamus quis dolore at.",
          "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": "accusamus-quis-dolore-at",
          "status": "operational",
          "team_id": 387,
          "updated_at": "2025-11-27T00:11:41.940-08:00"
        }
      ],
      "environments": [
        {
          "id": "ff39feb5-32de-40b0-929b-9e9d59fc38f0",
          "color": "#101094",
          "created_at": "2025-11-27T00:11:41.954-08:00",
          "deleted_at": null,
          "description": "Eos dolor eum in.",
          "external_id": null,
          "incidents_count": 0,
          "name": "Officia officiis ut aut.",
          "notify_emails": [],
          "position": 1,
          "slack_aliases": [],
          "slack_channels": [],
          "slug": "officia-officiis-ut-aut",
          "team_id": 387,
          "updated_at": "2025-11-27T00:11:41.954-08:00"
        }
      ],
      "data": {
        "url": "https://additionaldata.com"
      },
      "external_url": "https://external-url.com",
      "started_at": "2025-11-27T00:02:36.000-08:00",
      "ended_at": "2025-11-27T00:04:36.000-08:00",
      "created_at": "2025-11-27T00:11:43.330-08:00",
      "updated_at": "2025-11-27T00:11:43.330-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