proxy.get

Description

integer/array proxy.get(object parameters)

The method allows to retrieve proxies according to the given parameters.

Parameters

(object) Parameters defining the desired output.

The method supports the following parameters.

Parameter	Type	Description
proxyids	string/array	Return only proxies with the given IDs.
selectHosts	query	Return hosts monitored by the proxy in the `hosts` property. Does not support `shorten`.
selectInterfaces	query	Return the proxy interface used by a passive proxy as an array in the `interfaces` property. Does not support `shorten`.
sortfield	string/array	Sort the result by the given properties. Possible values are: `hostid`, `host` and `status`.
countOutput	flag	These parameters being common for all `get` methods are described in detail on the Generic Zabbix API information page.
editable	boolean
excludeSearch	flag
filter	object
limit	integer
nodeids	string/array
output	query
preservekeys	flag
search	object
searchByAny	boolean
searchWildcardsEnabled	boolean
sortorder	string/array
startSearch	flag

Return values

(integer/array) Returns either:

an array of objects;
the count of retrieved objects, if the countOutput parameter has been used.

Examples

Retrieve all proxies

Retrieve all configured proxies and their interfaces.

Request:

{
           "jsonrpc": "2.0",
           "method": "proxy.get",
           "params": {
               "output": "extend",
               "selectInterfaces": "extend"
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

Response:

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "interfaces": [],
                   "host": "Active proxy",
                   "status": "5",
                   "lastaccess": "0",
                   "proxyid": "30091"
               },
               {
                   "interfaces": [
                       {
                           "interfaceid": "30109",
                           "hostid": "30092",
                           "useip": "1",
                           "ip": "127.0.0.1",
                           "dns": "",
                           "port": "10051"
                       }
                   ],
                   "host": "Passive proxy",
                   "status": "6",
                   "lastaccess": "0",
                   "proxyid": "30092"
               }
           ],
           "id": 1
       }

Source

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

Documentation