Update Bot Rule
Updates an existing Bot Management Rule identified by ID.
Request
Request-Line
PUT /waap/v1.0/botRules/{ruleId} HTTP/1.1
Request Parameters
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| ruleId | Integer | Mandatory | Unique identifier assigned to the bot rule. |
Body Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| name | String | Optional | The name for a new rule. The name must have 1-26 characters. Valid characters: 0-9, A-Z, a-z, space, . (dot), _ (underline), - (hyphen), () (parentheses), * (asterisk) and + (plus sign). 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. |
| silenceChallengeEnabled | Boolean | Optional | Indicates whether the silence challenge is enabled. If omitted, the existing setting remains unchanged. |
| silenceChallengeAction | String | Optional | Specifies the action when a silence challenge is triggered. Valid values are "block" or "captcha". |
| ajaxEnabled | Boolean | Optional | Indicates whether AJAX behaviour detection is enabled. If omitted, the existing setting remains unchanged. |
| antiDebuggingEnabled | Boolean | Optional | Indicates whether anti-debugging behaviour detection is enabled. If omitted, the existing setting remains unchanged. |
| websites | Integer[] | Optional | List of website IDs the rule applies to. Must contain at least one valid ID. If omitted, the existing websites remains unchanged. |
Response
Status Codes, Error Codes and Error Messages
| Status Code | Error Code | Error Message |
|---|---|---|
| 400 | Request.BadRequest | Bad request. |
| 400 | RuleId.Invalid | RuleId is empty or invalid. |
| 400 | Name.Invalid | Name is empty or invalid. |
| 404 | BotManagementRule.NotFound | Bot Management Rule is not found. |
| 404 | Website.NotFound | Website is not found. |
Examples
Update Bot Rule
Request
PUT /waap/v1.0/botRules/40 HTTP/1.1
{
"name": "test111",
"description": "111",
"silenceChallengeEnabled": 1,
"silenceChallengeAction": "captcha",
"ajaxEnabled": true,
"antiDebuggingEnabled": true,
"websites": [
110,111
]
}