List monitors
list_monitorsFind monitors by name, target, type, status, or tag to retrieve IDs, identify down or degraded services, or find soonest SSL certificate expirations.
Instructions
Find monitors in the organization by name, target, type, status or tag. Each row is short: id, name, type, target, status, is_active, tags, interval_seconds, ssl_expires_at and last_checked_at. Use it first to get a monitor's id, or to answer what is broken now (status ["DOWN", "DEGRADED"]) or which certificates expire first (type ["SSL"], sort ssl_expiry). For one monitor's full settings use get_monitor; for heartbeats use list_heartbeats. Returns a page: items plus total, page, size and pages. An invalid value is a 422 naming the argument. Example: {"status": ["DOWN", "DEGRADED"], "size": 100}
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| q | No | Case-insensitive substring of the name or the target, 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: PENDING, DOWN, DEGRADED, UP, PAUSED, then by name), up_first (healthy first), name, newest, oldest, or ssl_expiry (soonest-expiring certificates first; monitors with no known expiry, non-SSL types or not checked yet, last). | |
| type | No | Keep monitors of any of these types: a JSON array. | |
| status | No | Keep monitors in any of these states: a JSON array. PENDING means no verdict yet. | |
| tag_match | No | all (the default): an item must carry every tag in tag. any: at least one of them. |