ActiveGate API - GET an ActiveGate

Gets the information about the specified ActiveGate.

The request produces an application/json payload.

GET	ManagedDynatrace for Government	`https://{your-domain}/e/{your-environment-id}/api/v2/activeGates/{agId}`
	SaaS	`https://{your-environment-id}.live.dynatrace.com/api/v2/activeGates/{agId}`
	Environment and Cluster ActiveGate (default port 9999)	`https://{your-activegate-domain}:9999/e/{your-environment-id}/api/v2/activeGates/{agId}`

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
agId	string	The ID of the required ActiveGate.	path	required

Response

Response codes

Code	Type	Description
200	ActiveGate	Success
404	ErrorEnvelope	Not found. See response body for details.

Response body objects

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. `INCOMPATIBLE` `OUTDATED` `SCHEDULED` `SUPPRESSED` `UNKNOWN` `UP2DATE` `UPDATE_IN_PROGRESS` `UPDATE_PENDING` `UPDATE_PROBLEM`
connectedHosts	ActiveGateConnectedHosts	Information about hosts currently connected to the ActiveGate
containerized	boolean	ActiveGate is deployed in container (`true`) or not (`false`).
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 `null` value means the ActiveGate is online.
osArchitecture	string	The OS architecture that the ActiveGate is running on. `S390` `X86` `ARM`
osBitness	string	The OS bitness that the ActiveGate is running on. `64`
osType	string	The OS type that the ActiveGate is running on. `LINUX` `WINDOWS`
type	string	The type of the ActiveGate. `CLUSTER` `ENVIRONMENT` `ENVIRONMENT_MULTI`
version	string	The current version of the ActiveGate in the `<major>.<minor>.<revision>.<timestamp>` format.

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. `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.

ABSENT
EXPIRING
INVALID
UNKNOWN
UNSUPPORTED
VALID

The `ActiveGateAutoUpdateConfig` object

Configuration of the ActiveGate auto-updates.

Element Type Description

effectiveSetting

string

Element	Type	Description
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. `ENABLED` `DISABLED`
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. `DISABLED` `ENABLED` `INHERITED`

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.

ENABLED
DISABLED

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.

DISABLED
ENABLED
INHERITED

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

Response body JSON model

1{
2  "activeGateTokens": [
3    {
4      "environmentId": "string",
5      "id": "dt0g02.4KWZO5EF",
6      "state": "ABSENT"
7    }
8  ],
9  "autoUpdateSettings": {
10    "effectiveSetting": "ENABLED",
11    "setting": "INHERITED"
12  },
13  "autoUpdateStatus": "OUTDATED",
14  "connectedHosts": {
15    "number": 150
16  },
17  "containerized": true,
18  "environments": [
19    "string"
20  ],
21  "group": "default",
22  "hostname": "exampleHostname",
23  "id": "0x3efdd091",
24  "loadBalancerAddresses": [
25    "string"
26  ],
27  "mainEnvironment": "d1bf4a7e-666b-43af-9f45-718g98372e2f",
28  "modules": [
29    {
30      "attributes": {},
31      "enabled": true,
32      "misconfigured": true,
33      "type": "KUBERNETES",
34      "version": "string"
35    }
36  ],
37  "networkAddresses": [
38    "string"
39  ],
40  "networkZone": "exampleNetworkZone",
41  "offlineSince": 1582031917814,
42  "osArchitecture": "X86",
43  "osBitness": "64",
44  "osType": "WINDOWS",
45  "type": "ENVIRONMENT",
46  "version": "1.185.0.20200201-120000"
47}

Example

In this example, the request lists the parameters of the ActiveGate with the ID of 876651882.

The API token is passed in the Authorization header.

Curl

1curl -L -X GET 'https://mySampleEnv/api/v2/activeGates/876651882' \
2-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'

Request URL

1https://mySampleEnv/api/v2/activeGates/876651882

Response body

1{
2  "id": "876651882",
3  "networkAddresses": [
4        "orange-13.easytravel.com",
5        "228.245.125.39"
6    ],
7    "osType": "LINUX",
8    "autoUpdateStatus": "UPDATE_IN_PROGRESS",
9    "offlineSince": null,
10    "version": "1.198.0.20200630-163221",
11    "type": "ENVIRONMENT",
12    "hostname": "orange-13.easytravel.com",
13    "mainEnvironment": null,
14    "environments": [
15        "mySampleEnv"
16    ],
17    "networkZone": "easytravel.europe.austria.05"
18}

Response code

200

ActiveGate API - GET an ActiveGate

Authentication

Parameters

Response

Response codes

Response body objects

The ActiveGate object

The ActiveGateTokenInfoDto object

The ActiveGateAutoUpdateConfig object

The ActiveGateConnectedHosts object

The ActiveGateModule object

Response body JSON model

Example

Curl

Request URL

Response body

Response code

Related topics

The `ActiveGate` object

The `ActiveGateTokenInfoDto` object

The `ActiveGateAutoUpdateConfig` object

The `ActiveGateConnectedHosts` object

The `ActiveGateModule` object