Editing Audit Notification Settings

This section explains how to edit audit notification settings.

Request

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

Request Headers

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

Request Body

To edit audit notification settings, you need to enter in the request body the properties that you want to change with new values. The properties you omit will remain unchanged.

The following table lists available request parameters.

Property

Type

Description

EnableNotification

boolean

Defines whether Veeam Backup for Microsoft Office 365 will send audit notifications by email.

SmtpServer

string

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

Port

int

Specifies the port used for connection to the SMTP server.

UseAuthentication

boolean

Defines whether the SMTP server requires authentication.

Username

string

Specifes the user name of the account used for authentication with the SMTP server.

UserPassword

string

Specifies the password of the account used for authentication with the SMTP server.

UseSSL

boolean

Defines whether Veeam Backup for Microsoft Office 365 will use a secure connection to transmit email notifications.

From

string

Specifies email address of the notification sender.

To

string

Specifies email address of the notification recepient. For listing multiple recipients, use semicolon (;) as a separator.

Subject

string

Specifies the subject for email notifications. The subject of an email notification displays information according to the following variables:

  • %OrganizationName% — organization whose data was processed by a backup job.
  • %DisplayName% — display name of the backed-up item for which a user performed an operation.
  • %Action% — name of the operation performed with the backed-up data.
  • %InitiatedByUserName% — name of the user who performed an operation with the backed-up data.
  • %StartTime% — date and time when a user performed an operation with the backed-up data.

For example:

Request Body:

{

 "enableNotification": "true",

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

 "port": 590,

 "useAuthentication": "true",

 "username": "john.smith@tech.com",

 "useSSL": "true",

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

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

 "subject": "[Audit] %OrganizationName% - %DisplayName% - %Action% initiated by %InitiatedByUserName% at %StartTime%"

}

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.

Example

The example below shows how to update audit notification settings.

Request:

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

 

Request Header:

Authorization: Bearer <Access-Token>

 

Request Body:

{

 "enableNotification": "true",

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

 "port": 590,

 "useAuthentication": "true",

 "username": "john.smith@tech.com",

 "useSSL": "true",

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

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

 "subject": "[Audit] %OrganizationName% - %DisplayName% - %Action% initiated by %InitiatedByUserName% at %StartTime%"

}

 

Response:

200 OK

I want to report a typo

There is a misspelling right here:

 

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