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

(GET) /VBOEmailSettings

Returns a resource representation of email notification settings.

Request

To get the the list of email notification settings, send GET HTTPS request to the URL of the /VBOEmailSettings resource.

HTTPS Request

GET https://<Backup-Office365>:4443/v2/VBOEmailSettings

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 /VBOEmailSettings resource.

Example

The example below returns an entity representation of the email notification settings that Veeam Backup for Microsoft Office 365 sends on the backup job run results.

Request:

GET https://support.east.local:4443/v2/VBOEmailSettings

 

Request Header:

Authorization: Bearer <Access-Token>

 

Response:

200 OK

 

Response Body:

{

"enableNotification": "true",

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

"port": 587,

"useAuthentication": "false",

"useSSL": "true",

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

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

"subject": "[%JobResult%] %OrgName% - %JobName% (%MailboxCount% mailboxes), %Issues% issues",

"notifyOnSuccess": "true",

"notifyOnWarning": "true",

"notifyOnFailure": "true",

"supressUntilLastRetry": "true",

"_links": {

   "self": {

     "href": "https://support.east.local:4443/v2/vboemailsettings"

   }

 },

 "_actions": {

   "update": {

     "uri": "https://support.east.local:4443/v2/vboemailsettings",

     "method": "PUT"

   }

 }

}

Veeam Large Logo

User Guide

RESTful API Reference

PowerShell Reference