Sidebar

manual:api:reference:housekeeping:update

housekeeping.update

Description

object housekeeping.update(object housekeeping)

This method allows to update existing housekeeping settings.

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

Parameters

(object) Housekeeping properties to be updated.

Return values

(array) Returns array with the names of updated parameters.

Examples

Request:

{
    "jsonrpc": "2.0",
    "method": "housekeeping.update",
    "params": {
        "hk_events_mode": "1",
        "hk_events_trigger": "200d",
        "hk_events_internal": "2d",
        "hk_events_discovery": "2d"
    },
    "auth": "038e1d7b1735c6a5436ee9eae095879e",
    "id": 1
}

Response:

{
    "jsonrpc": "2.0",
    "result": [
        "hk_events_mode",
        "hk_events_trigger",
        "hk_events_internal",
        "hk_events_discovery"
    ],
    "id": 1
}

Source

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