Editing Backup Proxy Server Settings

You can edit settings of a backup proxy server with the specified ID.

Request

PUT https://<hostname>:4443/v6/Proxies/{proxyId}

Request Headers

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

Request Parameters

The following parameter must be specified in the URL of the request:

Parameter

Type

Description

proxyId

string

Specifies the identification number of the backup proxy server. For more information on how to get this parameter, see Getting Backup Proxy Servers.

Request Body

The request body must contain the following properties:

Property

Type

Description

description

string

Specifies the description of the backup proxy server.

port

integer

Specifies the port number which is used to connect to a backup proxy server.

username

string

Specifies Windows user name to access the proxy server.

password

string

Specifies Windows user password to access the proxy server.

threadsNumber

integer

Specifies the number of threads that the proxy server will process.

enableNetworkThrottling

boolean

If set to true, indicates that Veeam Backup for Microsoft 365 will limit the network bandwidth for performance optimization. Use the throttlingValue property to set the network throttling value.

throttlingValue

integer

Specifies the network bandwidth limit value.

Note: The enableNetworkThrottling property value must be set to true.

throttlingUnit

string

Specifies the measuring unit for network bandwidth limit. The following values are available:

  • Mbps
  • MBs
  • KBs

Note: The enableNetworkThrottling property value must be set to true.

useInternetProxy

boolean

If set to true, indicates that Veeam Backup for Microsoft 365 uses the internet proxy server.

internetProxyType

boolean

Defines a type of the internet proxy server. The following types are available:

  • fromManagementServer
  • custom

Note: The useInternetProxy property value must be set to true.

internetProxySettings

internetProxySettings

Specifies the internet proxy connection settings.

internetProxySettings

The internet proxy settings have the following properties:

Property

Type

Description

hostName

string

Specifies the name of the internet proxy server.

port

integer

Specifies a port for connection to the internet proxy server.

The default port for connection to the internet proxy server 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

Specifies the username for the authentication with internet proxy server.

userPassword

string

Specifies the username for the authentication with internet proxy server.

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

None.

Example

The example shows how to update the backup proxy settings with the ID 5a905bb5-9071-433c-9d2f-f805d4da2cf4.

Request:

PUT https://abc.tech.local:4443/v6/Proxies/5a905bb5-9071-433c-9d2f-f805d4da2cf4

 

Request Header:

Authorization: Bearer <Access-Token>

 

Request Body:

{

 "useInternetProxy": true,

 "internetProxyType": "Custom",

 "internetProxySettings": {

   "hostName": "abc.tech.local",

   "port": 3128,

   "useAuthentication": true,

   "userName": "administrator",

   "userPassword": "XXXXXXXXXX"

 },

 "description": "Remote Backup Proxy Server",

 "port": 9193,

 "username": "administrator",

 "password": "xxxxxxxxxxx",

 "threadsNumber": 128,

 "enableNetworkThrottling": true,

 "throttlingValue": 2500,

 "throttlingUnit": "MBs"

}

 

Response:

200 OK