• Home
  • Dynatrace API
  • Environment
  • Synthetic v1
  • Monitors
  • GET all monitors

Synthetic monitors API - GET all monitors

Lists all synthetic monitors in your environment. The list contains only the names and IDs of monitors. To retrieve details, use the GET a monitor call.

GETManaged https://{your-domain}/e/{your-environment-id}/api/v1/synthetic/monitors
SaaS https://{your-environment-id}.live.dynatrace.com/api/v1/synthetic/monitors
Environment ActiveGate https://{your-activegate-domain}/e/{your-environment-id}/api/v1/synthetic/monitors

Authentication

To execute this request, you need an access token with Create and read synthetic monitors, locations, and nodes (ExternalSyntheticIntegration) scope. To learn how to obtain and use it, see Tokens and authentication.

Parameters

ParameterTypeDescriptionInRequired
managementZoneinteger

Filters the resulting set of monitors to those which are part of the specified management zone.

Specify the ID of the management zone here.

queryoptional
tagstring[]

Filters the resulting set of monitors by specified tags.

You can specify several tags in the following format: tag=tag1&tag=tag2. The monitor has to match all the specified tags.

In case of key-value tags, such as imported AWS or CloudFoundry tags use following format: [context]key:value.

queryoptional
locationstring

Filters the resulting set of monitors to those assigned to a specified Synthetic location.

Specify the ID of the location here.

queryoptional
assignedAppsstring[]

Filters the resulting set of monitors to those assigned to the specified applications.

You can specify several applications in the following format: assignedApps=app1&assignedApps=app2. The monitor has to have all the specified applications assigned.

Specify Dynatrace entity IDs of applications here.

queryoptional
typestring

Filters the resulting set of monitors to those of the specified type: BROWSER or HTTP.

queryoptional
enabledboolean

Filters the resulting set of monitors to those which are enabled (true) or disabled (false).

queryoptional
credentialIdstring

Filters the resulting set of monitors to those using the specified credential set.

Specify the ID of the credentials set here.

queryoptional
credentialOwnerstring

Filters the resulting set of monitors to those using a credential owned by the specified user.

queryoptional

Response

Response codes

CodeTypeDescription
200Monitors

Success

Response body objects

The Monitors object

A list of synthetic monitors

ElementTypeDescription
monitorsMonitorCollectionElement[]

The list of synthetic monitors.

The MonitorCollectionElement object

The short representation of a synthetic monitor.

ElementTypeDescription
namestring

The name of a synthetic object.

entityIdstring

The ID of a synthetic object.

typestring

The type of a synthetic monitor.

The element can hold these values
  • BROWSER
  • HTTP
enabledboolean

The state of a synthetic monitor.

Response body JSON model

json
{ "monitors": [ { "name": "string", "entityId": "string", "type": "BROWSER", "enabled": true } ] }

Example

In this example, the request lists all available monitors of the mySampleEnv environment.

The API token is passed in the Authorization header.

The result is truncated to the first three entries.

Curl

shell
curl -X GET \ https://mySampleEnv.live.dynatrace.com/api/v1/synthetic/monitors \ -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'

Request URL

plaintext
https://mySampleEnv.live.dynatrace.com/api/v1/synthetic/monitors

Response body

json
{ "monitors": [ { "name": "easyTravel Angular", "entityId": "SYNTHETIC_TEST-000000000000C69F" }, { "name": "dynatrace.com", "entityId": "SYNTHETIC_TEST-0000000000025434" }, { "name": "easytravel special offers", "entityId": "SYNTHETIC_TEST-000000000000987A" } ] }

Response code

200

Related topics
  • Synthetic Monitoring

    Learn about Synthetic Monitoring and how to create a single-URL browser monitor, a browser clickpath, or an HTTP monitor.