Veeam Backup for Microsoft Office 365 4.0
RESTful API Reference
Related documents

Getting Backup Proxy Servers

This section explains how to get a resource representation of a backup proxy with the specified ID.

Request

GET https://<hostname>:4443/v4/Proxies/{proxyId}

Request Headers

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

Request Parameters

The following parameters must be posted as URL.

Parameter

Type

Description

proxyId

string

An identification number of the backup proxy server.

Request Body

None.

Response

The server returns the following response to the client.

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

Property

Type

Description

IsDefault

bool

Indicates whether the backup proxy server is the default one.

Id

string

The ID of a backup proxy server.

hostName

string

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

description

string

The description of the backup proxy server.

port

int

The port number via which to connect to the backup proxy server.

threadsNumber

int

The number of threads that a backup proxy server can process.

enableNetworkthrottling

bool

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

throttlingValue

int

Specifies the network bandwidth limit value.

NOTE: EnableNetworkThrottling must be set to true.

throttlingUnit

string

Specifies a measuring unit for network bandwidth limit:

  • Mbps
  • MBs
  • KBs

NOTE: EnableNetworkThrottling must be set to true.

useInternetProxy

bool

If set to true, indicates that Veeam Backup for Microsoft Office 365 proxy uses the internet proxy server.

internetProxyType

bool

Specifies a type of the internet proxy server:

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

NOTE: UseInternetProxy must be set to true.

InternetProxySettings

internetProxySettings

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

status

string

Specifies the backup proxy server status:

  • Online
  • Offline

_links

Dictionary of string [key] and Object [value]

Links to related resources (navigation property).

InternetProxySettings

Property

Type

Description

hostName

string

The name of the internet proxy server.

port

int

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

useAuthentication

bool

Indicates that Veeam Backup for Microsoft Office 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 username for the authentication with Internet proxy.

Example

The example below returns an entity representation of a backup proxy server with the ID ea299798-8181-4726-841f-89a8a566b86b.

Request:

GET https://abc.tech.local:4443/v4/Proxies/ea299798-8181-4726-841f-89a8a566b86b

 

Request Header:

Authorization: Bearer <Access-Token>

 

Response:

200 OK

 

Response Body:

 {

   "isDefault": false,

   "useInternetProxy": true,

   "internetProxyType": "Custom",

   "internetProxySettings": {

      "hostName": "internet_proxy_host",

      "port": 3128,

      "useAuthentication": true,

      "UserName": "administrator"

   },

   "id": "ea299798-8181-4726-841f-89a8a566b86b",

   "hostName": "deafault_proxy_host",

   "description": "Default backup proxy",

   "port": 9193,

   "threadsNumber": 64,

   "enableNetworkthrottling": false,

   "status": "Online",

   "_links": {

     "self": {

       "href": "https://127.0.0.1:4443/v4/proxies/ea299798-8181-4726-841f-89a8a566b86b"

     },

     "repositories": {

       "href": "https://127.0.0.1:4443/v4/proxies/ea299798-8181-4726-841f-89a8a566b86b/repositories"

     }

   }

 }

This Document Help Center
User GuideRESTful API ReferencePowerShell ReferenceVeeam Explorers User GuideVeeam Explorers PowerShell Reference
I want to report a typo

There is a misspelling right here:

 

I want to let the Veeam Documentation Team know about that.