list_netwatch
Read-onlyIdempotent
Retrieves netwatch probes with live status and measurements, with filters for host, type, comment, or status to identify failing links.
Instructions
Lists the netwatch probes with their live status and measurements.
Each entry reports status (up / down / unknown), since — the timestamp
of the last transition — and, on an ICMP probe, the last test's numbers:
rtt-avg, loss-percent, failed-tests. None of that is in an export.
Notes:
host_filter and comment_filter are substring matches; status_filter
and type_filter are exact. Pass status_filter="down" to list only
what is currently failing.
`include_source=False` (the default) omits `up-script`,
`down-script` and `test-script`, because a probe that alerts through a
webhook or an e-mail carries the token or the password inline. Set it
to True only when you intend to read those commands; the output is
redacted either way, but redaction is pattern-based and is not a
guarantee.
A probe with no `src-address` follows whichever WAN is active, so it
keeps reporting across a failover; one pinned to a source address
reports that path only. Which of the two you want depends on whether
you are watching the internet or a specific link.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| device | No | ||
| host_filter | No | ||
| type_filter | No | ||
| status_filter | No | ||
| comment_filter | No | ||
| include_source | No |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |