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

(PUT) /InternetProxySettings

In this article

    Edits internet proxy settings.

    Request

    To edit internet proxy settings, send the PUT HTTPS request to the URL of the /InternetProxySettings resource.

    HTTPS Request

    PUT https://<Backup-Office365>:4443/v3/InternetProxySettings

    Request Headers

    The request header must contain the authorization token for the current logon session.

    Request Body

    To edit the internet proxy settings, you need to enter in the request body the corresponding properties with new values. The properties you omit will remain unchanged.

    The request body can contain the following properties:

    Property

    Type

    Description

    HostName

    string

    Indicates a 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 an authentication credentials when connecting to the internet proxy.

    For example, "useAuthentication": "true".

    UserName

    string

    Indicates the username for the authentication with internet proxy.

    For example, "userName": "LocalAdministrator".

    UserPassword

    string

    Indicates the username for the authentication with internet proxy.

    For example, "userPassword": "LocalPassword".

    For example:

    {

     "useInternetProxy": true,

     "hostName": "internetproxyhost",

     "port": 3128,

     "useAuthentication": true,

     "username": "administrator"

     "userpassword": "password"

    }

    Response

    The server returns the following response to the client.

    Response Codes

    A successfully completed operation returns 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 request body message: application/json; charset=utf-8

    Response Body

    None.

    Example

    The example below shows how to update the internet proxy settings.

    Request:

    PUT https://support.east.local:4443/v3/InternetProxySettings

     

    Request Header:

    Authorization: Bearer <Access-Token>

     

    Response:

    200 OK

     

    Response Body:

     {

     "useInternetProxy": true,

     "hostName": "internetproxyhost",

     "port": 3128,

     "useAuthentication": true,

     "username": "administrator",

     "userPassword": "password"

    }

    I want to report a typo

    There is a misspelling right here:

     

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