Get

/eventdefinitions/{id}/

This endpoint returns details of a specified event definition.

Security

HTTP

Type basic

Basic authentication using VMS user name and password

API Key: ApiToken

Header parameter nameApiToken

Send current valid API token in an Authorization header with format Api-Token .

Path parameters

id

stringRequired

Event Definition ID

Responses

200

Expand All

object

id

integer

name

string

object_type

string

event_type

string

severity

string

The severity of the alarm

trigger_on

string

For 'Object Modified' alarms: a list of values | For 'Threshold/Rate' alarms: a list of 2 members. The first is an operator like gt/ge/lte and the second is a number

trigger_off

string

For 'Object Modified' alarms: a list of values

user_modified

boolean

Did a user modify this event definition

email_recipients

Array of string

List of emails you want to notify in case this event occurs

string

property

string

Monitored property

alarm_definitions

string

A collection of properties of the alarm definition associated with the event.

action_definitions

string

Actions triggered by the event

event_message

string

Message text.

disable_actions

boolean

If true, actions are disabled.

enabled

boolean

If true, the event definition is enabled.

internal

boolean

alarm_only

boolean

When this is enabled, only alarms will lead to email and webhook actions

cooldown

integer

Minimal time to wait between two consecutive events

raise_at_count

integer

Raise an alarm after a specific number of recurrences

metadata

object

A collection of properties of the event definition.

webhooks

Array of integer

List of IDs of webhooks to be triggered by the event.

integer

Return Details of an Event Definition