Get the connection information an ActiveGate needs to connect to your Dynatrace environment with the Fleet Management API, for example during setup.
| GET | SaaS | https://{your-environment-id}.apps.dynatrace.com/v1/activegate/connection-info |
You use this operation to retrieve the connection information for ActiveGates in your environment. It takes no parameters and returns the connection details with a 200 response. Typical usage is configuring a new ActiveGate, for example in an automated deployment that sets up the connection without manual steps.
To execute this request, you need a platform token or OAuth access token with fleet-management:activegate.connection-info:read scope. To learn how to obtain and use it, see Tokens and authentication.
The request doesn't provide any configurable parameters.
| Code | Type | Description |
|---|---|---|
| 200 | Connection | Success |
| 4XX | Error | Client side error. |
| 5XX | Error | Server side error. |
ConnectionInfo objectConnection info with tenant data and initial tenant endpoint
| Element | Type | Description |
|---|---|---|
| initialEndpoint | string | Initial tenant endpoint. |
| tenantToken | string | Tenant token. |
| tenantUUID | string | Tenant UUID. |
ErrorEnvelope object| Element | Type | Description |
|---|---|---|
| error | Error | - |
Error object| Element | Type | Description |
|---|---|---|
| code | integer | The HTTP status code |
| constraintViolations | Constraint | A list of constraint violations |
| message | string | The error message |
ConstraintViolation objectA list of constraint violations
| Element | Type | Description |
|---|---|---|
| location | string | - |
| message | string | - |
| parameterLocation | string | -The element can hold these values
|
| path | string | - |
{"initialEndpoint": "string","tenantToken": "string","tenantUUID": "string"}
{"error": {"code": 1,"constraintViolations": [{"location": "string","message": "string","parameterLocation": "HEADER","path": "string"}],"message": "string"}}