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}

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

The ManagementZone object

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

Element Type Description
metadata ConfigurationMetadata

Metadata useful for debugging.

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.

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.

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

Type-specific key to identify which data we're matching.

comparisonInfo ComparisonBasic

Defines how the matching is actually performed: what and how are we comparing.

The ComparisonBasic object

Defines how the matching is actually performed: what and how are we comparing. The actual set of fields depends on the type of the comparison.

Element Type Description
operator Enum

Operator of the comparision. You can reverse it by setting negate to true.

value object

Holds the value to compare to.

negate boolean

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

type string

Defines the actual set of fields depending on the value:

STRING -> StringComparison INTEGER -> IntegerComparison SERVICE_TYPE -> ServiceTypeComparison PAAS_TYPE -> PaasTypeComparison CLOUD_TYPE -> CloudTypeComparision AZURE_SKU -> AzureSkuComparision AZURE_COMPUTE_MODE -> AzureComputeModeComparision ENTITY_ID -> EntityIdComparision SIMPLE_TECH -> SimpleTechComparison SIMPLE_HOST_TECH -> SimpleHostTechComparison SERVICE_TOPOLOGY -> ServiceTopologyComparison DATABASE_TOPOLOGY -> DatabaseTopologyComparision OS_TYPE -> OsTypeComparison HYPERVISOR_TYPE -> HypervisorTypeComparision IP_ADDRESS -> IpAddressComparison OS_ARCHITECTURE -> OsArchitectureComparison BITNESS -> BitnessComparision APPLICATION_TYPE -> ApplicationTypeComparison MOBILE_PLATFORM -> MobilePlatformComparison CUSTOM_APPLICATION_TYPE -> CustomApplicationTypeComparision DCRUM_DECODER_TYPE -> DcrumDecoderComparision SYNTHETIC_ENGINE_TYPE -> SyntheticEngineTypeComparison TAG -> TagComparison

The Enum object

Element Type Description

The ConditionKey object

Type-specific key to identify the data for which we want to match against.

This is the base version of the key, depending on the type, the actual JSON may contain additional fields.

Element Type Description
attribute string

The attribute to use for comparison.

type string

Defines the actual set of fields depending on the value:

PROCESS_CUSTOM_METADATA_KEY -> CustomProcessMetadataConditionKey HOST_CUSTOM_METADATA_KEY -> CustomHostMetadataConditionKey PROCESS_PREDEFINED_METADATA_KEY -> ProcessMetadataConditionKey STRING -> StringConditionKey

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.