Skip to main content
GET
Python

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

Response

Successful Response

Full custom rule representation

id
integer
required

The unique identifier for the rule

name
string
required

The name assigned to the rule

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

"Block foobar bot"

enabled
boolean
required

Whether or not the rule is enabled

description
string
required

A description assigned to the rule.

Maximum string length: 100
action
CustomerRuleAction · object
required

The action that the rule takes when triggered. Only one action can be set per rule.

conditions
CustomRuleConditionResponse · object[]
required

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