Update a heartbeat
update_heartbeatRename a heartbeat, change its period or grace, or pause / resume it. Only the fields you pass change. Paused: pings are still recorded but nothing is judged or alerted (an open outage ends without a "back" alert); resumed, it waits for its next ping. Deleting a heartbeat stays in the dashboard.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| tz | No | The cron expression's IANA time zone | |
| cron | No | A cron expression to use instead of the period ("" switches back to the period) | |
| name | No | New name | |
| paused | No | true pauses it, false resumes it | |
| graceSec | No | Grace time in seconds (60 to 604800) | |
| periodSec | No | How often the job runs, in seconds (60 to 2678400); switches a cron schedule back to a period | |
| heartbeatId | Yes | The heartbeat's id (from list_heartbeats or add_heartbeat) |