Sending Test Message

Sending a test message to the specified recipient.

Request

POST https://<hostname>:4443/v4/VBOEmailSettings/Action

Request Headers

The request header must contain an authorization token of the current session.

Request Body

To send a test message, the request body must contain the following line:

{

 "sendTest": null

}

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 HTTPS headers.

Header

Description

Content-length

The length of the response body.

Content-type

The media type and syntax of the response body message: application/json; charset=utf-8

Response Body

None.

Example

The example below shows how to send a test message to the email specified in VBOEmailSettings.

Request:

POST https://abc.tech.local:4443/v4/VBOEmailSettings/Action

Request Header:

Authorization: Bearer <Access-Token>

 

Request Body:

{

 "sendTest": null

}

 

Response:

200 OK

I want to report a typo

There is a misspelling right here:

 

I want to let the Veeam Documentation Team know about that.