This is an archive version of the document. To get the most up-to-date information, see the current version.Schemas
The following JSON schema is used to represent the /emailNotifications collection in the Veeam Backup for AWS REST API. Properties included in schema represent email notification settings. Properties are also used as parameters in POST requests.
EmailNotifications
Property | Type | Description |
|---|---|---|
enabled | boolean | Defines whether email notifications are enabled. Default value is false. |
server | string | DNS name or an IP address of the SMTP server. |
port | integer | Port number used by the SMTP server. Default value is 25. |
useSsl | boolean | Defines whether to use the secure connection for email operations. Default value is false. |
timeout | integer | Connection timeout for the SMTP server. Default value is 100000. |
useCredentials | boolean | Defines whether to use a specific account to connect to the SMTP server. Default value is false. |
credentialsId | string | System ID of an SMTP server credentials record used to connect the SMTP server. |
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%. |
onSuccess | boolean | Defines whether an email notification must be sent in case a backup policy completes successfully. Default value is true. |
onWarning | boolean | Defines whether an email notification must be sent in case a backup policy completes with a warning. Default value is true. |
onFailure | boolean | Defines whether an email notification must be sent in case a backup policy fails. Default value is true. |
enableScheduledNotification | boolean | Defines whether a daily report must be sent. Default value is false. |
notifyTime | string | Date and time when a report must be generated and sent. Default value is 09:00 AM. |