Synthetic nodes API - GET all nodes

We have a new version of this API—Synthetic API v2. Check it out!

Lists all synthetic nodes (and their parameters) available for your environment.

The request produces an application/json payload.

GET
  • Managed https://{your-domain}/e/{your-environment-id}/api/v1/synthetic/nodes
  • SaaS https://{your-environment-id}.live.dynatrace.com/api/v1/synthetic/nodes
  • Environment ActiveGate https://{your-activegate-domain}/e/{your-environment-id}/api/v1/synthetic/nodes

Authentication

To execute this request, you need the Access problem and event feed, metrics, and topology (DataExport) permission assigned to your API token. To learn how to obtain and use it, see Tokens and authentication.

Parameters

The request doesn't provide any configurable parameters.

Response

Response codes

Code Description
200

Success

Response body

The Nodes object

A list of synthetic nodes

Element Type Description
nodes NodeCollectionElement[]

A list of synthetic nodes

The NodeCollectionElement object

The short representation of a synthetic object. Only contains the ID and the display name.

Element Type Description
entityId string

The ID of a node.
hostname string

The hostname of a node.
ips string[]

The IP of a node.
version string

The version of a node
browserMonitorsEnabled boolean

Browser check capabilities enabled flag.
activeGateVersion string

The version of the Active Gate.
oneAgentRoutingEnabled boolean

The Active Gate has the One Agent routing enabled ('true') or not ('false').
operatingSystem string

The Active Gate's host operating system.
autoUpdateEnabled boolean

The Active Gate has the Auto update option enabled ('true') or not ('false')
status string

The status of the synthetic node.
playerVersion string

The version of the synthetic player.
healthCheckStatus string

The health check status of the synthetic node.

Example

In this example, the request lists all synthetic nodes available in the mySampleEnv environment.

The API token is passed in the Authorization header.

The result is truncated to three entries.

Curl

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

Request URL

https://mySampleEnv.live.dynatrace.com/api/v1/synthetic/nodes

Response body

{
  "nodes": [
    {
      "entityId": "3086117876",
      "hostname": "gdn.dyna.trace",
      "ips": [
        "238.245.160.14"
      ],
      "version": "1.164.0.20190205-184318",
      "browserMonitorsEnabled": false
    },
    {
      "entityId": "1267320067",
      "hostname": "244.94.30.253",
      "ips": [
        "244.94.30.253"
      ],
      "version": "1.161.0.20181210-173639",
      "browserMonitorsEnabled": false
    },
    {
      "entityId": "353074222",
      "hostname": "GDN-007",
      "ips": [
        "132.46.87.141"
      ],
      "version": "1.166.0.20190311-110828",
      "browserMonitorsEnabled": true
    }
  ]
}

Response code

200