PUT
/
v1
/
heartbeats
/
{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": "35e999ca-54bb-482f-aaa3-22671067f376",
    "type": "heartbeats",
    "attributes": {
      "slug": "occaecati-voluptates-tempore-enim",
      "name": "api.rootly.com",
      "description": "This is a description",
      "alert_summary": "API is down",
      "alert_urgency_id": "c7fd3f39-c7b3-4bce-941b-7b5924d50f1e",
      "interval": 10,
      "interval_unit": "minutes",
      "notification_target_id": "160",
      "notification_target_type": "User",
      "ping_url": "http://localhost:3001/v1/heartbeats/35e999ca-54bb-482f-aaa3-22671067f376/ping",
      "secret": "heartbeat_ac6133c8408e557e67146127fdd14928b86b34dd42048c54c419f91d81de9fa5",
      "last_pinged_at": null,
      "expires_at": null,
      "enabled": false,
      "status": "waiting",
      "updated_at": "2025-07-03T18:32:15.907-07:00",
      "created_at": "2025-07-03T18:32:07.585-07:00"
    }
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Body

application/vnd.api+json

Response

200
application/vnd.api+json

heartbeat updated

The response is of type object.