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.
GET | ManagedDynatrace for Government | https://{your-domain}/e/{your-environment-id}/api/v2/activeGates |
SaaS | https://{your-environment-id}.live.dynatrace.com/api/v2/activeGates | |
Environment and Cluster ActiveGate (default port 9999) | https://{your-activegate-domain}:9999/e/{your-environment-id}/api/v2/activeGates |
Authentication
To execute this request, you need an access token with activeGates.read
scope.
To learn how to obtain and use it, see Tokens and authentication.
Parameters
Parameter | Type | Description | In | Required |
---|---|---|---|---|
hostname | string | 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 | query | optional |
osType | string | Filters the resulting set of ActiveGates by the OS type of the host it's running on.
| query | optional |
osArchitecture | string | Filters the resulting set of ActiveGates by the OS architecture of the host it's running on.
| query | optional |
networkAddress | string | Filters the resulting set of ActiveGates by the network address. You can specify a partial address. In that case, the | query | optional |
loadBalancerAddress | string | Filters the resulting set of ActiveGates by the Load Balancer address. You can specify a partial address. In that case, the | query | optional |
type | string | Filters the resulting set of ActiveGates by the ActiveGate type.
| query | optional |
networkZone | string | Filters the resulting set of ActiveGates by the network zone. You can specify a partial name. In that case, the | query | optional |
updateStatus | string | Filters the resulting set of ActiveGates by the auto-update status.
| query | optional |
versionCompareType | string | Filters the resulting set of ActiveGates by the specified version. Specify the comparison operator here.
| query | optional |
version | string | Filters the resulting set of ActiveGates by the specified version. Specify the version in | query | optional |
autoUpdate | string | Filters the resulting set of ActiveGates by the actual state of auto-update.
| query | optional |
group | string | Filters the resulting set of ActiveGates by the group. You can specify a partial name. In that case, the | query | optional |
online | boolean | Filters the resulting set of ActiveGates by the communication status. | query | optional |
enabledModule | string[] | Filters the resulting set of ActiveGates by the enabled modules.
| query | optional |
disabledModule | string[] | Filters the resulting set of ActiveGates by the disabled modules.
| query | optional |
containerized | boolean | Filters the resulting set of ActiveGates to those which are running in container ( | query | optional |
tokenState | string | Filters the resulting set of ActiveGates to those with authorization token in specified state.
| query | optional |
tokenExpirationSet | boolean | Filters the resulting set of ActiveGates to those with set expiration date for authorization token. | query | optional |
Response
Response codes
Code | Type | Description |
---|---|---|
200 | ActiveGateList | Success |
400 | ErrorEnvelope | Failed. The input is invalid. |
Response body objects
The ActiveGateList
object
A list of ActiveGates.
Element | Type | Description |
---|---|---|
activeGates | ActiveGate[] | A list of ActiveGates. |
The ActiveGate
object
Parameters of the ActiveGate.
Element | Type | Description |
---|---|---|
activeGateTokens | ActiveGateTokenInfoDto[] | A list of the ActiveGate tokens. |
autoUpdateSettings | ActiveGateAutoUpdateConfig | Configuration of the ActiveGate auto-updates. |
autoUpdateStatus | string | The current status of auto-updates of the ActiveGate.
|
connectedHosts | ActiveGateConnectedHosts | Information about hosts currently connected to the ActiveGate |
containerized | boolean | ActiveGate is deployed in container ( |
environments | string[] | A list of environments (specified by IDs) the ActiveGate can connect to. |
group | string | The group of the ActiveGate. |
hostname | string | The name of the host the ActiveGate is running on. |
id | string | The ID of the ActiveGate. |
loadBalancerAddresses | string[] | A list of Load Balancer addresses of the ActiveGate. |
mainEnvironment | string | The ID of the main environment for a multi-environment ActiveGate. |
modules | ActiveGateModule[] | A list of modules of the ActiveGate. |
networkAddresses | string[] | A list of network addresses of the ActiveGate. |
networkZone | string | The network zone of the ActiveGate. |
offlineSince | integer | The timestamp since when the ActiveGate is offline. The |
osArchitecture | string | The OS architecture that the ActiveGate is running on.
|
osBitness | string | The OS bitness that the ActiveGate is running on.
|
osType | string | The OS type that the ActiveGate is running on.
|
type | string | The type of the ActiveGate.
|
version | string | The current version of the ActiveGate in the |
The ActiveGateTokenInfoDto
object
Information about ActiveGate token.
Element | Type | Description |
---|---|---|
environmentId | string | The environment ID to which the token belongs. Only available if more than one environment is supported. |
id | string | The ActiveGate token identifier, consisting of prefix and public part of the token. |
state | string | State of the ActiveGate token.
|
The ActiveGateAutoUpdateConfig
object
Configuration of the ActiveGate auto-updates.
Element | Type | Description |
---|---|---|
effectiveSetting | string | The actual state of the ActiveGate auto-update. Applicable only if the setting parameter is set to
|
setting | string | The state of the ActiveGate auto-update: enabled, disabled, or inherited. If set to
|
The ActiveGateConnectedHosts
object
Information about hosts currently connected to the ActiveGate
Element | Type | Description |
---|---|---|
number | integer | The number of hosts currently connected to the ActiveGate |
The ActiveGateModule
object
Information about ActiveGate module
Element | Type | Description |
---|---|---|
attributes | object | The attributes of the ActiveGate module. |
enabled | boolean | The module is enabled ( |
misconfigured | boolean | The module is misconfigured ( |
type | string | The type of ActiveGate module.
|
version | string | The version of the ActiveGate module. |
Response body JSON model
1{2 "activeGates": [3 {4 "activeGateTokens": [5 {6 "environmentId": "string",7 "id": "dt0g02.4KWZO5EF",8 "state": "ABSENT"9 }10 ],11 "autoUpdateSettings": {12 "effectiveSetting": "ENABLED",13 "setting": "INHERITED"14 },15 "autoUpdateStatus": "OUTDATED",16 "connectedHosts": {17 "number": 15018 },19 "containerized": true,20 "environments": [21 "string"22 ],23 "group": "default",24 "hostname": "exampleHostname",25 "id": "0x3efdd091",26 "loadBalancerAddresses": [27 "string"28 ],29 "mainEnvironment": "d1bf4a7e-666b-43af-9f45-718g98372e2f",30 "modules": [31 {32 "attributes": {},33 "enabled": true,34 "misconfigured": true,35 "type": "KUBERNETES",36 "version": "string"37 }38 ],39 "networkAddresses": [40 "string"41 ],42 "networkZone": "exampleNetworkZone",43 "offlineSince": 1582031917814,44 "osArchitecture": "X86",45 "osBitness": "64",46 "osType": "WINDOWS",47 "type": "ENVIRONMENT",48 "version": "1.185.0.20200201-120000"49 }50 ]51}
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
1curl -L -X GET 'https://mySampleEnv.live.dynatrace.com/api/v2/activeGates' \2-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'
Request URL
1https://mySampleEnv.live.dynatrace.com/api/v2/activeGates
Response body
1{2 "activeGates": [3 {4 "id": "1541791174",5 "networkAddresses": [6 "orange-15.easytravel.com",7 "150.134.11.6"8 ],9 "osType": "LINUX",10 "autoUpdateStatus": "UP2DATE",11 "offlineSince": null,12 "version": "1.193.0.20200416-144858",13 "type": "ENVIRONMENT",14 "hostname": "orange-15.easytravel.com",15 "mainEnvironment": null,16 "environments": [17 "mySampleEnv"18 ],19 "networkZone": "default"20 },21 {22 "id": "974977376",23 "networkAddresses": [24 "win-18.easytravel.com",25 "66.165.59.105"26 ],27 "osType": "WINDOWS",28 "autoUpdateStatus": "OUTDATED",29 "offlineSince": null,30 "version": "1.198.0.20200629-221007",31 "type": "ENVIRONMENT",32 "hostname": "win-18.easytravel.com",33 "mainEnvironment": null,34 "environments": [35 "mySampleEnv"36 ],37 "networkZone": "default"38 }39 ]40}
Response code
200