Synthetic nodes API v2 - GET all nodes
Lists all synthetic nodes (and their parameters) available for your environment.
The request produces an application/json
payload.
GET | ManagedDynatrace for Government | https://{your-domain}/e/{your-environment-id}/api/v2/synthetic/nodes |
SaaS | https://{your-environment-id}.live.dynatrace.com/api/v2/synthetic/nodes | |
Environment ActiveGate | https://{your-activegate-domain}/e/{your-environment-id}/api/v2/synthetic/nodes |
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
The request doesn't provide any configurable parameters.
Response
Response codes
Code | Type | Description |
---|---|---|
200 | Nodes | Success |
Response body objects
The Nodes
object
A list of synthetic nodes
Element | Type | Description |
---|---|---|
nodes | Node | A list of synthetic nodes |
The NodeCollectionElement
object
The short representation of a synthetic object. Only contains the ID and the display name.
Element | Type | Description |
---|---|---|
entityId | string | The ID of a node. |
hostname | string | The hostname of a node. |
ips | string[] | The IP of a node. |
version | string | The version of a node |
browserMonitorsEnabled | boolean | Browser check capabilities enabled flag. |
activeGateVersion | string | The version of the Active Gate. |
oneAgentRoutingEnabled | boolean | The Active Gate has the One Agent routing enabled ('true') or not ('false'). |
operatingSystem | string | The Active Gate's host operating system. |
autoUpdateEnabled | boolean | The Active Gate has the Auto update option enabled ('true') or not ('false') |
status | string | The status of the synthetic node. |
playerVersion | string | The version of the synthetic player. |
healthCheckStatus | string | The health check status of the synthetic node. |
Response body JSON model
{
"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 two entries.
Curl
curl -X GET \
https://mySampleEnv.live.dynatrace.com/api/v2/synthetic/nodes \
-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'
Request URL
https://mySampleEnv.live.dynatrace.com/api/v2/synthetic/nodes
Response body
{
"nodes": [
{
"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"
},
{
"entityId": "1267320067",
"hostname": "244.94.30.253",
"ips": [
"244.94.30.253"
],
"version": null,
"browserMonitorsEnabled": true,
"activeGateVersion": "1.207.0.20201029-180431",
"oneAgentRoutingEnabled": false,
"operatingSystem": "Platform: Linux, Version: 4.15.0-1057-azure, Architecture: amd64, Processors: 2",
"autoUpdateEnabled": true,
"status": null,
"playerVersion": null,
"healthCheckStatus": "Offline"
}
]
}
Response code
200