This is an archive version of the document. To get the most up-to-date information, see the current version.

Getting Internet Proxy Server

You can get a resource representation of the internet proxy server settings.

Request

GET https://<hostname>:4443/v5/InternetProxySettings

Request Headers

The request header must contain an authorization token of the current session.

Request Body

None.

Response

The server returns the following response to the client.

Response Codes

A successfully completed operation returns a response code 200 OK.

Response Headers

The response to this request contains the following headers. The response may also include additional standard HTTPS headers.

Header	Description
Content-length	The length of the response body.
Content-type	The media type and syntax of the response body message: application/json; charset=utf-8

Response Body

The response contains the following information:

Property	Type	Description
hostName	string	The name of the internet proxy server.
port	integer	A port number which is used to connect to the specified internet proxy server. The default port is 3128.
useAuthentication	boolean	Indicates that Veeam Backup for Microsoft Office 365 will use an authentication credentials when connecting to the internet proxy server.
userName	string	The username for the authentication with the internet proxy server.
UserPassword	string	The username for the authentication with Internet proxy.

Examples

Example 1

The example returns a resource representation of the internet proxy server settings.

Request:

GET https://abc.tech.local:4443/v5/InternetProxySettings

Request Header:

Authorization: Bearer <Access-Token>

Response:

200 OK

Response Body:

{

"useInternetProxy": true,

"_links": {"self": {"href": "https://abc.tech.local:4443/v5/internetProxy"}},

"hostName": "gamma.tech.local",

"port": 3128,

"useAuthentication": true,

"userName": "Administrator"

}