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 | Specifies settings of the SMTP server. | |
from | string | Email address from which email notifications must be sent. |
to | string | Recipient email addresses. |
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 |
| 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.
Example
The following request configures email notification settings for Veeam Backup for Microsoft Azure.
|