Heartbeats

Update a heartbeat

put/heartbeats/{heartbeatId}

Request

  • Base URL: https://api.pulsetic.com/api/public
  • URL: https://api.pulsetic.com/api/public/heartbeats/{heartbeatId}
  • Auth: API key in header Authorization

Path parameters

heartbeatIdinteger required
Example:1

Request body

namestring
monitoring_intervalinteger
grace_periodinteger
alert_emailboolean
alert_smsboolean
alert_voiceboolean
tagsstring[]

Replaces the heartbeat's tags with this list (existing tags with the same name are reused, unknown names are created automatically). Send an empty array to remove all tags; omit this field to leave existing tags untouched.

Example request

{
  "monitoring_interval": 120,
  "grace_period": 300,
  "tags": [
    "production",
    "critical"
  ]
}

Response

successful operation

idinteger
namestring
monitoring_intervalinteger

Expected heartbeat interval in seconds.

grace_periodinteger

Grace period in seconds before alerting.

alert_emailboolean
alert_smsboolean
alert_voiceboolean
created_atstring date-time
updated_atstring date-time

Example response

{
  "monitoring_interval": 60,
  "grace_period": 180,
  "tags": [
    {
      "name": "production"
    },
    {
      "name": "critical"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.