The new docs.trellix.com features a modernized UI and AI-powered conversational search. Content is currently available in English, with additional languages launching in early November 2026. We hope you enjoy the updated experience.

List custom rules

Prev Next

API URL

<ips-api-base>/custom_rules

URL parameters

is_concise (optional): true(default)/false . is_concise=false will include rule_text as well in the response

offset/limit (optional): for pagination

Sample curl request

curl -gsvk -H "$c" --header "Accept: application/json" "https://<host>/wsapis/v2.0.0/ips/ custom_rules?limit=5&offset=10&is_concise=true" | jq "."

Authentication

Standard WSAPI authentication

Method

GET

Response

[
{
"severity": "7",
"reference": "CVE-2011-0611,BID-47314",
"signature_iden": 85300010,
"protocol": "http",
"block_status": 0,
"blocked": "blockable",
"rule_name": "Adobe Flash Player ActionScript callMethod Type Confusion Code
Execution",
"is_custom": false,
"created_at": "2013-09-30T00:00:00",
"category": "exploit",
"enabled": true,
"direction": "from_server"
},
{
"severity": "7",
"reference": "CVE-2007-0015,BID-21829,SECUNIA-SA23540",
"signature_iden": 85300011,
"protocol": "http",
"block_status": 0,
"blocked": "blockable",
"rule_name": "Apple QuickTime RTSP URL Buffer Overflow",
"is_custom": false,
"created_at": "2013-09-30T00:00:00",
"category": "exploit",
"enabled": true,
"direction": "to_client"
},
{
"severity": "7",
"reference": "CVE-2007-0015",
"signature_iden": 85300012,
"protocol": "http",
"block_status": 0,
"blocked": "blockable",
"rule_name": "Apple QuickTime RTSP URL Buffer Overflow",
"is_custom": false,
"created_at": "2013-09-30T00:00:00",
"category": "exploit",
"enabled": true,
"direction": "to_client"
}
]

HTTP response codes

  • 200 - no errors

  • 401 - auth error

  • 500 - internal error