Editing Notification Settings

In this article

    You can edit Veeam Explorer for Microsoft OneDrive for Business notification settings.

    Request

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

    Request Headers

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

    Request Body

    To edit email notification 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

    enableNotification

    boolean

    If set to true, indicates that Veeam Backup for Microsoft Office 365 will send email notifications about the backup job completion results.

    smtpServer

    string

    Specifies the full DNS name or IP address of the SMTP server.

    port

    integer

    Specifies the port number to connect to the SMTP server.

    from

    string

    Specifies the email address of a sender.

    useSSL

    boolean

    If set to true, indicates that Veeam Backup for Microsoft Office 365 uses a secure connection for email notification transmission. Otherwise, email notifications will be transmitted through the connection that does not require SSL authentication.

    useAuthentication

    boolean

    If set to true, indicates that SMTP server requires authentication. Otherwise, the connection will be established to the SMTP server which does not enforce authentication.

    username

    string

    Specifies the user name to authenticate on an SMTP server.

    userpassword

    string

    Specifies the password to authenticate on an SMTP server.

    _links

    Dictionary of string [key] and Object [value]

    Links to related resources (navigation property).

    For example:

    Request Body:

    {

    "enableNotification": true,

    "smtpServer": "smtp.office365.com",

    "port": 587,

    "useAuthentication": false,

    "useSSL": true,

    "username": "vscott@tech.onmicrosoft.com",

    "userpassword": "P@ssW0rd",

    "from": "vbo@tech.com",

    "_links": {

       "self": {

         "href": "https://abc.tech.local:4443/v5/veodemailsettings"

       }

     }

    }

    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 shows how to update email notification settings.

    Request:

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

     

    Request Header:

    Authorization: Bearer <Access-Token>

     

    Request Body:

    {

    "enableNotification": true,

    "smtpServer": "smtp.office365.com",

    "port": 587,

    "useAuthentication": false,

    "useSSL": true,

    "username": "vscott@tech.onmicrosoft.com",

    "userpassword": "P@ssW0rd",

    "from": "vbo@tech.com",

    "_links": {

       "self": {

         "href": "https://abc.tech.local:4443/v5/veodemailsettings"

       }

     }

    }

     

    Response:

    200 OK