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.dexp.ae/api/v1/deployment/installer/agent/connectioninfo

Parameters

The request doesn't provide any configurable parameters.

Response format

The ConnectionInfo object

OneAgent connectivity information.

Element Type Description
tenantUUID string

The ID of your DESK environment.

tenantToken string

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

communicationEndpoints string[]

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