[comment]: # ({58fbd3bc-58fbd3bc}) # item.get [comment]: # ({/58fbd3bc-58fbd3bc}) [comment]: # ({14484745-673edf7f}) ### Description `integer/array item.get(object parameters)` The method allows to retrieve items according to the given parameters. ::: noteclassic This method is available to users of any type. Permissions to call the method can be revoked in user role settings. See [User roles](/manual/web_interface/frontend_sections/users/user_roles) for more information. ::: [comment]: # ({/14484745-673edf7f}) [comment]: # ({641397fb-cc946363}) ### Parameters `(object)` Parameters defining the desired output. The method supports the following parameters. |Parameter|[Type](/manual/api/reference_commentary#data-types)|Description| |--|--|------| |itemids|ID/array|Return only items with the given IDs.| |groupids|ID/array|Return only items that belong to the hosts from the given groups.| |templateids|ID/array|Return only items that belong to the given templates.| |hostids|ID/array|Return only items that belong to the given hosts.| |proxyids|ID/array|Return only items that are monitored by the given proxies.| |interfaceids|ID/array|Return only items that use the given host interfaces.| |graphids|ID/array|Return only items that are used in the given graphs.| |triggerids|ID/array|Return only items that are used in the given triggers.| |webitems|flag|Include web items in the result.| |inherited|boolean|If set to `true` return only items inherited from a template.| |templated|boolean|If set to `true` return only items that belong to templates.| |monitored|boolean|If set to `true` return only enabled items that belong to monitored hosts.| |group|string|Return only items that belong to a group with the given name.| |host|string|Return only items that belong to a host with the given name.| |evaltype|integer|Tag [evaluation method](/manual/web_interface/frontend_sections/data_collection/hosts/items#using-filter).

Possible values:
0 - *(default)* And/Or;
2 - Or.| |tags|array|Return only items with the given tags.
Format: `[{"tag": "", "value": "", "operator": ""}, ...]`.
An empty array returns all items.

Possible [operator](/manual/web_interface/frontend_sections/data_collection/hosts/items#using-filter) values:
0 - *(default)* Contains;
1 - Equals;
2 - Does not contain;
3 - Does not equal;
4 - Exists;
5 - Does not exist.| |with\_triggers|boolean|If set to `true` return only items that are used in triggers.| |selectHosts|query|Return a [`hosts`](/manual/api/reference/host/object) property with an array of hosts that the item belongs to.| |selectInterfaces|query|Return an [`interfaces`](/manual/api/reference/hostinterface/object) property with an array of host interfaces used by the item.| |selectTriggers|query|Return a [`triggers`](/manual/api/reference/trigger/object) property with the triggers that the item is used in.

Supports `count`.| |selectGraphs|query|Return a [`graphs`](/manual/api/reference/graph/object) property with the graphs that contain the item.

Supports `count`.| |selectDiscoveryData|query|Return a `discoveryData` property with the item discovery object data. The item discovery object links a discovered item to an item prototype from which it was discovered.

It has the following properties:
`parent_itemid` - `(string)` ID of the item prototype from which the item has been created;
`key_` - `(string)` key of the item prototype;
`status` - `(int)` item discovery status:
0 - *(default)* item is discovered,
1 - item is not discovered anymore;
`ts_delete` - `(timestamp)` time when an item that is no longer discovered will be deleted;
`ts_disable` - `(timestamp)` time when an item that is no longer discovered will be disabled;
`disable_source` - `(int)` indicator of whether item was disabled by an LLD rule or manually:
0 - *(default)* disabled automatically,
1 - disabled by an LLD rule.| |selectDiscoveryRule|query|Return a [`discoveryRule`](/manual/api/reference/discoveryrule/object) property with the LLD rule that created the item.| |selectPreprocessing|query|Return a [`preprocessing`](/manual/api/reference/item/object#item-preprocessing) property with item preprocessing options.| |selectTags|query|Return the item tags in [`tags`](/manual/api/reference/item/object#item-tag) property.| |selectValueMap|query|Return a [`valuemap`](/manual/api/reference/valuemap/object) property with item value map.| |filter|object|Return only those results that exactly match the given filter.

Accepts an object, where the keys are property names, and the values are either a single value or an array of values to match against.

Does not support properties of `text` [data type](/manual/api/reference_commentary#data-types).

Supports additional properties:
`host` - technical name of the host that the item belongs to.| |limitSelects|integer|Limits the number of records returned by subselects.

Applies to the following subselects:
`selectGraphs` - results will be sorted by `name`;
`selectTriggers` - results will be sorted by `description`.| |sortfield|string/array|Sort the result by the given properties.

Possible values: `itemid`, `name`, `key_`, `delay`, `history`, `trends`, `type`, `status`.| |countOutput|boolean|These parameters are described in the [reference commentary](/manual/api/reference_commentary#common-get-method-parameters).| |editable|boolean|^| |excludeSearch|boolean|^| |limit|integer|^| |output|query|^| |preservekeys|boolean|^| |search|object|^| |searchByAny|boolean|^| |searchWildcardsEnabled|boolean|^| |sortorder|string/array|^| |startSearch|boolean|^| |selectItemDiscovery|query|Return an `itemDiscovery` property with the item discovery object. The item discovery object links the item to an item prototype from which it was created.

This query is **deprecated**, please use `selectDiscoveryData` instead.| [comment]: # ({/641397fb-cc946363}) [comment]: # ({7223bab1-7223bab1}) ### Return values `(integer/array)` Returns either: - an array of objects; - the count of retrieved objects, if the `countOutput` parameter has been used. [comment]: # ({/7223bab1-7223bab1}) [comment]: # ({b41637d2-b41637d2}) ### Examples [comment]: # ({/b41637d2-b41637d2}) [comment]: # ({1a09225b-59b84d93}) #### Finding items by key Retrieve all items used in triggers for specific host ID that have word "system.cpu" in the item key and sort results by name. [Request](/manual/api#performing-requests): ```json { "jsonrpc": "2.0", "method": "item.get", "params": { "output": "extend", "hostids": "10084", "with_triggers": true, "search": { "key_": "system.cpu" }, "sortfield": "name" }, "id": 1 } ``` Response: ```json { "jsonrpc": "2.0", "result": [ { "itemid": "42269", "type": "18", "snmp_oid": "", "hostid": "10084", "name": "CPU utilization", "key_": "system.cpu.util", "delay": "0", "history": "7d", "trends": "365d", "status": "0", "value_type": "0", "trapper_hosts": "", "units": "%", "logtimefmt": "", "templateid": "42267", "valuemapid": "0", "params": "", "ipmi_sensor": "", "authtype": "0", "username": "", "password": "", "publickey": "", "privatekey": "", "flags": "0", "interfaceid": "0", "description": "CPU utilization in %.", "inventory_link": "0", "evaltype": "0", "jmx_endpoint": "", "master_itemid": "42264", "timeout": "", "url": "", "query_fields": [], "posts": "", "status_codes": "200", "follow_redirects": "1", "post_type": "0", "http_proxy": "", "headers": [], "retrieve_mode": "0", "request_method": "0", "output_format": "0", "ssl_cert_file": "", "ssl_key_file": "", "ssl_key_password": "", "verify_peer": "0", "verify_host": "0", "allow_traps": "0", "uuid": "", "state": "0", "error": "", "parameters": [], "lastclock": "0", "lastns": "0", "lastvalue": "0", "prevvalue": "0", "name_resolved": "CPU utilization" }, { "itemid": "42259", "type": "0", "snmp_oid": "", "hostid": "10084", "name": "Load average (15m avg)", "key_": "system.cpu.load[all,avg15]", "delay": "1m", "history": "7d", "trends": "365d", "status": "0", "value_type": "0", "trapper_hosts": "", "units": "", "logtimefmt": "", "templateid": "42219", "valuemapid": "0", "params": "", "ipmi_sensor": "", "authtype": "0", "username": "", "password": "", "publickey": "", "privatekey": "", "flags": "0", "interfaceid": "1", "description": "", "inventory_link": "0", "evaltype": "0", "jmx_endpoint": "", "master_itemid": "0", "timeout": "", "url": "", "query_fields": [], "posts": "", "status_codes": "200", "follow_redirects": "1", "post_type": "0", "http_proxy": "", "headers": [], "retrieve_mode": "0", "request_method": "0", "output_format": "0", "ssl_cert_file": "", "ssl_key_file": "", "ssl_key_password": "", "verify_peer": "0", "verify_host": "0", "allow_traps": "0", "uuid": "", "state": "0", "error": "", "parameters": [], "lastclock": "0", "lastns": "0", "lastvalue": "0", "prevvalue": "0", "name_resolved": "Load average (15m avg)" }, { "itemid": "42249", "type": "0", "snmp_oid": "", "hostid": "10084", "name": "Load average (1m avg)", "key_": "system.cpu.load[all,avg1]", "delay": "1m", "history": "7d", "trends": "365d", "status": "0", "value_type": "0", "trapper_hosts": "", "units": "", "logtimefmt": "", "templateid": "42209", "valuemapid": "0", "params": "", "ipmi_sensor": "", "authtype": "0", "username": "", "password": "", "publickey": "", "privatekey": "", "flags": "0", "interfaceid": "1", "description": "", "inventory_link": "0", "evaltype": "0", "jmx_endpoint": "", "master_itemid": "0", "timeout": "", "url": "", "query_fields": [], "posts": "", "status_codes": "200", "follow_redirects": "1", "post_type": "0", "http_proxy": "", "headers": [], "retrieve_mode": "0", "request_method": "0", "output_format": "0", "ssl_cert_file": "", "ssl_key_file": "", "ssl_key_password": "", "verify_peer": "0", "verify_host": "0", "allow_traps": "0", "uuid": "", "state": "0", "error": "", "parameters": [], "lastclock": "0", "lastns": "0", "lastvalue": "0", "prevvalue": "0", "name_resolved": "Load average (1m avg)" }, { "itemid": "42257", "type": "0", "snmp_oid": "", "hostid": "10084", "name": "Load average (5m avg)", "key_": "system.cpu.load[all,avg5]", "delay": "1m", "history": "7d", "trends": "365d", "status": "0", "value_type": "0", "trapper_hosts": "", "units": "", "logtimefmt": "", "templateid": "42217", "valuemapid": "0", "params": "", "ipmi_sensor": "", "authtype": "0", "username": "", "password": "", "publickey": "", "privatekey": "", "flags": "0", "interfaceid": "1", "description": "", "inventory_link": "0", "evaltype": "0", "jmx_endpoint": "", "master_itemid": "0", "timeout": "", "url": "", "query_fields": [], "posts": "", "status_codes": "200", "follow_redirects": "1", "post_type": "0", "http_proxy": "", "headers": [], "retrieve_mode": "0", "request_method": "0", "output_format": "0", "ssl_cert_file": "", "ssl_key_file": "", "ssl_key_password": "", "verify_peer": "0", "verify_host": "0", "allow_traps": "0", "uuid": "", "state": "0", "error": "", "parameters": [], "lastclock": "0", "lastns": "0", "lastvalue": "0", "prevvalue": "0", "name_resolved": "Load average (5m avg)" }, { "itemid": "42260", "type": "0", "snmp_oid": "", "hostid": "10084", "name": "Number of CPUs", "key_": "system.cpu.num", "delay": "1m", "history": "7d", "trends": "365d", "status": "0", "value_type": "3", "trapper_hosts": "", "units": "", "logtimefmt": "", "templateid": "42220", "valuemapid": "0", "params": "", "ipmi_sensor": "", "authtype": "0", "username": "", "password": "", "publickey": "", "privatekey": "", "flags": "0", "interfaceid": "1", "description": "", "inventory_link": "0", "evaltype": "0", "jmx_endpoint": "", "master_itemid": "0", "timeout": "", "url": "", "query_fields": [], "posts": "", "status_codes": "200", "follow_redirects": "1", "post_type": "0", "http_proxy": "", "headers": [], "retrieve_mode": "0", "request_method": "0", "output_format": "0", "ssl_cert_file": "", "ssl_key_file": "", "ssl_key_password": "", "verify_peer": "0", "verify_host": "0", "allow_traps": "0", "uuid": "", "state": "0", "error": "", "parameters": [], "lastclock": "0", "lastns": "0", "lastvalue": "0", "prevvalue": "0", "name_resolved": "Number of CPUs" } ], "id": 1 } ``` [comment]: # ({/1a09225b-59b84d93}) [comment]: # ({a6ae1426-674b0856}) #### Finding dependent items by key Retrieve all dependent items from host with ID "10116" that have the word "apache" in the key. [Request](/manual/api#performing-requests): ```json { "jsonrpc": "2.0", "method": "item.get", "params": { "output": "extend", "hostids": "10116", "search": { "key_": "apache" }, "filter": { "type": 18 } }, "id": 1 } ``` Response: ```json { "jsonrpc": "2.0", "result": [ { "itemid": "25550", "type": "18", "snmp_oid": "", "hostid": "10116", "name": "Days", "key_": "apache.status.uptime.days", "delay": "0", "history": "90d", "trends": "365d", "status": "0", "value_type": "3", "trapper_hosts": "", "units": "", "logtimefmt": "", "templateid": "0", "valuemapid": "0", "params": "", "ipmi_sensor": "", "authtype": "0", "username": "", "password": "", "publickey": "", "privatekey": "", "flags": "0", "interfaceid": "0", "description": "", "inventory_link": "0", "evaltype": "0", "jmx_endpoint": "", "master_itemid": "25545", "timeout": "", "url": "", "query_fields": [], "posts": "", "status_codes": "200", "follow_redirects": "1", "post_type": "0", "http_proxy": "", "headers": [], "retrieve_mode": "0", "request_method": "0", "output_format": "0", "ssl_cert_file": "", "ssl_key_file": "", "ssl_key_password": "", "verify_peer": "0", "verify_host": "0", "allow_traps": "0", "uuid": "", "state": "0", "error": "", "parameters": [], "lastclock": "0", "lastns": "0", "lastvalue": "0", "prevvalue": "0", "name_resolved": "Days" }, { "itemid": "25555", "type": "18", "snmp_oid": "", "hostid": "10116", "name": "Hours", "key_": "apache.status.uptime.hours", "delay": "0", "history": "90d", "trends": "365d", "status": "0", "value_type": "3", "trapper_hosts": "", "units": "", "logtimefmt": "", "templateid": "0", "valuemapid": "0", "params": "", "ipmi_sensor": "", "authtype": "0", "username": "", "password": "", "publickey": "", "privatekey": "", "flags": "0", "interfaceid": "0", "description": "", "inventory_link": "0", "evaltype": "0", "jmx_endpoint": "", "master_itemid": "25545", "timeout": "", "url": "", "query_fields": [], "posts": "", "status_codes": "200", "follow_redirects": "1", "post_type": "0", "http_proxy": "", "headers": [], "retrieve_mode": "0", "request_method": "0", "output_format": "0", "ssl_cert_file": "", "ssl_key_file": "", "ssl_key_password": "", "verify_peer": "0", "verify_host": "0", "allow_traps": "0", "uuid": "", "state": "0", "error": "", "parameters": [], "lastclock": "0", "lastns": "0", "lastvalue": "0", "prevvalue": "0", "name_resolved": "Hours" } ], "id": 1 } ``` [comment]: # ({/a6ae1426-674b0856}) [comment]: # ({256e2a05-94dc4b21}) #### Find HTTP agent item Find HTTP agent item with post body type XML for specific host ID. [Request](/manual/api#performing-requests): ```json { "jsonrpc": "2.0", "method": "item.get", "params": { "hostids": "10255", "filter": { "type": 19, "post_type": 3 } }, "id": 1 } ``` Response: ```json { "jsonrpc": "2.0", "result": [ { "itemid": "28252", "type": "19", "snmp_oid": "", "hostid": "10255", "name": "template item", "key_": "ti", "delay": "30s", "history": "90d", "trends": "365d", "status": "0", "value_type": "3", "trapper_hosts": "", "units": "", "logtimefmt": "", "templateid": "0", "valuemapid": "0", "params": "", "ipmi_sensor": "", "authtype": "0", "username": "", "password": "", "publickey": "", "privatekey": "", "flags": "0", "interfaceid": "0", "description": "", "inventory_link": "0", "evaltype": "0", "jmx_endpoint": "", "master_itemid": "0", "timeout": "", "url": "localhost", "query_fields": [ { "name": "mode", "value": "xml" } ], "posts": "\r\n]]>\r\n", "status_codes": "200", "follow_redirects": "0", "post_type": "3", "http_proxy": "", "headers": [], "retrieve_mode": "1", "request_method": "3", "output_format": "0", "ssl_cert_file": "", "ssl_key_file": "", "ssl_key_password": "", "verify_peer": "0", "verify_host": "0", "allow_traps": "0", "uuid": "", "state": "0", "error": "", "parameters": [], "lastclock": "0", "lastns": "0", "lastvalue": "", "prevvalue": "", "name_resolved": "template item" } ], "id": 1 } ``` [comment]: # ({/256e2a05-94dc4b21}) [comment]: # ({6697de6d-f4b01bbe}) #### Retrieving items with preprocessing rules Retrieve all items and their preprocessing rules for specific host ID. [Request](/manual/api#performing-requests): ```json { "jsonrpc": "2.0", "method": "item.get", "params": { "output": ["itemid", "name", "key_"], "selectPreprocessing": "extend", "hostids": "10254" }, "id": 1 } ``` Response: ```json { "jsonrpc": "2.0", "result": { "itemid": "23865", "name": "HTTP agent example JSON", "key_": "json", "preprocessing": [ { "type": "12", "params": "$.random", "error_handler": "1", "error_handler_params": "" } ] }, "id": 1 } ``` [comment]: # ({/6697de6d-f4b01bbe}) [comment]: # ({8d9fbd3b-d3276b35}) ### See also - [Discovery rule](/manual/api/reference/discoveryrule/object#discovery-rule) - [Graph](/manual/api/reference/graph/object#graph) - [Host](/manual/api/reference/host/object#host) - [Host interface](/manual/api/reference/hostinterface/object#host-interface) - [Trigger](/manual/api/reference/trigger/object#trigger) [comment]: # ({/8d9fbd3b-d3276b35}) [comment]: # ({a6ef1d0f-a6ef1d0f}) ### Source CItem::get() in *ui/include/classes/api/services/CItem.php*. [comment]: # ({/a6ef1d0f-a6ef1d0f})