This is the documentation page for an unsupported version of Zabbix.
Is this not what you were looking for? Switch to the current version or choose one from the drop-down menu.

hostgroup.delete

Description

object hostgroup.delete(array hostGroupIds)

This method allows to delete host groups.

A host group can not be deleted if:

  • it contains hosts that belong to this group only;
  • it is marked as internal;
  • it is used by a host prototype;
  • it is used in a global script;
  • it is used in a correlation condition.

Parameters

(array) IDs of the host groups to delete.

Return values

(object) Returns an object containing the IDs of the deleted host groups under the groupids property.

Examples

Deleting multiple host groups

Delete two host groups.

Request:

{
           "jsonrpc": "2.0",
           "method": "hostgroup.delete",
           "params": [
               "107824",
               "107825"
           ],
           "auth": "3a57200802b24cda67c4e4010b50c065",
           "id": 1
       }
Copy
✔ Copied

Response:

{
           "jsonrpc": "2.0",
           "result": {
               "groupids": [
                   "107824",
                   "107825"
               ]
           },
           "id": 1
       }
Copy
✔ Copied

Source

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

To toggle search highlight, press Ctrl+Alt+H
Have an improvement suggestion for this page? Select the text that could be improved and press Ctrl+Enter to send it to the editors.