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

Early Adopter

This request is an Early Adopter release and may be changed in non-compatible way.

GET
  • Managed https://{your-domain}/e/{your-environment-id}/api/v2/activeGates
  • SaaS https://{your-environment-id}.live.dynatrace.com/api/v2/activeGates

Authentication

To execute this request, you need the Read ActiveGates using API V2 (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
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 osType element can hold these values.
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
type string

Filters the resulting set of ActiveGates by the ActiveGate type.

The type element can hold these values.
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 updateStatus element can hold these values.
query optional
versionCompareType string

Filters the resulting set of ActiveGates by the specified version.

Specify the comparison operator here.

The versionCompareType element can hold these values.
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

Possible values

Possible values for the versionCompareType element:

  • EQUAL
  • GREATER
  • GREATER_EQUAL
  • LOWER
  • LOWER_EQUAL

Possible values for the updateStatus element:

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

Possible values for the type element:

  • ENVIRONMENT
  • ENVIRONMENT_MULTI

Possible values for the osType element:

  • LINUX
  • WINDOWS

Response format

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.

osType string

The OS type that the ActiveGate is running on.

The osType element can hold these values.
autoUpdateStatus string

The current status of auto-updates of the ActiveGate.

The autoUpdateStatus element can hold these values.
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 type element can hold these values.
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.

networkZone string

The network zone of the ActiveGate.

Possible values

Possible values for the type element in the ActiveGate object:

  • CLUSTER
  • ENVIRONMENT
  • ENVIRONMENT_MULTI

Possible values for the autoUpdateStatus element in the ActiveGate object:

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

Possible values for the osType element in the ActiveGate object:

  • LINUX
  • WINDOWS

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

curl -L -X GET 'https://mySampleEnv.live.dynatrace.com/api/v2/activeGates' \
-H 'Authorization: Api-Token abcdefjhij1234567890'

Request URL

https://mySampleEnv.live.dynatrace.com/api/v2/activeGates

Response body

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