Deployment API - View connectivity information for OneAgent

Gets the connectivity information for OneAgent.

The request produces an application/json payload.

GET	ManagedDynatrace for Government	`https://{your-domain}/e/{your-environment-id}/api/v1/deployment/installer/agent/connectioninfo`
	SaaS	`https://{your-environment-id}.live.dynatrace.com/api/v1/deployment/installer/agent/connectioninfo`
	Environment ActiveGate	`https://{your-activegate-domain}/e/{your-environment-id}/api/v1/deployment/installer/agent/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

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
version	string	The version of the OneAgent for which you're requesting connectivity information, in the `1.221` format. Set this parameter to get the best format of endpoint list for optimal performance.	query	optional

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

version

string

The version of the OneAgent for which you're requesting connectivity information, in the 1.221 format.

Set this parameter to get the best format of endpoint list for optimal performance.

query

optional

Response

Response codes

Code	Type	Description
200	ConnectionInfo	Success

Response body objects

The `ConnectionInfo` object

OneAgent connectivity information.

Element	Type	Description
communicationEndpoints	string[]	The list of endpoints to connect to the Dynatrace environment. The list is sorted by endpoint priority, descending.
formattedCommunicationEndpoints	string[]	The formatted list of endpoints to connect to the Dynatrace environment.
tenantToken	string	The internal token that is used for authentication when OneAgent connects to the Dynatrace cluster to send data.
tenantUUID	string	The ID of your Dynatrace environment.

Response body JSON model

json
{
  "communicationEndpoints": [
    "string"
  ],
  "formattedCommunicationEndpoints": [
    "string"
  ],
  "tenantToken": "string",
  "tenantUUID": "string"
}

Deployment API - View connectivity information for OneAgent

Authentication

Parameters

Response

Response codes

Response body objects

The ConnectionInfo object

Response body JSON model

The `ConnectionInfo` object