Policy API

This page describes the Policy API methods you can use to create, configure, and manage policies for an application.

A policy consists of a trigger based on one or more events and an action in response to that trigger. You use policies to automate monitoring, alerting, and problem remediation.

Syntax validation of the JSON payload is done when creating the policy.
Objects/Entities corresponding to EUM applications are not supported.

Create a Policy

Creates a new policy using the given JSON payload.

Resource URL

POST <controller_url>/controller/alerting/rest /v1/applications/<application_id>/policies

Request/Response Format

JSON

Example

{
    "name": "Policy json create example",
    "enabled": true,
    "executeActionsInBatch": true,
    "actions": [
        {
            "actionName": "your@email.com",
            "actionType": "EMAIL",
            "notes": "example notes"
        },
        {
            "actionName": "Thread dump action",
            "actionType": "THREAD_DUMP",
            "specifiedEntityActionDetails": {
                "specifiedEntityActionScope": "SPECIFIC_NODES",
                "nodes": [
                    "node1"
                ]
            }
        }
    ],
    "events": {
        "healthRuleEvents": {
            "healthRuleEventTypes": [
                "HEALTH_RULE_OPEN_CRITICAL",
                "HEALTH_RULE_UPGRADED",
                "HEALTH_RULE_CONTINUES_CRITICAL",
                "HEALTH_RULE_CONTINUES_WARNING"
            ],
            "healthRuleScope": {
                "healthRuleScopeType": "SPECIFIC_HEALTH_RULES",
                "healthRules": [
                    "JVM Garbage Collection Time is too high",
                    "Memory utilization is too high"
                ]
            }
        },
        "otherEvents": [
            "VERY_SLOW",
            "STALL",
            "SLOW",
            "ERROR"
        ]
     },
    "selectedEntities": {
        "selectedEntityType": "SPECIFIC_ENTITIES",
        "entities": [
            {
                "entityType": "BUSINESS_TRANSACTION",
                "selectedBusinessTransactions": {
                    "businessTransactionScope": "SPECIFIC_BUSINESS_TRANSACTIONS",
                    "businessTransactions": [
                        "/home/auctions"
                    ]
                }
            },
            {
                "entityType": "TIER_NODE",
                "tierOrNode": {
                    "tierOrNodeScope": "NODE_SELECTED_ENTITIES",
                    "typeofNode": "ALL_NODES",
                    "selectedNodes": {
                        "selectedNodeScope": "SPECIFIC_NODES",
                        "nodes": [
                            "node1"
                        ]
                    }
                }
            }
        ]
    }
}

JSON

{
    "id": 2,
    "name": "Policy json create example",
    "enabled": true,
    "executeActionsInBatch": true,
    "actions": [
        {
            "actionName": "your@email.com",
            "actionType": "EMAIL",
            "notes": "example notes"
        },
        {
            "actionName": "Thread dump action",
            "actionType": "THREAD_DUMP",
            "specifiedEntityActionDetails": {
                "specifiedEntityActionScope": "SPECIFIC_NODES",
                "nodes": [
                    "node1"
                ]
            }
        }
    ],
    "events": {
        "healthRuleEvents": {
            "healthRuleEventTypes": [
                "HEALTH_RULE_OPEN_CRITICAL",
                "HEALTH_RULE_UPGRADED",
                "HEALTH_RULE_CONTINUES_CRITICAL",
                "HEALTH_RULE_CONTINUES_WARNING"
            ],
            "healthRuleScope": {
                "healthRuleScopeType": "SPECIFIC_HEALTH_RULES",
                "healthRules": [
                    "JVM Garbage Collection Time is too high",
                    "Memory utilization is too high"
                ]
            }
        },
        "otherEvents": [
            "VERY_SLOW",
            "SLOW",
            "ERROR",
            "STALL"
        ],
        "anomalyEvents": null,
        "customEvents": []
    },
    "selectedEntities": {
        "selectedEntityType": "SPECIFIC_ENTITIES",
        "entities": [
            {
                "entityType": "BUSINESS_TRANSACTION",
                "selectedBusinessTransactions": {
                    "businessTransactionScope": "SPECIFIC_BUSINESS_TRANSACTIONS",
                    "businessTransactions": [
                        "/home/auctions"
                    ]
                }
            },
            {
                "entityType": "TIER_NODE",
                "tierOrNode": {
                    "tierOrNodeScope": "NODE_SELECTED_ENTITIES",
                    "typeofNode": "ALL_NODES",
                    "selectedNodes": {
                        "selectedNodeScope": "SPECIFIC_NODES",
                        "nodes": [
                            "node1"
                        ]
                    }
                }
            }
        ]
    }
}

JSON

Retrieve a list of Policies associated with an Application

This API returns a list of all policies associated with the given application, policy names, IDs, and enable flag details. To fetch the complete details of a policy, use GET /policies/{policy-id}.

Resource URL

GET <controller_url>/controller/alerting/rest/v1/applications/<application_id>/policies

Response Format

JSON

Example Response

[
    {
        "id": 1,
        "name": "Policy json update example",
        "enabled": true
    },
    {
        "id": 2,
        "name": "Policy json create example",
        "enabled": true
    }
]

JSON

Retrieve Details of a Specified Policy

Returns a JSON representation of a policy for the given policy ID.

Resource URL

GET <controller_url>/controller/alerting/rest/v1/applications/<application_id>/policies/{policy-id}

Response Format

JSON

Example Response

This example retrieves the configuration details of a policy.

{
    "id": 1,
    "name": "Policy REST get json example",
    "enabled": true,
    "executeActionsInBatch": true,
    "actions": [
        {
            "actionName": "your@email.com",
            "actionType": "EMAIL",
            "notes": "example notes"
        },
        {
            "actionName": "1234567890",
            "actionType": "SMS"
        },
        {
            "actionName": "Thread dump action",
            "actionType": "THREAD_DUMP",
            "specifiedEntityActionDetails": {
                "specifiedEntityActionScope": "SPECIFIC_NODES",
                "nodes": [
                    "node1"
                ]
            }
        }
    ],
    "events": {
        "healthRuleEvents": {
            "healthRuleEventTypes": [
                "HEALTH_RULE_OPEN_CRITICAL",
                "HEALTH_RULE_UPGRADED",
                "HEALTH_RULE_CONTINUES_CRITICAL",
                "HEALTH_RULE_CONTINUES_WARNING"
            ],
            "healthRuleScope": {
                "healthRuleScopeType": "SPECIFIC_HEALTH_RULES",
                "healthRules": [
                    "JVM Garbage Collection Time is too high",
                    "Memory utilization is too high"
                ]
            }
        },
        "otherEvents": [
            "VERY_SLOW",
            "STALL",
            "SLOW",
            "ERROR"
        ],
        "anomalyEvents": null,
        "customEvents": []
    },
    "selectedEntities": {
        "selectedEntityType": "SPECIFIC_ENTITIES",
        "entities": [
            {
                "entityType": "BUSINESS_TRANSACTION",
                "selectedBusinessTransactions": {
                    "businessTransactionScope": "SPECIFIC_BUSINESS_TRANSACTIONS",
                    "businessTransactions": [
                        "/home/auctions"
                    ]
                }
            },
            {
                "entityType": "TIER_NODE",
                "tierOrNode": {
                    "tierOrNodeScope": "NODE_SELECTED_ENTITIES",
                    "typeofNode": "ALL_NODES",
                    "selectedNodes": {
                        "selectedNodeScope": "SPECIFIC_NODES",
                        "nodes": [
                            "node1"
                        ]
                    }
                }
            }
        ]
    }
}

JSON

Update a Policy

Updates the configuration settings of an existing policy with the values of a specified policy ID.

This request requires a complete JSON payload as input. AppDynamics recommends

Retrieving the JSON payload using GET /policies/{policy-id} and update the required fields.
Send the modified payload as part of the PUT request.

Resource URL

PUT <controller_url>/controller/alerting/rest/v1/applications/<application_id>/policies/{policy-id}

Request/Response Format

JSON

Example

{
    "name": "Policy json update example",
    "enabled": true,
    "executeActionsInBatch": true,
    "actions": [
        {
            "actionName": "Thread dump action",
            "actionType": "THREAD_DUMP",
            "specifiedEntityActionDetails": {
                "specifiedEntityActionScope": "SPECIFIC_NODES",
                "nodes": [
                    "node1"
                ]
            }
        }
    ],
    "events": {
        "healthRuleEvents": {
            "healthRuleEventTypes": [
                "HEALTH_RULE_OPEN_CRITICAL",
                "HEALTH_RULE_UPGRADED",
                "HEALTH_RULE_CONTINUES_CRITICAL"
            ],
            "healthRuleScope": {
                "healthRuleScopeType": "ALL_HEALTH_RULES"
            }
        },
        "otherEvents": [
            "VERY_SLOW",
            "STALL",
            "SLOW",
            "ERROR"
        ]
    },
    "selectedEntities": {
        "selectedEntityType": "SPECIFIC_ENTITIES",
        "entities": [
            {
                "entityType": "BUSINESS_TRANSACTION",
                "selectedBusinessTransactions": {
                    "businessTransactionScope": "SPECIFIC_BUSINESS_TRANSACTIONS",
                    "businessTransactions": [
                        "/home/auctions"
                    ]
                }
            },
            {
                "entityType": "TIER_NODE",
                "tierOrNode": {
                    "tierOrNodeScope": "NODE_SELECTED_ENTITIES",
                    "typeofNode": "ALL_NODES",
                    "selectedNodes": {
                        "selectedNodeScope": "SPECIFIC_NODES",
                        "nodes": [
                            "node1"
                        ]
                    }
                }
            }
        ]
    }
}

JSON

{
    "id": 1,
    "name": "Policy json update example",
    "enabled": true,
    "executeActionsInBatch": true,
    "actions": [
        {
            "actionName": "Thread dump action",
            "actionType": "THREAD_DUMP",
            "specifiedEntityActionDetails": {
                "specifiedEntityActionScope": "SPECIFIC_NODES",
                "nodes": [
                    "node1"
                ]
            }
        }
    ],
    "events": {
        "healthRuleEvents": {
            "healthRuleEventTypes": [
                "HEALTH_RULE_OPEN_CRITICAL",
                "HEALTH_RULE_UPGRADED",
                "HEALTH_RULE_CONTINUES_CRITICAL"
            ],
            "healthRuleScope": {
                "healthRuleScopeType": "ALL_HEALTH_RULES"
            }
        },
        "otherEvents": [
            "VERY_SLOW",
            "SLOW",
            "ERROR",
            "STALL"
        ],
        "anomalyEvents": null,
        "customEvents": []
    },
    "selectedEntities": {
        "selectedEntityType": "SPECIFIC_ENTITIES",
        "entities": [
            {
                "entityType": "BUSINESS_TRANSACTION",
                "selectedBusinessTransactions": {
                    "businessTransactionScope": "SPECIFIC_BUSINESS_TRANSACTIONS",
                    "businessTransactions": [
                        "/home/auctions"
                    ]
                }
            },
            {
                "entityType": "TIER_NODE",
                "tierOrNode": {
                    "tierOrNodeScope": "NODE_SELECTED_ENTITIES",
                    "typeofNode": "ALL_NODES",
                    "selectedNodes": {
                        "selectedNodeScope": "SPECIFIC_NODES",
                        "nodes": [
                            "node1"
                        ]
                    }
                }
            }
        ]
    }
}

JSON

Delete a Policy

Deletes an existing policy with the specified ID.

Ensure that you provide a valid existing policy ID.

Resource URL

DELETE <controller_url>/controller/alerting/rest/v1/applications/<application_id>/policies/{policy-id}

Update a Policy Configuration

Updates one or more specific configuration setting(s) of a policy. You can update the Name and Enabled fields using this API.

Resource URL

PUT <controller_url>/controller/alerting/rest/v1/applications/<application_id>/policies/{policy-id}/configuration

Request/Response Format

JSON

Example

{
        "name": "Policy json update example",
        "enabled": false
}

JSON

{
    "id": 1,
    "name": "Policy json update example",
    "enabled": false,
    "executeActionsInBatch": true,
    "actions": [
        {
            "actionName": "Thread dump action",
            "actionType": "THREAD_DUMP",
            "specifiedEntityActionDetails": {
                "specifiedEntityActionScope": "SPECIFIC_NODES",
                "nodes": [
                    "node1"
                ]
            }
        }
    ],
    "events": {
        "healthRuleEvents": {
            "healthRuleEventTypes": [
                "HEALTH_RULE_OPEN_CRITICAL",
                "HEALTH_RULE_UPGRADED",
                "HEALTH_RULE_CONTINUES_CRITICAL"
            ],
            "healthRuleScope": {
                "healthRuleScopeType": "ALL_HEALTH_RULES"
            }
        },
        "otherEvents": [
            "VERY_SLOW",
            "STALL",
            "SLOW",
            "ERROR"
        ],
        "anomalyEvents": null,
        "customEvents": []
    },
    "selectedEntities": {
        "selectedEntityType": "SPECIFIC_ENTITIES",
        "entities": [
            {
                "entityType": "BUSINESS_TRANSACTION",
                "selectedBusinessTransactions": {
                    "businessTransactionScope": "SPECIFIC_BUSINESS_TRANSACTIONS",
                    "businessTransactions": [
                        "/home/auctions"
                    ]
                }
            },
            {
                "entityType": "TIER_NODE",
                "tierOrNode": {
                    "tierOrNodeScope": "NODE_SELECTED_ENTITIES",
                    "typeofNode": "ALL_NODES",
                    "selectedNodes": {
                        "selectedNodeScope": "SPECIFIC_NODES",
                        "nodes": [
                            "node1"
                        ]
                    }
                }
            }
        ]
    }
}

JSON

Example Response

Response Codes

Code	Description
200	Fetched successfully
201	Created successfully
204	Deleted successfully
400	Bad request
401	Unauthorized
403	Forbidden
404	Resource not found
409	Already exists

Property Details

Policy

Payload details of a policy.

Property Name

Type

Description and Valid Values

id

integer

This is auto-generated by the system and returned in the response.

It is a readOnly value.

name^*

string

Name of the policy.

Minimum length: 1

enabled

boolean

Sets the policy to enabled/disabled state.

Default value: true

executeActionsInBatch^*

boolean

Executes the actions configured for a policy, once for all the triggering events that occurred during the last minute.

Default value: true

actions^*

minItems: 1

Action

Describes the predefined, reusable, and automated response to an event to be taken when the policy is triggered.

Property Name Type Description

actionName^*

string

Name of the action defined for a policy.

actionType^*

string

ActionType Enum

Creates the following types of actions:

SMS

EMAIL

CUSTOM_EMAIL

THREAD_DUMP

HTTP_REQUEST

CUSTOM

RUN_SCRIPT_ON_NODES

DIAGNOSTIC_BUSINESS_TRANSACTIONS

CREATE_UPDATE_JIRA

events^*

Events

Describes the events that trigger the policy.

Property Name Description

healthRuleEvents

HealthRuleEvents

Describes the trigger event type(s) generated due to health rule issues.

Property Name Description

healthRuleEventTypes^*

HealthRuleEventTypes

Describes the event type related to health rule that triggers the policy.

minItems: 1

HealthRuleEventTypeEnum

HEALTH_RULE_CONTINUES_CRITICAL

HEALTH_RULE_OPEN_CRITICAL

HEALTH_RULE_OPEN_WARNING

HEALTH_RULE_UPGRADED

HEALTH_RULE_DOWNGRADED

HEALTH_RULE_CONTINUES_WARNING

HEALTH_RULE_CLOSE_WARNING

HEALTH_RULE_CLOSE_CRITICAL

HEALTH_RULE_CANCELED_WARNING

HEALTH_RULE_CANCELED_CRITICAL

healthRuleScope^*

HealthRuleScope

Describes the scope of the health rule based on which, the events are triggered.

Enums

ALL_HEALTH_RULES

SPECIFIC_HEALTH_RULES

otherEvents

OtherEvents

Describes the trigger event type(s) generated due to other issues.

Property Name Description

OtherEventType

Lists the event type that triggers an action.

Enums

CLR_CRASH

APPLICATION_CRASH

DEADLOCK

RESOURCE_POOL_LIMIT

APPLICATION_DEPLOYMENT

APP_SERVER_RESTART

APPLICATION_CONFIG_CHANGE

AGENT_CONFIGURATION_ERROR

APPLICATION_DISCOVERED

TIER_DISCOVERED

NODE_DISCOVERED

MACHINE_DISCOVERED

BT_DISCOVERED

SERVICE_ENDPOINT_DISCOVERED

BACKEND_DISCOVERED

EUM_CLOUD_SYNTHETIC_HEALTHY_EVENT

EUM_CLOUD_SYNTHETIC_WARNING_EVENT

EUM_CLOUD_SYNTHETIC_CONFIRMED_WARNING_EVENT

EUM_CLOUD_SYNTHETIC_ONGOING_WARNING_EVENT

EUM_CLOUD_SYNTHETIC_ERROR_EVENT

EUM_CLOUD_SYNTHETIC_CONFIRMED_ERROR_EVENT

EUM_CLOUD_SYNTHETIC_ONGOING_ERROR_EVENT

EUM_CLOUD_SYNTHETIC_PERF_HEALTHY_EVENT

EUM_CLOUD_SYNTHETIC_PERF_WARNING_EVENT

EUM_CLOUD_SYNTHETIC_PERF_CONFIRMED_WARNING_EVENT

EUM_CLOUD_SYNTHETIC_PERF_ONGOING_WARNING_EVENT

EUM_CLOUD_SYNTHETIC_PERF_CRITICAL_EVENT

EUM_CLOUD_SYNTHETIC_PERF_CONFIRMED_CRITICAL_EVENT

EUM_CLOUD_SYNTHETIC_PERF_ONGOING_CRITICAL_EVENT

MOBILE_NEW_CRASH_EVENT, SLOW, VERY_SLOW, STALL

ERROR

anomalyEvents

AnomalyEvents

Describes the trigger event type(s) generated due to anomaly detection.

minItems: 1

Property Name Description

AnomalyEventType

Lists the event type that triggers an action.

Enums

ANOMALY_OPEN_WARNING

ANOMALY_OPEN_CRITICAL

ANOMALY_UPGRADED

ANOMALY_DOWNGRADED

ANOMALY_CLOSE_WARNING

ANOMALY_CLOSE_CRITICAL

ANOMALY_CANCELED_WARNING

ANOMALY_CANCELED_CRITICAL

customEvents

Describes the custom event type(s) generated.

Property Name Type Description

eventName^* string Custom event name.

propertyMatchCriteria

string

Enums

ANY

ALL

keyValuePairArray

string

KeyValuePair

key^*

value^*

selectedEntities

SelectedEntityType

Scope of entities considered for the policy evaluation.

Entities corresponding to EUM applications are not supported.

Property Name Type Description

SelectedEntityType^*

string

Enums

ANY_ENTITY

SPECIFIC_ENTITIES

SelectedEntityType

Scope of entities considered for the policy evaluation.

Entities corresponding to EUM applications are not supported.

Property Name Type Description

SelectedEntityType^*

string

Enums

ANY_ENTITY

SPECIFIC_ENTITIES

SpecificEntities

Scope of specific entities considered for the policy evaluation.

Property Name Type Description

selectedEntityType^*

string

Enums

ANY_ENTITY

SPECIFIC_ENTITIES

entities

minItems: 1

Entity

Property name Type Description

entityType^*

string

minItems: 1

Enums

BUSINESS_TRANSACTION

TIER_NODE

ERRORS

SERVICE_ENDPOINTS

INFORMATION_POINTS

DATABASES_IN_APPLICATION

SERVERS_IN_APPLICATION

Entity

Property name Type Description

entityType^*

string

minItems: 1

Enums

BUSINESS_TRANSACTION

TIER_NODE

ERRORS

SERVICE_ENDPOINTS

INFORMATION_POINTS

DATABASES_IN_APPLICATION

SERVERS_IN_APPLICATION

AnyEntity

Scope of entities considered for the policy evaluation.

Entities corresponding to EUM applications are not supported.

Property Name Type Description

SelectedEntityType*

string

Enums

ANY_ENTITY

SPECIFIC_ENTITIES

BusinessTransaction

All entities of type BUSINESS_TRANSACTION are considered for policy evaluation.

Property Name Type Description

entityType^*

string

minItems: 1

Enums

BUSINESS_TRANSACTION

TIER_NODE

ERRORS

SERVICE_ENDPOINTS

INFORMATION_POINTS

DATABASES_IN_APPLICATION

SERVERS_IN_APPLICATION

selectedBusinessTransactions^*

string

BusinessTransactionScope

Property Name Description

businessTransactionScope^*

Enums

ALL_BUSINESS_TRANSACTIONS SPECIFIC_BUSINESS_TRANSACTIONS

BUSINESS_TRANSACTIONS_IN_SPECIFIC_TIERS

BUSINESS_TRANSACTIONS_MATCHING_PATTERN

SelectedBusinessTransactions

Property Name Description

businessTransactionScope^*

Enums

ALL_BUSINESS_TRANSACTIONS
SPECIFIC_BUSINESS_TRANSACTIONS

BUSINESS_TRANSACTIONS_IN_SPECIFIC_TIERS

BUSINESS_TRANSACTIONS_MATCHING_PATTERN

AllBusinessTransactions

The scope of business transactions is set to all business transactions.

Property Name Description

businessTransactionScope^*

Enums

ALL_BUSINESS_TRANSACTIONS SPECIFIC_BUSINESS_TRANSACTIONS

BUSINESS_TRANSACTIONS_IN_SPECIFIC_TIERS

BUSINESS_TRANSACTIONS_MATCHING_PATTERN

SpecificBusinessTransactions

The scope of business transactions is set to select business transactions.

Property Name Type Description

businessTransactionScope^*

Enums

ALL_BUSINESS_TRANSACTIONS SPECIFIC_BUSINESS_TRANSACTIONS

BUSINESS_TRANSACTIONS_IN_SPECIFIC_TIERS

BUSINESS_TRANSACTIONS_MATCHING_PATTERN

businessTransactions^*

string

minItems: 1

Name(s) of the business transactions.

BusinessTransactionsInSpecificTiers

The scope of business transactions is set to business transactions associated with a specific tier.

Property Name Type Description

businessTransactionScope^*

Enums

ALL_BUSINESS_TRANSACTIONS SPECIFIC_BUSINESS_TRANSACTIONS

BUSINESS_TRANSACTIONS_IN_SPECIFIC_TIERS

BUSINESS_TRANSACTIONS_MATCHING_PATTERN

specificTiers^*

string

minItems: 1

Name of the specified tier.

BusinessTransactionsMatchingPattern

The scope of business transactions is set to business transactions that match a specific pattern.

Property Name Description

businessTransactionScope^*

Enums

ALL_BUSINESS_TRANSACTIONS SPECIFIC_BUSINESS_TRANSACTIONS

BUSINESS_TRANSACTIONS_IN_SPECIFIC_TIERS

BUSINESS_TRANSACTIONS_MATCHING_PATTERN

patternMatcher^*

EntityMatchingPattern

Business transactions that match the specified pattern are included in the scope.

Property Name Type Description

matchTo*

Enums

STARTS_WITH

ENDS_WITH

CONTAINS

EQUALS

MATCH_REG_EX

matchValue*

string

minLength: 1

shouldNot

boolean

default: false

SelectedTierOrNodeEntities

Specific tiers or nodes are considered for policy evaluation.

Property Name Type Description

entityType^*

string

Enums

BUSINESS_TRANSACTION

TIER_NODE

ERRORS

SERVICE_ENDPOINTS

INFORMATION_POINTS

DATABASES_IN_APPLICATION

SERVERS_IN_APPLICATION

tierOrNode^*

string

minLength: 1

TierOrNode

Property Name Type Description

tierOrNodeScope^*

string

Enums

TIER_SELECTED_ENTITIES

NODE_SELECTED_ENTITIES

TierOrNode

Property Name Type Description

tierOrNodeScope^*

string

Enums

TIER_SELECTED_ENTITIES

NODE_SELECTED_ENTITIES

TierSelectedEntities

Property Name Type Description

tierOrNodeScope^*

string

Enums

TIER_SELECTED_ENTITIES

NODE_SELECTED_ENTITIES

selectedTiers^*

SelectedTiers

Property Name Type Description

selectedTierScope^*

string

Enums

ALL_TIERS

SPECIFIC_TIERS

SelectedTiers

Property Name Type Description

selectedTierScope^*

string

Enums

ALL_TIERS

SPECIFIC_TIERS

AllTiers

Property Name Type Description

selectedTierScope^*

string

Enums

ALL_TIERS

SPECIFIC_TIERS

SpecificTiers

Property Name Type Description

selectedTierScope^*

string

Enums

ALL_TIERS

SPECIFIC_TIERS

tiers^*

string

minItems: 1

Name(s) of the specified tier(s).

NodeSelectedEntities

Property Name Type Description

tierOrNodeScope^*

string

Enums

TIER_SELECTED_ENTITIES

NODE_SELECTED_ENTITIES

typeofNode^*

string

Enums

ALL_NODES

JAVA_NODES

DOT_NET_NODES

PHP_NODES

selectedNodes^*

SelectedNodes

Property Name Type Description

selectedNodeScope^*

string

Enums

ALL_NODES

SPECIFIC_NODES

NODES_OF_SPECIFIC_TIERS

NODES_MATCHING_PATTERN

NODE_PROPERTY_VARIABLE_MATCHER

SelectedNodes

Property Name Type Description

selectedNodeScope^*

string

Enums

ALL_NODES

SPECIFIC_NODES

NODES_OF_SPECIFIC_TIERS

NODES_MATCHING_PATTERN

NODE_PROPERTY_VARIABLE_MATCHER

AllNodes

Property Name Type Description

selectedNodeScope^*

string

Enums

ALL_NODES

SPECIFIC_NODES

NODES_OF_SPECIFIC_TIERS

NODES_MATCHING_PATTERN

NODE_PROPERTY_VARIABLE_MATCHER

SpecificNodes

Property Name Type Description

selectedNodeScope^*

string

Enums

ALL_NODES

SPECIFIC_NODES

NODES_OF_SPECIFIC_TIERS

NODES_MATCHING_PATTERN

NODE_PROPERTY_VARIABLE_MATCHER

nodes^*

string

minItems: 1

Name(s) of the specified node(s).

NodesOfSpecificTiers

Property Name Type Description

selectedNodeScope^*

string

Enums

ALL_NODES

SPECIFIC_NODES

NODES_OF_SPECIFIC_TIERS

NODES_MATCHING_PATTERN

NODE_PROPERTY_VARIABLE_MATCHER

specificTiers^*

string

minItems: 1

Name(s) of tier with the associated nodes.

NodesMatchingPattern

Property Name Type Description

selectedNodeScope^*

string

Enums

ALL_NODES

SPECIFIC_NODES

NODES_OF_SPECIFIC_TIERS

NODES_MATCHING_PATTERN

NODE_PROPERTY_VARIABLE_MATCHER

patternMatcher^*

string

minItems: 1

EntityMatchingPattern

Nodes that match a specified pattern are included in the scope.

Property Name Type Description

matchTo^*

Enums

STARTS_WITH

ENDS_WITH

CONTAINS

EQUALS

MATCH_REG_EX

matchValue^*

string

minLength: 1

shouldNot

boolean

default: false

NodePropertyVariableMatcher

Property Name Type Description

selectedNodeScope^*

string

Enums

ALL_NODES

SPECIFIC_NODES

NODES_OF_SPECIFIC_TIERS

NODES_MATCHING_PATTERN

NODE_PROPERTY_VARIABLE_MATCHER

propVarPairs^*

minItems: 1

propVarPairs

Property Name Type Description

propertyType^*

string

NodePropertyTypeEnum

META

ENV

JVM

name^*

string

minLength: 1

value^*

string

minLength: 1

Errors

Specific errors are considered for policy evaluation.

Property Name Type Description

entityType^*

string

Enums

BUSINESS_TRANSACTION

TIER_NODE

ERRORS

SERVICE_ENDPOINTS

INFORMATION_POINTS

DATABASES_IN_APPLICATION

SERVERS_IN_APPLICATION

selectedErrors^*

SelectedErrors

Property Name Type Description

errorScope^*

string

Enums

ALL_ERRORS

SPECIFIC_ERRORS

ERRORS_OF_SPECIFIC_TIERS

ERRORS_MATCHING_PATTERN

SelectedErrors

Property Name Type Description

errorScope^*

string

Enums

ALL_ERRORS

SPECIFIC_ERRORS

ERRORS_OF_SPECIFIC_TIERS

ERRORS_MATCHING_PATTERN

AllErrors

Property Name Type Description

errorScope^*

string

Enums

ALL_ERRORS

SPECIFIC_ERRORS

ERRORS_OF_SPECIFIC_TIERS

ERRORS_MATCHING_PATTERN

SpecificErrors

Property Name Type Description

errorScope^*

string

Enums

ALL_ERRORS

SPECIFIC_ERRORS

ERRORS_OF_SPECIFIC_TIERS

ERRORS_MATCHING_PATTERN

errors^*

string

minItems: 1

Example: NullPointerException

ErrorsOfSpecificTiers

Property Name Type Description

errorScope^*

string

Enums

ALL_ERRORS

SPECIFIC_ERRORS

ERRORS_OF_SPECIFIC_TIERS

ERRORS_MATCHING_PATTERN

specificTiers^*

string

minItems: 1

ErrorsMatchingPattern

Property Name Type Description

errorScope^*

string

Enums

ALL_ERRORS

SPECIFIC_ERRORS

ERRORS_OF_SPECIFIC_TIERS

ERRORS_MATCHING_PATTERN

patternMatcher^*

EntityMatchingPattern

Property Name Type Description

matchTo^*

string

Enums

STARTS_WITH

ENDS_WITH

CONTAINS

EQUALS

MATCH_REG_EX

matchValue^*

string

minLength: 1

shouldNot

boolean

default: false

ServiceEndpoints

Specific service endpoints are considered for policy evaluation.

Property Name Type Description

entityType^*

string

Enums

BUSINESS_TRANSACTION

TIER_NODE

ERRORS

SERVICE_ENDPOINTS

INFORMATION_POINTS

DATABASES_IN_APPLICATION

SERVERS_IN_APPLICATION

selectedServiceEndpoints^*

SelectedServiceEndpoints

Property Name Type Description

serviceEndpointScope^*

string

Enums

ALL_SERVICE_ENDPOINTS

SPECIFIC_SERVICE_ENDPOINTS

SERVICE_ENDPOINTS_IN_SPECIFIC_TIERS

SERVICE_ENDPOINTS_MATCHING_PATTERN

SelectedServiceEndpoints

Property Name Type Description

serviceEndpointScope^*

string

Enums

ALL_SERVICE_ENDPOINTS

SPECIFIC_SERVICE_ENDPOINTS

SERVICE_ENDPOINTS_IN_SPECIFIC_TIERS

SERVICE_ENDPOINTS_MATCHING_PATTERN

AllServiceEndpoints

Property Name Type Description

serviceEndpointScope^*

string

Enums

ALL_SERVICE_ENDPOINTS

SPECIFIC_SERVICE_ENDPOINTS

SERVICE_ENDPOINTS_IN_SPECIFIC_TIERS

SERVICE_ENDPOINTS_MATCHING_PATTERN

SpecificServiceEndpoints

Property Name Type Description

serviceEndpointScope^*

string

Enums

ALL_SERVICE_ENDPOINTS

SPECIFIC_SERVICE_ENDPOINTS

SERVICE_ENDPOINTS_IN_SPECIFIC_TIERS

SERVICE_ENDPOINTS_MATCHING_PATTERN

serviceEndpoints^*

string

minItems: 1

ServiceEndpointsInSpecificTiers

Property Name Type Description

serviceEndpointScope^*

string

Enums

ALL_SERVICE_ENDPOINTS

SPECIFIC_SERVICE_ENDPOINTS

SERVICE_ENDPOINTS_IN_SPECIFIC_TIERS

SERVICE_ENDPOINTS_MATCHING_PATTERN

specificTiers^*

string

minItems: 1

ServiceEndpointsInSpecificTiers

Property Name Type Description

serviceEndpointScope^*

string

Enums

ALL_SERVICE_ENDPOINTS

SPECIFIC_SERVICE_ENDPOINTS

SERVICE_ENDPOINTS_IN_SPECIFIC_TIERS

SERVICE_ENDPOINTS_MATCHING_PATTERN

patternMatcher^*

EntityMatchingPattern

Property Name Type Description

matchTo^*

string

Enums

STARTS_WITH

ENDS_WITH

CONTAINS

EQUALS

MATCH_REG_EX

matchValue^*

string

minLength: 1

shouldNot

boolean

default: false

InformationPoints

Specific information points are considered for policy evaluation.

Property Name Type Description

entityType^*

string

Enums

BUSINESS_TRANSACTION

TIER_NODE

ERRORS

SERVICE_ENDPOINTS

INFORMATION_POINTS

DATABASES_IN_APPLICATION

SERVERS_IN_APPLICATION

selectedInformationPoints^*

SelectedInformationPoints

Property Name Type Description

informationPointScope^*

string

Enums

ALL_INFORMATION_POINTS

SPECIFIC_INFORMATION_POINTS

INFORMATION_POINTS_MATCHING_PATTERN

SelectedInformationPoints

Property Name Type Description

informationPointScope^*

string

Enums

ALL_INFORMATION_POINTS

SPECIFIC_INFORMATION_POINTS

INFORMATION_POINTS_MATCHING_PATTERN

AllInformationPoints

Property Name Type Description

informationPointScope^*

string

Enums

ALL_INFORMATION_POINTS

SPECIFIC_INFORMATION_POINTS

INFORMATION_POINTS_MATCHING_PATTERN

SpecificInformationPoints

Property Name Type Description

informationPointScope^*

string

Enums

ALL_INFORMATION_POINTS

SPECIFIC_INFORMATION_POINTS

INFORMATION_POINTS_MATCHING_PATTERN

informationPoints^*

string

minItems: 1

InformationPointsMatchingPattern

Property Name Type Description

informationPointScope^*

string

Enums

ALL_INFORMATION_POINTS

SPECIFIC_INFORMATION_POINTS

INFORMATION_POINTS_MATCHING_PATTERN

patternMatcher^*

EntityMatchingPattern

Property Name Type Description

matchTo^*

string

Enums

STARTS_WITH

ENDS_WITH

CONTAINS

EQUALS

MATCH_REG_EX

matchValue^*

string

minLength: 1

shouldNot

boolean

default: false

DatabasesInApplication

Specific databases associated with the application are considered for policy evaluation.

Property Name Type Description

entityType^*

string

Enums

BUSINESS_TRANSACTION

TIER_NODE

ERRORS

SERVICE_ENDPOINTS

INFORMATION_POINTS

DATABASES_IN_APPLICATION

SERVERS_IN_APPLICATION

selectedApplicationDatabases^*

SelectedApplicationDatabases

Property Name Type Description

applicationDatabaseScope

string

Enums

ALL_APPLICATION_DATABASES

SPECIFIC_APPLICATION_DATABASES

APPLICATION_DATABASES_MATCHING_PATTERN

SelectedApplicationDatabases

Property Name Type Description

applicationDatabaseScope^*

string

Enums

ALL_APPLICATION_DATABASES

SPECIFIC_APPLICATION_DATABASES

APPLICATION_DATABASES_MATCHING_PATTERN

AllApplicationDatabases

Property Name Type Description

applicationDatabaseScope^*

string

Enums

ALL_APPLICATION_DATABASES

SPECIFIC_APPLICATION_DATABASES

APPLICATION_DATABASES_MATCHING_PATTERN

SpecificApplicationDatabases

Property Name Type Description

applicationDatabaseScope^*

string

Enums

ALL_APPLICATION_DATABASES

SPECIFIC_APPLICATION_DATABASES

APPLICATION_DATABASES_MATCHING_PATTERN

applicationDatabases^*

string

minItems: 1

ApplicationDatabasesMatchingPattern

Property Name Type Description

applicationDatabaseScope^*

string

Enums

ALL_APPLICATION_DATABASES

SPECIFIC_APPLICATION_DATABASES

APPLICATION_DATABASES_MATCHING_PATTERN

patternMatcher^*

EntityMatchingPattern

Property Name Type Description

matchTo^*

string

Enums

STARTS_WITH

ENDS_WITH

CONTAINS

EQUALS

MATCH_REG_EX

matchValue^*

string

minLength: 1

shouldNot

boolean

default: false

ServersInApplication

Specific servers associated with the application, are considered for the policy evaluation.

Property Name Type Description

entityType^*

string

Enums

BUSINESS_TRANSACTION

TIER_NODE

ERRORS

SERVICE_ENDPOINTS

INFORMATION_POINTS

DATABASES_IN_APPLICATION

SERVERS_IN_APPLICATION

selectedServers^*

string

ApplicationSelectedServers

Property Name Type Description

serversScope^*

string

Enums

ALL_SERVERS_IN_APPLICATION

SPECIFIC_SERVERS_IN_APPLICATION

ALL_SERVERS_IN_SPECIFIC_TIERS

ApplicationSelectedServers

Property Name Type Description

serversScope^*

string

Enums

ALL_SERVERS_IN_APPLICATION

SPECIFIC_SERVERS_IN_APPLICATION

ALL_SERVERS_IN_SPECIFIC_TIERS

AllServersInApplication

Property Name Type Description

serversScope^*

string

Enums

ALL_SERVERS_IN_APPLICATION

SPECIFIC_SERVERS_IN_APPLICATION

ALL_SERVERS_IN_SPECIFIC_TIERS

SpecificServersInApplication

Property Name Type Description

serversScope^*

string

Enums

ALL_SERVERS_IN_APPLICATION

SPECIFIC_SERVERS_IN_APPLICATION

ALL_SERVERS_IN_SPECIFIC_TIERS

specificServers^*

string

minLength: 1

minItems: 1

AllServersInSpecificTiers

Property Name Type Description

serversScope^*

string

Enums

ALL_SERVERS_IN_APPLICATION

SPECIFIC_SERVERS_IN_APPLICATION

ALL_SERVERS_IN_SPECIFIC_TIERS

specificTiers^*

string

minItems: 1

Events

Different types of events that trigger a policy.

Property Name Type Description

healthRuleEvents

HealthRuleEvent

Events associated with health rules that trigger the policy.

Property Name Type Description

healthRuleEventTypes^*

string

minItems: 1

HealthRuleEventType

Enums

HEALTH_RULE_CONTINUES_CRITICAL

HEALTH_RULE_OPEN_CRITICAL

HEALTH_RULE_OPEN_WARNING

HEALTH_RULE_UPGRADED

HEALTH_RULE_DOWNGRADED

HEALTH_RULE_CONTINUES_WARNING

HEALTH_RULE_CLOSE_WARNING

HEALTH_RULE_CLOSE_CRITICAL

HEALTH_RULE_CANCELED_WARNING

HEALTH_RULE_CANCELED_CRITICAL

healthRuleScope^*

string

Events associated with specific health rules or all health rules that trigger the policy.

HealthRuleScopeType

Property Name Type Description

healthRuleScopeType

string

ALL_HEALTH_RULES

SPECIFIC_HEALTH_RULES

otherEvents

string

OtherEventType

Enums

CLR_CRASH

APPLICATION_CRASH

DEADLOCK

RESOURCE_POOL_LIMIT

APPLICATION_DEPLOYMENT

APP_SERVER_RESTART

APPLICATION_CONFIG_CHANGE

AGENT_CONFIGURATION_ERROR

APPLICATION_DISCOVERED

TIER_DISCOVERED

NODE_DISCOVERED

MACHINE_DISCOVERED

BT_DISCOVERED

SERVICE_ENDPOINT_DISCOVERED

BACKEND_DISCOVERED

EUM_CLOUD_SYNTHETIC_HEALTHY_EVENT

EUM_CLOUD_SYNTHETIC_WARNING_EVENT

EUM_CLOUD_SYNTHETIC_CONFIRMED_WARNING_EVENT

EUM_CLOUD_SYNTHETIC_ONGOING_WARNING_EVENT

EUM_CLOUD_SYNTHETIC_ERROR_EVENT

EUM_CLOUD_SYNTHETIC_CONFIRMED_ERROR_EVENT

EUM_CLOUD_SYNTHETIC_ONGOING_ERROR_EVENT

EUM_CLOUD_SYNTHETIC_PERF_HEALTHY_EVENT

EUM_CLOUD_SYNTHETIC_PERF_WARNING_EVENT

EUM_CLOUD_SYNTHETIC_PERF_CONFIRMED_WARNING_EVENT

EUM_CLOUD_SYNTHETIC_PERF_ONGOING_WARNING_EVENT

EUM_CLOUD_SYNTHETIC_PERF_CRITICAL_EVENT

EUM_CLOUD_SYNTHETIC_PERF_CONFIRMED_CRITICAL_EVENT

EUM_CLOUD_SYNTHETIC_PERF_ONGOING_CRITICAL_EVENT

MOBILE_NEW_CRASH_EVENT

SLOW

VERY_SLOW

STALL

ERROR

anomalyEvents

minItems: 1

Events triggered due to anomaly detection.

AnomalyEventType

Enums

ANOMALY_OPEN_WARNING

ANOMALY_OPEN_CRITICAL

ANOMALY_UPGRADED

ANOMALY_DOWNGRADED

ANOMALY_CLOSE_WARNING

ANOMALY_CLOSE_CRITICAL

ANOMALY_CANCELED_WARNING

ANOMALY_CANCELED_CRITICAL

customEvents

Custom-defined events that trigger the policy.

CustomEvent

Property Name Type Description

eventName^* string

PropertyMatchCriteria

string

default: ANY

Enums

ANY

ALL

keyValuePairArray

KeyValuePair

Property Name	Type
`Key^*`	string
`Value^*`	string

CustomEvent

Details of custom-defined event that triggers the policy.

Property Name Type Description

eventName^* string

PropertyMatchCriteria

string

default: ANY

Enums

ANY

ALL

keyValuePairArray

KeyValuePair

Property Name	Type
`Key^*`	string
`Value^*`	string

HealthRuleEvent

Events associated with health rules that trigger the policy.

Property Name Type Description

healthRuleEventTypes^*

string

minItems: 1

HealthRuleEventType

Enums

HEALTH_RULE_CONTINUES_CRITICAL

HEALTH_RULE_OPEN_CRITICAL

HEALTH_RULE_OPEN_WARNING

HEALTH_RULE_UPGRADED

HEALTH_RULE_DOWNGRADED

HEALTH_RULE_CONTINUES_WARNING

HEALTH_RULE_CLOSE_WARNING

HEALTH_RULE_CLOSE_CRITICAL

HEALTH_RULE_CANCELED_WARNING

HEALTH_RULE_CANCELED_CRITICAL

healthRuleScope^*

string

Events associated with specific health rules or all health rules that trigger the policy.

healthRuleScopeType

Property Name Type Description

healthRuleScopeType^*

string

Enums

ALL_HEALTH_RULES

SPECIFIC_HEALTH_RULES

HealthRuleScope

Events associated with specific health rules or all health rules that trigger the policy.

Property Name Type Description

healthRuleScopeType^*

string

Enums

ALL_HEALTH_RULES

SPECIFIC_HEALTH_RULES

AllHealthRules

Events associated with all health rules within an application, trigger the policy.

Property Name Type Description

healthRuleScopeType^*

string

Enums

ALL_HEALTH_RULES

SPECIFIC_HEALTH_RULES

AllHealthRules

Events associated with specific health rules within an application, trigger the policy.

Property Name Type Description

healthRuleScopeType^*

string

Enums

ALL_HEALTH_RULES

SPECIFIC_HEALTH_RULES

healthRules^*

string

minItems: 1

HealthRuleEventTypes

Property Name Type Description

healthRuleEventTypes^*

string

Enums

HEALTH_RULE_CONTINUES_CRITICAL

HEALTH_RULE_OPEN_CRITICAL

HEALTH_RULE_OPEN_WARNING

HEALTH_RULE_UPGRADED

HEALTH_RULE_DOWNGRADED

HEALTH_RULE_CONTINUES_WARNING

HEALTH_RULE_CLOSE_WARNING

HEALTH_RULE_CLOSE_CRITICAL

HEALTH_RULE_CANCELED_WARNING

HEALTH_RULE_CANCELED_CRITICAL

OtherEvents

Property Name Type Description

otherEvents

string

OtherEventType

Enums

CLR_CRASH

APPLICATION_CRASH

DEADLOCK

RESOURCE_POOL_LIMIT

APPLICATION_DEPLOYMENT

APP_SERVER_RESTART

APPLICATION_CONFIG_CHANGE

AGENT_CONFIGURATION_ERROR

APPLICATION_DISCOVERED

TIER_DISCOVERED

NODE_DISCOVERED

MACHINE_DISCOVERED

BT_DISCOVERED

SERVICE_ENDPOINT_DISCOVERED

BACKEND_DISCOVERED

EUM_CLOUD_SYNTHETIC_HEALTHY_EVENT

EUM_CLOUD_SYNTHETIC_WARNING_EVENT

EUM_CLOUD_SYNTHETIC_CONFIRMED_WARNING_EVENT

EUM_CLOUD_SYNTHETIC_ONGOING_WARNING_EVENT

EUM_CLOUD_SYNTHETIC_ERROR_EVENT

EUM_CLOUD_SYNTHETIC_CONFIRMED_ERROR_EVENT

EUM_CLOUD_SYNTHETIC_ONGOING_ERROR_EVENT

EUM_CLOUD_SYNTHETIC_PERF_HEALTHY_EVENT

EUM_CLOUD_SYNTHETIC_PERF_WARNING_EVENT

EUM_CLOUD_SYNTHETIC_PERF_CONFIRMED_WARNING_EVENT

EUM_CLOUD_SYNTHETIC_PERF_ONGOING_WARNING_EVENT

EUM_CLOUD_SYNTHETIC_PERF_CRITICAL_EVENT

EUM_CLOUD_SYNTHETIC_PERF_CONFIRMED_CRITICAL_EVENT

EUM_CLOUD_SYNTHETIC_PERF_ONGOING_CRITICAL_EVENT

MOBILE_NEW_CRASH_EVENT

SLOW

VERY_SLOW

STALL

ERROR

AnomalyEvents

Events generated due to anomaly detection that trigger the policy.

Property Name Type Description

anomalyEvents

string

minItems: 1

AnomalyEventType

Enums

ANOMALY_OPEN_WARNING

ANOMALY_OPEN_CRITICAL

ANOMALY_UPGRADED

ANOMALY_DOWNGRADED

ANOMALY_CLOSE_WARNING

ANOMALY_CLOSE_CRITICAL

ANOMALY_CANCELED_WARNING

ANOMALY_CANCELED_CRITICAL

Action

A list of actions that are taken when a policy is triggered.

Property Name Type Description

actionName^* string

actionType^*

string

ActionType

Enums

SMS

EMAIL

CUSTOM_EMAIL

THREAD_DUMP

HTTP_REQUEST

CUSTOM

RUN_SCRIPT_ON_NODES

DIAGNOSTIC_BUSINESS_TRANSACTIONS

CREATE_UPDATE_JIRA

SimpleActionType

A simple action that is taken when the policy is triggered.

Property Name Type Description

actionName^* string

actionType^*

string

ActionType

Enums

SMS

EMAIL

CUSTOM_EMAIL

THREAD_DUMP

HTTP_REQUEST

CUSTOM

RUN_SCRIPT_ON_NODES

DIAGNOSTIC_BUSINESS_TRANSACTIONS

CREATE_UPDATE_JIRA

EmailActionType

An email is sent when the policy is triggered.

Property Name Type Description

actionName^* string

actionType^*

string

ActionType

Enums

SMS

EMAIL

CUSTOM_EMAIL

THREAD_DUMP

HTTP_REQUEST

CUSTOM

RUN_SCRIPT_ON_NODES

DIAGNOSTIC_BUSINESS_TRANSACTIONS

CREATE_UPDATE_JIRA

notes string

ActionOnSpecifiedEntities

A simple action that is taken for specific entities when the policy is triggered.

Property Name Type Description

actionName^* string

actionType^*

string

ActionType

Enums

SMS

EMAIL

CUSTOM_EMAIL

THREAD_DUMP

HTTP_REQUEST

CUSTOM

RUN_SCRIPT_ON_NODES

DIAGNOSTIC_BUSINESS_TRANSACTIONS

CREATE_UPDATE_JIRA

specifiedEntityActionDetails^*

string

SpecifiedEntityActionDetails

Property Name Type Description

specifiedEntityActionScope

string

SpecifiedEntityActionScope

Enums

PERCENTAGE

ABSOLUTE

SPECIFIC_NODES

SpecifiedEntityActionDetails

Property Name Type Description

specifiedEntityActionScope

string

SpecifiedEntityActionScope

Enums

PERCENTAGE

ABSOLUTE

SPECIFIC_NODES

ActionOnPercentageEntities

The scope of entities on which the action is performed is set to 'percentage'.

Property Name Type Description

specifiedEntityActionScope

string

SpecifiedEntityActionScope

Enums

PERCENTAGE

ABSOLUTE

SPECIFIC_NODES

value^* integer

ActionOnPercentageEntities

The scope of entities on which the action is performed is set to absolute.

Property Name Type Description

specifiedEntityActionScope

string

SpecifiedEntityActionScope

Enums

PERCENTAGE

ABSOLUTE

SPECIFIC_NODES

value^* integer

ActionOnPercentageEntities

A list of nodes on which the action is performed.

Property Name Type Description

specifiedEntityActionScope

string

SpecifiedEntityActionScope

Enums

PERCENTAGE

ABSOLUTE

SPECIFIC_NODES

nodes^*

string

minItems: 1

PolicySummaryArray

Property Name Type

id^* integer

name^*

string

minLength: 1

enabled^* boolean

KeyValuePair

Property Name	Type
`key^*`	string
`value^*`	string

PolicySummary

Property Name Type

id^* integer

name^*

string

minLength: 1

enabled^* boolean

PolicyConfiguration

Property Name Type

enabled^* boolean

policyName

string

EntityMatchingPattern

Entities that match the specified pattern.

Property Name Type Description

matchTo^*

string

Enums

STARTS_WITH

ENDS_WITH

CONTAINS

EQUALS

MATCH_REG_EX

matchValue^*

string

minLength: 1

shouldNot

boolean

default: false

ErrorResponse

Property Name	Type
`statusCode`	integer
`message`	string

PropertyMatchCriteria

Property Name Type Description

propertyMatchCriteria

string

default: ANY

Enums

ANY

ALL

EntityMatchingPatternEnum

Property Name Type Description

EntityMatchingPatternEnum

string

Enums

STARTS_WITH

ENDS_WITH

CONTAINS

EQUALS

MATCH_REG_EX

BusinessTransactionScopeEnum

Property Name Type Description

businessTransactionScope

string

Enums

ALL_BUSINESS_TRANSACTIONS SPECIFIC_BUSINESS_TRANSACTIONS

BUSINESS_TRANSACTIONS_IN_SPECIFIC_TIERS

BUSINESS_TRANSACTIONS_MATCHING_PATTERN

TierOrNodeScopeEnum

Property Name Type Description

TierOrNodeScope

string

Enums

TIER_SELECTED_ENTITIES

NODE_SELECTED_ENTITIES

SelectedTierScopeEnum

Property Name Type Description

SelectedTierScope

string

Enums

ALL_TIERS

SPECIFIC_TIERS

TypeOfNodeEnum

Property Name Type Description

typeofNode

string

Enums

ALL_NODES

JAVA_NODES

DOT_NET_NODES

PHP_NODES

SelectedNodesScopeEnum

Property Name Type Description

selectedNodeScope

string

Enums

ALL_NODES

SPECIFIC_NODES

NODES_OF_SPECIFIC_TIERS

NODES_MATCHING_PATTERN

NODE_PROPERTY_VARIABLE_MATCHER

NodePropertyTypeEnum

Property Name Type Description

NodePropertyTypeEnum

string

Enums

META

ENV

JVM

ErrorScopeEnum

Property Name Type Description

ErrorScopeEnum

string

Enums

ALL_ERRORS

SPECIFIC_ERRORS

ERRORS_OF_SPECIFIC_TIERS

ERRORS_MATCHING_PATTERN

ServiceEndpointScopeEnum

Property Name Type Description

ServiceEndpointScopeEnum

string

Enums

ALL_SERVICE_ENDPOINTS

SPECIFIC_SERVICE_ENDPOINTS

SERVICE_ENDPOINTS_IN_SPECIFIC_TIERS

SERVICE_ENDPOINTS_MATCHING_PATTERN

InformationPointScopeEnum

Property Name Type Description

InformationPointScopeEnum

string

ALL_INFORMATION_POINTS

SPECIFIC_INFORMATION_POINTS

INFORMATION_POINTS_MATCHING_PATTERN

DatabaseTypeEnum

Property Name Type Description

DatabaseTypeEnum

string

Enums

ALL_DATABASE_TYPES

COUCHBASE

DB2

MONGO_DB

MICROSOFT_SQL_SERVER

MYSQL

ORACLE

POSTGRE_SQL

AZURE_SQL

SYBASE

ApplicationDatabaseScopeEnum

Property Name Type Description

ApplicationDatabaseScopeEnum

string

Enums

ALL_APPLICATION_DATABASES

SPECIFIC_APPLICATION_DATABASES

APPLICATION_DATABASES_MATCHING_PATTERN

ServersScopeEnum

Property Name Type Description

ServersScopeEnum

string

Enums

ALL_SERVERS_IN_APPLICATION

SPECIFIC_SERVERS_IN_APPLICATION

ALL_SERVERS_IN_SPECIFIC_TIERS

SpecifiedEntityActionScopeEnum

Property Name Type Description

SpecifiedEntityActionScopeEnum

string

Enums

PERCENTAGE

ABSOLUTE

SPECIFIC_NODES

AnomalyEventType

Property Name Type Description

AnomalyEventType

string

Enums

ANOMALY_OPEN_WARNING

ANOMALY_OPEN_CRITICAL

ANOMALY_UPGRADED

ANOMALY_DOWNGRADED

ANOMALY_CLOSE_WARNING

ANOMALY_CLOSE_CRITICAL

ANOMALY_CANCELED_WARNING

ANOMALY_CANCELED_CRITICAL

HealthRuleEventTypeEnum

Property Name Type Description

HealthRuleEventTypeEnum

string

Enums

HEALTH_RULE_CONTINUES_CRITICAL

HEALTH_RULE_OPEN_CRITICAL

HEALTH_RULE_OPEN_WARNING

HEALTH_RULE_UPGRADED

HEALTH_RULE_DOWNGRADED

HEALTH_RULE_CONTINUES_WARNING

HEALTH_RULE_CLOSE_WARNING

HEALTH_RULE_CLOSE_CRITICAL

HEALTH_RULE_CANCELED_WARNING

HEALTH_RULE_CANCELED_CRITICAL

HealthRuleScopeType

Property Name Type Description

HealthRuleScopeType

string

ALL_HEALTH_RULES

SPECIFIC_HEALTH_RULES

OtherEventType

Property Name Type Description

OtherEventType

string

Enums

CLR_CRASH

APPLICATION_CRASH

DEADLOCK

RESOURCE_POOL_LIMIT

APPLICATION_DEPLOYMENT

APP_SERVER_RESTART

APPLICATION_CONFIG_CHANGE

AGENT_CONFIGURATION_ERROR

APPLICATION_DISCOVERED

TIER_DISCOVERED

NODE_DISCOVERED

MACHINE_DISCOVERED

BT_DISCOVERED

SERVICE_ENDPOINT_DISCOVERED

BACKEND_DISCOVERED

EUM_CLOUD_SYNTHETIC_HEALTHY_EVENT

EUM_CLOUD_SYNTHETIC_WARNING_EVENT

EUM_CLOUD_SYNTHETIC_CONFIRMED_WARNING_EVENT

EUM_CLOUD_SYNTHETIC_ONGOING_WARNING_EVENT

EUM_CLOUD_SYNTHETIC_ERROR_EVENT

EUM_CLOUD_SYNTHETIC_CONFIRMED_ERROR_EVENT

EUM_CLOUD_SYNTHETIC_ONGOING_ERROR_EVENT

EUM_CLOUD_SYNTHETIC_PERF_HEALTHY_EVENT

EUM_CLOUD_SYNTHETIC_PERF_WARNING_EVENT

EUM_CLOUD_SYNTHETIC_PERF_CONFIRMED_WARNING_EVENT

EUM_CLOUD_SYNTHETIC_PERF_ONGOING_WARNING_EVENT

EUM_CLOUD_SYNTHETIC_PERF_CRITICAL_EVENT

EUM_CLOUD_SYNTHETIC_PERF_CONFIRMED_CRITICAL_EVENT

EUM_CLOUD_SYNTHETIC_PERF_ONGOING_CRITICAL_EVENT

MOBILE_NEW_CRASH_EVENT, SLOW, VERY_SLOW, STALL

ERROR

SelectedEntityType

Property Name Type Description

SelectedEntityType

string

`Enums`

ANY_ENTITY

SPECIFIC_ENTITIES

EntityType

Property Name Type Description

EntityType

string

Enums

BUSINESS_TRANSACTION

TIER_NODE

ERRORS

SERVICE_ENDPOINTS

INFORMATION_POINTS

DATABASES_IN_APPLICATION

SERVERS_IN_APPLICATION

ActionTypeEnum

Property Name Type Description

ActionTypeEnum

string

Enums

SMS

EMAIL

CUSTOM_EMAIL

THREAD_DUMP

HTTP_REQUEST

CUSTOM

RUN_SCRIPT_ON_NODES

DIAGNOSTIC_BUSINESS_TRANSACTIONS

CREATE_UPDATE_JIRA

^*This property is required.

Download Examples

Download a set of examples that help you configure a policy, AppDynamicsPoliciesExamples.zip.

Download SWAGGER YAML Spec

Download the Swagger YAML spec policies_openapi.yml.