dashboard_get
Read-only
Retrieve Zabbix dashboards with widgets, pages, and sharing settings; filter, sort, and include related users or groups as needed.
Instructions
Retrieve dashboards with their widgets, pages, and user/group sharing settings. Dashboards are the primary visualization surface in Zabbix, containing pages with widgets that display graphs, maps, problems, and other monitoring data. Use the 'output' parameter to control which fields are returned and 'selectPages' / 'selectUsers' / 'selectUserGroups' in the filter to include related 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: auto_start (6.0+), dashboardid, display_period (6.0+), name, private, userid. Text properties cannot be filtered; use 'search' for them. | |
| output | No | Properties of the dashboard object to return. Pass 'extend' for all, 'count' for the number of matches only, or a list of property names. Default when omitted: dashboardid, name. Properties: auto_start (6.0+), dashboardid, display_period (6.0+), name, private, userid. | |
| 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: dashboardid, 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). | |
| selectPages | No | Include dashboard pages and their widgets in the output. Set to 'extend' to return all page/widget fields. | |
| dashboardids | No | Return only dashboards with the given IDs. | |
| extra_params | No | Other native dashboard.get parameters, merged into the request as-is. Sub-object selects (value 'extend', 'count' or a list of property names): selectUserGroups, selectUsers. 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. |