1. Operations
  2. appliance
  3. techpreview
  4. networking
  5. proxy

appliance techpreview networking proxy: get

Get proxy configuration for all protocols.

Request:

HTTP request

GET https://{server}/rest/appliance/techpreview/networking/proxy
No request parameters

Response:

HTTP Status Code: 200

Representations:

{
    "value": {
        "configlist": [
            {
                "password": "secret string",
                "port": 1,
                "protocol": "ftp",
                "server": "string",
                "username": "string"
            },
            {
                "password": "secret string",
                "port": 1,
                "protocol": "ftp",
                "server": "string",
                "username": "string"
            }
        ],
        "status": "disabled"
    }
}
<?xml version="1.0" ?>
<ns0:Get-Result xmlns:ns0="http://vmware.com/appliance/techpreview/networking/proxy" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <value>
    <configlist-array>
      <array-item>
        <port>1</port>
        <username>string</username>
        <protocol>ftp</protocol>
        <server>string</server>
        <password>secret string</password>
      </array-item>
      <array-item>
        <port>1</port>
        <username>string</username>
        <protocol>ftp</protocol>
        <server>string</server>
        <password>secret string</password>
      </array-item>
    </configlist-array>
    <status>disabled</status>
  </value>
</ns0:Get-Result>

Response Type:

Name Type Description
bold = required
value proxy_config_multiple proxy configuration for all protocols.
value.status string proxy enabled or disabled This sets whether the proxy configuration is used.

Defines state of proxy Value is one of:
disabled: proxy configuration is disabled
enabled: proxy configuration is enabled
value.configlist proxy_config[] List of proxy configuration.
value.configlist[].protocol string protocol being configured.

Defines different proxy protocols Value is one of:
ftp: proxy configuration for ftp.
http: proxy configuration for http.
https: proxy configuration for https.
value.configlist[].server string hostname or ip of proxy server
value.configlist[].port long port to connect to the proxy server on. A value of -1 indicates that the default port is being used.
value.configlist[].username string username for proxy server.
value.configlist[].password secret password for proxy server.

Errors:

HTTP Status Code Type Description
500 error Generic error