Skip to main content
PUT
/
v1
/
heartbeats
/
{id}
Update a heartbeat
curl --request PUT \
  --url https://api.rootly.com/v1/heartbeats/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/vnd.api+json' \
  --data '{
  "data": {
    "type": "heartbeats",
    "attributes": {
      "name": "<string>",
      "description": "<string>",
      "alert_summary": "<string>",
      "alert_description": "<string>",
      "alert_urgency_id": "<string>",
      "interval": 123,
      "interval_unit": "seconds",
      "notification_target_id": "<string>",
      "notification_target_type": "User",
      "enabled": true
    }
  }
}'
{
  "data": {
    "id": "2c3f2d56-6554-4175-a0a5-d7b1dd46e60a",
    "type": "heartbeats",
    "attributes": {
      "slug": "doloremque-quis-quaerat-facilis",
      "name": "api.rootly.com",
      "description": "This is a description",
      "alert_summary": "API is down",
      "alert_description": "Updated runbook: Check /docs/updated-troubleshooting",
      "alert_urgency_id": "c7c8b869-0903-4854-9eb7-8fd1f031d0a7",
      "interval": 10,
      "interval_unit": "minutes",
      "notification_target_id": "210",
      "notification_target_type": "User",
      "ping_url": "http://localhost:3001/v1/heartbeats/2c3f2d56-6554-4175-a0a5-d7b1dd46e60a/ping",
      "secret": "heartbeat_81ea9df806afc68b6d72940606a03e3c1b502d9ccc9a7d4612ee8027b3fed38c",
      "email_address": "heartbeat-5bcd6ad2e543fe8b718e7644a9503603@test.email.rootly.com",
      "last_pinged_at": null,
      "expires_at": null,
      "enabled": false,
      "status": "waiting",
      "updated_at": "2025-11-04T05:42:42.741-08:00",
      "created_at": "2025-11-04T05:42:35.966-08:00"
    }
  }
}

Authorizations

Authorization
string
header
required

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

Path Parameters

id
required

Resource UUID

Body

application/vnd.api+json
data
object
required

Response

heartbeat updated

data
object
required