[{"label":"Latest (2.0.0)","version":"latest"},{"version":"1.0.0"}]
vrms-appliance-config-api

Update Appliance Password

Description

Update the appliance password.

Request

Request

URL

URL


post
https://{api_host}//appliance/settings/access/password
Copy

Request Body

Request Body

UpdatePasswordSpec of mimetype application/json Optional

The appliance password to be updated.

{
	"new_password": "string",
	"password": "string",
	"username": "string"
}
string as ^(?=.*[a-z])(?=.*[A-Z])(?=.*[0-9])(?=.*[ !\"#$%&'()*+,-.\\/\\\\:;<=>?@[\\]^_`{|}~\"])[a-zA-Z0-9 !\"#$%&'()*+,-.\\/\\\\:;<=>?@[\\]^_`{|}~\"]{8,}$
new_password Required

New password for the appliance user.

    Requirements:
  • at least 8 characters long
  • with minimum one small letter
  • with minimum one capital letter
  • with minimum one number
  • with minimum one special character
  • differs from the last five passwords


string
password Required

Current password for appliance user.


string
username Required

Appliance username.
The user for which the password will be changed.
For now this parameter is not taken into account.

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

204 No Content

Appliance password was updated.

Errors

Errors

ResponseError
400

Bad request - the server could not understand the request due to invalid syntax or invalid request body content


401

Unauthorized - the client must authenticate itself to get the requested response


ResponseError
403

Forbidden - not sufficient access rights to fulfill the request


ResponseError
500

Internal server error - unexpected condition prevents fulfilling the request

Code Samples

Code Samples

cURL Command

curl -X POST -H "Content-Type: application/json" -d '{"new_password":"string","password":"string","username":"string"}' https://{api_host}/appliance/settings/access/password


[{"label":"Latest (2.0.0)","version":"latest"},{"version":"1.0.0"}]
vrms-appliance-config-api
Feedback

Was this page helpful?