[comment]: # translation:outdated

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

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

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

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

Cette méthode permet de récupérer des proxys selon les paramètres donnés.

::: noteclassic
Cette méthode est disponible pour les utilisateurs de tout type. Les autorisations d’appel de la méthode peuvent être révoquées dans les paramètres du rôle utilisateur. Voir
[User roles](/manual/web_interface/frontend_sections/users/user_roles) pour plus d’informations.
:::

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

[comment]: # ({eb1d0821-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|ID/array|Retourner uniquement les proxies avec les ID indiqués.|
|proxy_groupids|ID/array|Retourner uniquement les proxies qui appartiennent aux groupes de proxies indiqués.|
|selectAssignedHosts|query|Retourner une propriété [`assignedHosts`](/manual/api/reference/host/object) contenant les hôtes assignés au proxy.<br><br>Prend en charge `count`.|
|selectHosts|query|Retourner une propriété [`hosts`](/manual/api/reference/host/object) contenant les hôtes surveillés par le proxy.<br><br>Prend en charge `count`.|
|selectProxyGroup|query|Retourner une propriété [`proxyGroup`](/manual/api/reference/proxygroup/object) contenant l'objet groupe de proxies.|
|sortfield|string/array|Trier le résultat selon les propriétés indiquées.<br><br>Valeurs possibles : `proxyid`, `name`, `operating_mode`.|
|countOutput|boolean|Ces paramètres sont décrits dans le [commentaire 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]: # ({/eb1d0821-74f0aaac})

[comment]: # ({07ca11ca-7223bab1})
### Valeurs de retour

`(integer/array)` Renvoie soit :

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

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

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

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

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

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

[Requête](/manual/api#performing-requests) :

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

Réponse :

```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})
### Voir aussi

-   [Hôte](/manual/api/reference/host/object#host)
-   [Groupe de proxies](/manual/api/reference/proxygroup/object#proxy-group)

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

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

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

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