Pause a heartbeat monitor
pause_heartbeatPause a heartbeat to suppress late reports and close open incidents without alerts when a job is intentionally stopped, like a runner taken out of service.
Instructions
Pause one heartbeat: it is no longer reported late, pings to its ping_url are accepted but ignored, and its open incident closes without an alert. Use it when the job is stopped on purpose, such as a runner taken out of service; resume_heartbeat undoes it, while delete_heartbeat removes the heartbeat for good. Maintenance windows do not cover heartbeats. Requires a key with the write scope. Pausing a paused heartbeat changes nothing. Returns the heartbeat.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| 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. |
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 |