Configure Proxy Server API
This API allows the user to view proxy server details and configure proxy server parameters. This API is designed to support GET and POST requests.
GET Request
Whenever the request is sent by "GET" method, the data corresponding to the API will be listed.
Syntax
https://[HOST]:[PORT]/AppManager/xml/ProxyServer?apikey=[apikey]
POST Request
When the request is sent by "POST" method, the corresponding data will be added/updated.
Syntax
https://[HOST]:[PORT]/AppManager/xml/ProxyServer?apikey=[apikey]&useproxy=[USEPROXY]&host=[PROXYHOST]&port=[PROXYPORT]&bypassproxy=[BYPASSPROXY]&dontProxyList=[BYPASSPROXYLIST]
Supported HTTP methods: GET, POST
Allowed roles: Administrator
Request Parameters
The parameters involved in the API request are described below:
| Field | Description |
|---|
| useproxy | Option to Enable / Disable the proxy configuration settings. Values can be true or false. If set to false, then proxy configuration settings will be Disabled. Note: Specifying any value other than "true" for this will be assumed as false and the proxy configuration settings will be Disabled. |
| host | The host name or host ID of the proxy server that has to be used in configuration. |
| port | The port number of the proxy server. |
| username | The username for proxy server authentication. |
| password | The password for proxy server authentication. |
| bypassproxy | Option to bypass the proxy for local network addresses. Values can be true or false. If set to true, proxy will be bypassed for local addresses (192.168.0.0/255.255.0.0) Note: Any value other than "true" will be assumed as false. |
| dontProxyList | The host names or IP addresses for which the proxy should be bypassed. Multiple entries can separated by semicolon (;). |
Sample Request
https://apm-prod-server:8443/AppManager/xml/ProxyServer?apikey=aaaaaabbbbbbccccccddddddeeeeee&useproxy=true&host=localhost&port=9090&bypassproxy=true&dontProxyList=me.com;zoho.com
