Update a specific heartbeat by id
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": "minutes",
"notification_target_id": "<string>",
"notification_target_type": "User",
"enabled": true
}
}
}
'{
"data": {
"id": "c64c2cd1-39ad-49c9-80ad-8176ca743261",
"type": "heartbeats",
"attributes": {
"slug": "facere-architecto-quam-quo",
"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": "128b2ef4-6e02-490e-affc-2b69d503643f",
"interval": 10,
"interval_unit": "minutes",
"notification_target_id": "223",
"notification_target_type": "User",
"ping_url": "http://localhost:3001/v1/heartbeats/c64c2cd1-39ad-49c9-80ad-8176ca743261/ping",
"secret": "heartbeat_be0d13e866d9e659e45c9fd2b69b78a2b76d6711da91ca7335e7937e861b04f2",
"email_address": "[email protected]",
"last_pinged_at": null,
"expires_at": null,
"enabled": false,
"status": "waiting",
"updated_at": "2025-12-16T14:10:29.258-08:00",
"created_at": "2025-12-16T14:10:24.980-08:00"
}
}
}Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Resource UUID
Show child attributes
heartbeats Show child attributes
The name of the heartbeat
The description of the heartbeat
Summary of alerts triggered when heartbeat expires.
Description of alerts triggered when heartbeat expires.
Urgency of alerts triggered when heartbeat expires.
minutes, hours User, Group, Service, EscalationPolicy Whether to trigger alerts when heartbeat is expired.
heartbeat updated
Show child attributes
Unique ID of the heartbeat
heartbeats Show child attributes
The name of the heartbeat
Summary of alerts triggered when heartbeat expires.
minutes, hours User, Group, Service, EscalationPolicy Whether to trigger alerts when heartbeat is expired.
waiting, active, expired Email address to receive heartbeat pings.
Date of creation
Date of last update
The description of the heartbeat
Description of alerts triggered when heartbeat expires.
Urgency of alerts triggered when heartbeat expires.
URL to receive heartbeat pings.
Secret used as bearer token when pinging heartbeat.
When the heartbeat was last pinged.
When heartbeat expires
Was this page helpful?
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": "minutes",
"notification_target_id": "<string>",
"notification_target_type": "User",
"enabled": true
}
}
}
'{
"data": {
"id": "c64c2cd1-39ad-49c9-80ad-8176ca743261",
"type": "heartbeats",
"attributes": {
"slug": "facere-architecto-quam-quo",
"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": "128b2ef4-6e02-490e-affc-2b69d503643f",
"interval": 10,
"interval_unit": "minutes",
"notification_target_id": "223",
"notification_target_type": "User",
"ping_url": "http://localhost:3001/v1/heartbeats/c64c2cd1-39ad-49c9-80ad-8176ca743261/ping",
"secret": "heartbeat_be0d13e866d9e659e45c9fd2b69b78a2b76d6711da91ca7335e7937e861b04f2",
"email_address": "[email protected]",
"last_pinged_at": null,
"expires_at": null,
"enabled": false,
"status": "waiting",
"updated_at": "2025-12-16T14:10:29.258-08:00",
"created_at": "2025-12-16T14:10:24.980-08:00"
}
}
}