proxygroup.update

Beschrijving

object proxygroup.update(object/array proxyGroups)

Deze methode maakt het mogelijk om bestaande proxygroepen bij te werken.

Deze methode is alleen beschikbaar voor het gebruikerstype Super admin. Rechten om de methode aan te roepen kunnen worden ingetrokken in de gebruikersrolinstellingen. Zie Gebruikersrollen voor meer informatie.

Parameters

(object/array) Proxygroepeigenschappen die moeten worden bijgewerkt.

De eigenschap proxy_groupid moet voor elke proxygroep worden gedefinieerd, alle andere eigenschappen zijn optioneel. Alleen de doorgegeven eigenschappen worden bijgewerkt, alle andere blijven ongewijzigd.

De methode accepteert proxygroepen met de standaard proxygroepeigenschappen.

Retourwaarden

(object) Retourneert een object met de ID's van de bijgewerkte proxygroepen onder de eigenschap proxy_groupids.

Voorbeelden

Wijzig het minimum aantal online proxy's

Wijzig het minimum aantal online proxy's dat nodig is om de groep online te laten zijn.

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
       }

Bron

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

Documentation