Editing Internet Proxy Server Settings

In this article

    You can edit internet proxy server settings.

    Request

    PUT https://<hostname>:4443/v5/InternetProxySettings

    Request Headers

    The request header must contain an authorization token of the current session.

    Request Body

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

    The following table lists available request properties.

    Property

    Type

    Description

    hostName

    string

    Indicates a name of the internet proxy server.

    port

    integer

    Indicates a port number which is used to connect to the internet proxy server.

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

    useAuthentication

    boolean

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

    userName

    string

    Indicates the username for authentication with the internet proxy.

    userPassword

    string

    Indicates the username for authentication with the internet proxy.

    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

    None.

    Examples

    Example 1

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

    Request:

    PUT https://abc.tech.local:4443/v5/InternetProxySettings

     

    Request Header:

    Authorization: Bearer <Access-Token>

     

    Request Body:

    {

     "useInternetProxy": true,

     "hostName": "internetproxyhost",

     "port": 3128,

     "useAuthentication": true,

     "userName": "administrator",

     "userPassword": "password"

    }

     

    Response:

    200 OK

    I want to report a typo

    There is a misspelling right here:

     

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