This is an archive version of the document. To get the most up-to-date information, see the current version.

(POST) /VESPEmailSettings/Action

In this article

    Sends a test message to a specified email.

    Request

    To send a test message, send the POST HTTPS request to the URL of the /VESPEmailSettings/Action resource.

    HTTPS Request

    POST https://<Backup-Office365>:4443/v3/VESPEmailSettings/Action

    Request Headers

    The request header must contain the authorization token for the current logon session.

    Request Body

    To send a test message, the request body must contain the sendTest action properties:

    Property

    Type

    Description

    Email

    string

    Specifies the email you want to send the test message to.

    For example, "email": "jsmith@westsupport.onmicrosoft.com".

    Response

    The server returns the following response to the client.

    Response Codes

    A successfully completed operation returns 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 request body message: application/json; charset=utf-8

    Response Body

    None.

    Example

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

    Request:

    POST https://support.east.local:4443/v3/VESPEmailSettings/Action

    Request Header:

    Authorization: Bearer <Access-Token>

     

    Request Body:

    {

     "sendTest": { "Email": email@gmail.com }

    }

     

    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.