Help Center/ SecMaster/ API Reference/ Security Analysis V2 APIs/ Baseline Inspection/ Querying the Check Item List
Updated on 2025-10-29 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying the Check Item List

Function

This API is used to query the check item list.

Calling Method

For details, see Calling APIs.

URI

POST /v2/{project_id}/workspaces/{workspace_id}/sa/baseline/checkitems/search

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID, which is used to specify the project that a resource belongs to. You can query the resources of a project by project ID. You can obtain the project ID from the API or console. Obtaining the Project ID

Constraints

N/A

Range

N/A

Default Value

N/A

workspace_id

Yes

String

Definition

Workspace ID.

Constraints

N/A

Range

N/A

Default Value

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token. You can obtain it by calling the IAM API for obtaining a user token. The user token is the value of X-Subject-Token in the response header. Obtaining a User Token

Constraints

N/A

Range

N/A

Default Value

N/A

content-type

Yes

String

Definition

Content type.

  • application/json;charset=UTF-8: common API request type

Constraints

N/A

Range

  • application/json;charset=UTF-8

Default Value

N/A

X-Language

Yes

String

Definition

Language. Reference value: zh-cn or en-us.

Constraints

N/A

Range

zh-cn: Chinese environment

en-us: English environment

Default Value

N/A
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

limit

Yes

Integer

Page size.

offset

Yes

Integer

Offset. The records after this offset will be queried.

sort_by

No

String

Sorting keyword.

order

No

String

"DESC": Descending order; ESC: Ascending order.

name

No

String

Filter by check item name.

description

No

String

Filter by check item description.

type

No

Integer

Filter by check item type. 0: built-in; 1: custom

source_list

No

Array of integers

Filter by check item execution method. 0: Kotlin; 2: playbook workflow; 3: manual; 4: host access

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

limit

Integer

Page size.

offset

Integer

Offset. The records after this offset will be queried.

sort_by

String

Sorting keyword.

order

String

"DESC": Descending order; ESC: Ascending order.

name

String

Filter by check item name.

description

String

Filter by check item description.

type

Integer

Filter by check item type. 0: built-in; 1: custom

source_list

Array of integers

Filter by check item execution method. 0: Kotlin; 2: playbook workflow; 3: manual; 4: host access

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

code

String

Definition

Error code.

Range

N/A

message

String

Definition

Error description.

Range

N/A

Status code: 401

Table 6 Response body parameters

Parameter

Type

Description

code

String

Definition

Error code.

Range

N/A

message

String

Definition

Error description.

Range

N/A

Status code: 500

Table 7 Response body parameters

Parameter

Type

Description

code

String

Definition

Error code.

Range

N/A

message

String

Definition

Error description.

Range

N/A

Example Requests

Query built-in check items with pagination (first page, 10 data records per page).

{
  "limit" : 10,
  "offset" : 0,
  "type" : 0
}

Example Responses

Status code: 400

Request failed.

{
  "error_code" : "SecMaster.00040006",
  "error_msg" : "Invalid request parameters"
}

Status code: 401

Insufficient permission.

{
  "error_code" : "SecMaster.90010015",
  "error_msg" : "Unauthorized request"
}

Status code: 500

Request failed.

{
  "error_code" : "SecMaster.00040011",
  "error_msg" : "Internal system error"
}

Status Codes

Status Code

Description

200

Request succeeded.

400

Request failed.

401

Insufficient permission.

500

Request failed.

Error Codes

See Error Codes.

Parent topic: Baseline Inspection