drule_get
Read-only
Retrieve network discovery rules to inspect IP ranges and checks used for automatic host discovery in Zabbix, with filtering, sorting, and count options.
Instructions
Retrieve network discovery rules. Network discovery rules define IP ranges and checks (SNMP, agent, ICMP, etc.) used to automatically find new hosts on the network. Discovered hosts and services are stored as dhost/dservice objects.
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: concurrency_max (7.0+), delay, druleid, error (7.0+), iprange, name, nextcheck (removed in 6.4), proxy_hostid (removed in 7.0), proxyid (7.0+), status. Text properties cannot be filtered; use 'search' for them. | |
| output | No | Properties of the drule object to return. Pass 'extend' for all, 'count' for the number of matches only, or a list of property names. Default when omitted: druleid, name, status. Properties: concurrency_max (7.0+), delay, druleid, error (7.0+), iprange, name, nextcheck (removed in 6.4), proxy_hostid (removed in 7.0), proxyid (7.0+), status. | |
| search | No | Return results whose string properties contain the given pattern (case-insensitive; '*' is a wildcard when searchWildcardsEnabled is true). Example: {"name": "web"}. Keys: delay, error (7.0+), iprange, name. | |
| server | No | Target Zabbix server. Available: default. Defaults to 'default' if omitted. | |
| druleids | No | Return only network discovery rules 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: druleid, name (a list for several; pair with 'sortorder'). No other property is sortable. | |
| sortorder | No | Sort order: 'ASC' (ascending) or 'DESC' (descending). | |
| 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 drule.get parameters, merged into the request as-is. Parameters: dhostids, dserviceids, groupCount, limitSelects. Switches (true turns one on, false is the same as leaving it out): groupCount. groupCount 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): selectDChecks, selectDHosts. 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. | |
| searchWildcardsEnabled | No | If true, enable * and ? wildcards in search patterns. |