Updated on 2026-06-09 GMT+08:00

Checking the Imported Secret Strength

Function

This API is used to check the imported secrets. It is used only in the secret vault scenario.

Calling Method

For details, see Calling APIs.

Authorization Information

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

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

POST /v1/{project_id}/secrets/checker/check

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID. For details, see Obtaining a Project ID.

Constraints

N/A

Range

The value returned by the IAM API is used, which contains 32 characters.

Default Value

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token. It can be obtained by calling the IAM API. The value of X-Subject-Token in the response header is the user token. This parameter is optional if AK/SK authentication is used.

Constraints

N/A

Range

Obtain the value by calling the IAM API for obtaining the user token.

Default Value

N/A

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

type

Yes

String

Definition

Secret detection type

Constraints

N/A

Range

The value is fixed to 1.

Default Value

N/A

data

Yes

Object

Definition

Request data body corresponding to secret detection.

Constraints

N/A

Range

N/A

Default Value

N/A

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

type

String

Definition

Secret detection type

Range

N/A

data

Object

Definition

Response data body corresponding to secret detection

Range

N/A

Example Requests

{
  "data" : {
    "secret_type" : "COMMON-PV",
    "secret_string" : "{\"username\":\"root\",\"password\":\"1I@iiu@.\"}"
  },
  "type" : "1"
}

Example Responses

Status code: 200

Request succeeded.

{
  "type" : "1",
  "data" : {
    "secret_strength" : 1
  }
}

Status Codes

Status Code

Description

200

Request succeeded.

Error Codes

See Error Codes.