itemprototype.get

    The method allows to retrieve item prototypes 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.

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

    Examples

    Retrieving item prototypes from an LLD rule

    Retrieve all item prototypes from an LLD rule.

    Request:

    Response:

    1. {
    2.            "jsonrpc": "2.0",
    3.            "result": [
    4.                {
    5.                    "itemid": "23077",
    6.                    "type": "0",
    7.                    "snmp_oid": "",
    8.                    "hostid": "10079",
    9.                    "name": "Incoming network traffic on en0",
    10.                    "key_": "net.if.in[en0]",
    11.                    "delay": "1m",
    12.                    "history": "1w",
    13.                    "trends": "365d",
    14.                    "status": "0",
    15.                    "value_type": "3",
    16.                    "trapper_hosts": "",
    17.                    "units": "bps",
    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": "",
    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.                    "discover": "0",
    62.                    "parameters": []
    63.                },
    64.                {
    65.                    "itemid": "10010",
    67.                    "snmp_oid": "",
    68.                    "hostid": "10001",
    69.                    "name": "Processor load (1 min average per core)",
    70.                    "key_": "system.cpu.load[percpu,avg1]",
    71.                    "delay": "1m",
    72.                    "history": "1w",
    73.                    "trends": "365d",
    74.                    "status": "0",
    75.                    "value_type": "0",
    76.                    "trapper_hosts": "",
    77.                    "units": "",
    78.                    "formula": "",
    79.                    "logtimefmt": "",
    80.                    "templateid": "0",
    81.                    "valuemapid": "0",
    82.                    "params": "",
    83.                    "ipmi_sensor": "",
    84.                    "authtype": "0",
    85.                    "username": "",
    86.                    "password": "",
    87.                    "publickey": "",
    88.                    "privatekey": "",
    89.                    "flags": "0",
    90.                    "interfaceid": "0",
    91.                    "description": "The processor load is calculated as system CPU load divided by number of CPU cores.",
    92.                    "inventory_link": "0",
    93.                    "lifetime": "0",
    94.                    "state": "0",
    95.                    "evaltype": "0",
    96.                    "jmx_endpoint": "",
    97.                    "master_itemid": "0",
    98.                    "timeout": "3s",
    99.                    "url": "",
    100.                    "query_fields": [],
    101.                    "posts": "",
    102.                    "status_codes": "200",
    103.                    "follow_redirects": "1",
    104.                    "post_type": "0",
    105.                    "http_proxy": "",
    106.                    "headers": [],
    107.                    "retrieve_mode": "0",
    108.                    "request_method": "0",
    109.                    "output_format": "0",
    110.                    "ssl_cert_file": "",
    111.                    "ssl_key_file": "",
    112.                    "ssl_key_password": "",
    113.                    "verify_peer": "0",
    114.                    "verify_host": "0",
    115.                    "allow_traps": "0",
    116.                    "lastclock": "0",
    117.                    "lastns": "0",
    118.                    "lastvalue": "0",
    119.                    "prevvalue": "0",
    120.                    "discover": "0",
    121.                    "parameters": []
    122.                }
    123.            ],
    124.            "id": 1
    125.        }

    Finding dependent item

    Find one Dependent item for item with ID “25545”.

    Response:

    1. {
    2.            "jsonrpc": "2.0",
    3.            "result": [
    4.                {
    5.                    "itemid": "25547",
    6.                    "type": "18",
    7.                    "snmp_oid": "",
    8.                    "hostid": "10116",
    9.                    "name": "Seconds",
    10.                    "key_": "apache.status.uptime.seconds",
    11.                    "delay": "0",
    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",
    35.                    "state": "0",
    36.                    "evaltype": "0",
    37.                    "master_itemid": "25545",
    38.                    "jmx_endpoint": "",
    39.                    "master_itemid": "0",
    40.                    "timeout": "3s",
    41.                    "url": "",
    42.                    "query_fields": [],
    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.                    "discover": "0",
    62.                    "parameters": []
    63.                }
    64.            ],
    65.            "id": 1
    66.        }

    Find HTTP agent item prototype

    Find HTTP agent item prototype with request method HEAD for specific host id.

    Request:

    Response:

    1. {
    2.            "jsonrpc": "2.0",
    3.            "result": [
    4.                {
    5.                    "itemid": "28257",
    6.                    "type": "19",
    7.                    "snmp_oid": "",
    8.                    "hostid": "10254",
    9.                    "name": "discovered",
    10.                    "key_": "item[{#INAME}]",
    11.                    "delay": "{#IUPDATE}",
    12.                    "history": "90d",
    13.                    "trends": "30d",
    14.                    "status": "0",
    15.                    "value_type": "3",
    16.                    "trapper_hosts": "",
    17.                    "units": "",
    18.                    "formula": "",
    19.                    "error": "",
    20.                    "logtimefmt": "",
    21.                    "templateid": "28255",
    22.                    "valuemapid": "0",
    23.                    "params": "",
    24.                    "ipmi_sensor": "",
    25.                    "authtype": "0",
    26.                    "username": "",
    27.                    "password": "",
    28.                    "publickey": "",
    29.                    "privatekey": "",
    30.                    "flags": "2",
    31.                    "interfaceid": "2",
    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": "{#IURL}",
    41.                    "query_fields": [],
    42.                    "posts": "",
    43.                    "status_codes": "",
    44.                    "follow_redirects": "0",
    45.                    "post_type": "0",
    46.                    "http_proxy": "",
    47.                    "headers": [],
    48.                    "retrieve_mode": "0",
    49.                    "request_method": "3",
    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.                    "discover": "0",
    58.                    "parameters": []
    59.                }
    60.            ],
    62.        }

    Source