Update User Defined Event

Update an existing User-Defined event.

Request

URI

PUT

https://{api_host}/api/ni/settings/events/user-defined-events/{id}

COPY

Path Parameters

string

Required

The Entity ID of object requestion information on

Request Body

Update an existing User-Defined event.

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

string

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,

string

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 object

notification_settings

Optional

Notifications configured for alerts corresponding to this alert configuration.

Authentication

This operation uses the following authentication methods.

ApiKeyAuth

Responses

200

Success

Returns SubscriptionResponse of type(s) application/json

"SubscriptionResponse Object"

string

entity_id

Optional

entity_id

boolean

active

Optional

active

string

event_name

Optional

event_name

boolean

is_problem

Optional

is_problem

string

severity

Optional

severity

Possible values are : Critical, Moderate, Warning, Info,

string

search_criteria

Optional

search_criteria

string

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,

string

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

403

Forbidden

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 -X PUT -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/api/ni/settings/events/user-defined-events/{id}

Deprecated

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Errors

Settings Operations

GET