Help Center/ SecMaster/ API Reference/ SecMaster APIs (Excluding APIs for Security Analysis V2)/ Classifications & Mappings/ Creating a Preprocessing Rule
Updated on 2025-11-14 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Creating a Preprocessing Rule

Function

This API is used to create a preprocessing rule.

Calling Method

For details, see Calling APIs.

URI

POST /v1/{project_id}/workspaces/{workspace_id}/soc/mappings/preprocess-rules

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.

Range

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

Parameter

Mandatory

Type

Description

project_id

No

String

The id, display only

workspace_id

No

String

The id, display only

mapping_id

Yes

String

The id, display only

preprocess_rules

No

Array of preprocess_rules objects

Preprocessing rule list.
Table 4 preprocess_rules

Parameter

Mandatory

Type

Description

name

No

String

The name, display only

mapper_id

No

String

The id, display only

mapper_type_id

No

String

The id, display only

action

No

String

Preprocessing option: drop.

expression

No

String

Expression.

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

code

String

Definition

Error code.

Range

N/A

message

String

Definition

Error description.

Range

N/A

data

data object

Data.
Table 6 data

Parameter

Type

Description

project_id

String

The id, display only

workspace_id

String

The id, display only

mapping_id

String

The id, display only

preprocess_rules

Array of preprocess_rules objects

Preprocessing rule list.
Table 7 preprocess_rules

Parameter

Type

Description

id

String

The id, display only

name

String

The name, display only

mapper_id

String

The id, display only

mapper_type_id

String

The id, display only

action

String

Preprocessing option: drop.

expression

String

Expression.

Status code: 400

Table 8 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 to the request for creating a preprocessing rule.

400

Returned packet for abnormal requests.

Error Codes

See Error Codes.

Parent Topic: Classifications & Mappings