Filter Alarm Definitions

Filter Alarm Definitions
Get and filter Alarm Definitions

Retrieves a list of alarm definitions based on specified filter criteria. This endpoint supports filtering by feature names, severities, event types, and enabled status. The response includes detailed information about each matching alarm definition.

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

Successfully retrieved the list of alarm definitions matching the specified filter criteria. Returns a paginated list of alarm definitions, including their configuration details, severity levels, and associated metadata.

Returns AlarmDefinitionListResult of type(s) application/json
This response body class contains all of the following: ListResult , InlineAlarmDefinitionListResult1 
{
    "offset": 0,
    "number_of_results": 0,
    "total_result_count": 0,
    "total_pages": 0,
    "sort_ascending": false,
    "sort_by": "string",
    "results": [
        {
            "id": "550e8400-e29b-41d4-a716-446655440000",
            "feature_name": "nsx_manager_communication",
            "feature_display_name": "NSX Manager Communication",
            "severity": "HIGH",
            "summary": "NSX Manager is disconnected from Security Services Platform",
            "event_type": "nsx_manager_disconnected",
            "event_type_display_name": "NSX Manager Disconnected",
            "description": "Security Services Platform is disconnected from NSX Manager",
            "description_on_resolve": "Security Services Platform is connected to NSX Manager.",
            "recommended_action": "Navigate to System | NSX Managers and click on the Connected status",
            "kb_article": "http://kb-article-link",
            "release_introduced": "5.1.0",
            "event_resource_type": "nsx-manager",
            "event_resource_type_display_name": "NSX Manager",
            "enabled": true
        }
    ]
}

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.


Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/ssp/alarms/definitions
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