This is a translation of the original English documentation page. Help us make it better.

Sidebar

Become a monitoring expert!
Sign up for Zabbix training

> Maintenance object

The following objects are directly related to the maintenance API.

Maintenance

The maintenance object has the following properties.

Property Type Description
maintenanceid string (readonly) ID of the maintenance.
name
(required)
string Name of the maintenance.
active_since
(required)
timestamp Time when the maintenance becomes active.

The given value will be rounded down to minutes.
active_till
(required)
timestamp Time when the maintenance stops being active.

The given value will be rounded down to minutes.
description string Description of the maintenance.
maintenance_type integer Type of maintenance.

Possible values:
0 - (default) with data collection;
1 - without data collection.
tags_evaltype integer Problem tag evaluation method.

Possible values:
0 - (default) And/Or;
2 - Or.

Time period

The time period object is used to define periods when the maintenance must come into effect. It has the following properties.

Property Type Description
period integer Duration of the maintenance period in seconds.

The given value will be rounded down to minutes.

Default: 3600.
timeperiod_type integer Type of time period.

Possible values:
0 - (default) one time only;
2 - daily;
3 - weekly;
4 - monthly.
start_date timestamp Date when the maintenance period must come into effect.

Used only for one time periods.

The given value will be rounded down to minutes.

Default: current date.
start_time integer Time of day when the maintenance starts in seconds.

Used for daily, weekly and monthly periods.

The given value will be rounded down to minutes.

Default: 0.
every integer Used for daily, weekly and monthly periods.

For daily and weekly periods every defines day or week intervals at which the maintenance must come into effect.

Default: 1.

For monthly periods, if dayofweek property contains at least one selected day of week, the every property defines the week of the month when the maintenance must come into effect.

Possible values:
1 - (default) first week;
2 - second week;
3 - third week;
4 - fourth week;
5 - last week.
dayofweek integer Days of the week when the maintenance must come into effect.

Days are stored in binary form with each bit representing the corresponding day. For example, 4 equals 100 in binary and means, that maintenance will be enabled on Wednesday.

Used for weekly and monthly time periods. Required only for weekly time periods.

At least one dayofweek or day must be specified for monthly time periods.
day integer Day of the month when the maintenance must come into effect.

Used only for monthly time periods.

At least one dayofweek or day must be specified for monthly time periods.
month integer Months when the maintenance must come into effect.

Months are stored in binary form with each bit representing the corresponding month. For example, 5 equals 101 in binary and means, that maintenance will be enabled in January and March.

Required only for monthly time periods.

Problem tag

The problem tag object is used to define which problems must be suppressed when the maintenance comes into effect. It has the following properties.

Property Type Description
tag
(required)
string Problem tag name.
operator integer Condition operator.

Possible values:
0 - Equals;
2 - (default) Contains.
value string Problem tag value.