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_urgency_id": "<string>",
"interval": 123,
"interval_unit": "seconds",
"notification_target_id": "<string>",
"notification_target_type": "User",
"enabled": true
}
}
}'
{
"data": {
"id": "f260f299-0af1-4825-b605-1f745cd089ec",
"type": "heartbeats",
"attributes": {
"slug": "consectetur-nulla-molestiae-ipsa",
"name": "api.rootly.com",
"description": "This is a description",
"alert_summary": "API is down",
"alert_urgency_id": "d991a656-8459-4aa0-b2e3-7622eeaf8e2e",
"interval": 10,
"interval_unit": "minutes",
"notification_target_id": "177",
"notification_target_type": "User",
"ping_url": "http://localhost:3001/v1/heartbeats/f260f299-0af1-4825-b605-1f745cd089ec/ping",
"secret": "heartbeat_35562a10c920d2404e12357ca549354d98bba4aa0ba181f12f73688d40e3211a",
"last_pinged_at": null,
"expires_at": null,
"enabled": false,
"status": "waiting",
"updated_at": "2025-09-03T02:21:26.243-07:00",
"created_at": "2025-09-03T02:21:20.028-07:00"
}
}
}
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Resource UUID
heartbeat updated
The response is of type object
.
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_urgency_id": "<string>",
"interval": 123,
"interval_unit": "seconds",
"notification_target_id": "<string>",
"notification_target_type": "User",
"enabled": true
}
}
}'
{
"data": {
"id": "f260f299-0af1-4825-b605-1f745cd089ec",
"type": "heartbeats",
"attributes": {
"slug": "consectetur-nulla-molestiae-ipsa",
"name": "api.rootly.com",
"description": "This is a description",
"alert_summary": "API is down",
"alert_urgency_id": "d991a656-8459-4aa0-b2e3-7622eeaf8e2e",
"interval": 10,
"interval_unit": "minutes",
"notification_target_id": "177",
"notification_target_type": "User",
"ping_url": "http://localhost:3001/v1/heartbeats/f260f299-0af1-4825-b605-1f745cd089ec/ping",
"secret": "heartbeat_35562a10c920d2404e12357ca549354d98bba4aa0ba181f12f73688d40e3211a",
"last_pinged_at": null,
"expires_at": null,
"enabled": false,
"status": "waiting",
"updated_at": "2025-09-03T02:21:26.243-07:00",
"created_at": "2025-09-03T02:21:20.028-07:00"
}
}
}