ActiveGate API - GET an ActiveGate

Gets the information about the specified ActiveGate.

The request produces an application/json payload.

GETSaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/activeGates/{agId}
Environment ActiveGateCluster ActiveGatehttps://{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

ParameterTypeDescriptionInRequired
agIdstring

The ID of the required ActiveGate.

pathrequired

Response

Response codes

CodeTypeDescription
200ActiveGate

Success

404ErrorEnvelope

Not found. See response body for details.

4XXErrorEnvelope

Client side error.

5XXErrorEnvelope

Server side error.

Response body objects

The ActiveGate object

Parameters of the ActiveGate.

ElementTypeDescription
activeGateTokensActiveGateTokenInfoDto[]

A list of the ActiveGate tokens.

autoUpdateSettingsActiveGateAutoUpdateConfig

Configuration of the ActiveGate auto-updates.

autoUpdateStatusstring

The current status of auto-updates of the ActiveGate.

  • INCOMPATIBLE
  • OUTDATED
  • SCHEDULED
  • SUPPRESSED
  • UNKNOWN
  • UP2DATE
  • UPDATE_IN_PROGRESS
  • UPDATE_PENDING
  • UPDATE_PROBLEM
connectedHostsActiveGateConnectedHosts

Information about hosts currently connected to the ActiveGate

containerizedboolean

ActiveGate is deployed in container (true) or not (false).

environmentsstring[]

A list of environments (specified by IDs) the ActiveGate can connect to.

groupstring

The group of the ActiveGate.

hostnamestring

The name of the host the ActiveGate is running on.

idstring

The ID of the ActiveGate.

loadBalancerAddressesstring[]

A list of Load Balancer addresses of the ActiveGate.

mainEnvironmentstring

The ID of the main environment for a multi-environment ActiveGate.

modulesActiveGateModule[]

A list of modules of the ActiveGate.

networkAddressesstring[]

A list of network addresses of the ActiveGate.

networkZonestring

The network zone of the ActiveGate.

offlineSinceinteger

The timestamp since when the ActiveGate is offline.

The null value means the ActiveGate is online.

osArchitecturestring

The OS architecture that the ActiveGate is running on.

  • S390
  • X86
  • ARM
osBitnessstring

The OS bitness that the ActiveGate is running on.

  • 64
osTypestring

The OS type that the ActiveGate is running on.

  • LINUX
  • WINDOWS
typestring

The type of the ActiveGate.

  • CLUSTER
  • ENVIRONMENT
  • ENVIRONMENT_MULTI
versionstring

The current version of the ActiveGate in the <major>.<minor>.<revision>.<timestamp> format.

The ActiveGateTokenInfoDto object

Information about ActiveGate token.

ElementTypeDescription
environmentIdstring

The environment ID to which the token belongs.

Only available if more than one environment is supported.

idstring

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

statestring

State of the ActiveGate token.

  • ABSENT
  • EXPIRING
  • INVALID
  • UNKNOWN
  • UNSUPPORTED
  • VALID

The ActiveGateAutoUpdateConfig object

Configuration of the ActiveGate auto-updates.

ElementTypeDescription
effectiveSettingstring

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
settingstring

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

ElementTypeDescription
numberinteger

The number of hosts currently connected to the ActiveGate

The ActiveGateModule object

Information about ActiveGate module

ElementTypeDescription
attributesobject

The attributes of the ActiveGate module.

enabledboolean

The module is enabled (true) or disabled (false).

misconfiguredboolean

The module is misconfigured (true) or not (false).

typestring

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
versionstring

The version of the ActiveGate module.

Response body JSON model

{
  "activeGateTokens": [
    {
      "environmentId": "string",
      "id": "dt0g02.4KWZO5EF",
      "state": "ABSENT"
    }
  ],
  "autoUpdateSettings": {
    "effectiveSetting": "ENABLED",
    "setting": "INHERITED"
  },
  "autoUpdateStatus": "OUTDATED",
  "connectedHosts": {
    "number": 150
  },
  "containerized": true,
  "environments": [
    "string"
  ],
  "group": "default",
  "hostname": "exampleHostname",
  "id": "0x3efdd091",
  "loadBalancerAddresses": [
    "string"
  ],
  "mainEnvironment": "d1bf4a7e-666b-43af-9f45-718g98372e2f",
  "modules": [
    {
      "attributes": {},
      "enabled": true,
      "misconfigured": true,
      "type": "KUBERNETES",
      "version": "string"
    }
  ],
  "networkAddresses": [
    "string"
  ],
  "networkZone": "exampleNetworkZone",
  "offlineSince": 1582031917814,
  "osArchitecture": "X86",
  "osBitness": "64",
  "osType": "WINDOWS",
  "type": "ENVIRONMENT",
  "version": "1.185.0.20200201-120000"
}

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/876651882

Response 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

Related topics