threatprotection:ruleset : The Grid threat protection ruleset object.¶
This object represent the Grid protection ruleset information.
Object Reference¶
References to threatprotection:ruleset are object references.
The name part of the threatprotection:ruleset object reference has the following components:
The ruleset version.
- Example:
threatprotection:ruleset/YXRwLmNsdXN0ZXJfYXRwX3Byb3BlcnRpZXMkMA:42
Restrictions¶
The object does not support the following operations:
Create (insert)
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): add_type, version.
add_type¶
- add_type¶
Determines the way the ruleset was added.
Type
String.
- Valid values are:
AUTOMATIC
MANUAL
Search
The field is available for search via
‘=’ (exact equality)
Notes
The add_type is part of the base object.
The add_type cannot be updated.
add_type cannot be written.
added_time¶
- added_time¶
The time when the ruleset was added.
Type
Timestamp.
Search
The field is not available for search.
Notes
The added_time cannot be updated.
added_time cannot be written.
comment¶
- comment¶
The human readable comment for the ruleset.
Type
String.
Create
The default value is undefined.
Search
The field is available for search via
‘~=’ (regular expression)
‘=’ (exact equality)
‘:=’ (case insensitive search)
do_not_delete¶
- do_not_delete¶
Determines if the ruleset will not be deleted during upgrade.
Type
Bool.
Create
The default value is undefined.
Search
The field is not available for search.
is_factory_reset_enabled¶
- is_factory_reset_enabled¶
Determines if factory reset is enabled for this ruleset.
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.
used_by¶
- used_by¶
The users of the ruleset.
Type
String array.
Search
The field is not available for search.
Notes
The used_by cannot be updated.
used_by cannot be written.
version¶
- version¶
The ruleset version.
Type
String.
Search
The field is available for search via
‘~=’ (regular expression)
‘=’ (exact equality)
‘:=’ (case insensitive search)
Notes
The version is part of the base object.
The version cannot be updated.
version cannot be written.
Fields List¶
Field |
Type |
Req |
R/O |
Base |
Search |
|---|---|---|---|---|---|
add_type |
String |
N |
Y |
Y |
= |
added_time |
Timestamp |
N |
Y |
N |
N/A |
comment |
String |
N |
N |
N |
: = ~ |
do_not_delete |
Bool |
N |
N |
N |
N/A |
is_factory_reset_enabled |
Bool |
N |
Y |
N |
N/A |
used_by |
[String] |
N |
Y |
N |
N/A |
version |
String |
N |
Y |
Y |
: = ~ |
