tencent cloud

APIs

DocumentationAPIsCloud Security CenterAI-SPM APIsCreateSandboxLLMAuditRule

CreateSandboxLLMAuditRule

Download
Focus Mode
Font Size
Last updated: 2026-09-01 10:12:02

1. API Description

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

This API is used to create an LLM audit user rule. It must refer to at least one system rule and does not support user customization of rule content.

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: CreateSandboxLLMAuditRule.
Version Yes String Common Params. The value used for this API: 2022-11-21.
Region No String Common Params. This parameter is not required.
RuleName Yes String Rule name
Input parameter limit: length 1-128
Level Yes String Rule level
Enumeration values:
INFO: notification
LOW: low-risk
MEDIUM: Medium risk
HIGH: high risk
CRITICAL: Critical
BelongAssetType Yes String Asset type to which it belongs
Enumeration values:
HOST: Host
CONTAINER: Container
SystemRuleIDList.N Yes Array of String Referenced LLM audit system rule ID list (string literal, provided by LLMRules[].RuleID / ToolCallRules[].RuleID returned by DescribeSandboxLLMAuditSystemRuleList)
Input parameter limit: not empty, up to 1000; each element length 1-128.
EffectScope Yes TrafficSandboxEffectScope Effective scope
Status Yes String Initial status
Enumeration values:
ON: enabled.
OFF: disabled.
RuleAction Yes String Rule action
Enumeration values:
PASS: allowlist
BLOCK: Block and alarm
MONITOR: Alarm

3. Output Parameters

Parameter Name Type Description
ID Integer Rule ID
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 Creating an LLM Audit Rule Example

Input Example

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

{
    "RuleName": "Sensitive intent audit",
    "Level": "HIGH",
    "BelongAssetType": "HOST",
    "SystemRuleIDList": [
        "grl-safety-politics-std",
        "grl-safety-prompt-001"
    ],
    "EffectScope": {
        "EffectType": "EXCLUDE"
    },
    "RuleAction": "BLOCK",
    "Status": "ON"
}

Output Example

{
    "Response": {
        "ID": 6001,
        "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: CreateSandboxDLPRuleNext Topic: DeleteSandboxACLRule

Help and Support

Was this page helpful?

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

Feedback