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": "21accc52-2d88-4fe3-9a21-b2e860764737",
    "type": "heartbeats",
    "attributes": {
      "slug": "omnis-ex-est-ut",
      "name": "api.rootly.com",
      "description": "This is a description",
      "alert_summary": "API is down",
      "alert_urgency_id": "fd88194b-49dc-47d7-ae3f-5dd1ff34bedd",
      "interval": 10,
      "interval_unit": "minutes",
      "notification_target_id": "151",
      "notification_target_type": "User",
      "ping_url": "http://localhost:3001/v1/heartbeats/21accc52-2d88-4fe3-9a21-b2e860764737/ping",
      "secret": "heartbeat_42a938db359fcde75a476314bb222187738f84788a04526e66582038b6dbf3b0",
      "last_pinged_at": null,
      "expires_at": null,
      "enabled": false,
      "status": "waiting",
      "updated_at": "2025-05-08T00:19:56.754-07:00",
      "created_at": "2025-05-08T00:19:47.098-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.