This is an archive version of the document. To get the most up-to-date information, see the current version.(POST) /Proxies
Adds a Veeam Backup for Microsoft Office 365 backup proxy to Veeam Backup for Microsoft Office 365 configuration.
Request
To add a backup proxy to the Veeam Backup for Microsoft Office 365 configuration, send the POST HTTPS request to the URL of the /Proxies resource.
HTTPS Request
POST https://<Backup-Office365>:4443/v3/Proxies |
Request Headers
The request header must contain the authorization token for the current logon session.
Request Body
The request body can contain the following properties:
Property | Type | Description |
|---|---|---|
HostName | string | Specifies the DNS-name or IP address of the proxy server. For example, "hostname": "qa.east.local". |
Description | string | Specifies the description of the backup proxy. For example, "description": "ABC Reports". |
Port | int | Specifies the port for connecting with the proxy server. Default: 9193. For example, "port": "9193". |
Username | string | Specifies the Windows user name to access the proxy server. For example, "username": "support\administrator". |
Password | string | Specifies the Windows user password to access the proxy server. For example, "password": "Passw0rd1". |
Attach | bool | Adds a backup proxy 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 and add it to the backup infrastructure. For example, "attachUsedProxy": "true". |
Threads | int | Specifies the number of threads that a backup proxy can process. For example, "threadsNumber": "32". |
Enable | bool | 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. For example, "enableNetworkThrottling": "true". |
ThrottlingValue | int | Specifies the network bandwidth limit value. For example, "throttlingValue": "2500". 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:
For example, "throttlingUnit": "KBs". NOTE: The EnableNetworkThrottling property must be set to true. Otherwise |
UseInternetProxy | bool | If set to true, indicates that Veeam Backup for Microsoft Office 365 will use an Internet proxy to process the backup jobs. For example: "useInternetProxy": "True". |
InternetProxyType | bool | Specifies a type of the internet proxy:
For example, "internetProxyType": "fromManagementServer". NOTE: UseInternetProxy must be set to true. |
InternetProxySettings | Specifies internet proxy settings used to connect to the Internet proxy. |
For example:
{ "useInternetProxy": true, "internetProxyType": "Custom", "internetProxySettings": { "hostName": "internetproxy", "port": 3128, "useAuthentication": true, "UserName": "administrator", "UserPassword": "password" }, "hostName": "proxyhost", "description": "Default backup proxy", "port": 9193, "threadsNumber": 64, "enableNetworkthrottling": false "enableNetworkthrottling": true, "throttlingValue": 2500, "throttlingUnit": "KBs" } |
The internet proxy settings have the following properties:
Property | Type | Description |
|---|---|---|
HostName | string | Indicates the name of the Internet proxy. For example, "hostName": "InternetProxy1". |
Port | int | Indicates a port for connection to the Internet proxy. The default port for connection to the Internet proxy is 3128. For example, "port": "3128". |
UseAuthentication | bool | Indicates that Veeam Backup for Microsoft Office 365 will use an authentication credentials when connecting to the Internet proxy. For example, "useAuthentication": "true". |
UserName | string | Indicates the username for the authentication with Internet proxy. For example, "userName": "LocalAdministrator". |
UserPassword | string | Indicates the username for the authentication with Internet proxy. For example, "userPassword": "LocalPassword". |
Response
The server returns the following response to the client.
Response Codes
A successfully completed operation returns 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 request body message: application/json; charset=utf-8 |
Response Body
In the response body, the server returns a representation of the backup proxy resource. The resource has the following URL: /Proxies/{proxyId}.
Example
The example below shows how to add a backup proxy to Veeam Backup for Microsoft Office 365.
Request: POST https://support.east.local:4443/v3/Proxies
Request Header: Authorization: Bearer <Access-Token>
Request Body: { "useInternetProxy": true, "internetProxyType": "Custom", "internetProxySettings": { "hostName": "internetproxy", "port": 3128, "useAuthentication": true, "UserName": "administrator", "UserPassword": "password" }, "hostName": "proxyhost", "description": "Default backup proxy", "port": 9193, "threadsNumber": 64, "enableNetworkthrottling": false "enableNetworkthrottling": true, "throttlingValue": 2500, "throttlingUnit": "KBs" }
Response: 201 Created
Response Body: { "useInternetProxy": true, "internetProxyType": "Custom", "internetProxySettings": { "hostName": "internetproxy", "port": 3128, "useAuthentication": true, "UserName": "administrator", "UserPassword": "password" }, "hostName": "proxyhost", "description": "Default backup proxy", "port": 9193, "threadsNumber": 64, "enableNetworkthrottling": false "enableNetworkthrottling": true, "throttlingValue": 2500, "throttlingUnit": "KBs" } |