Filter Alarm Instances

Filter Alarm Instances
Get and filter alarm instances

Get alarm instances based on filter criteria

Request
URI
POST
https://{api_host}/ssp/alarms
COPY
Request Body
AlarmInstanceFilterRequest of type(s) application/json
Optional
This request body class requires all of the following: ListRequestParameters , InlineAlarmInstanceFilterRequest1 
{
    "site_ids": [
        "string"
    ],
    "offset": 0,
    "page_size": 0,
    "sort_ascending": false,
    "sort_by": "string",
    "severities": [
        "HIGH"
    ],
    "feature_names": [
        "string"
    ],
    "event_types": [
        "string"
    ],
    "resource_ids": [
        "string"
    ],
    "enabled": false,
    "definition_id": "string",
    "states": [
        "OPEN"
    ],
    "event_resource_types": [
        "string"
    ],
    "before": 0,
    "after": 0
}
Authentication
This operation uses the following authentication methods.
Responses
200

Successfully retrieved the list of alarm instances matching the specified filter criteria. Returns a paginated list of alarm instances, including their current state, severity, and associated metadata. The results can be filtered by various attributes such as severity, feature name, and time range.

Returns AlarmInstanceListResult of type(s) application/json
This response body class contains all of the following: ListResult , InlineAlarmInstanceListResult1 
{
    "offset": 0,
    "number_of_results": 0,
    "total_result_count": 0,
    "total_pages": 0,
    "sort_ascending": false,
    "sort_by": "string",
    "results": [
        {
            "_create_user": "string",
            "_create_time": 0,
            "_last_modified_user": "string",
            "_last_modified_time": 0,
            "_revision": 0,
            "_resource_type": "string",
            "_system_owned": false,
            "id": "string",
            "display_name": "string",
            "description": "string",
            "site_ids": [
                "string"
            ],
            "definition_id": "string",
            "feature_name": "string",
            "event_type": "string",
            "feature_display_name": "string",
            "event_type_display_name": "string",
            "severity": "HIGH",
            "summary": "string",
            "recommended_action": "string",
            "kb_article": "string",
            "event_resource_type": "string",
            "event_resource_type_display_name": "string",
            "resource_id": "string",
            "object_id": "string",
            "node_id": "string",
            "value": "string",
            "state": "OPEN",
            "suppress_duration": 0,
            "state_transitions": {
                "acknowledged": {
                    "at_time": 0,
                    "by_user": "string"
                },
                "suppressed": {
                    "at_time": 0,
                    "by_user": "string"
                },
                "raised": {
                    "at_time": 0,
                    "by_user": "string"
                },
                "resolved": {
                    "at_time": 0,
                    "by_user": "string"
                }
            }
        }
    ]
}

400

Bad Request

Returns BadRequest of type(s) application/json 
{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}
integer
error_code
Required

HTTP Status or Application error code.

string
module_name
Optional

Module where the error happened.

string
error_message
Required

Message describing the error.


401

Unauthorized

Returns Unauthorized of type(s) application/json 
{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}
integer
error_code
Required

HTTP Status or Application error code.

string
module_name
Optional

Module where the error happened.

string
error_message
Required

Message describing the error.


403

Forbidden

Returns Forbidden of type(s) application/json 
{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}
integer
error_code
Required

HTTP Status or Application error code.

string
module_name
Optional

Module where the error happened.

string
error_message
Required

Message describing the error.


412

Precondition Failed

Returns PreconditionFailed of type(s) application/json 
{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}
integer
error_code
Required

HTTP Status or Application error code.

string
module_name
Optional

Module where the error happened.

string
error_message
Required

Message describing the error.


428

Precondition Required

Returns PreconditionRequired of type(s) application/json 
{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}
integer
error_code
Required

HTTP Status or Application error code.

string
module_name
Optional

Module where the error happened.

string
error_message
Required

Message describing the error.


429

Too Many Requests

Returns TooManyRequests of type(s) application/json 
{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}
integer
error_code
Required

HTTP Status or Application error code.

string
module_name
Optional

Module where the error happened.

string
error_message
Required

Message describing the error.


500

An unexpected error occurred while processing the request. This may be due to internal system issues or invalid request parameters. Check the error response for details about the specific problem.

Returns Error of type(s) application/json 
{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}
integer
error_code
Required

HTTP Status or Application error code.

string
module_name
Optional

Module where the error happened.

string
error_message
Required

Message describing the error.


Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/ssp/alarms
On This Page
Alarms Operations
POST
Filter Alarm Definitions
GET
Get Alarm Definitions By Id
POST
Update Alarm Definition
POST
Filter Alarm Instances
POST
Update Alarm Instances States
GET
Get Alarm Instance By Id
POST
Get Alarm Counts By Category And Severity