Get Bot Rule Detail

Retrieve detailed information about a specific Bot Rule by its ID.

Request

Request-Line

GET /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.

Response

Response Body

Parameter	Type	Description
ruleId	Integer	Unique identifier assigned to the bot rule.
name	String	The name for the bot 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).
description	String	The description can have 1-200 characters.
silenceChallengeEnabled	Boolean	Indicates whether the silence challenge is enabled.
silenceChallengeAction	String	Specifies the action when a silence challenge is triggered. Valid values are "block" or "captcha".
ajaxEnabled	Boolean	Indicates whether AJAX behaviour detection is enabled.
antiDebuggingEnabled	Boolean	Indicates whether anti-debugging behaviour detection is enabled.
websites	Integer[]	List of website IDs the rule applies to. Must contain at least one valid ID.

Status Codes, Error Codes and Error Messages

Status Code	Error Code	Error Message
400	RuleId.Invalid	RuleId is empty or invalid.
404	BotManagementRule.NotFound	Bot Management Rule is not found.

Examples

Get Bot Rule Detail

Request

GET /waap/v1.0/botRules/40 HTTP/1.1

Successful Response Body

{
    "ruleId": 40,
    "name": "test111",
    "description": "111",
    "silenceChallengeEnabled": true,
    "silenceChallengeAction": "captcha",
    "ajaxEnabled": true,
    "antiDebuggingEnabled": true,
    "websites": [
        392
    ]
}