Help Center
Choose product document...
Veeam Backup for Microsoft Office 365
RESTful API Reference

(PUT) /VEXEmailSettings

Edits VEX e-mail settings.

Request

To edit VEX e-mail settings, send the PUT HTTPS request to the URL of the /VEXEmailSettings resource.

HTTPS Request

PUT https://<Backup-Office365>:<Port>/v1/VEXEmailSettings

Request Headers

The request header must contain the authorization token for the current logon session.

Request Body

To edit VEX e-mail settings, you need to enter in the request body the corresponding properties with new values. The properties you omit will remain unchanged.

The request body must contain the following properties:

Property

Type

Description

EnableNotification

bool

If set to True, indicates that mail server settings will be used for sending restored mailbox items via e-mail.

For example, "enableNotification": "true".

Server

string

Specifies the full DNS name or IP address of the SMTP server for sending restored mailbox items in e-mail messages.

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

Port

int

Specifies the port for connecting to SMTP server.

For example, "port": "25".

UseAuthentication

bool

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

For example, "useAuthentication": "true".

User

string

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

For example, "user": " vscott@tech.onmicrosoft.com".

Password

string

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

For example, "password": "P@ssW0rd".

UseSSL

bool

If set to True, indicates that Veeam Backup for Microsoft Office 365 will use a secure connection for e-mail notification transmission. Otherwise, e-mail notifications will be transmitted through the connection that does not require SSL authentication.

For example, "useSSL": "true".

From

string

Specifies the e-mail address from which the restored mailbox data will be sent. This e-mail address must have the rights to connect to SMTP server, If SMTP server requires authentication.

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

For example:

{

"enableNotification": "true",

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

"port": 25,

"useAuthentication": "true",

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

"password": "P@ssW0rd",

"useSSL": "true",

"from": "support@tech.com"

}

Response

The server returns the following response to the client.

Response Codes

A successfully completed operation returns 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 request body message: application/json; charset=utf-8

Response Body

None.

Example

The example below shows how to update VEX e-mail settings.

Request:

PUT https://support.east.local:4443/v1/VEXEmailSettings

 

Request Header:

Authorization: Bearer <Access-Token>

 

Request Body:

{

"enableNotification": "true",

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

"port": 25,

"useAuthentication": "true",

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

"password": "P@ssW0rd",

"useSSL": "true",

"from": "support@tech.com"

}

 

Response:

200 OK

Veeam Large Logo

User Guide

RESTful API Reference

PowerShell Reference