hostdashboard_get
Read-only
Retrieve the dashboards a host inherits from linked templates, returning host, template, dashboard, and display details. Provide host IDs to list each host-template dashboard record.
Instructions
Retrieve the dashboards a host has through its linked templates (Zabbix 7.0+): one record per host and template dashboard with hostid, dashboardid, name, display_period, auto_start and the templateid it comes from. 'hostids' is required. Use selectPages in extra_params for the pages and widgets as resolved for that host. For the template dashboards themselves use templatedashboard_get, for global dashboards dashboard_get. Not documented in the API reference.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Maximum number of records 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]}. Only these keys are accepted: dashboardid, name, display_period, auto_start, templateid. Text properties cannot be filtered; use 'search' for them. | |
| output | No | Properties of the hostdashboard object to return. Pass 'extend' for all, 'count' for the number of matches only, or a list of property names. Default when omitted: hostid, dashboardid, name, templateid. Properties: auto_start, dashboardid, display_period, hostid, name, templateid. | |
| search | No | Return results whose string properties contain the given pattern (case-insensitive; '*' is a wildcard when searchWildcardsEnabled is true). Example: {"name": "web"}. Only these keys are accepted: name. | |
| server | No | Target Zabbix server. Available: default. Defaults to 'default' if omitted. | |
| hostids | Yes | Return the dashboards of these hosts (required). | |
| 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: hostid, dashboardid, name (a list for several; pair with 'sortorder'). No other property is sortable. | |
| sortorder | No | Sort order: 'ASC' or 'DESC'. | |
| countOutput | No | Return the count instead of the records. | |
| dashboardids | No | Return only the given template dashboards. | |
| extra_params | No | Other native hostdashboard.get parameters, merged into the request as-is. Parameters: groupCount. 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): selectPages. 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. |