Getting Backup Proxy Servers
You can get a resource representation of a backup proxy server with the specified ID.
Request
Request Headers
The request header must contain an authorization token of the current session.
Request Parameters
The following parameters must be specified in the URL of the request:
Parameter | Type | Description |
---|---|---|
proxyId | string | Specifies the identification number of the backup proxy server. For more information on how to get this parameter, see Getting Backup Proxy Servers. |
extendedView | boolean | Defines the representation of the proxy server properties that will be returned to the client. The following values are available:
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 body contains the following properties:
Property | Type | Description |
---|---|---|
type | string | Specifies the backup proxy type. The following types are available:
|
id | string | ID of a backup proxy server. |
hostName | string | DNS name or IP address of the backup proxy server. |
description | string | Description of the backup proxy server. |
port | integer | Port number over which 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 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. The following values are available:
Note: The enableNetworkThrottling property value must be set to true. |
useInternetProxy | boolean | If set to true, indicates that Veeam Backup for Microsoft 365 proxy uses the internet proxy server. |
internetProxyType | string | Specifies the type of the internet proxy server. The following types are available:
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. The following values are available:
|
_links | Dictionary of string [key] and Object [value] | Links to related resources (navigation property). |
Property | Type | Description |
---|---|---|
hostName | string | Name of the internet proxy server. |
port | integer | Port number over which 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 | User name of the account used for authentication with the internet proxy server. |
userPassword | string | Password of the account used for authentication with the internet proxy server. |
Request: GET https://abc.tech.local:4443/v6/Proxies/ea299798-8181-4726-841f-89a8a566b86b?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": "/v6/proxies/0338ee9f-e45d-4b74-a526-6f20d3110e0b" }, "repositories": { "href": "/v6/backuprepositories?proxyId=0338ee9f-e45d-4b74-a526-6f20d3110e0b" } } } |