Help Center/ Bare Metal Server/ API Reference/ BMS APIs/ BMS Password Management/ Querying Whether One-Click Password Reset Is Supported
Updated on 2025-12-09 GMT+08:00
View PDF
Share

Querying Whether One-Click Password Reset Is Supported

Function

This API is used to query whether a BMS supports one-click password reset.

Debugging

You can debug this API in API Explorer.

Authorization Information

Each account has all of the permissions required to call all APIs, but IAM users must have the required permissions specifically assigned.

  • If you are using role/policy-based authorization, see the required permissions in Permissions and Supported Actions.
  • If you are using identity policy-based authorization, the permission listed below is required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    bms:servers:showResetPasswordFlag

    read

    instance*

    • g:EnterpriseProjectId

    • g:ResourceTag/<tag-key>

    bms:servers:get

    -

URI

GET /v1/{project_id}/baremetalservers/{server_id}/os-resetpwd-flag

Table 1 lists the parameters.

Table 1 Parameter description

Parameter

Mandatory

Description

project_id

Yes

Specifies the project ID.

For details about how to obtain the project ID, see Obtaining a Project ID.

server_id

Yes

Specifies the BMS ID.

You can obtain the BMS ID from the BMS console or by calling the API Querying BMSs (Deprecated).

Request Parameters

None

Example Request

Querying whether a BMS (ID: cf2a8b97-b5c6-47ef-9714-eb27adf26e5b) supports one-click password reset 
1
 
GET https://{BMS Endpoint}/v1/bbf1946d374b44a0a2a95533562ba954/baremetalservers/cf2a8b97-b5c6-47ef-9714-eb27adf26e5b/os-resetpwd-flag

Response Parameters

Parameter

Type

Description

resetpwd_flag

String

Specifies whether one-click password reset is supported.

  • True: One-click password reset is supported.
  • False: One-click password reset is not supported.

Example Response

1
2
3
 
{
    "resetpwd_flag": "False"
}

Returned Values

Normal values

Returned Values

Description

200

The request has been successfully processed.

For details about other returned values, see Status Codes.

Error Codes

See Error Codes.

Parent topic: BMS Password Management