List heartbeat monitors
list_heartbeatsFind cron heartbeat monitors to get a monitor's id or ping_url, or spot late jobs by sorting DOWN first. Filter by name, tags, or status.
Instructions
Find heartbeat (cron / dead-man's-switch) monitors. Each has id, name, state (PENDING until a success ping makes it UP or a /fail ping makes it DOWN; later UP, DOWN or PAUSED), period_seconds, grace_seconds, ping_url, last_ping_at, last_success_at, overdue_at, tags and channel_ids. Use it to get a heartbeat's id or ping_url, or to see which jobs are late (sort status puts DOWN first). Probed URLs and hosts are monitors: use list_monitors for those. For one heartbeat's full record, with its last run's duration, use get_heartbeat. Returns a page: items plus total, page, size and pages.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| q | No | Case-insensitive substring of the name, up to 255 characters. | |
| tag | No | Keep items carrying these tags: a JSON array of up to 10 tags, each up to 50 characters, lowercased before matching. tag_match decides whether all or any of them must match. | |
| page | No | Page number, 1 or more; default 1. | |
| size | No | Rows per page, 1 to 100; default 25. Keep paging until you have seen total rows. | |
| sort | No | status (the default: DOWN, PENDING, UP, PAUSED, newest first within each), name, or created_at (newest first). | |
| tag_match | No | all (the default): an item must carry every tag in tag. any: at least one of them. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | Yes | ||
| size | Yes | ||
| items | Yes | ||
| pages | Yes | ||
| total | Yes |