Deployment API - GET connectivity information for OneAgent

Gets the connectivity information for OneAgent.

The request produces an application/json payload.

GET
  • Managed 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 the PaaS token (InstallerDownload) of your environment. To learn how to obtain and use it, see Access tokens.

Parameters

Parameter Type Description In Required
networkZone string

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

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

Success

Response body

The ConnectionInfo object

OneAgent connectivity information.

Element Type Description
tenantUUID string

The ID of your Dynatrace environment.

tenantToken string

The internal token that is used for authentication when OneAgent connects to the Dynatrace cluster to send data.

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.