Skip to main content
PATCH
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 firewall rule ID

Body

application/json
name
string

The name assigned to the rule

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

"Block foobar bot"

description
string

A human-readable description. When set to empty string, erases any value set earlier.

Maximum string length: 100
enabled
boolean

Whether or not the rule is enabled

action
FirewallRuleAction · object

The action that the rule takes when triggered

conditions
FirewallRuleCondition · object[]

The condition required for the WAAP engine to trigger the rule.

Required array length: 1 element

Response

Successful Response

Full firewall 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
FirewallRuleAction · object
required

The action that the rule takes when triggered

conditions
FirewallRuleCondition · object[]
required

The condition required for the WAAP engine to trigger the rule.

Required array length: 1 element