Sidebar

manual:api:reference:host:exists

host.exists

Description

boolean host.exists(object filter)

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

This method is deprecated and will be removed in the future. Please use host.get instead.

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.

Return values

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

Examples

Check host by name

Check if a host with the technical name “Zabbix Server” exists.

Request:

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

Response:

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

See also

Source

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