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 ActiveGate | https://{your-activegate-domain}/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 |
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 | Active | Success |
400 | ErrorEnvelope | Failed. The input is invalid. |
Response body objects
The ActiveGateList
object
A list of ActiveGates.
Element | Type | Description |
---|---|---|
activeGates | Active | A list of ActiveGates. |
The ActiveGate
object
Parameters of the ActiveGate.
Element | Type | Description |
---|---|---|
id | string | The ID of the ActiveGate. |
networkAddresses | string[] | A list of network addresses of the ActiveGate. |
loadBalancerAddresses | string[] | A list of Load Balancer addresses of the ActiveGate. |
osType | string | The OS type that the ActiveGate is running on. |
osArchitecture | string | The OS architecture that the ActiveGate is running on. |
osBitness | string | The OS bitness that the ActiveGate is running on. |
autoUpdateStatus | string | The current status of auto-updates of the ActiveGate. |
offlineSince | integer | The timestamp since when the ActiveGate is offline. The |
version | string | The current version of the ActiveGate in the |
type | string | The type of the ActiveGate. |
hostname | string | The name of the host the ActiveGate is running on. |
mainEnvironment | string | The ID of the main environment for a multi-environment ActiveGate. |
environments | string[] | A list of environments (specified by IDs) the ActiveGate can connect to. |
autoUpdateSettings | Active | Configuration of the ActiveGate auto-updates. |
networkZone | string | The network zone of the ActiveGate. |
group | string | The group of the ActiveGate. |
modules | Active | A list of modules of the ActiveGate. |
containerized | boolean | ActiveGate is deployed in container ( |
connectedHosts | Active | Information about hosts currently connected to the ActiveGate |
activeGateTokens | Active | A list of the ActiveGate tokens. |
The ActiveGateAutoUpdateConfig
object
Configuration of the ActiveGate auto-updates.
Element | Type | Description |
---|---|---|
setting | string | The state of the ActiveGate auto-update: enabled, disabled, or inherited. If set to |
effectiveSetting | string | The actual state of the ActiveGate auto-update. Applicable only if the setting parameter is set to |
The ActiveGateModule
object
Information about ActiveGate module
Element | Type | Description |
---|---|---|
misconfigured | boolean | The module is misconfigured ( |
version | string | The version of the ActiveGate module. |
type | string | The type of ActiveGate module. |
attributes | object | The attributes of the ActiveGate module. |
enabled | boolean | The module is enabled ( |
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 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. |
Response body JSON model
{
"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,
"version": "string",
"type": "KUBERNETES",
"attributes": {},
"enabled": true
}
],
"containerized": true,
"connectedHosts": {
"number": 150
},
"activeGateTokens": [
{
"environmentId": "string",
"id": "dt0g02.4KWZO5EF",
"state": "ABSENT"
}
]
}
]
}
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
curl -L -X GET 'https://mySampleEnv.live.dynatrace.com/api/v2/activeGates' \
-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'
Request URL
https://mySampleEnv.live.dynatrace.com/api/v2/activeGates
Response body
{
"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