proxygroup.update

Description

object proxygroup.update(object/array proxyGroups)

This method allows to update existing proxy groups.

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/array) Proxy group properties to be updated.

The proxy_groupid property must be defined for each proxy group, all other properties are optional. Only the passed properties will be updated, all others will remain unchanged.

The method accepts proxy groups with the standard proxy group properties.

Return values

(object) Returns an object containing the IDs of the updated proxy groups under the proxy_groupids property.

Examples

Change minimum number of online proxies

Change minimum number of online proxies required for the group to be online.

Request:

{
           "jsonrpc": "2.0",
           "method": "proxygroup.update",
           "params": {
               "proxy_groupid": "5",
               "min_online": "3"
           },
           "id": 1
       }

Response:

{
           "jsonrpc": "2.0",
           "result": {
               "proxy_groupids": [
                   "5"
               ]
           },
           "id": 1
       }

Source

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

Documentation