Management zones API - PUT a management zone
deprecated
This API is deprecated. Use the Settings API with the Management zones settings (builtin:management-zones) schema instead.
Updates the specified management zone.
The request consumes and produces an application/json payload.
| PUT | SaaS | https://{your-environment-id}.live.dynatrace.com/api/config/v1/managementZones/{id} |
| Environment ActiveGate | https://{your-activegate-domain}:9999/e/{your-environment-id}/api/config/v1/managementZones/{id} |
Authentication
To execute this request, you need an access token with WriteConfig scope.
To learn how to obtain and use it, see Tokens and authentication.
Parameters
To find all JSON models that depend on the type of the model, refer to JSON models.
The ID of the management zone to be updated.
If you set the ID in the body as well, it must match this ID.
The JSON body of the request. Contains updated parameters of the management zone.
Request body objects
The ManagementZone object
The configuration of the management zone. It defines how the management zone applies.
The description of the management zone.
A list of dimensional data rules for management zone usage.
If several rules are specified, the OR logic applies.
A list of entity-selector based rules for management zone usage.
If several rules are specified, the OR logic applies.
The ID of the management zone.
The name of the management zone.
A list of rules for management zone usage.
If several rules are specified, the OR logic applies.
The MzDimensionalRule object
The dimensional rule of the management zone usage. It defines how the management zone applies.
Each rule is evaluated independently of all other rules.
The target of the rule.
ANYLOGMETRIC
A list of conditions for the management zone.
The management zone applies only if all conditions are fulfilled.
The rule is enabled (true) or disabled (false).
The MzDimensionalRuleCondition object
A condition of the management zone dimensional rule.
The type of the condition.
DIMENSIONLOG_FILE_NAMEMETRIC_KEY
The reference value for comparison.
For conditions of the DIMENSION type, specify the key here.
How we compare the values.
BEGINS_WITHEQUALS
The value of the dimension.
Only applicable when the conditionType is set to DIMENSION.
The EntitySelectorBasedMzRule object
The entity-selector-based rule for management zone usage. It allows adding entities to a management zone via an entity selector.
The rule is enabled (true) or disabled (false).
The entity selector string, by which the entities are selected.
The ConfigurationMetadata object
Metadata useful for debugging
Dynatrace version.
A sorted list of the version numbers of the configuration.
A sorted list of version numbers of the configuration.
The MzRule object
The rule of the management zone usage. It defines how the management zone applies.
Each rule is evaluated independently of all other rules.
A list of matching rules for the management zone.
The management zone applies only if all conditions are fulfilled.
The rule is enabled (true) or disabled (false).
How to apply the management zone to underlying entities:
SERVICE_TO_HOST_LIKE: Apply to underlying hosts of matching services.SERVICE_TO_PROCESS_GROUP_LIKE: Apply to underlying process groups of matching services.PROCESS_GROUP_TO_HOST: Apply to underlying hosts of matching process groups.PROCESS_GROUP_TO_SERVICE: Apply to all services provided by matching process groups.HOST_TO_PROCESS_GROUP_INSTANCE: Apply to processes running on matching hosts.CUSTOM_DEVICE_GROUP_TO_CUSTOM_DEVICE: Apply to custom devices in matching custom device groups.AZURE_TO_PG: Apply to process groups connected to matching Azure entities.AZURE_TO_SERVICE: Apply to services provided by matching Azure entities.
AZURE_TO_PGAZURE_TO_SERVICECUSTOM_DEVICE_GROUP_TO_CUSTOM_DEVICEHOST_TO_PROCESS_GROUP_INSTANCEPROCESS_GROUP_TO_HOSTPROCESS_GROUP_TO_SERVICESERVICE_TO_HOST_LIKESERVICE_TO_PROCESS_GROUP_LIKE
The type of Dynatrace entities the management zone can be applied to.
APPMON_SERVERAPPMON_SYSTEM_PROFILEAWS_ACCOUNTAWS_APPLICATION_LOAD_BALANCERAWS_AUTO_SCALING_GROUPAWS_CLASSIC_LOAD_BALANCERAWS_NETWORK_LOAD_BALANCERAWS_RELATIONAL_DATABASE_SERVICEAZUREBROWSER_MONITORCLOUD_APPLICATIONCLOUD_APPLICATION_NAMESPACECLOUD_FOUNDRY_FOUNDATIONCUSTOM_APPLICATIONCUSTOM_DEVICECUSTOM_DEVICE_GROUPDATA_CENTER_SERVICEENTERPRISE_APPLICATIONESXI_HOSTEXTERNAL_MONITORHOSTHOST_GROUPHTTP_MONITORKUBERNETES_CLUSTERKUBERNETES_SERVICEMOBILE_APPLICATIONMULTIPROTOCOL_MONITOROPENSTACK_ACCOUNTPROCESS_GROUPQUEUESERVICEWEB_APPLICATION
The EntityRuleEngineCondition object
A condition defines how to execute matching logic for an entity.
Defines how the matching is actually performed: what and how are we comparing.
The actual set of fields and possible values of the operator field depend on the type of the comparison. Find the list of actual objects in the description of the type field or see JSON models.
The key to identify the data we're matching.
The actual set of fields and possible values depend on the type of the key. Find the list of actual objects in the description of the type field or see JSON models.
The ComparisonBasic object
Defines how the matching is actually performed: what and how are we comparing.
The actual set of fields and possible values of the operator field depend on the type of the comparison. Find the list of actual objects in the description of the type field or see JSON models.
Reverses the comparison operator. For example it turns the begins with into does not begin with.
Operator of the comparison. You can reverse it by setting negate to true.
Possible values depend on the type of the comparison. Find the list of actual models in the description of the type field and check the description of the model you need.
Defines the actual set of fields depending on the value. See one of the following objects:
STRING-> StringComparisonINDEXED_NAME-> IndexedNameComparisonINDEXED_STRING-> IndexedStringComparisonINTEGER-> IntegerComparisonSERVICE_TYPE-> ServiceTypeComparisonPAAS_TYPE-> PaasTypeComparisonCLOUD_TYPE-> CloudTypeComparisonAZURE_SKU-> AzureSkuComparisionAZURE_COMPUTE_MODE-> AzureComputeModeComparisonENTITY_ID-> EntityIdComparisonSIMPLE_TECH-> SimpleTechComparisonSIMPLE_HOST_TECH-> SimpleHostTechComparisonSERVICE_TOPOLOGY-> ServiceTopologyComparisonDATABASE_TOPOLOGY-> DatabaseTopologyComparisonOS_TYPE-> OsTypeComparisonHYPERVISOR_TYPE-> HypervisorTypeComparisionIP_ADDRESS-> IpAddressComparisonOS_ARCHITECTURE-> OsArchitectureComparisonBITNESS-> BitnessComparisionAPPLICATION_TYPE-> ApplicationTypeComparisonMOBILE_PLATFORM-> MobilePlatformComparisonCUSTOM_APPLICATION_TYPE-> CustomApplicationTypeComparisonDCRUM_DECODER_TYPE-> DcrumDecoderComparisonSYNTHETIC_ENGINE_TYPE-> SyntheticEngineTypeComparisonTAG-> TagComparisonINDEXED_TAG-> IndexedTagComparison
APPLICATION_TYPEAZURE_COMPUTE_MODEAZURE_SKUBITNESSCLOUD_TYPECUSTOM_APPLICATION_TYPEDATABASE_TOPOLOGYDCRUM_DECODER_TYPEENTITY_IDHYPERVISOR_TYPEINDEXED_NAMEINDEXED_STRINGINDEXED_TAGINTEGERIP_ADDRESSMOBILE_PLATFORMOS_ARCHITECTUREOS_TYPEPAAS_TYPESERVICE_TOPOLOGYSERVICE_TYPESIMPLE_HOST_TECHSIMPLE_TECHSTRINGSYNTHETIC_ENGINE_TYPETAG
The value to compare to.
The AnyValue object
A schema representing an arbitrary value type.
The ConditionKey object
The key to identify the data we're matching.
The actual set of fields and possible values depend on the type of the key. Find the list of actual objects in the description of the type field or see JSON models.
The attribute to be used for comparison.
APPMON_SERVER_NAMEAPPMON_SYSTEM_PROFILE_NAMEAWS_ACCOUNT_IDAWS_ACCOUNT_NAMEAWS_APPLICATION_LOAD_BALANCER_NAMEAWS_APPLICATION_LOAD_BALANCER_TAGSAWS_AUTO_SCALING_GROUP_NAMEAWS_AUTO_SCALING_GROUP_TAGSAWS_AVAILABILITY_ZONE_NAMEAWS_CLASSIC_LOAD_BALANCER_FRONTEND_PORTSAWS_CLASSIC_LOAD_BALANCER_NAMEAWS_CLASSIC_LOAD_BALANCER_TAGSAWS_NETWORK_LOAD_BALANCER_NAMEAWS_NETWORK_LOAD_BALANCER_TAGSAWS_RELATIONAL_DATABASE_SERVICE_DB_NAMEAWS_RELATIONAL_DATABASE_SERVICE_ENDPOINTAWS_RELATIONAL_DATABASE_SERVICE_ENGINEAWS_RELATIONAL_DATABASE_SERVICE_INSTANCE_CLASSAWS_RELATIONAL_DATABASE_SERVICE_NAMEAWS_RELATIONAL_DATABASE_SERVICE_PORTAWS_RELATIONAL_DATABASE_SERVICE_TAGSAZURE_ENTITY_NAMEAZURE_ENTITY_TAGSAZURE_MGMT_GROUP_NAMEAZURE_MGMT_GROUP_UUIDAZURE_REGION_NAMEAZURE_SCALE_SET_NAMEAZURE_SUBSCRIPTION_NAMEAZURE_SUBSCRIPTION_UUIDAZURE_TENANT_NAMEAZURE_TENANT_UUIDAZURE_VM_NAMEBROWSER_MONITOR_NAMEBROWSER_MONITOR_TAGSCLOUD_APPLICATION_LABELSCLOUD_APPLICATION_NAMECLOUD_APPLICATION_NAMESPACE_LABELSCLOUD_APPLICATION_NAMESPACE_NAMECLOUD_FOUNDRY_FOUNDATION_NAMECLOUD_FOUNDRY_ORG_NAMECUSTOM_APPLICATION_NAMECUSTOM_APPLICATION_PLATFORMCUSTOM_APPLICATION_TAGSCUSTOM_APPLICATION_TYPECUSTOM_DEVICE_DETECTED_NAMECUSTOM_DEVICE_DNS_ADDRESSCUSTOM_DEVICE_GROUP_NAMECUSTOM_DEVICE_GROUP_TAGSCUSTOM_DEVICE_IP_ADDRESSCUSTOM_DEVICE_METADATACUSTOM_DEVICE_NAMECUSTOM_DEVICE_PORTCUSTOM_DEVICE_TAGSCUSTOM_DEVICE_TECHNOLOGYDATA_CENTER_SERVICE_DECODER_TYPEDATA_CENTER_SERVICE_IP_ADDRESSDATA_CENTER_SERVICE_METADATADATA_CENTER_SERVICE_NAMEDATA_CENTER_SERVICE_PORTDATA_CENTER_SERVICE_TAGSDOCKER_CONTAINER_NAMEDOCKER_FULL_IMAGE_NAMEDOCKER_IMAGE_VERSIONDOCKER_STRIPPED_IMAGE_NAMEEC2_INSTANCE_AMI_IDEC2_INSTANCE_AWS_INSTANCE_TYPEEC2_INSTANCE_AWS_SECURITY_GROUPEC2_INSTANCE_BEANSTALK_ENV_NAMEEC2_INSTANCE_IDEC2_INSTANCE_NAMEEC2_INSTANCE_PRIVATE_HOST_NAMEEC2_INSTANCE_PUBLIC_HOST_NAMEEC2_INSTANCE_TAGSENTERPRISE_APPLICATION_DECODER_TYPEENTERPRISE_APPLICATION_IP_ADDRESSENTERPRISE_APPLICATION_METADATAENTERPRISE_APPLICATION_NAMEENTERPRISE_APPLICATION_PORTENTERPRISE_APPLICATION_TAGSESXI_HOST_CLUSTER_NAMEESXI_HOST_HARDWARE_MODELESXI_HOST_HARDWARE_VENDORESXI_HOST_NAMEESXI_HOST_PRODUCT_NAMEESXI_HOST_PRODUCT_VERSIONESXI_HOST_TAGSEXTERNAL_MONITOR_ENGINE_DESCRIPTIONEXTERNAL_MONITOR_ENGINE_NAMEEXTERNAL_MONITOR_ENGINE_TYPEEXTERNAL_MONITOR_NAMEEXTERNAL_MONITOR_TAGSGEOLOCATION_SITE_NAMEGOOGLE_CLOUD_PLATFORM_ZONE_NAMEGOOGLE_COMPUTE_INSTANCE_IDGOOGLE_COMPUTE_INSTANCE_MACHINE_TYPEGOOGLE_COMPUTE_INSTANCE_NAMEGOOGLE_COMPUTE_INSTANCE_PROJECTGOOGLE_COMPUTE_INSTANCE_PROJECT_IDGOOGLE_COMPUTE_INSTANCE_PUBLIC_IP_ADDRESSESHOST_AIX_LOGICAL_CPU_COUNTHOST_AIX_SIMULTANEOUS_THREADSHOST_AIX_VIRTUAL_CPU_COUNTHOST_ARCHITECTUREHOST_AWS_NAME_TAGHOST_AZURE_COMPUTE_MODEHOST_AZURE_SKUHOST_AZURE_WEB_APPLICATION_HOST_NAMESHOST_AZURE_WEB_APPLICATION_SITE_NAMESHOST_BITNESSHOST_BOSH_AVAILABILITY_ZONEHOST_BOSH_DEPLOYMENT_IDHOST_BOSH_INSTANCE_IDHOST_BOSH_INSTANCE_NAMEHOST_BOSH_NAMEHOST_BOSH_STEMCELL_VERSIONHOST_CLOUD_TYPEHOST_CPU_CORESHOST_CUSTOM_METADATAHOST_DETECTED_NAMEHOST_GROUP_IDHOST_GROUP_NAMEHOST_HYPERVISOR_TYPEHOST_IP_ADDRESSHOST_KUBERNETES_LABELSHOST_LOGICAL_CPU_CORESHOST_NAMEHOST_ONEAGENT_CUSTOM_HOST_NAMEHOST_OS_TYPEHOST_OS_VERSIONHOST_PAAS_MEMORY_LIMITHOST_PAAS_TYPEHOST_TAGSHOST_TECHNOLOGYHTTP_MONITOR_NAMEHTTP_MONITOR_TAGSKUBERNETES_CLUSTER_NAMEKUBERNETES_NODE_NAMEKUBERNETES_SERVICE_NAMEMOBILE_APPLICATION_NAMEMOBILE_APPLICATION_PLATFORMMOBILE_APPLICATION_TAGSNAME_OF_COMPUTE_NODENETWORK_AVAILABILITY_MONITOR_NAMENETWORK_AVAILABILITY_MONITOR_TAGSOPENSTACK_ACCOUNT_NAMEOPENSTACK_ACCOUNT_PROJECT_NAMEOPENSTACK_AVAILABILITY_ZONE_NAMEOPENSTACK_PROJECT_NAMEOPENSTACK_REGION_NAMEOPENSTACK_VM_INSTANCE_TYPEOPENSTACK_VM_NAMEOPENSTACK_VM_SECURITY_GROUPPROCESS_GROUP_AZURE_HOST_NAMEPROCESS_GROUP_AZURE_SITE_NAMEPROCESS_GROUP_CUSTOM_METADATAPROCESS_GROUP_DETECTED_NAMEPROCESS_GROUP_IDPROCESS_GROUP_LISTEN_PORTPROCESS_GROUP_NAMEPROCESS_GROUP_PREDEFINED_METADATAPROCESS_GROUP_TAGSPROCESS_GROUP_TECHNOLOGYPROCESS_GROUP_TECHNOLOGY_EDITIONPROCESS_GROUP_TECHNOLOGY_VERSIONQUEUE_NAMEQUEUE_TECHNOLOGYQUEUE_VENDORSERVICE_AKKA_ACTOR_SYSTEMSERVICE_CTG_SERVICE_NAMESERVICE_DATABASE_HOST_NAMESERVICE_DATABASE_NAMESERVICE_DATABASE_TOPOLOGYSERVICE_DATABASE_VENDORSERVICE_DETECTED_NAMESERVICE_ESB_APPLICATION_NAMESERVICE_IBM_CTG_GATEWAY_URLSERVICE_IIB_APPLICATION_NAMESERVICE_MESSAGING_LISTENER_CLASS_NAMESERVICE_NAMESERVICE_PORTSERVICE_PUBLIC_DOMAIN_NAMESERVICE_REMOTE_ENDPOINTSERVICE_REMOTE_SERVICE_NAMESERVICE_TAGSSERVICE_TECHNOLOGYSERVICE_TECHNOLOGY_EDITIONSERVICE_TECHNOLOGY_VERSIONSERVICE_TOPOLOGYSERVICE_TYPESERVICE_WEB_APPLICATION_IDSERVICE_WEB_CONTEXT_ROOTSERVICE_WEB_SERVER_ENDPOINTSERVICE_WEB_SERVER_NAMESERVICE_WEB_SERVICE_NAMESERVICE_WEB_SERVICE_NAMESPACEVMWARE_DATACENTER_NAMEVMWARE_VM_NAMEWEB_APPLICATION_NAMEWEB_APPLICATION_NAME_PATTERNWEB_APPLICATION_TAGSWEB_APPLICATION_TYPE
Defines the actual set of fields depending on the value. See one of the following objects:
PROCESS_CUSTOM_METADATA_KEY-> CustomProcessMetadataConditionKeyHOST_CUSTOM_METADATA_KEY-> CustomHostMetadataConditionKeyPROCESS_PREDEFINED_METADATA_KEY-> ProcessMetadataConditionKeySTRING-> StringConditionKeySTATIC-> StaticConditionKey
HOST_CUSTOM_METADATA_KEYPROCESS_CUSTOM_METADATA_KEYPROCESS_PREDEFINED_METADATA_KEYSTATICSTRING
Request body JSON model
This is a model of the request body, showing the possible elements. It has to be adjusted for usage in an actual request.
{"description": "sampleDescription","dimensionalRules": [{"appliesTo": "METRIC","conditions": [{"conditionType": "DIMENSION","key": "alwaysRequired","ruleMatcher": "EQUALS","value": "requiredForDimension_forbiddenForMetricKeyAndLogFileName"}],"enabled": true}],"entitySelectorBasedRules": [{"enabled": true,"entitySelector": "type(HOST) AND cpuCores(4)"}],"name": "sampleManagementZone","rules": [{"conditions": [{"comparisonInfo": {"caseSensitive": false,"negate": false,"operator": "BEGINS_WITH","type": "STRING","value": "sample"},"key": {"attribute": "SERVICE_DATABASE_NAME"}},{"comparisonInfo": {"negate": false,"operator": "EXISTS","type": "STRING"},"key": {"attribute": "SERVICE_WEB_SERVER_NAME"}},{"comparisonInfo": {"caseSensitive": false,"negate": false,"operator": "BEGINS_WITH","type": "STRING","value": "sample"},"key": {"attribute": "PROCESS_GROUP_CUSTOM_METADATA","dynamicKey": {"key": "kubernetes.io/limit-ranger","source": "KUBERNETES"},"type": "PROCESS_CUSTOM_METADATA_KEY"}}],"enabled": true,"propagationTypes": ["SERVICE_TO_HOST_LIKE"],"type": "SERVICE"}]}
Response
Response codes
Success. The management zone has been created. The response contains the ID of the new zone.
Success. The management zone has been updated. Response doesn't have a body.
Response body objects
The EntityShortRepresentation object
The short representation of a Dynatrace entity.
A short description of the Dynatrace entity.
The ID of the Dynatrace entity.
The name of the Dynatrace entity.
Response body JSON model
{"description": "Dynatrace entity for the REST API example","id": "6a98d7bc-abb9-44f8-ae6a-73e68e71812a","name": "Dynatrace entity"}
Validate payload
We recommend that you validate the payload before submitting it with an actual request. A response code of 204 indicates a valid payload.
The request consumes an application/json payload.
| POST | SaaS | https://{your-environment-id}.live.dynatrace.com/api/config/v1/managementZones/{id}/validator |
| Environment ActiveGate | https://{your-activegate-domain}:9999/e/{your-environment-id}/api/config/v1/managementZones/{id}/validator |
Authentication
To execute this request, you need an access token with WriteConfig scope.
To learn how to obtain and use it, see Tokens and authentication.
Response
Response codes
Validated. The submitted configuration is valid. Response does not have a body.
Example
In this example, the request updates the Mainframe management zone from the POST request example. It adds the rule to include hosts with the z/OS architecture to the management zone.
The API token is passed in the Authorization header.
The request body is lengthy, so it is truncated in the Curl section. See the full body in the Request body section. You can download or copy the example request body to try it out on your own.
Curl
curl -L -X PUT 'https://mySampleEnv.live.dynatrace.com/api/config/v1/managementZones/2072664797514502900' \-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \-H 'Content-Type: application/json' \--data-raw '{ <truncated - see the Request body section > }'
Request URL
https://mySampleEnv.live.dynatrace.com/api/config/v1/managementZones/2072664797514502900
Request body
{"id": "2072664797514502900","name": "Mainframe","rules": [{"type": "SERVICE","enabled": true,"propagationTypes": ["SERVICE_TO_PROCESS_GROUP_LIKE"],"conditions": [{"key": {"attribute": "HOST_ARCHITECTURE"},"comparisonInfo": {"type": "OS_ARCHITECTURE","operator": "EQUALS","value": "ZOS","negate": false}}]},{"type": "HOST","enabled": true,"propagationTypes": [],"conditions": [{"key": {"attribute": "HOST_ARCHITECTURE"},"comparisonInfo": {"type": "OS_ARCHITECTURE","operator": "EQUALS","value": "ZOS","negate": false}}]}]}
Response code
204
Result
The updated management zone looks like this in the UI:
