Try it free

Settings API - EdgeConnect Configuration schema table

  • Published Jun 15, 2026

EdgeConnect Configuration (builtin:edge-connect.configuration)

Configuration for EdgeConnect configs that enable Dynatrace to route requests into customer environments.

An EdgeConnect maps specified host patterns and host mappings to an EdgeConnect config. Host patterns define which hosts are routed through this EdgeConnect. Host mappings allow optional rewriting of hostnames.

Schema IDSchema groupsScope
builtin:edge-connect.configuration-
environment
Retrieve schema via Settings API
GETManagedhttps://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:edge-connect.configuration
GETSaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:edge-connect.configuration
GETEnvironment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:edge-connect.configuration

Authentication

To execute this request, you need an access token with Read settings (settings.read) scope. To learn how to obtain and use it, see Tokens and authentication.

Parameters

PropertyTypeDescriptionRequired
Name
name		text

The name of the EdgeConnect configuration.

Required
Host Patterns
hostPatterns		set

Host patterns defining which hosts are routed through this EdgeConnect. Each pattern is either an IP or a domain name which may contain a wildcard ('*') as the leftmost label.

Required
Host Mappings
hostMappings		HostMapping[]

Optional host mappings for rewriting source hostnames to target hostnames. The 'from' field must be unique across all mappings.

Required
OAuth Client ID
oauthClientId		text

The OAuth 2.0 client identifier for this EdgeConnect.

Required
Managed by Dynatrace Operator
managedByDynatraceOperator		boolean

Indicates whether this EdgeConnect is managed by the Dynatrace Operator.

Optional
The HostMapping object
PropertyTypeDescriptionRequired
From
from		text

The source hostname to be mapped. Must be a valid IP or domain name.

Required
To
to		text

The target hostname to map to. Must be a valid IP or domain name.

Required