iconmap_get
Read-only
Retrieve icon maps that assign network map icons based on host inventory fields, and include mapping rules to verify how routers, switches, and servers get distinct icons.
Instructions
Retrieve icon maps used on network maps. Icon maps automatically assign icons to map elements based on host inventory field values. For example, map a host's 'type' inventory field so that routers, switches, and servers each display a distinct icon. Use selectMappings to include the mapping rules in the response.
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: default_iconid, iconmapid, name. Text properties cannot be filtered; use 'search' for them. | |
| output | No | Properties of the iconmap object to return. Pass 'extend' for all, 'count' for the number of matches only, or a list of property names. Default when omitted: iconmapid, name. Properties: default_iconid, iconmapid, name. | |
| 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. | |
| server | No | Target Zabbix server. Available: default. Defaults to 'default' if omitted. | |
| 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: iconmapid, name (a list for several; pair with 'sortorder'). No other property is sortable. | |
| sortorder | No | Sort order: 'ASC' (ascending) or 'DESC' (descending). | |
| iconmapids | No | Return only icon maps with the given IDs. | |
| 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 iconmap.get parameters, merged into the request as-is. Parameters: sysmapids. Sub-object selects (value 'extend', 'count' or a list of property names): selectMappings. 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. |