Synthetic nodes API v2 - GET a node
Gets all parameters of the specified synthetic node.
The request produces an application/json payload.
| GET | SaaS | https://{your-environment-id}.live.dynatrace.com/api/v2/synthetic/nodes/{nodeId} |
| Environment ActiveGateCluster ActiveGate | 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 |
| 4XX | Error | Client side error. |
| 5XX | Error | 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 ( |
| 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 gets the parameters of the node with the ID of 3086117876.
The API token is passed in the Authorization header.
Curl
curl -X GET \https://mySampleEnv.live.dynatrace.com/api/v2/synthetic/nodes/3086117876 \-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'
Request URL
https://mySampleEnv.live.dynatrace.com/api/v2/synthetic/nodes/3086117876
Response body
{"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