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

Validating Description

This section explains how to check if the description that you want to use satisfies Veeam Backup for Microsoft Azure validation criteria.

Request

POST https://<hostname>/api/v1/users/validateDescription

Request Headers

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

Request Parameters

None.

Request Body

Property

Type

Description

description

string

Sets the description to be validated.

Request Example

Request:

POST https://<hostname>/api/v1/users/validateDescription

 

Request Header:

Authorization: Bearer <Access-Token>

 

Request Body:

{

 "description": "auxiliaryaccount"

}

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 Example

None.

I want to report a typo

There is a misspelling right here:

 

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