Synthetic nodes API - GET a node

We have a new version of this API—Synthetic API v2. Check it out!

Gets all parameters of the specified synthetic node.

The request produces an application/json payload.

  • Managed https://{your-domain}/e/{your-environment-id}/api/v1/synthetic/nodes/{nodeId}
  • SaaS https://{your-environment-id}{nodeId}
  • Environment ActiveGate https://{your-activegate-domain}/e/{your-environment-id}/api/v1/synthetic/nodes/{nodeId}


To execute this request, you need the Access problem and event feed, metrics, and topology (DataExport) permission assigned to your API token. To learn how to obtain and use it, see Tokens and authentication.


Parameter Type Description In Required
nodeId string

The ID of the required synthetic node.

path required


Response codes

Code Description


Response body

The Node object

Configuration of a synthetic node.

A synthetic node is an ActiveGate that is able to execute synthetic monitors.

Element Type Description
entityId string

The ID of the synthetic node.

hostname string

The hostname of the synthetic node.

ips string[]

The IP of the synthetic node.

version string

The version of the synthetic node.

browserMonitorsEnabled boolean

The synthetic node is able to execute browser monitors (true) or not (false).

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.

browserType string

The browser type.

browserVersion string

The browser version.


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 three entries.


curl -X GET \ \
  -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'

Request URL

Response body

  "entityId": "353074222",
  "hostname": "GDN-007",
  "ips": [
  "version": "",
  "browserMonitorsEnabled": true

Response code