Getting Existing Backup Proxy Servers
This section explains how to get a collection of existing backup proxy servers.
Request
GET https://<hostname>:4443/v4/Proxies |
Request Headers
The request header must contain an authorization token of the current session.
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 | boolean | Shows if a backup proxy server act as default. |
Id | string | The ID of a backup proxy server. |
hostName | string | The DNS name or IP-address of a backup proxy server. |
description | string | The description of a backup proxy server. |
port | int | A port number to connect to the backup proxy server. |
threadsNumber | int | The number of threads that a backup proxy server can process. |
enableNetworkthrottling | boolean | 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:
NOTE: EnableNetworkThrottling must be set to true. |
useInternetProxy | boolean | If set to true, indicates that Veeam Backup for Microsoft Office 365 proxy uses the internet proxy server. |
internetProxyType | boolean | Specifies the type of the internet proxy server:
NOTE: UseInternetProxy must be set to true. |
InternetProxySettings | Specifies the internet proxy server settings used to connect to the Internet proxy server. | |
status | string | Specifies the backup proxy server status:
|
_links | Dictionary of string [key] and Object [value] | Links to related resources (navigation property). |
Internet proxy server settings have the following properties:
Property | Type | Description |
|---|---|---|
hostName | string | The name of the internet proxy server. |
port | int | A port number to connect to the specified internet proxy server. The default port is 3128. |
useAuthentication | boolean | Indicates that Veeam Backup for Microsoft Office 365 will use an authentication credentials to connect 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. |
Example
The following request returns an entity representation of all backup proxy servers added to Veeam Backup for Microsoft Office 365.
Request: GET https://abc.tech.local:4443/v4/Proxies
Request Header: Authorization: Bearer <Access-Token>
Response: 200 OK [ { "isDefault": true, "useInternetProxy": true, "internetProxyType": "FromManagementServer", "id": "600c9940-2072-4708-9633-3af6e5188ed2", "hostName": "ABC", "description": "Default backup proxy", "port": 9193, "threadsNumber": 64, "enableNetworkthrottling": false, "status": "Online", "_links": { "self": {"href": "https://abc.tech.local:4443/v4/proxies/600c9940-2072-4708-9633-3af6e5188ed2"}, "repositories": {"href": "https://abc.tech.local:4443/v4/backuprepositories?proxyId=600c9940-2072-4708-9633-3af6e5188ed2"} } }, { "isDefault": false, "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": "https://abc.tech.local:4443/v4/proxies/8a002d46-9802-4183-a636-d1b31673c525"}, "repositories": {"href": "https://abc.tech.local:4443/v4/backuprepositories?proxyId=8a002d46-9802-4183-a636-d1b31673c525"} } } ] |
