Schemas

The following JSON schema is used to represent the /emailNotifications collection in the Veeam Backup for Microsoft Azure REST API. Properties included in schema represent email notification settings. Properties are also used as parameters in POST requests.

SchemasEmailNotificationSettingsV2

Property

Type

Description

smtpSettings

SmtpSettingsV2

Specifies settings of the SMTP server.

notificationsEnabled

boolean

Defines whether email notifications are enabled. The default value is false.

from

string

Email address from which email notifications must be sent.

to

string

Recipient email addresses.

subject

string

Subject for the sent message. Default value is [%JobResult%] %JobName% (%ObjectCount% instances) %Issues%.

dailyReportSettings

DailyReportSettingsV2

Specifies the daily report settings.

emailNotificationSettings

EventEmailNotificationSettingsV2

Defines whether an email notification must be sent in case a backup policy completes successfully, with warning or failed.

SchemasSmtpSettingsV2

Property

Type

Description

host

string

DNS name or an IP address of the SMTP server.

port

integer($int32)

Port number used by the SMTP server. The default value is 25.

useSecureConnection

boolean

Defines whether to use the secure connection for email operations. Default value is false.

timeOutMiliSeconds

integer($int32)

Connection timeout for the SMTP server. The default value is 100000.

SchemasDailyReportSettingsV2

Property

Type

Description

sendDailyReport

boolean

Defines whether a daily report must be sent. Default value is false.

dailyTime

string($date-span)

Date and time when a report must be generated and sent. Default value is 09:00 AM.

SchemasEventEmailNotificationSettingsV2

Property

Type

Description

notifyOnSuccess

boolean

Defines whether an email notification must be sent in case a backup policy completes successfully. Default value is true.

notifyOnWarning

boolean

Defines whether an email notification must be sent in case a backup policy completes with a warning. Default value is true.

notifyOnFailure

boolean

Defines whether an email notification must be sent in case a backup policy fails. Default value is true.

I want to report a typo

There is a misspelling right here:

 

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