object proxy.update(object/array proxies)
This method allows to update existing proxies.
(object/array)
Proxy properties to be updated.
The proxyid
property must be defined for each proxy, all other properties are optional. Only the passed properties will be updated, all others will remain unchanged.
Additionally to the standard proxy properties, the method accepts the following parameters.
Parameter | Type | Description |
---|---|---|
hosts | array | Hosts to be monitored by the proxy. If a host is already monitored by a different proxy, it will be reassigned to the current proxy. The hosts must have the hostid property defined. |
interface | object | Host interface to replace the existing interface for the passive proxy. |
(deprecated) |
array | Host interface to be created for the passive proxy passed as an array. |
(object)
Returns an object containing the IDs of the updated proxies under the proxyids
property.
Update the proxy to monitor the two given hosts.
Request:
{
"jsonrpc": "2.0",
"method": "proxy.update",
"params": {
"proxyid": "10293",
"hosts": [
"10294",
"10295"
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
Response:
Change the proxy to an active proxy and rename it to "Active proxy".
Request:
{
"jsonrpc": "2.0",
"method": "proxy.update",
"params": {
"proxyid": "10293",
"host": "Active proxy",
"status": "5"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
Response:
CProxy::update() in frontends/php/api/classes/CProxy.php.