tencent cloud

APIs

DocumentationAPIsCloud Security CenterAI-SPM APIsModifySandboxDLPRule

ModifySandboxDLPRule

Download
Focus Mode
Font Size
Last updated: 2026-09-01 10:04:55

1. API Description

Domain name for API request: csip.intl.tencentcloudapi.com.

Modify an existing DLP user rule. Fields not passed retain their original values, and partial field update is supported. BelongAssetType cannot be modified.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: ModifySandboxDLPRule.
Version Yes String Common Params. The value used for this API: 2022-11-21.
Region No String Common Params. This parameter is not required.
ID Yes Integer

Rule ID.
RuleName No String

Rule name
Input limit: length 1-128
Default value: no modification if not passed
Level No String

Rule level
Enumeration values:
INFO: notification
LOW: low risk
MEDIUM: medium risk
HIGH: high risk
CRITICAL: critical
Default value: no modification if not passed in
RuleAction No String

Rule action
Enumeration values:
PASS: blocklist
BLOCK: block and alarm
MONITOR: alarm
Default value: no modification if not passed in
SystemRuleIDList.N No Array of Integer

Referenced system rule ID list
Input parameter limit: up to 1000; when passed, overwrites the original collection entirely; if not passed, means no modification
UserRuleContent.N No Array of TrafficSandboxDLPRuleContentItem

User-defined rule content
Input parameter limits: when passed in, the entire collection is overwritten (passing an empty array is allowed to clear it); if not passed, no modification is made
UserRuleInfo No TrafficSandboxDLPUserRuleInfo

Structured input parameters support 5 detection dimensions (file name/file size/file format/outbound domain name/outbound content). Each dimension is selectable, and at least one must be hit. When passed in, it overwrites the original collection as a whole; if not passed, no modification is made. It will override when passed in at the same time as UserRuleContent
EffectScope No TrafficSandboxEffectScope

Effective scope
Default value: no modification if not passed
Status No String

Target status
Enumeration values:
ON: Enablement
OFF: Disablement
Default value: No modification if not passed in

3. Output Parameters

Parameter Name Type Description
RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Sample code for modifying a DLP policy

Input Example

POST / HTTP/1.1
Host: csip.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifySandboxDLPRule
<Common request parameters>

{
    "ID": 4001,
    "Level": "CRITICAL"
}

Output Example

{
    "Response": {
        "RequestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

There is no error code related to the API business logic. For other error codes, please see Common Error Codes.

Previous Topic: ModifySandboxAlertStatusNext Topic: ModifySandboxDLPRuleStatus

Help and Support

Was this page helpful?

Help us improve! Rate your documentation experience in 5 mins.

Feedback