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

(GET) /VEXEmailSettings

Returns a resource representation of VEX e-mail settings.

Request

To get the the list of VEX e-mail settings, send GET HTTPS request to the URL of the /VEXEmailSettings resource.

HTTPS Request

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

Request Headers

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

Request Body

None.

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

In the response body the server returns a representation of the /VEXEmailSettings resource.

Example

The example below returns an entity representation of VEX e-mail settings used for sending restored organization's mailbox items via e-mail.

Request:

GET https://support.east.local:4443/v1/EmailSettings

 

Request Header:

Authorization: Bearer <Access-Token>

 

Response:

200 OK

 

Response Body:

{

"enableNotification": "true",

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

"port": 25,

"useAuthentication": "true",

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

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

"_links": {

   "self": {

     "href": "https://support.east.local:4443/v1/vexemailsettings"

   }

 }

}

Veeam Large Logo

User Guide

RESTful API Reference

PowerShell Reference