> Housekeeping object

The following objects are directly related to the housekeeping API.

Housekeeping

The settings object has the following properties.

PropertyTypeDescription
hk_events_modeintegerEnable internal housekeeping for events and alerts.

Possible values:
0 - Disable;
1 - (default) Enable.
hk_events_triggerstringTrigger data storage period. Accepts seconds and time unit with suffix.

Default: 365d.
hk_events_servicestringService data storage period. Accepts seconds and time unit with suffix.

Default: 1d.
hk_events_internalstringInternal data storage period. Accepts seconds and time unit with suffix.

Default: 1d.
hk_events_discoverystringNetwork discovery data storage period. Accepts seconds and time unit with suffix.

Default: 1d.
hk_events_autoregstringAutoregistration data storage period. Accepts seconds and time unit with suffix.

Default: 1d.
hk_services_modeintegerEnable internal housekeeping for services.

Possible values:
0 - Disable;
1 - (default) Enable.
hk_servicesstringServices data storage period. Accepts seconds and time unit with suffix.

Default: 365d.
hk_audit_modeintegerEnable internal housekeeping for audit.

Possible values:
0 - Disable;
1 - (default) Enable.
hk_auditstringAudit data storage period. Accepts seconds and time unit with suffix.

Default: 365d.
hk_sessions_modeintegerEnable internal housekeeping for sessions.

Possible values:
0 - Disable;
1 - (default) Enable.
hk_sessionsstringSessions data storage period. Accepts seconds and time unit with suffix.

Default: 365d.
hk_history_modeintegerEnable internal housekeeping for history.

Possible values:
0 - Disable;
1 - (default) Enable.
hk_history_globalintegerOverride item history period.

Possible values:
0 - Do not override;
1 - (default) Override.
hk_historystringHistory data storage period. Accepts seconds and time unit with suffix.

Default: 90d.
hk_trends_modeintegerEnable internal housekeeping for trends.

Possible values:
0 - Disable;
1 - (default) Enable.
hk_trends_globalintegerOverride item trend period.

Possible values:
0 - Do not override;
1 - (default) Override.
hk_trendsstringTrends data storage period. Accepts seconds and time unit with suffix.

Default: 365d.
db_extensionstring(readonly) Configuration flag DB extension. If this flag is set to “timescaledb” then the server changes its behavior for housekeeping and item deletion.
compression_statusintegerEnable TimescaleDB compression for history and trends.

Possible values:
0 - (default) Off;
1 - On.
compress_olderstringCompress history and trends records older than specified period. Accepts seconds and time unit with suffix.

Default: 7d.
compression_availabilityinteger(readonly) Compression availability.

Possible values:
0 - Unavailable;
1 - Available.