> Trigger object

The following objects are directly related to the trigger API.

Trigger

The trigger object has the following properties.

PropertyTypeDescription
triggeridstringID of the trigger.

Property behavior:
- read-only
- required for update operations
descriptionstringName of the trigger.

Property behavior:
- required for create operations
expressionstringReduced trigger expression.

Property behavior:
- required for create operations
event_namestringEvent name generated by the trigger.
opdatastringOperational data.
commentsstringAdditional description of the trigger.
errorstringError text if there have been any problems when updating the state of the trigger.

Property behavior:
- read-only
flagsintegerOrigin of the trigger.

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

Property behavior:
- read-only
lastchangetimestampTime when the trigger last changed its state.

Property behavior:
- read-only
priorityintegerSeverity of the trigger.

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

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

Property behavior:
- read-only
statusintegerWhether the trigger is enabled or disabled.

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

Property behavior:
- read-only
typeintegerWhether the trigger can generate multiple problem events.

Possible values:
0 - (default) do not generate multiple events;
1 - generate multiple events.
urlstringURL associated with the trigger.
url_namestringLabel for the URL associated with the trigger.
valueintegerWhether the trigger is in OK or problem state.

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

Property behavior:
- read-only
recovery_modeintegerOK event generation mode.

Possible values:
0 - (default) Expression;
1 - Recovery expression;
2 - None.
recovery_expressionstringReduced trigger recovery expression.
correlation_modeintegerOK event closes.

Possible values:
0 - (default) All problems;
1 - All problems if tag values match.
correlation_tagstringTag for matching.
manual_closeintegerAllow manual close.

Possible values:
0 - (default) No;
1 - Yes.
uuidstringUniversal 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.

PropertyTypeDescription
tagstringTrigger tag name.

Property behavior:
- required
valuestringTrigger tag value.