[comment]: # translation:outdated

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

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

[comment]: # ({bb502116-b91ae38b})
frontend### Descrição

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

O método permite recuperar proxies 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. Consulte [Funções de usuário](/manual/web_interface/frontend_sections/administration/user_roles) para obter mais informações.
:::

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

[comment]: # ({be728b27-74f0aaac})
### 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|
|--|--|------|
|proxyids|string/array|Retornar apenas proxies com os IDs fornecidos.|
|selectHosts|query|Retorna uma propriedade [hosts](/manual/api/reference/host/object) com os hosts monitorados pelo proxy.|
|selectInterface|query|Retornar uma propriedade [interface](/manual/api/reference/proxy/object#proxy_interface) com a interface de proxy usada por um proxy passivo.|
|sortfield|string/array|Classifique o resultado pelas propriedades fornecidas.<br><br>Os valores possíveis são: `hostid`, `host` e `status`.|
|countOutput|boolean|Esses parâmetros sendo comuns para todos os métodos `get` são descritos em detalhes 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]: # ({/be728b27-74f0aaac})

[comment]: # ({46612ad9-7223bab1})
### Valores de retorno  
  
`(integer/array)` Retorna:  
  
- uma matriz de objetos;  
- a contagem de objetos recuperados, se o parâmetro `countOutput` foi usado.

[comment]: # ({/46612ad9-7223bab1})

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

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

[comment]: # ({f4ff70a2-b40fb513})
#### Recupere todos os proxies  
  
Recupere todos os proxies configurados e suas interfaces.

Request:

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

Response:

```json
{
    "jsonrpc": "2.0",
    "result": [
        {
            "host": "Active proxy",
            "status": "5",
            "lastaccess": "0",
            "description": "",
            "tls_connect": "1",
            "tls_accept": "1",
            "tls_issuer": "",
            "tls_subject": "",
            "proxy_address": "",
            "auto_compress": "0",
            "proxyid": "30091",
            "interface": []
        },
        {
            "host": "Passive proxy",
            "status": "6",
            "lastaccess": "0",
            "description": "",
            "tls_connect": "1",
            "tls_accept": "1",
            "tls_issuer": "",
            "tls_subject": "",
            "proxy_address": "",
            "auto_compress": "0",
            "proxyid": "30092",
            "interface": {
                "interfaceid": "30109",
                "hostid": "30092",
                "useip": "1",
                "ip": "127.0.0.1",
                "dns": "",
                "port": "10051"
            ]
        }
    ],
    "id": 1
}
```

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

[comment]: # ({273e0fd8-273e0fd8})
### Veja também

-   [Host](/manual/api/reference/host/object#host)
-   [Interface proxy](object#proxy_interface)

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

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

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

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