Veeam Backup for Microsoft Office 365 4.0
RESTful API Reference
Related documents

Getting Notification Settings

This section explains how to get a resource representation of email notification settings.

Request

GET https://<hostname>:4443/v4/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

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

int

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

NotifyOnSuccess

boolean

If set to True, Veeam Backup for Microsoft Office 365 will send a notification message after a backup job completes its session without any warnings or errors.

NotifyOnWarning

boolean

If set to True, Veeam Backup for Microsoft Office 365 will send a notification message if the job finishes with warnings.

NotifyOnFailure

boolean

If set to True, Veeam Backup for Microsoft Office 365 will send a notification message if the job finishes with errors.

SupressUntilLastRetry

boolean

If set to True, Veeam Backup for Microsoft Office 365 will send a notification message according to the job schedule options. The following email notification scenarios are possible:

  • If the job fails, Veeam Backup for Microsoft Office 365 will send a notification message on the last job retry
  • If the job completes with Success or Warning, Veeam Backup for Microsoft Office 365 will send a notification message on the last completion status
  • If the job is scheduled to Terminate job if it runs longer than <interval>, Veeam Backup for Microsoft Office 365 will send a notification message on the last attempt within that interval

AttachDetailedReport

boolean

If set to True, Veeam Backup for Microsoft Office 365 will attach a report on the job results to the email notification.

_links

Dictionary of string [key] and Object [value]

Links to related resources (navigation property).

Example

The example below returns an entity representation of the email notification settings that Veeam Backup for Microsoft Office 365 sends on the backup job run results.

Request:

GET https://abc.tech.local:4443/v4/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/v4/vboemailsettings"

   }

 },

 "_actions": {

   "update": {

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

     "method": "PUT"

   }

 }

}

This Document Help Center
User GuideRESTful API ReferencePowerShell ReferenceVeeam Explorers User GuideVeeam Explorers PowerShell Reference
I want to report a typo

There is a misspelling right here:

 

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