Update a heartbeat monitor
update_heartbeatModify a heartbeat's name, timing, channels, or tags without resetting its current deadline; only supplied fields change. Use pause/resume to stop or restart late alerts.
Instructions
Change one heartbeat's name, timing, channels or tags; only the fields you pass change. A new period or grace applies from the next ping: the current deadline (overdue_at) is not recomputed. To stop or restart late alerts use pause_heartbeat or resume_heartbeat instead; ping_url never changes. Requires a key with the write scope. An invalid argument is a 422 naming it; never send null. Returns the heartbeat. Example: {"heartbeat_id": "", "grace_seconds": 7200}
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | Display name, 1 to 255 characters. | |
| tags | No | Replaces the whole tag list when passed, at most 10; [] clears it; omit it to keep the tags. Each tag is trimmed, lowercased and deduplicated on write, at most 50 characters of a-z, 0-9 and : _ . / -, starting with a letter or digit. Reuse names from list_tags rather than inventing near-duplicates. | |
| channel_ids | No | Notification channel uuids from list_channels. When passed it replaces the whole binding; [] clears it, after which every verified, active channel is alerted; omit it to keep the binding. An id that is not an active channel of this organization is a 404. | |
| heartbeat_id | Yes | The heartbeat's uuid from list_heartbeats. An id that is not a heartbeat of this organization, or a deleted one, is a 404. | |
| grace_seconds | No | Extra seconds of silence tolerated after the period before the heartbeat is reported late, 0 to 2592000; it may exceed the period. | |
| period_seconds | No | How often the job runs, 60 to 2592000 seconds. To ping every N seconds and be alerted after T seconds of silence, set period_seconds = N and grace_seconds = T - N (T at least N). | |
| notification_cooldown_seconds | No | 60 to 86400 seconds; 1800 when not set on create. Only holds back a duplicate first alert for the same incident within that window. Repeat reminders while an incident stays open and unacknowledged follow the plan's renotify_interval_seconds and renotify_max_count (get_plan_usage; 0 means no reminders) instead, and the recovery alert is never held back. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | ||
| name | Yes | ||
| tags | No | ||
| state | Yes | Known values: PENDING, UP, DOWN, PAUSED. | |
| ping_url | Yes | ||
| is_active | Yes | ||
| created_at | Yes | ||
| overdue_at | Yes | ||
| updated_at | Yes | ||
| channel_ids | No | ||
| last_ping_at | Yes | ||
| grace_seconds | Yes | ||
| last_start_at | Yes | ||
| period_seconds | Yes | ||
| last_success_at | Yes | ||
| last_duration_ms | Yes | ||
| notification_cooldown_seconds | Yes |