Update Web Access Control Rule

Update an existing web access control rule identified by ID.

Request

Request-Line

PUT /waap/v1.0/pbrStrategy/webAccessControls/{ruleId} HTTP/1.1

Request Parameters

Path Parameters

Parameter	Type	Required	Description
ruleId	Integer	Mandatory	Unique identifier assigned to the web access control rule.

Body Parameters

Parameter	Type	Required	Description
name	String	Optional	Rule name for web access control. If not provided, the existing name will remain unchanged.
description	String	Optional	The description can have 1-200 characters. If not provided, the existing description will remain unchanged.
pathOperator	String	Optional	Matching operator used to evaluate the request path. Supported values: equal, notEqual, contain, notContain, beginsWith, notBeginsWith, endsWith, notEndsWith, regex, notMatchRegex, include, exclude. If not provided, the existing pathOperator will remain unchanged.
pathPattern	String	Optional	The path pattern to be matched against the request URI. The interpretation depends on pathOperator. For example, when pathOperator is contain, the rule triggers if the request path contains this value. If not provided, the existing pathPattern will remain unchanged.
keyType	String	Optional	The request attribute used for matching. Supported values: ip, fingerprint, userAgent, cookieId. If provided, keyValue should also be specified. If not provided, the existing pathPattern will remain unchanged.
keyValue	String[]	Optional	One or more values used to match against the selected keyType. Multiple values can be provided. If not provided, the existing keyType will remain unchanged.
keyRegex	Boolean	Optional	Indicates whether keyValue should be interpreted as a regular expression. This field is only applicable when keyType is fingerprint, userAgent, or cookieId. If provided, keyType and keyValue should also be specified. If not provided, the existing keyRegex will remain unchanged.
devType	String[]	Optional	Specifies the device types that the rule applies to. Supported values: pc, mac, mobile. Multiple device types can be selected. If not provided, the existing devType will remain unchanged.
triggeringProbability	Integer	Optional	The probability (in percentage) that the configured action will be triggered when the request matches the rule. Supported values: 100, 90, 80, 70, 60, 50, 40, 30, 20, 10. If not provided, the existing triggeringProbability will remain unchanged.
autoListKey	String	Optional	The key type used by Auto-Web ACL to automatically control request access. Supported values: ip, fingerprint. If not provided, the existing autoListDuration will remain unchanged.
autoListDuration	Integer	Optional	The duration (in seconds) that the key will remain in the Auto-Web ACL once triggered. The valid range is 0 to 600000. If not provided, the existing pathPattern will remain unchanged.
websites	Integer[]	Optional	List of website IDs the rule applies to. If not provided, the existing websites will remain unchanged.

Response

Status Codes, Error Codes and Error Messages

Status Code	Error Code	Error Message
400	Request.BadRequest	Bad request.
400	Name.Invalid	Name is empty or invalid.
400	PathOperator.Invalid	PathOperator is empty or invalid.
400	PathPattern.Invalid	PathPattern is empty or invalid.
400	KeyType.Invalid	KeyType is empty or invalid.
400	KeyValue.Invalid	KeyValue is empty or invalid.
400	DevType.Invalid	DevType is empty or invalid.
400	TriggeringProbability.Invalid	TriggeringProbability is empty or invalid.
400	AutoListKey.Invalid	AutoListKey is empty or invalid.
400	AutoListDuration.Invalid	AutoListDuration is empty or invalid.
404	Website.NotFound	Website is not found.
404	WebAccessControlRule.NotFound	Web Access Control Rule is not found.

Examples

Update Web Access Control Rule

Request

PUT /waap/v1.0/pbrStrategy/webAccessControls/261700 HTTP/1.1

{
    "name": "test",
    "description": "test",
    "pathOperator": "endsWith",
    "pathPattern": "/test",
    "keyType": "userAgent",
    "keyValue": [
        "test"
    ],
    "keyRegex": false,
    "devType": [
        "mac",
        "mobile"
    ],
    "triggeringProbability": 10,
    "autoListKey": "ip",
    "autoListDuration": 60,
    "websites": []
}