REST API - list

appliance networking proxy: list

Gets proxy configuration for all configured protocols. This operation was added in vSphere API 6.7

Request:

HTTP request

GET https://{server}/rest/appliance/networking/proxy

No request parameters

Response:

HTTP Status Code: 200

Representation:

JSON

{
    "value": [
        {
            "key": "HTTP",
            "value": {
                "enabled": true,
                "password": "secret string",
                "port": 1,
                "server": "string",
                "username": "string"
            }
        }
    ]
}

Response Type:

Name	Type	Description
bold = required
value	list	Proxy configuration for all configured protocols.List of {"key": string, "value": config}
value[].key	string	Defines the protocols for which proxying is supported. This enumeration was added in vSphere API 6.7 Value is one of: HTTP: Proxy configuration for http. This constant was added in vSphere API 6.7 HTTPS: Proxy configuration for https. This constant was added in vSphere API 6.7 FTP: Proxy configuration for ftp. This constant was added in vSphere API 6.7
value[].value	config
value[].value.server	string	Hostname or IP address of the proxy server. This attribute was added in vSphere API 6.7
value[].value.port	long	Port to connect to the proxy server. In a 'get' call, indicates the port connected to the proxy server. In a 'set' call, specifies the port to connect to the proxy server. A value of -1 indicates the default port. This attribute was added in vSphere API 6.7
value[].value.username	string	Username for proxy server. This attribute was added in vSphere API 6.7 Optional. Only set if proxy requires username.
value[].value.password	secret	Password for proxy server. This attribute was added in vSphere API 6.7 Optional. Only set if proxy requires password.
value[].value.enabled	boolean	In the result of the `#get` and `#list` operations this field indicates whether proxying is enabled for a particular protocol. In the input to the `test` and `set` operations this field specifies whether proxying should be enabled for a particular protocol. This attribute was added in vSphere API 6.7

Errors:

HTTP Status Code	Type	Description
500	error	Generic error.