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": "9a4fe983-efad-4982-a848-5749fb34d4b8",
"type": "heartbeats",
"attributes": {
"slug": "laudantium-non-mollitia-cum",
"name": "api.rootly.com",
"description": "This is a description",
"alert_summary": "API is down",
"alert_urgency_id": "52410ef9-110a-4ade-a3de-b28a18c4f754",
"interval": 10,
"interval_unit": "minutes",
"notification_target_id": "161",
"notification_target_type": "User",
"ping_url": "http://localhost:3001/v1/heartbeats/9a4fe983-efad-4982-a848-5749fb34d4b8/ping",
"secret": "heartbeat_44df648f8137d6a0986b46c3f7d80d0caca8889935ced6c40feb22bbfe6ab507",
"last_pinged_at": null,
"expires_at": null,
"enabled": false,
"status": "waiting",
"updated_at": "2025-08-13T16:11:31.822-07:00",
"created_at": "2025-08-13T16:11:26.260-07:00"
}
}
}
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
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": "9a4fe983-efad-4982-a848-5749fb34d4b8",
"type": "heartbeats",
"attributes": {
"slug": "laudantium-non-mollitia-cum",
"name": "api.rootly.com",
"description": "This is a description",
"alert_summary": "API is down",
"alert_urgency_id": "52410ef9-110a-4ade-a3de-b28a18c4f754",
"interval": 10,
"interval_unit": "minutes",
"notification_target_id": "161",
"notification_target_type": "User",
"ping_url": "http://localhost:3001/v1/heartbeats/9a4fe983-efad-4982-a848-5749fb34d4b8/ping",
"secret": "heartbeat_44df648f8137d6a0986b46c3f7d80d0caca8889935ced6c40feb22bbfe6ab507",
"last_pinged_at": null,
"expires_at": null,
"enabled": false,
"status": "waiting",
"updated_at": "2025-08-13T16:11:31.822-07:00",
"created_at": "2025-08-13T16:11:26.260-07:00"
}
}
}