Management zones API - PUT a management zone
Updates the specified management zone.
The request consumes and produces an application/json payload.
| PUT | ManagedDynatrace for Government | 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} | |
| Environment ActiveGate | https://{your-activegate-domain}/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.
| Parameter | Type | Description | In | Required |
|---|---|---|---|---|
| id | string | The ID of the management zone to be updated. If you set the ID in the body as well, it must match this ID. | path | required |
| body | Management | The JSON body of the request. Contains updated parameters of the management zone. | body | optional |
Request body objects
The ManagementZone object
The configuration of the management zone. It defines how the management zone applies.
| Element | Type | Description | Required |
|---|---|---|---|
| metadata | Configuration | Metadata useful for debugging | optional |
| id | string | The ID of the management zone. | optional |
| name | string | The name of the management zone. | required |
| description | string | The description of the management zone. | optional |
| rules | Mz | A list of rules for management zone usage. If several rules are specified, the OR logic applies. | optional |
| dimensionalRules | Mz | A list of dimensional data rules for management zone usage. If several rules are specified, the OR logic applies. | optional |
| entitySelectorBasedRules | Entity | A list of entity-selector based rules for management zone usage. If several rules are specified, the OR logic applies. | optional |
The ConfigurationMetadata object
Metadata useful for debugging
| Element | Type | Description | Required |
|---|---|---|---|
| configurationVersions | integer[] | A sorted list of the version numbers of the configuration. | optional |
| currentConfigurationVersions | string[] | A sorted list of version numbers of the configuration. | optional |
| clusterVersion | string | Dynatrace version. | optional |
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.
| Element | Type | Description | Required |
|---|---|---|---|
| type | string | The type of Dynatrace entities the management zone can be applied to. | required |
| enabled | boolean | The rule is enabled ( | required |
| propagationTypes | string[] | How to apply the management zone to underlying entities:
| optional |
| conditions | Entity | A list of matching rules for the management zone. The management zone applies only if all conditions are fulfilled. | required |
The EntityRuleEngineCondition object
A condition defines how to execute matching logic for an entity.
| Element | Type | Description | Required |
|---|---|---|---|
| key | Condition | 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. | required |
| comparisonInfo | Comparison | 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. | required |
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.
| Element | Type | Description | Required |
|---|---|---|---|
| attribute | string | The attribute to be used for comparison. | required |
| type | string | Defines the actual set of fields depending on the value. See one of the following objects:
| optional |
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.
| Element | Type | Description | Required |
|---|---|---|---|
| operator | string | Operator of the comparison. You can reverse it by setting negate to 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. | required |
| value | object | The value to compare to. | optional |
| negate | boolean | Reverses the comparison operator. For example it turns the begins with into does not begin with. | required |
| type | string | Defines the actual set of fields depending on the value. See one of the following objects:
| required |
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.
| Element | Type | Description | Required |
|---|---|---|---|
| enabled | boolean | The rule is enabled ( | required |
| appliesTo | string | The target of the rule. | required |
| conditions | Mz | A list of conditions for the management zone. The management zone applies only if all conditions are fulfilled. | required |
The MzDimensionalRuleCondition object
A condition of the management zone dimensional rule.
| Element | Type | Description | Required |
|---|---|---|---|
| conditionType | string | The type of the condition. | required |
| ruleMatcher | string | How we compare the values. | required |
| key | string | The reference value for comparison. For conditions of the | required |
| value | string | The value of the dimension. Only applicable when the conditionType is set to | optional |
The EntitySelectorBasedMzRule object
The entity-selector-based rule for management zone usage. It allows adding entities to a management zone via an entity selector.
| Element | Type | Description | Required |
|---|---|---|---|
| enabled | boolean | The rule is enabled ( | optional |
| entitySelector | string | The entity selector string, by which the entities are selected. | required |
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.
{
"name": "sampleManagementZone",
"description": "sampleDescription",
"rules": [
{
"type": "SERVICE",
"enabled": true,
"propagationTypes": [
"SERVICE_TO_HOST_LIKE"
],
"conditions": [
{
"key": {
"attribute": "SERVICE_DATABASE_NAME"
},
"comparisonInfo": {
"type": "STRING",
"operator": "BEGINS_WITH",
"value": "sample",
"negate": false,
"caseSensitive": false
}
},
{
"key": {
"attribute": "SERVICE_WEB_SERVER_NAME"
},
"comparisonInfo": {
"type": "STRING",
"operator": "EXISTS",
"negate": false
}
},
{
"key": {
"attribute": "PROCESS_GROUP_CUSTOM_METADATA",
"type": "PROCESS_CUSTOM_METADATA_KEY",
"dynamicKey": {
"source": "KUBERNETES",
"key": "kubernetes.io/limit-ranger"
}
},
"comparisonInfo": {
"type": "STRING",
"operator": "BEGINS_WITH",
"value": "sample",
"negate": false,
"caseSensitive": false
}
}
]
}
],
"dimensionalRules": [
{
"enabled": true,
"appliesTo": "METRIC",
"conditions": [
{
"conditionType": "DIMENSION",
"ruleMatcher": "EQUALS",
"key": "alwaysRequired",
"value": "requiredForDimension_forbiddenForMetricKeyAndLogFileName"
}
]
}
],
"entitySelectorBasedRules": [
{
"enabled": true,
"entitySelector": "type(HOST) AND cpuCores(4)"
}
]
}Response
Response codes
| Code | Type | Description |
|---|---|---|
| 201 | Entity | Success. The management zone has been created. The response contains the ID of the new zone. |
| 204 | Success. The management zone has been updated. Response doesn't have a body. | |
| 400 | ErrorEnvelope | Failed. The input is invalid |
Response body objects
The EntityShortRepresentation object
The short representation of a Dynatrace entity.
| Element | Type | Description |
|---|---|---|
| id | string | The ID of the Dynatrace entity. |
| name | string | The name of the Dynatrace entity. |
| description | string | A short description of the Dynatrace entity. |
Response body JSON model
{
"id": "6a98d7bc-abb9-44f8-ae6a-73e68e71812a",
"name": "Dynatrace entity",
"description": "Dynatrace entity for the REST API example"
}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 | ManagedDynatrace for Government | https://{your-domain}/e/{your-environment-id}/api/config/v1/managementZones/{id}/validator |
| SaaS | https://{your-environment-id}.live.dynatrace.com/api/config/v1/managementZones/{id}/validator | |
| Environment ActiveGate | https://{your-activegate-domain}/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
| Code | Type | Description |
|---|---|---|
| 204 | Validated. The submitted configuration is valid. Response does not have a body. | |
| 400 | ErrorEnvelope | Failed. The input is invalid |
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/2072664797514502900Request 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:
