ActiveGates API - GET an ActiveGate

Gets the information about the specified ActiveGate.

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/{agId}
  • SaaS https://{your-environment-id}.live.dynatrace.com/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 format

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