aiwaf-user-defined-rules

Get user defined pattern rules from AIWAF devices

aiwaf-user-defined-rules [profile=PROFILE]

profile=PROFILE: Connect profile code of AIWAF device.

Output Fields

Field	Type	Name	Description
profile	String	Connect profile	Connect profile code of AIWAF device.
id	Integer	Rule id	Unique identifier of the user-defined rule.
severity	String	Severity	Risk level of the rule. e.g. low, medium, high, critical
name	String	Rule name	Name of the user-defined rule.
action	String	Action	Action to take when rule matches. e.g. BLOCK, DETECT
description	String	Description	Description of the user-defined rule.
is_enabled	Bool	Enabled	Whether the rule is enabled.
is_log_enabled	Bool	Log generated	Whether logging is enabled for this rule.
is_mail_enabled	Bool	Mail sent	Whether email notification is enabled for this rule.
include_src_addrs	String	Client IP	Client IP addresses to apply the rule to. Output array items with line breaks
exclude_src_addrs	String	Except IP	Client IP addresses to exclude from the rule. Output array items with line breaks
include_urls	String	Apply url	URLs to apply the rule to. Output array items with line breaks
exclude_urls	String	Except url	URLs to exclude from the rule. Output array items with line breaks
use_method	Bool	Use method condition	Whether to use HTTP method condition.
method_regex	String	Method regular expression	HTTP method pattern to match.
use_path	Bool	Use path condition	Whether to use URL path condition.
path_regex	String	Path regular expression	URL path pattern to match.
path_min_len	Integer	Path min length	Minimum length of URL path to match.
path_case_sensitive	Bool	Path case sensitive	Whether URL path matching is case sensitive.
use_user_agent	Bool	Use user agent condition	Whether to use User-Agent condition.
user_agent_regex	String	User agent regular expression	User-Agent pattern to match.
user_agent_min_len	Integer	User agent min length	Minimum length of User-Agent to match.
user_agent_case_sensitive	Bool	Is user agent case sensitive	Whether User-Agent matching is case sensitive.
use_header	Bool	Use header condition	Whether to use HTTP header condition.
header_regex	String	Header regular expression	HTTP header pattern to match.
header_min_len	Integer	Header min length	Minimum length of HTTP header to match.
header_case_sensitive	Bool	Header case sensitive	Whether HTTP header matching is case sensitive.
use_cookie	Bool	Use cookie condition	Whether to use cookie condition.
cookie_regex	String	Cookie regular expression	Cookie pattern to match.
cookie_min_len	Integer	Cookie min length	Minimum length of cookie to match.
cookie_case_sensitive	Bool	Cookie case sensitive	Whether cookie matching is case sensitive.
use_param	Bool	Use parameter condition	Whether to use query parameter condition.
param_regex	String	Query parameter regular expression	Query parameter pattern to match.
param_min_len	Integer	Query parameter min length	Minimum length of query parameter to match.
param_max_len	Integer	Query parameter max length	Maximum length of query parameter to match.
param_case_sensitive	Bool	Query parameter case sensitive	Whether query parameter matching is case sensitive.
use_query	Bool	Use query condition	Whether to use full query condition.
query_regex	String	Query regular expression	Full query pattern to match.
query_min_len	Integer	Query min length	Minimum length of full query to match.
query_max_len	Integer	Query max length	Maximum length of full query to match.
query_case_sensitive	Bool	Query case sensitive	Whether full query matching is case sensitive.
use_file_name	Bool	Use file name condition	Whether to use file name condition.
file_name_regex	String	Upload file name regular expression	Upload file name pattern to match.
file_name_min	Integer	Upload file name min length	Minimum length of upload file name to match.
file_name_case_sensitive	Bool	Upload file name case sensitive	Whether upload file name matching is case sensitive.
use_file_content	Bool	Use file content condition	Whether to use file content condition.
file_content_regex	String	Upload file content regular expression	Upload file content pattern to match.
file_content_min_len	Integer	Upload file content min length	Minimum length of upload file content to match.
file_content_max_len	Integer	Upload file content max length	Maximum length of upload file content to match.
file_content_case_sensitive	Bool	Upload file content case sensitive	Whether upload file content matching is case sensitive.