Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
Resource UUID
Body
application/vnd.api+json
Response
heartbeat updated
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": "seconds",
"notification_target_id": "<string>",
"notification_target_type": "User",
"enabled": true
}
}
}'
{
"data": {
"id": "3a93a0c6-9911-43d2-ade8-429e481e99cf",
"type": "heartbeats",
"attributes": {
"slug": "autem-corporis-necessitatibus-ducimus",
"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": "9e1fb8ab-7e27-4614-8503-7ce6a5cfe2dd",
"interval": 10,
"interval_unit": "minutes",
"notification_target_id": "203",
"notification_target_type": "User",
"ping_url": "http://localhost:3001/v1/heartbeats/3a93a0c6-9911-43d2-ade8-429e481e99cf/ping",
"secret": "heartbeat_4803e949c1a8ce7d777d28d1df259c399ff131d3b0504395bec9e3a8068760b6",
"email_address": "heartbeat-43f5bb8854ae03b247d5417595e8ac33@test.email.rootly.com",
"last_pinged_at": null,
"expires_at": null,
"enabled": false,
"status": "waiting",
"updated_at": "2025-10-06T09:28:46.238-07:00",
"created_at": "2025-10-06T09:28:38.966-07:00"
}
}
}
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Resource UUID
Show child attributes
heartbeat updated
Show child attributes
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": "seconds",
"notification_target_id": "<string>",
"notification_target_type": "User",
"enabled": true
}
}
}'
{
"data": {
"id": "3a93a0c6-9911-43d2-ade8-429e481e99cf",
"type": "heartbeats",
"attributes": {
"slug": "autem-corporis-necessitatibus-ducimus",
"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": "9e1fb8ab-7e27-4614-8503-7ce6a5cfe2dd",
"interval": 10,
"interval_unit": "minutes",
"notification_target_id": "203",
"notification_target_type": "User",
"ping_url": "http://localhost:3001/v1/heartbeats/3a93a0c6-9911-43d2-ade8-429e481e99cf/ping",
"secret": "heartbeat_4803e949c1a8ce7d777d28d1df259c399ff131d3b0504395bec9e3a8068760b6",
"email_address": "heartbeat-43f5bb8854ae03b247d5417595e8ac33@test.email.rootly.com",
"last_pinged_at": null,
"expires_at": null,
"enabled": false,
"status": "waiting",
"updated_at": "2025-10-06T09:28:46.238-07:00",
"created_at": "2025-10-06T09:28:38.966-07:00"
}
}
}