threatprotection:rule : Member Threat Protection Rule object.

This object provides information about the member Threat protection rule settings.

Object Reference

References to threatprotection:rule are object references.

The name part of the threat protection rule object reference has the following components:

  • Name of the Atp Rule object

Example: threatprotection:rule/ZG5zLm5ldHdvcmtfdmlldyQxMTk:somerulename

Restrictions

The object does not support the following operations:

  • Create (insert)
  • Delete
  • 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): member, rule.

config

config

The threat protection rule configuration.

Type

A/An Threat protection rule configuration struct.

Create

The default value is undefined.

Search

The field is not available for search.

Notes

config is associated with the field use_config (see use flag).

disable

disable

Determines if the rule is enabled or not for the member.

Type

Bool.

Create

The default value is True.

Search

The field is not available for search.

Notes

disable is associated with the field use_disable (see use flag).

member

member

The name of the Threat protection member.

Type

String.

Search

The field is available for search via

  • ‘=’ (exact equality)

Notes

The member is part of the base object.

The member cannot be updated.

member cannot be written.

rule

rule

The rule object name.

Type

String.

Search

The field is available for search via

  • ‘=’ (exact equality)

Notes

The rule is part of the base object.

The rule cannot be updated.

rule cannot be written.

sid

sid

The Rule ID.

Type

Unsigned integer.

Search

The field is available for search via

  • ‘=’ (exact equality)

Notes

The sid cannot be updated.

sid cannot be written.

use_config

use_config

Use flag for: config

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

use_disable

use_disable

Use flag for: disable

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

Fields List

Field Type Req R/O Base Search
config struct N N N N/A
disable Bool N N N N/A
member String N Y Y =
rule String N Y Y =
sid Unsigned int N Y N =
use_config Bool N N N N/A
use_disable Bool N N N N/A