Create User Defined Event

Create User Defined Event

Add new User-Defined event.

Request
URI
POST
https://{api_host}/api/ni/settings/events/user-defined-events
COPY
Request Body

Add new User-Defined events

SubscriptionRequest of type(s) application/json
Required 
{
    "event_name": "string",
    "is_problem": false,
    "severity": "string",
    "search_criteria": "string",
    "generate_event_criteria": "string",
    "email_frequency": "string",
    "daily_at_utc": "string",
    "email_ids": [
        "string"
    ],
    "snmp_trap_entity_ids": [
        "string"
    ],
    "notification_settings": [
        {
            "type": "string",
            "frequency": "string",
            "notification_time": "string",
            "receivers": [
                "string"
            ],
            "enabled": false
        }
    ]
}
string
event_name
Optional

event_name

boolean
is_problem
Optional

is_problem

string
severity
Optional

severity

string
search_criteria
Optional

search_criteria

GenerateEventCritera
generate_event_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,
EmailFrequency
email_frequency
Optional

email_frequency

Possible values are : IMMEDIATELY, DAILY_DIGEST,
string
daily_at_utc
Optional

daily_at_utc

array of string
email_ids
Optional

email_ids

array of string
snmp_trap_entity_ids
Optional

snmp_trap_entity_ids

array of NotificationSetting
notification_settings
Optional

Notifications configured for alerts corresponding to this alert configuration.

Authentication
This operation uses the following authentication methods.
Responses
201

Success

Returns SubscriptionResponse of type(s) application/json 
{
    "entity_id": "string",
    "active": false,
    "event_name": "string",
    "is_problem": false,
    "severity": "string",
    "search_criteria": "string",
    "generate_event_criteria": "string",
    "email_frequency": "string",
    "daily_at_utc": "string",
    "email_ids": [
        "string"
    ],
    "snmp_trap_entity_ids": [
        "string"
    ],
    "notification_settings": [
        {
            "type": "string",
            "frequency": "string",
            "notification_time": "string",
            "receivers": [
                "string"
            ],
            "enabled": false
        }
    ]
}
string
entity_id
Optional

entity_id

boolean
active
Optional

active

string
event_name
Optional

event_name

boolean
is_problem
Optional

is_problem

Severity
severity
Optional

severity

Possible values are : Critical, Moderate, Warning, Info,
string
search_criteria
Optional

search_criteria

GenerateEventCritera
generate_event_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,
EmailFrequency
email_frequency
Optional

email_frequency

Possible values are : IMMEDIATELY, DAILY_DIGEST,
string
daily_at_utc
Optional

daily_at_utc

array of string
email_ids
Optional

email_ids

array of string
snmp_trap_entity_ids
Optional

snmp_trap_entity_ids

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": 0,
    "message": "string",
    "details": [
        {
            "code": 0,
            "message": "string",
            "target": [
                "string"
            ]
        }
    ]
}
integer As int32 As int32
code
Optional

code

string
message
Optional

message

array of ErrorDetail
details
Optional

details


401

Unauthorized

Returns ApiError of type(s) application/json 
{
    "code": 0,
    "message": "string",
    "details": [
        {
            "code": 0,
            "message": "string",
            "target": [
                "string"
            ]
        }
    ]
}
integer As int32 As int32
code
Optional

code

string
message
Optional

message

array of ErrorDetail
details
Optional

details


403

Forbidden

Returns ApiError of type(s) application/json 
{
    "code": 0,
    "message": "string",
    "details": [
        {
            "code": 0,
            "message": "string",
            "target": [
                "string"
            ]
        }
    ]
}
integer As int32 As int32
code
Optional

code

string
message
Optional

message

array of ErrorDetail
details
Optional

details


500

Internal Error

Returns ApiError of type(s) application/json 
{
    "code": 0,
    "message": "string",
    "details": [
        {
            "code": 0,
            "message": "string",
            "target": [
                "string"
            ]
        }
    ]
}
integer As int32 As int32
code
Optional

code

string
message
Optional

message

array of ErrorDetail
details
Optional

details


Deprecated
On This Page
Settings Operations
POST
Activate Serial Number
POST
Add new SNMP Trap destination profile
POST
Add Backup Config
POST
Add Ip Tag
Deprecated
POST
Add Login Banner
POST
Add Restore Config
POST
Add Search Based Alert Config
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
Deprecated
DELETE
Deactivate Serial Number
DELETE
Delete An existing SNMP Trap destination profile
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 User
DELETE
Delete User Defined Event
Deprecated
DELETE
Delete User Group
DELETE
Delete Vidm Configuration
DELETE
Delete Web Proxy
POST
Disable Search Based Alert Config
POST
Disable User Defined Event
Deprecated
POST
Disable Vidm
POST
Enable Search Based Alert Config
POST
Enable User Defined Event
Deprecated
POST
Enable Vidm
GET
Get details Of An existing SNMP destination profile
GET
Get All Search Based Alert Configs
GET
Get All Subscriber
GET
Get All User Defined Events
Deprecated
GET
Get All Users
GET
Get Backup Config
GET
Get Backup Status Report
GET
Get Certificate
GET
Get Certificates Details
GET
Get Connected Clients To Web Proxy
GET
Get Infra Nodes Web Proxy
GET
Get Ip Tag
Deprecated
GET
Get Ip Tag Ids
Deprecated
GET
Get Ip Tag V2
GET
Get Licenses
GET
Get Login Banner
GET
Get Restore Config
GET
Get Restore Status Report
GET
Get Search Based Alert Config
GET
Get SNMP Engine Id
GET
Get Subnet Mappings
GET
Get Subscriber
GET
Get Tag Ids V2
GET
Get User
GET
Get User Defined Event
Deprecated
GET
Get User Group
GET
Get User Groups
GET
Get Users
GET
Get Vidm Configuration
GET
Get Web Proxies
GET
Get Web Proxy
GET
List the configured SNMP Trap destination profiles
POST
Migrate event subscriptions To other SNMP Trap destination profiles
POST
Remove Ip Tag
Deprecated
POST
Remove Tag V2
POST
Save Vidm Configuration
POST
Send Test trap To SNMP destination profile
PUT
Update An existing SNMP destination profile
PUT
Update user password
PUT
Update Backup Config
PUT
Update Login Banner
PUT
Update Search Based Alert Config
PUT
Update SNMP Engine Id
PUT
Update Subnet Mapping
PUT
Update Subscriber
PUT
Update User Defined Event
Deprecated
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