item.get

    The method allows to retrieve items according to the given parameters.

    This method is available to users of any type. Permissions to call the method can be revoked in user role settings. See User roles for more information.

    Parameters

    (object) Parameters defining the desired output.

    The method supports the following parameters.

    (integer/array) Returns either:

    • an array of objects;
    • the count of retrieved objects, if the countOutput parameter has been used.

    Examples

    Finding items by key

    Request:

    Response:

    1. {
    2.            "jsonrpc": "2.0",
    3.            "result": [
    4.                {
    5.                    "itemid": "23298",
    6.                    "type": "0",
    7.                    "snmp_oid": "",
    8.                    "hostid": "10084",
    9.                    "name": "Context switches per second",
    10.                    "key_": "system.cpu.switches",
    11.                    "delay": "1m",
    12.                    "history": "7d",
    13.                    "trends": "365d",
    14.                    "lastvalue": "2552",
    15.                    "lastclock": "1351090998",
    16.                    "prevvalue": "2641",
    17.                    "state": "0",
    18.                    "status": "0",
    19.                    "value_type": "3",
    20.                    "trapper_hosts": "",
    21.                    "units": "sps",
    22.                    "error": "",
    23.                    "logtimefmt": "",
    24.                    "templateid": "22680",
    25.                    "valuemapid": "0",
    26.                    "params": "",
    27.                    "ipmi_sensor": "",
    28.                    "authtype": "0",
    29.                    "username": "",
    30.                    "password": "",
    31.                    "publickey": "",
    32.                    "privatekey": "",
    33.                    "lastns": "564054253",
    34.                    "flags": "0",
    35.                    "interfaceid": "1",
    36.                    "description": "",
    37.                    "inventory_link": "0",
    38.                    "lifetime": "0s",
    39.                    "evaltype": "0",
    40.                    "jmx_endpoint": "",
    41.                    "master_itemid": "0",
    42.                    "timeout": "3s",
    43.                    "url": "",
    44.                    "query_fields": [],
    45.                    "posts": "",
    46.                    "status_codes": "200",
    47.                    "follow_redirects": "1",
    48.                    "post_type": "0",
    49.                    "http_proxy": "",
    50.                    "headers": [],
    51.                    "retrieve_mode": "0",
    52.                    "request_method": "0",
    53.                    "output_format": "0",
    54.                    "ssl_cert_file": "",
    55.                    "ssl_key_file": "",
    56.                    "ssl_key_password": "",
    57.                    "verify_peer": "0",
    58.                    "verify_host": "0",
    59.                    "allow_traps": "0",
    60.                    "parameters": []
    61.                },
    62.                {
    63.                    "itemid": "23299",
    64.                    "type": "0",
    65.                    "snmp_oid": "",
    66.                    "hostid": "10084",
    67.                    "name": "CPU $2 time",
    68.                    "key_": "system.cpu.util[,idle]",
    69.                    "delay": "1m",
    70.                    "history": "7d",
    71.                    "trends": "365d",
    72.                    "lastvalue": "86.031879",
    73.                    "lastclock": "1351090999",
    74.                    "prevvalue": "85.306944",
    75.                    "state": "0",
    76.                    "status": "0",
    77.                    "value_type": "0",
    78.                    "trapper_hosts": "",
    79.                    "units": "%",
    80.                    "error": "",
    81.                    "logtimefmt": "",
    82.                    "templateid": "17354",
    83.                    "valuemapid": "0",
    84.                    "params": "",
    85.                    "ipmi_sensor": "",
    86.                    "authtype": "0",
    87.                    "username": "",
    88.                    "password": "",
    89.                    "publickey": "",
    90.                    "privatekey": "",
    91.                    "lastns": "564256864",
    92.                    "flags": "0",
    93.                    "interfaceid": "1",
    94.                    "description": "The time the CPU has spent doing nothing.",
    95.                    "inventory_link": "0",
    96.                    "lifetime": "0s",
    97.                    "evaltype": "0",
    98.                    "jmx_endpoint": "",
    99.                    "master_itemid": "0",
    101.                    "url": "",
    102.                    "query_fields": [],
    103.                    "posts": "",
    104.                    "status_codes": "200",
    105.                    "follow_redirects": "1",
    106.                    "post_type": "0",
    107.                    "http_proxy": "",
    108.                    "headers": [],
    109.                    "retrieve_mode": "0",
    110.                    "request_method": "0",
    111.                    "output_format": "0",
    112.                    "ssl_cert_file": "",
    113.                    "ssl_key_file": "",
    114.                    "ssl_key_password": "",
    115.                    "verify_peer": "0",
    116.                    "verify_host": "0",
    117.                    "allow_traps": "0",
    118.                    "parameters": []
    119.                },
    120.                {
    121.                    "itemid": "23300",
    122.                    "type": "0",
    123.                    "hostid": "10084",
    124.                    "name": "CPU $2 time",
    125.                    "key_": "system.cpu.util[,interrupt]",
    126.                    "history": "7d",
    127.                    "trends": "365d",
    128.                    "lastvalue": "0.008389",
    129.                    "lastclock": "1351091000",
    130.                    "prevvalue": "0.000000",
    131.                    "state": "0",
    132.                    "status": "0",
    133.                    "value_type": "0",
    134.                    "trapper_hosts": "",
    135.                    "units": "%",
    136.                    "error": "",
    137.                    "logtimefmt": "",
    138.                    "templateid": "22671",
    139.                    "valuemapid": "0",
    140.                    "params": "",
    141.                    "ipmi_sensor": "",
    142.                    "authtype": "0",
    143.                    "username": "",
    144.                    "password": "",
    145.                    "publickey": "",
    146.                    "privatekey": "",
    147.                    "lastns": "564661387",
    148.                    "flags": "0",
    149.                    "interfaceid": "1",
    150.                    "description": "The amount of time the CPU has been servicing hardware interrupts.",
    151.                    "inventory_link": "0",
    152.                    "lifetime": "0s",
    153.                    "evaltype": "0",
    154.                    "jmx_endpoint": "",
    155.                    "master_itemid": "0",
    156.                    "timeout": "3s",
    157.                    "url": "",
    158.                    "query_fields": [],
    159.                    "posts": "",
    160.                    "status_codes": "200",
    161.                    "follow_redirects": "1",
    162.                    "post_type": "0",
    163.                    "http_proxy": "",
    164.                    "headers": [],
    165.                    "retrieve_mode": "0",
    166.                    "request_method": "0",
    167.                    "output_format": "0",
    168.                    "ssl_cert_file": "",
    169.                    "ssl_key_file": "",
    170.                    "ssl_key_password": "",
    171.                    "verify_peer": "0",
    172.                    "verify_host": "0",
    173.                    "allow_traps": "0",
    174.                    "parameters": []
    175.                }
    176.            ],
    177.            "id": 1
    178.        }

    Finding dependent items by key

    Retrieve all dependent items from host with ID “10116” that have the word “apache” in the key.

    Request:

    Response:

    1. {
    2.            "jsonrpc": "2.0",
    3.            "result": [
    4.                {
    5.                    "itemid": "25550",
    6.                    "type": "18",
    7.                    "snmp_oid": "",
    8.                    "hostid": "10116",
    9.                    "name": "Days",
    10.                    "key_": "apache.status.uptime.days",
    11.                    "delay": "",
    12.                    "history": "90d",
    13.                    "trends": "365d",
    14.                    "status": "0",
    15.                    "value_type": "3",
    16.                    "trapper_hosts": "",
    17.                    "units": "",
    18.                    "formula": "",
    19.                    "error": "",
    20.                    "logtimefmt": "",
    21.                    "templateid": "0",
    22.                    "valuemapid": "0",
    23.                    "params": "",
    24.                    "ipmi_sensor": "",
    25.                    "authtype": "0",
    26.                    "username": "",
    27.                    "password": "",
    28.                    "publickey": "",
    29.                    "privatekey": "",
    30.                    "flags": "0",
    31.                    "interfaceid": "0",
    32.                    "description": "",
    33.                    "inventory_link": "0",
    34.                    "lifetime": "30d",
    35.                    "state": "0",
    36.                    "evaltype": "0",
    37.                    "master_itemid": "25545",
    38.                    "jmx_endpoint": "",
    39.                    "timeout": "3s",
    40.                    "url": "",
    41.                    "query_fields": [],
    42.                    "posts": "",
    43.                    "status_codes": "200",
    44.                    "follow_redirects": "1",
    45.                    "post_type": "0",
    46.                    "http_proxy": "",
    47.                    "headers": [],
    48.                    "retrieve_mode": "0",
    49.                    "request_method": "0",
    50.                    "output_format": "0",
    51.                    "ssl_cert_file": "",
    52.                    "ssl_key_file": "",
    53.                    "ssl_key_password": "",
    54.                    "verify_peer": "0",
    55.                    "verify_host": "0",
    56.                    "allow_traps": "0",
    57.                    "lastclock": "0",
    58.                    "lastns": "0",
    59.                    "lastvalue": "0",
    60.                    "prevvalue": "0",
    61.                    "parameters": []
    62.                },
    63.                {
    64.                    "itemid": "25555",
    65.                    "type": "18",
    67.                    "hostid": "10116",
    68.                    "name": "Hours",
    69.                    "key_": "apache.status.uptime.hours",
    70.                    "delay": "0",
    71.                    "history": "90d",
    72.                    "trends": "365d",
    73.                    "status": "0",
    74.                    "value_type": "3",
    75.                    "trapper_hosts": "",
    76.                    "units": "",
    77.                    "formula": "",
    78.                    "error": "",
    79.                    "templateid": "0",
    80.                    "valuemapid": "0",
    81.                    "params": "",
    82.                    "ipmi_sensor": "",
    83.                    "authtype": "0",
    84.                    "username": "",
    85.                    "password": "",
    86.                    "publickey": "",
    87.                    "privatekey": "",
    88.                    "flags": "0",
    89.                    "interfaceid": "0",
    90.                    "description": "",
    91.                    "inventory_link": "0",
    92.                    "lifetime": "30d",
    93.                    "state": "0",
    94.                    "evaltype": "0",
    95.                    "master_itemid": "25545",
    96.                    "jmx_endpoint": "",
    97.                    "timeout": "3s",
    98.                    "url": "",
    99.                    "query_fields": [],
    100.                    "posts": "",
    101.                    "status_codes": "200",
    102.                    "follow_redirects": "1",
    103.                    "post_type": "0",
    104.                    "http_proxy": "",
    105.                    "headers": [],
    106.                    "retrieve_mode": "0",
    107.                    "request_method": "0",
    108.                    "output_format": "0",
    109.                    "ssl_cert_file": "",
    110.                    "ssl_key_file": "",
    111.                    "ssl_key_password": "",
    112.                    "verify_peer": "0",
    113.                    "verify_host": "0",
    114.                    "allow_traps": "0",
    115.                    "lastclock": "0",
    116.                    "lastns": "0",
    117.                    "lastvalue": "0",
    118.                    "prevvalue": "0",
    119.                    "parameters": []
    120.                }
    121.            ],
    122.            "id": 1
    123.        }

    Find HTTP agent item

    Request:

    Response:

    1. {
    2.            "jsonrpc": "2.0",
    3.            "result": [
    4.                {
    5.                    "itemid": "28252",
    6.                    "type": "19",
    7.                    "snmp_oid": "",
    8.                    "hostid": "10255",
    9.                    "name": "template item",
    10.                    "key_": "ti",
    11.                    "delay": "30s",
    12.                    "history": "90d",
    13.                    "trends": "365d",
    14.                    "status": "0",
    15.                    "value_type": "3",
    16.                    "trapper_hosts": "",
    17.                    "units": "",
    18.                    "formula": "",
    19.                    "error": "",
    20.                    "logtimefmt": "",
    21.                    "templateid": "0",
    22.                    "valuemapid": "0",
    23.                    "params": "",
    24.                    "ipmi_sensor": "",
    25.                    "authtype": "0",
    26.                    "username": "",
    27.                    "password": "",
    28.                    "publickey": "",
    29.                    "privatekey": "",
    30.                    "flags": "0",
    31.                    "interfaceid": "0",
    32.                    "description": "",
    33.                    "inventory_link": "0",
    34.                    "lifetime": "30d",
    35.                    "state": "0",
    36.                    "evaltype": "0",
    37.                    "jmx_endpoint": "",
    38.                    "master_itemid": "0",
    39.                    "timeout": "3s",
    40.                    "url": "localhost",
    41.                    "query_fields": [
    42.                        {
    43.                            "mode": "xml"
    44.                        }
    45.                    ],
    46.                    "posts": "<body>\r\n<![CDATA[{$MACRO}<foo></bar>]]>\r\n</body>",
    47.                    "status_codes": "200",
    48.                    "follow_redirects": "0",
    49.                    "post_type": "3",
    50.                    "http_proxy": "",
    51.                    "headers": [],
    52.                    "retrieve_mode": "1",
    53.                    "request_method": "3",
    54.                    "output_format": "0",
    55.                    "ssl_cert_file": "",
    56.                    "ssl_key_file": "",
    57.                    "ssl_key_password": "",
    58.                    "verify_peer": "0",
    59.                    "verify_host": "0",
    60.                    "allow_traps": "0",
    61.                    "lastclock": "0",
    62.                    "lastns": "0",
    63.                    "lastvalue": "0",
    64.                    "prevvalue": "0",
    65.                    "parameters": []
    66.                }
    67.            ],
    68.            "id": 3
    69.        }

    Retrieving items with preprocessing rules

    Reatrieve all items and their preprocessing rules from host with ID “10254”.

    Request:

    Response:

    1. {
    2.            "jsonrpc": "2.0",
    3.            "result": {
    4.                "itemid": "23865",
    5.                "name": "http agent example JSON",
    6.                "key_": "json",
    7.                "preprocessing": [
    8.                    {
    9.                        "type": "12",
    10.                        "params": "$.random",
    11.                        "error_handler": "1",
    12.                        "error_handler_params": ""
    13.                    }
    14.                ]
    15.            },
    16.            "id": 1
    17.        }

    Source