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 ActiveGate | https://{your-activegate-domain}/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 | Active | Success |
| 404 | ErrorEnvelope | Not found. See response body for details. |
Response body objects
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
{
"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 the parameters of the ActiveGate with the ID of 876651882.
The API token is passed in the Authorization header.
Curl
curl -L -X GET 'https://mySampleEnv/api/v2/activeGates/876651882' \
-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'Request URL
https://mySampleEnv/api/v2/activeGates/876651882Response body
{
"id": "876651882",
"networkAddresses": [
"orange-13.easytravel.com",
"228.245.125.39"
],
"osType": "LINUX",
"autoUpdateStatus": "UPDATE_IN_PROGRESS",
"offlineSince": null,
"version": "1.198.0.20200630-163221",
"type": "ENVIRONMENT",
"hostname": "orange-13.easytravel.com",
"mainEnvironment": null,
"environments": [
"mySampleEnv"
],
"networkZone": "easytravel.europe.austria.05"
}Response code
200