Add Search Based Alert Config
Add a new Search Based Alert Configuration (User Defined Alert Configuration).
Request
URI
POST
https://vrni.example.com/api/ni/settings/alerts/search-based-alerts
COPY
Request Body
Add a new Search Based Alert Configuration
SearchBasedAlertConfigRequest of type(s) application/json
Required
{
"alert_name": "string",
"search_criteria": "string",
"generate_alert_criteria": "string",
"alert_type": "string",
"severity": "string",
"notification_settings": [
{
"type": "string",
"frequency": "string",
"notification_time": "string",
"receivers": [
"string"
],
"enabled": "boolean"
}
]
}string
alert_name
Optional
Name of the Search based Alert Configuration.
string
search_criteria
Optional
The search query for the search-based alert configuration.
array of NotificationSetting
notification_settings
Optional
Notifications configured for alerts corresponding to this alert configuration.
Responses
201
Success
Returns SearchBasedAlertConfigResponse of type(s) application/json
{
"entity_id": "string",
"alert_name": "string",
"enabled": "boolean",
"search_criteria": "string",
"generate_alert_criteria": "string",
"alert_type": "string",
"severity": "string",
"notification_settings": [
{
"type": "string",
"frequency": "string",
"notification_time": "string",
"receivers": [
"string"
],
"enabled": "boolean"
}
]
}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.
array of NotificationSetting
notification_settings
Optional
Notifications configured for alerts corresponding to this alert configuration.
400
Bad Request
Returns ApiError of type(s) application/json
{
"code": "integer",
"message": "string",
"details": [
{
"code": "integer",
"message": "string",
"target": [
"string"
]
}
]
}integer As int32 As int32
code
Optional
code
string
message
Optional
message
401
Unauthorized
Returns ApiError of type(s) application/json
{
"code": "integer",
"message": "string",
"details": [
{
"code": "integer",
"message": "string",
"target": [
"string"
]
}
]
}integer As int32 As int32
code
Optional
code
string
message
Optional
message
403
Forbidden
Returns ApiError of type(s) application/json
{
"code": "integer",
"message": "string",
"details": [
{
"code": "integer",
"message": "string",
"target": [
"string"
]
}
]
}integer As int32 As int32
code
Optional
code
string
message
Optional
message
500
Internal Error
Returns ApiError of type(s) application/json
{
"code": "integer",
"message": "string",
"details": [
{
"code": "integer",
"message": "string",
"target": [
"string"
]
}
]
}integer As int32 As int32
code
Optional
code
string
message
Optional
message
Settings Operations
POST
Add new SNMP Trap destination profile
DELETE
Delete An existing SNMP Trap destination profile
GET
Get details Of An existing SNMP destination profile
GET
List the configured SNMP Trap destination profiles
POST
Migrate event subscriptions To other SNMP Trap destination profiles
POST
Send Test trap To SNMP destination profile
PUT
Update An existing SNMP destination profile
PUT
Update user password
POST
Activate Serial Number
POST
Add Backup Config
POST
Add Ip Tag
POST
Add Login Banner
POST
Add Restore Config
POST
Add Search Based Alert Config
POST
Add Syslog Target
POST
Add Tag V2
POST
Add Vidm User
POST
Add Vidm User Group
POST
Add Web Proxy
POST
Create Subnet Mapping
POST
Create Subscriber
POST
Create User Defined Event
DELETE
Deactivate Serial Number
DELETE
Delete Backup Config
DELETE
Delete Login Banner
DELETE
Delete Restore Config
DELETE
Delete Search Based Alert Config
DELETE
Delete Subnet Mapping
DELETE
Delete Subscriber
DELETE
Delete Syslog Target
DELETE
Delete User
DELETE
Delete User Defined Event
DELETE
Delete User Group
DELETE
Delete Vidm Configuration
DELETE
Delete Web Proxy
POST
Disable Search Based Alert Config
POST
Disable User Defined Event
POST
Disable Vidm
POST
Enable Search Based Alert Config
POST
Enable User Defined Event
POST
Enable Vidm
GET
Get All Search Based Alert Configs
GET
Get All Subscriber
GET
Get All User Defined Events
GET
Get All Users
GET
Get Backup Config
GET
Get Backup Status Report
GET
Get Certificate
GET
Get Connected Clients To Web Proxy
GET
Get Infra Nodes Web Proxy
GET
Get Ip Tag
GET
Get Ip Tag Ids
GET
Get Ip Tag V2
GET
Get Licenses
GET
Get Login Banner
GET
Get Restore Config
GET
Get Restore Status Report
GET
Get SNMP Engine Id
GET
Get Search Based Alert Config
GET
Get Subnet Mappings
GET
Get Subscriber
GET
Get Syslog Mapping
GET
Get Syslog Status
GET
Get Syslog Target List
GET
Get Tag Ids V2
GET
Get User
GET
Get User Defined Event
GET
Get User Group
GET
Get User Groups
GET
Get Users
GET
Get Vidm Configuration
GET
Get Web Proxies
GET
Get Web Proxy
POST
Remove Ip Tag
POST
Remove Tag V2
POST
Save Vidm Configuration
POST
Send Syslog Test Message
PUT
Update Backup Config
PUT
Update Login Banner
PUT
Update SNMP Engine Id
PUT
Update Search Based Alert Config
PUT
Update Subnet Mapping
PUT
Update Subscriber
POST
Update Syslog Mapping
PATCH
Update Syslog Status
PUT
Update Syslog Target
PUT
Update User Defined Event
PUT
Update Vidm Configuration
PUT
Update Vidm User Group Role
PUT
Update Vidm User Role
PUT
Update Web Proxy
POST
Validate Connections Via Web Proxy
POST
Validate Serial Number
POST
Validate Web Proxy Migration