Get Alarm Definitions By Id

Get Alarm Definitions By Id
Retrieve a specific alarm definition by ID

Retrieves a single alarm definition using its unique identifier. Returns detailed configuration information about the alarm definition including its feature name, event type, severity, and other associated metadata.

Request
URI
GET
https://{api_host}/ssp/alarms/definitions/{id}
COPY
Path Parameters
string
id
Required

The unique identifier of the alarm definition to retrieve or modify. This ID is a system-generated identifier that uniquely identifies the alarm definition configuration in the system.

Authentication
This operation uses the following authentication methods.
Responses
200

Successfully retrieved the requested alarm definition by its ID. Returns the complete configuration of the alarm definition, including its feature name, event type, severity level, and all 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.


404

The specified alarm definition ID was not found in the system. This may occur if the ID is incorrect or if the alarm definition has been deleted.

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.


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 -H 'Authorization: <value>' https://{api_host}/ssp/alarms/definitions/{id}
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