Documentation
Table of Contents
> Housekeeping object
The following object are directly related to the housekeeping API.
Housekeeping
The settings object has the following properties.
| Property | Type | Description |
|---|---|---|
| hk_events_mode | integer | Enable internal housekeeping for events and alerts. Possible values: 0 - Disable; 1 - (default) Enable. |
| hk_events_trigger | string | Trigger data storage period. Accepts seconds and time unit with suffix. Default: 365d. |
| hk_events_internal | string | Internal data storage period. Accepts seconds and time unit with suffix. Default: 1d. |
| hk_events_discovery | string | Network discovery data storage period. Accepts seconds and time unit with suffix. Default: 1d. |
| hk_events_autoreg | string | Autoregistration data storage period. Accepts seconds and time unit with suffix. Default: 1d. |
| hk_services_mode | integer | Enable internal housekeeping for services. Possible values: 0 - Disable; 1 - (default) Enable. |
| hk_services | string | Services data storage period. Accepts seconds and time unit with suffix. Default: 365d. |
| hk_audit_mode | integer | Enable internal housekeeping for audit. Possible values: 0 - Disable; 1 - (default) Enable. |
| hk_audit | string | Audit data storage period. Accepts seconds and time unit with suffix. Default: 365d. |
| hk_sessions_mode | integer | Enable internal housekeeping for sessions. Possible values: 0 - Disable; 1 - (default) Enable. |
| hk_sessions | string | Sessions data storage period. Accepts seconds and time unit with suffix. Default: 365d. |
| hk_history_mode | integer | Enable internal housekeeping for history. Possible values: 0 - Disable; 1 - (default) Enable. |
| hk_history_global | integer | Override item history period. Possible values: 0 - Do not override; 1 - (default) Override. |
| hk_history | string | History data storage period. Accepts seconds and time unit with suffix. Default: 90d. |
| hk_trends_mode | integer | Enable internal housekeeping for trends. Possible values: 0 - Disable; 1 - (default) Enable. |
| hk_trends_global | integer | Override item trend period. Possible values: 0 - Do not override; 1 - (default) Override. |
| hk_trends | string | Trends data storage period. Accepts seconds and time unit with suffix. Default: 365d. |
| db_extension | string | (readonly) Configuration flag DB extension. If this flag is set to "timescaledb" then the server changes its behavior for housekeeping and item deletion. |
| compression_status | integer | Enable TimescaleDB compression for history and trends. Possible values: 0 - (default) Off; 1 - On. |
| compress_older | string | Compress history and trends records older than specified period. Accepts seconds and time unit with suffix. Default: 7d. |
| compression_availability | integer | (readonly) Compression availability. Possible values: 0 - Unavailable; 1 - Available. |