> Trigger object

The following objects are directly related to the trigger API.

Trigger

The trigger object has the following properties.

Property Type Description
triggerid string ID of the trigger.

Property behavior:
- read-only
- required for update operations
description string Name of the trigger.

Property behavior:
- required for create operations
expression string Reduced trigger expression.

Property behavior:
- required for create operations
event_name string Event name generated by the trigger.
opdata string Operational data.
comments string Additional description of the trigger.
error string Error text if there have been any problems when updating the state of the trigger.

Property behavior:
- read-only
flags integer Origin of the trigger.

Possible values:
0 - (default) a plain trigger;
4 - a discovered trigger.

Property behavior:
- read-only
lastchange timestamp Time when the trigger last changed its state.

Property behavior:
- read-only
priority integer Severity of the trigger.

Possible values:
0 - (default) not classified;
1 - information;
2 - warning;
3 - average;
4 - high;
5 - disaster.
state integer State of the trigger.

Possible values:
0 - (default) trigger state is up to date;
1 - current trigger state is unknown.

Property behavior:
- read-only
status integer Whether the trigger is enabled or disabled.

Possible values:
0 - (default) enabled;
1 - disabled.
templateid string ID of the parent template trigger.

Property behavior:
- read-only
type integer Whether the trigger can generate multiple problem events.

Possible values:
0 - (default) do not generate multiple events;
1 - generate multiple events.
url string URL associated with the trigger.
url_name string Label for the URL associated with the trigger.
value integer Whether the trigger is in OK or problem state.

Possible values:
0 - (default) OK;
1 - problem.

Property behavior:
- read-only
recovery_mode integer OK event generation mode.

Possible values:
0 - (default) Expression;
1 - Recovery expression;
2 - None.
recovery_expression string Reduced trigger recovery expression.
correlation_mode integer OK event closes.

Possible values:
0 - (default) All problems;
1 - All problems if tag values match.
correlation_tag string Tag for matching.
manual_close integer Allow manual close.

Possible values:
0 - (default) No;
1 - Yes.
uuid string Universal unique identifier, used for linking imported triggers to already existing ones. Auto-generated, if not given.

Property behavior:
- supported if the trigger belongs to a template

Trigger tag

The trigger tag object has the following properties.

Property Type Description
tag string Trigger tag name.

Property behavior:
- required
value string Trigger tag value.