Zabbix Documentation 2.0

Sidebar

itemprototype.exists

Description

boolean itemprototype.exists(object filter)

This method checks if at least one item prototype that matches the given filter criteria exists.

Parameters

(object) Criteria to search by.

The following parameters are supported as search criteria.

Parameter Type Description
key_
(required)
string/array Keys of the item prototypes.
host string/array Names of the hosts that the item prototypes must belong to.
hostid string/array IDs of the hosts that the item prototypes must belong to.
node string Name of the node the item prototypes must belong to.

This will override the nodeids parameter.
nodeids string/array IDs of the nodes the item prototypes must belong to.

Return values

(boolean) Returns true if at least one item prototype that matches the given filter criteria exists.

Examples

Checking if an item prototype exists on a host

Check if item prototype with key "net.if.in[{#IFNAME}]" exists on host "Zabbix server".

Request:

{
           "jsonrpc": "2.0",
           "method": "itemprototype.exists",
           "params": {
               "host": "Zabbix server",
               "key_": "net.if.in[{#IFNAME}]"
           },
           "auth": "3a57200802b24cda67c4e4010b50c065",
           "id": 1
       }

Response:

{
           "jsonrpc": "2.0",
           "result": true,
           "id": 1
       }

See also

Source

CItemPrototype::exists() in frontends/php/api/classes/CItemPrototype.php.