Lists all synthetic nodes (and their parameters) available for your environment.
The request produces an application/json
payload.
GET | SaaS | https://{your-environment-id}.live.dynatrace.com/api/v2/synthetic/nodes |
Environment ActiveGateCluster ActiveGate | https://{your-activegate-domain}:9999/e/{your-environment-id}/api/v2/synthetic/nodes |
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.
Parameter | Type | Description | In | Required |
---|---|---|---|---|
assignedToLocation | string | Filters the resulting set of nodes to those which are assigned to a synthetic location or not.
| query | optional |
isContainerized | boolean | If set to true, returns only containerized nodes. | query | optional |
Code | Type | Description |
---|---|---|
200 | Nodes | Success |
4XX | Error | Client side error. |
5XX | Error | Server side error. |
Nodes
objectA list of synthetic nodes
Element | Type | Description |
---|---|---|
nodes | Node | A list of synthetic nodes |
NodeCollectionElement
objectThe short representation of a synthetic object. Only contains the ID and the display name.
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 | Browser check capabilities enabled flag. |
entityId | string | The ID of a node. |
healthCheckStatus | string | The health check status of the synthetic node. |
hostname | string | The hostname of a node. |
ips | string[] | The IP of a 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 a node |
{"nodes": [{"activeGateVersion": "1.172.2.20190607-040913","autoUpdateEnabled": true,"browserMonitorsEnabled": true,"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"}]}
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 -X GET \https://mySampleEnv.live.dynatrace.com/api/v2/synthetic/nodes \-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'
https://mySampleEnv.live.dynatrace.com/api/v2/synthetic/nodes
{"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"}]}
200