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/v1/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 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 Windows user name to access the proxy server. For example, "username": "support\administrator". |
Password | string | Specifies 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 a 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. 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 a measuring unit for the network bandwidth limit:
For example, "throttlingUnit": "KBs". NOTE: The EnableNetworkThrottling property must be set to true. Otherwise |
For example:
{ "hostName": "support.east.local", "description": "ABC Company Reports", "port": 9193, "username": "admin\\qa", "password": "Pa$$w0rd", "attachUsedProxy": "true", "threadsNumber": 64, "enableNetworkthrottling": true, "throttlingValue": 2500, "throttlingUnit": "KBs" } |
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/{ID}.
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/v1/Proxies
Request Header: Authorization: Bearer <Access-Token>
Request Body:
{ "hostName": "qa.east.local", "description": "ABC Company Reports", "port": 9193, "username": "admin\\qa", "password": "Pa$$w0rd", "attachUsedProxy": "true", "threadsNumber": 64, "enableNetworkthrottling": true, "throttlingValue": 2500, "throttlingUnit": "KBs" }
Response: 201 Created
Response Body: { "id": "46d10221-7974-42d7-bb38-f80e65f95f3d", "hostName": "qa.east.local", "description": "ABC Company Reports", "port": 9193, "threadsNumber": 64, "enableNetworkthrottling": "true", "throttlingValue": 2500, "throttlingUnit": "KBs", "_links": { "self": { "href": "https://support.east.local:4443/v1/Proxies/46d10221-7974-42d7-bb38-f80e65f95f3d" }, "repositories": { "href": "https://support.east.local:4443/v1/Proxies/46d10221-7974-42d7-bb38-f80e65f95f3d/repositories" } } } |
Related Topics
