Getting Notification Settings

In this article

    You can get a resource representation of email notification settings.

    Request

    GET https://<hostname>:4443/v5/VBOEmailSettings

    Request Headers

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

    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

    enableNotification

    boolean

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

    smtpServer

    string

    Specifies the full DNS name or IP address of the SMTP server for sending email notifications.

    port

    integer

    Specifies the port for connecting to the SMTP server.

    useAuthentication

    boolean

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

    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.

    from

    string

    Specifies notification sender email address with the rights to connect to the SMTP server.

    to

    string

    Specifies notification recipient email address. Semicolon is used for listing multiple recipients.

    subject

    string

    Specifies the subject that must be used for creating a notification email. The subject of an email notification displays information according to the following variables:

    • %JobName% - backup job name
    • %JobResult% - backup job result
    • %OrgName% - the organization, whose data was processed by the backup job
    • %MailboxCount% - total number of processed mailboxes
    • %Issues% - number of objects processed with Failed or Warning status
    • %Time% - date and time of the backup job completion

    _links

    Dictionary of string [key] and Object [value]

    Links to related resources (navigation property).

    Examples

    Example 1

    The example returns a resource representation of settings that Veeam Backup for Microsoft Office 365 uses to send email notifications about backup job results.

    Request:

    GET https://abc.tech.local:4443/v5/VBOEmailSettings

     

    Request Header:

    Authorization: Bearer <Access-Token>

     

    Response:

    200 OK

     

    Response Body:

    {

    "enableNotification": true,

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

    "port": 587,

    "useAuthentication": false,

    "useSSL": true,

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

    "to": "helpdesk@tech.com",

    "subject": "[%JobResult%] %OrgName% - %JobName% (%MailboxCount% mailboxes), %Issues% issues",

    "notifyOnSuccess": true,

    "notifyOnWarning": true,

    "notifyOnFailure": true,

    "supressUntilLastRetry": true,

    "_links": {

       "self": {

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

       }

     },

     "_actions": {

       "update": {

         "uri": "https://abc.tech.local:4443/v5/vboemailsettings",

         "method": "PUT"

       }

     }

    }