Modify SMTP Account

You can update an SMTP account with the specified ID in the Veeam Backup for Microsoft Azure configuration database.

Request

To change data for a specific SMTP account, send the HTTP PUT request to the /accounts/standard/{id} endpoint. {id} is a system ID assigned to the SMTP account in the Veeam Backup for Microsoft Azure REST API.

HTTP Request

PUT https://<hostname>/api/v2/accounts/standard/{id}

Request Headers

The request contains the following headers.

Header

Required

Value

Description

Authorization

Required

Bearer <Access-Token>

Authenticates a client who sends the request to the server. Must contain the access token for the current logon session in the Bearer <Access-Token> format.

Request Body

To specify data to be changed for the SMTP account, send the following parameters in the request body.

Parameter

Type

Description

name

string

Specifies an SMTP account name in Veeam Backup for Microsoft Azure.

description

string

Specifies an SMTP account description.

Note: If you do not send the description parameter in the request body, the value is set to null by default.

username

string

Specifies a username.

password

string

Specifies a password for the SMTP account.

Set the parameter values in the following format:

{

 "name": "string",

 "description": "string",

 "username": "string",

 "password": "string"

}

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

Header

Value

Description

Content-length

integer

Identifies the length of the response body message, in bytes.

Content-type

  • application/json
  • application/problem+json

Identifies the media type of the response body message.

Response Body

In the response body, Veeam Backup for Microsoft Azure returns an updated representation of the SMTP account. The StandardAccountV2 schema is used for the resource representation.

Modify SMTP AccountExample

The following request modifies the name and description of an SMTP account with the ID 2.

Request:

PUT https://51.11.247.127/api/v2/accounts/standard/2

 

Request Header:

Authorization: Bearer <Access-Token>

Content-Type: application/json

 

Request Body:

{

 "name": "default smtp account",

 "description": "added description",

 "username": "Admin",

 "password": "West9112#"

}

 

Response:

200

 

Response Body:

{

 "id": "2",

 "name": "default smtp account",

 "description": "added description",

 "username": "Admin"

}

I want to report a typo

There is a misspelling right here:

 

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