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

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

[comment]: # ({05aa6b77-0b47b101})
### Descrição

`integer/array proxygroup.get(object parameters)`

O método permite recuperar grupos de proxy de acordo com os parâmetros fornecidos.

::: noteclassic
Este método está disponível para usuários de qualquer tipo. As permissões para chamar o método podem ser revogadas nas configurações de função do usuário. Veja
[Funções de usuário](/manual/web_interface/frontend_sections/users/user_roles) para mais informações.
:::

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

[comment]: # ({4298141a-e8ed9d1c})
### Parâmetros

`(object)` Parâmetros que definem a saída desejada.

O método suporta os seguintes parâmetros.

|Parâmetro|[Tipo](/manual/api/reference_commentary#data-types)|Descrição|
|--|--|------|
|proxy_groupids|ID/array|Retorna apenas grupos de proxy com os IDs fornecidos.|
|proxyids|ID/array|Retorna apenas grupos de proxy que contenham os proxies fornecidos.|
|selectProxies|query|Retorna uma propriedade [`proxies`](/manual/api/reference/proxy/object) com os proxies que pertencem ao grupo de proxy.<br><br>Suporta `count`.|
|sortfield|string/array|Ordena o resultado pelas propriedades fornecidas.<br><br>Valores possíveis: `proxy_groupid`, `name`.|
|countOutput|boolean|Esses parâmetros são descritos no [comentário de referência](/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})
### Valores de retorno

`(integer/array)` Retorna:

-   um array de objetos;
-   a contagem de objetos recuperados, se o parâmetro `countOutput` tiver sido usado.

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

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

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

[comment]: # ({8e2ed653-78dbbfff})
#### Recuperar todos os grupos de proxy

Recupere todos os grupos de proxy configurados com proxies.

[Requisição](/manual/api#performing-requests):

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

Resposta:

```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})
### Veja também

-   [Proxy](/manual/api/reference/proxy/object#proxy)

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

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

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

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