threatprotection:rulecategory : Threat protection rule category object.

This object provides information about the threat protection rule category settings.

Object Reference

References to threatprotection:rulecategory are object references.

The name part of the threatprotection:rulecategory object reference has the following components:

  • The name of the threat protection ruleset the category assigned to.
  • The name of the threat protection category.
Example:
threatprotection:rulecategory/YXRwLmNsdXN0yb3BlcnRpZXMkMA: UDPAttackCounterMeasures:BlockingFloodTechniques

Restrictions

The object does not support the following operations:

  • Create (insert)
  • Delete
  • Modify (update)
  • Permissions
  • Global search (searches via the search object)
  • Scheduling
  • CSV export

The object cannot be managed on Cloud Platform members.

Fields

These fields are actual members of the object; thus, they can be requested by using _return_fields, if the fields are readable.

The basic version of the object contains the field(s): name, ruleset.

is_factory_reset_enabled

is_factory_reset_enabled

Determines if factory reset is enabled for this rule category.

Type

Bool.

Search

The field is not available for search.

Notes

The is_factory_reset_enabled cannot be updated.

is_factory_reset_enabled cannot be written.

name

name

The name of the rule category.

Type

String.

Search

The field is available for search via

  • ‘:=’ (case insensitive search)
  • ‘=’ (exact equality)
  • ‘~=’ (regular expression)

Notes

The name is part of the base object.

The name cannot be updated.

name cannot be written.

ruleset

ruleset

The version of the ruleset the category assigned to.

Type

String.

Search

The field is available for search via

  • ‘=’ (exact equality)

Notes

The ruleset is part of the base object.

The ruleset cannot be updated.

ruleset cannot be written.

Fields List

Field Type Req R/O Base Search
is_factory_reset_enabled Bool N Y N N/A
name String N Y Y : = ~
ruleset String N Y Y =