List synthetic monitors in Dynatrace with the Synthetic API and narrow the results with a monitor selector that matches all specified criteria.
| GET | SaaS | https://{your-environment-id}.apps.dynatrace.com/platform/synthetic/v1/monitors |
Use the monitor-selector query parameter to define the scope of the request and include only monitors that match all criteria. Dynatrace returns the synthetic monitors that satisfy your filter.
To execute this request, you need a platform token or OAuth access token with synthetic:monitors:read scope. To learn how to obtain and use it, see Tokens and authentication.
| Parameter | Type | Description | In | Required |
|---|---|---|---|---|
| monitor-selector | string | Defines the scope of the query. Only monitors matching all criteria are included in the response. You can add one or more 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. |
SyntheticMonitorListResponse 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. |
| id | string | Id of the monitor. |
| name | string | The name of the monitor. |
| type | string | -The element can hold these values
|
ErrorResponseEnvelope objectEncloses the encountered error.
| Element | Type | Description |
|---|---|---|
| error | Error | Basic information of the encountered error. |
ErrorResponse objectBasic information of the encountered error.
| Element | Type | Description |
|---|---|---|
| code | integer | The returned HTTP status code. |
| details | Error | Detailed information of the error. |
| message | string | Description of the encountered error. |
ErrorResponseDetails objectDetailed information of the error.
| Element | Type | Description |
|---|---|---|
| type | string | Defines the actual set of fields depending on the value. See one of the following objects:
The element can hold these values
|
{"monitors": [{"enabled": "true","id": "NETWORK-AVAILABILITY-MONITOR-63653CB579F573D1","name": "My network availability monitor","type": "NETWORK_AVAILABILITY"},{"enabled": "false","id": "NETWORK-AVAILABILITY-MONITOR-63653CB579F573D2","name": "Disabled network availability monitor","type": "NETWORK_AVAILABILITY"}]}
{"error": {"code": 1,"details": {"type": "constraintViolation"},"message": "string"}}