Help Center/Host Security Service/API Reference/API Description/Baseline Management/Ignoring, Unignoring, Repairing, or Verifying the Failed Configuration Check Items
Updated on 2026-04-03 GMT+08:00
View PDF
Share

Ignoring, Unignoring, Repairing, or Verifying the Failed Configuration Check Items

Function

This API is used to ignore, unignore, repair, or verify the failed configuration check items.

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

PUT /v5/{project_id}/baseline/check-rule/action

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID, which is used to specify the project that an asset belongs to. After the project ID is configured, you can query assets in the project using the project ID. For details about how to obtain it, see Obtaining a Project ID.

Constraints

N/A

Range

The value can contain 1 to 256 characters.

Default Value

N/A

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

enterprise_project_id

No

String

Definition

Enterprise project ID, which is used to filter assets in different enterprise projects. For details, see Obtaining an Enterprise Project ID.

To query assets in all enterprise projects, set this parameter to all_granted_eps.

Constraints

You need to set this parameter only after the enterprise project function is enabled.

Range

The value can contain 1 to 256 characters.

Default Value

0: default enterprise project.

host_id

No

String

Definition

Server ID. If this parameter is not specified, all the servers of the user are queried.

Constraints

N/A

Range

The value contains 1 to 128 characters.

Default Value

N/A

check_cce

No

Boolean

Definition

Whether to verify CCE.

Constraints

N/A

Range

  • true: Tags will be synchronized.

  • false: Tags will not be synchronized.

Default Value

N/A

action

Yes

String

Definition

Operation type of a check item.

Constraints

N/A

Range

  • ignore: Ignore

  • unignore: Unignore

  • fix: Fix

  • verify: Verify

  • add_to_whitelist: Add to whitelist

Default Value

ignore

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token, which contains user identity and permissions. The token can be used for identity authentication when an API is called. For details about how to obtain the token, see Obtaining a User Token.

Constraints

N/A

Range

The value can contain 1 to 32,768 characters.

Default Value

N/A

Table 4 Request body parameters

Parameter

Mandatory

Type

Description

check_rules

No

Array of CheckRuleKeyInfoRequestInfo objects

Definition

Check item ID list

Constraints

N/A

Range

The number of elements ranges from 0 to 2,147,483,647.

Default Value

N/A

Table 5 CheckRuleKeyInfoRequestInfo

Parameter

Mandatory

Type

Description

check_name

No

String

Definition

Configuration check baseline name, for example, SSH, CentOS 7, or Windows.

Constraints

N/A

Range

The value can contain 0 to 256 characters.

Default Value

N/A

check_rule_id

No

String

Definition

Check item ID, which can be obtained from the return data of the API /v5/{project_id}/baseline/risk-config/{check_name}/check-rules.

Constraints

N/A

Range

The value can contain 0 to 64 characters.

Default Value

N/A

standard

No

String

Definition

Baseline standard

Constraints

N/A

Range

  • cn_standard: DJCP MLPS

  • hw_standard: cloud security practice

  • cis_standard: general security standard

Default Value

N/A

fix_values

No

Array of CheckRuleFixValuesInfo objects

Definition

User-entered repair parameters of check items

Constraints

N/A

Range

The number of elements ranges from 0 to 10,000.

Default Value

N/A

Table 6 CheckRuleFixValuesInfo

Parameter

Mandatory

Type

Description

rule_param_id

No

Integer

Definition

Parameter ID of the check item

Constraints

N/A

Range

The value is a string of 1 to 128 characters.

Default Value

N/A

fix_value

No

Integer

Definition

Parameter value for fixing a check item.

Constraints

N/A

Range

The value is a string of 0 to 512 characters.

Default Value

N/A

Response Parameters

Status code: 200

Request succeeded.

None

Example Requests

  • This API is used to ignore the configuration check items whose baseline name is SSH, check item ID is 1.11, check standard is cloud security practice standard, and enterprise project ID is xxx. This operation applies to all affected servers.

    PUT https://{endpoint}/v5/{project_id}/baseline/check-rule/action?enterprise_project_id=xxx&action=ignore

{
  "check_rules" : [ {
    "check_name" : "SSH",
    "check_rule_id" : "1.11",
    "standard" : "hw_standard"
  } ]
}

  • This API is used to restore the configuration check items whose baseline name is SSH, check item ID is 1.11, check standard is cloud security practice standard, and enterprise project ID is xxx. This operation applies only to the server whose ID is xxx. The restoration parameters are as follows: Set the value of the repair item whose ID is 1 to 5 and the value of the repair item whose ID is 2 to 20.

    PUT https://{endpoint}/v5/{project_id}/baseline/check-rule/action?enterprise_project_id=xxx&host_id=xxx&action=fix

{
  "check_rules" : [ {
    "check_name" : "SSH",
    "check_rule_id" : "1.11",
    "standard" : "hw_standard",
    "fix_values" : [ {
      "rule_param_id" : 1,
      "fix_value" : 5
    }, {
      "rule_param_id" : 2,
      "fix_value" : 20
    } ]
  } ]
}

Example Responses

None

Status Codes

Status Code

Description

200

Request succeeded.

Error Codes

See Error Codes.

Parent Topic: Baseline Management