Synthetic nodes API v2 - GET a node
Gets all parameters of the specified synthetic node.
The request produces an application/json
payload.
GET | ManagedDynatrace for Government | https://{your-domain}/e/{your-environment-id}/api/v2/synthetic/nodes/{nodeId} |
SaaS | https://{your-environment-id}.live.dynatrace.com/api/v2/synthetic/nodes/{nodeId} | |
Environment and Cluster ActiveGate (default port 9999) | https://{your-activegate-domain}:9999/e/{your-environment-id}/api/v2/synthetic/nodes/{nodeId} |
Authentication
To execute this request, you need an access token with syntheticLocations.read
scope.
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 | Node | 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.
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 ( |
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
1{2 "activeGateVersion": "1.172.2.20190607-040913",3 "autoUpdateEnabled": true,4 "browserMonitorsEnabled": true,5 "browserType": "Chrome",6 "browserVersion": "69.0.3497.81",7 "entityId": "3086117876",8 "healthCheckStatus": "Ok",9 "hostname": "gdn.dyna.trace",10 "ips": [11 "238.245.160.14"12 ],13 "oneAgentRoutingEnabled": true,14 "operatingSystem": "Linux",15 "playerVersion": "1.179.0.20190920-145430",16 "status": "Running",17 "version": "1.161.0.20181210-173639"18}
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
1curl -X GET \2 https://mySampleEnv.live.dynatrace.com/api/v2/synthetic/nodes/3086117876 \3 -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'
Request URL
1https://mySampleEnv.live.dynatrace.com/api/v2/synthetic/nodes/3086117876
Response body
1{2 "entityId": "3086117876",3 "hostname": "gdn.dyna.trace",4 "ips": [5 "238.245.160.14"6 ],7 "version": "1.207.0.20201029-141904",8 "browserMonitorsEnabled": true,9 "activeGateVersion": "1.207.0.20201029-180431",10 "oneAgentRoutingEnabled": false,11 "operatingSystem": "Platform: Linux, Version: 4.4.0-1092-aws, Architecture: amd64, Processors: 2",12 "autoUpdateEnabled": true,13 "status": "Running",14 "playerVersion": "1.207.0.20201029-081128",15 "healthCheckStatus": "Ok"16}
Response code
200