[comment]: # translation:outdated

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

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

[comment]: # ({b91ae38b-b91ae38b})
### Description

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

La méthode permet de récupérer des proxys en fonction des paramètres donnés.

::: noteclassic
Cette méthode est disponible à tous les types d'utilisateurs. Les autorisations d'appeler la méthode peuvent être révoquées dans les paramètres du le rôle d'utilisateur. Voir [Rôles Utilisateur](/manual/web_interface/frontend_sections/administration/user_roles) pour plus d'informations.
:::

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

[comment]: # ({abd2b04b-74f0aaac})
### Paramètres

`(object)` Paramètres définissant la sortie souhaitée.

La méthode prend en charge les paramètres suivants.

|Paramètre|[Type](/manual/api/reference_commentary#data_types)|Description|
|--|--|------|
|proxyids|string/array|Renvoie uniquement les proxys avec les identifiants donnés.|
|selectHosts|query|Renvoie une propriété [hosts](/manual/api/reference/host/object) avec les hôtes surveillés par le proxy.|
|selectInterface|query|Renvoie une propriété [interface](/manual/api/reference/proxy/object#proxy_interface) avec l'interface du proxy utilisée par un proxy passif.|
|sortfield|string/array|Trie le résultat par les propriétés données.<br><br>Les valeurs possibles sont : `hostid`, `host` et `status`.|
|countOutput|boolean|Ces paramètres, communs à toutes les méthodes `get`, sont décrits dans les [commentaires de référence](/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]: # ({/abd2b04b-74f0aaac})

[comment]: # ({7223bab1-7223bab1})
### Valeurs retournées

`(integer/array)` Retourne soit :

-   un tableau d'objets ;
-   le nombre d'objets récupérés, si le paramètre `countOutput` a été utilisé.

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

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

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

[comment]: # ({7c18fe37-b40fb513})
#### Récupérer tous les proxys

Récupérez tous les proxys configurés et leurs interfaces.

Requête :

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

Réponse :

```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]: # ({/7c18fe37-b40fb513})

[comment]: # ({273e0fd8-273e0fd8})
### Voir également

-   [Hôte](/manual/api/reference/host/object#host)
-   [Interface Proxy](object#proxy_interface)

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

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

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

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