Try it free

List EdgeConnects

  • Latest Dynatrace
  • Reference
  • Published Oct 13, 2026

List EdgeConnects in Dynatrace with the EdgeConnect API, using filters, paging, and optional extra fields to refine the returned configurations.

GETSaaShttps://{your-environment-id}.apps.dynatrace.com/v1/edge-connects

Overview

You use the filter, page, page-size, and add-fields query parameters to control which EdgeConnect configurations appear and how much detail you receive. The response returns a list of all EdgeConnects.

Authentication

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.

Parameters

ParameterTypeDescriptionInRequired
add-fieldsstring

Provide a comma separated list of additional properties to be included in the response.

queryOptional
filterstring

The filter parameter for filtering the set of returned resources If this parameter is omitted, no filtering is applied and all states will be returned.

Filtering by string type parameters name, modificationInfo.lastModifiedBy when using one of the operators contains, starts-with and ends-with is case insensitive.

When using the operators =and !=, filtering is case sensitive.

The following fields are legal filtering parameters - any other field names will result in a HTTP 400 response:

  • name, supported operators: =, !=, contains, starts-with, ends-with

  • hostPatterns, supported operators: =, !=, contains, starts-with, ends-with

  • oauthClientId, supported operators: =, !=, contains, starts-with, ends-with

  • modificationInfo.lastModifiedTime, supported operators: =, !=, <, <=, >, >=

  • modificationInfo.lastModifiedBy, supported operators: =, !=, contains, starts-with, ends-with

The following constraints apply:

  • Field names are case-sensitive.

  • Conditions can be connected via operators and and or. A single condition can be negated by not.

  • Strings must be enclosed in single quotes. e.g. name contains 'my-string'

  • Single quotes within a string must be escaped with a backslash: e.g. name starts-with 'it\'s a string'

  • Maximum nesting depth (via brackets) is 2.

  • Maximum length is 256 characters.

Examples:

  • name starts-with 'game-'

  • modificationInfo.lastModifiedTime >= '2022-07-01T00:10:05.000Z' and not (name contains 'new')

queryOptional
pageinteger

The index of the page to return. The first page will be returned if this parameters isn't specified.

queryOptional
page-sizeinteger

The number of resources to return in a single request. 1000 by default.

queryOptional

Response

Response codes

CodeTypeDescription
200EdgeConnects

A list of all EdgeConnects

default--

Response body objects

The EdgeConnects object

ElementTypeDescription
edgeConnectsEdgeConnect[]-
totalCountinteger

Total number of currently configured EdgeConnects

The EdgeConnect object

Maps the specified host patterns to this EdgeConnect

ElementTypeDescription
idstring-
nameEdgeConnectName-
hostPatternsHostPattern[]-
hostMappingsHostMapping[]-
oauthClientIdstring

Id of OAuth client used to connect by the EdgeConnect

oauthClientSecretstring

Secret of OAuth client used to connect by the EdgeConnect. Only provided when creating a new EdgeConnect.

oauthClientResourcestring

Resource of OAuth client used to connect by the EdgeConnect. Only provided when creating a new EdgeConnect.

modificationInfoModificationInfo-
metadataMetadata-
managedByDynatraceOperatorboolean

Flag to identify if an EdgeConnect is managed by the Dynatrace operator. False by default!

The EdgeConnectName object

The HostPattern object

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

The HostMapping object

Todo

ElementTypeDescription
fromstring-
tostring-

The ModificationInfo object

ElementTypeDescription
lastModifiedBystring-
lastModifiedTimestring-

The Metadata object

ElementTypeDescription
instancesEdgeConnectInstance[]-
oauthClientStatusstring

The status of the OAuth client

The element can hold these values
  • ACTIVE
  • INACTIVE
  • PENDING_DELETION
  • DELETED

The EdgeConnectInstance object

ElementTypeDescription
versionstring-
instanceIdstring-

Response body JSON models

{
  "edgeConnects": [
    {
      "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
    }
  ],
  "totalCount": 1
}
Related tags
Platform APIDynatrace Platform