Get Email Notification Settings

You can get email notification settings configured in Veeam Backup for Microsoft Azure.

Request

To retrieve email notification settings, send the HTTP GET request to the /settings/emailNotifications endpoint.

HTTP Request

GET https://<hostname>/api/v2/settings/emailNotifications

Request Headers

The request contains the following headers.

Header

Required

Value

Description

Authorization

Required

Bearer <Access-Token>

Authenticates a client who sends the request to the server. Must contain the access token for the current logon session in the Bearer <Access-Token> format.

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 HTTP headers.

Header

Value

Description

Content-length

integer

Identifies the length of the response body message, in bytes.

Content-type

  • application/json
  • application/problem+json

Identifies the media type of the response body message.

Response Body

In the response body, Veeam Backup for Microsoft Azure returns a representation of the /emailNotifications collection. The EmailNotificationSettingsV2 schema is used for the collection representation.

Get Email Notification SettingsExample

The following request returns email notification settings configured in Veeam Backup for Microsoft Azure.

Request:

GET https://51.11.247.127/api/v2/settings/emailNotifications

 

Request Header:

Authorization: Bearer <Access-Token>

 

Response:

200

 

Response Body:

 

 "smtpSettings": {

   "host": "smtp.gmail.com",

   "port": 25,

   "useSecureConnection": false,

   "timeOutMiliSeconds": 100000

 },

 "notificationsEnabled": true,

 "from": "mc89bor@gmail.com",

 "to": "jane.dow@gmail.com",

 "subject": "[%JobResult%] %JobName% (%VmCount% virtual machines) %Issues%",

 "dailyReportSettings": {

   "sendDailyReport": false,

   "dailyTime": "00:00:00"

 },

 "emailNotificationSettings": {

   "notifyOnSuccess": true,

   "notifyOnWarning": true,

   "notifyOnFailure": true

 }

}

I want to report a typo

There is a misspelling right here:

 

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