Skip to content

Firewall Rule

The Firewall Rule object represents a specific rule within a firewall policy or event. It contains information about a rule’s configuration, properties, and associated actions that define how network traffic is handled by the firewall.

  • Extends: rule

Attributes

Section titled “Attributes”

name

  • Type: string_t
  • Requirement: recommended

The name of the rule that generated the event.

uid

  • Type: string_t
  • Requirement: recommended

The unique identifier of the rule that generated the event.

category

  • Type: string_t
  • Requirement: optional

The rule category.

condition

  • Type: string_t
  • Requirement: optional

The rule trigger condition for the rule. For example: SQL_INJECTION.

desc

  • Type: string_t
  • Requirement: optional

The description of the rule that generated the event.

duration

  • Type: long_t
  • Requirement: optional

The rule response time duration, usually used for challenge completion time.

match_details

  • Type: string_t
  • Requirement: optional

The data in a request that rule matched. For example: ’[“10”,“and”,“1”]’.

match_location

  • Type: string_t
  • Requirement: optional

The location of the matched data in the source which resulted in the triggered firewall rule. For example: HEADER.

rate_limit

  • Type: integer_t
  • Requirement: optional

The rate limit for a rate-based rule.

sensitivity

  • Type: string_t
  • Requirement: optional

The sensitivity of the firewall rule in the matched event. For example: HIGH.

type

  • Type: string_t
  • Requirement: optional

The rule type.

version

  • Type: string_t
  • Requirement: optional

The rule version. For example: 1.1.

Constraints

Section titled “Constraints”

At least one of: name, uid

Used By

Section titled “Used By”