• Home
  • Dynatrace Managed
  • Cluster API
  • Cluster API v2
  • Synthetic locations and nodes
  • GET a node

Synthetic nodes API v2 - GET a node (Dynatrace Managed)

This API call gets all parameters of the specified synthetic node. The request produces an application/json payload.

Authentication

To execute this request, you need the Service Provider API (ServiceProviderAPI) permission assigned to your API token. Generate your API token via Cluster Management Console (CMC). To learn how to obtain and use it, see Cluster API - Authentication.

Endpoint

/api/cluster/v2/synthetic/nodes

Parameters

ParameterTypeDescriptionInRequired
nodeIdstring

The ID of the required synthetic node.

pathrequired

Response

Response codes

CodeTypeDescription
200Node

Success

Response body objects

The Node object

Configuration of a synthetic node.

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

ElementTypeDescription
entityIdstring

The ID of the synthetic node.

hostnamestring

The hostname of the synthetic node.

ipsstring[]

The IP of the synthetic node.

versionstring

The version of the synthetic node.

browserMonitorsEnabledboolean

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

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.

browserTypestring

The browser type.

browserVersionstring

The browser version.

Response body JSON model

json
{ "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", "browserType": "Chrome", "browserVersion": "69.0.3497.81" }

Example

In this example, the request gets the parameters of the node with the ID of 3086117876.

The API token is passed in the Authorization header.

Curl

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

Request URL

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

Response body

json
{ "entityId": "3086117876", "hostname": "gdn.dyna.trace", "ips": [ "238.245.160.14" ], "version": "1.207.0.20201029-141904", "browserMonitorsEnabled": true, "activeGateVersion": "1.207.0.20201029-180431", "oneAgentRoutingEnabled": false, "operatingSystem": "Platform: Linux, Version: 4.4.0-1092-aws, Architecture: amd64, Processors: 2", "autoUpdateEnabled": true, "status": "Running", "playerVersion": "1.207.0.20201029-081128", "healthCheckStatus": "Ok" }

Response code

200