Send Test Message

You can check the email notification settings you want to use for Veeam Backup for Microsoft Azure.

Request

To send a test email, send the HTTP POST request to the /settings/emailNotifications/sendTestMessage endpoint.

HTTP Request

POST https://<hostname>/api/v2/settings/emailNotifications/sendTestMessage

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.

Request Body

To send a test message use the EmailNotificationSettingsV2 schema to send parameters in the request body. If you do not send a parameter, Veeam Backup for Microsoft Azure sets the default parameter value. The following parameters are required:

TestEmailMessageV2

Property

Type

Description

SmtpSettingsFromClientV2

SmtpSettingsV2

Specifies settings of the SMTP server.

from

string

Email address from which email notifications must be sent.

to

string

Recipient email addresses.

SmtpSettingsV2

Property

Type

Description

accountId

string

System ID assigned in the Veeam Backup for Microsoft Azure REST API to the standard account that is used for authentication on the SMTP server.

host

string

DNS name or an IP address of the SMTP server.

port

integer($int32)

Port number used by the SMTP server. Default value is 25.

useSecureConnection

boolean

Defines whether to use the secure connection for email operations. Default value is false.

timeOutMiliSeconds

integer($int32)

Connection timeout for the SMTP server. Default value is 100000.

Set the parameter values in the following format:

{

 "smtpSettings": {

   "accountId": "string",

   "host": "string",

   "port": 0,

   "useSecureConnection": true,

   "timeOutMiliSeconds": 0

 },

 "from": "string",

 "to": "string"

}

Response

The server returns the following response to the client.

Response Codes

A successfully completed operation returns a response code 202 (Accepted).

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 202 response code and a link to the /operations/{operationId} endpoint that contains the result of the operation.

Send Test MessageExample

The following request configures email notification settings for Veeam Backup for Microsoft Azure.

Request:

POST https://51.11.247.127/api/v2/settings/emailNotifications/sendTestMessage

 

Request Header:

Authorization: Bearer <Access-Token>

 

Request Body:

{

 "smtpSettings": {

   "accountId": "1325",

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

   "port": 25,

   "useSecureConnection": false,

   "timeOutMiliSeconds": 100000

 },

 "from": "administrator@tech.local",

 "to": "group@tech.local"

}

 

Response:

202

 

Response Body:

{

 "id": "f850b602-765d-4306-b4e3-24e50593bb70",

 "startTime": "2020-11-23T09:23:08.2280607Z",

 "status": "Running",

 "_links": {

   "self": {

     "href": "https://51.11.247.127/api/v2/operations/f850b602-765d-4306-b4e3-24e50593bb70"

   }

 }

}

I want to report a typo

There is a misspelling right here:

 

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