REST API - set

appliance techpreview networking proxy: set

Set Proxy configuration. In order for this configuration to take effect a logout is required.

Request:

HTTP request

PUT https://{server}/rest/appliance/techpreview/networking/proxy

Request Body Structure:

JSON
XML

{
    "config": {
        "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"
    }
}

Request Body Parameters:

Name	Type	Description
bold = required
config	proxy_config_multiple	List of Proxy configurations to be set.
config.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
config.configlist	proxy_config[]	List of proxy configuration.
config.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.
config.configlist[].server	string	hostname or ip of proxy server
config.configlist[].port	long	port to connect to the proxy server on. A value of -1 indicates that the default port is being used.
config.configlist[].username	string	username for proxy server.
config.configlist[].password	secret	password for proxy server.

Response:

HTTP Status Code: 200

None

Errors:

HTTP Status Code	Type	Description
500	error	Generic error