Sidebar

manual:api:reference:proxy:iswritable

proxy.iswritable

Description

boolean proxy.iswritable(array proxyIds)

This method checks if the given proxies are available for writing.

This method is deprecated and will be removed in the future. Please use proxy.get instead.

Parameters

(array) IDs of the proxies to check.

Return values

(boolean) Returns true if the given proxies are available for writing.

Examples

Check multiple proxies

Check if the two proxies are writable.

Request:

{
    "jsonrpc": "2.0",
    "method": "proxy.iswritable",
    "params": [
        "30091",
        "30092"
    ],
    "auth": "038e1d7b1735c6a5436ee9eae095879e",
    "id": 1
}

Response:

{
    "jsonrpc": "2.0",
    "result": true,
    "id": 1
}

See also

Source

CProxy::isWritable() in frontends/php/include/classes/api/services/CProxy.php.