Getting Internet Proxy Server

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

Request

GET https://<hostname>:4443/v6/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 body contains the following properties:

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

Defines that Veeam Backup for Microsoft 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 server.

Example

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

Request:

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

 

Request Header:

Authorization: Bearer <Access-Token>

 

Response:

200 OK

 

Response Body:

{

  "useInternetProxy": true,

  "_links": {"self": {"href": "/v6/internetProxy"}},

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

  "port": 3128,

  "useAuthentication": true,

  "userName": "Administrator"

}