This is an archive version of the document. To get the most up-to-date information, see the current version.

/Proxies/{proxyId}

In this article

    Represents a backup proxy with a specified ID.

    Resource URL

    The URL of the reference resource representation:

    https://<Backup-Office365>:4443/v3/Proxies/{proxyId}

    Related Resources

    Methods

    The following methods are supported for the /Proxies/{proxyId} resource:

    Properties

    The /Proxies/{proxyId} resource has the following properties:

    Property

    Type

    Description

    IsDefault

    bool

    If set to true, indicates that this proxy is default for Veeam Backup for Microsoft Office 365 server.

    For example, "isDeafult": "true".

    Id

    string

    Specifies the ID of a backup proxy.

    For example, "id": "46d10221-7974-42d7-bb38-f80e65f95f3d".

    HostName

    string

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

    For example, "hostname": "support.east.local".

    Description

    string

    Specifies the description of the backup proxy.

    For example, "description": "ABC Reports".

    Port

    int

    Specifies the port for connecting with the proxy server.

    For example, "port": "9193".

    Threads
    Number

    int

    Specifies the number of threads that a backup proxy can process.

    For example, "threadsNumber": "32". Default: 64.

    Enable
    NetworkThrottling

    bool

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

    For example, "enableNetworkThrottling": "true".

    ThrottlingValue

    int

    Specifies the network bandwidth limit value.

    For example, "throttlingValue": "1250".

    NOTE: EnableNetworkThrottling must be set to true.

    ThrottlingUnit

    string

    Specifies a measuring unit for network bandwidth limit:

    • Mbps
    • MBs
    • KBs

    For example, "throttlingUnit": "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.

    For example, "useInternetProxy": "true".

    InternetProxyType

    bool

    Specifies a type of the internet proxy:

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

    For example, "internetProxyType": "fromManagementServer".

    NOTE: UseInternetProxy must be set to true.

    InternetProxySettings

    internetProxySettings

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

    Status

    string

    Specifies the proxy status:

    • Online
    • Offline

    For example, "status": "Online"

    _links

    Dictionary of string [key] and Object [value]

    Links to related resources (navigation property).

    InternetProxySettings

    The internet proxy settings have the following properties:

    Property

    Type

    Description

    HostName

    string

    Indicates the name of the Internet proxy.

    For example, "hostName": "InternetProxy1".

    Port

    int

    Indicates a port for connection to the Internet proxy.

    The default port for connection to the Internet proxy is 3128.

    For example, "port": "3128".

    UseAuthentication

    bool

    Indicates that Veeam Backup for Microsoft Office 365 will use authentication credentials when connecting to the Internet proxy.

    For example, "useAuthentication": "true".

    UserName

    string

    Indicates the username for the authentication with the the Internet proxy.

    For example, "userName": "LocalAdministrator".

    UserPassword

    string

    Indicates the username for the authentication with the Internet proxy.

    For example, "userPassword": "LocalPassword".

    Resource Representation

    The /Proxies/{proxyId} resource has the following representation:

    {

       "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/v3/proxies/ea299798-8181-4726-841f-89a8a566b86b"

         },

         "repositories": {

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

         }

       }

     }

    I want to report a typo

    There is a misspelling right here:

     

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