[comment]: # aside:1 [comment]: # ({9103dc79-8098e93a}) # LLD rule prototype object The following objects are directly related to the `discoveryruleprototype` API. [comment]: # ({/9103dc79-8098e93a}) [comment]: # ({6e2aa0ce-0c810d05}) ### LLD rule prototype The low-level discovery rule prototype object has the following properties. |Property|[Type](/manual/api/reference_commentary#data-types)|Description| |--|--|------| |itemid|ID|ID of the LLD rule prototype.

[Property behavior](/manual/api/reference_commentary#property-behavior):
- *read-only*
- *required* for update operations| |ruleid|ID|ID of the parent LLD rule/LLD rule prototype.

[Property behavior](/manual/api/reference_commentary#property-behavior):
- *read-only*
- *required* for create operations| |delay|string|Update interval of the LLD rule prototype.

Accepts seconds or time unit with suffix (e.g., 30s, 1m, 2h, 1d) and, optionally, one or more [custom intervals](/manual/config/items/item/custom_intervals), all separated by semicolons. Custom intervals can be a mix of flexible and scheduling intervals.

Accepts user macros. If used, the value must be a single macro. Multiple macros or macros mixed with text are not supported. Flexible intervals may be written as two macros separated by a forward slash (e.g., `{$FLEX_INTERVAL}/{$FLEX_PERIOD}`).

Example:
`1h;wd1-5h9-18;{$Macro1}/1-7,00:00-24:00;0/6-7,12:00-24:00;{$Macro2}/{$Macro3}`

[Property behavior](/manual/api/reference_commentary#property-behavior):
- *required* if `type` is set to "Zabbix agent" (0), "Simple check" (3), "Zabbix internal" (5), "External check" (10), "Database monitor" (11), "IPMI agent" (12), "SSH agent" (13), "TELNET agent" (14), "JMX agent" (16), "HTTP agent" (19), "SNMP agent" (20), "Script" (21), "Browser" (22), or if `type` is set to "Zabbix agent (active)" (7) and `key_` does not contain "mqtt.get"| |hostid|ID|ID of the host that the LLD rule prototype belongs to.

[Property behavior](/manual/api/reference_commentary#property-behavior):
- *constant*
- *required* for create operations| |flags|integer|[Origin](/manual/api/reference_commentary#entity-origin-flags) of the LLD rule prototype.

Possible values:
3 - a low-level discovery rule prototype;
7 - a discovered low-level discovery rule prototype.

[Property behavior](/manual/api/reference_commentary#property-behavior):
- *read-only*| |interfaceid|ID|ID of the LLD rule prototype's host interface.

[Property behavior](/manual/api/reference_commentary#property-behavior):
- *required* if LLD rule prototype belongs to host and `type` is set to "Zabbix agent", "IPMI agent", "JMX agent", or "SNMP agent"
- *supported* if LLD rule prototype belongs to host and `type` is set to "Simple check", "External check", "SSH agent", "TELNET agent", or "HTTP agent"| |key\_|string|LLD rule prototype key. At least one LLD macro is required.

[Property behavior](/manual/api/reference_commentary#property-behavior):
- *required* for create operations
- *read-only* for inherited objects| |name|string|Name of the LLD rule prototype.

[Property behavior](/manual/api/reference_commentary#property-behavior):
- *required* for create operations
- *read-only* for inherited objects| |type|integer|Type of the LLD rule prototype.

Possible values:
0 - Zabbix agent;
2 - Zabbix trapper;
3 - Simple check;
5 - Zabbix internal;
7 - Zabbix agent (active);
10 - External check;
11 - Database monitor;
12 - IPMI agent;
13 - SSH agent;
14 - TELNET agent;
16 - JMX agent;
18 - Dependent item;
19 - HTTP agent;
20 - SNMP agent;
21 - Script;
22 - Browser;
23 - Nested.

[Property behavior](/manual/api/reference_commentary#property-behavior):
- *required* for create operations
- *read-only* for inherited objects| |url|string|URL string.
Supports user macros, {HOST.IP}, {HOST.CONN}, {HOST.DNS}, {HOST.HOST}, {HOST.NAME}, {HOST.PORT}, {ITEM.ID}, {ITEM.KEY}.

[Property behavior](/manual/api/reference_commentary#property-behavior):
- *required* if `type` is set to "HTTP agent"
- *read-only* for inherited objects| |allow\_traps|integer|Allow to populate value similarly to the trapper item.

Possible values:
0 - *(default)* Do not allow to accept incoming data;
1 - Allow to accept incoming data.

[Property behavior](/manual/api/reference_commentary#property-behavior):
- *supported* if `type` is set to "HTTP agent"| |authtype|integer|Authentication method.

Possible values if `type` is set to "SSH agent":
0 - *(default)* password;
1 - public key.

Possible values if `type` is set to "HTTP agent":
0 - *(default)* none;
1 - basic;
2 - NTLM.

[Property behavior](/manual/api/reference_commentary#property-behavior):
- *supported* if `type` is set to "SSH agent" or "HTTP agent"
- *read-only* for inherited objects (if `type` is set to "HTTP agent")| |description|string|Description of the LLD rule prototype.| |error|string|Error text if there are problems updating the LLD rule prototype value.

[Property behavior](/manual/api/reference_commentary#property-behavior):
- *read-only*| |follow\_redirects|integer|Follow response redirects while polling data.

Possible values:
0 - Do not follow redirects;
1 - *(default)* Follow redirects.

[Property behavior](/manual/api/reference_commentary#property-behavior):
- *supported* if `type` is set to "HTTP agent"
- *read-only* for inherited objects| |headers|array|Array of [headers](#http-header) that will be sent when performing an HTTP request.

[Property behavior](/manual/api/reference_commentary#property-behavior):
- *supported* if `type` is set to "HTTP agent"
- *read-only* for inherited objects| |http\_proxy|string|HTTP(S) proxy connection string.

[Property behavior](/manual/api/reference_commentary#property-behavior):
- *supported* if `type` is set to "HTTP agent"
- *read-only* for inherited objects| |ipmi\_sensor|string|IPMI sensor.

[Property behavior](/manual/api/reference_commentary#property-behavior):
- *required* if `type` is set to "IPMI agent" and `key_` is not set to "ipmi.get"
- *supported* if `type` is set to "IPMI agent"
- *read-only* for inherited objects| |jmx\_endpoint|string|JMX agent custom connection string.

Default: service:jmx:rmi:///jndi/rmi://{HOST.CONN}:{HOST.PORT}/jmxrmi

[Property behavior](/manual/api/reference_commentary#property-behavior):
- *supported* if `type` is set to "JMX agent"| |lifetime|string|Time period after which items that are no longer discovered will be deleted. Accepts seconds, time unit with suffix, or a user macro.

Default: `7d`.| |lifetime\_type|integer|Scenario to delete lost LLD resources.

Possible values:
0 - *(default)* Delete after lifetime threshold is reached;
1 - Do not delete;
2 - Delete immediately.| |enabled\_lifetime|string|Time period after which items that are no longer discovered will be disabled. Accepts seconds, time unit with suffix, or a user macro.

Default: `0`.| |enabled\_lifetime\_type|integer|Scenario to disable lost LLD resources.

Possible values:
0 - Disable after lifetime threshold is reached;
1 - Do not disable;
2 - *(default)* Disable immediately.| |master\_itemid|ID|ID of the master item.
Discovery rule cannot be master item for another discovery rule.

[Property behavior](/manual/api/reference_commentary#property-behavior):
- *required* if `type` is set to "Dependent item"
- *read-only* for inherited objects| |output\_format|integer|Should the response be converted to JSON.

Possible values:
0 - *(default)* Store raw;
1 - Convert to JSON.

[Property behavior](/manual/api/reference_commentary#property-behavior):
- *supported* if `type` is set to "HTTP agent"
- *read-only* for inherited objects| |params|string|Additional parameters depending on the type of the LLD rule prototype:
- executed script for SSH and Telnet LLD rules;
- SQL query for database monitor LLD rules;
- formula for calculated LLD rules;
- the script for script and browser LLD rules.

[Property behavior](/manual/api/reference_commentary#property-behavior):
- *required* if `type` is set to "Database monitor", "SSH agent", "TELNET agent", "Script" or "Browser"
- *read-only* for inherited objects (if `type` is set to "Script" or "Browser")| |parameters|object/array|Additional parameters if `type` is set to "Script" or "Browser".
Array of objects with `name` and `value` properties, where `name` must be unique.

[Property behavior](/manual/api/reference_commentary#property-behavior):
- *supported* if `type` is set to "Script" or "Browser"
- *read-only* for inherited objects| |password|string|Password for authentication.

[Property behavior](/manual/api/reference_commentary#property-behavior):
- *required* if `type` is set to "JMX agent" and `username` is set
- *supported* if `type` is set to "Simple check", "Database monitor", "SSH agent", "TELNET agent", or "HTTP agent"
- *read-only* for inherited objects (if `type` is set to "HTTP agent")| |post\_type|integer|Type of post data body stored in `posts` property.

Possible values:
0 - *(default)* Raw data;
2 - JSON data;
3 - XML data.

[Property behavior](/manual/api/reference_commentary#property-behavior):
- *supported* if `type` is set to "HTTP agent"
- *read-only* for inherited objects| |posts|string|HTTP(S) request body data.

[Property behavior](/manual/api/reference_commentary#property-behavior):
- *required* if `type` is set to "HTTP agent" and `post_type` is set to "JSON data" or "XML data"
- *supported* if `type` is set to "HTTP agent" and `post_type` is set to "Raw data"
- *read-only* for inherited objects| |privatekey|string|Name of the private key file.

[Property behavior](/manual/api/reference_commentary#property-behavior):
- *required* if `type` is set to "SSH agent" and `authtype` is set to "public key"| |publickey|string|Name of the public key file.

[Property behavior](/manual/api/reference_commentary#property-behavior):
- *required* if `type` is set to "SSH agent" and `authtype` is set to "public key"| |query\_fields|array|Array of [query fields](#http-query-field) that will be sent when performing an HTTP request.

[Property behavior](/manual/api/reference_commentary#property-behavior):
- *supported* if `type` is set to "HTTP agent"
- *read-only* for inherited objects| |request\_method|integer|Type of request method.

Possible values:
0 - *(default)* GET;
1 - POST;
2 - PUT;
3 - HEAD.

[Property behavior](/manual/api/reference_commentary#property-behavior):
- *supported* if `type` is set to "HTTP agent"
- *read-only* for inherited objects| |retrieve\_mode|integer|What part of response should be stored.

Possible values if `request_method` is set to "GET", "POST", or "PUT":
0 - *(default)* Body;
1 - Headers;
2 - Both body and headers will be stored.

Possible values if `request_method` is set to "HEAD":
1 - Headers.

[Property behavior](/manual/api/reference_commentary#property-behavior):
- *supported* if `type` is set to "HTTP agent"
- *read-only* for inherited objects| |snmp\_oid|string|SNMP OID.

[Property behavior](/manual/api/reference_commentary#property-behavior):
- *required* if `type` is set to "SNMP agent"
- *read-only* for inherited objects| |ssl\_cert\_file|string|Public SSL Key file path.

[Property behavior](/manual/api/reference_commentary#property-behavior):
- *supported* if `type` is set to "HTTP agent"
- *read-only* for inherited objects| |ssl\_key\_file|string|Private SSL Key file path.

[Property behavior](/manual/api/reference_commentary#property-behavior):
- *supported* if `type` is set to "HTTP agent"
- *read-only* for inherited objects| |ssl\_key\_password|string|Password for SSL Key file.

[Property behavior](/manual/api/reference_commentary#property-behavior):
- *supported* if `type` is set to "HTTP agent"
- *read-only* for inherited objects| |state|integer|State of the LLD rule prototype.

Possible values:
0 - *(default)* normal;
1 - not supported.

[Property behavior](/manual/api/reference_commentary#property-behavior):
- *read-only*| |status|integer|Status of the LLD rule prototype.

Possible values:
0 - *(default)* enabled LLD rule prototype;
1 - disabled LLD rule prototype.| |status\_codes|string|Ranges of required HTTP status codes, separated by commas. Also supports user macros as part of comma separated list.

Example: 200,200-{$M},{$M},200-400

[Property behavior](/manual/api/reference_commentary#property-behavior):
- *supported* if `type` is set to "HTTP agent"
- *read-only* for inherited objects| |templateid|ID|ID of the parent template LLD rule prototype.

[Property behavior](/manual/api/reference_commentary#property-behavior):
- *read-only*| |timeout|string|Item data polling request timeout.
Accepts seconds or time unit with suffix (e.g., 30s, 1m). Also accepts user macros.

Possible values range: 1-600s.

Default: "" - use proxy/global settings.

[Property behavior](/manual/api/reference_commentary#property-behavior):
- *supported* if `type` is set to "Zabbix agent" (0), "Simple check" (3) and `key_` does not start with "`vmware.`" and "`icmpping`", "Zabbix agent (active)" (7), "External check" (10), "Database monitor" (11), "SSH agent" (13), "TELNET agent" (14), "HTTP agent" (19), "SNMP agent" (20) and `snmp_oid` starts with "`walk[`" or "`get[`", "Script" (21), "Browser" (22)
- *read-only* for inherited objects| |trapper\_hosts|string|Allowed hosts.

[Property behavior](/manual/api/reference_commentary#property-behavior):
- *supported* if `type` is set to "Zabbix trapper", or if `type` is set to "HTTP agent" and `allow_traps` is set to "Allow to accept incoming data"| |username|string|Username for authentication.

[Property behavior](/manual/api/reference_commentary#property-behavior):
- *required* if `type` is set to "SSH agent", "TELNET agent", or if `type` is set to "JMX agent" and `password` is set
- *supported* if `type` is set to "Simple check", "Database monitor", or "HTTP agent"
- *read-only* for inherited objects (if `type` is set to "HTTP agent")| |uuid|string|Universal unique identifier, used for linking imported LLD rule prototypes to already existing ones. Auto-generated, if not given.

[Property behavior](/manual/api/reference_commentary#property-behavior):
- *supported* if the LLD rule prototype belongs to a template| |verify\_host|integer|Whether to validate that the host name for the connection matches the one in the host's certificate.

Possible values:
0 - *(default)* Do not validate;
1 - Validate.

[Property behavior](/manual/api/reference_commentary#property-behavior):
- *supported* if `type` is set to "HTTP agent"
- *read-only* for inherited objects| |verify\_peer|integer|Whether to validate that the host's certificate is authentic.

Possible values:
0 - *(default)* Do not validate;
1 - Validate.

[Property behavior](/manual/api/reference_commentary#property-behavior):
- *supported* if `type` is set to "HTTP agent"
- *read-only* for inherited objects| [comment]: # ({/6e2aa0ce-0c810d05}) [comment]: # ({ab5307fa-caf82a93}) #### HTTP header The header object has the following properties: |Property|[Type](/manual/api/reference_commentary#data-types)|Description| |--------|---------------------------------------------------|-----------| |name|string|HTTP header name.

[Property behavior](/manual/api/reference_commentary#property-behavior):
- *required*| |value|string|Header value.

[Property behavior](/manual/api/reference_commentary#property-behavior):
- *required*| [comment]: # ({/ab5307fa-caf82a93}) [comment]: # ({5b4177f3-0c63a63b}) #### HTTP query field The query field object defines a name and value that is used to specify a URL parameter. It has the following properties: |Property|[Type](/manual/api/reference_commentary#data-types)|Description| |--------|---------------------------------------------------|-----------| |name|string|Name of the parameter.

[Property behavior](/manual/api/reference_commentary#property-behavior):
- *required*| |value|string|Parameter value.

[Property behavior](/manual/api/reference_commentary#property-behavior):
- *required*| [comment]: # ({/5b4177f3-0c63a63b}) [comment]: # ({87597f1d-bc5ce0af}) ### LLD rule prototype filter The LLD rule prototype filter object defines a set of conditions that can be used to filter discovered objects. It has the following properties: |Property|[Type](/manual/api/reference_commentary#data-types)|Description| |--|--|------| |conditions|object/array|Set of [filter conditions](#lld-rule-prototype-filter-condition) to use for filtering results. The conditions will be sorted in the order of their placement in the formula.

[Property behavior](/manual/api/reference_commentary#property-behavior):
- *required*| |evaltype|integer|Filter condition [evaluation method](/manual/discovery/low_level_discovery#filter).

Possible values:
0 - And/Or;
1 - And;
2 - Or;
3 - Custom expression.

[Property behavior](/manual/api/reference_commentary#property-behavior):
- *required*| |eval\_formula|string|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.

[Property behavior](/manual/api/reference_commentary#property-behavior):
- *read-only*| |formula|string|User-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.

[Property behavior](/manual/api/reference_commentary#property-behavior):
- *required* if `evaltype` is set to "custom expression"| [comment]: # ({/87597f1d-bc5ce0af}) [comment]: # ({cd3f8c03-5bd71a86}) #### LLD rule prototype filter condition The LLD rule prototype filter condition object defines a separate check to perform on the value of an LLD macro. It has the following properties: |Property|[Type](/manual/api/reference_commentary#data-types)|Description| |--|--|------| |macro|string|LLD macro to perform the check on.

[Property behavior](/manual/api/reference_commentary#property-behavior):
- *required*| |value|string|Value to compare with.

[Property behavior](/manual/api/reference_commentary#property-behavior):
- *required* if `operator` is set to "matches regular expression" or "does not match regular expression"| |formulaid|string|Arbitrary 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.

[Property behavior](/manual/api/reference_commentary#property-behavior):
- *required* if `evaltype` of [LLD rule prototype filter object](#lld-rule-prototype-filter) is set to "custom expression"| |operator|integer|Condition operator.

Possible values:
8 - *(default)* matches regular expression;
9 - does not match regular expression;
12 - exists;
13 - does not exist.| ::: notetip To better understand how to use filters with various types of expressions, see examples on the [discoveryruleprototype.get](get#retrieving-filter-conditions) and [discoveryruleprototype.create](create#using-a-custom-expression-filter) method pages. ::: [comment]: # ({/cd3f8c03-5bd71a86}) [comment]: # ({99ea4653-ec3a36b7}) ### LLD macro path The LLD macro path has the following properties: |Property|[Type](/manual/api/reference_commentary#data-types)|Description| |--|--|------| |lld\_macro|string|LLD macro.

[Property behavior](/manual/api/reference_commentary#property-behavior):
- *required*| |path|string|Selector for value which will be assigned to corresponding macro.

[Property behavior](/manual/api/reference_commentary#property-behavior):
- *required*| [comment]: # ({/99ea4653-ec3a36b7}) [comment]: # ({58801fad-e8aecce9}) ### LLD rule prototype preprocessing The LLD rule prototype preprocessing object has the following properties. |Property|[Type](/manual/api/reference_commentary#data-types)|Description| |--|--|------| |type|integer|The preprocessing option type.

Possible values:
5 - Regular expression;
11 - XML XPath;
12 - JSONPath;
14 - Matches regular expression;
15 - Does not match regular expression;
16 - Check for error in JSON;
17 - Check for error in XML;
20 - Discard unchanged with heartbeat;
21 - JavaScript;
23 - Prometheus to JSON;
24 - CSV to JSON;
25 - Replace;
27 - XML to JSON;
28 - SNMP walk value;
29 - SNMP walk to JSON;
30 - SNMP get value.

[Property behavior](/manual/api/reference_commentary#property-behavior):
- *required*| |params|string|Additional parameters used by preprocessing option. Multiple parameters are separated by the newline (\\n) character.

[Property behavior](/manual/api/reference_commentary#property-behavior):
- *required* if `type` is set to "Regular expression" (5), "XML XPath" (11), "JSONPath" (12), "Matches regular expression" (14), "Does not match regular expression" (15), "Check for error in JSON" (16), "Check for error in XML" (17), "Discard unchanged with heartbeat" (20), "JavaScript" (21), "Prometheus to JSON" (23), "CSV to JSON" (24), "Replace" (25), "SNMP walk value" (28), "SNMP walk to JSON" (29), or "SNMP get value" (30)| |error\_handler|integer|Action type used in case of preprocessing step failure.

Possible values:
0 - Error message is set by Zabbix server;
1 - Discard value;
2 - Set custom value;
3 - Set custom error message.

[Property behavior](/manual/api/reference_commentary#property-behavior):
- *required* if `type` is set to "Regular expression" (5), "XML XPath" (11), "JSONPath" (12), "Matches regular expression" (14), "Does not match regular expression" (15), "Check for error in JSON" (16), "Check for error in XML" (17), "Prometheus to JSON" (23), "CSV to JSON" (24), "XML to JSON" (27), "SNMP walk value" (28), "SNMP walk to JSON" (29), or "SNMP get value" (30)| |error\_handler\_params|string|Error handler parameters.

[Property behavior](/manual/api/reference_commentary#property-behavior):
- *required* if `error_handler` is set to "Set custom value" or "Set custom error message"| The following parameters and error handlers are supported for each preprocessing type. |Preprocessing type|Name|Parameter 1|Parameter 2|Parameter 3|Supported error handlers| |------------------|----|-----------|-----------|-----------|------------------------| |5|Regular expression|pattern^1^|output^2^|<|0, 1, 2, 3| |11|XML XPath|path^3^|<|<|0, 1, 2, 3| |12|JSONPath|path^3^|<|<|0, 1, 2, 3| |14|Matches regular expression|pattern^1^|<|<|0, 1, 2, 3| |15|Does not match regular expression|pattern^1^|<|<|0, 1, 2, 3| |16|Check for error in JSON|path^3^|<|<|0, 1, 2, 3| |17|Check for error in XML|path^3^|<|<|0, 1, 2, 3| |20|Discard unchanged with heartbeat|seconds^4, 5^|<|<|<| |21|JavaScript|script^2^|<|<|<| |23|Prometheus to JSON|pattern^5, 6^|<|<|0, 1, 2, 3| |24|CSV to JSON|character^2^|character^2^|0,1|0, 1, 2, 3| |25|Replace|search string^2^|replacement^2^|<|<| |27|XML to JSON|<|<|<|0, 1, 2, 3| |28|SNMP walk value|OID^2^|Format:
0 - Unchanged
1 - UTF-8 from Hex-STRING
2 - MAC from Hex-STRING
3 - Integer from BITS|<|0, 1, 2, 3| |29|SNMP walk to JSON^7^|Field name^2^|OID prefix^2^|Format:
0 - Unchanged
1 - UTF-8 from Hex-STRING
2 - MAC from Hex-STRING
3 - Integer from BITS|0, 1, 2, 3| |30|SNMP get value|Format:
1 - UTF-8 from Hex-STRING
2 - MAC from Hex-STRING
3 - Integer from BITS|<|<|0, 1, 2, 3| ^1^ regular expression
^2^ string
^3^ JSONPath or XML XPath
^4^ positive integer (with support of time suffixes, e.g. 30s, 1m, 2h, 1d)
^5^ user macro
^6^ Prometheus pattern following the syntax: `{