Download PDF
Download page Email Digest API.
Email Digest API
This page provides Email Digest API methods you can use to report a summary of a specific event(s) to a recipient list configured on a health rule schedule. Email digests are triggered as a response to a health rule violation event.
Syntax validation of the JSON payload is done when creating the email digest.
Create a New Email Digest
Creates a new email digest with the specified JSON payload. See Property Details.
Resource URL
POST <controller_url>/controller/alerting/rest/v1
/applications/<application_id>/email-digests
Request/Response Format
JSON
Example
This example creates a new email digest. See Download Examples.
{
"name": "My new email digest",
"enabled": true,
"executeActionsInBatch": true,
"frequency": 2,
"actions": [
{
"actionName": "My action 1",
"actionType": "SMS"
}
],
"events": {
"healthRuleEvents": {
"healthRuleEventTypes": [
"HEALTH_RULE_CONTINUES_CRITICAL",
"HEALTH_RULE_UPGRADED"
],
"healthRuleScope": {
"healthRuleScopeType": "ALL_HEALTH_RULES"
}
},
"otherEvents": [
"CLR_CRASH",
"DEADLOCK"
],
"anomalyEvents": [
"ANOMALY_OPEN_WARNING",
"ANOMALY_CLOSE_CRITICAL"
],
"customEvents": [
{
"eventName": "string",
"propertyMatchCriteria": "ANY",
"keyValuePairArray": [
{
"key": "key1",
"value": "value1"
}
]
}
]
},
"selectedEntities": {
"selectedEntityType": "ANY_ENTITY"
}
}
This example returns the created email digest object.
{
"id": 0,
"name": "My new email digest",
"enabled": true,
"executeActionsInBatch": true,
"frequency": 2,
"actions": [
{
"actionName": "My action 1",
"actionType": "SMS"
}
],
"events": {
"healthRuleEvents": {
"healthRuleEventTypes": [
"HEALTH_RULE_CONTINUES_CRITICAL",
"HEALTH_RULE_UPGRADED"
],
"healthRuleScope": {
"healthRuleScopeType": "ALL_HEALTH_RULES"
}
},
"otherEvents": [
"CLR_CRASH",
"DEADLOCK"
],
"anomalyEvents": [
"ANOMALY_OPEN_WARNING",
"ANOMALY_CLOSE_CRITICAL"
],
"customEvents": [
{
"eventName": "string",
"propertyMatchCriteria": "ANY",
"keyValuePairArray": [
{
"key": "key1",
"value": "value1"
}
]
}
]
},
"selectedEntities": {
"selectedEntityType": "ANY_ENTITY"
}
}
Retrieve a List of Email Digests for an Application
This API returns the email digest names, IDs, and enable flag details pertaining to the specified application. See Property Details.
Resource URL
GET <controller_url>/controller/alerting/rest/v1/applications/<application_id>/
email-digests
Response Format
JSON
Example Response
This example returns a list of email digests pertaining to the specified application ID.
[
{
"id": 12,
"name": "some email digest name",
"enabled": true
}
]
Retrieve Details of an Email Digest
Retrieves the details of an email digest with a specified ID. See Property Details.
Ensure that you provide a valid email digest ID.
Resource URL
GET <controller_url>/controller/alerting/rest/v1/applications/<application_id>/email-digests/{email-digest-id}
Response Format
JSON
Example Response
{
"id": 0,
"name": "My new email digest",
"enabled": true,
"executeActionsInBatch": true,
"frequency": 2,
"actions": [
{
"actionName": "My action 1",
"actionType": "SMS"
}
],
"events": {
"healthRuleEvents": {
"healthRuleEventTypes": [
"HEALTH_RULE_CONTINUES_CRITICAL",
"HEALTH_RULE_UPGRADED"
],
"healthRuleScope": {
"healthRuleScopeType": "ALL_HEALTH_RULES"
}
},
"otherEvents": [
"CLR_CRASH",
"DEADLOCK"
],
"anomalyEvents": [
"ANOMALY_OPEN_WARNING",
"ANOMALY_CLOSE_CRITICAL"
],
"customEvents": [
{
"eventName": "string",
"propertyMatchCriteria": "ANY",
"keyValuePairArray": [
{
"key": "key1",
"value": "value1"
}
]
}
]
},
"selectedEntities": {
"selectedEntityType": "ANY_ENTITY"
}
}
Update an Email Digest
Updates an existing email digest with a specified JSON payload. See Property Details.
This request requires a complete JSON payload as input. It is recommended that you retrieve the JSON payload using,
GET email-digests/{email-digest-id}
and update the required fields. Then, send the modified payload as part of PUT
request.
Resource URL
PUT <controller_url>/controller/alerting/rest/v1/applications/<application_id>/email-digests/{email-digest-id}
Request/Response Format
JSON
Example
This example updates an action. See Download Examples.
{
"name": "My new email digest",
"enabled": true,
"executeActionsInBatch": true,
"frequency": 2,
"actions": [
{
"actionName": "My action 1",
"actionType": "SMS"
}
],
"events": {
"healthRuleEvents": {
"healthRuleEventTypes": [
"HEALTH_RULE_CONTINUES_CRITICAL",
"HEALTH_RULE_UPGRADED"
],
"healthRuleScope": {
"healthRuleScopeType": "ALL_HEALTH_RULES"
}
},
"otherEvents": [
"CLR_CRASH",
"DEADLOCK"
],
"anomalyEvents": [
"ANOMALY_OPEN_WARNING",
"ANOMALY_CLOSE_CRITICAL"
],
"customEvents": [
{
"eventName": "string",
"propertyMatchCriteria": "ANY",
"keyValuePairArray": [
{
"key": "key1",
"value": "value1"
}
]
}
]
},
"selectedEntities": {
"selectedEntityType": "ANY_ENTITY"
}
}
This example returns the updated action.
{
"id": 0,
"name": "My new email digest",
"enabled": true,
"executeActionsInBatch": true,
"frequency": 2,
"actions": [
{
"actionName": "My action 1",
"actionType": "SMS"
}
],
"events": {
"healthRuleEvents": {
"healthRuleEventTypes": [
"HEALTH_RULE_CONTINUES_CRITICAL",
"HEALTH_RULE_UPGRADED"
],
"healthRuleScope": {
"healthRuleScopeType": "ALL_HEALTH_RULES"
}
},
"otherEvents": [
"CLR_CRASH",
"DEADLOCK"
],
"anomalyEvents": [
"ANOMALY_OPEN_WARNING",
"ANOMALY_CLOSE_CRITICAL"
],
"customEvents": [
{
"eventName": "string",
"propertyMatchCriteria": "ANY",
"keyValuePairArray": [
{
"key": "key1",
"value": "value1"
}
]
}
]
},
"selectedEntities": {
"selectedEntityType": "ANY_ENTITY"
}
}
Delete an Email Digest
Deletes an email digest with the specified ID. See Property Details.
Ensure that you provide a valid email digest ID.
Resource URL
DELETE <controller_url>/controller/alerting/rest/v1/applications/<application_id>/email-digests/{email-digest-id}
Update one or more properties of an Email Digest
Updates the properties of an existing email digest with a specified JSON payload. See Property Details
Resource URL
PUT <controller_url>/controller/alerting/rest/v1/applications/<application_id>/email-digests/{email-digest-id}/configuration
Request/Response Format
JSON
Example
This example updates the properties of a specified email digest.
{
"enabled": true,
"emailDigestName": "test email digest",
"frequency": 2
}
This example returns the properties updated for a specified email digest.
{
"id": 0,
"name": "My new email digest",
"enabled": true,
"executeActionsInBatch": true,
"frequency": 2,
"actions": [
{
"actionName": "My action 1",
"actionType": "SMS"
}
],
"events": {
"healthRuleEvents": {
"healthRuleEventTypes": [
"HEALTH_RULE_CONTINUES_CRITICAL",
"HEALTH_RULE_UPGRADED"
],
"healthRuleScope": {
"healthRuleScopeType": "ALL_HEALTH_RULES"
}
},
"otherEvents": [
"CLR_CRASH",
"DEADLOCK"
],
"anomalyEvents": [
"ANOMALY_OPEN_WARNING",
"ANOMALY_CLOSE_CRITICAL"
],
"customEvents": [
{
"eventName": "string",
"propertyMatchCriteria": "ANY",
"keyValuePairArray": [
{
"key": "key1",
"value": "value1"
}
]
}
]
},
"selectedEntities": {
"selectedEntityType": "ANY_ENTITY"
}
}
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
Email Digest
Payload details of an email digest.
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 Minimum length: 1 | Name of the email digest. | ||||||||||||||||||||||||||
enabled | boolean Default value: | Sets the email digest to enabled/disabled state. | ||||||||||||||||||||||||||
frequency | integer minimum: 1 maximum: 168 | The frequency in hours at which emails are sent as a response to an event. | ||||||||||||||||||||||||||
| minItems: 1 | ActionDescribes the predefined, reusable, and automated response to an event to be taken when the event is triggered.
| ||||||||||||||||||||||||||
events* | EventsDescribes the events that trigger the email digest.
| |||||||||||||||||||||||||||
selectedEntities | SelectedEntityTypeScope of entities considered for the email digest. Entities corresponding to EUM applications are not supported.
|
SelectedEntityType
Scope of entities considered for the email digest.
Property Name | Type | Description |
---|---|---|
SelectedEntityType* | string | Enums
|
SpecificEntities
Scope of specific entities considered for the email digest.
Property Name | Type | Description | ||||||
---|---|---|---|---|---|---|---|---|
selectedEntityType* | string | Enum
| ||||||
entities | minItems: 1 | Entity
|
Entity
Property name | Type | Description |
---|---|---|
entityType* | string minItems: 1 | Enums
|
AnyEntity
Scope of entities considered for the email digest.
Property Name | Type | Description |
---|---|---|
SelectedEntityType * | string | Enums
|
SelectedMobileApps
Property name | Type | Description |
---|---|---|
mobileAppsScope * | string | Enums
|
AllMobileApps
Property name | Type | Description |
---|---|---|
mobileAppsScope* | string | Enum
|
SpecificMobileApps
Property name | Type | Description |
---|---|---|
mobileAppsScope* | string | Enum
|
mobileApps | string minItems: 1 |
MobileAppsMatchingPattern
Property name | Type | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
mobileAppsScope* | string | EnumMOBILE_APPS_MATCHING_PATTERN | ||||||||||||
patternMatcher* | EntityMatchingPatternBusiness transactions that match the specified pattern are included in the scope.
|
MobileNetworkRequests
Property name | Type | Description |
---|---|---|
entityType* | string minItems: 1 | Enum
|
selectedMobileNetworkRequests* | string | MobileNetworkRequestsScopeEnums
|
SelectedMobileNetworkRequests
Property name | Type | Description |
---|---|---|
mobileNetworkRequestsScope * | string | MobileNetworkRequestsScopeEnums
|
AllMobileNetworkRequests
The scope of mobile network requests is ALL_MOBILE_NETWORK_REQUESTS
.
Property name | Type | Description |
---|---|---|
mobileNetworkRequestsScope* | string | MobileNetworkRequestsScopeEnum
|
SpecificMobileNetworkRequests
The scope of mobile network requests is SPECIFIC_MOBILE_NETWORK_REQUESTS
.
Property name | Type | Description |
---|---|---|
mobileNetworkRequestsScope* | string | MobileNetworkRequestsScopeEnum
|
mobileNetworkRequests* | string minItems:1 |
SpecificMobileAppsNetworkRequests
The scope of mobile network requests is SPECIFIC_MOBILE_APPS_NETWORK_REQUESTS
.
Property name | Type | Description |
---|---|---|
mobileNetworkRequestsScope* | string | MobileNetworkRequestsScopeEnum
|
mobileApps* | string minItems:1 |
MobileNetworkRequestsMatchingPattern
The scope of mobile network requests is MOBILE_NETWORK_REQUESTS_MATCHING_PATTERN
.
Property name | Type | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
mobileNetworkRequestsScope* | string | MobileNetworkRequestsScopeEnum
| ||||||||||||
patternMatcher* | EntityMatchingPatternBusiness transactions that match the specified pattern are included in the scope.
|
Page
The scope of entities considered for the email digest is page
for EUM applications.
Property name | Type | Description |
---|---|---|
entityType* | string minItems: 1 | Enum
|
selectedPages* | string | pageScopeEnums
|
SelectedPages
The scope of entities considered for the email digest is selected pages
for EUM applications.
Property name | Type | Description |
---|---|---|
pageScope * | string | Enums
|
AllPages
The scope of entities considered for the email digest is ALL_PAGES
for EUM applications.
Property name | Type | Description |
---|---|---|
pageScope* | string | Enum
|
SpecificPages
The scope of entities considered for the email digest is SPECIFIC_PAGES
for EUM applications.
Property name | Type | Description |
---|---|---|
pageScope* | string | Enum
|
pages* | array of strings minItems: 1 |
PagesMatchingPattern
The scope of entities considered for the email digest is SPECIFIC_PAGES
for EUM applications.
Property name | Type | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
pageScope* | string | Enum
| ||||||||||||
pages* | EntityMatchingPatternBusiness transactions that match the specified pattern are included in the scope.
|
VirtualPage
Property name | Type | Description |
---|---|---|
entityType* | string minItems: 1 | Enum
|
| string | SelectedVirtualPagesEnums
|
SelectedVirtualPages
Property name | Type | Description |
---|---|---|
| string | SelectedVirtualPagesEnums
|
AllVirtualPages
Property name | Type | Description |
---|---|---|
| string | SelectedVirtualPagesEnum
|
SpecificVirtualPages
Property name | Type | Description |
---|---|---|
| string | SelectedVirtualPagesEnum
|
virtualPages | string minItems: 1 |
VirtualPagesMatchingPattern
Property name | Type | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| string | SelectedVirtualPagesEnum
| ||||||||||||
patternMatcher | EntityMatchingPatternBusiness transactions that match the specified pattern are included in the scope.
|
SyntheticJob
Property name | Type | Description |
---|---|---|
entityType* | string minItems: 1 | Enum
|
selectedSyntheticJobs* | string | SelectedSyntheticJobsEnums
|
SelectedSyntheticJobs
Property name | Type | Description |
---|---|---|
syntheticJobScope * | string | Enums
|
AllSyntheticJobs
Property name | Type | Description |
---|---|---|
syntheticJobScope * | string | Enum
|
SpecificSyntheticJobs
Property name | Type | Description |
---|---|---|
syntheticJobScope* | string | Enum
|
syntheticJobs* | string minItems: 1 |
SyntheticJobsMatchingPattern
Property name | Type | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
syntheticJobScope* | string | Enum
| ||||||||||||
patternMatcher* | EntityMatchingPatternBusiness transactions that match the specified pattern are included in the scope.
|
IFrame
Property name | Type | Description |
---|---|---|
entityType* | string minItems: 1 | EnumIFRAME |
selectedIFrames* | string | iFrameScopeEnums
|
SelectedIFrames
Property name | Type | Description |
---|---|---|
iFrameScope * | string | Enums
|
AllIFrames
Property name | Type | Description |
---|---|---|
iFrameScope * | string | Enum
|
SpecificIFrames
Property name | Type | Description |
---|---|---|
iFrameScope* | string | Enum
|
iFrames* | string minItems: 1 |
IFramesMatchingPattern
Property name | Type | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
iFrameScope* | string | Enum
| ||||||||||||
patternMatcher* | EntityMatchingPatternBusiness transactions that match the specified pattern are included in the scope.
|
AjaxRequest
Property name | Type | Description |
---|---|---|
entityType* | string minItems: 1 | Enum
|
selectedAjaxRequests* | string | AjaxRequestsScopeEnums
|
SelectedAjaxRequests
Property name | Type | Description |
---|---|---|
selectedAjaxRequests * | string | Enums
|
AllAjaxRequests
Property name | Type | Description |
---|---|---|
selectedAjaxRequests * | string | Enum
|
SpecificAjaxRequests
Property name | Type | Description |
---|---|---|
selectedAjaxRequests* | string | Enum
|
ajaxRequests* | array of strings minItems: 1 |
AjaxRequestsMatchingPattern
Property name | Type | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
ajaxRequestScope* | string | Enum
| ||||||||||||
patternMatcher* | EntityMatchingPatternBusiness transactions that match the specified pattern are included in the scope.
|
BusinessTransaction
All entities of type BUSINESS_TRANSACTION
are considered for email digest.
Property Name | Type | Description | ||||
---|---|---|---|---|---|---|
entityType* | string | EnumBUSINESS_TRANSACTION | ||||
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 * | Enum
|
SpecificBusinessTransactions
The scope of business transactions is set to select business transactions.
Property Name | Type | Description |
---|---|---|
businessTransactionScope* | string | Enum
|
businessTransactions* | array of strings 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* | Enum
| |
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* | Enum
| ||||||||||||
patternMatcher* | EntityMatchingPatternBusiness transactions that match the specified pattern are included in the scope.
|
SelectedTierOrNodeEntities
Specific tiers or nodes are considered for the email digest.
Property Name | Type | Description | ||||||
---|---|---|---|---|---|---|---|---|
entityType* | string | EnumTIER_NODE | ||||||
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 | Enum
|
SpecificTiers
Property Name | Type | Description |
---|---|---|
selectedTierScope* | string | Enum
|
tiers* | string minItems: 1 | Name(s) of the specified tier(s). |
NodeSelectedEntities
Property Name | Type | Description | ||||||
---|---|---|---|---|---|---|---|---|
tierOrNodeScope* | string | EnumNODE_SELECTED_ENTITIES | ||||||
typeofNode* | string | EnumsALL_NODES JAVA_NODES DOT_NET_NODES PHP_NODES | ||||||
selectedNodes* | SelectedNodes
|
SelectedNodes
Property Name | Type | Description |
---|---|---|
selectedNodeScope * | string | Enums
|
AllNodes
Property Name | Type | Description |
---|---|---|
selectedNodeScope * | string | Enum
|
SpecificNodes
Property Name | Type | Description |
---|---|---|
selectedNodeScope* | string | Enum
|
nodes* | string minItems: 1 | Name(s) of the specified node(s). |
NodesOfSpecificTiers
Property Name | Type | Description |
---|---|---|
selectedNodeScope* | string | Enum
|
specificTiers* | string minItems: 1 | Name(s) of tier with the associated nodes. |
NodesMatchingPattern
Property Name | Type | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
selectedNodeScope* | string | Enum
| ||||||||||||
patternMatcher* | EntityMatchingPatternNodes that match a specified pattern are included in the scope.
|
NodePropertyVariableMatcher
Property Name | Type | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
selectedNodeScope* | string | Enum
| ||||||||||||
propVarPairs* | minItems: 1 | propVarPairs
|
Errors
Specific errors are considered for email digest.
Property Name | Type | Description | ||||||
---|---|---|---|---|---|---|---|---|
entityType* | string | Enum
| ||||||
selectedErrors* | SelectedErrors
|
SelectedErrors
Property Name | Type | Description |
---|---|---|
errorScope * | string | Enums
|
AllErrors
Property Name | Type | Description |
---|---|---|
errorScope * | string | Enum
|
SpecificErrors
Property Name | Type | Description |
---|---|---|
errorScope* | string | Enum
|
errors* | string minItems: 1 Example: |
ErrorsOfSpecificTiers
Property Name | Type | Description |
---|---|---|
errorScope* | string | Enum
|
specificTiers* | string minItems: 1 |
ErrorsMatchingPattern
Property Name | Type | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errorScope* | string | EnumERRORS_MATCHING_PATTERN | ||||||||||||
patternMatcher* | EntityMatchingPattern
|
ServiceEndpoints
Specific service endpoints are considered for email digest.
Property Name | Type | Description | ||||||
---|---|---|---|---|---|---|---|---|
entityType* | string | Enum
| ||||||
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 | Enum
|
serviceEndpoints* | string minItems: 1 |
ServiceEndpointsInSpecificTiers
Property Name | Type | Description |
---|---|---|
serviceEndpointScope* | string | Enum
|
specificTiers* | string minItems: 1 |
ServiceEndpointsMatchingPattern
Property Name | Type | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
serviceEndpointScope* | string | Enum
| ||||||||||||
patternMatcher* | EntityMatchingPattern
|
InformationPoints
Specific information points are considered for email digest.
Property Name | Type | Description | ||||||
---|---|---|---|---|---|---|---|---|
entityType* | string | EnumINFORMATION_POINTS | ||||||
selectedInformationPoints* | SelectedInformationPoints
|
SelectedInformationPoints
Property Name | Type | Description |
---|---|---|
informationPointScope * | string | Enums
|
AllInformationPoints
Property Name | Type | Description |
---|---|---|
informationPointScope * | string | Enums
|
SpecificInformationPoints
Property Name | Type | Description |
---|---|---|
informationPointScope* | string | Enum
|
informationPoints* | string minItems: 1 |
InformationPointsMatchingPattern
Property Name | Type | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
informationPointScope* | string | Enum
| ||||||||||||
patternMatcher* | EntityMatchingPattern
|
DatabasesInApplication
Specific databases associated with the application are considered for email digest.
Property Name | Type | Description | ||||||
---|---|---|---|---|---|---|---|---|
entityType* | string | Enums
| ||||||
selectedApplicationDatabases* | SelectedApplicationDatabases
|
SelectedApplicationDatabases
Property Name | Type | Description |
---|---|---|
applicationDatabaseScope * | string | Enums
|
AllApplicationDatabases
Property Name | Type | Description |
---|---|---|
applicationDatabaseScope * | string | Enum
|
SpecificApplicationDatabases
Property Name | Type | Description |
---|---|---|
applicationDatabaseScope* | string | Enum
|
applicationDatabases* | string minItems: 1 |
ApplicationDatabasesMatchingPattern
Property Name | Type | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
applicationDatabaseScope* | string | Enum
| ||||||||||||
patternMatcher* | EntityMatchingPattern
|
ServersInApplication
Specific servers associated with the application are considered for the email digest.
Property Name | Type | Description | ||||||
---|---|---|---|---|---|---|---|---|
entityType* | string | Enum
| ||||||
selectedServers* | string | ApplicationSelectedServers
|
ApplicationSelectedServers
Property Name | Type | Description |
---|---|---|
serversScope * | string | Enums
|
AllServersInApplication
Property Name | Type | Description |
---|---|---|
serversScope * | string | Enum
|
SpecificServersInApplication
Property Name | Type | Description |
---|---|---|
serversScope* | string | Enum
|
specificServers* | string minLength: 1 minItems: 1 |
AllServersInSpecificTiers
Property Name | Type | Description |
---|---|---|
serversScope* | string | Enum
|
specificTiers* | string minItems: 1 |
Events
Different types of events considered for an email digest.
Property Name | Type | Description | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
healthRuleEvents | HealthRuleEventEvents associated with health rules that trigger the email digest.
| |||||||||||||||||||
otherEvents | string | OtherEventTypeEnums
| ||||||||||||||||||
anomalyEvents | minItems: 1 | Events triggered due to anomaly detection. AnomalyEventTypeEnums
| ||||||||||||||||||
customEvents | Custom-defined events that trigger the email digest. CustomEvent
|
CustomEvent
Details of custom-defined event considered for an email digest.
Property Name | Type | Description | ||||||
---|---|---|---|---|---|---|---|---|
eventName* | string | |||||||
PropertyMatchCriteria | string default: | Enums
| ||||||
keyValuePairArray | KeyValuePair
|
HealthRuleEvent
Events associated with health rules considered for an email digest.
Property Name | Type | Description | ||||||
---|---|---|---|---|---|---|---|---|
healthRuleEventTypes* | string minItems: 1 | HealthRuleEventTypeEnums
| ||||||
healthRuleScope* | string | Events associated with specific health rules or all health rules that trigger the email digest. healthRuleScopeType
|
HealthRuleScope
Events associated with specific health rules or all health rules considered for an email digest.
Property Name | Type | Description |
---|---|---|
healthRuleScopeType * | string | Enums
|
AllHealthRules
Events associated with all health rules within an application considered for an email digest.
Property Name | Type | Description |
---|---|---|
healthRuleScopeType * | string | Enum
|
SpecificHealthRules
Events associated with specific health rules within an application considered for an email digest.
Property Name | Type | Description |
---|---|---|
healthRuleScopeType* | string | Enum
|
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 considered for an email digest.
Property Name | Type | Description |
---|---|---|
anomalyEvents | string minItems: 1 | AnomalyEventTypeEnums
|
Action
A list of actions that are taken in response to an event.
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 | SpecifiedEntityActionScopeEnum
|
value * | integer |
ActionOnAbsoluteEntities
The scope of entities on which the action is performed is set to absolute
.
Property Name | Type | Description |
---|---|---|
specifiedEntityActionScope | string | SpecifiedEntityActionScopeEnum
|
value * | integer |
ActionOnSpecificNodes
A list of nodes on which the action is performed.
Property Name | Type | Description |
---|---|---|
specifiedEntityActionScope | string | SpecifiedEntityActionScopeEnum
|
nodes* | string minItems: 1 |
EmailDigestSummaryArray
Property Name | Type |
---|---|
id* | integer |
name* | string minLength: 1 |
enabled* | boolean |
KeyValuePair
Property Name | Type |
---|---|
key* | string |
value* | string |
EmailDigestSummary
Property Name | Type |
---|---|
id* | integer |
name* | string minLength: 1 |
enabled* | boolean |
EmailDigestConfiguration
Property Name | Type |
---|---|
enabled* | boolean |
EmailDigestName | string |
frequency | integer minimum: 1 maximum: 168 |
EntityMatchingPattern
Entities that match the specified pattern.
Property Name | Type | Description |
---|---|---|
matchTo* | string | Enums
ENDS_WITH CONTAINS EQUALS MATCH_REG_EX |
matchValue* | string minLength: 1 | |
shouldNot | boolean default: |
Enums
PropertyMatchCriteria
Property Name | Type | Description |
---|---|---|
propertyMatchCriteria | string default: ANY | Enums
|
EntityMatchingPatternEnum
Property Name | Type | Description |
---|---|---|
EntityMatchingPatternEnum | string | Enums
|
PageScopeEnum
Property Name | Type | Description |
---|---|---|
| string | Enums
|
VirtualPageScopeEnum
Property Name | Type | Description |
---|---|---|
| string | Enums
|
AjaxRequestScopeEnum
Property Name | Type | Description |
---|---|---|
| string | Enums
|
AjaxRequestScopeEnum
Property Name | Type | Description |
---|---|---|
| string | Enums
|
SyntheticJobScopeEnum
Property Name | Type | Description |
---|---|---|
| string | Enums
|
IFrameScopeEnum
Property Name | Type | Description |
---|---|---|
| string | Enums
|
BusinessTransactionScopeEnum
Property Name | Type | Description |
---|---|---|
businessTransactionScope | string | Enums
|
MobileAppsScopeEnum
Property Name | Type | Description |
---|---|---|
| string | Enums
|
MobileNetworkRequestsScopeEnum
Property Name | Type | Description |
---|---|---|
MobileAppsScopeEnum | 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 |
|
ServersScopeEnum
Property Name | Type | Description |
---|---|---|
ServersScopeEnum | string |
|
SpecifiedEntityActionScopeEnum
Property Name | Type | Description |
---|---|---|
SpecifiedEntityActionScopeEnum | string |
|
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 |
|
ErrorResponse
Property Name | Type |
---|---|
statusCode | integer |
message | string |
*This property is required.
Download Examples
Download Appdynamics Email Digest Examples.zip to get a set of examples that help you configure an email digest,
Download SWAGGER YAML file
Download the Swagger email_digests_openapi.yml file.