You are viewing documentation for the development version, it may be incomplete.
Join our translation project and help translate Zabbix documentation into your native language.



object maintenance.create(object/array maintenances)

This method allows to create new maintenances.

This method is only available to Admin and Super admin user types. Permissions to call the method can be revoked in user role settings. See User roles for more information.


(object/array) Maintenances to create.

Additionally to the standard maintenance properties, the method accepts the following parameters.

Parameter Type Description
groups object/array Host groups that will undergo maintenance.

The host groups must have only the groupid property defined.

Parameter behavior:
- required if hosts is not set
hosts object/array Hosts that will undergo maintenance.

The hosts must have only the hostid property defined.

Parameter behavior:
- required if groups is not set
timeperiods object/array Maintenance time periods.

Parameter behavior:
- required
tags object/array Problem tags.

Define what problems must be suppressed.
If no tags are given, all active maintenance host problems will be suppressed.

Parameter behavior:
- supported if maintenance_type of Maintenance object is set to "with data collection"
array This parameter is deprecated, please use groups instead.
IDs of the host groups that will undergo maintenance.
array This parameter is deprecated, please use hosts instead.
IDs of the hosts that will undergo maintenance.

Return values

(object) Returns an object containing the IDs of the created maintenances under the maintenanceids property. The order of the returned IDs matches the order of the passed maintenances.


Creating a maintenance

Create a maintenance with data collection for host group with ID "2" and with problem tags service:mysqld and error. It must be active from 22.01.2013 till 22.01.2014, come in effect each Sunday at 18:00 and last for one hour.


           "jsonrpc": "2.0",
           "method": "maintenance.create",
           "params": {
               "name": "Sunday maintenance",
               "active_since": 1358844540,
               "active_till": 1390466940,
               "tags_evaltype": 0,
               "groups": [
                   {"groupid": "2"}
               "timeperiods": [
                       "period": 3600,
                       "timeperiod_type": 3,
                       "start_time": 64800,
                       "every": 1,
                       "dayofweek": 64
               "tags": [
                       "tag": "service",
                       "operator": "0",
                       "value": "mysqld"
                       "tag": "error",
                       "operator": "2",
                       "value": ""
           "id": 1


           "jsonrpc": "2.0",
           "result": {
               "maintenanceids": [
           "id": 1

See also


CMaintenance::create() in ui/include/classes/api/services/CMaintenance.php.