item.exists

Description

boolean item.exists(object filter)

This method checks if at least one item 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 items.
host string/array Names of the hosts that the items must belong to.
hostid string/array IDs of the hosts that the items must belong to.
node string Name of the node the items must belong to.

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

Return values

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

Examples

Check item by key

Check if an item with key "vm.memory.size[available]" exists on the host "Linux Server."

Request:

{
    "jsonrpc": "2.0",
    "method": "item.exists",
    "params": {
        "host": "Linux Server",
        "key_": "vm.memory.size[available]"
    },
    "auth": "3a57200802b24cda67c4e4010b50c065",
    "id": 1
}

Response:

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

See also

Source

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