Download PDF
Download page Policy API.
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"
]
}
}
}
]
}
}
{
"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"
]
}
}
}
]
}
}
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": 1096,
"name": "My Policy 1",
"enabled": true,
"actions": [
{
"actionName": "action@email.com",
"actionType": "EMAIL"
}
],
"events": {
"healthRuleEvents": {
"healthRuleEventTypes": [
"HEALTH_RULE_OPEN_WARNING",
"HEALTH_RULE_OPEN_CRITICAL"
],
"healthRuleScopeType": "ALL_HEALTH_RULES",
"healthRuleCount": null
},
"otherEvents": [],
"anomalyEvents": null,
"customEvents": []
},
"selectedEntityType": "ANY_ENTITY"
},
{
"id": 1050,
"name": "My Policy 2",
"enabled": true,
"actions": [
{
"actionName": "action@email.com",
"actionType": "EMAIL"
}
],
"events": {
"healthRuleEvents": {
"healthRuleEventTypes": [
"HEALTH_RULE_OPEN_CRITICAL"
],
"healthRuleScopeType": "SPECIFIC_HEALTH_RULES",
"healthRuleCount": 1
},
"otherEvents": [],
"anomalyEvents": null,
"customEvents": []
},
"selectedEntityType": "ANY_ENTITY"
},
{
"id": 1051,
"name": "My policy 3",
"enabled": true,
"actions": [
{
"actionName": "action@email.com",
"actionType": "EMAIL"
}
],
"events": {
"healthRuleEvents": {
"healthRuleEventTypes": [
"HEALTH_RULE_OPEN_CRITICAL"
],
"healthRuleScopeType": "SPECIFIC_HEALTH_RULES",
"healthRuleCount": 1
},
"otherEvents": [],
"anomalyEvents": null,
"customEvents": []
},
"selectedEntityType": "ANY_ENTITY"
}
]
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"
]
}
}
}
]
}
}
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. Cisco AppDynamics recommends the following:
- Retrieve the JSON payload using
GET /policies/{policy-id}
and update the required fields. - From the JSON payload, remove the anomaly events that are empty or have null values. Check and delete these values from the payload:
"anomalyEvents": []
"anomalyEvents": null
- 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"
]
}
}
}
]
}
}
{
"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"
]
}
}
}
]
}
}
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
}
{
"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"
]
}
}
}
]
}
}
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 | ||||||||||||||||||||||||
| string | Name of the policy. Minimum length: 1 | ||||||||||||||||||||||||
enabled | boolean | Sets the policy to enabled/disabled state. Default value: | ||||||||||||||||||||||||
| boolean | Executes the actions configured for a policy, once for all the triggering events that occurred during the last minute. Default value: | ||||||||||||||||||||||||
| minItems: 1 | ActionDescribes the predefined, reusable, and automated response to an event to be taken when the policy is triggered.
| ||||||||||||||||||||||||
events* | EventsDescribes the events that trigger the policy.
| |||||||||||||||||||||||||
selectedEntities | SelectedEntityTypeScope of entities considered for the policy evaluation. Entities corresponding to EUM applications are not supported.
|
SelectedEntityType
Scope of entities considered for the policy evaluation.
Entities corresponding to EUM applications are not supported.
Property Name | Type | Description |
---|---|---|
SelectedEntityType * | string | Enums
|
SpecificEntities
Scope of specific entities considered for the policy evaluation.
Property Name | Type | Description | ||||||
---|---|---|---|---|---|---|---|---|
selectedEntityType* | string | Enums
| ||||||
entities | minItems: 1 | Entity
|
Entity
Property name | Type | Description |
---|---|---|
entityType * | string minItems: 1 | Enums
|
AnyEntity
Scope of entities considered for the policy evaluation.
Entities corresponding to EUM applications are not supported.
Property Name | Type | Description |
---|---|---|
SelectedEntityType * | string | Enums
|
BusinessTransaction
All entities of type BUSINESS_TRANSACTION
are considered for policy evaluation.
Property Name | Type | Description | ||||
---|---|---|---|---|---|---|
entityType* | string minItems: 1 | Enums
| ||||
selectedBusinessTransactions* | string | BusinessTransactionScope
|
SelectedBusinessTransactions
Property Name | Description |
---|---|
businessTransactionScope * | Enums
|
AllBusinessTransactions
The scope of business transactions is set to all business transactions.
Property Name | Description |
---|---|
businessTransactionScope * | Enums
|
SpecificBusinessTransactions
The scope of business transactions is set to select business transactions.
Property Name | Type | Description |
---|---|---|
businessTransactionScope* | Enums
| |
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
| |
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
| ||||||||||||
patternMatcher* | EntityMatchingPatternBusiness transactions that match the specified pattern are included in the scope.
|
SelectedTierOrNodeEntities
Specific tiers or nodes are considered for policy evaluation.
Property Name | Type | Description | ||||||
---|---|---|---|---|---|---|---|---|
entityType* | string | Enums
TIER_NODE ERRORS SERVICE_ENDPOINTS INFORMATION_POINTS DATABASES_IN_APPLICATION SERVERS_IN_APPLICATION | ||||||
tierOrNode* | string minLength: 1 | TierOrNode
|
TierOrNode
Property Name | Type | Description |
---|---|---|
tierOrNodeScope * | string | Enums
|
TierSelectedEntities
Property Name | Type | Description | ||||||
---|---|---|---|---|---|---|---|---|
tierOrNodeScope* | string | Enums
| ||||||
selectedTiers* | SelectedTiers
|
SelectedTiers
Property Name | Type | Description |
---|---|---|
selectedTierScope * | string | Enums
|
AllTiers
Property Name | Type | Description |
---|---|---|
selectedTierScope * | string | Enums
|
SpecificTiers
Property Name | Type | Description |
---|---|---|
selectedTierScope* | string | Enums
|
tiers* | string minItems: 1 | Name(s) of the specified tier(s). |
NodeSelectedEntities
Property Name | Type | Description | ||||||
---|---|---|---|---|---|---|---|---|
tierOrNodeScope* | string | Enums
| ||||||
typeofNode* | string | Enums
| ||||||
selectedNodes* | SelectedNodes
|
SelectedNodes
Property Name | Type | Description |
---|---|---|
selectedNodeScope* | string | Enums
|
AllNodes
Property Name | Type | Description |
---|---|---|
selectedNodeScope * | string | Enums
|
SpecificNodes
Property Name | Type | Description |
---|---|---|
selectedNodeScope * | string | Enums
|
nodes * | string minItems: 1 | Name(s) of the specified node(s). |
NodesOfSpecificTiers
Property Name | Type | Description |
---|---|---|
selectedNodeScope * | string | Enums
|
specificTiers * | string minItems: 1 | Name(s) of tier with the associated nodes. |
NodesMatchingPattern
Property Name | Type | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
selectedNodeScope* | string | Enums
| ||||||||||||
patternMatcher* | string minItems: 1 | EntityMatchingPatternNodes that match a specified pattern are included in the scope.
|
NodePropertyVariableMatcher
Property Name | Type | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
selectedNodeScope* | string | Enums
| ||||||||||||
propVarPairs* | minItems: 1 | propVarPairs
|
Errors
Specific errors are considered for policy evaluation.
Property Name | Type | Description | ||||||
---|---|---|---|---|---|---|---|---|
entityType* | string | Enums
| ||||||
selectedErrors* | SelectedErrors
|
SelectedErrors
Property Name | Type | Description |
---|---|---|
errorScope * | string | Enums
|
AllErrors
Property Name | Type | Description |
---|---|---|
errorScope * | string | Enums
|
SpecificErrors
Property Name | Type | Description |
---|---|---|
errorScope* | string | Enums
|
errors* | string minItems: 1 Example: |
ErrorsOfSpecificTiers
Property Name | Type | Description |
---|---|---|
errorScope* | string | Enums
|
specificTiers* | string minItems: 1 |
ErrorsMatchingPattern
Property Name | Type | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errorScope* | string | Enums
| ||||||||||||
patternMatcher* | EntityMatchingPattern
|
ServiceEndpoints
Specific service endpoints are considered for policy evaluation.
Property Name | Type | Description | ||||||
---|---|---|---|---|---|---|---|---|
entityType* | string | Enums
| ||||||
selectedServiceEndpoints* | SelectedServiceEndpoints
|
SelectedServiceEndpoints
Property Name | Type | Description |
---|---|---|
serviceEndpointScope* | string | Enums
|
AllServiceEndpoints
Property Name | Type | Description |
---|---|---|
serviceEndpointScope * | string | Enums
|
SpecificServiceEndpoints
Property Name | Type | Description |
---|---|---|
serviceEndpointScope* | string | Enums
|
serviceEndpoints* | string minItems: 1 |
ServiceEndpointsInSpecificTiers
Property Name | Type | Description |
---|---|---|
serviceEndpointScope* | string | EnumsALL_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 | EnumsALL_SERVICE_ENDPOINTS SPECIFIC_SERVICE_ENDPOINTS SERVICE_ENDPOINTS_IN_SPECIFIC_TIERS SERVICE_ENDPOINTS_MATCHING_PATTERN | ||||||||||||
patternMatcher* | EntityMatchingPattern
|
InformationPoints
Specific information points are considered for policy evaluation.
Property Name | Type | Description | ||||||
---|---|---|---|---|---|---|---|---|
entityType* | string | Enums
| ||||||
selectedInformationPoints* | SelectedInformationPoints
|
SelectedInformationPoints
Property Name | Type | Description |
---|---|---|
informationPointScope * | string | EnumsALL_INFORMATION_POINTS SPECIFIC_INFORMATION_POINTS INFORMATION_POINTS_MATCHING_PATTERN |
AllInformationPoints
Property Name | Type | Description |
---|---|---|
informationPointScope * | string | Enums
|
SpecificInformationPoints
Property Name | Type | Description |
---|---|---|
informationPointScope * | string | Enums
|
informationPoints* | string minItems: 1 |
InformationPointsMatchingPattern
Property Name | Type | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
informationPointScope* | string | Enums
| ||||||||||||
patternMatcher* | EntityMatchingPattern
|
DatabasesInApplication
Specific databases associated with the application are considered for policy evaluation.
Property Name | Type | Description | ||||||
---|---|---|---|---|---|---|---|---|
entityType* | string | Enums
| ||||||
selectedApplicationDatabases* | SelectedApplicationDatabases
|
SelectedApplicationDatabases
Property Name | Type | Description |
---|---|---|
applicationDatabaseScope* | string | Enums
|
AllApplicationDatabases
Property Name | Type | Description |
---|---|---|
applicationDatabaseScope * | string | Enums
|
SpecificApplicationDatabases
Property Name | Type | Description |
---|---|---|
applicationDatabaseScope* | string | Enums
|
applicationDatabases* | string minItems: 1 |
ApplicationDatabasesMatchingPattern
Property Name | Type | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
applicationDatabaseScope* | string | Enums
| ||||||||||||
patternMatcher* | EntityMatchingPattern
|
ServersInApplication
Specific servers associated with the application, are considered for the policy evaluation.
Property Name | Type | Description | ||||||
---|---|---|---|---|---|---|---|---|
entityType* | string | Enums
| ||||||
selectedServers* | string | ApplicationSelectedServers
|
ApplicationSelectedServers
Property Name | Type | Description |
---|---|---|
serversScope * | string | Enums
|
AllServersInApplication
Property Name | Type | Description |
---|---|---|
serversScope * | string | Enums
|
SpecificServersInApplication
Property Name | Type | Description |
---|---|---|
serversScope* | string | Enums
|
specificServers* | string minLength: 1 minItems: 1 |
AllServersInSpecificTiers
Property Name | Type | Description |
---|---|---|
serversScope* | string | Enums
|
specificTiers* | string minItems: 1 |
Events
Different types of events that trigger a policy.
Property Name | Type | Description | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
healthRuleEvents | HealthRuleEventEvents associated with health rules that trigger the policy.
| |||||||||||||||||||
otherEvents | string | OtherEventTypeEnums
| ||||||||||||||||||
anomalyEvents | minItems: 1 | Events triggered due to anomaly detection. AnomalyEventTypeEnums
| ||||||||||||||||||
customEvents | Custom-defined events that trigger the policy. CustomEvent
|
CustomEvent
Details of custom-defined event that triggers the policy.
Property Name | Type | Description | ||||||
---|---|---|---|---|---|---|---|---|
eventName* | string | |||||||
PropertyMatchCriteria | string default: ANY | Enums
| ||||||
keyValuePairArray | KeyValuePair
|
HealthRuleEvent
Events associated with health rules that trigger the policy.
Property Name | Type | Description | ||||||
---|---|---|---|---|---|---|---|---|
healthRuleEventTypes* | string minItems: 1 | HealthRuleEventTypeEnums
| ||||||
healthRuleScope* | string | Events associated with specific health rules or all health rules that trigger the policy. healthRuleScopeType
|
HealthRuleScope
Events associated with specific health rules or all health rules that trigger the policy.
Property Name | Type | Description |
---|---|---|
healthRuleScopeType* | string | Enums
|
AllHealthRules
Events associated with all health rules within an application, trigger the policy.
Property Name | Type | Description |
---|---|---|
healthRuleScopeType* | string | Enums
|
AllHealthRules
Events associated with specific health rules within an application, trigger the policy.
Property Name | Type | Description |
---|---|---|
healthRuleScopeType* | string | Enums
|
healthRules* | string minItems: 1 |
HealthRuleEventTypes
Property Name | Type | Description |
---|---|---|
healthRuleEventTypes * | string | Enums
|
OtherEvents
Property Name | Type | Description |
---|---|---|
otherEvents | string | OtherEventTypeEnums
|
AnomalyEvents
Events generated due to anomaly detection that trigger the policy.
Property Name | Type | Description |
---|---|---|
anomalyEvents | string minItems: 1 | AnomalyEventTypeEnums
|
Action
A list of actions that are taken when a policy is triggered.
Property Name | Type | Description |
---|---|---|
actionName* | string | |
actionType* | string | ActionTypeEnums
|
SimpleActionType
A simple action that is taken when the policy is triggered.
Property Name | Type | Description |
---|---|---|
actionName* | string | |
actionType * | string | ActionTypeEnums
|
EmailActionType
An email is sent when the policy is triggered.
Property Name | Type | Description |
---|---|---|
actionName* | string | |
actionType* | string | ActionTypeEnums
|
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 | ActionTypeEnums
| ||||||
specifiedEntityActionDetails* | string | SpecifiedEntityActionDetails
|
SpecifiedEntityActionDetails
Property Name | Type | Description |
---|---|---|
specifiedEntityActionScope | string | SpecifiedEntityActionScopeEnums
|
ActionOnPercentageEntities
The scope of entities on which the action is performed is set to 'percentage'.
Property Name | Type | Description |
---|---|---|
specifiedEntityActionScope | string | SpecifiedEntityActionScopeEnums
|
value* | integer |
ActionOnPercentageEntities
The scope of entities on which the action is performed is set to absolute.
Property Name | Type | Description |
---|---|---|
specifiedEntityActionScope | string | SpecifiedEntityActionScopeEnums
|
value* | integer |
ActionOnPercentageEntities
A list of nodes on which the action is performed.
Property Name | Type | Description |
---|---|---|
specifiedEntityActionScope | string | SpecifiedEntityActionScopeEnums
|
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
|
matchValue* | string minLength: 1 | |
shouldNot | boolean default: |
ErrorResponse
Property Name | Type |
---|---|
statusCode | integer |
message | string |
PropertyMatchCriteria
Property Name | Type | Description |
---|---|---|
propertyMatchCriteria | string default: ANY | Enums
|
EntityMatchingPatternEnum
Property Name | Type | Description |
---|---|---|
EntityMatchingPatternEnum | string | Enums
ENDS_WITH CONTAINS EQUALS MATCH_REG_EX |
BusinessTransactionScopeEnum
Property Name | Type | Description |
---|---|---|
businessTransactionScope | string | Enums
|
TierOrNodeScopeEnum
Property Name | Type | Description |
---|---|---|
| string | Enums
|
SelectedTierScopeEnum
Property Name | Type | Description |
---|---|---|
| string | Enums
|
TypeOfNodeEnum
Property Name | Type | Description |
---|---|---|
typeofNode | string | Enums
|
SelectedNodesScopeEnum
Property Name | Type | Description |
---|---|---|
selectedNodeScope | string | Enums
|
NodePropertyTypeEnum
Property Name | Type | Description |
---|---|---|
| string | Enums
|
ErrorScopeEnum
Property Name | Type | Description |
---|---|---|
ErrorScopeEnum | string | Enums
|
ServiceEndpointScopeEnum
Property Name | Type | Description |
---|---|---|
ServiceEndpointScopeEnum | string | Enums
|
InformationPointScopeEnum
Property Name | Type | Description |
---|---|---|
InformationPointScopeEnum | string |
|
DatabaseTypeEnum
Property Name | Type | Description |
---|---|---|
DatabaseTypeEnum | string |
|
ApplicationDatabaseScopeEnum
Property Name | Type | Description |
---|---|---|
ApplicationDatabaseScopeEnum | string | Enums
|
ServersScopeEnum
Property Name | Type | Description |
---|---|---|
ServersScopeEnum | string |
|
SpecifiedEntityActionScopeEnum
Property Name | Type | Description |
---|---|---|
SpecifiedEntityActionScopeEnum | string | Enums
|
AnomalyEventType
Property Name | Type | Description |
---|---|---|
AnomalyEventType | string | Enums
|
HealthRuleEventTypeEnum
Property Name | Type | Description |
---|---|---|
HealthRuleEventTypeEnum | string | Enums
|
HealthRuleScopeType
Property Name | Type | Description |
---|---|---|
HealthRuleScopeType | string |
|
OtherEventType
Property Name | Type | Description |
---|---|---|
OtherEventType | string | Enums
|
SelectedEntityType
Property Name | Type | Description |
---|---|---|
SelectedEntityType | string |
|
EntityType
Property Name | Type | Description |
---|---|---|
EntityType | string | Enums
|
ActionTypeEnum
Property Name | Type | Description |
---|---|---|
ActionTypeEnum | string | Enums
|
*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
.