This object provides information about the threat protection rule template settings.
References to threatprotection:ruletemplate are object references.
The name part of the threatprotection:ruletemplate object reference has the following components:
- The name of the threat protection ruleset the template assigned to.
- The name of the threat protection template.
- The sid of the threat protection template.
The object does not support the following operations:
The object cannot be managed on Cloud Platform members.
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, sid.
The list of allowed actions of rhe rule template.
Type
Enum values array.
Search
The field is not available for search.
Notes
The allowed_actions cannot be updated.
allowed_actions cannot be written.
The rule category this template assigned to.
Type
String.
This field supports nested return fields as described here.
Search
The field is available for search via
Notes
The category cannot be updated.
category cannot be written.
The rule config of this template.
Type
A/An Threat protection rule configuration struct.
Search
The field is not available for search.
Notes
The default_config cannot be updated.
default_config cannot be written.
The description of the rule template.
Type
String.
Search
The field is available for search via
Notes
The description cannot be updated.
description cannot be written.
The name of the rule template.
Type
String.
Search
The field is available for search via
Notes
The name is part of the base object.
The name cannot be updated.
name cannot be written.
| Field | Type | Req | R/O | Base | Search |
|---|---|---|---|---|---|
| allowed_actions | [Enum] | N | Y | N | N/A |
| category | String | N | Y | N | = |
| default_config | struct | N | Y | N | N/A |
| description | String | N | Y | N | : = ~ |
| name | String | N | Y | Y | : = ~ |
| ruleset | String | N | Y | Y | = |
| sid | Unsigned int | N | Y | Y | = |
