This is an archive version of the document. To get the most up-to-date information, see the current version.Validate Password
You can check whether a password you plan to specify for a new user meets the Veeam Backup for AWS requirements.
Note |
To meet the security level required in Veeam Backup for AWS, password must be at least 8 characters long and contain uppercase, lowercase letters and numeric characters. Do not use monotonic sequences in the password. |
Request
To validate a password, send the HTTP POST request to the /users/validatePassword endpoint.
HTTP Request
POST https://<hostname>:<port>/api/v1/users/validatePassword |
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 whether the password meets the requirements, send the following parameter in the request body.
Parameter | Type | Description |
|---|---|---|
password | string | Specifies a password. |
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
If the password is valid, Veeam Backup for AWS does not return a response body, in other cases Veeam Backup for AWS returns the severity level and the error message.
Example
The following request checks whether Administrator1 meets the Veeam Backup for AWS requirements for a password.
|