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": "e51e7206-ecfc-4a2e-95df-eed03a9477d8",
    "type": "heartbeats",
    "attributes": {
      "slug": "esse-molestiae-aut-velit",
      "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": "d30e5e84-789d-4e03-853f-5653c12e113d",
      "interval": 10,
      "interval_unit": "minutes",
      "notification_target_id": "212",
      "notification_target_type": "User",
      "ping_url": "http://localhost:3001/v1/heartbeats/e51e7206-ecfc-4a2e-95df-eed03a9477d8/ping",
      "secret": "heartbeat_d81e3541c63ef487daf79398fc4ec7fb6e21075705da2aff86ab5686f2bfc711",
      "email_address": "heartbeat-dcd58babdc2c7e829645a6d425ad3768@test.email.rootly.com",
      "last_pinged_at": null,
      "expires_at": null,
      "enabled": false,
      "status": "waiting",
      "updated_at": "2025-11-25T08:54:34.421-08:00",
      "created_at": "2025-11-25T08:54:26.923-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