Resetting the admin Password of a CBH Instance

This API is used to reset the password of user admin, which is used for logging in to the CBH instance over a web client.

PUT /v2/{project_id}/cbs/instance/password

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID For details about how to obtain the project ID, see "Obtaining a Project ID".

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token. For details, see "Obtaining the Token of an IAM User."

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
new_password	Yes	String	The new password of user admin can contain 8 to 32 characters, including letters, digits, and special characters.
server_id	Yes	String	CBH instance ID, in UUID format. For details about how to obtain the value, see " Viewing CBH Instance Details" in Cloud Bastion Host User Guide.

Status code: 400

**Table 4** Response body parameters
Parameter	Type	Description
error_code	String	Error code
error_description	String	Incorrect request parameters.

Status code: 401

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Error code
error_description	String	Failed to verify the token.

Status code: 403

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code
error_description	String	Permissions required.

Status code: 404

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code
error_description	String	Not CBH instances found.

{
  "new_password" : "xxxxxxxxx",
  "server_id" : "6e22aced-xxxx-xxxx-xxxx-4796fbe9fc23"
}

None

Status Code	Description
200	Reset Instance Password Success
400	Bad Request
401	Unauthorized
403	Forbidden
404	Not Found

Parent topic: Operation Management

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.