proxygroup.delete

Description

object proxygroup.delete(array proxyGroupIds)

This method allows to delete 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

(array) IDs of proxy groups to delete.

Return values

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

Examples

Delete multiple proxy groups

Delete two proxy groups.

Request:

{
           "jsonrpc": "2.0",
           "method": "proxygroup.delete",
           "params": [
               "5",
               "10"
           ],
           "id": 1
       }

Response:

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

Source

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

Documentation