This is an archive version of the document. To get the most up-to-date information, see the current version.(PUT) /Proxies/{proxyId}
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/{proxyId} resource:
HTTPS Request
PUT https://<Backup-Office365>:4443/v3/Proxies/{proxyId} |
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 | int | Specifies the number of threads that the proxy server will 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: EnableNetworkThrottling must be set to true. |
ThrottlingUnit | string | Specifies the measuring unit for network bandwidth limit:
For example, "throttlingUnit": "KBs". NOTE: EnableNetworkThrottling must be set to true. |
UseInternetProxy | bool | If set to true, indicates that Veeam Backup for Microsoft Office 365 uses the internet proxy. 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 the internet proxy connection settings. |
For example:
{ "useInternetProxy": true, "internetProxyType": "Custom", "internetProxySettings": { "hostName": "internet_proxy_host", "port": 3128, "useAuthentication": true, "UserName": "administrator" "UserPassword": "Password" }, "description": "ABC Monthly Reports", "port": 9193, "username": "administrator", "password": "Password", "threadsNumber": 128, "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 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/v3/Proxies/5a905bb5-9071-433c-9d2f-f805d4da2cf4
Request Header: Authorization: Bearer <Access-Token>
Request Body: { "useInternetProxy": true, "internetProxyType": "Custom", "internetProxySettings": { "hostName": "internet_proxy_host", "port": 3128, "useAuthentication": true, "UserName": "administrator" "UserPassword": "Password" }, "hostName": "proxy_host", "description": "Default backup proxy", "port": 9193, "threadsNumber": 64, "enableNetworkthrottling": false, }
Response: 200 OK |