V11 SP8
Loading...

REST API - GET HTTP Proxy Server

This operation returns the details associated with an HTTP proxy server.

Request

Syntax

GET <webservice>/Commcell/InternetOptions/Proxy HTTP/1.1
Host: <host name>
Accept: application/xml
Authtoken: <authentication token>

where <webservice> is the root path used to route the API requests to the Web Server.

For more information, see Available Web Services for REST API.

Request Headers

Name Description
Host The host name of the Web Server or Web Console used in the API request.
Accept The format of the response. Valid values are: application/xml or application/json.
Authtoken The authentication token received after successfully logging on. For details on receiving an authentication token, see Authentication.

Response

Response Parameters

Parameter Description Element
proxyPort The port number used to establish connections with the proxy server. config
proxyServer The hostname or IP address of the proxy server. config
proxyType Valid value is 1. config
useHttpProxy The option to use an HTTP proxy server.

Valid values are:

  • 0, to not use an HTTP proxy server
  • 1, to use an HTTP proxy server
config
useProxyAuthentication The option to provide user credentials that are required to access the proxy server.

Valid values are:

  • 0, to not provide user credentials
  • 1, to provide user credentials
config
_type_ Valid value is 3. proxyClient
clientId Valid value is 1. proxyClient
clientName The client name is blank. proxyClient
type Valid value is 0. proxyClient
userName The user name to access the proxy server. This value is available if the useProxyAuthentication parameter is set to 1. proxyCredentials

Examples

Sample Request

GET <webservice>/Commcell/InternetOptions/Proxy HTTP/1.1
Host: client.mydomain.com
Accept: application/xml
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8

Sample Response

This is the response when an HTTP proxy server is not configured.

<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<EVGui_GetProxyClientResp>
  <config proxyPort="1025" proxyServer="" proxyType="1" useHttpProxy="0" useIgDownloadSoftware="0" useInternetGatewayPrivate="0" useInternetGatewayPublic="0" useProxyAuthentication="0">
    <proxyClient _type_="3" clientId="1" clientName="" type="0"/>
  <proxyCredentials/>
</config>
</EVGui_GetProxyClientResp>