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 | Managed | 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
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 |
Response
Response codes
Code | Type | Description |
---|---|---|
200 | Active | Success |
400 | Error | Failed. The input is invalid. |
Response body objects
The ActiveGateList
object
A list of ActiveGates.
Element | Type | Description |
---|---|---|
activeGates | Active | A list of ActiveGates. Can be |
The ActiveGate
object
Parameters of the ActiveGate.
Element | Type | Description |
---|---|---|
id | string | The ID of the ActiveGate. Can be |
networkAddresses | string[] | A list of network addresses of the ActiveGate. Can be |
loadBalancerAddresses | string[] | A list of Load Balancer addresses of the ActiveGate. Can be |
osType | string | The OS type that the ActiveGate is running on. Can be |
osArchitecture | string | The OS architecture that the ActiveGate is running on. Can be |
osBitness | string | The OS bitness that the ActiveGate is running on. Can be |
autoUpdateStatus | string | The current status of auto-updates of the ActiveGate. Can be |
offlineSince | integer | The timestamp since when the ActiveGate is offline. The Can be |
version | string | The current version of the ActiveGate in the Can be |
type | string | The type of the ActiveGate. Can be |
hostname | string | The name of the host the ActiveGate is running on. Can be |
mainEnvironment | string | The ID of the main environment for a multi-environment ActiveGate. Can be |
environments | string[] | A list of environments (specified by IDs) the ActiveGate can connect to. Can be |
autoUpdateSettings | Active | Configuration of the ActiveGate auto-updates. Can be |
networkZone | string | The network zone of the ActiveGate. Can be |
group | string | The group of the ActiveGate. Can be |
modules | Active | A list of modules of the ActiveGate. Can be |
containerized | boolean | ActiveGate is deployed in container ( Can be |
connectedHosts | Active | Information about hosts currently connected to the ActiveGate Can be |
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 Can be |
The ActiveGateModule
object
Information about ActiveGate module
Element | Type | Description |
---|---|---|
misconfigured | boolean | The module is misconfigured ( Can be |
type | string | The type of ActiveGate module. Can be |
attributes | object | The attributes of the ActiveGate module. Can be |
version | string | The version of the ActiveGate module. Can be |
enabled | boolean | The module is enabled ( Can be |
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 Can be |
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,
"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
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