Validate Password Used for Encryption

You can verify the password used for encryption on a repository with the specified ID.

Request

To check the password, send the HTTP POST request to the /repositories/{repositoryId}/checkPassword endpoint.{repositoryId} is a system ID assigned to the repository in the Veeam Backup for Microsoft Azure REST API.

HTTP Request

POST https://<hostname>/api/v2/repositories/{repositoryId}/checkPassword

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 check the password, send the password parameter in the request body.

Parameter

Type

Description

password

string

Specifies the password you want to verify.

Set the parameter value in the following format:

{

 "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 the isSuccess parameter. The true value of the parameter signifies the password is correct. The false value signifies the password is incorrect.

Validate Password Used for EncryptionExample

The following request verifies the password used for encryption on an  repository with the ID a7bcabe6-91f7-40ca-ad73-915d43a8e86b.

Request:

POST https://51.11.247.127/api/v2/repositories/a7bcabe6-91f7-40ca-ad73-915d43a8e86b/checkPassword

Request Header:

Authorization: Bearer <Access-Token>

Content-Type: application/json

 

Request Body:

{

 "password": "Passwrd123"

}

 

Response:

200

 

Response Body:

{

 true

}

I want to report a typo

There is a misspelling right here:

 

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