Editing Backup Proxy Server Settings
This section explains how to edit settings of the specified backup proxy server by the server ID.
Request
PUT https://<hostname>:4443/v5/Proxies/{proxyId} |
Request Headers
The request header must contain an authorization token of the current session.
Request Parameters
The following parameters must be posted as URL.
Parameter | Type | Description |
|---|---|---|
proxyId | string | An identification number of the backup proxy server. |
Request Body
The following table lists available request parameters.
Property | Type | Description |
|---|---|---|
Description | string | Specifies the description of the backup proxy server. |
Port | int | Specifies the port number via which 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 | int | Specifies the number of threads that the proxy server will process. |
EnableNetworkThrottling | boolean | If set to true, indicates that Veeam Backup for Microsoft Office 365 will limit the network bandwidth for performance optimization. Use the ThrottlingValue property to set the network throttling value. |
ThrottlingValue | int | Specifies the network bandwidth limit value. NOTE: EnableNetworkThrottling must be set to true. |
ThrottlingUnit | string | Specifies the measuring unit for network bandwidth limit:
NOTE: EnableNetworkThrottling must be set to true. |
UseInternetProxy | boolean | If set to true, indicates that Veeam Backup for Microsoft Office 365 uses the internet proxy. |
InternetProxyType | boolean | Specifies a type of the internet proxy:
NOTE: UseInternetProxy must be set to true. |
InternetProxySettings | Specifies the internet proxy connection settings. |
The internet proxy settings have the following properties:
Property | Type | Description |
|---|---|---|
HostName | string | Indicates the name of the Internet proxy. |
Port | int | Indicates a port for connection to the Internet proxy. The default port for connection to the Internet proxy is 3128. |
UseAuthentication | boolean | Indicates that Veeam Backup for Microsoft Office 365 will use an authentication credentials when connecting to the Internet proxy. |
UserName | string | Indicates the username for the authentication with Internet proxy. |
UserPassword | string | Indicates the username for the authentication with Internet proxy. |
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 below shows how to update the backup proxy settings with ID 5a905bb5-9071-433c-9d2f-f805d4da2cf4.
Request: PUT https://abc.tech.local:4443/v5/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 |
