• Home
  • Dynatrace API
  • Environment
  • Deployment
  • OneAgent
  • View connectivity info

Deployment API - View connectivity information for OneAgent

Gets the connectivity information for OneAgent.

The request produces an application/json payload.

GETManaged 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 PaaS integration - Installer download (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
versionstring

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.

queryoptional

Response

Response codes

CodeTypeDescription
200ConnectionInfo

Success

Response body objects

The ConnectionInfo object

OneAgent connectivity information.

ElementTypeDescription
tenantUUIDstring

The ID of your Dynatrace environment.

Can be null.

tenantTokenstring

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

Can be null.

communicationEndpointsstring[]

The list of endpoints to connect to the Dynatrace environment. The list is sorted by endpoint priority, descending.

Can be null.

formattedCommunicationEndpointsstring[]

The formatted list of endpoints to connect to the Dynatrace environment.

Can be null.

Response body JSON model

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