Getting Notification Settings

This section explains how to get a resource representation of Veeam Explorer for Microsoft SharePoint notification settings.

Request

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

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 email notifications are enabled for Veeam Explorer for Microsoft SharePoint. The specified mail server settings will be also used for sending restored Microsoft SharePoint items by email.

SmtpServer

string

Specifies the full DNS name or IP address of the SMTP server used for sending notifications and restored items in email messages.

Port

int

Specifies the port for connecting to the SMTP server.

From

string

Specifies the email address from which notifications and restored Microsoft SharePoint data will be sent. This email address must have permissions to connect to the SMTP server if the SMTP server requires 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.

UseAuthentication

boolean

If set to True, indicates that the SMTP server requires authentication. Otherwise, a connection that does not enforce authentication will be established to the SMTP server.

UserName

string

Specifies the user name you want to use for authenticating with the SMTP server.

UserPassword

string

Specifies the password you want to use for authenticating with the SMTP server.

_links

Dictionary of string [key] and Object [value]

Links to related resources (navigation property).

Example

The example below returns an entity representation of the Veeam Explorer for Microsoft SharePoint settings that Veeam Backup for Microsoft Office 365 uses to send the notifications on the backup job run results.

Request:

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

 

Request Header:

Authorization: Bearer <Access-Token>

 

Response:

200 OK

 

Response Body:

{

"enableNotification": "true",

"server": "smtp.office365.com",

"port": 25,

"useAuthentication": "true",

"username": "vscott@tech.onmicrosoft.com",

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

"_links": {

   "self": {

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

   }

 }

}

I want to report a typo

There is a misspelling right here:

 

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