proxy.delete

Description

object proxy.delete(array proxies)

This method allows to delete proxies.

Parameters

(array) Proxies to delete.

The proxies must have the proxyid property defined.

Return values

(object) Returns an object containing the IDs of the deleted proxies under the proxyids property.

Examples

Delete multiple proxies

Delete two proxies.

Request:

{
    "jsonrpc": "2.0",
    "method": "proxy.delete",
    "params": [
        {"proxyid": "10286"},
        {"proxyid": "10285"}
    ],
    "auth": "3a57200802b24cda67c4e4010b50c065",
    "id": 1
}

Response:

{
    "jsonrpc": "2.0",
    "result": {
        "proxyids": [
            "10286",
            "10285"
        ]
    },
    "id": 1
}

Source

CProxy::delete() in frontends/php/api/classes/CProxy.php.