proxy.create

Description

object proxy.create(object/array proxies)

This method allows to create new proxies.

This method is only available to Super admin user type. Permissions to call the method can be revoked in user role settings. See User roles for more information.

Parameters

(object/array) Proxies to create.

Additionally to the standard proxy properties, the method accepts the following parameters.

ParameterTypeDescription
hostsarrayHosts 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.
interfaceobjectHost interface to be created for the passive proxy.

Required for passive proxies.

Return values

(object) Returns an object containing the IDs of the created proxies under the proxyids property. The order of the returned IDs matches the order of the passed proxies.

Examples

Create an active proxy

Create an action proxy “Active proxy” and assign a host to be monitored by it.

Request:

  1. {
  2.            "jsonrpc": "2.0",
  3.            "method": "proxy.create",
  4.            "params": {
  5.                "host": "Active proxy",
  6.                "status": "5",
  7.                "hosts": [
  8.                    {
  9.                        "hostid": "10279"
  10.                    }
  11.                ]
  12.            },
  13.            "auth": "ab9638041ec6922cb14b07982b268f47",
  14.            "id": 1
  15.        }

Response:

  1. {
  2.            "jsonrpc": "2.0",
  3.            "result": {
  4.                "proxyids": [
  5.                    "10280"
  6.                ]
  7.            },
  8.            "id": 1
  9.        }

Create a passive proxy

Create a passive proxy “Passive proxy” and assign two hosts to be monitored by it.

Request:

  1. {
  2.            "jsonrpc": "2.0",
  3.            "method": "proxy.create",
  4.            "params": {
  5.                "host": "Passive proxy",
  6.                "status": "6",
  7.                "interface": {
  8.                    "ip": "127.0.0.1",
  9.                    "dns": "",
  10.                    "useip": "1",
  11.                    "port": "10051"
  12.                },
  13.                "hosts": [
  14.                    {
  15.                        "hostid": "10192"
  16.                    },
  17.                    {
  18.                        "hostid": "10139"
  19.                    }
  20.                ]
  21.            },
  22.            "auth": "ab9638041ec6922cb14b07982b268f47",
  23.            "id": 1
  24.        }

Response:

  1. {
  2.            "jsonrpc": "2.0",
  3.            "result": {
  4.                "proxyids": [
  5.                    "10284"
  6.                ]
  7.            },
  8.            "id": 1
  9.        }

See also

Source

CProxy::create() in ui/include/classes/api/services/CProxy.php.