maintenance_get
Read-only
Retrieve Zabbix maintenance periods to identify scheduled downtime windows, check which hosts or host groups are affected, and verify when problem notifications are suppressed or data collection is paused.
Instructions
Retrieve maintenance periods. Maintenance windows suppress problem notifications and optionally pause data collection for specified hosts or host groups during scheduled downtime (e.g., patching windows).
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: active_since, active_till, maintenance_type, maintenanceid, name, tags_evaltype. Text properties cannot be filtered; use 'search' for them. | |
| output | No | Properties of the maintenance object to return. Pass 'extend' for all, 'count' for the number of matches only, or a list of property names. Default when omitted: maintenanceid, name, active_since, active_till. Properties: active_since, active_till, description, maintenance_type, maintenanceid, name, tags_evaltype. | |
| search | No | Return results whose string properties contain the given pattern (case-insensitive; '*' is a wildcard when searchWildcardsEnabled is true). Example: {"name": "web"}. Keys: description, name. | |
| server | No | Target Zabbix server. Available: default. Defaults to 'default' if omitted. | |
| hostids | No | Return only maintenance periods that affect the given hosts. | |
| groupids | No | Return only maintenance periods that affect the given host groups. | |
| 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: maintenanceid, name, maintenance_type, active_since, active_till (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 maintenance.get parameters, merged into the request as-is. Parameters: groupCount, triggerids (8.0+). 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): selectEventNames (8.0+), selectGroups (removed in 7.2), selectHostGroups (6.2+), selectHosts, selectTags, selectTimeperiods, selectTriggers (8.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. | |
| maintenanceids | No | Return only maintenance periods with the given IDs. | |
| searchWildcardsEnabled | No | If true, enable * and ? wildcards in search patterns. |