Get Alarm Definitions 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.
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.
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.
{
"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
}
]
}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.
{
"error_code": 0,
"module_name": "string",
"error_message": "string"
}HTTP Status or Application error code.
Module where the error happened.
Message describing the error.
curl -H 'Authorization: <value>' https://{api_host}/ssp/alarms/definitions/{id}