Get Search Based Alert Config

Get Search Based Alert Config

Get details of an existing Search Based Alert Configuration (User Defined Alert Configuration).

Request
URI
GET
https://{api_host}/api/ni/settings/alerts/search-based-alerts/{id}
COPY
Path Parameters
string
id
Required

The Entity ID of object requestion information on

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns SearchBasedAlertConfigResponse of type(s) application/json 
{
    "entity_id": "string",
    "alert_name": "string",
    "enabled": false,
    "search_criteria": "string",
    "generate_alert_criteria": "string",
    "alert_type": "string",
    "severity": "string",
    "notification_settings": [
        {
            "type": "string",
            "frequency": "string",
            "notification_time": "string",
            "receivers": [
                "string"
            ],
            "enabled": false
        }
    ]
}
string
entity_id
Optional

entity_id

string
alert_name
Optional

Name of the Search based Alert Configuration.

boolean
enabled
Optional

Boolean value to depict if the Search based alert configuration is enabled.

string
search_criteria
Optional

The search query for the search-based alert configuration.

string
generate_alert_criteria
Optional

The basis of raising of alerts. It can take a value SEARCH_RESULT_CHANGE or ZERO_SEARCH_RESULTS

Possible values are : SEARCH_RESULT_CHANGE, ZERO_SEARCH_RESULTS,
string
alert_type
Optional

The type of alert. It can take a value PROBLEM or CHANGE.

Possible values are : PROBLEM, CHANGE, INTENT,
string
severity
Optional

severity

Possible values are : Critical, Moderate, Warning, Info,
array of object
notification_settings
Optional

Notifications configured for alerts corresponding to this alert configuration.


400

Bad Request

Returns ApiError of type(s) application/json 
"ApiError Object"
integer As int32 As int32
code
Optional

code

string
message
Optional

message

array of object
details
Optional

details


401

Unauthorized

Returns ApiError of type(s) application/json 
"ApiError Object"
integer As int32 As int32
code
Optional

code

string
message
Optional

message

array of object
details
Optional

details


404

Not Found

Returns ApiError of type(s) application/json 
"ApiError Object"
integer As int32 As int32
code
Optional

code

string
message
Optional

message

array of object
details
Optional

details


500

Internal Error

Operation doesn't return any data structure

Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/api/ni/settings/alerts/search-based-alerts/{id}
On This Page
Settings Operations
GET
Get Ip Tag Ids
Deprecated
GET
Get Ip Tag
Deprecated
POST
Add Ip Tag
Deprecated
POST
Remove Ip Tag
Deprecated
GET
Get Tag Ids V2
GET
Get Ip Tag V2
POST
Add Tag V2
POST
Remove Tag V2
GET
Get Subnet Mappings
POST
Create Subnet Mapping
PUT
Update Subnet Mapping
DELETE
Delete Subnet Mapping
GET
Get Certificate
GET
Get Vidm Configuration
PUT
Update Vidm Configuration
POST
Save Vidm Configuration
DELETE
Delete Vidm Configuration
POST
Enable Vidm
POST
Disable Vidm
PUT
Update Vidm User Group Role
POST
Add Vidm User Group
GET
Get User Groups
GET
Get User Group
DELETE
Delete User Group
PUT
Update Vidm User Role
POST
Add Vidm User
GET
Get Users
GET
Get All Users
GET
Get User
DELETE
Delete User
PUT
Update user password
GET
Get Web Proxies
POST
Add Web Proxy
GET
Get Web Proxy
PUT
Update Web Proxy
DELETE
Delete Web Proxy
POST
Validate Connections Via Web Proxy
POST
Validate Web Proxy Migration
GET
Get Connected Clients To Web Proxy
GET
Get Infra Nodes Web Proxy
GET
Get SNMP Engine Id
PUT
Update SNMP Engine Id
GET
List the configured SNMP Trap destination profiles
POST
Add new SNMP Trap destination profile
POST
Send Test trap To SNMP destination profile
GET
Get details Of An existing SNMP destination profile
PUT
Update An existing SNMP destination profile
DELETE
Delete An existing SNMP Trap destination profile
POST
Migrate event subscriptions To other SNMP Trap destination profiles
GET
Get All Search Based Alert Configs
POST
Add Search Based Alert Config
POST
Enable Search Based Alert Config
POST
Disable Search Based Alert Config
GET
Get Search Based Alert Config
PUT
Update Search Based Alert Config
DELETE
Delete Search Based Alert Config
GET
Get All User Defined Events
Deprecated
POST
Create User Defined Event
Deprecated
POST
Enable User Defined Event
Deprecated
POST
Disable User Defined Event
Deprecated
GET
Get User Defined Event
Deprecated
PUT
Update User Defined Event
Deprecated
DELETE
Delete User Defined Event
Deprecated
GET
Get Backup Config
PUT
Update Backup Config
POST
Add Backup Config
DELETE
Delete Backup Config
GET
Get Backup Status Report
GET
Get Restore Config
POST
Add Restore Config
DELETE
Delete Restore Config
GET
Get Restore Status Report
GET
Get Licenses
POST
Validate Serial Number
POST
Activate Serial Number
DELETE
Deactivate Serial Number
GET
Get All Subscriber
POST
Create Subscriber
GET
Get Subscriber
PUT
Update Subscriber
DELETE
Delete Subscriber
GET
Get Certificates Details
GET
Get Login Banner
PUT
Update Login Banner
POST
Add Login Banner
DELETE
Delete Login Banner