Creating a Sensitive Data Scanning Rule Group

Updated on 2023-12-07 GMT+08:00

View PDF

Function

This API is used to create a sensitive data scanning rule group using the specified rule group name and rule list.

URI

POST /v1/{project_id}/sdg/server/scan/groups

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
category	No	String	Rule type, which can be built-in rule (BUILT_IN) or self-built rule (BUILT_SELF). Enumeration values: BUILT_IN BUILT_SELF
default_status	No	Boolean	Whether it is a default rule group
group_desc	No	String	Rule group description
group_name	No	String	Rule group name
id	No	String	Rule group ID
rule_ids	No	Array of strings	IDs of rules in the group

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
msg	String	Returned message
status	String	Return status, for example, '200', '400'.

Status code: 400

**Table 4** Response body parameters
Parameter	Type	Description
error_code	String	Error Code
error_msg	String	Error Message

Example Requests

Create a self-built scanning rule group named xxxx.

POST /v1/{project_id}/sdg/server/scan/groups

{
  "category" : "BUILT_SELF",
  "group_desc" : "xxxx",
  "group_name" : "xxxx",
  "rule_ids" : [ "xxxxxxxxxxxxxxxxxxx", "xxxxxxxxxxxxxxxxxxx" ]
}

Example Responses

Status code: 200

Request sent

{
  "msg" : "xxxx",
  "status" : "RESPONSE_SUCCESS"
}

Status code: 400

Invalid request

{
  "error_code" : "dsc.40000011",
  "error_msg" : "Invalid parameter"
}

Status Codes

Status Code	Description
200	Request sent
400	Invalid request

Error Codes

See Error Codes.

Parent topic: Sensitive Data Discovery

Previous topic: Querying Sensitive Data Scanning Rule Groups

Next topic: Deleting a Sensitive Data Scanning Rule Group

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel