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 ID | Schema groups | Scope |
|---|---|---|
builtin:remote.environment |
| environment |
| GET | Managed | https://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:remote.environment |
| SaaS | https://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:remote.environment | |
| Environment ActiveGate | https://{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
| Property | Label | Type | Description | Required |
|---|---|---|---|---|
| name | Name | text | - | required |
| uri | Remote environment URI | text | 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 |
| networkScope | Network scope | enum |
Dynatrace SaaS can only use External. | required |
| token | Token | secret | Provide a valid token created on the remote environment. | required |