dcheck_get
Read-only
Retrieve read-only discovery checks defined in Zabbix network discovery rules, including SNMP, agent, ICMP ping, and TCP port tests.
Instructions
Retrieve discovery checks (read-only). Discovery checks are the individual tests (SNMP, agent, ICMP ping, TCP port, etc.) defined within a network discovery rule. Each discovery rule contains one or more checks.
Input Schema
TableJSON 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: allow_redirect (7.0+), dcheckid, druleid, host_source, key_, name_source, ports, snmp_community, snmpv3_authpassphrase, snmpv3_authprotocol, snmpv3_contextname, snmpv3_privpassphrase, snmpv3_privprotocol, snmpv3_securitylevel, snmpv3_securityname, type, uniq. Text properties cannot be filtered; use 'search' for them. | |
| output | No | Properties of the dcheck object to return. Pass 'extend' for all, 'count' for the number of matches only, or a comma-separated list of property names. Default when omitted: dcheckid, druleid, type. Properties: allow_redirect (7.0+), dcheckid, druleid, host_source, key_, name_source, ports, snmp_community, snmpv3_authpassphrase, snmpv3_authprotocol, snmpv3_contextname, snmpv3_privpassphrase, snmpv3_privprotocol, snmpv3_securitylevel, snmpv3_securityname, type, uniq. | |
| search | No | Return results whose string properties contain the given pattern (case-insensitive; '*' is a wildcard when searchWildcardsEnabled is true). Example: {"name": "web"}. Keys: key_, ports, snmp_community, snmpv3_authpassphrase, snmpv3_contextname, snmpv3_privpassphrase, snmpv3_securityname. | |
| server | No | Target Zabbix server. Available: default. Defaults to 'default' if omitted. | |
| druleids | No | Return only discovery checks belonging to the given network discovery rules. | |
| 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. | |
| dcheckids | No | Return only discovery checks with the given IDs. | |
| sortfield | No | Sort by one or more of: dcheckid, druleid (comma-separated 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 dcheck.get parameters, merged into the request as-is. Parameters: dserviceids. Sub-object selects (value 'extend', 'count' or a list of property names): selectDRules (6.0+). 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. |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |