[comment]: # ({70dbc2c9-70dbc2c9})
# proxy.get

[comment]: # ({/70dbc2c9-70dbc2c9})

[comment]: # ({fea54630-b91ae38b})
### Описание

`integer/array proxy.get(параметры объекта)`

Этот метод позволяет получать прокси в соответствии с заданными
параметрами.

::: noteclassic
Этот метод доступен пользователям любого типа.
Разрешения на вызов метода можно отозвать в настройках ролей пользователя.
Дополнительную информацию см. в разделе [Роли пользователей](/manual/web_interface/frontend_sections/users/user_roles).
:::

[comment]: # ({/fea54630-b91ae38b})

[comment]: # ({eb1d0821-74f0aaac})
### Параметры

`(object)` Параметры, определяющие желаемый результат.

Метод поддерживает следующие параметры.

|Parameter|[Type](/manual/api/reference_commentary#data-types)|Description|
|--|--|------|
|proxyids|ID/array|Возвращать только прокси с указанными ID.|
|proxy_groupids|ID/array|Возвращать только прокси, которые принадлежат указанным группам прокси.|
|selectAssignedHosts|query|Возвращать свойство [`assignedHosts`](/manual/api/reference/host/object) с узлами сети, назначенными прокси.<br><br>Поддерживает `count`.|
|selectHosts|query|Возвращать свойство [`hosts`](/manual/api/reference/host/object) с узлами сети, контролируемыми прокси.<br><br>Поддерживает `count`.|
|selectProxyGroup|query|Возвращать свойство [`proxyGroup`](/manual/api/reference/proxygroup/object) с объектом группы прокси.|
|sortfield|string/array|Сортировать результат по указанным свойствам.<br><br>Возможные значения: `proxyid`, `name`, `operating_mode`.|
|countOutput|boolean|Эти параметры описаны в [reference commentary](/manual/api/reference_commentary#common-get-method-parameters).|
|editable|boolean|^|
|excludeSearch|boolean|^|
|filter|object|^|
|limit|integer|^|
|output|query|^|
|preservekeys|boolean|^|
|search|object|^|
|searchByAny|boolean|^|
|searchWildcardsEnabled|boolean|^|
|sortorder|string/array|^|
|startSearch|boolean|^|

[comment]: # ({/eb1d0821-74f0aaac})

[comment]: # ({07ca11ca-7223bab1})
### Возвращаемые значения

`(integer/array)` Возвращает либо:

-   массив объектов;
-   количество полученных объектов, если использовался параметр `countOutput`.

[comment]: # ({/07ca11ca-7223bab1})

[comment]: # ({b41637d2-b41637d2})
### Примеры

[comment]: # ({/b41637d2-b41637d2})

[comment]: # ({eace8ca8-b40fb513})
#### Получить все прокси

Получить все настроенные прокси и их интерфейсы.

[Запрос](/manual/api#performing-requests):

```json
{
    "jsonrpc": "2.0",
    "method": "proxy.get",
    "params": {
        "output": "extend"
    },
    "id": 1
}
```

Ответ:

```json
{
    "jsonrpc": "2.0",
    "result": [
        {
            "proxyid": "11",
            "name": "Active proxy",
            "proxy_groupid": "0",
            "local_address": "",
            "local_port": "10051",
            "operating_mode": "0",
            "description": "",
            "allowed_addresses": "",
            "address": "127.0.0.1",
            "port": "10051",
            "tls_connect": "1",
            "tls_accept": "1",
            "tls_issuer": "",
            "tls_subject": "",
            "custom_timeouts": "0",
            "timeout_zabbix_agent": "",
            "timeout_simple_check": "",
            "timeout_snmp_agent": "",
            "timeout_external_check": "",
            "timeout_db_monitor": "",
            "timeout_http_agent": "",
            "timeout_ssh_agent": "",
            "timeout_telnet_agent": "",
            "timeout_script": "",
            "last_access": "1693391880",
            "version": "70000",
            "compatibility": "1",
            "state": "1"
        },
        {
            "proxyid": "12",
            "name": "Passive proxy",
            "proxy_groupid": "1",
            "local_address": "127.0.0.1",
            "local_port": "10051",
            "operating_mode": "1",
            "description": "",
            "allowed_addresses": "",
            "address": "127.0.0.1",
            "port": "10051",
            "tls_connect": "1",
            "tls_accept": "1",
            "tls_issuer": "",
            "tls_subject": "",
            "custom_timeouts": "1",
            "timeout_zabbix_agent": "5s",
            "timeout_simple_check": "5s",
            "timeout_snmp_agent": "5s",
            "timeout_external_check": "5s",
            "timeout_db_monitor": "5s",
            "timeout_http_agent": "5s",
            "timeout_ssh_agent": "5s",
            "timeout_telnet_agent": "5s",
            "timeout_script": "5s",
            "lastaccess": "1693391875",
            "version": "60400",
            "compatibility": "2",
            "state": "2"
        }
    ],
    "id": 1
}
```

[comment]: # ({/eace8ca8-b40fb513})

[comment]: # ({ffb6ee14-273e0fd8})
### См. также

-   [Узел сети](/manual/api/reference/host/object#host)
-   [Группа прокси](/manual/api/reference/proxygroup/object#proxy-group)

[comment]: # ({/ffb6ee14-273e0fd8})

[comment]: # ({b9a96f2c-b9a96f2c})
### Источник

CProxy::get() в *ui/include/classes/api/services/CProxy.php*.

[comment]: # ({/b9a96f2c-b9a96f2c})