host.exists

Description

boolean host.exists(object filter)

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

Parameters

(object) Criteria to search by.

The following parameters are supported as search criteria.

Parameter Type Description
hostid string/array Host IDs.
host string/array Technical names of the hosts.
name string/array Visible names of the hosts.
node string Name of the node the hosts must belong to.

This will override the nodeids parameter.
nodeids string/array IDs of the node the hosts must belong to.

Return values

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

Examples

Check host on a node

Check if a host with the technical name "Zabbix Server" exists on the node with ID 1.

Request:

{
    "jsonrpc": "2.0",
    "method": "host.exists",
    "params": {
        "host": "Zabbix Server",
        "nodeids": [
            "1"
        ]
    },
    "auth": "038e1d7b1735c6a5436ee9eae095879e",
    "id": 1
}

Response:

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

See also

Source

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