List synthetic nodes in Dynatrace with the Synthetic API, including nodes assigned to locations and containerized nodes based on query filters.
| GET | SaaS | https://{your-environment-id}.apps.dynatrace.com/platform/synthetic/v1/nodes |
You can use the assigned-to-location and containerized query parameters to filter the synthetic nodes returned. The operation returns a 200 response with the set of nodes available in your environment.
To execute this request, you need a platform token or OAuth access token with synthetic:locations:read scope. To learn how to obtain and use it, see Tokens and authentication.
| Parameter | Type | Description | In | Required |
|---|---|---|---|---|
| assigned-to-location | boolean | If set to true, returns the set of nodes that are assigned to a synthetic location. If set to false, returns only unassigned nodes. If omitted, returns both assigned and unassigned nodes. | query | Optional |
| containerized | boolean | If set to true, returns only containerized nodes. If set to false, returns only non-containerized nodes. If omitted, returns both containerized and non-containerized nodes. | query | Optional |
| Code | Type | Description |
|---|---|---|
| 200 | Nodes | Success |
| 4XX | Error | Client side error. |
| 5XX | Error | Server side error. |
NodesResponse objectA list of synthetic nodes.
| Element | Type | Description |
|---|---|---|
| nodes | Node | A list of synthetic nodes. |
NodeResponse objectConfiguration 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 | Browser check capabilities enabled flag. |
| capabilities | string[] | The list of node's capabilities. |
| healthCheckStatus | string | The health check status of the synthetic node. |
| hostname | string | The hostname of a node. |
| id | string | The ID 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. |
ErrorResponseEnvelope objectEncloses the encountered error.
| Element | Type | Description |
|---|---|---|
| error | Error | Basic information of the encountered error. |
ErrorResponse objectBasic information of the encountered error.
| Element | Type | Description |
|---|---|---|
| code | integer | The returned HTTP status code. |
| details | Error | Detailed information of the error. |
| message | string | Description of the encountered error. |
ErrorResponseDetails objectDetailed information of the error.
| Element | Type | Description |
|---|---|---|
| type | string | Defines the actual set of fields depending on the value. See one of the following objects:
The element can hold these values
|
{"nodes": [{"activeGateVersion": "1.172.2.20190607-040913","autoUpdateEnabled": true,"browserMonitorsEnabled": true,"capabilities": ["HTTP_HIGH_RESOURCE","HTTP"],"healthCheckStatus": "Ok","hostname": "gdn.dyna.trace","id": "3086117876","ips": ["238.245.160.14"],"oneAgentRoutingEnabled": true,"operatingSystem": "Linux","playerVersion": "1.179.0.20190920-145430","status": "Running","version": "1.161.0.20181210-173639"}]}
{"error": {"code": 1,"details": {"type": "constraintViolation"},"message": "string"}}