# Item prototype object

The following objects are directly related to the `itemprototype` API.

### Item prototype

The item prototype object has the following properties.

|Property|Type|Description|
|--------|----|-----------|
|itemid|string|*(readonly)* ID of the item prototype.|
|**delay**<br>(required)|integer|Update interval of the item prototype in seconds.|
|**hostid**<br>(required)|string|ID of the host that the item prototype belongs to.|
|**interfaceid**<br>(required)|string|ID of the item prototype's host interface. Used only for host item prototypes.<br><br>Optional for Zabbix agent (active), Zabbix internal, Zabbix trapper, Zabbix aggregate, database monitor and calculated item prototypes.|
|**key\_**<br>(required)|string|Item prototype key.|
|**name**<br>(required)|string|Name of the item prototype.|
|**type**<br>(required)|integer|Type of the item prototype.<br><br>Possible values:<br>0 - Zabbix agent;<br>1 - SNMPv1 agent;<br>2 - Zabbix trapper;<br>3 - simple check;<br>4 - SNMPv2 agent;<br>5 - Zabbix internal;<br>6 - SNMPv3 agent;<br>7 - Zabbix agent (active);<br>8 - Zabbix aggregate;<br>10 - external check;<br>11 - database monitor;<br>12 - IPMI agent;<br>13 - SSH agent;<br>14 - TELNET agent;<br>15 - calculated;<br>16 - JMX agent;<br>17 - SNMP trap.|
|**value\_type**<br>(required)|integer|Type of information of the item prototype.<br><br>Possible values:<br>0 - numeric float;<br>1 - character;<br>2 - log;<br>3 - numeric unsigned;<br>4 - text.|
|authtype|integer|SSH authentication method. Used only by SSH agent item prototypes.<br><br>Possible values:<br>0 - *(default)* password;<br>1 - public key.|
|data\_type|integer|Data type of the item prototype.<br><br>Possible values:<br>0 - *(default)* decimal;<br>1 - octal;<br>2 - hexadecimal;<br>3 - boolean.|
|delay\_flex|string|[Custom intervals](/manual/config/items/item/custom_intervals) that contain flexible intervals and scheduling intervals as serialized strings.<br><br>Multiple intervals are separated by a semicolon.|
|delta|integer|Value that will be stored.<br><br>Possible values:<br>0 - *(default)* as is;<br>1 - Delta, speed per second;<br>2 - Delta, simple change.|
|description|string|Description of the item prototype.|
|formula|integer/float|Custom multiplier.<br><br>Default: 1.|
|history|integer|Number of days to keep item prototype's history data.<br><br>Default: 90.|
|ipmi\_sensor|string|IPMI sensor. Used only by IPMI item prototypes.|
|logtimefmt|string|Format of the time in log entries. Used only by log item prototypes.|
|multiplier|integer|Whether to use a custom multiplier.|
|params|string|Additional parameters depending on the type of the item prototype:<br>- executed script for SSH and Telnet item prototypes;<br>- SQL query for database monitor item prototypes;<br>- formula for calculated item prototypes.|
|password|string|Password for authentication. Used by simple check, SSH, Telnet, database monitor and JMX item prototypes.|
|port|string|Port monitored by the item prototype. Used only by SNMP items prototype.|
|privatekey|string|Name of the private key file.|
|publickey|string|Name of the public key file.|
|snmp\_community|string|SNMP community.<br><br>Used only by SNMPv1 and SNMPv2 item prototypes.|
|snmp\_oid|string|SNMP OID.|
|snmpv3\_authpassphrase|string|SNMPv3 auth passphrase. Used only by SNMPv3 item prototypes.|
|snmpv3\_authprotocol|integer|SNMPv3 authentication protocol. Used only by SNMPv3 items.<br><br>Possible values:<br>0 - *(default)* MD5;<br>1 - SHA.|
|snmpv3\_contextname|string|SNMPv3 context name. Used only by SNMPv3 item prototypes.|
|snmpv3\_privpassphrase|string|SNMPv3 priv passphrase. Used only by SNMPv3 item prototypes.|
|snmpv3\_privprotocol|integer|SNMPv3 privacy protocol. Used only by SNMPv3 items.<br><br>Possible values:<br>0 - *(default)* DES;<br>1 - AES.|
|snmpv3\_securitylevel|integer|SNMPv3 security level. Used only by SNMPv3 item prototypes.<br><br>Possible values:<br>0 - noAuthNoPriv;<br>1 - authNoPriv;<br>2 - authPriv.|
|snmpv3\_securityname|string|SNMPv3 security name. Used only by SNMPv3 item prototypes.|
|status|integer|Status of the item prototype.<br><br>Possible values:<br>0 - *(default)* enabled item prototype;<br>1 - disabled item prototype;<br>3 - unsupported item prototype.|
|templateid|string|(readonly) ID of the parent template item prototype.|
|trapper\_hosts|string|Allowed hosts. Used only by trapper item prototypes.|
|trends|integer|Number of days to keep item prototype's trends data.<br><br>Default: 365.|
|units|string|Value units.|
|username|string|Username for authentication. Used by simple check, SSH, Telnet, database monitor and JMX item prototypes.<br><br>Required by SSH and Telnet item prototypes.|
|valuemapid|string|ID of the associated value map.|
