AppDynamics switched from Semantic Versioning to Calendar Versioning starting in February 2020 for some agents and March 2020 for the entire product suite.


    Skip to end of metadata
    Go to start of metadata

    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

    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 

    This example creates an action suppression that affects specific health rules within an application. See Download Examples

    {
      "name":"ACTION_SUP_1586414418752",
      "disableAgentReporting":true,
      "startTime":"2018-04-09T12:10:18",
      "endTime":"2019-04-09T12:10:18",
      "affects":{
           "affectedInfoType":"APPLICATION"
       }
    }
    {
            "id": 1,
            "name": "ACTION_SUP_1586414418752",
            "disableAgentReporting": true,
            "startTime": "2018-04-09T12:10:18",
            "endTime": "2019-04-09T12:10:18",
            "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. Only action suppression IDs and names 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": 3,
                "name": "ACTION_SUP_Updated_Name"
            },
            {
                "id": 2,
                "name": "ACTION_SUP_14"
            },
            {
                "id": 1,
                "name": "ACTION_SUP_15"
            }
        ]


    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": 3,
            "name": "ACTION_SUP_Updated_Name",
            "disableAgentReporting": true,
            "startTime": "2020-04-09T12:10:18",
            "endTime": "2020-04-09T17:10:18",
            "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

    {
      "name":"ACTION_SUP_14",
      "disableAgentReporting":true,
      "startTime":"2020-04-09T12:10:18",
      "endTime":"2020-04-09T17:10:18",
      "affects":{
          "affectedInfoType":"APPLICATION"
       }
    }
    {
            "id": 1,
            "name": "ACTION_SUP_14",
            "disableAgentReporting": true,
            "startTime": "2020-04-09T12:10:18",
            "endTime": "2020-04-09T17:10:18",
            "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/?name=<ActionSuppressionName>

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

    Response Format

    JSON

    Example Response

    {
            "id": 1,
            "name": "ACTION_SUP_15",
            "disableAgentReporting": true,
            "startTime": "2018-04-09T12:10:18",
            "endTime": "2019-04-09T12:10:18",
            "affects": {
                "affectedInfoType": "APPLICATION"
            },
            "healthRuleScope": null
    }


    Response Codes

    Code

    Description

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

    Property Details

    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.
    startTime

    string

    format: yyyy-MM-ddTHH:mm:ss

    The time at which the action suppression is initiated. If you do not specify the startTime, action suppression starts from the current time.
    endTime

    string

    format: yyyy-MM-ddTHH:mm:ss

    The time at which ongoing action suppression should end. If not specified, action suppression ends at 60 minutes from the current time.

    affects*


    Describes entities affected by action suppression. For example, applications, business transactions, servers, or databases.

    Property NameTypeDescription
    affectedInfoType*string

    The affected entity type.

    Enums

    APPLICATION

    BUSINESS_TRANSACTIONS

    TIERS_NODES

    SERVERS

    healthRuleScope*

    The scope of the health rules applicable to action suppression.

    Property NameTypeDescription
    healthRuleScopeType*string

    The health rule types affected by action suppression.

    Enums

    SPECIFIC_HEALTH_RULES

    Entities Affected by Action Suppression

    Information pertaining to entities affected by action suppression.

    Property Name

    Type

    Description and Valid Values

    affectedInfoType*

    string

    Enums

    APPLICATION

    BUSINESS_TRANSACTIONS

    TIERS_NODES

    SERVERS

    Example
    {
                "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.

    Property Name

    Type

    Description and Valid Values

    affectedInfoType*

    string

    Enum

    APPLICATION

    Example
    {
        "affectedInfoType": "APPLICATION"
    }

    Business Transactions Affected by Action Suppression

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

    Property Name

    Type

    Description and Valid Values

    affectedInfoType*

    string

    Enum

    BUSINESS_TRANSACTIONS

    affectedBusinessTransactions*

    The scope of the business transactions affected by action suppression.

    Property NameTypeDescription and Valid Values
    businessTransactionScope*string

    Enums

    ALL_BUSINESS_TRANSACTIONS

    SPECIFIC_BUSINESS_TRANSACTIONS

    BUSINESS_TRANSACTIONS_IN_SPECIFIC_TIERS

    BUSINESS_TRANSACTIONS_MATCHING_PATTERN

    Example
    {
       "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.

    Property NameTypeDescription and Valid Values
    businessTransactionScope*string

    Enums

    ALL_BUSINESS_TRANSACTIONS

    SPECIFIC_BUSINESS_TRANSACTIONS

    BUSINESS_TRANSACTIONS_IN_SPECIFIC_TIERS

    BUSINESS_TRANSACTIONS_MATCHING_PATTERN

    All Types of Business Transactions

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

    Property NameTypeDescription and Valid Values
    businessTransactionScope*string

    Enum

    ALL_BUSINESS_TRANSACTIONS

    Example
    {
    		"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.

    Property NameTypeDescription and Valid Values
    businessTransactionScope*string

    Enum

    SPECIFIC_BUSINESS_TRANSACTIONS

    businessTransactions*

    array of strings

    minItems: 1

    Specific business transactions affected by action suppression. For example:

    [CheckoutBt, LoginBt]

    Example
    {
    		"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.

    Property NameTypeDescription and Valid Values
    businessTransactionScope*string

    Enum

    BUSINESS_TRANSACTIONS_IN_SPECIFIC_TIERS

    specificTiers*

    array of strings

    minItems: 1

    Business transactions associated with specific tiers affected by action suppression. For example:

    [CheckoutTier, LoginTier]

    Example
    {
       "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.

    Property NameTypeDescription and Valid Values
    businessTransactionScope*string

    Enums

    BUSINESS_TRANSACTIONS_MATCHING_PATTERN

    patternMatcher*


    EntityMatchingPattern

    Property NameTypeDescription and Valid Values
    matchTo*string

    Enums

    STARTS_WITH

    ENDS_WITH

    CONTAINS

    EQUALS

    MATCH_REG_EX

    matchValue*

    string

    minLength: 1

    The pattern match value.
    shouldNot

    boolean

    default: false

    Select this to reverse the pattern match condition.


    Example
    {
    		"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.

    Property Name

    Type

    Description and Valid Values

    affectedInfoType*

    string

    Enum

    TIERS_NODES

    affectedEntities*

    TierNodeEntities

    Property NameTypeDescription and Valid Values
    tierNodeType*string

    Enums

    TIER

    NODE

    Example
    {
                "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.

    Property NameTypeDescription and Valid Values
    tierNodeType*string

    Enums

    TIER

    NODE

    Tier-level Entities Affected

    Property NameTypeDescription and Valid Values
    tierNodeType*string

    Enum

    TIER

    affectedTiers*

    AffectedTiers

    Property NameTypeDescription and Valid Values
    affectedTierScope*string

    Enums

    ALL_TIERs

    SPECIFIC_TIERS

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

    Node-level Entities Affected

    Property NameTypeDescription and Valid Values
    tierNodeType*string

    Enum

    NODE

    nodeType*string

    Enums

    ALL_NODES

    JAVA_NODES

    DOT_NET_NODES

    PHP_NODES

    affectedNodes*

    AffectedNodes

    Property NameTypeDescription and Valid Values
    affectedNodeScope*string

    Enums

    ALL_NODES

    SPECIFIC_NODES

    NODES_OF_SPECIFIC_TIERS

    NODES_MATCHING_PATTERN

    NODE_PROPERTY_VARIABLE_MATCHER


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

    Affected Tier Scope

    Property NameTypeDescription and Valid Values
    affectedTierScope*string

    Enums

    ALL_TIERs

    SPECIFIC_TIERS

    All Tiers

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

    Property NameTypeDescription and Valid Values
    affectedTierScope*string

    Enum

    ALL_TIERS

    Example
    {
    		"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.

    Property NameTypeDescription and Valid Values
    affectedTierScope*string

    Enum

    SPECIFIC_TIERS

    tiers*

    array of strings

    minItems: 1


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

    Affected Nodes

    Property NameTypeDescription and Valid Values
    affectedNodeScope*string

    Enums

    ALL_NODES

    SPECIFIC_NODES

    NODES_OF_SPECIFIC_TIERS

    NODES_MATCHING_PATTERN

    NODE_PROPERTY_VARIABLE_MATCHER

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

    All Nodes

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

    Property NameTypeDescription and Valid Values
    affectedNodeScope*string

    Enum

    ALL_NODES

    Example
    {
    		"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.

    Property NameTypeDescription and Valid Values
    affectedNodeScope*string

    Enum

    SPECIFIC_NODES

    nodes*

    array of strings

    minItems: 1

    A list of nodes considered as affected entities for action suppression. For example:

    [Node1, Node2]

    Example
    {
    		"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.

    Property NameTypeDescription and Valid Values
    affectedNodeScope*string

    Enum

    NODES_OF_SPECIFIC_TIERS

    specificTiers*

    array of strings

    minItems: 1


    Example
    {
    		"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.

    Property NameTypeDescription and Valid Values
    affectedNodeScope*string

    Enum

    NODES_MATCHING_PATTERN

    patternMatcher*


    EntityMatchingPattern

    Property NameTypeDescription
    matchTo*string

    Enums

    STARTS_WITH

    ENDS_WITH

    CONTAINS

    EQUALS

    MATCH_REG_EX

    matchValue*

    string

    minLength: 1

    The pattern match value.
    shouldNot

    boolean

    default: false

    Select this if you want to reverse the pattern match condition.
    Example
    {
    		"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.

    Property NameTypeDescription and Valid Values
    affectedNodeScope*string

    Enum

    NODE_PROPERTY_VARIABLE_MATCHER

    propVarPairs*


    Property NameTypeDescription
    propertyType*string

    Enums

    META

    ENV

    JVM

    name*

    string

    minLength: 1


    value*

    string

    minLength: 1


    Example
    {
    	"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

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

    Property Name

    Type

    Description and Valid Values

    affectedInfoType*

    string

    Enum

    SERVERS

    affectedServers*

    ApplicationAffectedServers

    Property NameTypeDescription
    serversScope*string

    Enum

    SPECIFIC_SERVERS_IN_APPLICATION



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

    Specific Servers within an Application

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

    Property NameTypeDescription
    serversScope*string

    Enum

    SPECIFIC_SERVERS_IN_APPLICATION


    specificServers*


    array of strings

    minItems: 1

    MinLength: 1

    A list of servers considered as affected entities for action suppression. For example: 

    [server1, server2]

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

    Health Rule Scope

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

    Property NameTypeDescription
    healthRuleScopeType*string

    HealthRuleScopeType

    Enum

    SPECIFIC_HEALTH_RULES

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

    Health Rule Scope Type

    Property NameTypeDescription
    healthRuleScope*string

    Enum

    SPECIFIC_HEALTH_RULES

    Specific Health Rules

    Property NameTypeDescription
    healthRuleScopeType*string

    HealthRuleScopeType

    Enum

    SPECIFIC_HEALTH_RULES

    healthRules*

    array of strings

    minItems: 1


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

    Action Suppression Summary

    Property Name

    Type

    id*integer

    name*

    string

    minLength: 1

    Error Response

    Property Name

    Type

    statusCodeinteger

    message

    string

    *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.

    • No labels