• Home
  • Dynatrace API
  • Environment
  • ActiveGates
  • ActiveGates info
  • GET all ActiveGates

ActiveGate API - GET all ActiveGates

Lists all ActiveGates that are currently connected to the environment or have been connected during the last 2 hours.

You can narrow down the output by specifying filtering parameters in your request.

The request produces an application/json payload.

GETManaged https://{your-domain}/e/{your-environment-id}/api/v2/activeGates
SaaS https://{your-environment-id}.live.dynatrace.com/api/v2/activeGates
Environment ActiveGate https://{your-activegate-domain}/e/{your-environment-id}/api/v2/activeGates

Authentication

To execute this request, you need an access token with Read ActiveGates (activeGates.read) scope. To learn how to obtain and use it, see Tokens and authentication.

Parameters

ParameterTypeDescriptionInRequired
hostnamestring

Filters the resulting set of ActiveGates by the name of the host it's running on.

You can specify a partial name. In that case, the CONTAINS operator is used.

queryoptional
osTypestring

Filters the resulting set of ActiveGates by the OS type of the host it's running on.

The element can hold these values
  • LINUX
  • WINDOWS
queryoptional
networkAddressstring

Filters the resulting set of ActiveGates by the network address.

You can specify a partial address. In that case, the CONTAINS operator is used.

queryoptional
loadBalancerAddressstring

Filters the resulting set of ActiveGates by the Load Balancer address.

You can specify a partial address. In that case, the CONTAINS operator is used.

queryoptional
typestring

Filters the resulting set of ActiveGates by the ActiveGate type.

The element can hold these values
  • ENVIRONMENT
  • ENVIRONMENT_MULTI
queryoptional
networkZonestring

Filters the resulting set of ActiveGates by the network zone.

You can specify a partial name. In that case, the CONTAINS operator is used.

queryoptional
updateStatusstring

Filters the resulting set of ActiveGates by the auto-update status.

The element can hold these values
  • INCOMPATIBLE
  • OUTDATED
  • SCHEDULED
  • SUPPRESSED
  • UNKNOWN
  • UP2DATE
  • UPDATE_IN_PROGRESS
  • UPDATE_PENDING
  • UPDATE_PROBLEM
queryoptional
versionCompareTypestring

Filters the resulting set of ActiveGates by the specified version.

Specify the comparison operator here.

The element can hold these values
  • EQUAL
  • GREATER
  • GREATER_EQUAL
  • LOWER
  • LOWER_EQUAL
queryoptional
versionstring

Filters the resulting set of ActiveGates by the specified version.

Specify the version in <major>.<minor>.<revision> format (for example, 1.195.0) here.

queryoptional
autoUpdatestring

Filters the resulting set of ActiveGates by the actual state of auto-update.

The element can hold these values
  • DISABLED
  • ENABLED
queryoptional
groupstring

Filters the resulting set of ActiveGates by the group.

You can specify a partial name. In that case, the CONTAINS operator is used.

queryoptional
onlineboolean

Filters the resulting set of ActiveGates by the communication status.

queryoptional
enabledModulestring[]

Filters the resulting set of ActiveGates by the enabled modules.

The element can hold these values
  • AWS
  • AZURE
  • BEACON_FORWARDER
  • CLOUD_FOUNDRY
  • DB_INSIGHT
  • EXTENSIONS_V1
  • EXTENSIONS_V2
  • KUBERNETES
  • LOGS
  • MEMORY_DUMPS
  • METRIC_API
  • ONE_AGENT_ROUTING
  • OTLP_INGEST
  • REST_API
  • SYNTHETIC
  • VMWARE
  • Z_OS
queryoptional
disabledModulestring[]

Filters the resulting set of ActiveGates by the disabled modules.

The element can hold these values
  • AWS
  • AZURE
  • BEACON_FORWARDER
  • CLOUD_FOUNDRY
  • DB_INSIGHT
  • EXTENSIONS_V1
  • EXTENSIONS_V2
  • KUBERNETES
  • LOGS
  • MEMORY_DUMPS
  • METRIC_API
  • ONE_AGENT_ROUTING
  • OTLP_INGEST
  • REST_API
  • SYNTHETIC
  • VMWARE
  • Z_OS
queryoptional
containerizedboolean

Filters the resulting set of ActiveGates to those which are running in container (true) or not (false).

queryoptional

Response

Response codes

CodeTypeDescription
200ActiveGateList

Success

400ErrorEnvelope

Failed. The input is invalid.

Response body objects

The ActiveGateList object

A list of ActiveGates.

ElementTypeDescription
activeGatesActiveGate[]

A list of ActiveGates.

Can be null.

The ActiveGate object

Parameters of the ActiveGate.

ElementTypeDescription
idstring

The ID of the ActiveGate.

Can be null.

networkAddressesstring[]

A list of network addresses of the ActiveGate.

Can be null.

loadBalancerAddressesstring[]

A list of Load Balancer addresses of the ActiveGate.

Can be null.

osTypestring

The OS type that the ActiveGate is running on.

The element can hold these values
  • LINUX
  • WINDOWS

Can be null.

osArchitecturestring

The OS architecture that the ActiveGate is running on.

The element can hold these values
  • S390
  • X86

Can be null.

osBitnessstring

The OS bitness that the ActiveGate is running on.

The element can hold these values
  • 64

Can be null.

autoUpdateStatusstring

The current status of auto-updates of the ActiveGate.

The element can hold these values
  • INCOMPATIBLE
  • OUTDATED
  • SCHEDULED
  • SUPPRESSED
  • UNKNOWN
  • UP2DATE
  • UPDATE_IN_PROGRESS
  • UPDATE_PENDING
  • UPDATE_PROBLEM

Can be null.

offlineSinceinteger

The timestamp since when the ActiveGate is offline.

The null value means the ActiveGate is online.

Can be null.

versionstring

The current version of the ActiveGate in the <major>.<minor>.<revision>.<timestamp> format.

Can be null.

typestring

The type of the ActiveGate.

The element can hold these values
  • CLUSTER
  • ENVIRONMENT
  • ENVIRONMENT_MULTI

Can be null.

hostnamestring

The name of the host the ActiveGate is running on.

Can be null.

mainEnvironmentstring

The ID of the main environment for a multi-environment ActiveGate.

Can be null.

environmentsstring[]

A list of environments (specified by IDs) the ActiveGate can connect to.

Can be null.

autoUpdateSettingsActiveGateAutoUpdateConfig

Configuration of the ActiveGate auto-updates.

Can be null.

networkZonestring

The network zone of the ActiveGate.

Can be null.

groupstring

The group of the ActiveGate.

Can be null.

modulesActiveGateModule[]

A list of modules of the ActiveGate.

Can be null.

containerizedboolean

ActiveGate is deployed in container (true) or not (false).

Can be null.

connectedHostsActiveGateConnectedHosts

Information about hosts currently connected to the ActiveGate

Can be null.

The ActiveGateAutoUpdateConfig object

Configuration of the ActiveGate auto-updates.

ElementTypeDescription
settingstring

The state of the ActiveGate auto-update: enabled, disabled, or inherited.

If set to INHERITED, the setting is inherited from the global configuration set on the environment or Managed cluster level.

The element can hold these values
  • DISABLED
  • ENABLED
  • INHERITED
effectiveSettingstring

The actual state of the ActiveGate auto-update.

Applicable only if the setting parameter is set to INHERITED. In that case, the value is taken from the parent setting. Otherwise, it's just a duplicate of the setting value.

The element can hold these values
  • ENABLED
  • DISABLED

Can be null.

The ActiveGateModule object

Information about ActiveGate module

ElementTypeDescription
misconfiguredboolean

The module is misconfigured (true) or not (false).

Can be null.

typestring

The type of ActiveGate module.

The element can hold these values
  • AWS
  • AZURE
  • BEACON_FORWARDER
  • CLOUD_FOUNDRY
  • DB_INSIGHT
  • EXTENSIONS_V1
  • EXTENSIONS_V2
  • KUBERNETES
  • LOGS
  • MEMORY_DUMPS
  • METRIC_API
  • ONE_AGENT_ROUTING
  • OTLP_INGEST
  • REST_API
  • SYNTHETIC
  • VMWARE
  • Z_OS

Can be null.

attributesobject

The attributes of the ActiveGate module.

Can be null.

versionstring

The version of the ActiveGate module.

Can be null.

enabledboolean

The module is enabled (true) or disabled (false).

Can be null.

The ActiveGateConnectedHosts object

Information about hosts currently connected to the ActiveGate

ElementTypeDescription
numberinteger

The number of hosts currently connected to the ActiveGate

Can be null.

Response body JSON model

json
{ "activeGates": [ { "id": "0x3efdd091", "networkAddresses": [ "string" ], "loadBalancerAddresses": [ "string" ], "osType": "WINDOWS", "osArchitecture": "X86", "osBitness": "64", "autoUpdateStatus": "OUTDATED", "offlineSince": 1582031917814, "version": "1.185.0.20200201-120000", "type": "ENVIRONMENT", "hostname": "exampleHostname", "mainEnvironment": "d1bf4a7e-666b-43af-9f45-718g98372e2f", "environments": [ "string" ], "autoUpdateSettings": { "setting": "INHERITED", "effectiveSetting": "ENABLED" }, "networkZone": "exampleNetworkZone", "group": "default", "modules": [ { "misconfigured": true, "type": "KUBERNETES", "attributes": {}, "version": "string", "enabled": true } ], "containerized": true, "connectedHosts": { "number": 150 } } ] }

Example

In this example, the request lists all ActiveGates available for the mySampleEnv environment.

The API token is passed in the Authorization header.

The result is truncated to two entries.

Curl

shell
curl -L -X GET 'https://mySampleEnv.live.dynatrace.com/api/v2/activeGates' \ -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'

Request URL

plaintext
https://mySampleEnv.live.dynatrace.com/api/v2/activeGates

Response body

json
{ "activeGates": [ { "id": "1541791174", "networkAddresses": [ "orange-15.easytravel.com", "150.134.11.6" ], "osType": "LINUX", "autoUpdateStatus": "UP2DATE", "offlineSince": null, "version": "1.193.0.20200416-144858", "type": "ENVIRONMENT", "hostname": "orange-15.easytravel.com", "mainEnvironment": null, "environments": [ "mySampleEnv" ], "networkZone": "default" }, { "id": "974977376", "networkAddresses": [ "win-18.easytravel.com", "66.165.59.105" ], "osType": "WINDOWS", "autoUpdateStatus": "OUTDATED", "offlineSince": null, "version": "1.198.0.20200629-221007", "type": "ENVIRONMENT", "hostname": "win-18.easytravel.com", "mainEnvironment": null, "environments": [ "mySampleEnv" ], "networkZone": "default" } ] }

Response code

200

Related topics
  • Dynatrace ActiveGate

    Understand the basic concepts related to ActiveGate.