Help Center/ Document Database Service/ API Reference (Ally Region)/ APIs V3.0 (Recommended)/ DB Instance Management/ Checking for Weak Passwords
Updated on 2026-01-08 GMT+08:00
View PDF
Share

Checking for Weak Passwords

API Description

This API is used to check whether a password is a weak password.

URI

  • URI format
    POST https://{Endpoint}/v3/{project_id}/weak-password-verification
    Table 1 Path parameters

    Name

    Mandatory

    Type

    Description

    project_id

    Yes

    String

    Project ID of a tenant in a region. Obtain the project ID by following the instructions in Obtaining a Project ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token
Table 3 Request body parameters

Name

Mandatory

Type

Description

password

Yes

String

Password.
  • Request example 
    {
  "password" : "xxxx"
}

Response Parameters

Table 4 Response body parameters

Name

Type

Description

weak

Boolean

Whether the password is a weak password. The value can be true or false.
  • Example response 
    { 
  "weak" : false 
}

Status Code

For details, see Status Code.

Error Code

For details, see Error Code.

Parent topic: DB Instance Management