POST
/
v1
/
pulses
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": "15500e5d-32c1-4ddc-b8dd-8e46e44f33c4",
    "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": "10ac1635-a57c-4744-9ac0-f2ddfbb51cee",
          "team_id": 284,
          "name": "Atque dolorem architecto ipsum.",
          "slug": "atque-dolorem-architecto-ipsum",
          "description": "Voluptatibus animi ab beatae.",
          "deleted_at": null,
          "created_at": "2025-04-18T09:51:36.676-07:00",
          "updated_at": "2025-04-18T09:51:36.676-07:00",
          "opsgenie_id": null,
          "pagerduty_id": null,
          "public_description": null,
          "github_repository_branch": "master",
          "github_repository_name": null,
          "color": "#F4CFD1",
          "heroku_app_name": null,
          "gitlab_repository_name": null,
          "gitlab_repository_branch": "master",
          "kubernetes_deployment_name": null,
          "incidents_count": 0,
          "position": 1,
          "slack_channels": [],
          "slack_aliases": [],
          "backstage_id": null,
          "show_uptime": true,
          "show_uptime_last_days": 60,
          "status": "operational",
          "external_id": null,
          "notify_emails": [],
          "cortex_id": null,
          "alerts_email_enabled": false,
          "alerts_email_address": "service-230ca8715bb3682afb1a2c24dbc16fc1@email.rootly.com",
          "opsgenie_team_id": null,
          "service_now_ci_sys_id": null,
          "alert_urgency_id": null,
          "opslevel_id": null
        }
      ],
      "environments": [
        {
          "id": "567cee8a-a60c-415d-9625-a2d5928c70c6",
          "team_id": 284,
          "name": "Nostrum alias dignissimos natus.",
          "slug": "nostrum-alias-dignissimos-natus",
          "description": "Voluptas quo odio ab.",
          "color": "#e0a9a9",
          "deleted_at": null,
          "created_at": "2025-04-18T09:51:36.690-07:00",
          "updated_at": "2025-04-18T09:51:36.690-07:00",
          "incidents_count": 0,
          "position": 1,
          "slack_channels": [],
          "slack_aliases": [],
          "external_id": null,
          "notify_emails": []
        }
      ],
      "data": {
        "url": "https://additionaldata.com"
      },
      "external_url": "https://external-url.com",
      "started_at": "2025-04-18T09:42:16.000-07:00",
      "ended_at": "2025-04-18T09:44:16.000-07:00",
      "created_at": "2025-04-18T09:51:39.135-07:00",
      "updated_at": "2025-04-18T09:51:39.135-07: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

201
application/vnd.api+json
pulse created
​
data
object
required

Was this page helpful?