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

Settings 2.0 - Management zones settings schema

Management zones settings (builtin:management-zones)

Management zones enable defining fine grained access rights to parts of an environment. A Management zone consists of a set of entities like applications, hosts, process groups, or services.

For each Management zone you can define which user groups have access to them. This way you can ensure the confidentiality of certain parts of an environment and still keep an end to end view across all components for the users that need it.

For value suggestions based on entity data and preview functionality, environment-wide "Access environment" permission is required.

Schema IDSchema groupsScope
builtin:management-zones
  • group:preferences
environment
Retrieve schema via Settings API
GETManagedhttps://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:management-zones
SaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:management-zones
Environment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:management-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
nameManagement zone nametext

Be careful when renaming - if there are policies that are referencing this Management zone, they will need to be adapted to the new name!

required
descriptionDescriptiontext-optional
rulesRulesset-required

Request body objects

The AttributeCondition object
PropertyLabelTypeDescriptionRequired
keyPropertyenum-required
dynamicKeySourceKey sourcetext-required
dynamicKeyDynamic keytext-required
operatorOperatorenum-required
enumValueValuetext-required
stringValueValuetext-required
caseSensitiveCase sensitiveboolean-required
integerValueValueinteger-required
entityIdValuetext-required
tagTagtext

Format: [CONTEXT]tagKey:tagValue

required
The ManagementZoneAttributeRule object
PropertyLabelTypeDescriptionRequired
entityTypeRule applies toenum-required
conditionsConditionsset-required
serviceToHostPropagationApply to underlying hosts of matching servicesboolean-required
serviceToPGPropagationApply to underlying process groups of matching servicesboolean-required
pgToHostPropagationApply to underlying hosts of matching process groupsboolean-required
pgToServicePropagationApply to all services provided by the process groupsboolean-required
hostToPGPropagationApply to processes running on matching hostsboolean-required
customDeviceGroupToCustomDevicePropagationApply to custom devices in a custom device groupboolean-required
azureToServicePropagationApply to services provided by matching Azure entitiesboolean-required
azureToPGPropagationApply to process groups connected to matching Azure entitiesboolean-required
The DimensionCondition object
PropertyLabelTypeDescriptionRequired
conditionTypeTypeenum-required
keyKeytext-required
ruleMatcherOperatorenum-required
valueValuetext-required
The DimensionRule object
PropertyLabelTypeDescriptionRequired
appliesToTypeenum-required
conditionsConditionsset-required
The Rule object
PropertyLabelTypeDescriptionRequired
enabledEnabledboolean-required
typeRule typeenum-required
attributeRule-ManagementZoneAttributeRule-required
dimensionRule-DimensionRule-required
entitySelectorEntity selectortext

The documentation of the entity selector can be found here.

required