Monitors

List Monitors

List monitors for the active organization.

Filter by search text, by type and by status (repeat a parameter to allow several values), and by tags: with tag_match=all (default) a monitor must carry every tag given, with tag_match=any at least one. Problems come first by default; sort=ssl_expiry puts the soonest-expiring certificates first. view=compact returns short rows without configuration or uptime history.

get/v1/monitors

Request

  • Base URL: https://api.fettle.sh (the document declares no server; this is the origin it was published from)
  • URL: https://api.fettle.sh/v1/monitors
  • Auth: API key in header Authorization

Query parameters

qstring nullable
sort'status' | 'up_first' | 'name' | 'newest' | 'oldest' | 'ssl_expiry'

Ordering options for the monitors list endpoint.

STATUS is the default and surfaces actionable monitors first (PENDING → DOWN → DEGRADED → UP → PAUSED), then by name, then newest. UP_FIRST inverts the severity so healthy monitors lead. NAME, NEWEST and OLDEST are plain orderings.

SSL_EXPIRY orders by certificate expiry, soonest first; monitors with no known expiry (non-SSL types, not yet probed) come last.

tagstring[] nullable
tag_match'all' | 'any'

How a multi-tag filter combines: every tag (ALL) or any of them.

typeCheckType[] nullable
statusMonitorStatus[] nullable
view'full' | 'compact'

Shape of a monitors-list page: the full card or a compact row.

pageinteger
sizeinteger

Headers

X-Organization-Idstring uuid nullable

Response

A page of monitors: full rows by default, compact rows for view=compact.

OR

Changes

No recorded changes to this operation across all 1 revision of this API.