Getting Backup Proxy Servers
You can get a collection of backup proxy servers.
Request
Request Headers
The request header must contain an authorization token of the current session.
Request Parameters
The following parameter must be specified in the URL of the request:
Parameter | Type | Description |
---|---|---|
extendedView | boolean | Defines the representation of the proxy server properties that will be returned to the client. Possible values:
The default value is true. |
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
The response contains the following information:
Property | Type | Description |
---|---|---|
type | string | Backup proxy type. Possible values:
|
id | string | ID of a backup proxy server. |
hostName | string | DNS name or IP address of a backup proxy server. |
description | string | Description of a backup proxy server. |
port | integer | Port number to connect to the backup proxy server. |
threadsNumber | integer | 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 | integer | Specifies the network bandwidth limit value. Note: The enableNetworkThrottling property value must be set to true. |
throttlingUnit | string | Specifies a measuring unit for network bandwidth limit:
Note: The enableNetworkThrottling property value 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 | string | Specifies the type of the internet proxy server:
Note: The useInternetProxy property value 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 | Name of the internet proxy server. |
port | integer | Port number used 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 | User name for the authentication with the internet proxy server. |
userPassword | string | Password for the authentication with the internet proxy server. |
Request: GET https://abc.tech.local:4443/v5/Proxies?extendedView=true
Request Header: Authorization: Bearer <Access-Token>
Response: 200 OK
Response Body: [ { "type": "Local", "useInternetProxy": true, "internetProxyType": "FromManagementServer", "id": "0338ee9f-e45d-4b74-a526-6f20d3110e0b", "hostName": "EPSILON", "description": "Default backup proxy", "port": 9193, "threadsNumber": 64, "enableNetworkThrottling": false, "status": "Online", "_links": { "self": { "href": "https://abc.tech.local:4443/v5/proxies/0338ee9f-e45d-4b74-a526-6f20d3110e0b" }, "repositories": { "href": "https://abc.tech.local:4443/v5/backuprepositories?proxyId=0338ee9f-e45d-4b74-a526-6f20d3110e0b" } } }, { "type": "Domain", "useInternetProxy": true, "internetProxyType": "FromManagementServer", "id": "5b62b36f-c586-4174-8dd9-14d85188db21", "hostName": "filesrv04.tech.local", "description": "Remote backup proxy", "port": 9193, "threadsNumber": 64, "enableNetworkThrottling": false, "status": "Online", "_links": { "self": { "href": "https://abc.tech.local:4443/v5/proxies/5b62b36f-c586-4174-8dd9-14d85188db21" }, "repositories": { "href": "https://abc.tech.local:4443/v5/backuprepositories?proxyId=5b62b36f-c586-4174-8dd9-14d85188db21" } } }, { "type": "Workgroup", "useInternetProxy": true, "internetProxyType": "FromManagementServer", "id": "cf54dab5-656c-4336-a3ad-192b495bcf20", "hostName": "172.24.31.71", "description": "Remote backup proxy", "port": 9193, "threadsNumber": 64, "enableNetworkThrottling": false, "status": "Online", "_links": { "self": { "href": "https://abc.tech.local:4443/v5/proxies/cf54dab5-656c-4336-a3ad-192b495bcf20" }, "repositories": { "href": "https://abc.tech.local:4443/v5/backuprepositories?proxyId=cf54dab5-656c-4336-a3ad-192b495bcf20" } } } ] |