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": "b3573c4f-d8ab-4e8e-977a-97bfd4fa4db9",
    "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": "e23df220-45e5-452f-93b7-627d1bf357c9",
          "team_id": 284,
          "name": "Consequatur dolor magni alias.",
          "slug": "consequatur-dolor-magni-alias",
          "description": "Molestias voluptatibus asperiores est.",
          "deleted_at": null,
          "created_at": "2025-05-08T00:23:32.511-07:00",
          "updated_at": "2025-05-08T00:23:32.511-07:00",
          "opsgenie_id": null,
          "pagerduty_id": null,
          "public_description": null,
          "github_repository_branch": "master",
          "github_repository_name": null,
          "color": "#D7F5E1",
          "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-70a9ac304b60c60461238b33a59a227d@email.rootly.com",
          "opsgenie_team_id": null,
          "service_now_ci_sys_id": null,
          "alert_urgency_id": null,
          "opslevel_id": null
        }
      ],
      "environments": [
        {
          "id": "3dcd6a67-21ba-4dab-a515-7e62e320af14",
          "team_id": 284,
          "name": "Distinctio cumque et excepturi.",
          "slug": "distinctio-cumque-et-excepturi",
          "description": "Amet quod fugit quia.",
          "color": "#0cb00c",
          "deleted_at": null,
          "created_at": "2025-05-08T00:23:32.527-07:00",
          "updated_at": "2025-05-08T00:23:32.527-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-05-08T00:13:48.000-07:00",
      "ended_at": "2025-05-08T00:15:48.000-07:00",
      "created_at": "2025-05-08T00:23:35.086-07:00",
      "updated_at": "2025-05-08T00:23:35.086-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

Response

201
application/vnd.api+json
pulse created

The response is of type object.