Management zones API - GET a management zone

Gets parameters of the specified management zone.

The request produces an application/json payload.

GET
  • Managed https://{your-domain}/e/{your-environment-id}/api/config/v1/managementZones/{id}
  • SaaS https://{your-environment-id}.live.dynatrace.com/api/config/v1/managementZones/{id}

Authentication

To execute this request, you need the Read configuration (ReadConfig) permission assigned to your API token. To learn how to obtain and use it, see Authentication.

Parameters

Parameter Type Description In Required
id string

The ID of the required management zone.

path required
includeProcessGroupReferences boolean

Flag to include process group references to the response.

Process group references aren't compatible across environments. When this flag is set to false, conditions with process group references will be removed. If that leads to a rule having no conditions, the entire rule will be removed.

query optional

Response format

To find all JSON models that depend on the type of the model, refer to JSON models.

The ManagementZone object

The configuration of the management zone. It defines where the management zone should be applied.

Element Type Description
metadata ConfigurationMetadata
id string

The ID of the management zone.

name string

The name of the management zone.

rules ManagementZoneRule[]

The list of rules to where the management zone applies. Each rule is evaluated independently of all other rules.

The ManagementZoneRule object

A rule defines when to apply a management zone. Each rule is evaluated independently of all other rules.

Element Type Description
type string

The type of Dynatrace entities the management zone can be applied to.

The type element can hold these values.
enabled boolean

The evaluation rule is enabled(true) or disabled(false).

propagationTypes string[]

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.
conditions EntityRuleEngineCondition[]

Matching rules of the management zone. The management zone applies only if all conditions are fulfilled.

The EntityRuleEngineCondition object

A condition defines how to execute matching logic for an entity.

Element Type Description
key ConditionKey
comparisonInfo ComparisonBasic

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. \n\nFind the list of actual models in the description of the type field and check the description of the model you need.

Element Type Description
operator object

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.

value object

The value to compare to.

negate boolean

Reverses the comparison operator. For example it turns the begins with into does not begin with.

type string

Defines the actual set of fields depending on the value. See one of the following objects:

  • STRING -> StringComparison
  • INDEXED_NAME -> IndexedNameComparison
  • INDEXED_STRING -> IndexedStringComparison
  • INTEGER -> IntegerComparison
  • SERVICE_TYPE -> ServiceTypeComparison
  • PAAS_TYPE -> PaasTypeComparison
  • CLOUD_TYPE -> CloudTypeComparison
  • AZURE_SKU -> AzureSkuComparision
  • AZURE_COMPUTE_MODE -> AzureComputeModeComparison
  • ENTITY_ID -> EntityIdComparison
  • SIMPLE_TECH -> SimpleTechComparison
  • SIMPLE_HOST_TECH -> SimpleHostTechComparison
  • SERVICE_TOPOLOGY -> ServiceTopologyComparison
  • DATABASE_TOPOLOGY -> DatabaseTopologyComparison
  • OS_TYPE -> OsTypeComparison
  • HYPERVISOR_TYPE -> HypervisorTypeComparision
  • IP_ADDRESS -> IpAddressComparison
  • OS_ARCHITECTURE -> OsArchitectureComparison
  • BITNESS -> BitnessComparision
  • APPLICATION_TYPE -> ApplicationTypeComparison
  • MOBILE_PLATFORM -> MobilePlatformComparison
  • CUSTOM_APPLICATION_TYPE -> CustomApplicationTypeComparison
  • DCRUM_DECODER_TYPE -> DcrumDecoderComparison
  • SYNTHETIC_ENGINE_TYPE -> SyntheticEngineTypeComparison
  • TAG -> TagComparison
  • INDEXED_TAG -> IndexedTagComparison
The type element can hold these values.

The ConditionKey object

The key to identify the data we're matching.

The actual set of fields and possible values vary, depending on the type of the key.

Find the list of actual objects in the description of the type field.

Element Type Description
attribute string

The attribute to be used for comparision.

The attribute element can hold these values.
type string

Defines the actual set of fields depending on the value. See one of the following objects:

  • PROCESS_CUSTOM_METADATA_KEY -> CustomProcessMetadataConditionKey
  • HOST_CUSTOM_METADATA_KEY -> CustomHostMetadataConditionKey
  • PROCESS_PREDEFINED_METADATA_KEY -> ProcessMetadataConditionKey
  • STRING -> StringConditionKey
The type element can hold these values.

The ConfigurationMetadata object

Metadata useful for debugging

Element Type Description
configurationVersions integer[]

A Sorted list of the version numbers of the configuration.

clusterVersion string

Dynatrace server version.

Possible values

Possible values for the type element in the ComparisonBasic object:

  • APPLICATION_TYPE
  • AZURE_COMPUTE_MODE
  • AZURE_SKU
  • BITNESS
  • CLOUD_TYPE
  • CUSTOM_APPLICATION_TYPE
  • DATABASE_TOPOLOGY
  • DCRUM_DECODER_TYPE
  • ENTITY_ID
  • HYPERVISOR_TYPE
  • INDEXED_NAME
  • INDEXED_STRING
  • INDEXED_TAG
  • INTEGER
  • IP_ADDRESS
  • MOBILE_PLATFORM
  • OS_ARCHITECTURE
  • OS_TYPE
  • PAAS_TYPE
  • SERVICE_TOPOLOGY
  • SERVICE_TYPE
  • SIMPLE_HOST_TECH
  • SIMPLE_TECH
  • STRING
  • SYNTHETIC_ENGINE_TYPE
  • TAG

Possible values for the type element in the ConditionKey object:

  • HOST_CUSTOM_METADATA_KEY
  • PROCESS_CUSTOM_METADATA_KEY
  • PROCESS_PREDEFINED_METADATA_KEY
  • STRING

Possible values for the attribute element in the ConditionKey object:

  • APPMON_SERVER_NAME
  • APPMON_SYSTEM_PROFILE_NAME
  • AWS_ACCOUNT_ID
  • AWS_ACCOUNT_NAME
  • AWS_APPLICATION_LOAD_BALANCER_NAME
  • AWS_APPLICATION_LOAD_BALANCER_TAGS
  • AWS_AUTO_SCALING_GROUP_NAME
  • AWS_AUTO_SCALING_GROUP_TAGS
  • AWS_AVAILABILITY_ZONE_NAME
  • AWS_CLASSIC_LOAD_BALANCER_FRONTEND_PORTS
  • AWS_CLASSIC_LOAD_BALANCER_NAME
  • AWS_CLASSIC_LOAD_BALANCER_TAGS
  • AWS_NETWORK_LOAD_BALANCER_NAME
  • AWS_NETWORK_LOAD_BALANCER_TAGS
  • AWS_RELATIONAL_DATABASE_SERVICE_DB_NAME
  • AWS_RELATIONAL_DATABASE_SERVICE_ENDPOINT
  • AWS_RELATIONAL_DATABASE_SERVICE_ENGINE
  • AWS_RELATIONAL_DATABASE_SERVICE_INSTANCE_CLASS
  • AWS_RELATIONAL_DATABASE_SERVICE_NAME
  • AWS_RELATIONAL_DATABASE_SERVICE_PORT
  • AWS_RELATIONAL_DATABASE_SERVICE_TAGS
  • AZURE_ENTITY_NAME
  • AZURE_ENTITY_TAGS
  • AZURE_MGMT_GROUP_NAME
  • AZURE_MGMT_GROUP_UUID
  • AZURE_REGION_NAME
  • AZURE_SCALE_SET_NAME
  • AZURE_SUBSCRIPTION_NAME
  • AZURE_SUBSCRIPTION_UUID
  • AZURE_TENANT_NAME
  • AZURE_TENANT_UUID
  • AZURE_VM_NAME
  • BROWSER_MONITOR_NAME
  • BROWSER_MONITOR_TAGS
  • CLOUD_APPLICATION_LABELS
  • CLOUD_APPLICATION_NAME
  • CLOUD_APPLICATION_NAMESPACE_LABELS
  • CLOUD_APPLICATION_NAMESPACE_NAME
  • CLOUD_FOUNDRY_FOUNDATION_NAME
  • CLOUD_FOUNDRY_ORG_NAME
  • CUSTOM_APPLICATION_NAME
  • CUSTOM_APPLICATION_PLATFORM
  • CUSTOM_APPLICATION_TAGS
  • CUSTOM_APPLICATION_TYPE
  • CUSTOM_DEVICE_DETECTED_NAME
  • CUSTOM_DEVICE_DNS_ADDRESS
  • CUSTOM_DEVICE_GROUP_NAME
  • CUSTOM_DEVICE_GROUP_TAGS
  • CUSTOM_DEVICE_IP_ADDRESS
  • CUSTOM_DEVICE_METADATA
  • CUSTOM_DEVICE_NAME
  • CUSTOM_DEVICE_PORT
  • CUSTOM_DEVICE_TAGS
  • CUSTOM_DEVICE_TECHNOLOGY
  • DATA_CENTER_SERVICE_DECODER_TYPE
  • DATA_CENTER_SERVICE_IP_ADDRESS
  • DATA_CENTER_SERVICE_METADATA
  • DATA_CENTER_SERVICE_NAME
  • DATA_CENTER_SERVICE_PORT
  • DATA_CENTER_SERVICE_TAGS
  • DOCKER_CONTAINER_NAME
  • DOCKER_FULL_IMAGE_NAME
  • DOCKER_IMAGE_VERSION
  • DOCKER_STRIPPED_IMAGE_NAME
  • EC2_INSTANCE_AMI_ID
  • EC2_INSTANCE_AWS_INSTANCE_TYPE
  • EC2_INSTANCE_AWS_SECURITY_GROUP
  • EC2_INSTANCE_BEANSTALK_ENV_NAME
  • EC2_INSTANCE_ID
  • EC2_INSTANCE_NAME
  • EC2_INSTANCE_PRIVATE_HOST_NAME
  • EC2_INSTANCE_PUBLIC_HOST_NAME
  • EC2_INSTANCE_TAGS
  • ENTERPRISE_APPLICATION_DECODER_TYPE
  • ENTERPRISE_APPLICATION_IP_ADDRESS
  • ENTERPRISE_APPLICATION_METADATA
  • ENTERPRISE_APPLICATION_NAME
  • ENTERPRISE_APPLICATION_PORT
  • ENTERPRISE_APPLICATION_TAGS
  • ESXI_HOST_CLUSTER_NAME
  • ESXI_HOST_HARDWARE_MODEL
  • ESXI_HOST_HARDWARE_VENDOR
  • ESXI_HOST_NAME
  • ESXI_HOST_PRODUCT_NAME
  • ESXI_HOST_PRODUCT_VERSION
  • ESXI_HOST_TAGS
  • EXTERNAL_MONITOR_ENGINE_DESCRIPTION
  • EXTERNAL_MONITOR_ENGINE_NAME
  • EXTERNAL_MONITOR_ENGINE_TYPE
  • EXTERNAL_MONITOR_NAME
  • EXTERNAL_MONITOR_TAGS
  • GEOLOCATION_SITE_NAME
  • GOOGLE_CLOUD_PLATFORM_ZONE_NAME
  • GOOGLE_COMPUTE_INSTANCE_ID
  • GOOGLE_COMPUTE_INSTANCE_MACHINE_TYPE
  • GOOGLE_COMPUTE_INSTANCE_NAME
  • GOOGLE_COMPUTE_INSTANCE_PROJECT
  • GOOGLE_COMPUTE_INSTANCE_PROJECT_ID
  • GOOGLE_COMPUTE_INSTANCE_PUBLIC_IP_ADDRESSES
  • HOST_AIX_LOGICAL_CPU_COUNT
  • HOST_AIX_SIMULTANEOUS_THREADS
  • HOST_AIX_VIRTUAL_CPU_COUNT
  • HOST_ARCHITECTURE
  • HOST_AWS_NAME_TAG
  • HOST_AZURE_COMPUTE_MODE
  • HOST_AZURE_SKU
  • HOST_AZURE_WEB_APPLICATION_HOST_NAMES
  • HOST_AZURE_WEB_APPLICATION_SITE_NAMES
  • HOST_BITNESS
  • HOST_BOSH_AVAILABILITY_ZONE
  • HOST_BOSH_DEPLOYMENT_ID
  • HOST_BOSH_INSTANCE_ID
  • HOST_BOSH_INSTANCE_NAME
  • HOST_BOSH_NAME
  • HOST_BOSH_STEMCELL_VERSION
  • HOST_CLOUD_TYPE
  • HOST_CPU_CORES
  • HOST_CUSTOM_METADATA
  • HOST_DETECTED_NAME
  • HOST_GROUP_ID
  • HOST_GROUP_NAME
  • HOST_HYPERVISOR_TYPE
  • HOST_IP_ADDRESS
  • HOST_KUBERNETES_LABELS
  • HOST_LOGICAL_CPU_CORES
  • HOST_NAME
  • HOST_ONEAGENT_CUSTOM_HOST_NAME
  • HOST_OS_TYPE
  • HOST_OS_VERSION
  • HOST_PAAS_MEMORY_LIMIT
  • HOST_PAAS_TYPE
  • HOST_TAGS
  • HOST_TECHNOLOGY
  • HTTP_MONITOR_NAME
  • HTTP_MONITOR_TAGS
  • KUBERNETES_CLUSTER_NAME
  • KUBERNETES_NODE_NAME
  • MOBILE_APPLICATION_NAME
  • MOBILE_APPLICATION_PLATFORM
  • MOBILE_APPLICATION_TAGS
  • NAME_OF_COMPUTE_NODE
  • OPENSTACK_ACCOUNT_NAME
  • OPENSTACK_ACCOUNT_PROJECT_NAME
  • OPENSTACK_AVAILABILITY_ZONE_NAME
  • OPENSTACK_PROJECT_NAME
  • OPENSTACK_REGION_NAME
  • OPENSTACK_VM_INSTANCE_TYPE
  • OPENSTACK_VM_NAME
  • OPENSTACK_VM_SECURITY_GROUP
  • PROCESS_GROUP_AZURE_HOST_NAME
  • PROCESS_GROUP_AZURE_SITE_NAME
  • PROCESS_GROUP_CUSTOM_METADATA
  • PROCESS_GROUP_DETECTED_NAME
  • PROCESS_GROUP_ID
  • PROCESS_GROUP_LISTEN_PORT
  • PROCESS_GROUP_NAME
  • PROCESS_GROUP_PREDEFINED_METADATA
  • PROCESS_GROUP_TAGS
  • PROCESS_GROUP_TECHNOLOGY
  • PROCESS_GROUP_TECHNOLOGY_EDITION
  • PROCESS_GROUP_TECHNOLOGY_VERSION
  • SERVICE_AKKA_ACTOR_SYSTEM
  • SERVICE_CTG_SERVICE_NAME
  • SERVICE_DATABASE_HOST_NAME
  • SERVICE_DATABASE_NAME
  • SERVICE_DATABASE_TOPOLOGY
  • SERVICE_DATABASE_VENDOR
  • SERVICE_DETECTED_NAME
  • SERVICE_ESB_APPLICATION_NAME
  • SERVICE_IBM_CTG_GATEWAY_URL
  • SERVICE_IIB_APPLICATION_NAME
  • SERVICE_MESSAGING_LISTENER_CLASS_NAME
  • SERVICE_NAME
  • SERVICE_PORT
  • SERVICE_PUBLIC_DOMAIN_NAME
  • SERVICE_REMOTE_ENDPOINT
  • SERVICE_REMOTE_SERVICE_NAME
  • SERVICE_TAGS
  • SERVICE_TECHNOLOGY
  • SERVICE_TECHNOLOGY_EDITION
  • SERVICE_TECHNOLOGY_VERSION
  • SERVICE_TOPOLOGY
  • SERVICE_TYPE
  • SERVICE_WEB_APPLICATION_ID
  • SERVICE_WEB_CONTEXT_ROOT
  • SERVICE_WEB_SERVER_ENDPOINT
  • SERVICE_WEB_SERVER_NAME
  • SERVICE_WEB_SERVICE_NAME
  • SERVICE_WEB_SERVICE_NAMESPACE
  • VMWARE_DATACENTER_NAME
  • VMWARE_VM_NAME
  • WEB_APPLICATION_NAME
  • WEB_APPLICATION_NAME_PATTERN
  • WEB_APPLICATION_TAGS
  • WEB_APPLICATION_TYPE

Possible values for the propagationTypes element in the ManagementZoneRule object:

  • AZURE_TO_PG
  • AZURE_TO_SERVICE
  • CUSTOM_DEVICE_GROUP_TO_CUSTOM_DEVICE
  • HOST_TO_PROCESS_GROUP_INSTANCE
  • PROCESS_GROUP_TO_HOST
  • PROCESS_GROUP_TO_SERVICE
  • SERVICE_TO_HOST_LIKE
  • SERVICE_TO_PROCESS_GROUP_LIKE

Possible values for the type element in the ManagementZoneRule object:

  • APPMON_SERVER
  • APPMON_SYSTEM_PROFILE
  • AWS_ACCOUNT
  • AWS_APPLICATION_LOAD_BALANCER
  • AWS_AUTO_SCALING_GROUP
  • AWS_CLASSIC_LOAD_BALANCER
  • AWS_NETWORK_LOAD_BALANCER
  • AWS_RELATIONAL_DATABASE_SERVICE
  • AZURE
  • BROWSER_MONITOR
  • CLOUD_APPLICATION
  • CLOUD_APPLICATION_NAMESPACE
  • CLOUD_FOUNDRY_FOUNDATION
  • CUSTOM_APPLICATION
  • CUSTOM_DEVICE
  • CUSTOM_DEVICE_GROUP
  • DATA_CENTER_SERVICE
  • ENTERPRISE_APPLICATION
  • ESXI_HOST
  • EXTERNAL_MONITOR
  • HOST
  • HOST_GROUP
  • HTTP_MONITOR
  • KUBERNETES_CLUSTER
  • KUBERNETES_NODE
  • MOBILE_APPLICATION
  • OPENSTACK_ACCOUNT
  • PROCESS_GROUP
  • SERVICE
  • WEB_APPLICATION

Example

In this example, the request inquires about the properties of the Easytravel management zone, which has the ID 9130632296508575249.

The configuration has the following settings:

GET management zone

Curl

curl -L -X GET 'https://mySampleEnv.live.dynatrace.com/api/config/v1/managementZones/9130632296508575249' \
-H 'Authorization: Api-token abcdefjhij1234567890'

Request URL

https://mySampleEnv.live.dynatrace.com/api/config/v1/managementZones/9130632296508575249

Response body

{
  "metadata": {
    "configurationVersions": [
      0
    ],
    "clusterVersion": "1.198.0.20200625-125013"
  },
  "id": "9130632296508575249",
  "name": "Easytravel",
  "rules": [
    {
      "type": "WEB_APPLICATION",
      "enabled": true,
      "propagationTypes": [],
      "conditions": [
        {
          "key": {
            "attribute": "WEB_APPLICATION_NAME"
          },
          "comparisonInfo": {
            "type": "STRING",
            "operator": "BEGINS_WITH",
            "value": "easytravel",
            "negate": false,
            "caseSensitive": false
          }
        }
      ]
    },
    {
      "type": "HOST",
      "enabled": true,
      "propagationTypes": [
        "HOST_TO_PROCESS_GROUP_INSTANCE"
      ],
      "conditions": [
        {
          "key": {
            "attribute": "HOST_TAGS"
          },
          "comparisonInfo": {
            "type": "TAG",
            "operator": "TAG_KEY_EQUALS",
            "value": {
              "context": "CONTEXTLESS",
              "key": "easyTravel"
            },
            "negate": false
          }
        }
      ]
    },
    {
      "type": "SERVICE",
      "enabled": true,
      "propagationTypes": [
        "SERVICE_TO_HOST_LIKE",
        "SERVICE_TO_PROCESS_GROUP_LIKE"
      ],
      "conditions": [
        {
          "key": {
            "attribute": "SERVICE_TAGS"
          },
          "comparisonInfo": {
            "type": "TAG",
            "operator": "TAG_KEY_EQUALS",
            "value": {
              "context": "CONTEXTLESS",
              "key": "easyTravel"
            },
            "negate": false
          }
        }
      ]
    },
    {
      "type": "SERVICE",
      "enabled": true,
      "propagationTypes": [
        "SERVICE_TO_HOST_LIKE",
        "SERVICE_TO_PROCESS_GROUP_LIKE"
      ],
      "conditions": [
        {
          "key": {
            "attribute": "SERVICE_NAME"
          },
          "comparisonInfo": {
            "type": "STRING",
            "operator": "BEGINS_WITH",
            "value": "dotNetFrontend",
            "negate": false,
            "caseSensitive": true
          }
        }
      ]
    },
    {
      "type": "SERVICE",
      "enabled": true,
      "propagationTypes": [
        "SERVICE_TO_HOST_LIKE",
        "SERVICE_TO_PROCESS_GROUP_LIKE"
      ],
      "conditions": [
        {
          "key": {
            "attribute": "SERVICE_NAME"
          },
          "comparisonInfo": {
            "type": "STRING",
            "operator": "BEGINS_WITH",
            "value": "dev: easyTravel Customer Frontend",
            "negate": false,
            "caseSensitive": false
          }
        }
      ]
    },
    {
      "type": "SERVICE",
      "enabled": true,
      "propagationTypes": [
        "SERVICE_TO_HOST_LIKE",
        "SERVICE_TO_PROCESS_GROUP_LIKE"
      ],
      "conditions": [
        {
          "key": {
            "attribute": "SERVICE_NAME"
          },
          "comparisonInfo": {
            "type": "STRING",
            "operator": "BEGINS_WITH",
            "value": "easyTravel-Business",
            "negate": false,
            "caseSensitive": true
          }
        }
      ]
    }
  ]
}

Response code

200