Deployment API - GET connectivity information for ActiveGate

  • Reference
  • Published Jul 02, 2020

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

ParameterTypeDescriptionInRequired
networkZonestring

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

queryoptional
defaultZoneFallbackboolean

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

queryoptional

Response

Response codes

CodeTypeDescription
200ActiveGateConnectionInfo

Success

4XXErrorEnvelope

Client side error.

5XXErrorEnvelope

Server side error.

Response body objects

The ActiveGateConnectionInfo object

Connectivity information for an Environment ActiveGate (except ActiveGate tokens)

ElementTypeDescription
communicationEndpointsstring-
tenantTokenstring-
tenantUUIDstring-

Response body JSON model

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