Get a synthetic monitor definition for the given monitor ID
The request produces an application/json payload.
| GET | SaaS | https://{your-environment-id}.live.dynatrace.com/api/v2/synthetic/monitors/{monitorId} |
| Environment ActiveGateCluster ActiveGate | https://{your-activegate-domain}:9999/e/{your-environment-id}/api/v2/synthetic/monitors/{monitorId} |
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 |
|---|---|---|---|---|
| monitorId | string | The identifier of the monitor. | path | required |
| Code | Type | Description |
|---|---|---|
| 200 | Synthetic | Success |
| 4XX | Error | Client side error. |
| 5XX | Error | Server side error. |
SyntheticMultiProtocolMonitorDto objectNetwork Availability monitor.
| Element | Type | Description |
|---|---|---|
| description | string | Monitor description |
| enabled | boolean | If true, the monitor is enabled. |
| entityId | string | The entity id of the monitor. |
| frequencyMin | integer | The frequency of the monitor, in minutes. |
| locations | string[] | The locations to which the monitor is assigned. |
| modificationTimestamp | integer | The timestamp of the last modification |
| name | string | The name of the monitor. |
| performanceThresholds | Synthetic | Performance thresholds configuration. |
| steps | Synthetic | The steps of the monitor. |
| syntheticMonitorOutageHandlingSettings | Synthetic | Outage handling configuration. |
| tags | Synthetic | A set of tags assigned to the monitor. You can specify only the value of the tag here and the |
| type | string | Monitor type.
|
SyntheticMonitorPerformanceThresholdsDto objectPerformance thresholds configuration.
| Element | Type | Description |
|---|---|---|
| enabled | boolean | Performance threshold is enabled ( |
| thresholds | Synthetic | The list of performance threshold rules. |
SyntheticMonitorPerformanceThresholdDto objectThe performance threshold rule.
| Element | Type | Description |
|---|---|---|
| aggregation | string | Aggregation type
|
| dealertingSamples | integer | Number of most recent non-violating request executions that closes the problem |
| samples | integer | Number of request executions in analyzed sliding window (sliding window size) |
| stepIndex | integer | Specify the step's index to which a threshold applies. |
| threshold | integer | Notify if monitor request takes longer than X milliseconds to execute. |
| violatingSamples | integer | Number of violating request executions in analyzed sliding window |
SyntheticMultiProtocolMonitorStepDto objectThe step of a network availability monitor.
| Element | Type | Description |
|---|---|---|
| constraints | Synthetic | The list of constraints which apply to all requests in the step. |
| name | string | Step name. |
| properties | object | The properties which apply to all requests in the step. |
| requestConfigurations | Synthetic | Request configurations. |
| requestType | string | Request type.
|
| targetFilter | string | Target filter. |
| targetList | string[] | Target list. |
SyntheticMonitorConstraintDto objectSynthetic monitor constraint.
| Element | Type | Description |
|---|---|---|
| properties | object | The properties of the constraint. |
| type | string | Constraint type. |
SyntheticMultiProtocolRequestConfigurationDto objectThe configuration of a network availability monitor request.
| Element | Type | Description |
|---|---|---|
| constraints | Synthetic | Request constraints. |
SyntheticMonitorOutageHandlingSettingsDto objectOutage handling configuration.
| Element | Type | Description |
|---|---|---|
| globalConsecutiveOutageCountThreshold | integer | Number of consecutive failures for all locations. |
| globalOutages | boolean | Generate a problem and send an alert when the monitor is unavailable at all configured locations. |
| localConsecutiveOutageCountThreshold | integer | Number of consecutive failures. |
| localLocationOutageCountThreshold | integer | Number of failing locations. |
| localOutages | boolean | Generate a problem and send an alert when the monitor is unavailable for one or more consecutive runs at any location. |
SyntheticTagWithSourceDto objectThe tag with source of a monitored entity.
| Element | Type | Description |
|---|---|---|
| context | string | The origin of the tag, such as AWS or Cloud Foundry. Custom tags use the |
| key | string | The key of the tag. |
| source | string | The source of the tag, such as USER, RULE_BASED or AUTO.
|
| value | string | The value of the tag. |
{"description": "My network availability monitor description","enabled": "true","entityId": "MULTIPROTOCOL_MONITOR-63653CB579F573D1","frequencyMin": "60","locations": ["SYNTHETIC_LOCATION-D3A5BFD8676A4F19"],"name": "My network availability monitor","performanceThresholds": {"enabled": "true","thresholds": [{"aggregation": "AVG","dealertingSamples": "5","samples": "5","stepIndex": "0","threshold": "200","violatingSamples": "3"}]},"steps": [{"constraints": [{"properties": {"operator": ">=","value": "95"},"type": "SUCCESS_RATE_PERCENT"}],"name": "Step 1","properties": {"ICMP_IP_VERSION": "4","ICMP_NUMBER_OF_PACKETS": "8","ICMP_TIMEOUT_FOR_REPLY": "PT1S"},"requestConfigurations": [{"constraints": [{"properties": {"operator": "=","value": "100"},"type": "ICMP_SUCCESS_RATE_PERCENT"}]}],"requestType": "ICMP","targetFilter": "ipMask == 127.0.0.1/24","targetList": ["127.0.0.1","127.0.0.2"]}],"syntheticMonitorOutageHandlingSettings": {"globalConsecutiveOutageCountThreshold": "1","globalOutages": "true","localConsecutiveOutageCountThreshold": "3","localLocationOutageCountThreshold": "3","localOutages": "true"},"tags": [{"key": "sample key","value": "sample value"},{"key": "sample key"}],"type": "MULTI_PROTOCOL"}