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`
GET	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

Parameter Type Description In Required

monitorSelector

string

Parameter	Type	Description	In	Required
monitorSelector	string	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`, and `key` 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 a `key: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.	query	optional
Dt-App-Context	string	The dt-app-context header is set automatically by the Dynatrace platform to identify a request's app of origin. It is used to authorize the app's access to credentials.	header	optional

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, and key 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 a key: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.

query

optional

Dt-App-Context

string

The dt-app-context header is set automatically by the Dynatrace platform to identify a request's app of origin. It is used to authorize the app's access to credentials.

header

optional

Response

Response codes

Code	Type	Description
200	SyntheticMonitorListDto	Success
4XX	ErrorEnvelope	Client side error.
5XX	ErrorEnvelope	Server side error.

Response body objects

The `SyntheticMonitorListDto` object

List of available synthetic monitors.

Element	Type	Description
monitors	SyntheticMonitorSummaryDto[]	List of monitors.

The `SyntheticMonitorSummaryDto` object

Basic monitor data.

Element	Type	Description
enabled	boolean	If true, the monitor is enabled.
entityId	string	The entity id of the monitor.
name	string	The name of the monitor.
type	string	- `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"
    }
  ]
}