Veeam Backup for Microsoft 365 8
REST API Reference
Related documents

Veeam Backup for Microsoft 365 Email Notification Settings

The /VBOEmailSettings resource collection represents email notification settings.

Email notifications are sent from a backup proxy server upon each execution of a backup or backup copy job.

NOTE
Email notification settings are global and will be applied to all backup and backup copy jobs in Veeam Backup for Microsoft 365.

Get Email Notification Settings

Returns a resource representation of Veeam Backup for Microsoft 365 email notification settings.

SecurityBearer
Responses
200

OK

default

Operation failure response.

get/v8/VboEmailSettings
Request samples 
Response samples 
application/json
{
  • "_links": {
    },
  • "_actions": {
    },
  • "notifyOnSuccess": true,
  • "notifyOnWarning": true,
  • "notifyOnFailure": true,
  • "supressUntilLastRetry": true,
  • "attachDetailedReport": true,
  • "enableNotification": true,
  • "smtpServer": "string",
  • "port": 0,
  • "useAuthentication": true,
  • "username": "string",
  • "useSSL": true,
  • "from": "string",
  • "to": "string",
  • "subject": "string",
  • "authenticationType": "CustomSmtp",
  • "clientId": "string",
  • "tenantId": "string",
  • "userId": "string",
  • "mailApiUrl": "string",
  • "isAuthenticated": true
}
Edit Email Notification Settings
Modifies email notification settings for Veeam Backup for Microsoft 365.


x-codegen-request-body-name:  emailSettingsRequest
SecurityBearer 
Request 
Request Body schema: application/json
required
userPassword
string <password>  (SecureString) 
Specifies a password.


 
notifyOnSuccess
boolean or null
Defines whether Veeam Backup for Microsoft 365 will send email notifications if a backup or backup copy job completes successfully without any warnings or errors.


 
notifyOnWarning
boolean or null
Defines whether Veeam Backup for Microsoft 365 will send email notifications if a backup or backup copy job completes with warnings.


 
notifyOnFailure
boolean or null
Defines whether Veeam Backup for Microsoft 365 will send email notifications if a backup or backup copy completes with errors.


 
supressUntilLastRetry
boolean or null
Defines whether Veeam Backup for Microsoft 365 will send email notifications according to the job schedule options. The following email notification scenarios are available: 
     
  • If a job fails, Veeam Backup for Microsoft 365 will send a notification message on the last job retry.
    •  
  • If the job completes with Success or Warning, Veeam Backup for Microsoft 365 will send a notification message on the last completion status.
    •  
  • If the job is scheduled to Terminate the job if it exceeds allowed backup window, Veeam Backup for Microsoft 365 will send a notification message on the last attempt within the configured interval.
    •  


 
attachDetailedReport
boolean or null
Defines whether a detailed report about the job results will be included as an email attachment.


 
enableNotification
boolean or null
Defines whether Veeam Backup for Microsoft 365 will send email notifications.


 
smtpServer
string
Specifies the full DNS name or IP address of the SMTP server for sending email notifications.


 
port
integer or null <int32> 
Specifies the port used for connection to the SMTP server.


 
useAuthentication
boolean or null
Defines whether the SMTP server requires authentication.


 
username
string
Specifies the user name of the account used for authentication to the SMTP server.


 
useSSL
boolean or null
Defines whether Veeam Backup for Microsoft 365 uses a secure connection to send email notifications.


 
from
string
Specifies email address of the notification sender.


 
to
string
Specifies email address of the notification recipient. For listing multiple recipients, use semicolon as a separator.


 
subject
string
Specifies the subject for email notifications. The subject of an email notification displays information according to the following variables: 
     
  • %JobName% - name of a backup or backup copy job.
    •  
  • %JobResult% - a job result.
    •  
  • %OrgName% - organization whose data was processed by a backup or backup copy job.
    •  
  • %MailboxCount% - total number of processed objects.
    •  
  • %Issues% - number of objects that were processed with the Failed or Warning status.
    •  
  • %Time% - date and time of a job completion.
    •  


 
authenticationType
string (RESTAuthenticationType) 
Specifies authentication method that Veeam Backup for Microsoft 365 and Veeam Explorers use to send emails.


 Enum: "CustomSmtp" "GoogleGmail" "Microsoft365"  
userId
string
Specifies an authenticated user account ID. Veeam Backup for Microsoft 365 will send email notifications on behalf of this user.


 
mailApiUrl
string or null
Specifies the Microsoft Graph endpoint for sending emails.


 
requestId
string or null
Specifies an authentication request ID.


 
Responses 
204
No Content


default
Operation failure response.


put/v8/VboEmailSettings
Request samples 
application/json
{
  • "userPassword": "pa$$word",
  • "notifyOnSuccess": true,
  • "notifyOnWarning": true,
  • "notifyOnFailure": true,
  • "supressUntilLastRetry": true,
  • "attachDetailedReport": true,
  • "enableNotification": true,
  • "smtpServer": "string",
  • "port": 0,
  • "useAuthentication": true,
  • "username": "string",
  • "useSSL": true,
  • "from": "string",
  • "to": "string",
  • "subject": "string",
  • "authenticationType": "CustomSmtp",
  • "userId": "string",
  • "mailApiUrl": "string",
  • "requestId": "string"
}
Response samples 
application/json
{
  • "message": "string",
  • "errorCode": "ProxyOffline",
  • "stackTrace": "string"
}
Prepare to Authentication Request
Prepares to create authentication request that allows you to acquire an access token. Veeam Backup for Microsoft 365 will send email notifications on behalf of either a Microsoft 365 account or a Google account.


SecurityBearer 
Request 
Request Body schema: application/json
required
authenticationServiceKind
string (RESTOAuth2ServiceKind) 
Specifies account that you want to use to acquire an access token from Google or Microsoft Identity platform.


 Enum: "GoogleGmail" "Microsoft365"  
clientId
string or null
Specifies a client ID obtained while registering an application in the Google Cloud console or Microsoft Identity platform.


 
clientSecret
string <password>  (SecureString) 
Specifies a password.


 
tenantId
string or null
Specifies a tenant ID in Microsoft Entra ID.


 
redirectUrl
string
Specifies URL to which you will be redirected after signing in to Google or Microsoft Identity platform to get the code and state properties required to complete authentication. For more information, see Complete Authentication.


 
Responses 
200
OK


default
Operation failure response.


post/v8/VboEmailSettings/PrepareOAuthSignIn
Request samples 
application/json
{
  • "authenticationServiceKind": "GoogleGmail",
  • "clientId": "string",
  • "clientSecret": "pa$$word",
  • "tenantId": "string",
  • "redirectUrl": "string"
}
Response samples 
application/json
{
  • "requestId": "string",
  • "signInUrl": "string"
}
Complete Authentication
Completes authentication to Google or Microsoft Identity platform that allows Veeam Backup for Microsoft 365 to send email notifications on behalf of either a Microsoft 365 account or a Google account.


SecurityBearer 
Request 
Request Body schema: application/json
required
code
string
Specifies value that you get from the Google Authorization Server or Microsoft Identity platform in the redirect URL. Veeam Backup for Microsoft 365 and Veeam Explorers will use this value to obtain an access token.


 
state
string
Specifies value that you get from the Google Authorization Server or Microsoft Identity platform in the redirect URL. Veeam Backup for Microsoft 365 and Veeam Explorers will use this value to check that the code property value matches the authentication request.


 
Responses 
200
OK


default
Operation failure response.


post/v8/VboEmailSettings/CompleteOAuthSignIn
Request samples 
application/json
{
  • "code": "string",
  • "state": "string"
}
Response samples 
application/json
{
  • "requestId": "string",
  • "userId": "string"
}
Send Test Message
Sends a test message to the specified recipient.


SecurityBearer 
Responses 
204
No Content


default
Operation failure response.


post/v8/VboEmailSettings/SendTestEmail
Request samples 
Response samples 
application/json
{
  • "message": "string",
  • "errorCode": "ProxyOffline",
  • "stackTrace": "string"
}

    
    

                                

                                    
Document updated 12/18/2025
Page content applies to build 8.3.0.2201