Search monitors
Spaces method and path for this operation:
<div><span class="operation-verb get">get</span> <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.<br/><br/>[Required authorization] Route required privileges: uptime-read.
Request
- Base URLhttps://localhost:5601
- URLhttps://localhost:5601/api/synthetics/monitors
- Auth
- API key in header Authorization
- or HTTP basic
Query parameters
A free-text query string.
Additional KQL filtering criteria.
Tags to filter monitors. Accepts a string or an array of strings.
The monitor types to filter by, such as http. Accepts a string or an array of strings.
The location IDs to filter by. Accepts a string or an array of strings.
The projects to filter by. Accepts a string or an array of strings.
The schedules to filter by. Accepts a string or an array of strings.
A string or an array of strings.
The monitor statuses to filter by. Accepts a string or an array of strings.
The monitor query IDs to filter by. Accepts a string or an array of strings.
The monitor config IDs to filter by. Accepts a string or an array of strings.
If true, return monitors from all spaces the user can access.
Apply logical AND for tags and/or locations. Accepts a string or an array.
The start of the status window, as datemath (now-15m) or an ISO-8601 timestamp.
The end of the status window, as datemath (now) or an ISO-8601 timestamp.
The page number for paginated results.
The number of items to return per page.
The field to sort the results by.
The sort order.
A JSON array of sort values from the previous page, for cursor-based paging.
Response
A successful response.
Changes
No operation changes recorded.