Patch

/eventdefinitions/{id}/

This endpoint modifies an 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

Body parameters

object

severity

string

The severity of an alarm triggered by this event. INFO means no alarm is triggered.

Valid values[ "INFO", "MINOR", "MAJOR", "CRITICAL" ]

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.

time_frame

string

For rate alarms, the The time frame over which to monitor the property.

email_recipients

Array of string

Comma separated list of email recipients for alarms

string

disable_actions

boolean

Set to true to disable alert actions for the event definition.

enabled

boolean

Set to true to enable events, alarms and actions.

internal

boolean

cooldown

integer

Minimal time to wait between two consecutive events

raise_at_count

integer

Raise an alarm after a specific number of recurrences

alarm_only

boolean

Set to true for only alarms to trigger configured actions such as email and webhook. Set to false for all events of the definition to trigger the configured actions.

webhooks

Array of integer

List of webhooks IDs

integer

Responses

200

Modify Event Definition