Health Rule API

Health Rules

This page describes the Health Rule API methods you can use to create, configure, update, and delete health rules for multiple applications simultaneously. This API allows you to programmatically update and maintain single or multiple health rules and migrate them across applications or Controllers.

Warning:

Minimal syntax validation of the JSON payload is done when creating the health rule.
Path validation for a specified metric is not done. Ensure that you provide valid paths for all the metrics you define.
If metrics are not resolved during the health rule evaluation, the health rule attains an unknown (?) state. Ensure that you provide valid metrics for all the affected entities you define.

Create a Health Rule

Creates a new health rule from the specified JSON payload. See Property Details.

Resource URL

POST <controller_url>/controller/alerting/rest/v1/applications/<application_id>/health-rules

Request/Response Format

JSON

Example

This example creates a health rule with an affected entity type business transaction performance and defines the evaluation criteria for the health rule. See Download Examples.

Request

{
  "name": "My new health rule",
  "enabled": true,
  "useDataFromLastNMinutes": 30,
  "waitTimeAfterViolation": 5,
  "affects": {
    "affectedEntityType": "BUSINESS_TRANSACTION_PERFORMANCE",
    "affectedBusinessTransactions": {
      "businessTransactionScope": "ALL_BUSINESS_TRANSACTIONS"
    }
  },
  "evalCriterias": {
    "criticalCriteria": {
      "conditionAggregationType": "ALL",
      "conditions": [
        {
          "name": "Condition 1",
          "shortName": "A",
          "evaluateToTrueOnNoData": false,
          "evalDetail": {
            "evalDetailType": "SINGLE_METRIC",
            "metricAggregateFunction": "VALUE",
            "metricPath": "Average CPU Used (ms)",
            "metricEvalDetail": {
              "metricEvalDetailType": "BASELINE_TYPE",
              "baselineCondition": "WITHIN_BASELINE",
              "baselineName": "All Data - Last 15 Days",
              "baselineUnit": "PERCENTAGE",
              "compareValue": 30.5
            }
          }
        }
      ]
    },
    "warningCriteria": {
      "conditionAggregationType": "ALL",
      "conditions": [
        {
          "name": "Condition 1",
          "shortName": "A",
          "evalDetail": {
            "evalDetailType": "METRIC_EXPRESSION",
            "metricExpression": "({metric1} + ({metric2} * 3))",
            "metricExpressionVariables": [
              {
                "variableName": "metric1",
                "metricAggregateFunction": "VALUE",
                "metricPath": "95th Percentile Response Time (ms)"
              },
              {
                "variableName": "metric2",
                "metricAggregateFunction": "MAXIMUM",
                "metricPath": "Average CPU Used (ms)"
              }
            ],
            "metricEvalDetail": {
              "metricEvalDetailType": "SPECIFIC_TYPE",
              "compareCondition": "GREATER_THAN_SPECIFIC_VALUE",
              "compareValue": 10
            }
          }
        }
      ]
    }
  }
}

Response

{
    "id": 26,
    "name": "My new health rule",
    "enabled": false,
    "useDataFromLastNMinutes": 30,
    "waitTimeAfterViolation": 5,
    "scheduleName": "Weeknights: 11pm-6am, Mon-Fri",
    "affects": {
        "affectedEntityType": "BUSINESS_TRANSACTION_PERFORMANCE",
        "affectedBusinessTransactions": {
            "businessTransactionScope": "ALL_BUSINESS_TRANSACTIONS"
        }
    },
    "evalCriterias": {
        "criticalCriteria": {
            "conditionAggregationType": "ALL",
            "conditionExpression": null,
            "conditions": [
                {
                    "name": "Condition 1",
                    "shortName": "A",
                    "evaluateToTrueOnNoData": false,
                    "evalDetail": {
                        "evalDetailType": "SINGLE_METRIC",
                        "metricAggregateFunction": "VALUE",
                        "metricPath": "Average CPU Used (ms)",
                        "metricEvalDetail": {
                            "metricEvalDetailType": "BASELINE_TYPE",
                            "baselineCondition": "WITHIN_BASELINE",
                            "baselineName": "All data - Last 15 days",
                            "compareValue": 30.5,
                            "baselineUnit": "PERCENTAGE"
                        }
                    },
                    "triggerEnabled": false,
                    "minimumTriggers": 0
                }
            ],
            "evalMatchingCriteria": {
                "matchType": "ANY_NODE",
                "value": null
            }
        },
        "warningCriteria": {
            "conditionAggregationType": "ALL",
            "conditionExpression": null,
            "conditions": [
                {
                    "name": "Condition 1",
                    "shortName": "A",
                    "evaluateToTrueOnNoData": false,
                    "evalDetail": {
                        "evalDetailType": "METRIC_EXPRESSION",
                        "metricExpression": "({metric1} + ({metric2} * 3))",
                        "metricExpressionVariables": [
                            {
                                "variableName": "metric1",
                                "metricAggregateFunction": "VALUE",
                                "metricPath": "95th Percentile Response Time (ms)"
                            },
                            {
                                "variableName": "metric2",
                                "metricAggregateFunction": "MAXIMUM",
                                "metricPath": "Average CPU Used (ms)"
                            }
                        ],
                        "metricEvalDetail": {
                            "metricEvalDetailType": "SPECIFIC_TYPE",
                            "compareCondition": "GREATER_THAN_SPECIFIC_VALUE",
                            "compareValue": 10
                        }
                    },
                    "triggerEnabled": false,
                    "minimumTriggers": 0
                }
            ],
            "evalMatchingCriteria": {
                "matchType": "ANY_NODE",
                "value": null
            }
        }
    }
}

Retrieve a List of Health Rules for an Application

This API returns a list of all the health rule IDs and names for the specified application ID. To retrieve complete details of the health rule, use GET //health-rule/{health-rule-id}. See Property Details.

Resource URL

GET <controller_url>/controller/alerting/rest/v1/applications/<application_id>/health-rules

Response Format

JSON

Example Response

[
    {
        "id": 1,
        "name": "Machine Availability is too low",
        "enabled": true
    },
    {
        "id": 2,
        "name": "Overall Disk Space Available is too low",
        "enabled": true
    },
    {
        "id": 3,
        "name": "CPU Usage is too high",
        "enabled": true
    },
    {
        "id": 4,
        "name": "Memory Usage is too high",
        "enabled": true
    },
    {
        "id": 5,
        "name": "Swap Usage is too high",
        "enabled": true
    },
    {
        "id": 6,
        "name": "Disk Usage is too high on at least one partition",
        "enabled": false
    }
]

Retrieve Details of a Specified Health Rule

This API Returns the health rule details for the specified health rule ID.

Resource URL

GET <controller_url>/controller/alerting/rest/v1/applications/<application_id>/health-rules/{health-rule-id}

Response Format

JSON

Example Response

{
    "id": 26,
    "name": "My new health rule",
    "enabled": true,
    "useDataFromLastNMinutes": 30,
    "waitTimeAfterViolation": 5,
    "scheduleName": "Always",
    "affects": {
        "affectedEntityType": "BUSINESS_TRANSACTION_PERFORMANCE",
        "affectedBusinessTransactions": {
            "businessTransactionScope": "ALL_BUSINESS_TRANSACTIONS"
        }
    },
    "evalCriterias": {
        "criticalCriteria": {
            "conditionAggregationType": "ALL",
            "conditionExpression": null,
            "conditions": [
                {
                    "name": "Condition 1",
                    "shortName": "A",
                    "evaluateToTrueOnNoData": false,
                    "evalDetail": {
                        "evalDetailType": "SINGLE_METRIC",
                        "metricAggregateFunction": "VALUE",
                        "metricPath": "Average CPU Used (ms)",
                        "metricEvalDetail": {
                            "metricEvalDetailType": "BASELINE_TYPE",
                            "baselineCondition": "WITHIN_BASELINE",
                            "baselineName": "All data - Last 15 days",
                            "compareValue": 30.5,
                            "baselineUnit": "PERCENTAGE"
                        }
                    },
                    "triggerEnabled": false,
                    "minimumTriggers": 0
                }
            ],
            "evalMatchingCriteria": {
                "matchType": "ANY_NODE",
                "value": null
            }
        },
        "warningCriteria": {
            "conditionAggregationType": "ALL",
            "conditionExpression": null,
            "conditions": [
                {
                    "name": "Condition 1",
                    "shortName": "A",
                    "evaluateToTrueOnNoData": false,
                    "evalDetail": {
                        "evalDetailType": "METRIC_EXPRESSION",
                        "metricExpression": "({metric1} + ({metric2} * 3))",
                        "metricExpressionVariables": [
                            {
                                "variableName": "metric1",
                                "metricAggregateFunction": "VALUE",
                                "metricPath": "95th Percentile Response Time (ms)"
                            },
                            {
                                "variableName": "metric2",
                                "metricAggregateFunction": "MAXIMUM",
                                "metricPath": "Average CPU Used (ms)"
                            }
                        ],
                        "metricEvalDetail": {
                            "metricEvalDetailType": "SPECIFIC_TYPE",
                            "compareCondition": "GREATER_THAN_SPECIFIC_VALUE",
                            "compareValue": 10
                        }
                    },
                    "triggerEnabled": false,
                    "minimumTriggers": 0
                }
            ],
            "evalMatchingCriteria": {
                "matchType": "ANY_NODE",
                "value": null
            }
        }
    }
}

Update a Health Rule

This API updates an existing health rule (required fields) with details from the specified health rule ID. See Property Details.

Warning: To safeguard against potential API abuse of Splunk AppDynamics On-Premises, you must limit the API calls to no more than 100 requests per minute to the specified API endpoint. Exceeding this threshold limit may result in the blocking of additional call requests to Splunk AppDynamics On-Premises to maintain system integrity.

Resource URL

PUT <controller_url>/controller/alerting/rest/v1/applications/<application_id>/health-rules/{health-rule-id}

Request/Response Format

JSON

Example

Request

{
  "name": "My new health rule",
  "enabled": true,
  "useDataFromLastNMinutes": 30,
  "waitTimeAfterViolation": 5,
  "affects": {
    "affectedEntityType": "BUSINESS_TRANSACTION_PERFORMANCE",
    "affectedBusinessTransactions": {
      "businessTransactionScope": "ALL_BUSINESS_TRANSACTIONS"
    }
  },
  "evalCriterias": {
    "criticalCriteria": {
      "conditionAggregationType": "ALL",
      "conditions": [
        {
          "name": "Condition 1",
          "shortName": "A",
          "evaluateToTrueOnNoData": false,
          "evalDetail": {
            "evalDetailType": "SINGLE_METRIC",
            "metricAggregateFunction": "VALUE",
            "metricPath": "Average CPU Used (ms)",
            "metricEvalDetail": {
              "metricEvalDetailType": "BASELINE_TYPE",
              "baselineCondition": "WITHIN_BASELINE",
              "baselineName": "All Data - Last 15 Days",
              "baselineUnit": "PERCENTAGE",
              "compareValue": 30.5
            }
          }
        }
      ]
    },
    "warningCriteria": {
      "conditionAggregationType": "ALL",
      "conditions": [
        {
          "name": "Condition 1",
          "shortName": "A",
          "evalDetail": {
            "evalDetailType": "METRIC_EXPRESSION",
            "metricExpression": "({metric1} + ({metric2} * 3))",
            "metricExpressionVariables": [
              {
                "variableName": "metric1",
                "metricAggregateFunction": "VALUE",
                "metricPath": "95th Percentile Response Time (ms)"
              },
              {
                "variableName": "metric2",
                "metricAggregateFunction": "MAXIMUM",
                "metricPath": "Average CPU Used (ms)"
              }
            ],
            "metricEvalDetail": {
              "metricEvalDetailType": "SPECIFIC_TYPE",
              "compareCondition": "GREATER_THAN_SPECIFIC_VALUE",
              "compareValue": 10
            }
          }
        }
      ]
    }
  }
}

Response

{
  "name": "My new health rule",
  "enabled": true,
  "useDataFromLastNMinutes": 30,
  "waitTimeAfterViolation": 5,
  "affects": {
    "affectedEntityType": "BUSINESS_TRANSACTION_PERFORMANCE",
    "affectedBusinessTransactions": {
      "businessTransactionScope": "ALL_BUSINESS_TRANSACTIONS"
    }
  },
  "evalCriterias": {
    "criticalCriteria": {
      "conditionAggregationType": "ALL",
      "conditions": [
        {
          "name": "Condition 1",
          "shortName": "A",
          "evaluateToTrueOnNoData": false,
          "evalDetail": {
            "evalDetailType": "SINGLE_METRIC",
            "metricAggregateFunction": "VALUE",
            "metricPath": "Average CPU Used (ms)",
            "metricEvalDetail": {
              "metricEvalDetailType": "BASELINE_TYPE",
              "baselineCondition": "WITHIN_BASELINE",
              "baselineName": "All Data - Last 15 Days",
              "baselineUnit": "PERCENTAGE",
              "compareValue": 30.5
            }
          }
        }
      ]
    },
    "warningCriteria": {
      "conditionAggregationType": "ALL",
      "conditions": [
        {
          "name": "Condition 1",
          "shortName": "A",
          "evalDetail": {
            "evalDetailType": "METRIC_EXPRESSION",
            "metricExpression": "({metric1} + ({metric2} * 3))",
            "metricExpressionVariables": [
              {
                "variableName": "metric1",
                "metricAggregateFunction": "VALUE",
                "metricPath": "95th Percentile Response Time (ms)"
              },
              {
                "variableName": "metric2",
                "metricAggregateFunction": "MAXIMUM",
                "metricPath": "Average CPU Used (ms)"
              }
            ],
            "metricEvalDetail": {
              "metricEvalDetailType": "SPECIFIC_TYPE",
              "compareCondition": "GREATER_THAN_SPECIFIC_VALUE",
              "compareValue": 10
            }
          }
        }
      ]
    }
  }
}

Delete a Health Rule

Deletes an existing health rule with the specified ID.

Resource URL

DELETE <controller_url>/controller/alerting/rest/v1/applications/<application_id>/health-rules/{health-rule-id}

Update a Health Rule Configuration

This API updates one or more configuration setting(s) of a health rule. See Property Details

You can enter one or both of the following field(s) in the request:

Enable/disable the health rule.
Update the schedule of the health rule.

Resource URL

PUT <controller_url>/controller/alerting/rest/v1/applications/<application_id>/health-rules/{health-rule-id}/configuration

Request/Response Format

JSON

Example

Request

{
  "enabled": "false",
  "scheduleName": "Weeknights: 11pm-6am, Mon-Fri"
}

Response

{
    "id": 26,
    "name": "My new health rule",
    "enabled": false,
    "useDataFromLastNMinutes": 30,
    "waitTimeAfterViolation": 5,
    "scheduleName": "Weeknights: 11pm-6am, Mon-Fri",
    "affects": {
        "affectedEntityType": "BUSINESS_TRANSACTION_PERFORMANCE",
        "affectedBusinessTransactions": {
            "businessTransactionScope": "ALL_BUSINESS_TRANSACTIONS"
        }
    },
    "evalCriterias": {
        "criticalCriteria": {
            "conditionAggregationType": "ALL",
            "conditionExpression": null,
            "conditions": [
                {
                    "name": "Condition 1",
                    "shortName": "A",
                    "evaluateToTrueOnNoData": false,
                    "evalDetail": {
                        "evalDetailType": "SINGLE_METRIC",
                        "metricAggregateFunction": "VALUE",
                        "metricPath": "Average CPU Used (ms)",
                        "metricEvalDetail": {
                            "metricEvalDetailType": "BASELINE_TYPE",
                            "baselineCondition": "WITHIN_BASELINE",
                            "baselineName": "All data - Last 15 days",
                            "compareValue": 30.5,
                            "baselineUnit": "PERCENTAGE"
                        }
                    },
                    "triggerEnabled": false,
                    "minimumTriggers": 0
                }
            ],
            "evalMatchingCriteria": {
                "matchType": "ANY_NODE",
                "value": null
            }
        },
        "warningCriteria": {
            "conditionAggregationType": "ALL",
            "conditionExpression": null,
            "conditions": [
                {
                    "name": "Condition 1",
                    "shortName": "A",
                    "evaluateToTrueOnNoData": false,
                    "evalDetail": {
                        "evalDetailType": "METRIC_EXPRESSION",
                        "metricExpression": "({metric1} + ({metric2} * 3))",
                        "metricExpressionVariables": [
                            {
                                "variableName": "metric1",
                                "metricAggregateFunction": "VALUE",
                                "metricPath": "95th Percentile Response Time (ms)"
                            },
                            {
                                "variableName": "metric2",
                                "metricAggregateFunction": "MAXIMUM",
                                "metricPath": "Average CPU Used (ms)"
                            }
                        ],
                        "metricEvalDetail": {
                            "metricEvalDetailType": "SPECIFIC_TYPE",
                            "compareCondition": "GREATER_THAN_SPECIFIC_VALUE",
                            "compareValue": 10
                        }
                    },
                    "triggerEnabled": false,
                    "minimumTriggers": 0
                }
            ],
            "evalMatchingCriteria": {
                "matchType": "ANY_NODE",
                "value": null
            }
        }
    }
}

Enable All Health Rules

Enables all the health rules of an application.

Resource URL

PUT <controller_url>/controller/alerting/rest/v1/applications/<application_id>/health-rules/enable

Disable All Health Rules

Disable all the health rules of an application.

Resource URL

PUT <controller_url>/controller/alerting/rest/v1/applications/<application_id>/health-rules/disable

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

HealthRule

Property Name Type and Valid Values Description

id

integer

Auto-generated by the system and returned in the response.

It is a readOnly value.

name

string

Minimum length: 1

Name of the health rule.

enabled

boolean

Default value: true

Sets the health rule to enabled/disabled state. A health rule is evaluated only if it is in enabled state.

useDataFromLastNMinutes

integer

Minimum value: 1

Maximum value: 360

The time interval (in minutes) during which the data collected is considered for health rule evaluation. Enter a value between 1 to 9 or a multiple of 10 that is less than 360.

waitTimeAfterViolation

integer

Minimum time: 1 minute

The wait time after a violation in minutes.

scheduleName

string

Default option: Always

Name of schedule to be associated with the health rule for evaluation.

affects^*

Describes entities affected by the health rule. For example, business transactions, servers, or databases.

Affects


Property	Type	Enums
`affectedEntity` Type	string	`OVERALL_APPLICATION_PERFORMANCE` `BUSINESS_TRANSACTION_PERFORMANCE` `TIER_NODE_TRANSACTION_PERFORMANCE` `TIER_NODE_HARDWARE` `SERVERS_IN_APPLICATION` `BACKENDS` `ERRORS` `SERVICE_ENDPOINTS` `INFORMATION_POINTS` `CUSTOM` `DATABASES` `SERVERS` `EUM_API_MON` `EUM_BROWSER_APPS` `EUM_MOBILE_APPS` `ADVANCED_NETWORK` `OVERAGE_EVENT_TYPE` `JMX`

evalCriterias^*

Defines a condition or a set of conditions (maximum of 8) expressed as a boolean expression to evaluate the health rule. Depending on affectedEntityType a condition may or may not contain evalMatchingCriteria. Conditions are classified as:

critical or
warning

criticalCriteria

Critical conditions are evaluated before warning conditions. If you have defined a critical condition and a warning condition in the same health rule, the warning condition is evaluated only if the critical condition is not true.

Property Description Types/Enums

conditionAggregationType

Condition evaluation criteria that constitute a health rule violation.

String

default: ALL

Enums

ALL

ANY

CUSTOM

conditionExpression

Use only when you set the conditionAggregationType variable to CUSTOM. Use the ShortName of the condition to define the boolean expression.

String

minLength: 1

conditions^*

A single condition that can be evaluated independently to true or false

A list of conditions (maximum of 8) along with other properties to form a criteria.

String

minItems: 1

Condition

Property Description Type/Enums

name^* Name of the condition. string

shortname^*

A short name used in conditionExpression to evaluate CUSTOM conditionType .

string

pattern: ^[A-Z]{1,3}$

Enums

evaluateToTrueOnNoData

Controls the evaluation of the condition in cases where any metric on which the condition is based, returns no data. The condition evaluates to unknown by default when no data is returned. If the health rule is based on all the conditions evaluating to true , having no data returned may affect whether the health rule triggers an action.

boolean

default: false

evalDetail^*

Details of metric(s) considered for evaluation of the condition. Use SINGLE_METRIC to evaluate a sing le metric. Use METRIC_EXPRESSION to evaluate a metric expression.

ConditionEvalDetail


Property	Description	Type/Enums
evalDetailType	string	SINGLE_METRIC METRIC_EXPRESSION

triggerEnabled

If set to true , the value in field minimumTriggers is considered for evaluation.

boolean

default: false

minimumTriggers

If you set a non-zero value, persistence thresholds are considered when evaluating the conditions. Ensure that you define a value less than useDataFromLastNMinutes .

integer

default: 0

minimum: 0

maximum: 30

evalMatchingCriteria

The criteria for evaluating a condition for the following health rule types:

Business Transaction
Node health-hardware
Node health-transaction performance

It defines how many nodes in the affected entities must violate the condition before the health rule is considered violated.

NodeEvalMatchingCriteria


Property	Description	Type/Enums
`matchType`	The evaluation scope type that defines how many nodes in the affected entities must violate the condition before the health rule is considered violated. Enter the matching criteria only when you select PERCENTAGE_NODES or NUMBER_OF_NODES. matchType	String Enums AVERAGE ANY_NODE PERCENTAGE_NODESNUMBER_OF_NODES
`value`	The number or percentage of nodes that must violate the condition to constitute a health rule violation. If you select NUMBER_OF_NODES enter an integer. If you select PERCENTAGE_NODES, enter a number.	number minimum: 0

warningCriteria

If you have defined a critical condition and a warning condition in the same health rule, the warning condition is evaluated only if the critical condition is not true.

Property Description Type/Enums

conditionAggregationType

Condition evaluation criteria that constitute a health rule violation.

String

default: ALL

Enums

ALL

ANY

CUSTOM

conditionExpression

Use only when you set the conditionAggregationType variable to CUSTOM. Use the ShortName of the condition to define the boolean expression.

String

minLength: 1

conditions^*

A single condition that can be evaluated independently to true or false. OR A list of conditions (maximum of 8) along with other properties to form a criteria.

String

minLength: 1

Condition

Property Description Type/Enums

name^* Name of the condition. string

shortname^*

A short name used in conditionExpression to evaluate CUSTOM conditionType .

string

pattern: ^[A-Z]{1,3}$

Enums

evaluateToTrueOnNoData

Controls the evaluation of the condition in cases where any metric on which the condition is based, returns no data. The default when no data is returned is for the condition to evaluate to unknown. If the health rule is based on all the conditions evaluating to true, having no data returned may affect whether the health rule triggers an action.

boolean

default: false

evalDetail^*

Details of metric(s) considered for evaluation of the condition. Use SINGLE_METRIC to evaluate a sing le metric. Use METRIC_EXPRESSION to evaluate a metric expression.

ConditionEvalDetail


Property	Description	Type/Enums
evalDetailType	string	SINGLE_METRIC METRIC_EXPRESSION

triggerEnabled

If set to true , the value in field minimumTriggers is considered for evaluation.

boolean

default: false

minimumTriggers

If you set a non-zero value, persistence thresholds are considered when evaluating the conditions. Ensure that you define a value less than useDataFromLastNMinutes .

integer

default: 0

minimum: 0

maximum: 30

evalMatchingCriteria

The criteria for evaluating a condition for the following health rule types:

Business Transaction
Node health-hardware
Node health-transaction performance

It defines how many nodes in the affected entities must violate the condition before the health rule is considered violated.

NodeEvalMatchingCriteria


Property	Description	Type/Enums
`matchType`	The evaluation scope type that defines how many nodes in the affected entities must violate the condition before the health rule is considered violated. Enter the matching criteria only when you select PERCENTAGE_NODES or NUMBER_OF_NODES. matchType	String Enums AVERAGE ANY_NODE PERCENTAGE_NODES NUMBER_OF_NODES
`value`	The number or percentage of nodes that must violate the condition to constitute a health rule violation. If you select NUMBER_OF_NODES enter an integer. If you select PERCENTAGE_NODES, enter a number.	number minimum: 0

HealthRuleSummaryArray


Property	Type
`id^*`	integer
`name`	string minLength: 1
`enabled^*`	boolean

HealthRuleConfiguration

The configuration details of a health rule that you can update individually without the need to send the complete health rule JSON payload. You can mention one or more properties and all those properties are set to the new specified values.


Property	Type
`enabled`	boolean
`scheduleName`	string

MetricEvalDetail


Property	Type	Enums
`metricEvalDetailType^*`	string	BASELINE_TYPE SPECIFIC_TYPE

BaselineMetricEvalDetail

The deviation of a metric from the baseline used to evaluate the health rule.


Property	Type	Enums
`metricEvalDetailType^*`	string	BASELINE_TYPE SPECIFIC_TYPE
`baselineCondition^*`	string	WITHIN_BASELINE NOT_WITHIN_BASELINE GREATER_THAN_BASELINE LESS_THAN_BASELINE
`baselineName^*`	string minLength: 1
`compareValue^*`	number minimum: 0
`baselineUnit^*`	string	STANDARD_DEVIATIONS PERCENTAGE

SpecificValueMetricEvalDetail

The deviation of a metric from a specific value used to evaluate the health rule.


Property	Type	Enums
`metricEvalDetailType^*`	string	BASELINE_TYPE SPECIFIC_TYPE
`compareCondition^*`	string	GREATER_THAN_SPECIFIC_VALUE LESS_THAN_SPECIFIC_VALUE
`compareValue^*`	number minimum: 0

MetricAggregateFunction

Metrics aggregated to determine the deviation and evaluate the health rule.


Property	Type	Enums
MetricAggregateFunction*	string	MINIMUM MAXIMUM VALUE SUM COUNT CURRENT GROUP_COUNT

SingleMetricEvalDetail

The deviation of a single metric from the aggregated value used to evaluate the health rule.


Property	Type	Enums
evalDetailType	string	SINGLE_METRIC METRIC_EXPRESSION
`metricAggregateFunction^*`	string	MINIMUM MAXIMUM VALUE SUM COUNT CURRENT GROUP_COUNT
`metricPath^*`	string minLength: 1 Note: To ensure that a metric path for a health rule that includes a machine agent hierarchy is resolved appropriately, append the escape characters "\\" before the vertical bar for any custom metric. For example: `Application Infrastructure Performance\|Root\\\|Containers\\\|Fulfillment-Service\|Individual Nodes\|9b711cda4a83\|Hardware Resources\|CPU\|%Busy`
`metricEvalDetail^*`	string	BASELINE_TYPE SPECIFIC_TYPE

MetricExpressionEvalDetail

The metric expression used to evaluate the health rule.

Property Type Enums

evalDetailType

string

SINGLE_METRIC

METRIC_EXPRESSION

metricExpression^*

string

minLength: 1

metricExpressionVariables^*

string

minItems: 1

MetricDetailWithVariableName


Property	Type	Enums
`variableName^*`	string minLength: 1
`metricAggregateFunction^*`	string	MINIMUM MAXIMUM VALUE SUM COUNT CURRENT GROUP_COUNT
`metricPath^*`	string minLength: 1

metricEvalDetail^*

string

SpecificValueMetricEvalDetail


Property	Type	Enums
`metricEvalDetailType^*`	string	BASELINE_TYPE SPECIFIC_TYPE
`compareCondition^*`	string	GREATER_THAN_SPECIFIC_VALUE LESS_THAN_SPECIFIC_VALUE
`compareValue^*`	number minimum: 0

MetricDetailWithVariableName


Property	Type	Enums
`variableName^*`	string minLength: 1
`metricAggregateFunction^*`	string	MINIMUM MAXIMUM VALUE SUM COUNT CURRENT GROUP_COUNT
`metricPath^*`	string minLength: 1

NodeEvalMatchingCriteria


Property	Type	Enums
`matchType`	string	AVERAGE ANY_NODE PERCENTAGE_NODES NUMBER_OF_NODES
value Enter the matching criteria only when you select PERCENTAGE_NODES or NUMBER_OF_NODES as matchType. If you select NUMBER_OF_NODES, enter an integer; else if you select PERCENTAGE_NODES, enter a number.	number minimum: 0

Condition

A single condition that can be independently evaluated to true or false. List of conditions (maximum 8) along with other properties form a criteria.

Property Description Type/Enums

name^* Name of the condition. string

shortname^*

A short name used in conditionExpression to evaluate CUSTOM conditionType .

string

pattern: ^[A-Z]{1,3}$

Enums

evaluateToTrueOnNoData

boolean

default: false

evalDetail^*

Details of metric(s) considered for evaluation of the condition. Use SINGLE_METRIC to evaluate a single metric. Use METRIC_EXPRESSION to evaluate a metric expression.

ConditionEvalDetail


Property	Type	Enums
`evalDetailType`	string	SINGLE_METRIC METRIC_EXPRESSION

triggerEnabled

If set to true , the value in field minimumTriggers is considered for evaluation.

boolean

default: false

minimumTriggers

If you set a non-zero value, persistence thresholds are considered when evaluating the conditions. Ensure that you define a value less than useDataFromLastNMinutes .

integer

default: 0

minimum: 0

maximum: 30

ConditionEvalDetail


Property	Type	Enums
`evalDetailType`	string	SINGLE_METRIC METRIC_EXPRESSION

Criteria

Property Description Type/Enums

conditionAggregationType

Condition evaluation criteria that constitute a health rule violation.

string

default: ALL

Enums

ALL

ANY

CUSTOM

conditionExpression

Use only when you set the conditionAggregationType variable to CUSTOM. Use the ShortName of the condition to define the boolean expression.

String

minLength: 1

conditions^*

A single condition that can be evaluated independently to true or false. OR

A list of conditions (maximum of 8) along with other properties to form a criteria.

String

minItems: 1

Condition

Property Description Type/Enums

name^* Name of the condition. string

shortname^*

A short name used in conditionExpression to evaluate CUSTOM conditionType.

string

pattern: ^[A-Z]{1,3}$

Enums

evaluateToTrueOnNoData

Controls the evaluation of the condition in cases where any metric on which the condition is based, returns no data. The default when no data is returned is for the condition to evaluate to unknown . If the health rule is based on all the conditions evaluating to true , having no data returned may affect whether the health rule triggers an action.

boolean

default: false

evalDetail^*

Details of metric(s) considered for evaluation of the condition. Use SINGLE_METRIC to evaluate a single metric. Use METRIC_EXPRESSION to evaluate a metric expression.

ConditionEvalDetail


Property	Type	Enums
`evalDetailType`	string	SINGLE_METRIC METRIC_EXPRESSION

triggerEnabled

If set to true , the value in field minimumTriggers is considered for evaluation.

boolean

default: false

minimumTriggers

If you set a non-zero value, persistence thresholds are considered when evaluating the conditions. Ensure that you define a value less than useDataFromLastNMinutes .

integer

default: 0

minimum: 0

maximum: 30

evalMatchingCriteria

The criteria for evaluating a condition for the following health rule types:

Business Transaction
Node health-hardware
Node health-transaction performance

It defines how many nodes in the affected entities must violate the condition before the health rule is considered violated.

NodeEvalMatchingCriteria


Property	Description	Type/Enums
`matchType`	The evaluation scope type that defines how many nodes in the affected entities must violate the condition before the health rule is considered violated. Enter the matching criteria only when you select PERCENTAGE_NODES or NUMBER_OF_NODES. matchType	String Enums AVERAGE ANY_NODE PERCENTAGE_NODES NUMBER_OF_NODES
`value`	The number or percentage of nodes that must violate the condition to constitute a health rule violation. If you select NUMBER_OF_NODES enter an integer. If you select PERCENTAGE_NODES, enter a number.	number minimum: 0

EntityMatchingPattern


Property	Type	Enums
`matchTo^*`	string	STARTS_WITH ENDS_WITH CONTAINS EQUALS MATCH_REG_EX
`matchValue^*`	string minLength: 1
`shouldNot`	boolean

AffectedTiers


Property	Type	Enums
`affectedTierScope^*`	string	ALL_TIERS SPECIFIC_TIERS TIERS_BY_TAGS

AllTiers

The scope of affected tiers is set to all tiers for an affected entity.


Property	Type	Enums
`affectedTierScope^*`	string	ALL_TIERS

SpecificTiers

The scope of affected tiers is set to specific tiers for an affected entity.


Property	Type	Enums
`affectedTierScope^*`	string	SPECIFIC_TIERS
`tiers^*`	string minItems: 1

TiersByTags

The scope of affected tiers is set to all tiers that matches the tag criteria.

Property Type Enums

affectedTierScope^* string TIERS_BY_TAGS

tagVarPairs^*

array

minItems: 1


Property	Type	Enums
`propertyType^*`	string	TAG
`name^*`	string minLength: 1
`value^*`	string minLength: 1

AffectedNodes


Property	Type	Enums
`affectedNodeScope^*`	string	ALL_NODES SPECIFIC_NODES NODES_OF_SPECIFIC_TIERS NODES_MATCHING_PATTERN NODE_PROPERTY_VARIABLE_MATCHER

AffectedNodes


Property	Type	Enums
`affectedNodeScope^*`	string	ALL_NODES SPECIFIC_NODES NODES_OF_SPECIFIC_TIERS NODES_MATCHING_PATTERN NODE_PROPERTY_VARIABLE_MATCHER NODES_BY_TAGS

AllNodes

The scope of affected nodes is set to all nodes for an affected entity.


Property	Type	Enums
`affectedNodeScope^*`	string	ALL_NODES

SpecificNodes

The scope of affected nodes is set to all nodes for an affected entity.


Property	Type	Enums
`affectedNodeScope^*`	string	SPECIFIC_NODES
`nodes^*`	string minItems: 1

NodesOfSpecificTiers

The scope of affected nodes is set to nodes of specific tiers for an affected entity.


Property	Type	Enums
`affectedNodeScope^*`	string	NODES_OF_SPECIFIC_TIERS
`specificTiers^*`	string minItems: 1

NodesMatchingPattern

The scope of affected nodes is set to nodes matching a pattern for an affected entity.

Property Type Enums

affectedNodeScope^*

string

NODES_MATCHING_PATTERN

patternMatcher^*

EntityMatchingPattern


Property	Type	Enums
`matchTo^*`	string	STARTS_WITH ENDS_WITH CONTAINS EQUALS MATCH_REG_EX
`matchValue^*`	string minLength: 1
`shouldNot`	boolean

NodePropertyVariableMatcher

The scope of affected nodes is set to nodes matching a variable property for an affected entity.

Property Type Enums

affectedNodeScope^*

string

NODE_PROPERTY_VARIABLE_MATCHER

propVarPairs^*

array

minItems: 1


Property	Type	Enums
`propertyType`	string	META ENV JVM TAG
`name`	string minLength: 1
`value`	string minLength: 1

OverallApplicationPerformance

The scope of the affected entity is set to overall application performance.


Property	Type	Enums
`affectedEntityType^*`	string	OVERALL_APPLICATION_PERFORMANCE

BusinessTransactionPerformance

The scope of the affected entity is set to business transaction performance.

Property Type Enums

affectedEntityType^*

string

BUSINESS_TRANSACTION_PERFORMANCE

affectedBusinessTransactions^*

string

AffectedBusinessTransactions


Property	Type	Enums
`businessTransactionScope^*`	string	ALL_BUSINESS_TRANSACTIONS SPECIFIC_BUSINESS_TRANSACTIONS BUSINESS_TRANSACTIONS_IN_SPECIFIC_TIERS BUSINESS_TRANSACTIONS_MATCHING_PATTERN BUSINESS_TRANSACTIONS_BY_TAGS

AffectedBusinessTransactions


Property	Type	Enums
`businessTransactionScope^*`	string	ALL_BUSINESS_TRANSACTIONS SPECIFIC_BUSINESS_TRANSACTIONS BUSINESS_TRANSACTIONS_IN_SPECIFIC_TIERS BUSINESS_TRANSACTIONS_MATCHING_PATTERN BUSINESS_TRANSACTIONS_BY_TAGS

AllBusinessTransactions

The scope of business transactions is set to all business transactions.


Property	Type	Enums
`businessTransactionScope^*`	string	ALL_BUSINESS_TRANSACTIONS

SpecificBusinessTransactions

The scope of business transactions is set to specific business transactions.


Property	Type	Enums
`businessTransactionScope^*`	string	SPECIFIC_BUSINESS_TRANSACTIONS
`businessTransactions^*`	string minItems: 1

BusinessTransactionsInSpecificTiers

The scope of business transactions is set to business transactions for specific tiers.


Property	Type	Enums
`businessTransactionScope^*`	string	BUSINESS_TRANSACTIONS_IN_SPECIFIC_TIERS
`specificTiers^*`	string minItems: 1

BusinessTransactionsMatchingPattern

The scope of business transactions is set to business transactions matching a certain pattern.

Property Type Enums

businessTransactionScope^*

string

BUSINESS_TRANSACTIONS_MATCHING_PATTERN

specificTiers^*

string

EntityMatchingPattern


Property	Type	Enums
`matchTo^*`	string	STARTS_WITH ENDS_WITH CONTAINS EQUALS MATCH_REG_EX
`matchValue^*`	string minLength: 1
`shouldNot`	boolean

BUSINESS_TRANSACTIONS_BY_TAGS

The scope of business transactions is set to business transactions by tags.

Property

Type

Enum

businessTransactionScope^*

string

BUSINESS_TRANSACTIONS_BY_TAGS

tagVarPairs^*

array

minItems: 1


Property	Type	Enum
propertyType^*	string	TAG
name^*	string minLength: 1
value^*	string minLength: 1

TierNodeTransactionPerformance

The type of affected entities is set to the performance of tier and node transactions.

Property Type Enums

affectedEntityType^*

string

TIER_NODE_TRANSACTION_PERFORMANCE

affectedEntities^*

string

AffectedTierOrNodeEntities


Property	Type	Enums
`tierOrNode^*`	string	TIER_AFFECTED_ENTITIES NODE_AFFECTED_ENTITIES

AffectedTierOrNodeEntities


Property	Type	Enums
`tierOrNode^*`	string	TIER_AFFECTED_ENTITIES NODE_AFFECTED_ENTITIES

TierAffectedEntities

The scope of affected entities is set to tiers.

Property Type Enums

tierOrNode*

string

TIER_AFFECTED_ENTITIES

NODE_AFFECTED_ENTITIES

affectedTiers*

string

AffectedTiers


Property	Type	Enums
`affectedTierScope^*`	string	ALL_TIERS SPECIFIC_TIERS

NodeAffectedEntities

The scope of affected entities is set to nodes.

Property Type Enums

tierOrNode^*

string

TIER_AFFECTED_ENTITIES

NODE_AFFECTED_ENTITIES

typeofNode^*

string

ALL_NODES

JAVA_NODES

DOT_NET_NODES

PHP_NODES

affectedNodes^*

string

AffectedNodes


Property	Type	Enums
`affectedNodeScope^*`	string	ALL_NODES SPECIFIC_NODES NODES_OF_SPECIFIC_TIERS NODES_MATCHING_PATTERN NODE_PROPERTY_VARIABLE_MATCHER NODES_BY_TAGS

TierNodeHardware

The affected entity type is set to tier node hardware.

Property Type Enums

affectedEntityType^*

string

TIER_NODE_HARDWARE

affectedEntities^*

string

AffectedTierOrNodeEntities


Property	Type	Enums
`tierOrNode^*`	string	TIER_AFFECTED_ENTITIES NODE_AFFECTED_ENTITIES

ServersInApplication

The affected entity type is set to servers in the application.

Property Type Enums

affectedEntityType^*

string

SERVERS_IN_APPLICATION

affectedServers^*

string

ApplicationAffectedServers


Property	Type	Enums
`serversScope^*`	string	ALL_SERVERS_IN_APPLICATION SPECIFIC_SERVERS_IN_APPLICATION ALL_SERVERS_IN_SPECIFIC_TIERS APM_SERVERS_BY_TAGS

ApplicationAffectedServers


Property	Type	Enums
s `erversScope^*`	string	ALL_SERVERS_IN_APPLICATION SPECIFIC_SERVERS_IN_APPLICATION ALL_SERVERS_IN_SPECIFIC_TIERS APM_SERVERS_BY_TAGS

AllServersInApplication

The scope of servers is set to all servers in the application.


Property	Type	Enums
`serversScope^*`	string	ALL_SERVERS_IN_APPLICATION

SpecificServersInApplication

The scope of servers is set to specific servers in the application.


Property	Type	Enums
`serversScope^*`	string	SPECIFIC_SERVERS_IN_APPLICATION
`specificServers^*`	string minLength: 1

AllServersInSpecificTiers

The scope of servers is set to all servers in specific tiers.


Property	Type	Enums
`serversScope^*`	string	ALL_SERVERS_IN_SPECIFIC_TIERS
`specificTiers^*`	string minItems: 1

ApmServersByTags

The scope of servers is set to all servers matching the tag criteria.

Property Type Enums

serversScope^* string APM_SERVERS_BY_TAGS

tagVarPairs^*

array

minItems: 1


Property	Type	Enums
`propertyType^*`	string	TAG
`name^*`	string minLength: 1
`value^*`	string minLength: 1

Backends

The affected entity type is set to backends.

Property Type Enums

affectedEntityType^*

string

BACKENDS

affectedBackends^*

string

AffectedBackends


Property	Type	Enums
`backendScope^*`	string	ALL_BACKENDS SPECIFIC_BACKENDS BACKENDS_MATCHING_PATTERN

AffectedBackends


Property	Type	Enums
`backendScope^*`	string	ALL_BACKENDS SPECIFIC_BACKENDS BACKENDS_MATCHING_PATTERN

AllBackends

The scope of backends is set to all backends.


Property	Type	Enums
`backendScope^*`	string	ALL_BACKENDS

SpecificBackends

The scope of backends is set to specific backends.


Property	Type	Enums
`backendScope^*`	string	SPECIFIC_BACKENDS
`backends^*`	string minItems: 1

BackendsMatchingPattern

The scope of backends is set to backends matching a specific pattern.

Property Type Enums

backendScope^*

string

BACKENDS_MATCHING_PATTERN

patternMatcher^*

string

EntityMatchingPattern


Property	Type	Enums
`matchTo^*`	string	STARTS_WITH ENDS_WITH CONTAINS EQUALS MATCH_REG_EX
`matchValue^*`	string minLength: 1
`shouldNot`	boolean

Errors

The affected entity type is set to errors.

Property Type Enums

affectedEntityType^*

string

ERRORS

affectedErrors^*

string

AffectedErrors


Property	Type	Enums
`errorScope^*`	string	ALL_ERRORS SPECIFIC_ERRORS ERRORS_OF_SPECIFIC_TIERS ERRORS_MATCHING_PATTERN

AffectedErrors


Property	Type	Enums
`errorScope^*`	string	ALL_ERRORS SPECIFIC_ERRORS ERRORS_OF_SPECIFIC_TIERS ERRORS_MATCHING_PATTERN

AllErrors

The scope of errors is set to all errors.


Property	Type	Enums
`errorScope^*`	string	ALL_ERRORS

SpecificErrors

The scope of errors is set to specific errors.


Property	Type	Description/Enums
`errorScope^*`	string	SPECIFIC_ERRORS
errors^*	string minItems: 1
tiers	string minItems: 1	Use if error names belong to multiple tiers. Provide the tier names as a list in affects.affectedErrors.tiers in the same order as the error names. In the following example, 'Page Not Found: 404' corresponds to Tier1, while 'Error2' corresponds to SomeOtherTier. Note: If the error names are unique to each tier, tiers map errors one to one. You need not specify the tier name in this case. If errors have same name but belong to different tiers, duplicate names are handled by appending tier names with the delimiter '\|'. If there is a mismatch between the number of error names and tier names, then the list `affects.affectedErrors.tiers` is ignored. If an error belongs to multiple tiers, and you do not specify the tier names, the error name cannot be uniquely identified. Hence, an error is displayed.
	{ "id": 33, "name": "Specific Error", "enabled": true, "useDataFromLastNMinutes": 1, "waitTimeAfterViolation": 1, "scheduleName": "Always", "affects": { "affectedEntityType": "ERRORS", "affectedErrors": { "errorScope": "SPECIFIC_ERRORS", "errors": [ "Page Not Found : 404", "Error2" ], "tiers": [ "Tier1", "SomeOtherTier" ] } }, "evalCriterias": { "criticalCriteria": { "conditionAggregationType": "ALL", "conditionExpression": null, "conditions": [ { "name": "Condition 1", "shortName": "A", "evaluateToTrueOnNoData": false, "evalDetail": { "evalDetailType": "SINGLE_METRIC", "metricAggregateFunction": "VALUE", "metricPath": "Errors per Minute", "metricEvalDetail": { "metricEvalDetailType": "SPECIFIC_TYPE", "compareCondition": "GREATER_THAN_SPECIFIC_VALUE", "compareValue": 10 } }, "triggerEnabled": false, "minimumTriggers": 1 } ], "evalMatchingCriteria": { "matchType": "ANY_NODE", "value": null } }, "warningCriteria": null } }

ErrorsOfSpecificTiers

The scope of errors is set to errors related to specific tiers.


Property	Type	Enums
`errorScope^*`	string	ERRORS_OF_SPECIFIC_TIERS
`specificTiers^*`	string minItems: 1

ErrorsMatchingPattern

The scope of errors is set to errors matching a specific pattern.

Property Type Enums

errorScope^*

string

ERRORS_MATCHING_PATTERN

patternMatcher

string

EntityMatchingPattern


Property	Type	Enums
`matchTo^*`	string	STARTS_WITH ENDS_WITH CONTAINS EQUALS MATCH_REG_EX
`matchValue^*`	string minLength: 1
`shouldNot`	boolean

ServiceEndpoints

The affected entity type is set to service endpoints.

Property Type Enums

affectedEntityType^*

string

SERVICE_ENDPOINTS

affectedServiceEndpoints^*

AffectedServiceEndpoints


Property	Type	Enums
`serviceEndpointScope^*`	string	ALL_SERVICE_ENDPOINTS SPECIFIC_SERVICE_ENDPOINTS SERVICE_ENDPOINTS_IN_SPECIFIC_TIERS SERVICE_ENDPOINTS_MATCHING_PATTERN

AffectedServiceEndpoints


Property	Type	Enums
`serviceEndpointScope^*`	string	ALL_SERVICE_ENDPOINTS SPECIFIC_SERVICE_ENDPOINTS SERVICE_ENDPOINTS_IN_SPECIFIC_TIERS SERVICE_ENDPOINTS_MATCHING_PATTERN

AllServiceEndpoints

The scope of service endpoints is set to all service endpoints.


Property	Type	Enums
`serviceEndpointScope^*`	string	ALL_SERVICE_ENDPOINTS

SpecificServiceEndpoints

The scope of service endpoints is set to specific service endpoints.


Property	Type	Enums
`serviceEndpointScope^*`	string	SPECIFIC_SERVICE_ENDPOINTS
`serviceEndpoints^*`	string minItems: 1

ServiceEndpointsInSpecificTiers

The scope of service endpoints is set to specific service endpoints.


Property	Type	Enums
`serviceEndpointScope^*`	string	SERVICE_ENDPOINTS_IN_SPECIFIC_TIERS
`specificTiers^*`	string minItems: 1

ServiceEndpointsMatchingPattern

The scope of service endpoints is set to service endpoints that match a specific pattern.

Property Type Enums

serviceEndpointScope^*

string

SERVICE_ENDPOINTS_MATCHING_PATTERN

patternMatcher^*

string

minItems: 1

EntityMatchingPattern


Property	Type	Enums
`matchTo^*`	string	STARTS_WITH ENDS_WITH CONTAINS EQUALS MATCH_REG_EX
`matchValue^*`	string minLength: 1
`shouldNot`	boolean

InformationPoints

The affected entity type is set to information points.

Property Type Enums

affectedEntityType^*

string

INFORMATION_POINTS

affectedInformationPoints^*

string

AffectedInformationPoints


Property	Type	Enums
`informationPointScope^*`	string	ALL_INFORMATION_POINTS SPECIFIC_INFORMATION_POINTS INFORMATION_POINTS_MATCHING_PATTERN

AffectedInformationPoints


Property	Type	Enums
`informationPointScope^*`	string	ALL_INFORMATION_POINTS SPECIFIC_INFORMATION_POINTS INFORMATION_POINTS_MATCHING_PATTERN

AllInformationPoints

The scope of information points is set to all information points.


Property	Type	Enums
`informationPointScope^*`	string	ALL_INFORMATION_POINTS

SpecificInformationPoints

The scope of information points is set to specific information points.


Property	Type	Enums
`informationPointScope^*`	string	SPECIFIC_INFORMATION_POINTS
`informationPoints^*`	string minItems: 1

InformationPointsMatchingPattern

The scope of information points is set to information points matching a pattern.

Property Type Enums

informationPointScope^*

string

INFORMATION_POINTS_MATCHING_PATTERN

patternMatcher^*

string

minItems: 1

EntityMatchingPattern


Property	Type	Enums
`matchTo^*`	string	STARTS_WITH ENDS_WITH CONTAINS EQUALS MATCH_REG_EX
`matchValue^*`	string minLength: 1
`shouldNot`	boolean

Custom

The affected entity type is set to custom.

Property Type Enums

affectedEntityType^*

string

CUSTOM

affectedEntityScope^*

string

AffectedEntityScope


Property	Type	Enums
`entityScope^*`	string	APPLICATION_PERFORMANCE SPECIFIC_ENTITY_PERFORMANCE

AffectedEntityScope


Property	Type	Enums
`entityScope^*`	string	APPLICATION_PERFORMANCE SPECIFIC_ENTITY_PERFORMANCE

ApplicationPerformance

The scope of the affected entity is set to application performance.


Property	Type	Enums
`entityScope^*`	string	APPLICATION_PERFORMANCE

SpecificEntityPerformance

The scope of the affected entity is set to specific entity performance.


Property	Type	Enums
`entityScope^*`	string	SPECIFIC_ENTITY_PERFORMANCE
`entityType^*`	string	BUSINESS_TRANSACTION NODE SERVER
`affectedEntityName^*`	string minLength: 1

Databases

The affected entity type is set to databases.

Property Type Enums

affectedEntityType^*

string

DATABASES

databaseType^*

string

ALL_DATABASE_TYPES

COUCHBASE

DB2

MONGO_DB

MICROSOFT_SQL_SERVER

MYSQL

ORACLE

POSTGRE_SQL

AZURE_SQL

SYBASE

affectedDatabases^*

string

AffectedDatabases


Property	Type	Enums
`databaseScope`	string	ALL_DATABASES SPECIFIC_DATABASES

AffectedDatabases


Property	Type	Enums
`databaseScope^*`	string	ALL_DATABASES SPECIFIC_DATABASES

AllDatabases

The scope of affected databases is set to all databases.


Property	Type	Enums
`databaseScope^*`	string	ALL_DATABASES

SpecificDatabases

The scope of affected databases is set to specific databases.

Property Type Enums

databaseScope^*

string

SPECIFIC_DATABASES

databases^*

string

minItems: 1

DbServer


Property	Type
`serverName^*`	string minLength: 1
`collectorConfigName^*`	string minLength: 1

DbServer


Property	Type
`serverName^*`	string minLength: 1
`collectorConfigName^*`	string minLength: 1

Servers

The affected entity type is set to servers.

Property Type Enums

affectedEntityType^*

string

SERVERS

serverSelectionCriteria^*

string

AffectedServersCriteria


Property	Type	Enums
`selectServersBy^*`	string	AFFECTED_SERVER_SUBGROUPS AFFECTED_SERVERS

AffectedServersCriteria


Property	Type	Enums
`selectServersBy^*`	string	AFFECTED_SERVER_SUBGROUPS AFFECTED_SERVERS

AffectedServers

Property Type Enums

selectServersBy^*

string

AFFECTED_SERVER_SUBGROUPS

AFFECTED_SERVERS

affectedServers^*

string

ServerSelectionCriteria


Property	Type	Enums
`severSelectionScope^*`	string	ALL_SERVERS_IN_ACCOUNT SERVERS_WITHIN_SUBGROUP SPECIFIC_SERVERS SERVERS_MATCHING_PATTERN SERVERS_BY_TAGS

ServerSelectionCriteria


Property	Type	Enums
`severSelectionScope^*`	string	ALL_SERVERS_IN_ACCOUNT SERVERS_WITHIN_SUBGROUP SPECIFIC_SERVERS SERVERS_MATCHING_PATTERN SERVERS_BY_TAGS

AllServersInAccount

The scope of servers is set to all servers within an account.


Property	Type	Enums
`severSelectionScope^*`	string	ALL_SERVERS_IN_ACCOUNT

ServersWithinSubGroup

The scope of servers is set to all servers within a subgroup.


Property	Type	Enums
`severSelectionScope^*`	string	SERVERS_WITHIN_SUBGROUP
`subGroups^*`	string minItems: 1

SpecificServers

The scope of servers is set to specific servers.


Property	Type	Enums
`severSelectionScope^*`	string	SPECIFIC_SERVERS
`servers^*`	string minItems: 1

ServersMatchingPattern

The scope of servers is set to servers matching a specific pattern.

Property Type Enums

severSelectionScope^*

string

SERVERS_MATCHING_PATTERN

patternMatcher^*

EntityMatchingPattern


Property	Type	Enums
`matchTo^*`	string	STARTS_WITH ENDS_WITH CONTAINS EQUALS MATCH_REG_EX
`matchValue^*`	string minLength: 1
`shouldNot`	boolean

ServersByTags

The scope of affected servers is to match the tag criteria.

Property Type Enums

severSelectionScope^* string SERVERS_BY_TAGS

tagVarPairs^*

array

minItems: 1


Property	Type	Enum
propertyType^*	string	TAG
name^*	string minLength: 1
value^*	string minLength: 1

AffectedServerSubGroups

The scope of affected servers is set to affected servers within a subgroup.

Property Type Enums

selectServersBy^*

string

AFFECTED_SERVER_SUBGROUPS

subGroups^*

string

minItems: 1

AffectedSubGroups


Property	Type	Enums
`subGroupScope^*`	string	ALL_SUBGROUPS SPECIFIC_SERVER_SUB_GROUPS

AffectedSubGroups


Property	Type	Enums
`subGroupScope*`	string	ALL_SUBGROUPS SPECIFIC_SERVER_SUB_GROUPS

AllSubGroups

The scope of affected servers is set to servers within all subgroups.



`subGroupScope^*`	string	ALL_SUBGROUPS

SpecificServerSubGroups

The scope of affected servers is set to servers within specific subgroups.


Property	Type	Enums
`subGroupScope^*`	string	SPECIFIC_SERVER_SUB_GROUPS
`subGroupNames`	string minItems: 1

AffectedEumBrowserEntities

Describes the End User Monitoring (EUM) browser entities that a health rule can affect.


Property	Type	Enum
`affectedEumEntityType^*`	string	EUM_PAGES EUM_VIRTUAL_PAGES EUM_IFRAMES EUM_AJAX_REQUESTS

EumPages

Describes the End User Monitoring (EUM) pages that a health rule can monitor.

Property Type Enum

affectedPages^*

string


Property	Type	Enum
`affectedPageScope^*`	string	ALL_PAGES SPECIFIC_PAGES PAGES_MATCHING_PATTERN PAGES_BY_TAGS

AllPages

The scope of affected pages is set to all pages.


Property	Type	Enum
`affectedPageScope^*`	string	`ALL_PAGES`

SpecificPages

The scope of affected pages is set to specific pages.


Property	Type	Enum
`affectedPageScope^*`	string	`SPECIFIC_PAGES`
`pages^*`	string minItems: 1

PagesMatchingPattern

The scope of affected pages is set to pages matching pattern.

Property Type Enum

affectedPageScope^* string PAGES_MATCHING_PATTERN

patternMatcher^*

EntityMatchingPattern


Property	Type	Enums
`matchTo^*`	string	STARTS_WITH ENDS_WITH CONTAINS EQUALS MATCH_REG_EX
`matchValue^*`	string minLength: 1
`shouldNot`	boolean

PagesByTags

The scope of affected pages is set to pages matching tag criteria.

Property Type Enum

affectedPageScope^* string PAGES_BY_TAGS

tagVarPairs^*

array

minItems: 1


Property	Type	Enum
`propertyType^*`	string	TAG
`name`	string minLength: 1
`value`	string minLength: 1

JMX

The scope of the affected entity type is set to JMX.

Property Type Enum

affectedEntityType

string

JMX

affectedEntities^*

string

AffectedJmxEntities

Property Type Enum

jmxOrNode^*

string

JMX_INSTANCE_NAME

NODES

metricPath^*

string

affectedNodes^*

JmxNodeAffectedEntities


Property	Type	Enum
affectedNodes^*		AffectedNodes

affectedJmxInstanceNames^*

JmxInstanceNameAffectedEntities

Property Type Enum

affectedJmx^*

AffectedJmxInstance


Property	Type	Enum
`affectedJmxInstanceScope^*`	string	`ALL_JMX_INSTANCESPECIFIC_JMX_INSTANCE`

Affected JMX Instance

The scope of affected JMX instance scope is set to all JMX instances and the specific JMX instances.


Property	Type	Enum
affectedJmxInstanceScope	string	ALL_JMX_INSTANCE SPECIFIC_JMX_INSTANC

All JMX Instance

The scope of JMX instance is set to all the JMX instances of the entity.


Property	Type	Enum
affectedJmxInstanceScope^*	string	ALL_JMX_INSTANCE

Specific JMX Instance

The scope of affected JMX instance is set to specific JMX instance of the entity.


Property	Type	Enum
affectedJmxInstanceScope	string	SPECIFIC_JMX_INSTANCE
jmxInstance^*	array minItems: 1	Examples: mapped direct PS Scavenge

HealthRuleSummary


Property	Type
`id^*`	integer
`name`	string
`enabled^*`	boolean

ErrorResponse


Property	Type
`statusCode`	integer
`message`	string

*This property is required (mandatory).

Download Examples

Download a set of examples that help you configure a health rule, health_rule_request_examples.zip.

Examples- Health Rules with Tags

The following section illustrates a few examples related to health rules with tags.

Warning: The custom tagging feature requires enabling the account-level setting, entity.tagging.enabled, which is disabled by default. To use this feature, set the entity.tagging.enabled account level property to true on the Administration Console. See Custom Tag APIs.

Create a Health Rules for Tiers with Tags

This example creates a health rule with the affected entity type TIER_NODE_TRANSACTION_PERFORMANCE that matches the tag criteria.

Resource URL

POST <controller_url>/controller/alerting/rest/v1/applications/10/health-rules

Request

{
    "name": "Health rule for tiers with tags",
    "enabled": true,
    "useDataFromLastNMinutes": 30,
    "waitTimeAfterViolation": 30,
    "scheduleName": "Always",
    "affects": {
        "affectedEntityType": "TIER_NODE_TRANSACTION_PERFORMANCE",
        "affectedEntities": {
            "tierOrNode": "TIER_AFFECTED_ENTITIES",
            "affectedTiers": {
                "affectedTierScope": "TIERS_BY_TAGS",
                "tagVarPairs": [
                    {
                        "propertyType": "TAG",
                        "name": "i_app_support_org",
                        "value": "Enterprise Platforms"
                    },
                    {
                        "propertyType": "TAG",
                        "name": "i_manufacturer",
                        "value": "Cisco"
                    }
 
                ]
            }
        }
    },
    "evalCriterias": {
        "criticalCriteria": {
            "conditionAggregationType": "ALL",
            "conditionExpression": null,
            "conditions": [
                {
                    "name": "Condition 1",
                    "shortName": "A",
                    "evaluateToTrueOnNoData": false,
                    "evalDetail": {
                        "evalDetailType": "SINGLE_METRIC",
                        "metricAggregateFunction": "VALUE",
                        "metricPath": "Calls per Minute",
                        "metricEvalDetail": {
                            "metricEvalDetailType": "SPECIFIC_TYPE",
                            "compareCondition": "GREATER_THAN_SPECIFIC_VALUE",
                            "compareValue": 11
                        }
                    },
                    "triggerEnabled": false,
                    "minimumTriggers": 0
                }
            ],
            "evalMatchingCriteria": {
                "matchType": "ANY_NODE",
                "value": null
            }
        },
        "warningCriteria": null
    }
}

Response

{
    "id": 63,
    "name": "Health rule for tiers with tags",
    "enabled": true,
    "useDataFromLastNMinutes": 30,
    "waitTimeAfterViolation": 30,
    "scheduleName": "Always",
    "affects": {
        "affectedEntityType": "TIER_NODE_TRANSACTION_PERFORMANCE",
        "affectedEntities": {
            "tierOrNode": "TIER_AFFECTED_ENTITIES",
            "affectedTiers": {
                "affectedTierScope": "TIERS_BY_TAGS",
                "tagVarPairs": [
                    {
                        "propertyType": "TAG",
                        "name": "i_app_support_org",
                        "value": "Enterprise Platforms"
                    },
                    {
                        "propertyType": "TAG",
                        "name": "i_manufacturer",
                        "value": "Cisco"
                    }
                ]
            }
        }
    },
    "evalCriterias": {
        "criticalCriteria": {
            "conditionAggregationType": "ALL",
            "conditionExpression": null,
            "conditions": [
                {
                    "name": "Condition 1",
                    "shortName": "A",
                    "evaluateToTrueOnNoData": false,
                    "evalDetail": {
                        "evalDetailType": "SINGLE_METRIC",
                        "metricAggregateFunction": "VALUE",
                        "metricPath": "Calls per Minute",
                        "metricEvalDetail": {
                            "metricEvalDetailType": "SPECIFIC_TYPE",
                            "compareCondition": "GREATER_THAN_SPECIFIC_VALUE",
                            "compareValue": 11
                        }
                    },
                    "triggerEnabled": false,
                    "minimumTriggers": 0
                }
            ],
            "evalMatchingCriteria": {
                "matchType": "ANY_NODE",
                "value": null
            }
        },
        "warningCriteria": null
    }
}

Retrieve a Health Rules for Tiers with Tags

This example retrieves a health for tiers with tags.

Resource URL

 GET <controller_url>/controller/alerting/rest/v1/applications/10/health-rules/63

{
    "id": 63,
    "name": "Health rule for tiers with tags",
    "enabled": true,
    "useDataFromLastNMinutes": 30,
    "waitTimeAfterViolation": 30,
    "scheduleName": "Always",
    "affects": {
        "affectedEntityType": "TIER_NODE_TRANSACTION_PERFORMANCE",
        "affectedEntities": {
            "tierOrNode": "TIER_AFFECTED_ENTITIES",
            "affectedTiers": {
                "affectedTierScope": "TIERS_BY_TAGS",
                "tagVarPairs": [
                    {
                        "propertyType": "TAG",
                        "name": "i_app_support_org",
                        "value": "Enterprise Platforms"
                    },
                    {
                        "propertyType": "TAG",
                        "name": "i_manufacturer",
                        "value": "Cisco"
                    }
                ]
            }
        }
    },
    "evalCriterias": {
        "criticalCriteria": {
            "conditionAggregationType": "ALL",
            "conditionExpression": null,
            "conditions": [
                {
                    "name": "Condition 1",
                    "shortName": "A",
                    "evaluateToTrueOnNoData": false,
                    "evalDetail": {
                        "evalDetailType": "SINGLE_METRIC",
                        "metricAggregateFunction": "VALUE",
                        "metricPath": "Calls per Minute",
                        "metricEvalDetail": {
                            "metricEvalDetailType": "SPECIFIC_TYPE",
                            "compareCondition": "GREATER_THAN_SPECIFIC_VALUE",
                            "compareValue": 11
                        }
                    },
                    "triggerEnabled": false,
                    "minimumTriggers": 0
                }
            ],
            "evalMatchingCriteria": {
                "matchType": "ANY_NODE",
                "value": null
            }
        },
        "warningCriteria": null
    }
}

Create a Health Rule for Servers with Tags

This example creates a health for servers with tags.

Resource URL

 POST <controller_url>/controller/alerting/rest/v1/applications/3/health-rules/

Request

{
    "name": "Health rule for servers with tags",
    "enabled": true,
    "useDataFromLastNMinutes": 30,
    "waitTimeAfterViolation": 30,
    "scheduleName": "Always",
    "affects": {
        "affectedEntityType": "SERVERS",
        "serverSelectionCriteria": {
            "selectServersBy": "AFFECTED_SERVERS",
            "affectedServers": {
                "severSelectionScope": "SERVERS_BY_TAGS",
                "tagVarPairs": [
                    {
                        "propertyType": "TAG",
                        "name": "i_app_support_org",
                        "value": "Enterprise Platforms"
                    },
                    {
                        "propertyType": "TAG",
                        "name": "i_manufacturer",
                        "value": "Cisco"
                    }
                ]
            }
        }
    },
    "evalCriterias": {
        "criticalCriteria": {
            "conditionAggregationType": "ALL",
            "conditionExpression": null,
            "conditions": [
                {
                    "name": "Condition 1",
                    "shortName": "A",
                    "evaluateToTrueOnNoData": false,
                    "evalDetail": {
                        "evalDetailType": "SINGLE_METRIC",
                        "metricAggregateFunction": "VALUE",
                        "metricPath": "Hardware Resources|CPU|%Busy",
                        "metricEvalDetail": {
                            "metricEvalDetailType": "SPECIFIC_TYPE",
                            "compareCondition": "GREATER_THAN_SPECIFIC_VALUE",
                            "compareValue": 5
                        }
                    },
                    "triggerEnabled": false,
                    "minimumTriggers": 0
                }
            ],
            "evalMatchingCriteria": null
        },
        "warningCriteria": null
    }
}

Response

{
    "id": 64,
    "name": "Health rule for servers with tags",
    "enabled": true,
    "useDataFromLastNMinutes": 30,
    "waitTimeAfterViolation": 30,
    "scheduleName": "Always",
    "affects": {
        "affectedEntityType": "SERVERS",
        "serverSelectionCriteria": {
            "selectServersBy": "AFFECTED_SERVERS",
            "affectedServers": {
                "severSelectionScope": "SERVERS_BY_TAGS",
                "tagVarPairs": [
                    {
                        "propertyType": "TAG",
                        "name": "i_app_support_org",
                        "value": "Enterprise Platforms"
                    },
                    {
                        "propertyType": "TAG",
                        "name": "i_manufacturer",
                        "value": "Cisco"
                    }
                ]
            }
        }
    },
    "evalCriterias": {
        "criticalCriteria": {
            "conditionAggregationType": "ALL",
            "conditionExpression": null,
            "conditions": [
                {
                    "name": "Condition 1",
                    "shortName": "A",
                    "evaluateToTrueOnNoData": false,
                    "evalDetail": {
                        "evalDetailType": "SINGLE_METRIC",
                        "metricAggregateFunction": "VALUE",
                        "metricPath": "Hardware Resources|CPU|%Busy",
                        "metricEvalDetail": {
                            "metricEvalDetailType": "SPECIFIC_TYPE",
                            "compareCondition": "GREATER_THAN_SPECIFIC_VALUE",
                            "compareValue": 5
                        }
                    },
                    "triggerEnabled": false,
                    "minimumTriggers": 0
                }
            ],
            "evalMatchingCriteria": null
        },
        "warningCriteria": null
    }
}

Retrieve a Health Rule for Servers with Tags

This example retrieves a health for servers with tags.

Resource URL

 GET <controller_url>/controller/alerting/rest/v1/applications/3/health-rules/64

{
    "id": 64,
    "name": "Health rule for servers with tags",
    "enabled": true,
    "useDataFromLastNMinutes": 30,
    "waitTimeAfterViolation": 30,
    "scheduleName": "Always",
    "affects": {
        "affectedEntityType": "SERVERS",
        "serverSelectionCriteria": {
            "selectServersBy": "AFFECTED_SERVERS",
            "affectedServers": {
                "severSelectionScope": "SERVERS_BY_TAGS",
                "tagVarPairs": [
                    {
                        "propertyType": "TAG",
                        "name": "i_app_support_org",
                        "value": "Enterprise Platforms"
                    },
                    {
                        "propertyType": "TAG",
                        "name": "i_manufacturer",
                        "value": "Cisco"
                    }
                ]
            }
        }
    },
    "evalCriterias": {
        "criticalCriteria": {
            "conditionAggregationType": "ALL",
            "conditionExpression": null,
            "conditions": [
                {
                    "name": "Condition 1",
                    "shortName": "A",
                    "evaluateToTrueOnNoData": false,
                    "evalDetail": {
                        "evalDetailType": "SINGLE_METRIC",
                        "metricAggregateFunction": "VALUE",
                        "metricPath": "Hardware Resources|CPU|%Busy",
                        "metricEvalDetail": {
                            "metricEvalDetailType": "SPECIFIC_TYPE",
                            "compareCondition": "GREATER_THAN_SPECIFIC_VALUE",
                            "compareValue": 5
                        }
                    },
                    "triggerEnabled": false,
                    "minimumTriggers": 0
                }
            ],
            "evalMatchingCriteria": null
        },
        "warningCriteria": null
    }
}

Create a Health Rule for Base Pages with Tags

This example creates a health for base pages with tags.

Resource URL

 POST <controller_url>/controller/alerting/rest/v1/applications/16/health-rules/

Request

{
    "name": "Health rule for base pages with tags",
    "enabled": true,
    "useDataFromLastNMinutes": 1,
    "waitTimeAfterViolation": 30,
    "scheduleName": "Always",
    "affects": {
        "affectedEntityType": "EUM_BROWSER_APPS",
        "affectedEntities": {
            "affectedEumEntityType": "EUM_PAGES",
            "affectedPages": {
                "affectedPageScope": "PAGES_BY_TAGS",
                "tagVarPairs": [
                    {
                        "propertyType": "TAG",
                        "name": "i_app_support_org",
                        "value": "Enterprise Platforms"
                    },
                    {
                        "propertyType": "TAG",
                        "name": "i_manufacturer",
                        "value": "Cisco"
                    }
                ]
            }
        }
    },
    "evalCriterias": {
        "criticalCriteria": {
            "conditionAggregationType": "ALL",
            "conditionExpression": null,
            "conditions": [
                {
                    "name": "Condition 1",
                    "shortName": "A",
                    "evaluateToTrueOnNoData": false,
                    "violationStatusOnNoData": "UNKNOWN",
                    "evalDetail": {
                        "evalDetailType": "SINGLE_METRIC",
                        "metricAggregateFunction": "VALUE",
                        "metricPath": "Application Server Time (ms)",
                        "metricEvalDetail": {
                            "metricEvalDetailType": "SPECIFIC_TYPE",
                            "compareCondition": "GREATER_THAN_SPECIFIC_VALUE",
                            "compareValue": 1
                        }
                    },
                    "triggerEnabled": false,
                    "minimumTriggers": 1
                }
            ],
            "evalMatchingCriteria": null
        },
        "warningCriteria": null
    }
}

Response

{
    "id": 37,
    "name": "Health rule for base pages with tags",
    "enabled": true,
    "useDataFromLastNMinutes": 1,
    "waitTimeAfterViolation": 30,
    "scheduleName": "Always",
    "affects": {
        "affectedEntityType": "EUM_BROWSER_APPS",
        "affectedEntities": {
            "affectedEumEntityType": "EUM_PAGES",
            "affectedPages": {
                "affectedPageScope": "PAGES_BY_TAGS",
                "tagVarPairs": [
                    {
                        "propertyType": "TAG",
                        "name": "i_app_support_org",
                        "value": "Enterprise Platforms"
                    },
                    {
                        "propertyType": "TAG",
                        "name": "i_manufacturer",
                        "value": "Cisco"
                    }
                ]
            }
        }
    },
    "evalCriterias": {
        "criticalCriteria": {
            "conditionAggregationType": "ALL",
            "conditionExpression": null,
            "conditions": [
                {
                    "name": "Condition 1",
                    "shortName": "A",
                    "evaluateToTrueOnNoData": false,
                    "violationStatusOnNoData": "UNKNOWN",
                    "evalDetail": {
                        "evalDetailType": "SINGLE_METRIC",
                        "metricAggregateFunction": "VALUE",
                        "metricPath": "Application Server Time (ms)",
                        "metricEvalDetail": {
                            "metricEvalDetailType": "SPECIFIC_TYPE",
                            "compareCondition": "GREATER_THAN_SPECIFIC_VALUE",
                            "compareValue": 1
                        }
                    },
                    "triggerEnabled": false,
                    "minimumTriggers": 1
                }
            ],
            "evalMatchingCriteria": null
        },
        "warningCriteria": null
    }
}

Retrieve a Health Rule for Base Pages with Tags

This example retrieves a health for base pages with tags.

Resource URL

 GET <controller_url>/controller/alerting/rest/v1/applications/16/health-rules/37

{
    "id": 37,
    "name": "Health rule for base pages with tags",
    "enabled": true,
    "useDataFromLastNMinutes": 1,
    "waitTimeAfterViolation": 30,
    "scheduleName": "Always",
    "affects": {
        "affectedEntityType": "EUM_BROWSER_APPS",
        "affectedEntities": {
            "affectedEumEntityType": "EUM_PAGES",
            "affectedPages": {
                "affectedPageScope": "PAGES_BY_TAGS",
                "tagVarPairs": [
                    {
                        "propertyType": "TAG",
                        "name": "i_app_support_org",
                        "value": "Enterprise Platforms"
                    },
                    {
                        "propertyType": "TAG",
                        "name": "i_manufacturer",
                        "value": "Cisco"
                    }
                ]
            }
        }
    },
    "evalCriterias": {
        "criticalCriteria": {
            "conditionAggregationType": "ALL",
            "conditionExpression": null,
            "conditions": [
                {
                    "name": "Condition 1",
                    "shortName": "A",
                    "evaluateToTrueOnNoData": false,
                    "violationStatusOnNoData": "UNKNOWN",
                    "evalDetail": {
                        "evalDetailType": "SINGLE_METRIC",
                        "metricAggregateFunction": "VALUE",
                        "metricPath": "Application Server Time (ms)",
                        "metricEvalDetail": {
                            "metricEvalDetailType": "SPECIFIC_TYPE",
                            "compareCondition": "GREATER_THAN_SPECIFIC_VALUE",
                            "compareValue": 1
                        }
                    },
                    "triggerEnabled": false,
                    "minimumTriggers": 1
                }
            ],
            "evalMatchingCriteria": null
        },
        "warningCriteria": null
    }
}

Download Swagger YAML spec

Download the Swagger YAML spec health_rule_openapi.yml.

Documentation

Health Rule API

Create a Health Rule

Resource URL

Request/Response Format

Example

Retrieve a List of Health Rules for an Application

Resource URL

Response Format

Example Response

Retrieve Details of a Specified Health Rule

Resource URL

Response Format

Example Response

Update a Health Rule

Resource URL

Request/Response Format

Example

Delete a Health Rule

Resource URL

Update a Health Rule Configuration

Resource URL

Request/Response Format

Example

Enable All Health Rules

Resource URL

Disable All Health Rules

Resource URL

Response Codes

Property Details

HealthRule

HealthRuleSummaryArray

HealthRuleConfiguration

MetricEvalDetail

BaselineMetricEvalDetail

SpecificValueMetricEvalDetail

MetricAggregateFunction

SingleMetricEvalDetail

MetricExpressionEvalDetail

MetricDetailWithVariableName

NodeEvalMatchingCriteria

Condition

ConditionEvalDetail

Criteria

EntityMatchingPattern

AffectedTiers

AllTiers

SpecificTiers

TiersByTags

AffectedNodes

AffectedNodes

AllNodes

SpecificNodes

NodesOfSpecificTiers

NodesMatchingPattern

NodePropertyVariableMatcher

OverallApplicationPerformance

BusinessTransactionPerformance

AffectedBusinessTransactions

AllBusinessTransactions

SpecificBusinessTransactions

BusinessTransactionsInSpecificTiers

BusinessTransactionsMatchingPattern

BUSINESS_TRANSACTIONS_BY_TAGS

TierNodeTransactionPerformance

AffectedTierOrNodeEntities

TierAffectedEntities

NodeAffectedEntities

TierNodeHardware

ServersInApplication

ApplicationAffectedServers

AllServersInApplication

SpecificServersInApplication

AllServersInSpecificTiers

ApmServersByTags

Backends

AffectedBackends

AllBackends

SpecificBackends

BackendsMatchingPattern