• Home
  • Dynatrace API
  • Environment
  • Settings
  • Schemas
  • Settings zones

Settings API - Settings zones schema table

Settings zones (builtin:settings-zones)

Settings zones enable defining fine grained access rights to parts of an environment.

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

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
idSettings zone idtext-required
displayNameSettings zone display nametext-optional
entitySelectorRulesEntity selector rulesset-required

Request body objects

The EntitySelectorRule object
PropertyLabelTypeDescriptionRequired
enabledEnabledboolean-required
meTypeMonitored entity typeenum

Rules can only be applied to the selected type

required
entitySelectorEntity selectortext

The documentation of the entity selector can be found here. The type is optional here (already defined above).

required