Action Suppression API

This page describes the Action Suppression API methods you can use to temporarily suspend the automatic trigger of actions and alerts by a policy in response to an event. This API is useful when performing maintenance activities or troubleshooting a component.

Note

Syntax validation of the JSON payload is done when creating action suppression.

Create a New Action Suppression

Creates a new action suppression with the specified JSON payload. See Property Details.

Resource URL

POST <controller_url>/controller/alerting/rest/v1/applications/<application_id>/action-suppressions

Request/Response Format

JSON

Example 

{
  "id": 9,
  "name": "TestAS",
  "disableAgentReporting": false,
  "suppressionScheduleType": "ONE_TIME",
  "timezone": "Asia/Kolkata",
  "startTime": "2020-08-19T11:43:00",
  "endTime": "2020-08-19T12:43:00",
  "recurringSchedule": null,
  "affects": {
    "affectedInfoType": "APPLICATION"
  },
  "healthRuleScope": null
}

{
  "id": 9,
  "name": "TestAS",
  "disableAgentReporting": false,
  "suppressionScheduleType": "ONE_TIME",
  "timezone": "Asia/Kolkata",
  "startTime": "2020-08-19T11:43:00",
  "endTime": "2020-08-19T12:43:00",
  "recurringSchedule": null,
  "affects": {
    "affectedInfoType": "APPLICATION"
  },
  "healthRuleScope": null
}

Retrieve a List of Action Suppressions Configured for a Given Application

Returns all the action suppressions that are configured for a given application. The required fields are action suppression IDs and names. Details such as timezone, startTime, endTime and recurringSchedule of configured action suppressions are returned. See Property Details.

Resource URL

GET <controller_url>/controller/alerting/rest/v1/applications/<application_id>/action-suppressions

Response Format

JSON

Example Response

[
 {
	"id": 11, 
	"name": "TestAS1", 
	"timezone": "Asia/Kolkata", 
	"startTime": "2020-08-19T12:06:00",
	"endTime": "2020-08-19T13:06:00"
 }
 {
	"id": 12, 
	"name": "TestAS2", 
	"timezone": "Asia/Kolkata", 
	"startTime": "2020-08-19T12:27:00",
	"endTime": "2020-08-19T13:27:00"
 }
 {
	"id": 13, 
	"name": "TestAS3", 
	"timezone": "Asia/Kolkata", 
	"startTime": "2020-08-19T12:08:00",
	"endTime": "2020-08-19T13:08:00"
 }
]

Retrieve the Details of an Action Suppression

Returns JSON representation of action suppression for the given action suppression ID. See Property Details.

Resource URL

GET <controller_url>/controller/alerting/rest/v1/applications/<application_id>/action-suppressions/{action-suppression-id}

Response Format

JSON

Example Response

{
  "id": 9,
  "name": "TestAS",
  "disableAgentReporting": false,
  "suppressionScheduleType": "ONE_TIME",
  "timezone": "Asia/Kolkata",
  "startTime": "2020-08-19T11:43:00",
  "endTime": "2020-08-19T12:43:00",
  "recurringSchedule": null,
  "affects": {
    "affectedInfoType": "APPLICATION"
  },
  "healthRuleScope": null
}

Update an Action Suppression

Updates an existing action suppression with a specified JSON payload. See Property Details.

Resource URL

PUT <controller_url>/controller/alerting/rest/v1/applications/<application_id>/action-suppressions/{action-suppression-id}

Request/Response Format

JSON

Example

{
  "id": 9,
  "name": "TestAS1",
  "disableAgentReporting": false,
  "suppressionScheduleType": "ONE_TIME",
  "timezone": "Asia/Kolkata",
  "startTime": "2020-08-19T12:05:00",
  "endTime": "2020-08-19T13:05:00",
  "recurringSchedule": null,
  "affects": {
    "affectedInfoType": "APPLICATION"
  },
  "healthRuleScope": null
}

{
  "id": 9,
  "name": "TestAS",
  "disableAgentReporting": false,
  "suppressionScheduleType": "ONE_TIME",
  "timezone": "Asia/Kolkata",
  "startTime": "2020-08-19T11:43:00",
  "endTime": "2020-08-19T12:43:00",
  "recurringSchedule": null,
  "affects": {
    "affectedInfoType": "APPLICATION"
  },
  "healthRuleScope": null
}

Delete an Action Suppression

Deletes an action suppression with the specified ID. See Property Details.

Resource URL

DELETE <controller_url>/controller/alerting/rest/v1/applications/<application_id>/action-suppressions/{action-suppression-id}

Retrieve the Details of an Action Suppression by Name

Returns JSON representation of action suppression for the given action suppression name. See Property Details.

Resource URL

GET <controller_url>/controller/alerting/rest/v1/applications/<application_id>/action-suppressions/action-suppression-by-name/?name=<ActionSuppressionName>


Replace <ActionSuppressionName> with a name you specified for the action suppression. For example, ACTION_SUP_15.

Response Format

JSON

Example Response

{
    "id": 9,
    "name": "TestAS1",
    "timezone": "Asia/Kolkata",
    "startTime": "2020-08-19T12:05:00",
    "endTime": "2020-08-19T13:05:00",
    "recurringSchedule": null
  }

Response Codes

Property Details

The property names with asterisk are the required (mandatory) fields in a payload.

Action Suppression

Payload details for action suppression.

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 minLength: 1 maxLength: 100	The name of action suppression.
disableAgentReporting	boolean default: false	If enabled, the agents defined in the scope do not report any metric data during the specified time frame.
You cannot define a recurring action suppression if you set disableAgentReporting to true.
suppressionScheduleType	string default: ONE_TIME	The available scheduling options for action suppression. Enums ONE_TIME RECURRING
timezone	string	The timezone ID. The default time zone is the controller timezone.
startTime	string format: yyyy-MM-ddTHH:mm:ss	The time at which the action suppression is initiated. Specify startTime only if suppressionScheduleType is set to ONE_TIME. If you do not specify the startTime, action suppression starts from the current time. The expected format is yyyy-MM-ddTHH:mm:ss conforming to rfc3339.
endTime	string format: yyyy-MM-ddTHH:mm:ss	The time at which the ongoing action suppression ends. Specify startTime only if suppressionScheduleType is set to ONE_TIME. If not specified, action suppression ends at 60 minutes from the current time. The expected format is yyyy-MM-ddTHH:mm:ss conforming to rfc3339.
recurringSchedule	string	The recurring schedule details to initiate an action suppression. Property Name Type Description scheduleFrequency* string The frequency of invoking action suppression. Enums DAILY WEEKLY MONTHLY_SPECIFIC_DATE MONTHLY_SPECIFIC_DAY
affects*		Describes entities affected by action suppression. For example, applications, business transactions, servers, or databases. Property Name Type Description affectedInfoType* string The affected entity type. Enums APPLICATION BUSINESS_TRANSACTIONS TIERS_NODES SERVERS DATABASES SERVERS_IN_SERVERS_APP
healthRuleScope*		The scope of the health rules applicable to action suppression. Property Name Type Description healthRuleScopeType* string The health rule types affected by action suppression. Enums SPECIFIC_HEALTH_RULES

Action Suppression Schedule Type

Use this property to schedule a one-time or recurring action suppression.

{
    "name": "Action Suppression With One Time Schedule",
    "disableAgentReporting": false,
    "suppressionScheduleType": "ONE_TIME",
    "timezone": "Asia/Kolkata",
    "startTime": "2020-06-18T13:33:37",
    "endTime": "2021-06-30T16:48:37",
    "recurringSchedule": null,
    "affects": {
        "affectedInfoType": "APPLICATION"
    },
    "healthRuleScope": null
}

Recurring Schedule Frequency Details

Use this property to define the frequency of invoking action suppression on a recurring basis.

{
    "name": "Action Suppression With Daily Schedule",
    "disableAgentReporting": false,
    "suppressionScheduleType": "RECURRING",
    "timezone": "Asia/Kolkata",
    "startTime": null,
    "endTime": null,
    "recurringSchedule": {
        "scheduleFrequency": "DAILY",
        "startTime": "01:00",
        "endTime": "01:22"
    },
    "affects": {
        "affectedInfoType": "APPLICATION"
    },
    "healthRuleScope": null
}

Daily Schedule - Configuration Details

Use the following properties to configure the details of an action suppression that is scheduled on a daily basis.

{
    "name": "Action Suppression With Daily Schedule",
    "disableAgentReporting": false,
    "suppressionScheduleType": "RECURRING",
    "timezone": "Asia/Kolkata",
    "startTime": null,
    "endTime": null,
    "recurringSchedule": {
        "scheduleFrequency": "DAILY",
        "startTime": "01:00",
        "endTime": "01:22"
    },
    "affects": {
        "affectedInfoType": "APPLICATION"
    },
    "healthRuleScope": null
}

Weekly Schedule - Configuration Details

Use the following properties to configure the details of an action suppression that is scheduled on a weekly basis.

{ "name": "Action Suppression With Weekly Schedule", "disableAgentReporting": false,
    "suppressionScheduleType": "RECURRING",
    "timezone": "Asia/Kolkata",
    "startTime": null,
    "endTime": null,
    "recurringSchedule": {
        "scheduleFrequency": "WEEKLY",
        "startTime": "06:00",
        "endTime": "18:00",
        "days": [
            "SUNDAY",
            "MONDAY"
        ]
    },
    "affects": {
        "affectedInfoType": "APPLICATION"
    },
    "healthRuleScope": null
}

Monthly Schedule, Specific Date - Configuration Details

Use the following properties to configure the details of an action suppression that is scheduled on a monthly basis, on a specific date.

{
    "name": "Action Suppression With Monthly Specific Date Schedule",
    "disableAgentReporting": false,
    "suppressionScheduleType": "RECURRING",
    "timezone": "Asia/Kolkata",
    "startTime": null,
    "endTime": null,
    "recurringSchedule": {
        "scheduleFrequency": "MONTHLY_SPECIFIC_DATE",
        "startDate": "01",
        "startTime": "06:00",
        "endDate": "Last Day",
        "endTime": "18:00"
    },
    "affects": {
        "affectedInfoType": "APPLICATION"
    },
    "healthRuleScope": null
}

Monthly Schedule, Specific Day - Configuration Details

Use the following properties to configure the details of an action suppression that is scheduled on a monthly basis, on a specific date.

{
    "name": "Action Suppression With Monthly Specific Day Schedule",
    "disableAgentReporting": false,
    "suppressionScheduleType": "RECURRING",
    "timezone": "Asia/Kolkata",
    "startTime": null,
    "endTime": null,
    "recurringSchedule": {
        "scheduleFrequency": "MONTHLY_SPECIFIC_DAY",
        "startTime": "06:00",
        "endTime": "18:00",
        "day": "SUNDAY",
        "occurrence": "FIRST"
    },
    "affects": {
        "affectedInfoType": "APPLICATION"
    },
    "healthRuleScope": null
}

Schedule Frequency Details

Use this property to define the frequency of invoking an action suppression.

{
   "recurringSchedule":{
      "scheduleFrequency":"WEEKLY",
      "startTime":"06:00",
      "endTime":"18:00",
      "days":[
         "SUNDAY",
         "MONDAY"
      ]
   }

Occurrence Details

The occurrence of the day of the month to suppress actions.

{
   "recurringSchedule":{
      "scheduleFrequency":"MONTHLY_SPECIFIC_DAY",
      "startTime":"06:00",
      "endTime":"18:00",
      "day":"SUNDAY",
      "occurrence":"FIRST"
   }
}

Monthly Action Suppression - Day

The day of the month to suppress actions.

{
   "recurringSchedule":{
      "scheduleFrequency":"MONTHLY_SPECIFIC_DAY",
      "startTime":"06:00",
      "endTime":"18:00",
      "day":"SUNDAY",
      "occurrence":"FIRST"
   }
}

Action Suppression Time Details

Use this property to define the time details to suppress an action.

{
        "recurringSchedule": {
        "scheduleFrequency": "MONTHLY_SPECIFIC_DATE",
        "startDate": "01",
        "startTime": "06:00",
        "endDate": "Last Day",
        "endTime": "18:00"
    }
}

Timezone

{
    "name": "Action Suppression With One Time Schedule",
    "disableAgentReporting": false,
    "suppressionScheduleType": "ONE_TIME",
    "timezone": "Asia/Kolkata",
    "startTime": "2020-06-18T13:33:37",
    "endTime": "2021-06-30T16:48:37",
    "recurringSchedule": null,
    "affects": {
        "affectedInfoType": "APPLICATION"
    },
    "healthRuleScope": null
}

Entities Affected by Action Suppression

Information pertaining to entities affected by action suppression.

{
            "affectedInfoType": "TIERS_NODES",
            "affectedEntities": {
                "tierNodeType": "NODE",
                "nodeType": "ALL_NODES",
                "affectedNodes": {
                    "affectedNodeScope": "NODES_OF_SPECIFIC_TIERS",
                    "specificTiers": ["Tier1"]
                }
            }
  }

Application-level Entities Affected by Action Suppression

Use to suppress actions for entities at the application-level.

{
    "affectedInfoType": "APPLICATION"
}

Business Transactions Affected by Action Suppression

Use this to suppress actions for entities at the business transaction (BT) level.

{
   "affectedInfoType":"BUSINESS_TRANSACTIONS",
   "affectedBusinessTransactions":{
         "businessTransactionScope":"BUSINESS_TRANSACTIONS_IN_SPECIFIC_TIERS",
         "specificTiers":["DefaultTier1"]
      }
}

Scope of Business Transactions Affected

Use this to suppress actions for entities at the BT level for the selected BT types.

All Types of Business Transactions

Use this to suppress actions for entities at the BT level for all BTs.

{
		"affectedInfoType": "BUSINESS_TRANSACTIONS",
		"affectedBusinessTransactions": {
			"businessTransactionScope": "ALL_BUSINESS_TRANSACTIONS"
		}
}

Specific Business Transactions

Use this to suppress actions for entities at the BT level for the specific BTs only.

{
		"affectedInfoType": "BUSINESS_TRANSACTIONS",
		"affectedBusinessTransactions": {
			"businessTransactionScope": "SPECIFIC_BUSINESS_TRANSACTIONS",
			"businessTransactions": ["/BT/", "/BT/rest"]
}

Business Transactions Associated with Specific Tiers

Use this to suppress actions for entities at the BT level for BTs within specific tiers only.

{
   "affectedInfoType":"BUSINESS_TRANSACTIONS",
   "affectedBusinessTransactions":{
         "businessTransactionScope":"BUSINESS_TRANSACTIONS_IN_SPECIFIC_TIERS",
         "specificTiers":["DefaultTier1"]
      }
}

Business Transactions Matching a Pattern

Use this to suppress actions for entities at the BT level for BTs with properties that match a given pattern.

{
		"affectedInfoType": "BUSINESS_TRANSACTIONS",
		"affectedBusinessTransactions": {
			"businessTransactionScope": "BUSINESS_TRANSACTIONS_MATCHING_PATTERN",
			"patternMatcher": {
				"matchTo": "STARTS_WITH",
				"matchValue": "E",
				"shouldNot": false
			}
		}
	}

Tiers/Nodes Entities Affected

Use this to suppress actions for entities at the Tier/Node level.

{
            "affectedInfoType": "TIERS_NODES",
            "affectedEntities": {
                "tierNodeType": "NODE",
                "nodeType": "ALL_NODES",
                "affectedNodes": {
                    "affectedNodeScope": "NODES_OF_SPECIFIC_TIERS",
                    "specificTiers": ["Tier1"]
                }
            }
  }

Tier or Node Entities Affected

Use this to suppress actions for entities at the tier level or node level.

Tier-level Entities Affected

{
		"affectedInfoType": "TIERS_NODES",
		"affectedEntities": {
			"tierNodeType": "TIER",
			"affectedTiers": {
				"affectedTierScope": "SPECIFIC_TIERS",
				"tiers": ["ECommerce-Services", "Inventory-Services"]
					}
				}
}

Node-level Entities Affected

{
            "affectedInfoType": "TIERS_NODES",
            "affectedEntities": {
                "tierNodeType": "NODE",
                "nodeType": "ALL_NODES",
                "affectedNodes": {
                    "affectedNodeScope": "NODES_OF_SPECIFIC_TIERS",
                    "specificTiers": ["Tier1"]
                }
            }
  }

Affected Tier Scope

All Tiers

Use this to suppress actions for entities at the tier level for all tiers.

{
		"affectedInfoType": "TIERS_NODES",
		"affectedEntities": {
			"tierNodeType": "TIER",
			"affectedTiers": {
				"affectedTierScope": "ALL_TIERS"
				}
			}
}

Specific Tiers

Use this to suppress actions for entities at the tier level for specific tiers only.

{
		"affectedInfoType": "TIERS_NODES",
		"affectedEntities": {
			"tierNodeType": "TIER",
			"affectedTiers": {
				"affectedTierScope": "SPECIFIC_TIERS",
				"tiers": ["ECommerce-Services", "Inventory-Services"]
					}
				}
}

Affected Nodes

{
   "affectedNodeScope": "NODES_OF_SPECIFIC_TIERS",
   "specificTiers": ["Tier1"]
 }

All Nodes

Use this to suppress actions for entities at the node level for all nodes.

{
		"affectedInfoType": "TIERS_NODES",
		"affectedEntities": {
			"tierNodeType": "NODE",
			"nodeType": "ALL_NODES",
			"affectedNodes": {
				"affectedNodeScope": "ALL_NODES"
			}
		}
	}

Specific Nodes

Use this to suppress actions for entities at the node level for specific nodes only.

{
		"affectedInfoType": "TIERS_NODES",
		"affectedEntities": {
			"tierNodeType": "NODE",
			"nodeType": "ALL_NODES",
			"affectedNodes": {
				"affectedNodeScope": "SPECIFIC_NODES",
				"nodes": ["Node1", "Node2"]
			}
		}
	}

Nodes within Specific Tiers

Use this to suppress actions for entities at the node level for nodes within specific tiers only.

{
		"affectedInfoType": "TIERS_NODES",
		"affectedEntities": {
			"tierNodeType": "NODE",
			"nodeType": "ALL_NODES",
			"affectedNodes": {
				"affectedNodeScope": "NODES_OF_SPECIFIC_TIERS",
				"specificTiers": ["ECommerce-Services", "Inventory-Services"]
			}
		}
	}

Nodes that Match a Pattern

Use this to suppress actions for entities at the node level for nodes with properties that match a pattern.

{
		"affectedInfoType": "TIERS_NODES",
		"affectedEntities": {
			"tierNodeType": "NODE",
			"nodeType": "ALL_NODES",
			"affectedNodes": {
				"affectedNodeScope": "NODES_MATCHING_PATTERN",
				"patternMatcher": {
					"matchTo": "STARTS_WITH",
					"matchValue": "A",
					"shouldNot": false
				}
			}
		}
}

Node Property Variable Matcher

Use this to suppress actions for entities at the node level for nodes that match specified environment variables.

{
	"affectedInfoType": "TIERS_NODES",
	"affectedEntities": {
		"tierNodeType": "NODE",
		"nodeType": "ALL_NODES",
		"affectedNodes": {
			"affectedNodeScope": "NODE_PROPERTY_VARIABLE_MATCHER",
			"propVarPairs": [{
				"propertyType": "ENV",
				"name": "CLASSPATH",
				"value": "C:\\Users\\Java\\Classes"
			}]
		}
	}
}

Servers Affected within an Application

Use this to suppress actions for entities at the server level.

{
   "affectedInfoType":"SERVERS",
    "affectedServers":{
       "serversScope":"SPECIFIC_SERVERS_IN_APPLICATION",
       "specificServers":["DropWizardTestApplicationDropWizardDefaultNode1"]
     }
}

Specific Servers within an Application

Use this property to suppress actions for entities at the server level for specific servers within an application.

{
   "affectedInfoType":"SERVERS",
    "affectedServers":{
       "serversScope":"SPECIFIC_SERVERS_IN_APPLICATION",
       "specificServers":["DropWizardTestApplicationDropWizardDefaultNode1"]
     }
}

Servers in the Server Application

Use this to suppress actions for entities at the servers in the server level.

Scope of Affected Servers

Use this to suppress actions for entities for the servers in an account or a subgroup level.

Scope of Affected Servers- All Servers in Account

Use this to suppress actions for entities for all servers in the account.

{
	"affectedInfoType":"SERVERS_IN_SERVERS_APP",
	"serversAffectedEntities":{
		"selectServersBy":"AFFECTED_SERVERS",
		"affectedServers":{
			"severSelectionScope":"ALL_SERVERS_IN_ACCOUNT"
		}
	}
}

Scope of Affected Servers- Servers within SubGroup

Use this to suppress actions for entities for all servers within the specified subgroups.

{
	"affectedInfoType":"SERVERS_IN_SERVERS_APP",
	"serversAffectedEntities":{
		"selectServersBy":"AFFECTED_SERVERS",
		"affectedServers":{
			"severSelectionScope":"SERVERS_WITHIN_SUBGROUP",
			"subGroups":[24, 34]
			}
	}
}

Scope of Affected Servers- Specific Servers

Use this to suppress actions for entities for the specified servers.

{
	"affectedInfoType":"SERVERS_IN_SERVERS_APP",
	"serversAffectedEntities":{
		"selectServersBy":"AFFECTED_SERVERS",
		"affectedServers":{
			"severSelectionScope":"SPECIFIC_SERVERS",
			"servers":[404, 124]
			}
	}
}

Scope of Affected Server- Servers with Matching Pattern

Use this to suppress actions for entities for servers with properties that match a pattern.

{
	"affectedInfoType":"SERVERS_IN_SERVERS_APP",
	"serversAffectedEntities":{
		"selectServersBy":"AFFECTED_SERVERS",
		"affectedServers":{
			"severSelectionScope":"SERVERS_MATCHING_PATTERN",
			"patternMatcher":{
				"matchValue":"ecommerce",
				"shouldNot":false,
				"matchTo":"STARTS_WITH"
			}
		}
	}
}

Scope of Affected Servers within Subgroups

Use this to suppress actions for entities for servers within subgroups.

Scope of Affected Servers within Subgroups- All Subgroups

Use this to suppress actions for entities at the servers in all subgroups level.

{
	"affectedInfoType":"SERVERS_IN_SERVERS_APP",
	"serversAffectedEntities":{
		"selectServersBy":"AFFECTED_SERVER_SUBGROUPS",
		"subGroups":{
			"subGroupScope":"ALL_SUBGROUPS",
					}
				}
}

Scope of Affected Servers within Subgroups- Servers within Specific Subgroups

Use this to suppress actions for entities at the servers within specific subgroups level.

{
	"affectedInfoType":"SERVERS_IN_SERVERS_APP",
	"serversAffectedEntities":{
		"selectServersBy":"AFFECTED_SERVER_SUBGROUPS",
		"subGroups":{
			"subGroupScope":"SPECIFIC_SERVER_SUB_GROUPS",
			"subGroupNames":[43, 45]
		}
	}
}

Databases Affected

Use this property to suppress actions for entities at the database level.

{
   "affects":{
      "affectedInfoType":"DATABASES",
      "affectedDatabases":{
         "databaseScope":"ALL_DATABASES"
}   

Scope of Affected Databases

Use this property to define the scope of action suppression at the database level.

Scope of Affected Databases—All Databases

Use this property to suppress actions for entities of all the databases.

Scope of Affected Databases—Specific Databases

Use this property to suppress actions for entities of specific databases.

{
"affects":{
      "affectedInfoType":"DATABASES",
      "affectedDatabases":{
         "databaseScope":"SPECIFIC_DATABASES",
         "databases":[
            {
               "serverName":"MongoNewKC",
               "collectorConfigName":"MongoNewKC"
            },
            {
               "serverName":"Collector41",
               "collectorConfigName":"Collector41"
            }
         ]
      }
   }
}   

Database Server Details

Use this property to define database server details.

Affected Database Types

Use this property to define the scope of affected databases.

Health Rule Scope

Use this to suppress actions triggered as a response to health rule violation events.

{
   "healthRuleScopeType": "SPECIFIC_HEALTH_RULES",
   "healthRules": ["CPU utilization is too high", "JVM Garbage Collection Time is too high"]
}

Health Rule Scope Type

Specific Health Rules

{
   "healthRuleScopeType": "SPECIFIC_HEALTH_RULES",
   "healthRules": ["CPU utilization is too high", "JVM Garbage Collection Time is too high"]
}

Action Suppression Summary

Error Response

^*This property is required.

Download Examples

Download Appdynamics Action Suppression examples.zip to get a set of examples that help you configure a schedule. 

Download SWAGGER YAML file

Download the Swagger YAML spec action_suppression_openapi.yml.