Synthetic API v2 - GET all synthetic network availability monitors

  • Reference
  • Published Jul 08, 2024

Lists all synthetic network availability monitors in your environment.

The request produces an application/json payload.

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

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
monitorSelectorstring

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.

  • Monitor type: type(HTTP,MULTI_PROTOCOL). Possible values: 'HTTP', 'BROWSER', 'THIRD_PARTY', 'MULTI_PROTOCOL' (Note that only 'BROWSER' and 'MULTI_PROTOCOL' are currently supported).
  • Management zone ID: managementZoneId(1, 2).
  • Synthetic Location ME ID: location(SYNTHETIC_LOCATION-123).
  • Monitored host ME ID: monitoredEntity(HOST-123).
  • Monitor tags: tag([context]key:value,key:value,key). Tags in [context]key:value, key:value, and key formats are detected and parsed automatically. If a key-only tag has a colon (:) in it, you must escape the colon with a backslash(\). Otherwise, the tag will be parsed as a key:value tag. All tag values are case-sensitive.
  • Monitor enablement: enabled(true).

To set several criteria, separate them with a comma (,). Only results matching all criteria are included in the response.

queryOptional

Response

Response codes

CodeTypeDescription
200SyntheticMonitorListDto

Success

4XXErrorEnvelope

Client side error.

5XXErrorEnvelope

Server side error.

Response body objects

The SyntheticMonitorListDto object

List of available synthetic monitors.

ElementTypeDescription
monitorsSyntheticMonitorSummaryDto[]

List of monitors.

The SyntheticMonitorSummaryDto object

Basic monitor data.

ElementTypeDescription
enabledboolean

If true, the monitor is enabled.

entityIdstring

The entity id of the monitor.

namestring

The name of the monitor.

typestring-
The element can hold these values
  • BROWSER
  • HTTP
  • MULTI_PROTOCOL
  • THIRD_PARTY

The ErrorEnvelope object

ElementTypeDescription
errorError-

The Error object

ElementTypeDescription
codeinteger

The HTTP status code

constraintViolationsConstraintViolation[]

A list of constraint violations

messagestring

The error message

The ConstraintViolation object

A list of constraint violations

ElementTypeDescription
locationstring-
messagestring-
parameterLocationstring-
The element can hold these values
  • HEADER
  • PATH
  • PAYLOAD_BODY
  • QUERY
pathstring-

Response body JSON models

{
  "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"
    }
  ]
}
{
  "error": {
    "code": 1,
    "constraintViolations": [
      {
        "location": "string",
        "message": "string",
        "parameterLocation": "HEADER",
        "path": "string"
      }
    ],
    "message": "string"
  }
}