Get Alarm Instance By Id

Get Alarm Instance By Id
Get an alarm instance by ID

Retrieves a single alarm instance using its unique identifier

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

The unique identifier of the alarm instance to retrieve. This ID is generated when an alarm instance is created and is used to uniquely identify it in the system.

Authentication
This operation uses the following authentication methods.
Responses
200

Successfully retrieved the requested alarm instance by its ID. Returns detailed information about the alarm instance, including its current state, severity, associated resource details, and state transition history.

Returns AlarmInstance of type(s) application/json
This response body class contains all of the following: Resource , InlineAlarmInstance1 
{
    "_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

The request was invalid. This typically occurs when the provided alarm instance ID is not in the correct format. Verify that the ID is properly formatted and try again.

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.


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 instance ID was not found in the system. This may occur if the ID is incorrect or if the alarm instance has been deleted or archived.

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/{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