Try it free

Create an EdgeConnect

  • Latest Dynatrace
  • Reference
  • Published Oct 13, 2026

Create an EdgeConnect in Dynatrace with the EdgeConnect API, setting host patterns, mappings, and optional OAuth client details in one request.

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

Overview

You can either specify a UUID in the request body or a random UUID will be assigned to the created EdgeConnect configuration.

The name must not be longer than 50 characters and must be 'RFC 1123' compliant. The OAuth client ID is optional. If no OAuth client ID is provided an OAuth client must be generated for that EdgeConnect. This additionally requires the oauth2:clients:manage scope allowing generation of OAuth clients with the app-engine:edge-connects:connect scope, e.g. via the following policy statement: ALLOW oauth2:clients:manage where oauth2:scopes='app-engine:edge-connects:connect' The oauth2:clients:manage scope is not required if you provide an OAuth client ID.

The OAuth client ID, secret and resource will be returned in the response. The OAuth client secret is not retrievable later on.

Authentication

To execute this request, you need a platform token or OAuth access token with app-engine:edge-connects:write scope. To learn how to obtain and use it, see Tokens and authentication.

Parameters

ParameterTypeDescriptionInRequired
bodyEdgeConnect

Maps the specified host patterns to this EdgeConnect

bodyRequired

Request body objects

The EdgeConnect object

Maps the specified host patterns to this EdgeConnect

ElementTypeDescriptionRequired
idstring-Optional
nameEdgeConnectName-Required
hostPatternsHostPattern[]-Required
hostMappingsHostMapping[]-Optional
oauthClientIdstring

Id of OAuth client used to connect by the EdgeConnect

Optional
oauthClientSecretstring

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

Optional
oauthClientResourcestring

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

Optional
modificationInfoModificationInfo-Optional
metadataMetadata-Optional
managedByDynatraceOperatorboolean

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

Optional

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

ElementTypeDescriptionRequired
fromstring-Required
tostring-Required

The ModificationInfo object

ElementTypeDescriptionRequired
lastModifiedBystring-Required
lastModifiedTimestring-Required

The Metadata object

ElementTypeDescriptionRequired
instancesEdgeConnectInstance[]-Optional
oauthClientStatusstring

The status of the OAuth client

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

The EdgeConnectInstance object

ElementTypeDescriptionRequired
versionstring-Optional
instanceIdstring-Optional

Request body JSON model

This is a model of the request body, showing the possible elements. It has to be adjusted for usage in an actual request.

{
  "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
}

Response

Response codes

CodeTypeDescription
201EdgeConnect

The EdgeConnect has been created successfully

400ErrorResponse

Bad Request

default--

Response body objects

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-

The ErrorResponse object

ElementTypeDescription
errorError-

The Error object

ElementTypeDescription
codeinteger-
messagestring-
detailsErrorDetails-

The ErrorDetails object

ElementTypeDescription
constraintViolationsConstraintViolation[]-
missingScopesstring[]-
missingPermissionsstring[]-

The ConstraintViolation object

ElementTypeDescription
messagestring-
pathstring-
parameterLocationstring-

Response body JSON models

{
  "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
}
{
  "error": {
    "code": 1,
    "message": "string",
    "details": {
      "constraintViolations": [
        {
          "error": {
            "code": 400,
            "message": "Constraints violated. Properties already exist in another configuration.",
            "details": {
              "constraintViolations": [
                {
                  "path": "hostPatterns[0]",
                  "message": "Host pattern must be unique across configurations.\nHost pattern 'myjira.com' already exists in EdgeConnect configuration 'InternalServices'."
                }
              ]
            }
          }
        }
      ],
      "missingScopes": [
        "string"
      ],
      "missingPermissions": [
        "string"
      ]
    }
  }
}
Related tags
Platform APIDynatrace Platform