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_urgency_id": "<string>",
      "interval": 123,
      "interval_unit": "seconds",
      "notification_target_id": "<string>",
      "notification_target_type": "User",
      "enabled": true
    }
  }
}'
{
  "data": {
    "id": "35d1a77a-933d-4ebc-af91-902252088740",
    "type": "heartbeats",
    "attributes": {
      "slug": "nihil-minima-molestias-expedita",
      "name": "api.rootly.com",
      "description": "This is a description",
      "alert_summary": "API is down",
      "alert_urgency_id": "b26f1ea8-621e-42fb-84a0-45c43d1f090a",
      "interval": 10,
      "interval_unit": "minutes",
      "notification_target_id": "161",
      "notification_target_type": "User",
      "ping_url": "http://localhost:3001/v1/heartbeats/35d1a77a-933d-4ebc-af91-902252088740/ping",
      "secret": "heartbeat_1809f2ec73d8dc7675e24bead13caa4c2b74a8362537be462dab745f06a7ed7e",
      "last_pinged_at": null,
      "expires_at": null,
      "enabled": false,
      "status": "waiting",
      "updated_at": "2025-07-24T00:08:43.771-07:00",
      "created_at": "2025-07-24T00:08:36.726-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.