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": "63bf2d1b-e5be-4e98-806e-3dba92c07791",
    "type": "heartbeats",
    "attributes": {
      "slug": "quas-fugiat-architecto-expedita",
      "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": "1ef4fa7a-eb64-4da3-9554-c27896fafc39",
      "interval": 10,
      "interval_unit": "minutes",
      "notification_target_id": "212",
      "notification_target_type": "User",
      "ping_url": "http://localhost:3001/v1/heartbeats/63bf2d1b-e5be-4e98-806e-3dba92c07791/ping",
      "secret": "heartbeat_485279eb8e91ea56416e7f7d9ac60772e38e6761436fd3227087dd87d56ffc4d",
      "email_address": "heartbeat-ac1e7477f1eece036a37fb0d10c08870@test.email.rootly.com",
      "last_pinged_at": null,
      "expires_at": null,
      "enabled": false,
      "status": "waiting",
      "updated_at": "2025-11-27T00:08:51.538-08:00",
      "created_at": "2025-11-27T00:08:44.574-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