Get an EdgeConnect configuration in Dynatrace with the EdgeConnect API by ID, including its host patterns, mappings, and OAuth settings.
| GET | SaaS | https://{your-environment-id}.apps.dynatrace.com/v1/edge-connects/{edgeConnectId} |
You provide the edgeConnectId path parameter to retrieve one EdgeConnect configuration. The response returns the EdgeConnect configuration for that ID.
To execute this request, you need a platform token or OAuth access token with app-engine:edge-connects:read scope. To learn how to obtain and use it, see Tokens and authentication.
| Parameter | Type | Description | In | Required |
|---|---|---|---|---|
| edgeConnectId | string | Specify the ID of the EdgeConnect | path | Required |
| Code | Type | Description |
|---|---|---|
| 200 | Edge | The EdgeConnect configuration |
| default | - | - |
EdgeConnect objectMaps the specified host patterns to this EdgeConnect
| Element | Type | Description |
|---|---|---|
| id | string | - |
| name | Edge | - |
| hostPatterns | Host | - |
| hostMappings | Host | - |
| oauthClientId | string | Id of OAuth client used to connect by the EdgeConnect |
| oauthClientSecret | string | Secret of OAuth client used to connect by the EdgeConnect. Only provided when creating a new EdgeConnect. |
| oauthClientResource | string | Resource of OAuth client used to connect by the EdgeConnect. Only provided when creating a new EdgeConnect. |
| modificationInfo | Modification | - |
| metadata | Metadata | - |
| managedByDynatraceOperator | boolean | Flag to identify if an EdgeConnect is managed by the Dynatrace operator. False by default! |
EdgeConnectName objectHostPattern objectEither an IP, or a domain name which may contain a wildcard ('') as the leftmost label. If a '' is used, it must be followed by at least two labels.
HostMapping objectTodo
| Element | Type | Description |
|---|---|---|
| from | string | - |
| to | string | - |
ModificationInfo object| Element | Type | Description |
|---|---|---|
| lastModifiedBy | string | - |
| lastModifiedTime | string | - |
Metadata object| Element | Type | Description |
|---|---|---|
| instances | Edge | - |
| oauthClientStatus | string | The status of the OAuth client The element can hold these values
|
EdgeConnectInstance object| Element | Type | Description |
|---|---|---|
| version | string | - |
| instanceId | string | - |
{"id": "11111111-2222-4444-3333-555555555555","name": "internal-services","hostPatterns": ["*.internal.org"],"hostMappings": [{"from": "test.local","to": "kubernetes.my.cluster.local"}],"oauthClientId": "dt0s02.AIOUP56P","oauthClientSecret": "dt0s02.AIOUP56P.5ODBJEQYBA4KLD2F6F6EHQZKYK5Q45RARKVCHICXKLMAXVVLIH2L6N5RLMDDY4QA","oauthClientResource": "urn:dtenvironment:wu31a2p3","modificationInfo": {"lastModifiedBy": "12345678-abcd-efgh-1234-123456789","lastModifiedTime": "2022-01-01T01:02:03.165Z"},"metadata": {"instances": [{"version": "1.46.2","instanceId": "string"}],"oauthClientStatus": "ACTIVE"},"managedByDynatraceOperator": false}