Skip to main content
PATCH
Update a custom rule

Authorizations

Authorization
string
header
required

API key for authentication. Make sure to include the word apikey, followed by a single space and then your token. Example: apikey 1234$abcdef

Path Parameters

domain_id
integer
required

The domain ID

rule_id
integer
required

The custom rule ID

Body

application/json

A request to update a WAAP rule

name
string | null

The name assigned to the rule

Required string length: 1 - 100
Pattern: ^[A-Za-z0-9\s.:'";<>?&|\\]+$
Example:

"Block foobar bot"

description
string | null

The description assigned to the rule

Maximum string length: 100
enabled
boolean | null

Whether or not the rule is enabled

action
CustomerRuleAction · object | null

The action that the rule takes when triggered

conditions
CustomRuleCondition · object[] | null

The conditions required for the WAAP engine to trigger the rule. Rules may have between 1 and 5 conditions. All conditions must pass for the rule to trigger

Required array length: 1 - 5 elements

Response

Successful Response