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 `CONTAINS` operator is used.	query	optional
osType	string	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`	query	optional
networkAddress	string	Filters the resulting set of ActiveGates by the network address. You can specify a partial address. In that case, the `CONTAINS` operator is used.	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 `CONTAINS` operator is used.	query	optional
type	string	Filters the resulting set of ActiveGates by the ActiveGate type. The element can hold these values `ENVIRONMENT` `ENVIRONMENT_MULTI`	query	optional
networkZone	string	Filters the resulting set of ActiveGates by the network zone. You can specify a partial name. In that case, the `CONTAINS` operator is used.	query	optional
updateStatus	string	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`	query	optional
versionCompareType	string	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`	query	optional
version	string	Filters the resulting set of ActiveGates by the specified version. Specify the version in `<major>.<minor>.<revision>` format (for example, `1.195.0`) here.	query	optional
autoUpdate	string	Filters the resulting set of ActiveGates by the actual state of auto-update. The element can hold these values `DISABLED` `ENABLED`	query	optional
group	string	Filters the resulting set of ActiveGates by the group. You can specify a partial name. In that case, the `CONTAINS` operator is used.	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. 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`	query	optional
disabledModule	string[]	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`	query	optional
containerized	boolean	Filters the resulting set of ActiveGates to those which are running in container (`true`) or not (`false`).	query	optional
tokenState	string	Filters the resulting set of ActiveGates to those with authorization token in specified state. The element can hold these values `ABSENT` `EXPIRING` `INVALID` `UNKNOWN` `UNSUPPORTED` `VALID`	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
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. The element can hold these values `LINUX` `WINDOWS`
osArchitecture	string	The OS architecture that the ActiveGate is running on. The element can hold these values `S390` `X86`
osBitness	string	The OS bitness that the ActiveGate is running on. The element can hold these values `64`
autoUpdateStatus	string	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`
offlineSince	integer	The timestamp since when the ActiveGate is offline. The `null` value means the ActiveGate is online.
version	string	The current version of the ActiveGate in the `<major>.<minor>.<revision>.<timestamp>` format.
type	string	The type of the ActiveGate. The element can hold these values `CLUSTER` `ENVIRONMENT` `ENVIRONMENT_MULTI`
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	ActiveGateAutoUpdateConfig	Configuration of the ActiveGate auto-updates.
networkZone	string	The network zone of the ActiveGate.
group	string	The group of the ActiveGate.
modules	ActiveGateModule[]	A list of modules of the ActiveGate.
containerized	boolean	ActiveGate is deployed in container (`true`) or not (`false`).
connectedHosts	ActiveGateConnectedHosts	Information about hosts currently connected to the ActiveGate
activeGateTokens	ActiveGateTokenInfoDto[]	A list of the ActiveGate tokens.

The `ActiveGateAutoUpdateConfig` object

Configuration of the ActiveGate auto-updates.

Element Type Description

setting

string

Element	Type	Description
setting	string	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`
effectiveSetting	string	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`

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

effectiveSetting

string

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

The `ActiveGateModule` object

Information about ActiveGate module

Element	Type	Description
misconfigured	boolean	The module is misconfigured (`true`) or not (`false`).
version	string	The version of the ActiveGate module.
type	string	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`
attributes	object	The attributes of the ActiveGate module.
enabled	boolean	The module is enabled (`true`) or disabled (`false`).

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

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 element can hold these values `ABSENT` `EXPIRING` `INVALID` `UNKNOWN` `UNSUPPORTED` `VALID`

The environment ID to which the token belongs.

Only available if more than one environment is supported.

string

The ActiveGate token identifier, consisting of prefix and public part of the token.

state

string

State of the ActiveGate token.

The element can hold these values

ABSENT
EXPIRING
INVALID
UNKNOWN
UNSUPPORTED
VALID

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,
          "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

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

ActiveGate API - GET all ActiveGates

Authentication

Parameters

Response

Response codes

Response body objects

The ActiveGateList object

The ActiveGate object

The ActiveGateAutoUpdateConfig object

The ActiveGateModule object

The ActiveGateConnectedHosts object

The ActiveGateTokenInfoDto object

Response body JSON model

Example

Curl

Request URL

Response body

Response code

The `ActiveGateList` object

The `ActiveGate` object

The `ActiveGateAutoUpdateConfig` object

The `ActiveGateModule` object

The `ActiveGateConnectedHosts` object

The `ActiveGateTokenInfoDto` object