> Action object

The following objects are directly related to the action API.

Action

The action object has the following properties.

PropertyTypeDescription
actionidstring(readonly) ID of the action.
esc_period
(required)
stringDefault operation step duration. Must be greater than 60 seconds. Accepts seconds, time unit with suffix and user macro.

Note that escalations are supported only for trigger and internal actions. In trigger actions, escalations are not supported in problem recovery and update operations.
eventsource
(required)
integer(constant) Type of events that the action will handle.

Refer to the event “source” property for a list of supported event types.
name
(required)
stringName of the action.
statusintegerWhether the action is enabled or disabled.

Possible values:
0 - (default) enabled;
1 - disabled.
pause_suppressedintegerWhether to pause escalation during maintenance periods or not.

Possible values:
0 - Don’t pause escalation;
1 - (default) Pause escalation.

Note that this parameter is valid for trigger actions only.

Action operation

The action operation object defines an operation that will be performed when an action is executed. It has the following properties.

PropertyTypeDescription
operationidstring(readonly) ID of the action operation.
operationtype
(required)
integerType of operation.

Possible values:
0 - send message;
1 - remote command;
2 - add host;
3 - remove host;
4 - add to host group;
5 - remove from host group;
6 - link to template;
7 - unlink from template;
8 - enable host;
9 - disable host;
10 - set host inventory mode.

Note that only types ‘0’ and ‘1’ are supported for trigger actions, only ‘0’ is supported for internal actions. All types are supported for discovery and autoregistration actions.
actionidstringID of the action that the operation belongs to.
esc_periodstringDuration of an escalation step in seconds. Must be greater than 60 seconds. Accepts seconds, time unit with suffix and user macro. If set to 0 or 0s, the default action escalation period will be used.

Default: 0s.

Note that escalations are supported only for trigger and internal actions. In trigger actions, escalations are not supported in problem recovery and update operations.
esc_step_fromintegerStep to start escalation from.

Default: 1.

Note that escalations are supported only for trigger and internal actions. In trigger actions, escalations are not supported in problem recovery and update operations.
esc_step_tointegerStep to end escalation at.

Default: 1.

Note that escalations are supported only for trigger and internal actions. In trigger actions, escalations are not supported in problem recovery and update operations.
evaltypeintegerOperation condition evaluation method.

Possible values:
0 - (default) AND / OR;
1 - AND;
2 - OR.
opcommandobjectObject containing the data about the command run by the operation.

The operation command object is described in detail below.

Required for remote command operations.
opcommand_grparrayHost groups to run remote commands on.

Each object has the following properties:
opcommand_grpid - (string, readonly) ID of the object;
operationid - (string) ID of the operation;
groupid - (string) ID of the host group.

Required for remote command operations if opcommand_hst is not set.
opcommand_hstarrayHost to run remote commands on.

Each object has the following properties:
opcommand_hstid - (string, readonly) ID of the object;
operationid - (string) ID of the operation;
hostid - (string) ID of the host; if set to 0 the command will be run on the current host.

Required for remote command operations if opcommand_grp is not set.
opconditionsarrayOperation conditions used for trigger actions.

The operation condition object is described in detail below.
opgrouparrayHost groups to add hosts to.

Each object has the following properties:
operationid - (string) ID of the operation;
groupid - (string) ID of the host group.

Required for “add to host group” and “remove from host group” operations.
opmessageobjectObject containing the data about the message sent by the operation.

The operation message object is described in detail below.

Required for message operations.
opmessage_grparrayUser groups to send messages to.

Each object has the following properties:
operationid - (string) ID of the operation;
usrgrpid - (string) ID of the user group.

Required for message operations if opmessage_usr is not set.
opmessage_usrarrayUsers to send messages to.

Each object has the following properties:
operationid - (string) ID of the operation;
userid - (string) ID of the user.

Required for message operations if opmessage_grp is not set.
optemplatearrayTemplates to link the hosts to to.

Each object has the following properties:
operationid - (string) ID of the operation;
templateid - (string) ID of the template.

Required for “link to template” and “unlink from template” operations.
opinventoryobjectInventory mode set host to.

Object has the following properties:
operationid - (string) ID of the operation;
inventory_mode - (string) Inventory mode.

Required for “Set host inventory mode” operations.

Action operation command

The operation command object contains data about the command that will be run by the operation.

PropertyTypeDescription
commandstringCommand to run. Required when type IN (0,1,2,3)
type
(required)
integerType of operation command.

Possible values:
0 - custom script;
1 - IPMI;
2 - SSH;
3 - Telnet;
4 - global script.
authtypeintegerAuthentication method used for SSH commands.

Possible values:
0 - password;
1 - public key.

Required for SSH commands.
execute_onintegerTarget on which the custom script operation command will be executed.

Possible values:
0 - Zabbix agent;
1 - Zabbix server;
2 - Zabbix server (proxy).

Required for custom script commands.
passwordstringPassword used for SSH commands with password authentication and Telnet commands.
portstringPort number used for SSH and Telnet commands.
privatekeystringName of the private key file used for SSH commands with public key authentication.

Required for SSH commands with public key authentication.
publickeystringName of the public key file used for SSH commands with public key authentication.

Required for SSH commands with public key authentication.
scriptidstringID of the script used for global script commands.

Required for global script commands.
usernamestringUser name used for authentication.

Required for SSH and Telnet commands.

Action operation message

The operation message object contains data about the message that will be sent by the operation.

PropertyTypeDescription
default_msgintegerWhether to use the default action message text and subject.

Possible values:
0 - use the data from the operation;
1 - (default) use the data from the media type.
mediatypeidstringID of the media type that will be used to send the message.
messagestringOperation message text.
subjectstringOperation message subject.

Action operation condition

The action operation condition object defines a condition that must be met to perform the current operation. It has the following properties.

PropertyTypeDescription
opconditionidstring(readonly) ID of the action operation condition
conditiontype
(required)
integerType of condition.

Possible values:
14 - event acknowledged.
value
(required)
stringValue to compare with.
operationidstring(readonly) ID of the operation.
operatorintegerCondition operator.

Possible values:
0 - (default) =.

The following operators and values are supported for each operation condition type.

ConditionCondition nameSupported operatorsExpected value
14Event acknowledged=Whether the event is acknowledged.

Possible values:
0 - not acknowledged;
1 - acknowledged.

Action recovery operation

The action recovery operation object defines an operation that will be performed when a problem is resolved. Recovery operations are possible for trigger actions and internal actions. It has the following properties.

PropertyTypeDescription
operationidstring(readonly) ID of the action operation.
operationtype
(required)
integerType of operation.

Possible values for trigger actions:
0 - send message;
1 - remote command;
11 - notify all involved.

Possible values for internal actions:
0 - send message;
11 - notify all involved.
actionidstringID of the action that the recovery operation belongs to.
opcommandobjectObject containing the data about the command run by the recovery operation.

The operation command object is described in detail above.

Required for remote command operations.
opcommand_grparrayHost groups to run remote commands on.

Each object has the following properties:
opcommand_grpid - (string, readonly) ID of the object;
operationid - (string) ID of the operation;
groupid - (string) ID of the host group.

Required for remote command operations if opcommand_hst is not set.
opcommand_hstarrayHost to run remote commands on.

Each object has the following properties:
opcommand_hstid - (string, readonly) ID of the object;
operationid - (string) ID of the operation;
hostid - (string) ID of the host; if set to 0 the command will be run on the current host.

Required for remote command operations if opcommand_grp is not set.
opmessageobjectObject containing the data about the message sent by the recovery operation.

The operation message object is described in detail above.

Required for message operations.
opmessage_grparrayUser groups to send messages to.

Each object has the following properties:
operationid - (string) ID of the operation;
usrgrpid - (string) ID of the user group.

Required for message operations if opmessage_usr is not set.
opmessage_usrarrayUsers to send messages to.

Each object has the following properties:
operationid - (string) ID of the operation;
userid - (string) ID of the user.

Required for message operations if opmessage_grp is not set.

Action update operation

The action update operation object defines an operation that will be performed when a problem is updated (commented upon, acknowledged, severity changed, or manually closed). Update operations are possible for trigger actions. It has the following properties.

PropertyTypeDescription
operationidstring(readonly) ID of the action operation.
operationtype
(required)
integerType of operation.

Possible values for trigger actions:
0 - send message;
1 - remote command;
12 - notify all involved.
opcommandobjectObject containing the data about the command run by the update operation.

The operation command object is described in detail above.

Required for remote command operations.
opcommand_grparrayHost groups to run remote commands on.

Each object has the following properties:
groupid - (string) ID of the host group.

Required for remote command operations if opcommand_hst is not set.
opcommand_hstarrayHost to run remote commands on.

Each object has the following properties:
hostid - (string) ID of the host; if set to 0 the command will be run on the current host.

Required for remote command operations if opcommand_grp is not set.
opmessageobjectObject containing the data about the message sent by the update operation.

The operation message object is described in detail above.
opmessage_grparrayUser groups to send messages to.

Each object has the following properties:
usrgrpid - (string) ID of the user group.

Required only for send message operations if opmessage_usr is not set.
Is ignored for send update message operations.
opmessage_usrarrayUsers to send messages to.

Each object has the following properties:
userid - (string) ID of the user.

Required only for send message operations if opmessage_grp is not set.
Is ignored for send update message operations.

Action filter

The action filter object defines a set of conditions that must be met to perform the configured action operations. It has the following properties.

PropertyTypeDescription
conditions
(required)
arraySet of filter conditions to use for filtering results.
evaltype
(required)
integerFilter condition evaluation method.

Possible values:
0 - and/or;
1 - and;
2 - or;
3 - custom expression.
eval_formulastring(readonly) Generated expression that will be used for evaluating filter conditions. The expression contains IDs that reference specific filter conditions by its formulaid. The value of eval_formula is equal to the value of formula for filters with a custom expression.
formulastringUser-defined expression to be used for evaluating conditions of filters with a custom expression. The expression must contain IDs that reference specific filter conditions by its formulaid. The IDs used in the expression must exactly match the ones defined in the filter conditions: no condition can remain unused or omitted.

Required for custom expression filters.

Action filter condition

The action filter condition object defines a specific condition that must be checked before running the action operations.

PropertyTypeDescription
conditionidstring(readonly) ID of the action condition.
conditiontype
(required)
integerType of condition.

Possible values for trigger actions:
0 - host group;
1 - host;
2 - trigger;
3 - trigger name;
4 - trigger severity;
6 - time period;
13 - host template;
15 - application;
16 - problem is suppressed;
25 - event tag;
26 - event tag value.

Possible values for discovery actions:
7 - host IP;
8 - discovered service type;
9 - discovered service port;
10 - discovery status;
11 - uptime or downtime duration;
12 - received value;
18 - discovery rule;
19 - discovery check;
20 - proxy;
21 - discovery object.

Possible values for autoregistration actions:
20 - proxy;
22 - host name;
24 - host metadata.

Possible values for internal actions:
0 - host group;
1 - host;
13 - host template;
15 - application;
23 - event type.
value
(required)
stringValue to compare with.
value2
stringSecondary value to compare with. Required for trigger actions when condition type is 26.
actionidstring(readonly) ID of the action that the condition belongs to.
formulaidstringArbitrary unique ID that is used to reference the condition from a custom expression. Can only contain capital-case letters. The ID must be defined by the user when modifying filter conditions, but will be generated anew when requesting them afterward.
operatorintegerCondition operator.

Possible values:
0 - (default) equals;
1 - does not equal;
2 - contains;
3 - does not contain;
4 - in;
5 - is greater than or equals;
6 - is less than or equals;
7 - not in;
8 - matches;
9 - does not match;
10 - Yes;
11 - No.

To better understand how to use filters with various types of expressions, see examples on the action.get and action.create method pages.

The following operators and values are supported for each condition type.

ConditionCondition nameSupported operatorsExpected value
0Host groupequals,
does not equal
Host group ID.
1Hostequals,
does not equal
Host ID.
2Triggerequals,
does not equal
Trigger ID.
3Trigger namecontains,
does not contain
Trigger name.
4Trigger severityequals,
does not equal,
is greater than or equals,
is less than or equals
Trigger severity. Refer to the trigger “severity” property for a list of supported trigger severities.
5Trigger valueequalsTrigger value. Refer to the trigger “value” property for a list of supported trigger values.
6Time periodin, not inTime when the event was triggered as a time period.
7Host IPequals,
does not equal
One or several IP ranges to check separated by commas. Refer to the network discovery configuration section for more information on supported formats of IP ranges.
8Discovered service typeequals,
does not equal
Type of discovered service. The type of service matches the type of the discovery check used to detect the service. Refer to the discovery check “type” property for a list of supported types.
9Discovered service portequals,
does not equal
One or several port ranges separated by commas.
10Discovery statusequalsStatus of a discovered object.

Possible values:
0 - host or service up;
1 - host or service down;
2 - host or service discovered;
3 - host or service lost.
11Uptime or downtime durationis greater than or equals,
is less than or equals
Time indicating how long has the discovered object been in the current status in seconds.
12Received valuesequals,
does not equal,
is greater than or equals,
is less than or equals,
contains,
does not contain
Value returned when performing a Zabbix agent, SNMPv1, SNMPv2 or SNMPv3 discovery check.
13Host templateequals,
does not equal
Linked template ID.
15Applicationequals,
contains,
does not contain
Name of the application.
16Problem is suppressedYes, NoNo value required: using the “Yes” operator means that problem must be suppressed, “No” - not suppressed.
18Discovery ruleequals,
does not equal
ID of the discovery rule.
19Discovery checkequals,
does not equal
ID of the discovery check.
20Proxyequals,
does not equal
ID of the proxy.
21Discovery objectequalsType of object that triggered the discovery event.

Possible values:
1 - discovered host;
2 - discovered service.
22Host namecontains,
does not contain,
matches,
does not match
Host name.
Using a regular expression is supported for operators matches and does not match in autoregistration conditions.
23Event typeequalsSpecific internal event.

Possible values:
0 - item in “not supported” state;
1 - item in “normal” state;
2 - LLD rule in “not supported” state;
3 - LLD rule in “normal” state;
4 - trigger in “unknown” state;
5 - trigger in “normal” state.
24Host metadatacontains,
does not contain,
matches,
does not match
Metadata of the auto-registered host.
Using a regular expression is supported for operators matches and does not match.
25Tagequals,
does not equal,
contains,
does not contain
Event tag.
26Tag valueequals,
does not equal,
contains,
does not contain
Event tag value.