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": "a25feb80-9d79-4ac0-81d6-87842ab41a80",
    "type": "heartbeats",
    "attributes": {
      "slug": "et-hic-rerum-officiis",
      "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": "747958f9-67d3-49c2-ac6f-b647d2b3bf65",
      "interval": 10,
      "interval_unit": "minutes",
      "notification_target_id": "212",
      "notification_target_type": "User",
      "ping_url": "http://localhost:3001/v1/heartbeats/a25feb80-9d79-4ac0-81d6-87842ab41a80/ping",
      "secret": "heartbeat_91b8452fa9e493323080edc08fce65e47e39ded025c07ca844aab88842579718",
      "email_address": "[email protected]",
      "last_pinged_at": null,
      "expires_at": null,
      "enabled": false,
      "status": "waiting",
      "updated_at": "2025-12-02T10:25:55.533-08:00",
      "created_at": "2025-12-02T10:25:46.811-08:00"
    }
  }
}

Authorizations

Authorization
string
header
required

Path Parameters

id
required

Body

application/vnd.api+json
data
object
required

Response

data
object
required