Veeam Backup for Microsoft 365 8
REST API Reference
Related documents

Veeam Explorer for Microsoft Exchange Email Settings

The /VexEmailSettings resource collection represents Veeam Explorer for Microsoft Exchange email settings.

Veeam Explorer for Microsoft Exchange uses these settings to send Exchange items that are located in a backup by email and deliver export reports.

Get Email Settings

Returns a resource representation of Veeam Explorer for Microsoft Exchange email settings.

SecurityBearer
Responses
200

OK

default

Operation failure response.

get/v8/VexEmailSettings
Request samples 
Response samples 
application/json
{
  • "username": "string",
  • "enableNotification": true,
  • "server": "string",
  • "port": 0,
  • "from": "string",
  • "useAuthentication": true,
  • "useSSL": true,
  • "authenticationType": "CustomSmtp",
  • "clientId": "string",
  • "tenantId": "string",
  • "userId": "string",
  • "mailApiUrl": "string",
  • "isAuthenticated": true,
  • "_links": {
    },
  • "_actions": {
    }
}
Edit Email Settings
Modifies email settings for Veeam Explorer for Microsoft Exchange.


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


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


 
enableNotification
boolean or null
Defines whether Veeam Explorer will send email messages.


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


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


 
from
string
Specifies email address of the notification sender.


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


 
useSSL
boolean or null
Defines whether Veeam Explorer uses a secure connection to send email messages.


 
userId
string or null
Specifies an authenticated user account ID. Veeam Explorer will send email messages 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.


 
object (RESTLinkHALDictionary) 
Related resources.


 
Responses 
204
No Content


default
Operation failure response.


put/v8/VexEmailSettings
Request samples 
application/json
{
  • "userPassword": "pa$$word",
  • "username": "string",
  • "enableNotification": true,
  • "server": "string",
  • "port": 0,
  • "from": "string",
  • "useAuthentication": true,
  • "useSSL": true,
  • "userId": "string",
  • "mailApiUrl": "string",
  • "requestId": "string",
  • "_links": {
    }
}
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 Explorer for Microsoft Exchange will send email messages 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/VexEmailSettings/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 Explorer for Microsoft Exchange to send email messages 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/VexEmailSettings/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.


x-codegen-request-body-name:  jsonOptions
SecurityBearer 
Request 
Request Body schema: application/json
required
email
string
Specifies the email address to which a test email message will be sent.


 
Responses 
204
No Content


default
Operation failure response.


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

    
    

                                

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