hostgroup.getobjects

Description

array hostgroup.getobjects(object filter)

This method allows to retrieve host groups that match the given filter criteria.

Parameters

(object) Criteria to search by.

The following parameters are supported as search criteria.

Return values

(array) Returns an array of objects with all properties.

Examples

Retrieve a host group by name

Retrieve a host group called "Zabbix servers."

Request:

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

Response:

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "groupid": "2",
                   "name": "Linux servers",
                   "internal": "0"
               }
           ],
           "id": 16
       }

See also

• hostgroup.get

Source

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