Filter Alarm Instances

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: InlineAlarmInstanceFilterRequest0 , InlineAlarmInstanceFilterRequest1 
{
    "offset": 0,
    "page_size": 0,
    "sort_ascending": false,
    "sort_by": "string",
    "severities": [
        "string"
    ],
    "feature_names": [
        "string"
    ],
    "event_types": [
        "string"
    ],
    "resource_ids": [
        "string"
    ],
    "enabled": false,
    "definition_id": "string",
    "states": [
        "string"
    ],
    "event_resource_types": [
        "string"
    ],
    "before": 0,
    "after": 0
}
Authentication
This operation uses the following authentication methods.
Responses
200

Alarm Instance Response OK

Returns AlarmInstanceListResult of type(s) application/json
This response body class contains all of the following: InlineAlarmInstanceListResult0 , InlineAlarmInstanceListResult1 
"AlarmInstanceListResult Object"

500

Unknown Error occurred

Returns Error of type(s) application/json 
"Error Object"
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