Get Alarm Counts By Category And Severity
When invoking this API, the Alarm instances are accounted for in a map where the key is a category, by default feature name, and the value contains counts by severity. When the optional FeatureName request parameter is specified, the resulting list will only include the feature names passed along with the instance counts by severity for those features.
Show optional properties
{
"group_by": "FEATURE_NAME"
}{
"filter_match": [
"string"
],
"group_by": "FEATURE_NAME",
"before": 0,
"after": 0
}List of values to filter alarm instances by the specified group_by type. For example, if group_by is FEATURE_NAME, this list should contain feature names to filter by.
Specifies how to group alarm counts in the response:
- FEATURE_NAME - Group alarms by the feature they belong to (e.g., networking, security)
- EVENT_TYPE - Group alarms by the type of event that triggered them
Timestamp in milliseconds since epoch.
Timestamp in milliseconds since epoch.
Successfully retrieved alarm instance counts grouped by the requested criteria. Returns counts of alarm instances broken down by severity and category (feature or event type), including separate counts for open, suppressed, resolved, and acknowledged states.
{
"open_instance_counts": [
{
"categories": [
{
"category": "string",
"severity_counts": {
"severity_counts": [
{
"severity": "CRITICAL",
"count": 1
}
]
}
}
]
}
],
"suppressed_instance_counts": [
{
"categories": [
{
"category": "string",
"severity_counts": {
"severity_counts": [
{
"severity": "CRITICAL",
"count": 1
}
]
}
}
]
}
],
"resolved_instance_counts": [
{
"categories": [
{
"category": "string",
"severity_counts": {
"severity_counts": [
{
"severity": "CRITICAL",
"count": 1
}
]
}
}
]
}
],
"acknowledged_instance_counts": [
{
"categories": [
{
"category": "string",
"severity_counts": {
"severity_counts": [
{
"severity": "CRITICAL",
"count": 1
}
]
}
}
]
}
],
"total_instance_count": 0
}List of alarm counts for alarms in the OPEN state, grouped by both category and severity. These represent active alarms that require attention.
List of alarm counts for alarms in the SUPPRESSED state, grouped by both category and severity. These represent alarms that have been temporarily silenced.
List of alarm counts for alarms in the RESOLVED state, grouped by both category and severity. These represent alarms where the underlying condition has been fixed or no longer exists.
List of alarm counts for alarms in the ACKNOWLEDGED state, grouped by both category and severity. These represent alarms that have been seen and are being handled.
Total count of Alarm instances found (across all pages)
The request was invalid. This typically occurs when the filter criteria are malformed or contain invalid values. Check the error response for details about which parameters were invalid.
{
"error_code": 0,
"module_name": "string",
"error_message": "string"
}HTTP Status or Application error code.
Module where the error happened.
Message describing the error.
No alarm instances were found matching the specified filter criteria. This may indicate that there are no alarms in the system for the requested time period, features, or other filter parameters.
"Error Object"HTTP Status or Application error code.
Module where the error happened.
Message describing the error.
curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"group_by:"string"}' https://{api_host}/ssp/alarms/counts