Get Bot Rules

Retrieves a list of all existing Bot Management Rules.

Request

Request-Line

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

Response

Response Body

Parameter	Type	Required	Description
	Array	Mandatory	Array of Bot Rule.

Object: Bot Rule

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

Examples

Get Bot Rules

Request

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

Successful Response Body

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