v3

latestOpenAPI 3.0.02026-07-2759120262.8 KB

Monitors

List monitors

List all monitors in a user's account. Values can be paginated with the cursor parameter. Optionally filter by tags, URL, name, status, groupId, or limit. All filters use AND logic when combined.

get/monitors

Query parameters

customFieldstring[]

Filter monitors by custom field key:value pairs. Format: customField=key:value. Multiple filters use AND logic. Split on first colon only.

limitnumber

Example:50

Maximum number of monitors to return per page. Default: 50, Min: 1, Max: 200.

groupIdnumber

Example:100

Filter monitors by monitor group ID.

statusstring

Example:UP,DOWN

Comma-separated list of status values to filter monitors. Uses OR logic (matches any specified status). Case-insensitive. Allowed values: PAUSED, STARTED, UP, LOOKS_DOWN, DOWN.

namestring

Example:Production API

Filter monitors by name. Case-insensitive partial match on the monitor friendly name.

urlstring

Example:example.com

Filter monitors by URL. Case-insensitive partial match on the monitor URL.

tagsstring

Example:production,staging

Comma-separated list of tag names to filter monitors. Uses OR logic (matches any specified tag). Case-sensitive.

cursornumber

Cursor to paginate through monitors

Response

nextLinkstring nullable required