Veeam Plug-in for Nutanix AHV 7 [Archived]
REST API Reference
Related documents

SMTP Account

The /emailSettings resource collection represents settings of an SMTP account used to send email notifications.

Get Email Notification Settings

The HTTP GET request to the /emailSettings endpoint retrieves email notification settings configured in Veeam Backup for Nutanix AHV.

SecurityBearer
Responses
200

OK

400

Bad Request. The request body is malformed, incomplete or otherwise invalid.

401

Unauthorized. The authorization header has been expected but not found (or found but is expired).

403

Forbidden. The user sending a request does not have adequate privileges to access one or more objects specified in the request

500

Internal Server Error. The request has been received but could not be completed because of an internal error at the server side.

get/api/v7/emailSettings
Request samples 
Response samples 
application/json
{
  • "enabled": true,
  • "notificationOptions": [
    ],
  • "messageSettings": {
    },
  • "smtpServerSettingsId": "cbb96c51-35d5-4bb7-94a5-cb7e5065516c"
}
Modify Email Notification Settings
The HTTP PUT request to the /emailSettings endpoint configures Veeam Backup for Nutanix AHV to send email notifications.


SecurityBearer 
Request 
Request Body schema: application/json
required
Email settings


enabled
required
boolean
Defines whether email notifications are enabled. Default value is false.


 
notificationOptions
required
Array of strings (EmailNotificationOption) 
Specifies notification settings for jobs.


Items Enum: "None" "NotifyOnSuccess" "NotifyOnWarning" "NotifyOnFailure" "SuppressNotificationsUntilLastRetry"  
required
object (EmailNotificationMessageSettings) 
Email parameters.


 
smtpServerSettingsId
required
string <uuid> 
ID assigned to a collection of the SMTP account settings in Veeam Backup for Nutanix AHV.


 
Responses 
204
No Content


400
Bad Request. The request body is malformed, incomplete or otherwise invalid.


401
Unauthorized. The authorization header has been expected but not found (or found but is expired).


403
Forbidden. The user sending a request does not have adequate privileges to access one or more objects specified in the request


500
Internal Server Error. The request has been received but could not be completed because of an internal error at the server side.


put/api/v7/emailSettings
Request samples 
application/json
{
  • "enabled": true,
  • "notificationOptions": [
    ],
  • "messageSettings": {
    },
  • "smtpServerSettingsId": "cbb96c51-35d5-4bb7-94a5-cb7e5065516c"
}
Response samples 
application/problem+json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "extensions": {
    }
}
Get SMTP Account Settings
The HTTP GET request to the emailSettings/smtp/{id}/settings endpoint retrieves information on an SMTP account with the specified ID.


SecurityBearer 
Request 
path Parameters
id
required
string <uuid> 
System ID assigned to an SMTP account in Veeam Backup for Nutanix AHV.


 
Responses 
200
OK


400
Bad Request. The request body is malformed, incomplete or otherwise invalid.


401
Unauthorized. The authorization header has been expected but not found (or found but is expired).


403
Forbidden. The user sending a request does not have adequate privileges to access one or more objects specified in the request


500
Internal Server Error. The request has been received but could not be completed because of an internal error at the server side.


get/api/v7/emailSettings/smtp/{id}/settings
Request samples 
Response samples 
application/json
{
  • "serverType": "Unknown",
  • "serverId": "10d2345a-e43d-463d-830e-4f5b19b60d41",
  • "smtp": {
    }
}
Configure SMTP Account Settings
The HTTP POST request to the emailSettings/smtp/basic endpoint configures or updates the SMTP account settings.


SecurityBearer 
Request 
Request Body schema: application/json
required
SMTP account settings.


address
required
string
DNS name or an IP address of the SMTP server.


 
port
integer <int32>   [ 0 .. 65535 ] 
 Default:  25
Port number used by the SMTP server. Default value is 25.


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


 
certificateThumbprint
string or null
Hexadecimal string that uniquely identifies a certificate used on the SMTP server.


 
authenticationRequired
boolean
Defines whether to use a specific account to connect to the SMTP server. Default value is false.


 
username
string or null
Specifies user name used to access the account on the SMTP server.


 
password
write-only
string or null <password> 
Password used to access the account on the SMTP server.


 
Responses 
201
Created


400
Bad Request. The request body is malformed, incomplete or otherwise invalid.


401
Unauthorized. The authorization header has been expected but not found (or found but is expired).


403
Forbidden. The user sending a request does not have adequate privileges to access one or more objects specified in the request


500
Internal Server Error. The request has been received but could not be completed because of an internal error at the server side.


post/api/v7/emailSettings/smtp/basic
Request samples 
application/json
{
  • "address": "string",
  • "port": 25,
  • "useSsl": true,
  • "certificateThumbprint": "string",
  • "authenticationRequired": true,
  • "username": "string",
  • "password": "pa$$word"
}
Response samples 
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

    
    

                                

                                    
Document updated 9/03/2025
Page content applies to build 12.7.1.12