ActiveGate API - GET an ActiveGate

Gets the information about the specified ActiveGate.

The request produces an application/json payload.

GET
  • Managed 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 the Read ActiveGates (activeGates.read) permission assigned to your API token. 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 Description
200

Success

404

Not found. See response body for details.

Response body

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.

autoUpdateStatus string

The current status of auto-updates of the ActiveGate.

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.

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

The ActiveGateModule object

Information about ActiveGate module

Element Type Description
misconfigured boolean

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

enabled boolean

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

type string

The type of ActiveGate module.

attributes object

The attributes of the ActiveGate module.

version string

The version of the ActiveGate module.

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 INHERITED, the setting is inherited from the global configuration set on the environment or Managed cluster level.

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.

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