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": "797e797c-04ee-462f-aa27-8ce2f74b3814",
    "type": "heartbeats",
    "attributes": {
      "slug": "voluptatum-ex-cum-eos",
      "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": "1322cdca-ceec-43e4-b894-aae1a031e704",
      "interval": 10,
      "interval_unit": "minutes",
      "notification_target_id": "177",
      "notification_target_type": "User",
      "ping_url": "http://localhost:3001/v1/heartbeats/797e797c-04ee-462f-aa27-8ce2f74b3814/ping",
      "secret": "heartbeat_6dd9697f70e161f41bbc433b1d116bee26c3cb2db5d6db12619a2864cddb4a65",
      "last_pinged_at": null,
      "expires_at": null,
      "enabled": false,
      "status": "waiting",
      "updated_at": "2025-09-16T04:46:33.453-07:00",
      "created_at": "2025-09-16T04:46:26.788-07: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