Get User Defined Event

Get details of an existing User-Defined event.

Request

URI

GET

https://vrni.example.com/api/ni/settings/events/user-defined-events/{id}

COPY

Path Parameters

string

Required

The Entity ID of object requestion information on

Authentication

This operation uses the following authentication methods.

ApiKeyAuth

Responses

200

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

string

search_criteria

Optional

search_criteria

GenerateEventCritera

generate_event_criteria

Optional

generate_event_criteria

EmailFrequency

email_frequency

Optional

email_frequency

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

404

Not Found

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