Getting Backup Proxy Servers

In this article

    You can get a resource representation of a backup proxy server with the specified ID.

    Request

    GET https://<hostname>:4443/v5/Proxies/{proxyId}?extendedView=<boolean>

    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. Possible values:

    • true — controller requests the proxy server and if the proxy server is online, returns all properties of the proxy server.
    • false — even if the proxy server is offline, the controller returns the proxy server properties without the following properties:
    • threadsNumber
    • throttlingValue
    • throttlingUnit

    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:

    • Domain — the backup proxy is deployed on a machine that resides in the same domain as the Veeam Backup for Microsoft Office 365 server or a trusted domain.
    • Local — the backup proxy is the default backup proxy deployed on the Veeam Backup for Microsoft Office 365 server.
    • Workgroup — the backup proxy is deployed on a machine that resides in a workgroup.

    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 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:

    • Mbps
    • MBs
    • KBs

    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:

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

    Note: The useInternetProxy property value 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

    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

    Indicates that Veeam Backup for Microsoft Office 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.

    Examples

    Example 1

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

    Request:

    GET https://abc.tech.local:4443/v5/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": "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"

       }

     }

    }