Deployment API - View 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 an access token with PaaS integration - Installer download (InstallerDownload) scope. To learn how to obtain and use it, see Tokens and authentication.
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 Set this parameter to get the best format of endpoint list for optimal performance. | query | optional |
Response
Response codes
| Code | Type | Description |
|---|---|---|
| 200 | Connection | Success |
Response body objects
The ConnectionInfo object
OneAgent connectivity information.
| Element | Type | Description |
|---|---|---|
| tenantUUID | string | The ID of your Dynatrace environment. Can be |
| tenantToken | string | The internal token that is used for authentication when OneAgent connects to the Dynatrace cluster to send data. Can be |
| communicationEndpoints | string[] | The list of endpoints to connect to the Dynatrace environment. The list is sorted by endpoint priority, descending. Can be |
| formattedCommunicationEndpoints | string[] | The formatted list of endpoints to connect to the Dynatrace environment. Can be |
Response body JSON model
{
"tenantUUID": "string",
"tenantToken": "string",
"communicationEndpoints": [
"string"
],
"formattedCommunicationEndpoints": [
"string"
]
}