Better Stack · Schema

HeartbeatUpdateRequest

Request body for updating a heartbeat (all fields optional).

IncidentsLogsMonitoringPlatformStatusUptimeObservabilityOn-CallHeartbeats

Properties

Name Type Description
name string New name for the heartbeat.
period integer New period in seconds.
grace integer New grace period in seconds.
View JSON Schema on GitHub

JSON Schema

better-stack-heartbeat-update-request-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/better-stack/refs/heads/main/json-schema/better-stack-heartbeat-update-request-schema.json",
  "title": "HeartbeatUpdateRequest",
  "description": "Request body for updating a heartbeat (all fields optional).",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "New name for the heartbeat.",
      "example": "Updated Backup Job"
    },
    "period": {
      "type": "integer",
      "description": "New period in seconds.",
      "example": 86400
    },
    "grace": {
      "type": "integer",
      "description": "New grace period in seconds.",
      "example": 7200
    }
  }
}