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

Parameter
Type
Description
In
Required
monitorId
string

The identifier of the monitor.

path
required

Response

Response codes

Code
Type
Description
200

Success

4XX

Client side error.

5XX

Server side error.

Response body objects

The SyntheticMultiProtocolMonitorDto object

Network 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

Performance thresholds configuration.

steps

The steps of the monitor.

syntheticMonitorOutageHandlingSettings

Outage handling configuration.

tags

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.

type
string
-
  • BROWSER
  • HTTP
  • MULTI_PROTOCOL
  • THIRD_PARTY

The SyntheticMonitorPerformanceThresholdsDto object

Performance thresholds configuration.

Element
Type
Description
enabled
boolean

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

thresholds

The list of performance threshold rules.

The SyntheticMonitorPerformanceThresholdDto object

The performance threshold rule.

Element
Type
Description
aggregation
string

Aggregation type

  • AVG
  • MAX
  • MIN
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

The SyntheticMultiProtocolMonitorStepDto object

The step of a network availability monitor.

Element
Type
Description
constraints

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

Request configurations.

requestType
string

Request type.

  • ICMP
  • TCP
  • DNS
targetFilter
string

Target filter.

targetList
string[]

Target list.

The SyntheticMultiProtocolMonitorConstraintDto object

The network availability monitor constraint.

Element
Type
Description
properties
object

The properties of the constraint.

type
string

Constraint type.

The SyntheticMultiProtocolRequestConfigurationDto object

The configuration of a network availability monitor request.

Element
Type
Description
constraints

Request constraints.

The SyntheticMonitorOutageHandlingSettingsDto object

Outage 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.

The SyntheticTagWithSourceDto object

The 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 CONTEXTLESS value.

key
string

The key of the tag.

source
string

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

  • AUTO
  • RULE_BASED
  • USER
value
string

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