Table of Contents
> Item object
The following objects are directly related to the item API.
Item
Web items cannot be directly created, updated or deleted via the Áú»¢¶Ä²© API.
The item object has the following properties.
| Property | Type | Description |
|---|---|---|
| itemid | string | (readonly) ID of the item. |
| delay (required) |
integer | Update interval of the item in seconds. |
| hostid (required) |
string | ID of the host or template that the item belongs to. |
| interfaceid (required) |
string | ID of the item's host interface. Not required for template items. Optional for Áú»¢¶Ä²© agent (active), Áú»¢¶Ä²© internal, Áú»¢¶Ä²© trapper, Áú»¢¶Ä²© aggregate, database monitor and calculated items. |
| key_ (required) |
string | Item key. |
| name (required) |
string | Name of the item. |
| type (required) |
integer | Type of the item. Possible values: 0 - Áú»¢¶Ä²© agent; 1 - SNMPv1 agent; 2 - Áú»¢¶Ä²© trapper; 3 - simple check; 4 - SNMPv2 agent; 5 - Áú»¢¶Ä²© internal; 6 - SNMPv3 agent; 7 - Áú»¢¶Ä²© agent (active); 8 - Áú»¢¶Ä²© aggregate; 9 - web item; 10 - external check; 11 - database monitor; 12 - IPMI agent; 13 - SSH agent; 14 - TELNET agent; 15 - calculated; 16 - JMX agent; 17 - SNMP trap. |
| value_type (required) |
integer | Type of information of the item. Possible values: 0 - numeric float; 1 - character; 2 - log; 3 - numeric unsigned; 4 - text. |
| authtype | integer | SSH authentication method. Used only by SSH agent items. Possible values: 0 - (default) password; 1 - public key. |
| data_type | integer | Data type of the item. Possible values: 0 - (default) decimal; 1 - octal; 2 - hexadecimal; 3 - boolean. |
| delay_flex | string | Custom intervals that contain flexible intervals and scheduling intervals as serialized strings. Multiple intervals are separated by a semicolon. |
| delta | integer | Value that will be stored. Possible values: 0 - (default) as is; 1 - Delta, speed per second; 2 - Delta, simple change. |
| description | string | Description of the item. |
| error | string | (readonly) Error text if there are problems updating the item. |
| flags | integer | (readonly) Origin of the item. Possible values: 0 - a plain item; 4 - a discovered item. |
| formula | integer/float | Custom multiplier. Default: 1. |
| history | integer | Number of days to keep item's history data. Default: 90. |
| inventory_link | integer | ID of the host inventory field that is populated by the item. Refer to the host inventory page for a list of supported host inventory fields and their IDs. Default: 0. |
| ipmi_sensor | string | IPMI sensor. Used only by IPMI items. |
| lastclock | timestamp | (readonly) Time when the item was last updated. This property will only return a value for the period configured in ZBX_HISTORY_PERIOD. |
| lastns | integer | (readonly) Nanoseconds when the item was last updated. This property will only return a value for the period configured in ZBX_HISTORY_PERIOD. |
| lastvalue | string | (readonly) Last value of the item. This property will only return a value for the period configured in ZBX_HISTORY_PERIOD. |
| logtimefmt | string | Format of the time in log entries. Used only by log items. |
| mtime | timestamp | Time when the monitored log file was last updated. Used only by log items. |
| multiplier | integer | Whether to use a custom multiplier. |
| params | string | Additional parameters depending on the type of the item: - executed script for SSH and Telnet items; - SQL query for database monitor items; - formula for calculated items. |
| password | string | Password for authentication. Used by simple check, SSH, Telnet, database monitor and JMX items. |
| port | string | Port monitored by the item. Used only by SNMP items. |
| prevvalue | string | (readonly) Previous value of the item. This property will only return a value for the period configured in ZBX_HISTORY_PERIOD. |
| privatekey | string | Name of the private key file. |
| publickey | string | Name of the public key file. |
| snmp_community | string | SNMP community. Used only by SNMPv1 and SNMPv2 items. |
| snmp_oid | string | SNMP OID. |
| snmpv3_authpassphrase | string | SNMPv3 auth passphrase. Used only by SNMPv3 items. |
| snmpv3_authprotocol | integer | SNMPv3 authentication protocol. Used only by SNMPv3 items. Possible values: 0 - (default) MD5; 1 - SHA. |
| snmpv3_contextname | string | SNMPv3 context name. Used only by SNMPv3 items. |
| snmpv3_privpassphrase | string | SNMPv3 priv passphrase. Used only by SNMPv3 items. |
| snmpv3_privprotocol | integer | SNMPv3 privacy protocol. Used only by SNMPv3 items. Possible values: 0 - (default) DES; 1 - AES. |
| snmpv3_securitylevel | integer | SNMPv3 security level. Used only by SNMPv3 items. Possible values: 0 - noAuthNoPriv; 1 - authNoPriv; 2 - authPriv. |
| snmpv3_securityname | string | SNMPv3 security name. Used only by SNMPv3 items. |
| state | integer | (readonly) State of the item. Possible values: 0 - (default) normal; 1 - not supported. |
| status | integer | Status of the item. Possible values: 0 - (default) enabled item; 1 - disabled item. |
| templateid | string | (readonly) ID of the parent template item. Hint: Use the hostid property to specify the template that the item belongs to. |
| trapper_hosts | string | Allowed hosts. Used only by trapper items. |
| trends | integer | Number of days to keep item's trends data. Default: 365. |
| units | string | Value units. |
| username | string | Username for authentication. Used by simple check, SSH, Telnet, database monitor and JMX items. Required by SSH and Telnet items. |
| valuemapid | string | ID of the associated value map. |