Bot Defender APICustom Rules

Update field by rule ID

Update specified custom fields for a rule based on 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.
ruleIdstringOptional
priorityintegerOptional

Range from 0 (the highest priority) to the number of rules minus 1 (the lowest priority). For example, if there are 10 rules, then the 0th rule is the highest priority while the 9th rule is the lowest priority. By default, the priority will be set to the lowest priority.

namestringOptional
descriptionstringOptional
conditionsobjectOptional

A nested object with exactly two levels.

actionslist of enumsOptional
Allowed values:
statusenumOptional
Allowed values:

Response

Success
resultboolean or null
messagestring or null
contentobject or null