Sign in

v3

latestOpenAPI 3.0.12026-07-31240345599.7 KB
Heartbeats

Update heartbeat

Updates the heartbeat with the given name. Name of a heartbeat cannot be changed

patch/api/{cloudId}/v1/teams/{teamId}/heartbeats

Path parameters

teamIdstring required

Identifier of the heartbeat owning team.

Query parameters

namestring required

Name of the heartbeat for identification.

Request body

descriptionstring

An optional description of the heartbe.at

intervalinteger

Specifies how often a heartbeat message should be expected.

intervalUnit'hours' | 'minutes' | 'days'
enabledboolean

Enable/disable heartbeat monitoring.

alertMessagestring

Specifies the alert message for heartbeat expiration alert.

alertTagsstring[]

Specifies the alert tags for heartbeat expiration alert.

alertPriority'P1' | 'P2' | 'P3' | 'P4' | 'P5'

Specifies the alert priority for heartbeat expiration alert.

Example request

{
  "description": "It checks whether server is online or not.",
  "interval": 5,
  "intervalUnit": "minutes",
  "enabled": true,
  "alertMessage": "HeartbeatName is expired",
  "alertTags": [
    "critical",
    "dns"
  ]
}

Response

Returned if the request is successful.

namestring

Name of the heartbeat.

descriptionstring

Description of the heartbeat.

intervalinteger

Specifies how often a heartbeat message should be expected.

intervalUnit'Days' | 'Minutes' | 'Hours'
enabledboolean

Enable/disable heartbeat monitoring.

status'Unresponsive' | 'Responsive' | 'Off' | 'Pending'
ownerTeamIdstring

Owner team of the heartbeat, consisting id of the owner team

alertMessagestring

Specifies the alert message for heartbeat expiration alert.

alertTagsstring[]

Specifies the alert tags for heartbeat expiration alert.

alertPriority'P1' | 'P2' | 'P3' | 'P4' | 'P5'

Specifies the alert priority for heartbeat expiration alert.

Example response

{
  "name": "Service Heartbeat",
  "description": "Heartbeat for checking service health",
  "interval": 5,
  "intervalUnit": "Days",
  "status": "Responsive",
  "ownerTeamId": "4b26961a-a837-49d2-a1fe-0973013e3c3b",
  "alertMessage": "Service does not respond",
  "alertTags": [
    "HighPriority",
    "Database"
  ],
  "alertPriority": "P2"
}