This is an archive version of the document. To get the most up-to-date information, see the current version.Validate Password Used for Encryption
You can verify the password used for encryption on an S3 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 theS3 repository in the Veeam Backup for AWS REST API.
HTTP Request
POST https://<hostname>:<port>/api/v1/repositories/{repositoryId}/checkPassword |
Request Headers
The request contains the following headers.
Header | Required/Optional | 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. |
x-api-version | Required | 1.0-rev0 | Specifies the current revision of the Veeam Backup for AWS REST API. |
Content-Type | Required | application/json | Identifies a media type that is used in the body of the request. |
Accept | Optional |
| Specifies a media type of representation that is required in the response message. If the requested type is not supported, the server will return the response in the application/json media type. |
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 Code
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 |
| Identifies the media type of the response body message. |
Response Body
In the response body, Veeam Backup for AWS returns the isSuccess parameter. The true value of the parameter signifies the password is correct. The false value signifies the password is incorrect.
Example
The following request verifies the password used for encryption on an S3 repository with the ID a7bcabe6-91f7-40ca-ad73-915d43a8e86b.
|