Synthetic NAM API v2 - GET synthetic monitor definition

Get a synthetic monitor definition for the given monitor ID

The request produces an application/json payload.

GETSaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/synthetic/monitors/{monitorId}
Environment ActiveGateCluster ActiveGatehttps://{your-activegate-domain}:9999/e/{your-environment-id}/api/v2/synthetic/monitors/{monitorId}

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

ParameterTypeDescriptionInRequired
monitorIdstring

The identifier of the monitor.

pathrequired
Dt-App-Contextstring

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.

headeroptional

Response

Response codes

CodeTypeDescription
200SyntheticMultiProtocolMonitorDto

Success

4XXErrorEnvelope

Client side error.

5XXErrorEnvelope

Server side error.

Response body objects

The SyntheticMultiProtocolMonitorDto object

Network Availability monitor.

ElementTypeDescription
descriptionstring

Monitor description

enabledboolean

If true, the monitor is enabled.

entityIdstring

The entity id of the monitor.

frequencyMininteger

The frequency of the monitor, in minutes.

locationsstring[]

The locations to which the monitor is assigned.

modificationTimestampinteger

The timestamp of the last modification

namestring

The name of the monitor.

performanceThresholdsSyntheticMonitorPerformanceThresholdsDto

Performance thresholds configuration.

stepsSyntheticMultiProtocolMonitorStepDto[]

The steps of the monitor.

syntheticMonitorOutageHandlingSettingsSyntheticMonitorOutageHandlingSettingsDto

Outage handling configuration.

tagsSyntheticTagWithSourceDto[]

A set of tags assigned to the monitor.

You can specify only the value of the tag here and the CONTEXTLESS context and source 'USER' will be added automatically. But preferred option is usage of SyntheticTagWithSourceDto model.

typestring-
  • BROWSER
  • HTTP
  • MULTI_PROTOCOL
  • THIRD_PARTY

The SyntheticMonitorPerformanceThresholdsDto object

Performance thresholds configuration.

ElementTypeDescription
enabledboolean

Performance threshold is enabled (true) or disabled (false).

thresholdsSyntheticMonitorPerformanceThresholdDto[]

The list of performance threshold rules.

The SyntheticMonitorPerformanceThresholdDto object

The performance threshold rule.

ElementTypeDescription
aggregationstring

Aggregation type

  • AVG
  • MAX
  • MIN
dealertingSamplesinteger

Number of most recent non-violating request executions that closes the problem

samplesinteger

Number of request executions in analyzed sliding window (sliding window size)

stepIndexinteger

Specify the step's index to which a threshold applies.

thresholdinteger

Notify if monitor request takes longer than X milliseconds to execute.

violatingSamplesinteger

Number of violating request executions in analyzed sliding window

The SyntheticMultiProtocolMonitorStepDto object

The step of a network availability monitor.

ElementTypeDescription
constraintsSyntheticMultiProtocolMonitorConstraintDto[]

The list of constraints which apply to all requests in the step.

namestring

Step name.

propertiesobject

The properties which apply to all requests in the step.

requestConfigurationsSyntheticMultiProtocolRequestConfigurationDto[]

Request configurations.

requestTypestring

Request type.

  • ICMP
  • TCP
  • DNS
targetFilterstring

Target filter.

targetListstring[]

Target list.

The SyntheticMultiProtocolMonitorConstraintDto object

The network availability monitor constraint.

ElementTypeDescription
propertiesobject

The properties of the constraint.

typestring

Constraint type.

The SyntheticMultiProtocolRequestConfigurationDto object

The configuration of a network availability monitor request.

ElementTypeDescription
constraintsSyntheticMultiProtocolMonitorConstraintDto[]

Request constraints.

The SyntheticMonitorOutageHandlingSettingsDto object

Outage handling configuration.

ElementTypeDescription
globalConsecutiveOutageCountThresholdinteger

Number of consecutive failures for all locations.

globalOutagesboolean

Generate a problem and send an alert when the monitor is unavailable at all configured locations.

localConsecutiveOutageCountThresholdinteger

Number of consecutive failures.

localLocationOutageCountThresholdinteger

Number of failing locations.

localOutagesboolean

Generate a problem and send an alert when the monitor is unavailable for one or more consecutive runs at any location.

The SyntheticTagWithSourceDto object

The tag with source of a monitored entity.

ElementTypeDescription
contextstring

The origin of the tag, such as AWS or Cloud Foundry.

Custom tags use the CONTEXTLESS value.

keystring

The key of the tag.

sourcestring

The source of the tag, such as USER, RULE_BASED or AUTO.

  • AUTO
  • RULE_BASED
  • USER
valuestring

The value of the tag.

Response body JSON model

{
  "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"
}

Related topics