hostgroup_get
Read-only
Retrieve Zabbix host groups to organize hosts, control access permissions, and filter related hosts, items, and triggers by group.
Instructions
Retrieve host groups. Host groups are used to logically organize hosts and to control access permissions. Every host must belong to at least one host group. Groups can also be used to filter when retrieving hosts, items, triggers, etc.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Maximum number of results to return. | |
| filter | No | Return only results whose properties exactly match the given values (a single value or a list of values per key). Example: {"status": 0} or {"status": [0, 1]}. Keys: flags, groupid, internal (removed in 6.2), name, uuid (6.0+). Text properties cannot be filtered; use 'search' for them. | |
| output | No | Properties of the hostgroup object to return. Pass 'extend' for all, 'count' for the number of matches only, or a list of property names. Default when omitted: groupid, name. Properties: flags, groupid, internal (removed in 6.2), name, uuid (6.0+). | |
| search | No | Return results whose string properties contain the given pattern (case-insensitive; '*' is a wildcard when searchWildcardsEnabled is true). Example: {"name": "web"}. Keys: name, uuid (6.0+). | |
| server | No | Target Zabbix server. Available: default. Defaults to 'default' if omitted. | |
| hostids | No | Return only host groups that contain the given hosts. | |
| groupids | No | Return only host groups with the given IDs. | |
| raw_json | No | Strips the security disclaimer preamble from the response so it is pure JSON. Default: false. Requires the bearer token to have 'allow_raw_json' explicitly enabled by an operator in the admin portal - tokens without that policy receive a PolicyError instead. WARNING: setting true bypasses the prompt-injection mitigation marker that wraps untrusted Zabbix data (host names, item descriptions, problem text). LLM clients (Claude, GPT, Cursor, ...) should leave this false; only programmatic non-LLM consumers (Python scripts, n8n workflows that json.loads the result) should set true. | |
| sortfield | No | Sort by one or more of: groupid, name (a list for several; pair with 'sortorder'). No other property is sortable. | |
| sortorder | No | Sort order: 'ASC' (ascending) or 'DESC' (descending). | |
| with_hosts | No | Only return host groups that contain at least one host. | |
| countOutput | No | Return the count of matching results instead of the actual data. | |
| searchByAny | No | If true, return results matching ANY search field (OR). Default is ALL fields (AND). | |
| extra_params | No | Other native hostgroup.get parameters, merged into the request as-is. Parameters: graphids, groupCount (removed in 6.2), limitSelects, maintenanceids, monitored_hosts (removed in 7.2), real_hosts (removed in 7.2), templated_hosts (removed in 6.2), templateids (removed in 6.2), triggerids, with_graph_prototypes, with_graphs, with_hosts_and_templates (removed in 6.2), with_httptests, with_item_prototypes, with_items, with_monitored_httptests, with_monitored_items, with_monitored_triggers, with_simple_graph_item_prototypes, with_simple_graph_items, with_triggers. Switches (true turns one on, false is the same as leaving it out): groupCount, monitored_hosts, real_hosts, templated_hosts, with_graph_prototypes, with_graphs, with_hosts_and_templates, with_httptests, with_item_prototypes, with_items, with_monitored_httptests, with_monitored_items, with_monitored_triggers, with_simple_graph_item_prototypes, with_simple_graph_items, with_triggers. groupCount (removed in 6.2) goes with output='count': the count is then split by the ID filters the method groups by (hostids, groupids ...), one row per ID with 'rowscount'; a single row without such a filter. Sub-object selects (value 'extend', 'count' or a list of property names): selectDiscoveryData (7.4+), selectDiscoveryRule (removed in 7.0), selectDiscoveryRules (7.0+), selectGroupDiscoveries (7.0+, deprecated in 7.4, use selectDiscoveryData), selectGroupDiscovery (removed in 7.0), selectHostPrototype (removed in 7.0), selectHostPrototypes (7.0+), selectHosts, selectTemplates (removed in 6.2). Any other key is refused here, because Zabbix would silently ignore it. For a parameter you are sure exists on your release but is not listed, use zabbix_raw_api_call. | |
| with_monitored_hosts | No | Only return host groups that contain at least one monitored (enabled) host. | |
| searchWildcardsEnabled | No | If true, enable * and ? wildcards in search patterns. |