Skip to main content

Get Bot Rules

Retrieves a list of all existing Bot Management Rules.

Request

Request-Line

GET /waap/v1.0/botManagementRules HTTP/1.1

Response

Response Body

ParameterTypeRequiredDescription
ArrayMandatoryArray of Bot Rule.

Object: Bot Rule

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.

Examples

Get Bot Rules

Request

GET /waap/v1.0/botManagementRules HTTP/1.1

Successful Response Body

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