Management zones API - POST a management zone

Creates a new management zone.

The request consumes and produces an application/json payload.

POST	Managed https://{your-domain}/e/{your-environment-id}/api/config/v1/managementZones SaaS https://{your-environment-id}.live.dexp.ae/api/config/v1/managementZones

Authentication

To execute this request, you need the Write configuration permission assigned to your API token. See the Authentication page to learn how to obtain and use it.

Parameters

Parameter	Type	Description	In	Required
body	ManagementZone	The JSON body of the request, containing parameters of the management zone.	body	optional

Request parameters JSON model

The ManagementZone object

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

Element	Type	Description	Required
metadata	ConfigurationMetadata	Metadata useful for debugging.	optional
id	string	The ID of the management zone.	optional
name	string	The name of the management zone.	required
rules	ManagementZoneRule[]	The list of rules to where the management zone applies. Each rule is evaluated independently of all other rules.	optional

The ManagementZoneRule object

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

Element	Type	Description	Required
type	string	The type of DESK entities the management zone can be applied to. The type element can hold these values.	required
enabled	boolean	The evaluation rule is enabled(`true`) or disabled(`false`).	required
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.	optional
conditions	EntityRuleEngineCondition[]	Matching rules of 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	ConditionKey	The key to identify the data we're matching.	required
comparisonInfo	ComparisonBasic	Defines how the matching is actually performed: what and how are we comparing.	required

The ComparisonBasic object

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

The actual field set and the list of possible values of the operator field 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.

Element	Type	Description	Required
operator	Enum	Operator of the comparision. You can reverse it by setting negate to `true`.	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: STRING -> StringComparison 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 The type element can hold these values.	required

The Enum object

The ConditionKey object

The key to identify the data we're matching.

Depending on the type of the key, the actual JSON may contain additional fields. Find the list in the description of the type field.

Element	Type	Description	Required
attribute	string	The attribute to be used for comparision. The attribute element can hold these values.	required
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 type element can hold these values.	optional

Element

Type

Description

Required

attribute

string

The attribute to be used for comparision.

The attribute element can hold these values.

required

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 type element can hold these values.

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
clusterVersion	string	DESK server version.	optional

This is a model of the request body, showing the possible elements. It has to be adjusted for usage in an actual request. See the Example expandable section for working sample request.

      
  {
  "name": "sampleManagementZone",
  "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
          }
        }
      ]
    }
  ]
}

Possible values

Possible values for the type element in the ComparisonBasic object:

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

Possible values for the type element in the ConditionKey object:

PROCESS_CUSTOM_METADATA_KEY
HOST_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_BACKEND_PORTS
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_API_MANAGEMENT_SERVICE_NAME
AZURE_API_MANAGEMENT_SERVICE_TAGS
AZURE_APPLICATION_GATEWAY_NAME
AZURE_APPLICATION_GATEWAY_TAGS
AZURE_APP_SERVICE_PLAN_NAME
AZURE_APP_SERVICE_PLAN_TAGS
AZURE_COSMOS_DB_NAME
AZURE_COSMOS_DB_TAGS
AZURE_EVENT_HUB_NAME
AZURE_EVENT_HUB_NAMESPACE_NAME
AZURE_EVENT_HUB_NAMESPACE_TAGS
AZURE_EVENT_HUB_TAGS
AZURE_FUNCTION_APP_NAME
AZURE_FUNCTION_APP_TAGS
AZURE_IOT_HUB_NAME
AZURE_IOT_HUB_TAGS
AZURE_LOAD_BALANCER_NAME
AZURE_LOAD_BALANCER_TAGS
AZURE_REDIS_CACHE_NAME
AZURE_REDIS_CACHE_TAGS
AZURE_REGION_NAME
AZURE_SCALE_SET_NAME
AZURE_SERVICE_BUS_NAMESPACE_NAME
AZURE_SERVICE_BUS_NAMESPACE_TAGS
AZURE_SERVICE_BUS_QUEUE_NAME
AZURE_SERVICE_BUS_QUEUE_TAGS
AZURE_SERVICE_BUS_TOPIC_NAME
AZURE_SERVICE_BUS_TOPIC_TAGS
AZURE_SQL_DATABASE_NAME
AZURE_SQL_DATABASE_TAGS
AZURE_SQL_ELASTIC_POOL_NAME
AZURE_SQL_ELASTIC_POOL_TAGS
AZURE_SQL_SERVER_NAME
AZURE_SQL_SERVER_TAGS
AZURE_STORAGE_ACCOUNT_NAME
AZURE_STORAGE_ACCOUNT_TAGS
AZURE_SUBSCRIPTION_NAME
AZURE_VM_NAME
AZURE_VM_SCALE_SET_TAGS
AZURE_VM_TAGS
AZURE_WEB_APP_NAME
AZURE_WEB_APP_TAGS
BROWSER_MONITOR_NAME
BROWSER_MONITOR_TAGS
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_INSTANCE_CUSTOM_METADATA
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_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 items element in the ManagementZoneRule object:

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_API_MANAGEMENT_SERVICE
AZURE_APPLICATION_GATEWAY
AZURE_APP_SERVICE_PLAN
AZURE_COSMOS_DB
AZURE_EVENT_HUB
AZURE_EVENT_HUB_NAMESPACE
AZURE_FUNCTION_APP
AZURE_IOT_HUB
AZURE_LOAD_BALANCER
AZURE_REDIS_CACHE
AZURE_SERVICE_BUS_NAMESPACE
AZURE_SERVICE_BUS_QUEUE
AZURE_SERVICE_BUS_TOPIC
AZURE_SQL_DATABASE
AZURE_SQL_ELASTIC_POOL
AZURE_SQL_SERVER
AZURE_STORAGE_ACCOUNT
AZURE_SUBSCRIPTION
AZURE_VM
AZURE_VM_SCALE_SET
AZURE_WEB_APP
BROWSER_MONITOR
CLOUD_FOUNDRY_FOUNDATION
CUSTOM_APPLICATION
CUSTOM_DEVICE
CUSTOM_DEVICE_GROUP
DATA_CENTER_SERVICE
ENTERPRISE_APPLICATION
ESXI_HOST
EXTERNAL_MONITOR
HOST
HTTP_MONITOR
KUBERNETES_CLUSTER
MOBILE_APPLICATION
OPENSTACK_ACCOUNT
PROCESS_GROUP
SERVICE
WEB_APPLICATION

Response format

Response parameters JSON model

The EntityShortRepresentation object

The short representation of a DESK entity.

Element	Type	Description
id	string	The ID of the DESK entity.
name	string	The name of the DESK entity.
description	string	A short description of the DESK 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	Managed https://{your-domain}/e/{your-environment-id}/api/config/v1/managementZones/validator SaaS https://{your-environment-id}.live.dexp.ae/api/config/v1/managementZones/validator

Authentication

To execute this request, you need the Write configuration permission assigned to your API token. See the Authentication page to learn how to obtain and use it.

Response codes

Code	Description
204	Validated. The submitted configuration is valid. Response does not have a body.
400	Failed. The input is invalid.