Deployment API - View connectivity information for OneAgent

  • Reference
  • Published Aug 28, 2019

Gets the connectivity information for OneAgent.

The request produces an application/json payload.

GETSaaShttps://{your-environment-id}.live.dynatrace.com/api/v1/deployment/installer/agent/connectioninfo
Environment ActiveGatehttps://{your-activegate-domain}:9999/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

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

4XXErrorEnvelope

Client side error.

5XXErrorEnvelope

Server side error.

Response body objects

The ConnectionInfo object

OneAgent connectivity information.

ElementTypeDescription
communicationEndpointsstring[]

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

formattedCommunicationEndpointsstring

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

tenantTokenstring

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

tenantUUIDstring

The ID of your Dynatrace environment.

The ErrorEnvelope object

ElementTypeDescription
errorError-

The Error object

ElementTypeDescription
codeinteger

The HTTP status code

constraintViolationsConstraintViolation[]

A list of constraint violations

messagestring

The error message

The ConstraintViolation object

A list of constraint violations

ElementTypeDescription
locationstring-
messagestring-
parameterLocationstring-
The element can hold these values
  • HEADER
  • PATH
  • PAYLOAD_BODY
  • QUERY
pathstring-

Response body JSON models

{
  "communicationEndpoints": [
    "string"
  ],
  "formattedCommunicationEndpoints": "string",
  "tenantToken": "string",
  "tenantUUID": "string"
}
{
  "error": {
    "code": 1,
    "constraintViolations": [
      {
        "location": "string",
        "message": "string",
        "parameterLocation": "HEADER",
        "path": "string"
      }
    ],
    "message": "string"
  }
}