# hostgroup.exists

### Description

`boolean hostgroup.exists(object filter)`

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

### 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.|
|node|string|Name of the node the host groups must belong to.<br><br>This will override the `nodeids` parameter.|
|nodeids|string/array|IDs of the nodes the host groups must belong to.|

### Return values

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

### Examples

#### Check host group on a node

Check if a host group called "Zabbix servers" exists on the node with ID
1.

Request:

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

Response:

``` {.java}
{
    "jsonrpc": "2.0",
    "result": true,
    "id": 1
}
```

### See also

-   [hostgroup.isreadable](isreadable)
-   [hostgroup.iswritable](iswritable)

### Source

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