Configure Email Notification Settings
You can configure Veeam Backup for Microsoft Azure to send email notifications.
Request
To configure email notifications settings, send the HTTP POST request to the /settings/emailNotifications endpoint.
HTTP Request
PUT 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. |
Request Body
To configure email notification settings 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:
Note |
Before you configure email notifications, you can send a test email to check the settings. For more information, see Send Test Message. |
Set the parameter values in the following format:
{ "smtpSettings": { "accountId": "string", "host": "string", "port": 0, "useSecureConnection": true, "timeOutMiliSeconds": 0 }, "notificationsEnabled": true, "from": "string", "to": "string", "subject": "string", "dailyReportSettings": { "sendDailyReport": true, "dailyTime": "string" }, "emailNotificationSettings": { "notifyOnSuccess": true, "notifyOnWarning": true, "notifyOnFailure": true } } |
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 |
| Identifies the media type of the response body message. |
Response Body
In the response body, Veeam Backup for Microsoft Azure returns new email notification settings. The EmailNotificationSettingsV2 schema is used for the collection representation.
Example
The following request configures email notification settings for Veeam Backup for Microsoft Azure.
|