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.

Warning: 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

Request

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

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

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

Request
{
"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
}
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
}

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>

Note: 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

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

Note: 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

name*

string

minLength: 1maxLength: 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.
Note: 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 NameTypeDescription
scheduleFrequency*string

The frequency of invoking action suppression.

DAILY

WEEKLY

MONTHLY_SPECIFIC_DATE

MONTHLY_SPECIFIC_DAY

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

DATABASES

SERVERS_IN_SERVERS_APP

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

Action Suppression Schedule Type

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

Property NameTypeDescription
ActionSuppressionScheduleType string
Enums

ONE_TIME

RECURRING

Example for one-time 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.

Property NameTypeDescription
scheduleFrequency * string

Describes how often action suppression is invoked.

Enums

DAILY

WEEKLY

MONTHLY_SPECIFIC_DATE

MONTHLY_SPECIFIC_DAY

Example for recurring action suppression 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
}

Daily Schedule - Configuration Details

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

Property NameTypeDescription
scheduleFrequency * string

Action suppression is invoked daily.

Enum

DAILY

startTime*

Time string

pattern: ^([01]\d|2[0-3]):([0-5]\d)$

The time at which the action suppression is initiated.

The time in 24 hour format.

endTime*

Time string

pattern: ^([01]\d|2[0-3]):([0-5]\d)$

The time at which the ongoing action suppression ends.

The time in 24 hour format.

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

Property NameTypeDescription
scheduleFrequency * string

Action suppression is invoked on a specific day of the week.

Enum

WEEKLY

days *

string

minItems: 1maxItems: 7

The day(s) of the week to suppress actions.

Property NameTypeDescription
DayOfWeekstring Enums

SUNDAY

MONDAY

TUESDAY

WEDNESDAY

THURSDAY

FRIDAY

SATURDAY

startTime*

Time string

pattern: ^([01]\d|2[0-3]):([0-5]\d)$

The time at which the action suppression is initiated.

The time in 24 hour format.

endTime*

Time string

pattern: ^([01]\d|2[0-3]):([0-5]\d)$

The time at which the ongoing action suppression ends.

The time in 24 hour format.

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

Property NameTypeDescription
scheduleFrequency * string

Action suppression is invoked on a specific date every month.

Enum

MONTHLY_SPECIFIC_DATE

startDate*

string

pattern: ^(0[1-9]|[12][0-9]|3[01])$|^Last Day$

The start date of the month to suppress actions.

startTime*

Time string

pattern: ^([01]\d|2[0-3]):([0-5]\d)$

The time at which action suppression is initiated.

The time in 24 hour format.

endDate *

string

pattern: ^(0[1-9]|[12][0-9]|3[01])$|^Last Day$

The end date of the month to suppress actions.
endTime*

Time string

pattern: ^([01]\d|2[0-3]):([0-5]\d)$

The time at which the ongoing action suppression ends.

The time in 24 hour format.

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

Property NameTypeDescription
scheduleFrequency * string

Action suppression is invoked on a specific day of the month.

Enum

MONTHLY_SPECIFIC_DAY

startTime*

Time string

pattern: ^([01]\d|2[0-3]):([0-5]\d)$

The time at which action suppression is initiated.

The time in 24 hour format.

endTime*

Time string

pattern: ^([01]\d|2[0-3]):([0-5]\d)$

The time at which the ongoing action suppression ends.

The time in 24 hour format.

days *

string

The day of the month to suppress actions.

Property NameTypeDescription
DayOfWeekstringEnums

SUNDAY

MONDAY

TUESDAY

WEDNESDAY

THURSDAY

FRIDAY

SATURDAY

occurrence *string Enums

FIRST

SECOND

THIRD

FOURTH

LAST

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

Property NameTypeDescription
scheduleFrequency * string
Enums

DAILY

WEEKLY

MONTHLY_SPECIFIC_DATE

MONTHLY_SPECIFIC_DAY

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

Property NameTypeDescription
occurrence string Enums

FIRST

SECOND

THIRD

FOURTH

LAST

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

Property NameTypeDescription
DayOfWeek string Enums

SUNDAY

MONDAY

TUESDAY

WEDNESDAY

THURSDAY

FRIDAY

SATURDAY

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

Property NameTypeDescription
Time

string

pattern: ^([01]\d|2[0-3]):([0-5]\d)$

The time in 24 hour format.

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

Timezone

Property NameTypeDescription
Timezone

string

Timezone Id. The default time zone is the controller timezone.

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

Property Name Type Description and Valid Values

affectedInfoType

string

 Enums

APPLICATION

BUSINESS_TRANSACTIONS

TIERS_NODES

SERVERS

DATABASES

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
string
The pattern match value.
Select this to reverse the pattern match condition.
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.

Propert 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 within an Application

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

Property Name Type Description

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 property 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"]
}
}

Servers in the Server Application

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

Property NameTypeDescription and Valid Values
affectedInfoType* string Enum

SERVERS_IN_SERVERS_APP

serversAffectedEntities*

ServersAffectedEntities

Property NameTypeDescription
selectServersBy* string

Enum

AFFECTED_SERVER_SUBGROUPS

AFFECTED_SERVERS

Scope of Affected Servers

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

Property NameTypeDescription and Valid Values
selectServersBy* string Enum

AFFECTED_SERVERS

affectedServers*

ServerSelectionCriteria

Property NameTypeDescription and Valid Values
severSelectionScope* string

Enums

ALL_SERVERS_IN_ACCOUNT

SERVERS_WITHIN_SUBGROUP

SPECIFIC_SERVERS

SERVERS_MATCHING_PATTERN

Scope of Affected Servers- All Servers in Account

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

Property NameTypeDescription and Valid Values
severSelectionScope* string Enum

ALL_SERVERS_IN_ACCOUNT

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

Property NameTypeDescription and Valid Values
severSelectionScope* string Enum

SERVERS_WITHIN_SUBGROUP

subGroups*

array of strings

minItems: 1

The identities (IDs) of the selected entity.
Example 
{
"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.

Property NameTypeDescription and Valid Values
severSelectionScope* string Enum

SPECIFIC_SERVERS

servers*

array of strings

minItems: 1

IDs of the selected entity.

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

Property NameTypeDescription and Valid Values
severSelectionScope* string Enum

SERVERS_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: ifalse

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

Property NameTypeDescription and Valid Values
selectServersBy* string Enum

AFFECTED_SERVER_SUBGROUPS

subGroups*

AffectedSubGroups

Property NameTypeDescription and Valid Values
subGroupScope* string

Enums

ALL_SUBGROUPS

SPECIFIC_SERVER_SUB_GROUPS

Scope of Affected Servers within Subgroups- All Subgroups

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

Property Name Type Description and Valid Values

subGroupScope

string

 Enum

ALL_SUBGROUPS

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

Property NameTypeDescription and Valid Values
subGroupScope* string Enum

SPECIFIC_SERVER_SUB_GROUP

subGroupNames*

array of strings

minItems: 1

IDs of the selected entity.

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

Property Name Type Description and Valid Values

affectedInfoType

string

 Enum

DATABASES

affectedDatabases* AffectedDatabases
Property NameTypeDescription
databaseScope*string
Property NameTypeDescription
AffectedDatabaseTypestring Enums

ALL_DATABASES

SPECIFIC_DATABASES

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

Property NameTypeDescription
databaseScope* string
Property NameTypeDescription
AffectedDatabaseType string Enums

ALL_DATABASES

SPECIFIC_DATABASES

Scope of Affected Databases—All Databases

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

Property NameTypeDescription
databaseScope* string
Property NameTypeDescription
AffectedDatabaseType string Enums

ALL_DATABASES

Scope of Affected Databases—Specific Databases

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

Property NameTypeDescription
databaseScope* string
Property NameTypeDescription
AffectedDatabaseType string Enums

SPECIFIC_DATABASES

databases *

array of strings

minItems: 1

 DbServer
Property NameType

serverName*

string

minLength: 1

collectorConfigName*

string

minLength: 1

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

Property Name Type

serverName

string

minLength: 1

collectorConfigName *

string

minLength: 1

Affected Database Types

Use this property to define the scope of affected databases.

Property NameTypeDescription
AffectedDatabaseType string Enums

ALL_DATABASES

SPECIFIC_DATABASES

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
statusCode integer

message

string

* This property is required.