[comment]: # ({9936c391-51323acb})
# proxygroup.get

[comment]: # ({/9936c391-51323acb})

[comment]: # ({05aa6b77-0b47b101})
### Описание

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

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

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

[comment]: # ({/05aa6b77-0b47b101})

[comment]: # ({4298141a-e8ed9d1c})
### Параметры

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

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

|Parameter|[Type](/manual/api/reference_commentary#data-types)|Description|
|--|--|------|
|proxy_groupids|ID/array|Возвращать только группы прокси с указанными ID.|
|proxyids|ID/array|Возвращать только группы прокси, которые содержат указанные прокси.|
|selectProxies|query|Возвращать свойство [`proxies`](/manual/api/reference/proxy/object) с прокси, которые принадлежат группе прокси.<br><br>Поддерживает `count`.|
|sortfield|string/array|Сортировать результат по указанным свойствам.<br><br>Возможные значения: `proxy_groupid`, `name`.|
|countOutput|boolean|Эти параметры описаны в [справочном комментарии](/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]: # ({/4298141a-e8ed9d1c})

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

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

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

[comment]: # ({/07ca11ca-5d7f971e})

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

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

[comment]: # ({8e2ed653-78dbbfff})
#### Получение всех групп прокси

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

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

```json
{
    "jsonrpc": "2.0",
    "method": "proxygroup.get",
    "params": {
        "output": "extend",
        "selectProxies": ["proxyid", "name"]
    },
    "id": 1
}
```

Ответ:

```json
{
    "jsonrpc": "2.0",
    "result": [
        {
            "proxy_groupid": "1",
            "name": "Proxy group 1",
            "failover_delay": "1m",
            "min_online": "3",
            "description": "",
            "state": "1",
            "proxies": [
                {
                    "proxyid": "1",
                    "name": "proxy 1"
                },
                {
                    "proxyid": "2",
                    "name": "proxy 2"
                }
            ]
        },
        {
            "proxy_groupid": "2",
            "name": "Proxy group 2",
            "failover_delay": "10m",
            "min_online": "3",
            "description": "",
            "state": "3",
            "proxies": [
                {
                    "proxyid": "3",
                    "name": "proxy 3"
                },
                {
                    "proxyid": "4",
                    "name": "proxy 4"
                },
                {
                    "proxyid": "5",
                    "name": "proxy 5"
                }
            ]
        }
    ],
    "id": 1
}
```

[comment]: # ({/8e2ed653-78dbbfff})

[comment]: # ({606fe203-df1d5f90})
### См. также

-   [Прокси](/manual/api/reference/proxy/object#proxy)

[comment]: # ({/606fe203-df1d5f90})

[comment]: # ({e04ef422-01660b7a})
### Исходный код

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

[comment]: # ({/e04ef422-01660b7a})