Skip to main content

Get Bot Rule Details

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

Request

Request-Line

GET /waap/v1.0/botManagementRule/{id} HTTP/1.1

Request Parameters

Path Parameters

ParameterTypeRequiredDescription
idintegerMandatoryUnique identifier assigned to the bot rule.

Response

Response Body

ParameterTypeRequiredDescription
idintegerMandatoryUnique identifier assigned to the bot rule.
namestringMandatoryThe 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).
descriptionstringMandatoryThe description can have 1-200 characters.
silenceChallengeEnabledbooleanMandatoryWhether to enable silence challenge.
silenceChallengeActionstringMandatoryAction when silence challenge triggers. Must be "block" or "captcha".
ajaxEnabledbooleanMandatoryWhether to enable AJAX behavior detection.
antiDebuggingEnabledbooleanMandatoryWhether to enable anti-debugging behavior detection.
websitesinteger[]MandatoryList of website IDs the rule applies to. Must contain at least one valid ID.

Status Codes, Error Codes and Error Messages

Status CodeError CodeError Message
400Id.InvalidId is empty or invalid.
404BotManagementRule.NotFoundBot Management Rule is not found.

Examples

Get Bot Rule Details

Request

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

Successful Response Body

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