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 |
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.
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.
To set several criteria, separate them with a comma ( | query | optional |
Code | Type | Description |
---|---|---|
200 | Synthetic | Success |
4XX | Error | Client side error. |
5XX | Error | Server side error. |
SyntheticMonitorListDto
objectList of available synthetic monitors.
Element | Type | Description |
---|---|---|
monitors | Synthetic | List of monitors. |
SyntheticMonitorSummaryDto
objectBasic 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 | -
|
{"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"}]}