Deployment API - GET connectivity information for ActiveGate

Gets the connectivity information for ActiveGate.

The request produces an application/json payload.

GETSaaShttps://{your-environment-id}.live.dynatrace.com/api/v1/deployment/installer/gateway/connectioninfo
Environment ActiveGatehttps://{your-activegate-domain}:9999/e/{your-environment-id}/api/v1/deployment/installer/gateway/connectioninfo

Authentication

To execute this request, you need an access token with InstallerDownload scope.

To learn how to obtain and use it, see Tokens and authentication.

Parameters

Parameter
Type
Description
In
Required
networkZone
string

The network zone you want the result to be configured with.

query
optional
defaultZoneFallback
boolean

Set true to perform a fallback to the default network zone if the provided network zone does not exist.

query
optional

Response

Response codes

Code
Type
Description
200

Success

4XX

Client side error.

5XX

Server side error.

Response body objects

The ActiveGateConnectionInfo object

Connectivity information for an Environment ActiveGate (except ActiveGate tokens)

Element
Type
Description
communicationEndpoints
string
-
tenantToken
string
-
tenantUUID
string
-

Response body JSON model

{
  "communicationEndpoints": "string",
  "tenantToken": "string",
  "tenantUUID": "string"
}