This is an archive version of the document. To get the most up-to-date information, see the current version.Send Test Message
You can check the email notification settings you want to use for Veeam Backup for AWS.
Request
To send a test email, send the HTTP POST request to the /settings/emailNotifications/sendTestMessage endpoint.
HTTP Request
POST https://<hostname>:<port>/api/v1/settings/emailNotifications/sendTestMessage |
Request Headers
The request contains the following headers.
Header | Required/Optional | 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. |
x-api-version | Required | 1.0-rev0 | Specifies the current revision of the Veeam Backup for AWS REST API. |
Content-Type | Required | application/json | Identifies a media type that is used in the body of the request. |
Accept | Optional |
| Specifies a media type of representation that is required in the response message. If the requested type is not supported, the server will return the response in the application/json media type. |
Request Body
To send a test message use the EmailNotifications schema to send parameters in the request body. If you do not send a parameter, Veeam Backup for AWS sets the default parameter value. The following parameters are required:
Parameter | Type | Description |
|---|---|---|
enabled | boolean | Defines whether to enable email notifications. |
server | string | Specifies a DNS name or an IP address of the SMTP server. |
port | integer | Specifies a port number used by the SMTP server. |
from | string | Specifies an email address from which email notifications must be sent. |
to | string | Specifies the recipient email addresses. |
subject | string | Specifies the subject for the sent message. |
Set the parameter values in the following format:
{ "enabled": true/false, "server": "string", "port": "integer", "useSsl": true/false, "timeout": "integer", "useCredentials": true/false, "credentialsId": "string", "from": "string", "to": "string", "subject": "string", "onSuccess": true/false, "onWarning": true/false, "onFailure": true/false, "enableScheduledNotification": true/false, "notifyTime": "YYYY-MM-DDT00:00:00" } |
Response
The server returns the following response to the client.
Response Code
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 |
| Identifies the media type of the response body message. |
Response Body
In the response body, Veeam Backup for AWS returns the success parameter set to true and a test message in case of successfully sent email or the success parameter set to false in case of failure.
Example
The following request configures email notification settings for Veeam Backup for AWS.
|