• Home
  • API
  • Environment
  • Settings
  • Schemas
  • Remote environments

Settings API - Remote environments schema table

Remote environments (builtin:remote.environment)

Configure connections to other Dynatrace environments for cross-environment capabilities (e.g. dashboards)

For help on remote environments, see Remote environment API documentation

Schema IDSchema groupsScope
builtin:remote.environment
  • group:integration.external
  • group:integration
environment
Retrieve schema via Settings API
GETManagedhttps://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:remote.environment
SaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:remote.environment
Environment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:remote.environment

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

PropertyLabelTypeDescriptionRequired
nameNametext-required
uriRemote environment URItext

Specify the full URI to the remote environment. Your local environment will have to be able to connect this URI on a network level.

required
networkScopeNetwork scopeenum
  • External: The remote environment is located in an another network.
  • Internal: The remote environment is located in the same network.
  • Cluster: The remote environment is located in the same cluster.

Dynatrace SaaS can only use External.

required
tokenTokensecret

Provide a valid token created on the remote environment.

required