Sidebar

manual:api:reference:hostgroup:exists

hostgroup.exists

Description

boolean hostgroup.exists(object filter)

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

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

Parameters

(object) Criteria to search by.

The following parameters are supported as search criteria.

Parameter Type Description
groupid string/array Host group IDs.
name string/array Names of the host groups.

Return values

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

Examples

Check host group by name

Check if a host group called “Zabbix servers” exists.

Request:

{
    "jsonrpc": "2.0",
    "method": "hostgroup.exists",
    "params": {
        "name": "Linux servers"
    },
    "auth": "3a57200802b24cda67c4e4010b50c065",
    "id": 1
}

Response:

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

See also

Source

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