This is an archive version of the document. To get the most up-to-date information, see the current version.

Adding Backup Proxy Servers

You can add a Veeam Backup for Microsoft 365 backup proxy server to the Veeam Backup for Microsoft 365 configuration.

Request

POST https://<hostname>:4443/v6/Proxies

Request Headers

The request header must contain an authorization token of the current session.

Request Body

The request body must contain the following properties:

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

integer

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.

useDomainNetwork

boolean

Defines the type of the backup proxy server to add. The following values are available:

  • true — domain backup proxy, that is, a backup proxy server that resides in the same domain as the Veeam Backup for Microsoft 365 server or in a trusted domain.
  • false — workgroup backup proxy, that is, a backup proxy server that resides in a workgroup.

If you omit this property, a workgroup backup proxy will be added.

attachUsedProxy

boolean

Adds a backup proxy server that is already managed by another Veeam Backup for Microsoft 365 server.

If set to true, indicates that Veeam Backup for Microsoft 365 will take ownership of the backup proxy server and add it to the backup infrastructure.

threadsNumber

integer

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

enableNetworkThrottling

boolean

If set to true, indicates that Veeam Backup for Microsoft 365 will limit the network bandwidth for performance optimization. Use the throttlingValue property to set the network throttling value.

throttlingValue

integer

Specifies the network bandwidth limit value.

Note: The enableNetworkThrottling property value 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. The following values are available:

  • Mbps
  • MBs
  • KBs

Note: The enableNetworkThrottling property value must be set to true.

useInternetProxy

boolean

If set to true, indicates that Veeam Backup for Microsoft 365 will use an internet proxy server to process backup jobs.

internetProxyType

string

Specifies the type of the internet proxy server. The following types are available:

  • From management server — the internet proxy server uses connection settings from the Veeam Backup for Microsoft 365 server.
  • Custom — the internet proxy server uses connection settings configured on the Veeam Backup for Microsoft 365 proxy.

Note: The useInternetProxy property value must be set to true.

internetProxySettings

internetProxySettings

Specifies internet proxy settings used to connect to the internet proxy server.

internetProxySettings

Property

Type

Description

hostName

string

The name of the internet proxy server.

port

integer

A port number which is used to connect to the specified internet proxy server. The default port is 3128.

useAuthentication

boolean

Defines that Veeam Backup for Microsoft 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/v6/Proxies

 

Request Header:

Authorization: Bearer <Access-Token>

 

Request Body:

{

   "hostName": "storage1.tech.local",

   "username": "Administrator",

   "password": "xxxxxxxxxxx",
       "useDomainNetwork": true,

   "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 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 response body message: application/json; charset=utf-8

Response Body

In the response body, the server returns a resource representation of the /Proxies/{proxyId} resource. For more information, see Getting Backup Proxy Servers.

Response Example

Response:

200 OK

 

Response Body:

{

  "type": "Domain",

  "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": "/v6/proxies/8a002d46-9802-4183-a636-d1b31673c525"},

     "repositories": {"href": "/v6/proxies/8a002d46-9802-4183-a636-d1b31673c525/repositories"}

  }

}