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.
Whenever the request is sent by "GET" method, the data corresponding to the API will be listed.
https://[HOST]:[PORT]/AppManager/xml/ProxyServer?apikey=[apikey]
When the request is sent by "POST" method, the corresponding data will be added/updated.
https://[HOST]:[PORT]/AppManager/xml/ProxyServer?apikey=[apikey]
Supported HTTP methods: GET, POST
Allowed roles: Administrator
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 asssumed 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 enable bypass for the proxy server. Values can be true or false. If set to true, will enable the bypass for the proxy server.
Note: Any value other than "true" will be assumed as false.
|
| dontProxyList | Do not use proxy for addresses beginning with the hosts mentioned in this parameter. Multiple hosts are separated by semicolon (;). |
https://apm-prod-server:8443/AppManager/xml/ProxyServer?apikey=aaaaaabbbbbbccccccddddddeeeeee
