Bot Defender APICustom Rules

Update rule by ID

Update a custom rule by the rule's ID.

Path parameters

ruleIdstringRequired

The ID for the rule. You can get this from the get custom rules endpoint or from the Portal’s Policy Settings.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
namestringRequired
conditionsobjectRequired

A nested object with exactly two levels.

actionslist of enumsRequired
Allowed values:
statusenumRequired
Allowed values:
ruleIdstringOptional
priorityintegerOptional
API returns rules between 0 (the highest priority) and the number of rules minus 1 (the lowest priority). This corresponds to the console's rules between 1 (the highest priority) and the number of rules. For example, if there are 10 rules, then in the API, the 0th rule is the highest priority while the 9th rule is the lowest priority. This 0th rule corresponds to the 1st rule in the console. Based on this example, the default value would be 9.
descriptionstringOptional

Response

Success
resultboolean or null
messagestring or null
contentobject or null

Errors