Synthetic API v2 - GET all synthetic network availability monitors
Lists all synthetic network availability monitors in your environment.
The request produces an application/json
payload.
GET | SaaS | https://{your-environment-id}.live.dynatrace.com/api/v2/synthetic/monitors |
Environment ActiveGateCluster ActiveGate | https://{your-activegate-domain}:9999/e/{your-environment-id}/api/v2/synthetic/monitors |
Authentication
To execute this request, you need an access token with settings.read
scope.
To learn how to obtain and use it, see Tokens and authentication.
Parameters
Defines the scope of the query. Only monitors matching the specified criteria are included into response.
You can add one or several of the criteria listed below. For each criterion you can specify multiple comma-separated values, unless stated otherwise. If several values are specified, the OR logic applies.
- Monitor type:
type(HTTP,MULTI_PROTOCOL)
. Possible values: 'HTTP', 'BROWSER', 'THIRD_PARTY', 'MULTI_PROTOCOL' (Note that only 'MULTI_PROTOCOL' is currently supported). - Management zone ID:
managementZoneId(1, 2)
. - Synthetic Location ME ID:
location(SYNTHETIC_LOCATION-123)
. - Monitored host ME ID:
monitoredEntity(HOST-123)
. - Monitor tags:
tag([context]key:value,key:value,key)
. Tags in[context]key:value
,key:value
, andkey
formats are detected and parsed automatically. If a key-only tag has a colon (:
) in it, you must escape the colon with a backslash(\
). Otherwise, the tag will be parsed as akey:value tag
. All tag values are case-sensitive. - Monitor enablement:
enabled(true)
.
To set several criteria, separate them with a comma (,
).
Only results matching all criteria are included in the response.
Response
Response codes
Response body objects
The SyntheticMonitorListDto
object
List of available synthetic monitors.
The SyntheticMonitorSummaryDto
object
Basic monitor data.
If true, the monitor is enabled.
The entity id of the monitor.
The name of the monitor.
BROWSER
HTTP
MULTI_PROTOCOL
THIRD_PARTY
Response body JSON model
{"monitors": [{"enabled": "true","entityId": "MULTIPROTOCOL_MONITOR-63653CB579F573D1","name": "My network availability monitor","type": "MULTI_PROTOCOL"},{"enabled": "false","entityId": "MULTIPROTOCOL_MONITOR-63653CB579F573D2","name": "Disabled network availability monitor","type": "MULTI_PROTOCOL"}]}