Sign in
synthetics

Get monitors

Spaces method and path for this operation:

<div><span class="operation-verb get">get</span>&nbsp;<span class="operation-path">/s/{space_id}/api/synthetics/monitors</span></div>

Refer to Spaces for more information.

Get a list of monitors. You must have read privileges for the Synthetics feature in the Observability section of the Kibana feature privileges.

get/api/synthetics/monitors

Query parameters

filterstring

Additional filtering criteria.

string
OR
string[]

The locations to filter by.

'browser' | 'http' | 'icmp' | 'tcp'
OR
string[]

The monitor types to filter.

pageinteger

The page number for paginated results.

per_pageinteger

The number of items to return per page.

string
OR
string[]

The projects to filter by.

querystring

A free-text query string.

string[]
OR
string

The schedules to filter by.

sortField'name' | 'createdAt' | 'updatedAt' | 'status'

The field to sort the results by.

sortOrder'asc' | 'desc'

The sort order.

string[]
OR
string

The status to filter by.

string
OR
string[]

Tags to filter monitors.

'tags' | 'locations'
OR
string[]

Specifies whether to apply logical AND filtering for specific fields. Accepts either a string with values "tags" or "locations" or an array containing both.

Response

A successful response.

object required

Changes

No recorded changes to this endpoint across all 106 revisions of this API.