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

/Proxies/{ID}

Represents a backup proxy with the specified ID.

Resource URL

The URL of the reference resource representation:

https://<Backup-Office365>:<Port>/v1/Proxies/{ID}

Related Resources

/Proxies/{ID}/Repositories

Methods

The following methods are supported for the /Proxies/{ID} resource:

Properties

The /Proxies/{ID} resource has the following properties:

Property

Type

Description

Id

string

Specifies the ID of a backup proxy.

For example, "id": "46d10221-7974-42d7-bb38-f80e65f95f3d".

HostName

string

Specifies DNS-name or IP address of the proxy server.

For example, "hostname": "support.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.

For example, "port": "9193".

Threads
Number

int

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

For example, "threadsNumber": "32". Default: 64.

Enable
NetworkThrottling

bool

If set to true, indicates that Veeam Backup for Microsoft Office 365 limits the network bandwidth for performance optimization.

For example, "enableNetworkThrottling": "true".

ThrottlingValue

int

Specifies the network bandwidth limit value.

For example, "throttlingValue": "1250".

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.

Status

string

Specifies the proxy status:

  • Online
  • Offline

For example, "status": "Online"

_links

Dictionary of string [key] and Object [value]

Links to related resources (navigation property).

Resource Representation

The /Proxies/{ID} resource has the following representation:

{

   "id": "46d10221-7974-42d7-bb38-f80e65f95f3d",

   "hostName": "support.east.local",

   "description": "ABC Company Reports",

   "port": 9193,

   "threadsNumber": 64,

   "enableNetworkthrottling": "true",

   "throttlingValue": 1250,

   "throttlingUnit": "KBs",

   "status": "Online",

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

Configuring Backup Proxies

Veeam Large Logo

User Guide

RESTful API Reference

PowerShell Reference