housekeeping.get

Description

object housekeeping.get(object parameters)

The method allows to retrieve housekeeping object according to the given parameters.

This method is available to users of any type. Permissions to call the method can be revoked in user role settings. See User roles for more information.

Parameters

(object) Parameters defining the desired output.

The method supports only one parameter.

Parameter	Type	Description
output	query	This parameter being common for all `get` methods described in the reference commentary.

Return values

(object) Returns housekeeping object.

Examples

Request:

{
           "jsonrpc": "2.0",
           "method": "housekeeping.get",
           "params": {
               "output": "extend"
           },
           "id": 1
       }

Response:

{
           "jsonrpc": "2.0",
           "result": {
               "hk_events_mode": "1",
               "hk_events_trigger": "365d",
               "hk_events_service": "1d",
               "hk_events_internal": "1d",
               "hk_events_discovery": "1d",
               "hk_events_autoreg": "1d",
               "hk_services_mode": "1",
               "hk_services": "365d",
               "hk_audit_mode": "1",
               "hk_audit": "31d",
               "hk_sessions_mode": "1",
               "hk_sessions": "365d",
               "hk_history_mode": "1",
               "hk_history_global": "0",
               "hk_history": "31d",
               "hk_trends_mode": "1",
               "hk_trends_global": "0",
               "hk_trends": "365d",
               "db_extension": "",
               "compression_status": "0",
               "compress_older": "7d"
           },
           "id": 1
       }

Source

CHousekeeping ::get() in ui/include/classes/api/services/CHousekeeping.php.

Documentation