Help Center
Choose product document...
Veeam Backup for Microsoft Office 365 2.0
RESTful API Reference

(PUT) /Proxies/{ID}

Edits the backup proxy with a specified ID.

Request

To edit the settings of a backup proxy, send the PUT HTTPS request to the URL of the/Proxies/{ID}resource:

HTTPS Request

PUT https://<Backup-Office365>:4443/v2/Proxies/{ID}

Request Headers

The request header must contain the authorization token for the current logon session.

Request Body

To edit backup proxy settings, you need to enter in the request body the corresponding properties with new values. The properties you omit will remain unchanged.

The request body can contain the following properties:

Property

Type

Description

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.

For example, "port": "9192".

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".

Threads
Number

int

Specifies the number of threads that a backup proxy can process.

For example, "threadsNumber": "32".

Enable
NetworkThrottling

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: EnableNetworkThrottling must be set to true.

ThrottlingUnit

string

Specifies a measuring unit for network bandwidth limit:

  • Mbps
  • MBs
  • KBs

For example, "throttlingUnit": "KBs".

NOTE: EnableNetworkThrottling must be set to true.

For example:

{

 "description": "ABC Monthly Reports",

 "port": 9193,

 "username": "support\administrator",

 "password": "Passw0rd1",

 "threadsNumber": 128,

 "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 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 request 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://support.east.local:4443/v2/Proxies/5a905bb5-9071-433c-9d2f-f805d4da2cf4

 

Request Header:

Authorization: Bearer <Access-Token>

 

Request Body:

{

 "description": "ABC Monthly Reports",

 "port": 9193,

 "username": "support\administrator",

 "password": "Pas$sw0rd1",

 "threadsNumber": 128,

 "enableNetworkthrottling": "true",

 "throttlingValue": 2500,

 "throttlingUnit": "KBs"

}

 

Response:

200 OK

Veeam Large Logo

User Guide

RESTful API Reference

PowerShell Reference