Skip to main content
GET
List monitors for the authenticated org

Authorizations

Authorization
string
header
required

API key (dh_live_...) or Auth0 JWT token

Headers

X-DevHelm-Client
string

Calling surface and version, e.g. cli/1.4.0 or sdk-js/2.0.0

Query Parameters

enabled
boolean

Filter by enabled state (true/false)

status
string

Lifecycle status alias: 'active' (enabled=true) or 'paused' (enabled=false). Ignored when ?enabled is also supplied.

type
enum<string>

Filter by monitor type

Available options:
HTTP,
DNS,
MCP_SERVER,
TCP,
ICMP,
HEARTBEAT,
BROWSER,
MULTI_STEP_API
types
enum<string>[]

Filter by monitor types, comma-separated; matches any listed type

Available options:
HTTP,
DNS,
MCP_SERVER,
TCP,
ICMP,
HEARTBEAT,
BROWSER,
MULTI_STEP_API
managedBy
enum<string>

Filter by managed-by source

Available options:
DASHBOARD,
CLI,
TERRAFORM,
MCP,
API,
GIT
tags
string

Filter by tag names, comma-separated (e.g. prod,critical); OR semantics

tag
string

Filter by a single tag name (alias for ?tags=); merged with ?tags using OR semantics

Case-insensitive name search

environmentId
string<uuid>

Filter by environment ID

displayHealth
string

Filter by projected chip health

needsAttention
boolean

When true, only monitors that need operator attention

region
string

Filter by probe region

name
string

Exact, case-sensitive monitor name

openIncident
boolean

Whether a confirmed incident is open

muted
boolean

Whether alert delivery is currently muted

quarantined
boolean

Whether quarantine has not expired

pausedBefore
string<date-time>

Only monitors paused before this timestamp

flaky
boolean

Whether recent completed cycles recovered on retry

group
string

List group: failing, not_running, passing, or paused

ownerProject
string

Exact project declared by the owning tool

sort
string

Use state for group and streak ordering

page
integer
default:0

Zero-based page index (0..N)

Required range: x >= 0
size
integer
default:20

The size of the page to be returned

Required range: x >= 1

Response

OK

data
object[]
required
hasNext
boolean
required
hasPrev
boolean
required
totalElements
integer<int64> | null
totalPages
integer<int32> | null