Sidebar

manual:appendix:api:discoveryrule:exists

discoveryrule.exists

Description

boolean discoveryrule.exists(object filter)

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

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

Return values

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

Examples

Checking if an LLD rule exists on a host

Check if the LLD rule with the key “vfs.fs.discovery” exists on host “Zabbix server”.

Request:

{
    "jsonrpc": "2.0",
    "method": "discoveryrule.exists",
    "params": {
        "host": "Zabbix server",
        "key_": "vfs.fs.discovery"
    },
    "auth": "3a57200802b24cda67c4e4010b50c065",
    "id": 1
}

Response:

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

See also

Source

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