Synthetic nodes API - GET a node

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

Gets all parameters of the specified synthetic node.

The request produces an application/json payload.

GETSaaShttps://{your-environment-id}.live.dynatrace.com/api/v1/synthetic/nodes/{nodeId}
Environment ActiveGatehttps://{your-activegate-domain}:9999/e/{your-environment-id}/api/v1/synthetic/nodes/{nodeId}

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

Parameter
Type
Description
In
Required
nodeId
string

The ID of the required synthetic node.

path
required

Response

Response codes

Code
Type
Description
200

Success

4XX

Client side error.

5XX

Server side error.

Response body objects

The Node object

Configuration of a synthetic node.

A synthetic node is an ActiveGate that is able to execute synthetic monitors.

Element
Type
Description
activeGateVersion
string

The version of the Active Gate.

autoUpdateEnabled
boolean

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

browserMonitorsEnabled
boolean

The synthetic node is able to execute browser monitors (true) or not (false).

browserType
string

The browser type.

browserVersion
string

The browser version.

entityId
string

The ID of the synthetic node.

healthCheckStatus
string

The health check status of the synthetic node.

hostname
string

The hostname of the synthetic node.

ips
string[]

The IP of the synthetic node.

oneAgentRoutingEnabled
boolean

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

operatingSystem
string

The Active Gate's host operating system.

playerVersion
string

The version of the synthetic player.

status
string

The status of the synthetic node.

version
string

The version of the synthetic node.

Response body JSON model

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

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/353074222 \
  -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'

Request URL

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

Response body

{
  "entityId": "353074222",
  "hostname": "GDN-007",
  "ips": [
    "132.46.87.141"
  ],
  "version": "1.166.0.20190311-110828",
  "browserMonitorsEnabled": true
}

Response code

200