Getting Audit Notification Settings

In this article

You can get a resource representation of audit notification settings.

Request

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

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

In the response body, the server returns a resource representation of the /AuditEmailSettings resource. The response body contains the following properties:

Property	Type	Description
enableNotification	boolean	Defines whether Veeam Backup for Microsoft Office 365 is set to send audit notifications by email.
smtpServer	string	DNS name or IP address of the SMTP server for sending email notifications.
port	integer	Port used for connection to the SMTP server.
useAuthentication	boolean	Defines whether the SMTP server requires authentication.
useSSL	boolean	Defines whether Veeam Backup for Microsoft Office 365 uses a secure connection to transmit email notifications.
from	string	Email address of the notification sender.
to	string	Email address of the notification recipient. For listing multiple recipients, use semicolon (;) as a separator.
subject	string	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% — user name of the account used to perform an operation with the backed-up data. %StartTime% — date and time when a user performed an operation with the backed-up data.
_links	Dictionary of string [key] and Object [value]	Links to related resources (navigation property).
_actions	Dictionary of string [key] and Object [value]	Links to related actions (navigation property).

Examples

Example 1

The example returns a resource representation of settings that Veeam Backup for Microsoft Office 365 uses to send audit notifications by email.

Request:

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

Request Header:

Authorization: Bearer <Access-Token>

Response:

200 OK

Response Body:

{

"_links": {

"self": {

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

}

"_actions": {

"update": {

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

"method": "PUT"

}

"enableNotification": true,

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

"port": 587,

"useAuthentication": false,

"useSSL": false,

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

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

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

}