threatinsight:allowlist : Threat insight allowlist object.¶
The threat insight allowlist object contains trusted domains on which NIOS allows DNS traffic.
Object Reference¶
References to threatinsight:allowlist are object references.
The name part of the threat insight allowlist object reference has the following components:
The fully-qualified domain name (FQDN) of the threat insight allowlist
- Example:
threatinsight:allowlist/ ZG5zLm9wdGlvbl9kZWZpbml0aW9uJGluZm8uLmZhbHNlLjI1Mg:allowlist.com
Restrictions¶
The object does not support the following operations:
Global search (searches via the search object)
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): comment, disable, fqdn.
The following fields are required to create this object:
Field |
Notes |
|---|---|
fqdn |
comment¶
- comment¶
The descriptive comment for the threat insight allowlist.
Type
String.
Create
The default value is empty.
Search
The field is available for search via
‘~=’ (regular expression)
‘=’ (exact equality)
‘:=’ (case insensitive search)
Notes
The comment is part of the base object.
disable¶
- disable¶
Determines whether the threat insight allowlist is disabled.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Notes
The disable is part of the base object.
fqdn¶
- fqdn¶
The FQDN of the threat insight allowlist.
Type
String.
Values with leading or trailing white space are not valid for this field.
Create
The field is required on creation.
Search
The field is available for search via
‘~=’ (regular expression)
‘=’ (exact equality)
‘:=’ (case insensitive search)
Notes
The fqdn is part of the base object.
type¶
- type¶
The type of the threat insight allowlist.
Type
String.
- Valid values are:
BOTH
CUSTOM
SYSTEM
Search
The field is available for search via
‘=’ (exact equality)
Notes
The type cannot be updated.
type cannot be written.
Fields List¶
Field |
Type |
Req |
R/O |
Base |
Search |
|---|---|---|---|---|---|
comment |
String |
N |
N |
Y |
: = ~ |
disable |
Bool |
N |
N |
Y |
N/A |
fqdn |
String |
Y |
N |
Y |
: = ~ |
type |
String |
N |
Y |
N |
= |
