Skip to main content
GET
List monitors

Authorizations

X-API-KEY
string
header
required

API key created in the Bigdata Developer Platform.

Query Parameters

status
enum<string> | null

Filter by monitor status. active runs on schedule. inactive keeps its configuration but does not start new scheduled runs.

Available options:
active,
inactive
name
string | null

Filter by monitor name using a case-insensitive substring match.

intent
string | null

Filter by monitor intent using a case-insensitive substring match.

limit
integer
default:50

Maximum number of monitors to return.

Required range: x >= 1

Response

Monitors returned.

results
object[]
required
pagination
object
required
metadata
object
required