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

Updating a Check Item

Function

This API is used to update a check item.

Calling Method

For details, see Calling APIs.

URI

PUT /v2/{project_id}/workspaces/{workspace_id}/sa/baseline/checkitems/{checkitem_id}

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

checkitem_id

Yes

String

Check item UUID.

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
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

cloud_server

Yes

String

Cloud service to which the check item belongs.

description

Yes

String

Check item description.

level

Yes

String

Check item severity.

informational: informational

low: low risk

medium: medium risk

high: high risk

fatal: fatal

method

Yes

Integer

Check method of the check item.

0: automatic

3: playbook workflows.

name

Yes

String

Check item name.

source

No

Integer

Source of the check item.

0: default

2: workflows and playbooks

workflow_id

No

String

Definition

Workflow ID.

Constraints

N/A

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

code

String

Error code.

message

String

Error message.

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

Example Requests

None

Example Responses

None

Status Codes

Status Code

Description

200

Response body for updating a check item.

400

Error response body for updating a check item.

Error Codes

See Error Codes.

Parent topic: Baseline Inspection