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

Adding Account

This section explains how to add an SMTP account.

Request

POST https://<hostname>/api/v1/accounts/standard

Request Headers

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

Request Parameters

None.

Request Body

Property

Type

Description

name

string

Sets the name under which to add a new account.

description

string

Sets the description that must be added to the account record.

username

string

Sets the name of the user  

password

string

Sets the password for the new account.

Request Example

Request:

POST https://<hostname>/api/v1/accounts/standard

 

Request Header:

Authorization: Bearer <Access-Token>

 

Request Body:

{

 "name": "Authentication",

 "description": "Auxiliary account",

 "username": "Administrator",

 "password": "ZbQIZIjVkEfLBE0y-"

}

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

The response contains the following information.

Property

Type

Description

id

string

Shows the identification number of the account record.

name

string

Shows the name of the account.

description

string

Shows the description.

_links

Dictionary of string [key] and Object [value]

Links to related resources (navigation property).

Response Example

Response:

200 OK

 

Response Body:

{

  "id": 1001,

  "name": "Authentication",

  "description": "Auxiliary account",

  "_links": {"self": {"href": "https://abc.ukwest.cloudapp.azure.com/api/v1/users/1001"}}

}

I want to report a typo

There is a misspelling right here:

 

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