This is an archive version of the document. To get the most up-to-date information, see the current version.Adding New Backup Proxy Servers
This section explains how to add a Veeam Backup for Microsoft Office 365 backup proxy server to the Veeam Backup for Microsoft Office 365 configuration.
Request
POST https://<hostname>:4443/v4/Proxies |
Request Headers
The request header must contain an authorization token of the current session.
Request Body
Property | Type | Description |
|---|---|---|
HostName | string | Specifies the DNS name or IP-address of a backup proxy server. |
Description | string | Specifies the description of the backup proxy server. |
Port | int | Specifies the port number to connect to the backup proxy server. Default 9193. |
Username | string | Specifies the user name to access the specified backup proxy server. |
Password | string | Specifies the password to access the specified backup proxy server. |
AttachUsedProxy | boolean | Adds a backup proxy server that is already managed by another Veeam Backup for Microsoft Office 365 server. If set to True, Veeam Backup for Microsoft Office 365 will take ownership of the backup proxy server and add it to the backup infrastructure. |
ThreadsNumber | int | Specifies the number of threads that a backup proxy backup can 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: The EnableNetworkThrottling property must be set to true. Otherwise, the network bandwidth limit value will not be applied. |
ThrottlingUnit | string | Specifies the measuring unit for the network bandwidth limit:
NOTE: The EnableNetworkThrottling property must be set to true. |
UseInternetProxy | boolean | If set to true, indicates that Veeam Backup for Microsoft Office 365 will use an Internet proxy server to process the existing backup jobs. |
InternetProxyType | boolean | Specifies a type of the internet proxy server:
NOTE: UseInternetProxy must be set to true. |
InternetProxySettings | Specifies internet proxy settings used to connect to the internet proxy server. |
Property | Type | Description |
|---|---|---|
HostName | string | The name of the internet proxy server. |
Port | int | A port number via which 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 password for the authentication with the internet proxy server. |
Request Example
The following example shows how to add a new backup proxy server.
Request: POST https://abc.tech.local:4443/v4/Proxies
Request Header: Authorization: Bearer <Access-Token>
Request Body: { "hostName": "storage1.tech.local", "username": "Administrator", "password": "xxxxxxxxxxx", "attachUsedProxy": true, "description": "Remote backup proxy", "port": 9193, "threadsNumber": 64, "enableNetworkthrottling": true, "throttlingValue": 2500, "throttlingUnit": "KBs", "useInternetProxy": true, "internetProxyType": "Custom", "internetProxySettings": { "hostName": "abc.tech.local", "port": 3128, "useAuthentication": true, "UserName": "administrator", "UserPassword": "xxxxxxxxxxx" }, } |
Response
Response Codes
A successfully completed operation returns a response code 201 (Created).
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
In the response body, the server returns a representation of the backup proxy server resource. The resource has the following URL: /Proxies/{proxyId}.
Response Example
Response: 201 Created
Response Body: { "isDefault": false, "useInternetProxy": true, "internetProxyType": "Custom", "internetProxySettings": { "hostName": "abc.tech.local", "port": 3128, "useAuthentication": true, "username": "administrator" }, "id": "8a002d46-9802-4183-a636-d1b31673c525", "hostName": "storage1.tech.local", "description": "Remote backup proxy", "port": 9193, "threadsNumber": 64, "enableNetworkthrottling": true, "throttlingValue": 2500, "throttlingUnit": "KBs", "status": "Online", "_links": { "self": {"href": "https://abc.tech.local:4443/v4/proxies/8a002d46-9802-4183-a636-d1b31673c525"}, "repositories": {"href": "https://abc.tech.local:4443/v4/proxies/8a002d46-9802-4183-a636-d1b31673c525/repositories"} } } |