• Home
  • Dynatrace API
  • Environment
  • Synthetic v1
  • Nodes
  • GET all

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.

GETManagedDynatrace for Governmenthttps://{your-domain}/e/{your-environment-id}/api/v1/synthetic/nodes
SaaShttps://{your-environment-id}.live.dynatrace.com/api/v1/synthetic/nodes
Environment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/v1/synthetic/nodes

Authentication

To execute this request, you need an access token with one of the following scopes:

  • DataExport
  • ExternalSyntheticIntegration
  • ReadSyntheticData

To learn how to obtain and use it, see Tokens and authentication.

Parameters

The request doesn't provide any configurable parameters.

Response

Response codes

CodeTypeDescription
200Nodes

Success

Response body objects

The Nodes object

A list of synthetic nodes

ElementTypeDescription
nodesNodeCollectionElement[]

A list of synthetic nodes

The NodeCollectionElement object

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

ElementTypeDescription
entityIdstring

The ID of a node.

hostnamestring

The hostname of a node.

ipsstring[]

The IP of a node.

versionstring

The version of a node

browserMonitorsEnabledboolean

Browser check capabilities enabled flag.

activeGateVersionstring

The version of the Active Gate.

oneAgentRoutingEnabledboolean

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

operatingSystemstring

The Active Gate's host operating system.

autoUpdateEnabledboolean

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

statusstring

The status of the synthetic node.

playerVersionstring

The version of the synthetic player.

healthCheckStatusstring

The health check status of the synthetic node.

Response body JSON model

json
{
  "nodes": [
    {
      "entityId": "3086117876",
      "hostname": "gdn.dyna.trace",
      "ips": [
        "238.245.160.14"
      ],
      "version": "1.161.0.20181210-173639",
      "browserMonitorsEnabled": true,
      "activeGateVersion": "1.172.2.20190607-040913",
      "oneAgentRoutingEnabled": true,
      "operatingSystem": "Linux",
      "autoUpdateEnabled": true,
      "status": "Running",
      "playerVersion": "1.179.0.20190920-145430",
      "healthCheckStatus": "Ok"
    }
  ]
}

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

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

Request URL

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

Response body

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