WafSiteSettings - ESA WAF site protection settings - Edge Security Acceleration

Parameter	Type	Description	Example
	object	A short description of struct
ClientIpIdentifier	object	The client IP identification.
Mode	string	The identification mode.	headers
Headers	array	The specified headers.
	string	The specified header.	X-Forwarded-For
AddBotProtectionHeaders	object	The bot protection headers.
Enable	boolean	The switch.
AddSecurityHeaders	object	The security headers.
Enable	boolean	The switch.
SecurityLevel	object	The security level.
Value	string	The security level value.	low
BotManagement	object	The bot management.
DefiniteBots	object	The definite bots.
Id	integer	The rule ID.	20000001
Action	string	The action to perform.	captcha
LikelyBots	object	The likely bots.
Id	integer	The rule ID.	20000002
Action	string	The action to perform.	deny
VerifiedBots	object	The verified bots.
Id	integer	The rule ID.	20000003
Action	string	The action to perform.	bypass
JSDetection	object	The JavaScript detection.
Enable	boolean	Specifies whether to enable JavaScript detection.
EffectOnStatic	object	Specifies whether the rule applies to static resource requests.
Enable	boolean	Specifies whether to apply bot management to static resource requests.	true
BandwidthAbuseProtection	object	The bandwidth abuse protection.
Id	integer	The ID of the bandwidth abuse protection rule.	10000001
Status	string	The status of the bandwidth abuse protection rule.	on
Action	string	The action of the bandwidth abuse protection rule.	deny
DisableSecurityModule	object	The configuration for disabling the security module.
Status	string	The status switch for disabling the security module.	on
RequestBodyInspection	object	The request body inspection configuration. Controls the deep packet inspection behavior of WAF for HTTP request bodies. After this feature is enabled, content-based matching rules such as SQL injection and XSS detection take effect on request bodies. This structure can contain the following fields: Id: The unique identifier of the built-in inspection rule. SizeLimit: The maximum size of the request body to inspect. Action: The action to take when the request body exceeds the size limit.
Id	integer	The request body inspection rule ID, which is the unique identifier of the built-in rule. When request body inspection is enabled, the server uses this ID to associate the matching logic of the built-in inspection rule. The valid values are based on the built-in rule list of WAF.
SizeLimit	string	The maximum size of the request body to inspect, in bytes. If the request body is less than or equal to this value, the entire content is subject to WAF matching. If the request body exceeds this value, the action specified in the Action field is taken, such as inspecting only the first N bytes, rejecting the request, or allowing the request. Note The valid value range and default value are determined by the WAF server-side configuration.
Action	string	The action to take when the request body size exceeds SizeLimit. Common valid values (the complete list is determined by the server-side configuration): allow: allows the request without performing deep packet inspection on the portion that exceeds the limit. Note The complete enumeration is determined by the WAF server-side configuration.

object

A short description of struct

ClientIpIdentifier

object

The client IP identification.

Mode

string

The identification mode.

headers

Headers

array

The specified headers.

string

The specified header.

X-Forwarded-For

AddBotProtectionHeaders

object

The bot protection headers.

Enable

boolean

The switch.

AddSecurityHeaders

object

The security headers.

Enable

boolean

The switch.

SecurityLevel

object

The security level.

Value

string

The security level value.

low

BotManagement

object

The bot management.

DefiniteBots

object

The definite bots.

Id

integer

The rule ID.

20000001

Action

string

The action to perform.

captcha

LikelyBots

object

The likely bots.

Id

integer

The rule ID.

20000002

Action

string

The action to perform.

deny

VerifiedBots

object

The verified bots.

Id

integer

The rule ID.

20000003

Action

string

The action to perform.

bypass

JSDetection

object

The JavaScript detection.

Enable

boolean

Specifies whether to enable JavaScript detection.

EffectOnStatic

object

Specifies whether the rule applies to static resource requests.

Enable

boolean

Specifies whether to apply bot management to static resource requests.

true

BandwidthAbuseProtection

object

The bandwidth abuse protection.

Id

integer

The ID of the bandwidth abuse protection rule.

10000001

Status

string

The status of the bandwidth abuse protection rule.

on

Action

string

The action of the bandwidth abuse protection rule.

deny

DisableSecurityModule

object

The configuration for disabling the security module.

Status

string

The status switch for disabling the security module.

on

RequestBodyInspection

object

The request body inspection configuration. Controls the deep packet inspection behavior of WAF for HTTP request bodies. After this feature is enabled, content-based matching rules such as SQL injection and XSS detection take effect on request bodies.

This structure can contain the following fields:

Id: The unique identifier of the built-in inspection rule.
SizeLimit: The maximum size of the request body to inspect.
Action: The action to take when the request body exceeds the size limit.

Id

integer

The request body inspection rule ID, which is the unique identifier of the built-in rule. When request body inspection is enabled, the server uses this ID to associate the matching logic of the built-in inspection rule. The valid values are based on the built-in rule list of WAF.

SizeLimit

string

The maximum size of the request body to inspect, in bytes.

If the request body is less than or equal to this value, the entire content is subject to WAF matching.
If the request body exceeds this value, the action specified in the Action field is taken, such as inspecting only the first N bytes, rejecting the request, or allowing the request.

Note

The valid value range and default value are determined by the WAF server-side configuration.

Action

string

The action to take when the request body size exceeds SizeLimit.

Common valid values (the complete list is determined by the server-side configuration):

allow: allows the request without performing deep packet inspection on the portion that exceeds the limit.

Note

The complete enumeration is determined by the WAF server-side configuration.