@robinmordasiewicz/f5xc-terraform-mcp 3.5.1 → 3.6.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/docs/data-sources/bgp.md +2 -2
- package/dist/docs/data-sources/discovery.md +2 -2
- package/dist/docs/data-sources/fast_acl.md +2 -2
- package/dist/docs/data-sources/fast_acl_rule.md +2 -2
- package/dist/docs/data-sources/irule.md +2 -2
- package/dist/docs/data-sources/log_receiver.md +2 -2
- package/dist/docs/data-sources/network_policy.md +2 -2
- package/dist/docs/data-sources/route.md +2 -2
- package/dist/docs/data-sources/site.md +2 -2
- package/dist/docs/resources/address_allocator.md +7 -7
- package/dist/docs/resources/advertise_policy.md +57 -57
- package/dist/docs/resources/alert_policy.md +40 -40
- package/dist/docs/resources/alert_receiver.md +57 -57
- package/dist/docs/resources/api_crawler.md +13 -13
- package/dist/docs/resources/api_definition.md +11 -11
- package/dist/docs/resources/api_discovery.md +4 -4
- package/dist/docs/resources/api_testing.md +27 -27
- package/dist/docs/resources/apm.md +40 -40
- package/dist/docs/resources/app_api_group.md +20 -20
- package/dist/docs/resources/app_firewall.md +50 -50
- package/dist/docs/resources/app_setting.md +19 -19
- package/dist/docs/resources/app_type.md +7 -7
- package/dist/docs/resources/authentication.md +29 -29
- package/dist/docs/resources/aws_tgw_site.md +140 -140
- package/dist/docs/resources/aws_vpc_site.md +174 -174
- package/dist/docs/resources/azure_vnet_site.md +245 -245
- package/dist/docs/resources/bgp.md +37 -205
- package/dist/docs/resources/bgp_asn_set.md +1 -1
- package/dist/docs/resources/bgp_routing_policy.md +19 -19
- package/dist/docs/resources/bot_defense_app_infrastructure.md +12 -12
- package/dist/docs/resources/cdn_cache_rule.md +5 -5
- package/dist/docs/resources/cdn_loadbalancer.md +418 -418
- package/dist/docs/resources/certificate.md +1 -1
- package/dist/docs/resources/certificate_chain.md +1 -1
- package/dist/docs/resources/cloud_connect.md +28 -28
- package/dist/docs/resources/cloud_credentials.md +35 -35
- package/dist/docs/resources/cloud_elastic_ip.md +8 -8
- package/dist/docs/resources/cloud_link.md +36 -36
- package/dist/docs/resources/cluster.md +86 -86
- package/dist/docs/resources/cminstance.md +22 -22
- package/dist/docs/resources/code_base_integration.md +24 -24
- package/dist/docs/resources/container_registry.md +13 -13
- package/dist/docs/resources/crl.md +1 -1
- package/dist/docs/resources/data_type.md +16 -16
- package/dist/docs/resources/dc_cluster_group.md +4 -4
- package/dist/docs/resources/discovery.md +8 -259
- package/dist/docs/resources/dns_compliance_checks.md +1 -1
- package/dist/docs/resources/dns_domain.md +3 -3
- package/dist/docs/resources/endpoint.md +44 -44
- package/dist/docs/resources/enhanced_firewall_policy.md +51 -51
- package/dist/docs/resources/external_connector.md +42 -42
- package/dist/docs/resources/fast_acl.md +60 -166
- package/dist/docs/resources/fast_acl_rule.md +28 -28
- package/dist/docs/resources/filter_set.md +10 -10
- package/dist/docs/resources/fleet.md +160 -160
- package/dist/docs/resources/forward_proxy_policy.md +82 -82
- package/dist/docs/resources/forwarding_class.md +14 -14
- package/dist/docs/resources/gcp_vpc_site.md +152 -152
- package/dist/docs/resources/global_log_receiver.md +238 -238
- package/dist/docs/resources/healthcheck.md +17 -17
- package/dist/docs/resources/http_loadbalancer.md +1003 -1003
- package/dist/docs/resources/irule.md +5 -7
- package/dist/docs/resources/log_receiver.md +825 -44
- package/dist/docs/resources/malicious_user_mitigation.md +10 -10
- package/dist/docs/resources/nat_policy.md +86 -86
- package/dist/docs/resources/network_connector.md +31 -31
- package/dist/docs/resources/network_firewall.md +22 -22
- package/dist/docs/resources/network_interface.md +77 -77
- package/dist/docs/resources/network_policy.md +38 -217
- package/dist/docs/resources/network_policy_rule.md +21 -21
- package/dist/docs/resources/network_policy_view.md +65 -65
- package/dist/docs/resources/nfv_service.md +76 -76
- package/dist/docs/resources/nginx_service_discovery.md +10 -10
- package/dist/docs/resources/origin_pool.md +166 -166
- package/dist/docs/resources/policer.md +4 -4
- package/dist/docs/resources/policy_based_routing.md +28 -28
- package/dist/docs/resources/protocol_inspection.md +12 -12
- package/dist/docs/resources/protocol_policer.md +14 -14
- package/dist/docs/resources/proxy.md +111 -111
- package/dist/docs/resources/rate_limiter.md +15 -15
- package/dist/docs/resources/rate_limiter_policy.md +56 -56
- package/dist/docs/resources/route.md +183 -183
- package/dist/docs/resources/secret_management_access.md +68 -68
- package/dist/docs/resources/securemesh_site.md +1619 -258
- package/dist/docs/resources/segment.md +4 -4
- package/dist/docs/resources/sensitive_data_policy.md +9 -9
- package/dist/docs/resources/service_policy.md +175 -175
- package/dist/docs/resources/service_policy_rule.md +142 -142
- package/dist/docs/resources/site.md +381 -303
- package/dist/docs/resources/site_mesh_group.md +18 -18
- package/dist/docs/resources/subnet.md +17 -17
- package/dist/docs/resources/tcp_loadbalancer.md +130 -130
- package/dist/docs/resources/tenant_configuration.md +10 -10
- package/dist/docs/resources/trusted_ca_list.md +1 -1
- package/dist/docs/resources/tunnel.md +36 -36
- package/dist/docs/resources/udp_loadbalancer.md +59 -59
- package/dist/docs/resources/usb_policy.md +6 -6
- package/dist/docs/resources/user_identification.md +16 -16
- package/dist/docs/resources/virtual_host.md +225 -225
- package/dist/docs/resources/virtual_network.md +14 -14
- package/dist/docs/resources/virtual_site.md +3 -3
- package/dist/docs/resources/voltstack_site.md +141 -141
- package/dist/docs/resources/waf_exclusion_policy.md +17 -17
- package/dist/docs/resources/workload.md +327 -327
- package/dist/docs/resources/workload_flavor.md +3 -3
- package/dist/metadata/resource-metadata.json +1484 -942
- package/dist/types.d.ts +11 -0
- package/dist/types.d.ts.map +1 -1
- package/dist/types.js.map +1 -1
- package/package.json +1 -1
|
@@ -36,11 +36,11 @@ resource "f5xc_app_api_group" "example" {
|
|
|
36
36
|
bigip_virtual_server {
|
|
37
37
|
# Configure bigip_virtual_server settings
|
|
38
38
|
}
|
|
39
|
-
#
|
|
39
|
+
# Set the scope of the API Group to a specific CDN Loadbala...
|
|
40
40
|
cdn_loadbalancer {
|
|
41
41
|
# Configure cdn_loadbalancer settings
|
|
42
42
|
}
|
|
43
|
-
#
|
|
43
|
+
# List of API group elements with methods and path regex fo...
|
|
44
44
|
elements {
|
|
45
45
|
# Configure elements settings
|
|
46
46
|
}
|
|
@@ -67,11 +67,11 @@ resource "f5xc_app_api_group" "example" {
|
|
|
67
67
|
### Spec Argument Reference
|
|
68
68
|
|
|
69
69
|
-> **One of the following:**
|
|
70
|
-
• <a id="bigip-virtual-server"></a>[`bigip_virtual_server`](#bigip-virtual-server) - Optional Block<br>
|
|
71
|
-
<br><br>• <a id="cdn-loadbalancer"></a>[`cdn_loadbalancer`](#cdn-loadbalancer) - Optional Block<br>
|
|
72
|
-
<br><br>• <a id="http-loadbalancer"></a>[`http_loadbalancer`](#http-loadbalancer) - Optional Block<br>
|
|
70
|
+
• <a id="bigip-virtual-server"></a>[`bigip_virtual_server`](#bigip-virtual-server) - Optional Block<br>Set the scope of the API Group to a specific BIG-IP Virtual Server<br>See [Bigip Virtual Server](#bigip-virtual-server) below for details.
|
|
71
|
+
<br><br>• <a id="cdn-loadbalancer"></a>[`cdn_loadbalancer`](#cdn-loadbalancer) - Optional Block<br>Set the scope of the API Group to a specific CDN Loadbalancer<br>See [CDN Loadbalancer](#cdn-loadbalancer) below for details.
|
|
72
|
+
<br><br>• <a id="http-loadbalancer"></a>[`http_loadbalancer`](#http-loadbalancer) - Optional Block<br>Set the scope of the API Group to a specific HTTP Loadbalancer<br>See [HTTP Loadbalancer](#http-loadbalancer) below for details.
|
|
73
73
|
|
|
74
|
-
<a id="elements"></a>• [`elements`](#elements) - Optional Block<br>
|
|
74
|
+
<a id="elements"></a>• [`elements`](#elements) - Optional Block<br>List of API group elements with methods and path regex for matching requests<br>See [Elements](#elements) below for details.
|
|
75
75
|
|
|
76
76
|
<a id="timeouts"></a>• [`timeouts`](#timeouts) - Optional Block<br>See [Timeouts](#timeouts) below for details.
|
|
77
77
|
|
|
@@ -87,57 +87,57 @@ In addition to all arguments above, the following attributes are exported:
|
|
|
87
87
|
|
|
88
88
|
A [`bigip_virtual_server`](#bigip-virtual-server) block supports the following:
|
|
89
89
|
|
|
90
|
-
<a id="server-575600"></a>• [`bigip_virtual_server`](#server-575600) - Optional Block<br>
|
|
90
|
+
<a id="server-575600"></a>• [`bigip_virtual_server`](#server-575600) - Optional Block<br>Type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name<br>See [Bigip Virtual Server](#server-575600) below.
|
|
91
91
|
|
|
92
92
|
#### Bigip Virtual Server Bigip Virtual Server
|
|
93
93
|
|
|
94
94
|
A [`bigip_virtual_server`](#server-575600) block (within [`bigip_virtual_server`](#bigip-virtual-server)) supports the following:
|
|
95
95
|
|
|
96
|
-
<a id="name-9fb983"></a>• [`name`](#name-9fb983) - Optional String<br>
|
|
96
|
+
<a id="name-9fb983"></a>• [`name`](#name-9fb983) - Optional String<br>When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g. Route's) name
|
|
97
97
|
|
|
98
|
-
<a id="namespace-4ecc61"></a>• [`namespace`](#namespace-4ecc61) - Optional String<br>
|
|
98
|
+
<a id="namespace-4ecc61"></a>• [`namespace`](#namespace-4ecc61) - Optional String<br>When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g. Route's) namespace
|
|
99
99
|
|
|
100
|
-
<a id="tenant-c4d0e6"></a>• [`tenant`](#tenant-c4d0e6) - Optional String<br>
|
|
100
|
+
<a id="tenant-c4d0e6"></a>• [`tenant`](#tenant-c4d0e6) - Optional String<br>When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object's(e.g. Route's) tenant
|
|
101
101
|
|
|
102
102
|
#### CDN Loadbalancer
|
|
103
103
|
|
|
104
104
|
A [`cdn_loadbalancer`](#cdn-loadbalancer) block supports the following:
|
|
105
105
|
|
|
106
|
-
<a id="cdn-loadbalancer-cdn-loadbalancer"></a>• [`cdn_loadbalancer`](#cdn-loadbalancer-cdn-loadbalancer) - Optional Block<br>
|
|
106
|
+
<a id="cdn-loadbalancer-cdn-loadbalancer"></a>• [`cdn_loadbalancer`](#cdn-loadbalancer-cdn-loadbalancer) - Optional Block<br>Type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name<br>See [CDN Loadbalancer](#cdn-loadbalancer-cdn-loadbalancer) below.
|
|
107
107
|
|
|
108
108
|
#### CDN Loadbalancer CDN Loadbalancer
|
|
109
109
|
|
|
110
110
|
A [`cdn_loadbalancer`](#cdn-loadbalancer-cdn-loadbalancer) block (within [`cdn_loadbalancer`](#cdn-loadbalancer)) supports the following:
|
|
111
111
|
|
|
112
|
-
<a id="cdn-loadbalancer-cdn-loadbalancer-name"></a>• [`name`](#cdn-loadbalancer-cdn-loadbalancer-name) - Optional String<br>
|
|
112
|
+
<a id="cdn-loadbalancer-cdn-loadbalancer-name"></a>• [`name`](#cdn-loadbalancer-cdn-loadbalancer-name) - Optional String<br>When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g. Route's) name
|
|
113
113
|
|
|
114
|
-
<a id="namespace-8ae5bf"></a>• [`namespace`](#namespace-8ae5bf) - Optional String<br>
|
|
114
|
+
<a id="namespace-8ae5bf"></a>• [`namespace`](#namespace-8ae5bf) - Optional String<br>When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g. Route's) namespace
|
|
115
115
|
|
|
116
|
-
<a id="tenant-ea0b41"></a>• [`tenant`](#tenant-ea0b41) - Optional String<br>
|
|
116
|
+
<a id="tenant-ea0b41"></a>• [`tenant`](#tenant-ea0b41) - Optional String<br>When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object's(e.g. Route's) tenant
|
|
117
117
|
|
|
118
118
|
#### Elements
|
|
119
119
|
|
|
120
120
|
An [`elements`](#elements) block supports the following:
|
|
121
121
|
|
|
122
|
-
<a id="elements-methods"></a>• [`methods`](#elements-methods) - Optional List Defaults to `ANY`<br>See [HTTP Methods](#common-http-methods)<br>
|
|
122
|
+
<a id="elements-methods"></a>• [`methods`](#elements-methods) - Optional List Defaults to `ANY`<br>See [HTTP Methods](#common-http-methods)<br> List of method values to match the input request API method against. The match is considered to succeed if the input request API method is a member of the list
|
|
123
123
|
|
|
124
|
-
<a id="elements-path-regex"></a>• [`path_regex`](#elements-path-regex) - Optional String<br>
|
|
124
|
+
<a id="elements-path-regex"></a>• [`path_regex`](#elements-path-regex) - Optional String<br>Regular expression to match the input request API path against. The match is considered to succeed if the input request API path matches the specified path regex
|
|
125
125
|
|
|
126
126
|
#### HTTP Loadbalancer
|
|
127
127
|
|
|
128
128
|
A [`http_loadbalancer`](#http-loadbalancer) block supports the following:
|
|
129
129
|
|
|
130
|
-
<a id="http-loadbalancer-http-loadbalancer"></a>• [`http_loadbalancer`](#http-loadbalancer-http-loadbalancer) - Optional Block<br>
|
|
130
|
+
<a id="http-loadbalancer-http-loadbalancer"></a>• [`http_loadbalancer`](#http-loadbalancer-http-loadbalancer) - Optional Block<br>Type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name<br>See [HTTP Loadbalancer](#http-loadbalancer-http-loadbalancer) below.
|
|
131
131
|
|
|
132
132
|
#### HTTP Loadbalancer HTTP Loadbalancer
|
|
133
133
|
|
|
134
134
|
A [`http_loadbalancer`](#http-loadbalancer-http-loadbalancer) block (within [`http_loadbalancer`](#http-loadbalancer)) supports the following:
|
|
135
135
|
|
|
136
|
-
<a id="name-9dca0b"></a>• [`name`](#name-9dca0b) - Optional String<br>
|
|
136
|
+
<a id="name-9dca0b"></a>• [`name`](#name-9dca0b) - Optional String<br>When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g. Route's) name
|
|
137
137
|
|
|
138
|
-
<a id="namespace-c94608"></a>• [`namespace`](#namespace-c94608) - Optional String<br>
|
|
138
|
+
<a id="namespace-c94608"></a>• [`namespace`](#namespace-c94608) - Optional String<br>When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g. Route's) namespace
|
|
139
139
|
|
|
140
|
-
<a id="tenant-fa3b49"></a>• [`tenant`](#tenant-fa3b49) - Optional String<br>
|
|
140
|
+
<a id="tenant-fa3b49"></a>• [`tenant`](#tenant-fa3b49) - Optional String<br>When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object's(e.g. Route's) tenant
|
|
141
141
|
|
|
142
142
|
#### Timeouts
|
|
143
143
|
|
|
@@ -77,16 +77,16 @@ resource "f5xc_app_firewall" "example" {
|
|
|
77
77
|
### Spec Argument Reference
|
|
78
78
|
|
|
79
79
|
-> **One of the following:**
|
|
80
|
-
• <a id="ai-risk-based-blocking"></a>[`ai_risk_based_blocking`](#ai-risk-based-blocking) - Optional Block<br>
|
|
81
|
-
<br><br>• <a id="default-detection-settings"></a>[`default_detection_settings`](#default-detection-settings) - Optional Block<br>
|
|
80
|
+
• <a id="ai-risk-based-blocking"></a>[`ai_risk_based_blocking`](#ai-risk-based-blocking) - Optional Block<br>All Attack Types, including high, medium, and low accuracy signatures, automatic Attack Signature tuning, Threat Campaigns, and all Violations will be enabled. AI and ML algorithms will assess request risk, and only high-risk requests will be blocked by default. This feature is in preview mode<br>See [Ai Risk Based Blocking](#ai-risk-based-blocking) below for details.
|
|
81
|
+
<br><br>• <a id="default-detection-settings"></a>[`default_detection_settings`](#default-detection-settings) - Optional Block<br>Can be used for messages where no values are needed
|
|
82
82
|
|
|
83
83
|
-> **One of the following:**
|
|
84
|
-
• <a id="allow-all-response-codes"></a>[`allow_all_response_codes`](#allow-all-response-codes) - Optional Block<br>
|
|
85
|
-
<br><br>• <a id="allowed-response-codes"></a>[`allowed_response_codes`](#allowed-response-codes) - Optional Block<br>
|
|
84
|
+
• <a id="allow-all-response-codes"></a>[`allow_all_response_codes`](#allow-all-response-codes) - Optional Block<br>Can be used for messages where no values are needed
|
|
85
|
+
<br><br>• <a id="allowed-response-codes"></a>[`allowed_response_codes`](#allowed-response-codes) - Optional Block<br>List of HTTP response status codes that are allowed<br>See [Allowed Response Codes](#allowed-response-codes) below for details.
|
|
86
86
|
|
|
87
87
|
-> **One of the following:**
|
|
88
|
-
• <a id="blocking"></a>[`blocking`](#blocking) - Optional Block<br>
|
|
89
|
-
<br><br>• <a id="monitoring"></a>[`monitoring`](#monitoring) - Optional Block<br>
|
|
88
|
+
• <a id="blocking"></a>[`blocking`](#blocking) - Optional Block<br>Can be used for messages where no values are needed
|
|
89
|
+
<br><br>• <a id="monitoring"></a>[`monitoring`](#monitoring) - Optional Block<br>Can be used for messages where no values are needed
|
|
90
90
|
|
|
91
91
|
-> **One of the following:**
|
|
92
92
|
• <a id="blocking-page"></a>[`blocking_page`](#blocking-page) - Optional Block<br>Custom Blocking Response Page. Custom blocking response page body<br>See [Blocking Page](#blocking-page) below for details.
|
|
@@ -95,18 +95,18 @@ resource "f5xc_app_firewall" "example" {
|
|
|
95
95
|
• <a id="bot-protection-setting"></a>[`bot_protection_setting`](#bot-protection-setting) - Optional Block<br>Bot Protection. Configuration of WAF Bot Protection<br>See [Bot Protection Setting](#bot-protection-setting) below for details.
|
|
96
96
|
|
|
97
97
|
-> **One of the following:**
|
|
98
|
-
• <a id="custom-anonymization"></a>[`custom_anonymization`](#custom-anonymization) - Optional Block<br>Anonymization
|
|
99
|
-
<br><br>• <a id="default-anonymization"></a>[`default_anonymization`](#default-anonymization) - Optional Block<br>
|
|
98
|
+
• <a id="custom-anonymization"></a>[`custom_anonymization`](#custom-anonymization) - Optional Block<br>Anonymization settings which is a list of HTTP headers, parameters and cookies<br>See [Custom Anonymization](#custom-anonymization) below for details.
|
|
99
|
+
<br><br>• <a id="default-anonymization"></a>[`default_anonymization`](#default-anonymization) - Optional Block<br>Can be used for messages where no values are needed
|
|
100
100
|
|
|
101
|
-
<a id="default-bot-setting"></a>• [`default_bot_setting`](#default-bot-setting) - Optional Block<br>
|
|
101
|
+
<a id="default-bot-setting"></a>• [`default_bot_setting`](#default-bot-setting) - Optional Block<br>Can be used for messages where no values are needed
|
|
102
102
|
|
|
103
|
-
<a id="detection-settings"></a>• [`detection_settings`](#detection-settings) - Optional Block<br>
|
|
103
|
+
<a id="detection-settings"></a>• [`detection_settings`](#detection-settings) - Optional Block<br>Specifies detection settings to be used by WAF<br>See [Detection Settings](#detection-settings) below for details.
|
|
104
104
|
|
|
105
|
-
<a id="disable-anonymization"></a>• [`disable_anonymization`](#disable-anonymization) - Optional Block<br>
|
|
105
|
+
<a id="disable-anonymization"></a>• [`disable_anonymization`](#disable-anonymization) - Optional Block<br>Can be used for messages where no values are needed
|
|
106
106
|
|
|
107
107
|
<a id="timeouts"></a>• [`timeouts`](#timeouts) - Optional Block<br>See [Timeouts](#timeouts) below for details.
|
|
108
108
|
|
|
109
|
-
<a id="use-default-blocking-page"></a>• [`use_default_blocking_page`](#use-default-blocking-page) - Optional Block<br>
|
|
109
|
+
<a id="use-default-blocking-page"></a>• [`use_default_blocking_page`](#use-default-blocking-page) - Optional Block<br>Can be used for messages where no values are needed
|
|
110
110
|
|
|
111
111
|
### Attributes Reference
|
|
112
112
|
|
|
@@ -120,69 +120,69 @@ In addition to all arguments above, the following attributes are exported:
|
|
|
120
120
|
|
|
121
121
|
An [`ai_risk_based_blocking`](#ai-risk-based-blocking) block supports the following:
|
|
122
122
|
|
|
123
|
-
<a id="ai-risk-based-blocking-high-risk-action"></a>• [`high_risk_action`](#ai-risk-based-blocking-high-risk-action) - Optional String Defaults to `AI_BLOCK`<br>Possible values are `AI_BLOCK`, `AI_REPORT`<br>[Enum: AI_BLOCK|AI_REPORT]
|
|
123
|
+
<a id="ai-risk-based-blocking-high-risk-action"></a>• [`high_risk_action`](#ai-risk-based-blocking-high-risk-action) - Optional String Defaults to `AI_BLOCK`<br>Possible values are `AI_BLOCK`, `AI_REPORT`<br>[Enum: AI_BLOCK|AI_REPORT] Action to be performed on the request Log and block Log only
|
|
124
124
|
|
|
125
|
-
<a id="ai-risk-based-blocking-low-risk-action"></a>• [`low_risk_action`](#ai-risk-based-blocking-low-risk-action) - Optional String Defaults to `AI_BLOCK`<br>Possible values are `AI_BLOCK`, `AI_REPORT`<br>[Enum: AI_BLOCK|AI_REPORT]
|
|
125
|
+
<a id="ai-risk-based-blocking-low-risk-action"></a>• [`low_risk_action`](#ai-risk-based-blocking-low-risk-action) - Optional String Defaults to `AI_BLOCK`<br>Possible values are `AI_BLOCK`, `AI_REPORT`<br>[Enum: AI_BLOCK|AI_REPORT] Action to be performed on the request Log and block Log only
|
|
126
126
|
|
|
127
|
-
<a id="action-da1a5e"></a>• [`medium_risk_action`](#action-da1a5e) - Optional String Defaults to `AI_BLOCK`<br>Possible values are `AI_BLOCK`, `AI_REPORT`<br>[Enum: AI_BLOCK|AI_REPORT]
|
|
127
|
+
<a id="action-da1a5e"></a>• [`medium_risk_action`](#action-da1a5e) - Optional String Defaults to `AI_BLOCK`<br>Possible values are `AI_BLOCK`, `AI_REPORT`<br>[Enum: AI_BLOCK|AI_REPORT] Action to be performed on the request Log and block Log only
|
|
128
128
|
|
|
129
129
|
#### Allowed Response Codes
|
|
130
130
|
|
|
131
131
|
An [`allowed_response_codes`](#allowed-response-codes) block supports the following:
|
|
132
132
|
|
|
133
|
-
<a id="allowed-response-codes-response-code"></a>• [`response_code`](#allowed-response-codes-response-code) - Optional List<br>
|
|
133
|
+
<a id="allowed-response-codes-response-code"></a>• [`response_code`](#allowed-response-codes-response-code) - Optional List<br>List of HTTP response status codes that are allowed
|
|
134
134
|
|
|
135
135
|
#### Blocking Page
|
|
136
136
|
|
|
137
137
|
A [`blocking_page`](#blocking-page) block supports the following:
|
|
138
138
|
|
|
139
|
-
<a id="blocking-page-blocking-page"></a>• [`blocking_page`](#blocking-page-blocking-page) - Optional String<br>
|
|
139
|
+
<a id="blocking-page-blocking-page"></a>• [`blocking_page`](#blocking-page-blocking-page) - Optional String<br>Define the content of the response page (e.g., an HTML document or a JSON object), use the {{request_id}} placeholder to provide users with a unique identifier to be able to trace the blocked request in the logs. The maximum allowed size of response body is 4096 bytes after base64 encoding
|
|
140
140
|
|
|
141
|
-
<a id="blocking-page-response-code"></a>• [`response_code`](#blocking-page-response-code) - Optional String Defaults to `EmptyStatusCode`<br>Possible values are `EmptyStatusCode`, `Continue`, `OK`, `Created`, `Accepted`, `NonAuthoritativeInformation`, `NoContent`, `ResetContent`, `PartialContent`, `MultiStatus`, `AlreadyReported`, `IMUsed`, `MultipleChoices`, `MovedPermanently`, `Found`, `SeeOther`, `NotModified`, `UseProxy`, `TemporaryRedirect`, `PermanentRedirect`, `BadRequest`, `Unauthorized`, `PaymentRequired`, `Forbidden`, `NotFound`, `MethodNotAllowed`, `NotAcceptable`, `ProxyAuthenticationRequired`, `RequestTimeout`, `Conflict`, `Gone`, `LengthRequired`, `PreconditionFailed`, `PayloadTooLarge`, `URITooLong`, `UnsupportedMediaType`, `RangeNotSatisfiable`, `ExpectationFailed`, `MisdirectedRequest`, `UnprocessableEntity`, `Locked`, `FailedDependency`, `UpgradeRequired`, `PreconditionRequired`, `TooManyRequests`, `RequestHeaderFieldsTooLarge`, `InternalServerError`, `NotImplemented`, `BadGateway`, `ServiceUnavailable`, `GatewayTimeout`, `HTTPVersionNotSupported`, `VariantAlsoNegotiates`, `InsufficientStorage`, `LoopDetected`, `NotExtended`, `NetworkAuthenticationRequired`<br>[Enum: EmptyStatusCode|Continue|OK|Created|Accepted|NonAuthoritativeInformation|NoContent|ResetContent|PartialContent|MultiStatus|AlreadyReported|IMUsed|MultipleChoices|MovedPermanently|Found|SeeOther|NotModified|UseProxy|TemporaryRedirect|PermanentRedirect|BadRequest|Unauthorized|PaymentRequired|Forbidden|NotFound|MethodNotAllowed|NotAcceptable|ProxyAuthenticationRequired|RequestTimeout|Conflict|Gone|LengthRequired|PreconditionFailed|PayloadTooLarge|URITooLong|UnsupportedMediaType|RangeNotSatisfiable|ExpectationFailed|MisdirectedRequest|UnprocessableEntity|Locked|FailedDependency|UpgradeRequired|PreconditionRequired|TooManyRequests|RequestHeaderFieldsTooLarge|InternalServerError|NotImplemented|BadGateway|ServiceUnavailable|GatewayTimeout|HTTPVersionNotSupported|VariantAlsoNegotiates|InsufficientStorage|LoopDetected|NotExtended|NetworkAuthenticationRequired] HTTP
|
|
141
|
+
<a id="blocking-page-response-code"></a>• [`response_code`](#blocking-page-response-code) - Optional String Defaults to `EmptyStatusCode`<br>Possible values are `EmptyStatusCode`, `Continue`, `OK`, `Created`, `Accepted`, `NonAuthoritativeInformation`, `NoContent`, `ResetContent`, `PartialContent`, `MultiStatus`, `AlreadyReported`, `IMUsed`, `MultipleChoices`, `MovedPermanently`, `Found`, `SeeOther`, `NotModified`, `UseProxy`, `TemporaryRedirect`, `PermanentRedirect`, `BadRequest`, `Unauthorized`, `PaymentRequired`, `Forbidden`, `NotFound`, `MethodNotAllowed`, `NotAcceptable`, `ProxyAuthenticationRequired`, `RequestTimeout`, `Conflict`, `Gone`, `LengthRequired`, `PreconditionFailed`, `PayloadTooLarge`, `URITooLong`, `UnsupportedMediaType`, `RangeNotSatisfiable`, `ExpectationFailed`, `MisdirectedRequest`, `UnprocessableEntity`, `Locked`, `FailedDependency`, `UpgradeRequired`, `PreconditionRequired`, `TooManyRequests`, `RequestHeaderFieldsTooLarge`, `InternalServerError`, `NotImplemented`, `BadGateway`, `ServiceUnavailable`, `GatewayTimeout`, `HTTPVersionNotSupported`, `VariantAlsoNegotiates`, `InsufficientStorage`, `LoopDetected`, `NotExtended`, `NetworkAuthenticationRequired`<br>[Enum: EmptyStatusCode|Continue|OK|Created|Accepted|NonAuthoritativeInformation|NoContent|ResetContent|PartialContent|MultiStatus|AlreadyReported|IMUsed|MultipleChoices|MovedPermanently|Found|SeeOther|NotModified|UseProxy|TemporaryRedirect|PermanentRedirect|BadRequest|Unauthorized|PaymentRequired|Forbidden|NotFound|MethodNotAllowed|NotAcceptable|ProxyAuthenticationRequired|RequestTimeout|Conflict|Gone|LengthRequired|PreconditionFailed|PayloadTooLarge|URITooLong|UnsupportedMediaType|RangeNotSatisfiable|ExpectationFailed|MisdirectedRequest|UnprocessableEntity|Locked|FailedDependency|UpgradeRequired|PreconditionRequired|TooManyRequests|RequestHeaderFieldsTooLarge|InternalServerError|NotImplemented|BadGateway|ServiceUnavailable|GatewayTimeout|HTTPVersionNotSupported|VariantAlsoNegotiates|InsufficientStorage|LoopDetected|NotExtended|NetworkAuthenticationRequired] HTTP response status codes EmptyStatusCode response codes means it is not specified Continue status code OK status code Created status code Accepted status code Non Authoritative Information status code No Content status code Reset Content status code Partial Content status code Multi Status
|
|
142
142
|
|
|
143
143
|
#### Bot Protection Setting
|
|
144
144
|
|
|
145
145
|
A [`bot_protection_setting`](#bot-protection-setting) block supports the following:
|
|
146
146
|
|
|
147
|
-
<a id="bot-protection-setting-good-bot-action"></a>• [`good_bot_action`](#bot-protection-setting-good-bot-action) - Optional String Defaults to `BLOCK`<br>Possible values are `BLOCK`, `REPORT`, `IGNORE`<br>[Enum: BLOCK|REPORT|IGNORE]
|
|
147
|
+
<a id="bot-protection-setting-good-bot-action"></a>• [`good_bot_action`](#bot-protection-setting-good-bot-action) - Optional String Defaults to `BLOCK`<br>Possible values are `BLOCK`, `REPORT`, `IGNORE`<br>[Enum: BLOCK|REPORT|IGNORE] Action to be performed on the request Log and block Log only Disable detection
|
|
148
148
|
|
|
149
|
-
<a id="action-a39578"></a>• [`malicious_bot_action`](#action-a39578) - Optional String Defaults to `BLOCK`<br>Possible values are `BLOCK`, `REPORT`, `IGNORE`<br>[Enum: BLOCK|REPORT|IGNORE]
|
|
149
|
+
<a id="action-a39578"></a>• [`malicious_bot_action`](#action-a39578) - Optional String Defaults to `BLOCK`<br>Possible values are `BLOCK`, `REPORT`, `IGNORE`<br>[Enum: BLOCK|REPORT|IGNORE] Action to be performed on the request Log and block Log only Disable detection
|
|
150
150
|
|
|
151
|
-
<a id="action-7e372f"></a>• [`suspicious_bot_action`](#action-7e372f) - Optional String Defaults to `BLOCK`<br>Possible values are `BLOCK`, `REPORT`, `IGNORE`<br>[Enum: BLOCK|REPORT|IGNORE]
|
|
151
|
+
<a id="action-7e372f"></a>• [`suspicious_bot_action`](#action-7e372f) - Optional String Defaults to `BLOCK`<br>Possible values are `BLOCK`, `REPORT`, `IGNORE`<br>[Enum: BLOCK|REPORT|IGNORE] Action to be performed on the request Log and block Log only Disable detection
|
|
152
152
|
|
|
153
153
|
#### Custom Anonymization
|
|
154
154
|
|
|
155
155
|
A [`custom_anonymization`](#custom-anonymization) block supports the following:
|
|
156
156
|
|
|
157
|
-
<a id="config-0b4528"></a>• [`anonymization_config`](#config-0b4528) - Optional Block<br>
|
|
157
|
+
<a id="config-0b4528"></a>• [`anonymization_config`](#config-0b4528) - Optional Block<br>List of HTTP headers, cookies and query parameters whose values will be masked<br>See [Anonymization Config](#config-0b4528) below.
|
|
158
158
|
|
|
159
159
|
#### Custom Anonymization Anonymization Config
|
|
160
160
|
|
|
161
161
|
An [`anonymization_config`](#config-0b4528) block (within [`custom_anonymization`](#custom-anonymization)) supports the following:
|
|
162
162
|
|
|
163
|
-
<a id="cookie-df02b1"></a>• [`cookie`](#cookie-df02b1) - Optional Block<br>
|
|
163
|
+
<a id="cookie-df02b1"></a>• [`cookie`](#cookie-df02b1) - Optional Block<br>Configure anonymization for HTTP Cookies<br>See [Cookie](#cookie-df02b1) below.
|
|
164
164
|
|
|
165
|
-
<a id="header-65f784"></a>• [`http_header`](#header-65f784) - Optional Block<br>
|
|
165
|
+
<a id="header-65f784"></a>• [`http_header`](#header-65f784) - Optional Block<br>Configure anonymization for HTTP Headers<br>See [HTTP Header](#header-65f784) below.
|
|
166
166
|
|
|
167
|
-
<a id="parameter-dd1b2a"></a>• [`query_parameter`](#parameter-dd1b2a) - Optional Block<br>
|
|
167
|
+
<a id="parameter-dd1b2a"></a>• [`query_parameter`](#parameter-dd1b2a) - Optional Block<br>Configure anonymization for HTTP Parameters<br>See [Query Parameter](#parameter-dd1b2a) below.
|
|
168
168
|
|
|
169
169
|
#### Custom Anonymization Anonymization Config Cookie
|
|
170
170
|
|
|
171
171
|
A [`cookie`](#cookie-df02b1) block (within [`custom_anonymization.anonymization_config`](#config-0b4528)) supports the following:
|
|
172
172
|
|
|
173
|
-
<a id="name-856338"></a>• [`cookie_name`](#name-856338) - Optional String<br>
|
|
173
|
+
<a id="name-856338"></a>• [`cookie_name`](#name-856338) - Optional String<br>Masks the cookie value. The setting does not mask the cookie name
|
|
174
174
|
|
|
175
175
|
#### Custom Anonymization Anonymization Config HTTP Header
|
|
176
176
|
|
|
177
177
|
A [`http_header`](#header-65f784) block (within [`custom_anonymization.anonymization_config`](#config-0b4528)) supports the following:
|
|
178
178
|
|
|
179
|
-
<a id="name-ace46c"></a>• [`header_name`](#name-ace46c) - Optional String<br>
|
|
179
|
+
<a id="name-ace46c"></a>• [`header_name`](#name-ace46c) - Optional String<br>Masks the HTTP header value. The setting does not mask the HTTP header name
|
|
180
180
|
|
|
181
181
|
#### Custom Anonymization Anonymization Config Query Parameter
|
|
182
182
|
|
|
183
183
|
A [`query_parameter`](#parameter-dd1b2a) block (within [`custom_anonymization.anonymization_config`](#config-0b4528)) supports the following:
|
|
184
184
|
|
|
185
|
-
<a id="name-043171"></a>• [`query_param_name`](#name-043171) - Optional String<br>
|
|
185
|
+
<a id="name-043171"></a>• [`query_param_name`](#name-043171) - Optional String<br>Masks the query parameter value. The setting does not mask the query parameter name
|
|
186
186
|
|
|
187
187
|
#### Detection Settings
|
|
188
188
|
|
|
@@ -190,51 +190,51 @@ A [`detection_settings`](#detection-settings) block supports the following:
|
|
|
190
190
|
|
|
191
191
|
<a id="setting-37e8d9"></a>• [`bot_protection_setting`](#setting-37e8d9) - Optional Block<br>Bot Protection. Configuration of WAF Bot Protection<br>See [Bot Protection Setting](#setting-37e8d9) below.
|
|
192
192
|
|
|
193
|
-
<a id="detection-settings-default-bot-setting"></a>• [`default_bot_setting`](#detection-settings-default-bot-setting) - Optional Block<br>
|
|
193
|
+
<a id="detection-settings-default-bot-setting"></a>• [`default_bot_setting`](#detection-settings-default-bot-setting) - Optional Block<br>Can be used for messages where no values are needed
|
|
194
194
|
|
|
195
|
-
<a id="settings-da3fa7"></a>• [`default_violation_settings`](#settings-da3fa7) - Optional Block<br>
|
|
195
|
+
<a id="settings-da3fa7"></a>• [`default_violation_settings`](#settings-da3fa7) - Optional Block<br>Can be used for messages where no values are needed
|
|
196
196
|
|
|
197
|
-
<a id="detection-settings-disable-staging"></a>• [`disable_staging`](#detection-settings-disable-staging) - Optional Block<br>
|
|
197
|
+
<a id="detection-settings-disable-staging"></a>• [`disable_staging`](#detection-settings-disable-staging) - Optional Block<br>Can be used for messages where no values are needed
|
|
198
198
|
|
|
199
|
-
<a id="detection-settings-disable-suppression"></a>• [`disable_suppression`](#detection-settings-disable-suppression) - Optional Block<br>
|
|
199
|
+
<a id="detection-settings-disable-suppression"></a>• [`disable_suppression`](#detection-settings-disable-suppression) - Optional Block<br>Can be used for messages where no values are needed
|
|
200
200
|
|
|
201
|
-
<a id="campaigns-7bf1af"></a>• [`disable_threat_campaigns`](#campaigns-7bf1af) - Optional Block<br>
|
|
201
|
+
<a id="campaigns-7bf1af"></a>• [`disable_threat_campaigns`](#campaigns-7bf1af) - Optional Block<br>Can be used for messages where no values are needed
|
|
202
202
|
|
|
203
|
-
<a id="detection-settings-enable-suppression"></a>• [`enable_suppression`](#detection-settings-enable-suppression) - Optional Block<br>
|
|
203
|
+
<a id="detection-settings-enable-suppression"></a>• [`enable_suppression`](#detection-settings-enable-suppression) - Optional Block<br>Can be used for messages where no values are needed
|
|
204
204
|
|
|
205
|
-
<a id="campaigns-16aa5e"></a>• [`enable_threat_campaigns`](#campaigns-16aa5e) - Optional Block<br>
|
|
205
|
+
<a id="campaigns-16aa5e"></a>• [`enable_threat_campaigns`](#campaigns-16aa5e) - Optional Block<br>Can be used for messages where no values are needed
|
|
206
206
|
|
|
207
|
-
<a id="setting-306450"></a>• [`signature_selection_setting`](#setting-306450) - Optional Block<br>Attack Signatures
|
|
207
|
+
<a id="setting-306450"></a>• [`signature_selection_setting`](#setting-306450) - Optional Block<br>Attack Signatures are patterns that identify attacks on a web application and its components<br>See [Signature Selection Setting](#setting-306450) below.
|
|
208
208
|
|
|
209
|
-
<a id="signatures-2278ab"></a>• [`stage_new_and_updated_signatures`](#signatures-2278ab) - Optional Block<br>Attack Signatures
|
|
209
|
+
<a id="signatures-2278ab"></a>• [`stage_new_and_updated_signatures`](#signatures-2278ab) - Optional Block<br>Attack Signatures staging configuration<br>See [Stage New And Updated Signatures](#signatures-2278ab) below.
|
|
210
210
|
|
|
211
|
-
<a id="detection-settings-stage-new-signatures"></a>• [`stage_new_signatures`](#detection-settings-stage-new-signatures) - Optional Block<br>Attack Signatures
|
|
211
|
+
<a id="detection-settings-stage-new-signatures"></a>• [`stage_new_signatures`](#detection-settings-stage-new-signatures) - Optional Block<br>Attack Signatures staging configuration<br>See [Stage New Signatures](#detection-settings-stage-new-signatures) below.
|
|
212
212
|
|
|
213
|
-
<a id="detection-settings-violation-settings"></a>• [`violation_settings`](#detection-settings-violation-settings) - Optional Block<br>
|
|
213
|
+
<a id="detection-settings-violation-settings"></a>• [`violation_settings`](#detection-settings-violation-settings) - Optional Block<br>Specifies violation settings to be used by WAF<br>See [Violation Settings](#detection-settings-violation-settings) below.
|
|
214
214
|
|
|
215
215
|
#### Detection Settings Bot Protection Setting
|
|
216
216
|
|
|
217
217
|
A [`bot_protection_setting`](#setting-37e8d9) block (within [`detection_settings`](#detection-settings)) supports the following:
|
|
218
218
|
|
|
219
|
-
<a id="action-1a1e0b"></a>• [`good_bot_action`](#action-1a1e0b) - Optional String Defaults to `BLOCK`<br>Possible values are `BLOCK`, `REPORT`, `IGNORE`<br>[Enum: BLOCK|REPORT|IGNORE]
|
|
219
|
+
<a id="action-1a1e0b"></a>• [`good_bot_action`](#action-1a1e0b) - Optional String Defaults to `BLOCK`<br>Possible values are `BLOCK`, `REPORT`, `IGNORE`<br>[Enum: BLOCK|REPORT|IGNORE] Action to be performed on the request Log and block Log only Disable detection
|
|
220
220
|
|
|
221
|
-
<a id="action-321642"></a>• [`malicious_bot_action`](#action-321642) - Optional String Defaults to `BLOCK`<br>Possible values are `BLOCK`, `REPORT`, `IGNORE`<br>[Enum: BLOCK|REPORT|IGNORE]
|
|
221
|
+
<a id="action-321642"></a>• [`malicious_bot_action`](#action-321642) - Optional String Defaults to `BLOCK`<br>Possible values are `BLOCK`, `REPORT`, `IGNORE`<br>[Enum: BLOCK|REPORT|IGNORE] Action to be performed on the request Log and block Log only Disable detection
|
|
222
222
|
|
|
223
|
-
<a id="action-223ae0"></a>• [`suspicious_bot_action`](#action-223ae0) - Optional String Defaults to `BLOCK`<br>Possible values are `BLOCK`, `REPORT`, `IGNORE`<br>[Enum: BLOCK|REPORT|IGNORE]
|
|
223
|
+
<a id="action-223ae0"></a>• [`suspicious_bot_action`](#action-223ae0) - Optional String Defaults to `BLOCK`<br>Possible values are `BLOCK`, `REPORT`, `IGNORE`<br>[Enum: BLOCK|REPORT|IGNORE] Action to be performed on the request Log and block Log only Disable detection
|
|
224
224
|
|
|
225
225
|
#### Detection Settings Signature Selection Setting
|
|
226
226
|
|
|
227
227
|
A [`signature_selection_setting`](#setting-306450) block (within [`detection_settings`](#detection-settings)) supports the following:
|
|
228
228
|
|
|
229
|
-
<a id="settings-72f64b"></a>• [`attack_type_settings`](#settings-72f64b) - Optional Block<br>
|
|
229
|
+
<a id="settings-72f64b"></a>• [`attack_type_settings`](#settings-72f64b) - Optional Block<br>Specifies attack-type settings to be used by WAF<br>See [Attack Type Settings](#settings-72f64b) below.
|
|
230
230
|
|
|
231
|
-
<a id="settings-067018"></a>• [`default_attack_type_settings`](#settings-067018) - Optional Block<br>
|
|
231
|
+
<a id="settings-067018"></a>• [`default_attack_type_settings`](#settings-067018) - Optional Block<br>Can be used for messages where no values are needed
|
|
232
232
|
|
|
233
|
-
<a id="signatures-38e545"></a>• [`high_medium_accuracy_signatures`](#signatures-38e545) - Optional Block<br>
|
|
233
|
+
<a id="signatures-38e545"></a>• [`high_medium_accuracy_signatures`](#signatures-38e545) - Optional Block<br>Can be used for messages where no values are needed
|
|
234
234
|
|
|
235
|
-
<a id="signatures-b902f3"></a>• [`high_medium_low_accuracy_signatures`](#signatures-b902f3) - Optional Block<br>
|
|
235
|
+
<a id="signatures-b902f3"></a>• [`high_medium_low_accuracy_signatures`](#signatures-b902f3) - Optional Block<br>Can be used for messages where no values are needed
|
|
236
236
|
|
|
237
|
-
<a id="signatures-a0c47d"></a>• [`only_high_accuracy_signatures`](#signatures-a0c47d) - Optional Block<br>
|
|
237
|
+
<a id="signatures-a0c47d"></a>• [`only_high_accuracy_signatures`](#signatures-a0c47d) - Optional Block<br>Can be used for messages where no values are needed
|
|
238
238
|
|
|
239
239
|
#### Detection Settings Signature Selection Setting Attack Type Settings
|
|
240
240
|
|
|
@@ -244,19 +244,19 @@ A [`signature_selection_setting`](#setting-306450) block (within [`detection_set
|
|
|
244
244
|
|
|
245
245
|
A [`stage_new_and_updated_signatures`](#signatures-2278ab) block (within [`detection_settings`](#detection-settings)) supports the following:
|
|
246
246
|
|
|
247
|
-
<a id="period-dbffd2"></a>• [`staging_period`](#period-dbffd2) - Optional Number<br>
|
|
247
|
+
<a id="period-dbffd2"></a>• [`staging_period`](#period-dbffd2) - Optional Number<br>Define staging period in days. The default staging period is 7 days and the max supported staging period is 20 days
|
|
248
248
|
|
|
249
249
|
#### Detection Settings Stage New Signatures
|
|
250
250
|
|
|
251
251
|
A [`stage_new_signatures`](#detection-settings-stage-new-signatures) block (within [`detection_settings`](#detection-settings)) supports the following:
|
|
252
252
|
|
|
253
|
-
<a id="period-627ff7"></a>• [`staging_period`](#period-627ff7) - Optional Number<br>
|
|
253
|
+
<a id="period-627ff7"></a>• [`staging_period`](#period-627ff7) - Optional Number<br>Define staging period in days. The default staging period is 7 days and the max supported staging period is 20 days
|
|
254
254
|
|
|
255
255
|
#### Detection Settings Violation Settings
|
|
256
256
|
|
|
257
257
|
A [`violation_settings`](#detection-settings-violation-settings) block (within [`detection_settings`](#detection-settings)) supports the following:
|
|
258
258
|
|
|
259
|
-
<a id="types-5a07a0"></a>• [`disabled_violation_types`](#types-5a07a0) - Optional List Defaults to `VIOL_NONE`<br>Possible values are `VIOL_NONE`, `VIOL_FILETYPE`, `VIOL_METHOD`, `VIOL_MANDATORY_HEADER`, `VIOL_HTTP_RESPONSE_STATUS`, `VIOL_REQUEST_MAX_LENGTH`, `VIOL_FILE_UPLOAD`, `VIOL_FILE_UPLOAD_IN_BODY`, `VIOL_XML_MALFORMED`, `VIOL_JSON_MALFORMED`, `VIOL_ASM_COOKIE_MODIFIED`, `VIOL_HTTP_PROTOCOL_MULTIPLE_HOST_HEADERS`, `VIOL_HTTP_PROTOCOL_BAD_HOST_HEADER_VALUE`, `VIOL_HTTP_PROTOCOL_UNPARSABLE_REQUEST_CONTENT`, `VIOL_HTTP_PROTOCOL_NULL_IN_REQUEST`, `VIOL_HTTP_PROTOCOL_BAD_HTTP_VERSION`, `VIOL_HTTP_PROTOCOL_SEVERAL_CONTENT_LENGTH_HEADERS`, `VIOL_EVASION_DIRECTORY_TRAVERSALS`, `VIOL_MALFORMED_REQUEST`, `VIOL_EVASION_MULTIPLE_DECODING`, `VIOL_DATA_GUARD`, `VIOL_EVASION_APACHE_WHITESPACE`, `VIOL_COOKIE_MODIFIED`, `VIOL_EVASION_IIS_UNICODE_CODEPOINTS`, `VIOL_EVASION_IIS_BACKSLASHES`, `VIOL_EVASION_PERCENT_U_DECODING`, `VIOL_EVASION_BARE_BYTE_DECODING`, `VIOL_EVASION_BAD_UNESCAPE`, `VIOL_HTTP_PROTOCOL_BODY_IN_GET_OR_HEAD_REQUEST`, `VIOL_ENCODING`, `VIOL_COOKIE_MALFORMED`, `VIOL_GRAPHQL_FORMAT`, `VIOL_GRAPHQL_MALFORMED`, `VIOL_GRAPHQL_INTROSPECTION_QUERY`<br>[Enum: VIOL_NONE|VIOL_FILETYPE|VIOL_METHOD|VIOL_MANDATORY_HEADER|VIOL_HTTP_RESPONSE_STATUS|VIOL_REQUEST_MAX_LENGTH|VIOL_FILE_UPLOAD|VIOL_FILE_UPLOAD_IN_BODY|VIOL_XML_MALFORMED|VIOL_JSON_MALFORMED|VIOL_ASM_COOKIE_MODIFIED|VIOL_HTTP_PROTOCOL_MULTIPLE_HOST_HEADERS|VIOL_HTTP_PROTOCOL_BAD_HOST_HEADER_VALUE|VIOL_HTTP_PROTOCOL_UNPARSABLE_REQUEST_CONTENT|VIOL_HTTP_PROTOCOL_NULL_IN_REQUEST|VIOL_HTTP_PROTOCOL_BAD_HTTP_VERSION|VIOL_HTTP_PROTOCOL_SEVERAL_CONTENT_LENGTH_HEADERS|VIOL_EVASION_DIRECTORY_TRAVERSALS|VIOL_MALFORMED_REQUEST|VIOL_EVASION_MULTIPLE_DECODING|VIOL_DATA_GUARD|VIOL_EVASION_APACHE_WHITESPACE|VIOL_COOKIE_MODIFIED|VIOL_EVASION_IIS_UNICODE_CODEPOINTS|VIOL_EVASION_IIS_BACKSLASHES|VIOL_EVASION_PERCENT_U_DECODING|VIOL_EVASION_BARE_BYTE_DECODING|VIOL_EVASION_BAD_UNESCAPE|VIOL_HTTP_PROTOCOL_BODY_IN_GET_OR_HEAD_REQUEST|VIOL_ENCODING|VIOL_COOKIE_MALFORMED|VIOL_GRAPHQL_FORMAT|VIOL_GRAPHQL_MALFORMED|VIOL_GRAPHQL_INTROSPECTION_QUERY]
|
|
259
|
+
<a id="types-5a07a0"></a>• [`disabled_violation_types`](#types-5a07a0) - Optional List Defaults to `VIOL_NONE`<br>Possible values are `VIOL_NONE`, `VIOL_FILETYPE`, `VIOL_METHOD`, `VIOL_MANDATORY_HEADER`, `VIOL_HTTP_RESPONSE_STATUS`, `VIOL_REQUEST_MAX_LENGTH`, `VIOL_FILE_UPLOAD`, `VIOL_FILE_UPLOAD_IN_BODY`, `VIOL_XML_MALFORMED`, `VIOL_JSON_MALFORMED`, `VIOL_ASM_COOKIE_MODIFIED`, `VIOL_HTTP_PROTOCOL_MULTIPLE_HOST_HEADERS`, `VIOL_HTTP_PROTOCOL_BAD_HOST_HEADER_VALUE`, `VIOL_HTTP_PROTOCOL_UNPARSABLE_REQUEST_CONTENT`, `VIOL_HTTP_PROTOCOL_NULL_IN_REQUEST`, `VIOL_HTTP_PROTOCOL_BAD_HTTP_VERSION`, `VIOL_HTTP_PROTOCOL_SEVERAL_CONTENT_LENGTH_HEADERS`, `VIOL_EVASION_DIRECTORY_TRAVERSALS`, `VIOL_MALFORMED_REQUEST`, `VIOL_EVASION_MULTIPLE_DECODING`, `VIOL_DATA_GUARD`, `VIOL_EVASION_APACHE_WHITESPACE`, `VIOL_COOKIE_MODIFIED`, `VIOL_EVASION_IIS_UNICODE_CODEPOINTS`, `VIOL_EVASION_IIS_BACKSLASHES`, `VIOL_EVASION_PERCENT_U_DECODING`, `VIOL_EVASION_BARE_BYTE_DECODING`, `VIOL_EVASION_BAD_UNESCAPE`, `VIOL_HTTP_PROTOCOL_BODY_IN_GET_OR_HEAD_REQUEST`, `VIOL_ENCODING`, `VIOL_COOKIE_MALFORMED`, `VIOL_GRAPHQL_FORMAT`, `VIOL_GRAPHQL_MALFORMED`, `VIOL_GRAPHQL_INTROSPECTION_QUERY`<br>[Enum: VIOL_NONE|VIOL_FILETYPE|VIOL_METHOD|VIOL_MANDATORY_HEADER|VIOL_HTTP_RESPONSE_STATUS|VIOL_REQUEST_MAX_LENGTH|VIOL_FILE_UPLOAD|VIOL_FILE_UPLOAD_IN_BODY|VIOL_XML_MALFORMED|VIOL_JSON_MALFORMED|VIOL_ASM_COOKIE_MODIFIED|VIOL_HTTP_PROTOCOL_MULTIPLE_HOST_HEADERS|VIOL_HTTP_PROTOCOL_BAD_HOST_HEADER_VALUE|VIOL_HTTP_PROTOCOL_UNPARSABLE_REQUEST_CONTENT|VIOL_HTTP_PROTOCOL_NULL_IN_REQUEST|VIOL_HTTP_PROTOCOL_BAD_HTTP_VERSION|VIOL_HTTP_PROTOCOL_SEVERAL_CONTENT_LENGTH_HEADERS|VIOL_EVASION_DIRECTORY_TRAVERSALS|VIOL_MALFORMED_REQUEST|VIOL_EVASION_MULTIPLE_DECODING|VIOL_DATA_GUARD|VIOL_EVASION_APACHE_WHITESPACE|VIOL_COOKIE_MODIFIED|VIOL_EVASION_IIS_UNICODE_CODEPOINTS|VIOL_EVASION_IIS_BACKSLASHES|VIOL_EVASION_PERCENT_U_DECODING|VIOL_EVASION_BARE_BYTE_DECODING|VIOL_EVASION_BAD_UNESCAPE|VIOL_HTTP_PROTOCOL_BODY_IN_GET_OR_HEAD_REQUEST|VIOL_ENCODING|VIOL_COOKIE_MALFORMED|VIOL_GRAPHQL_FORMAT|VIOL_GRAPHQL_MALFORMED|VIOL_GRAPHQL_INTROSPECTION_QUERY] List of violations to be excluded
|
|
260
260
|
|
|
261
261
|
#### Timeouts
|
|
262
262
|
|
|
@@ -32,15 +32,15 @@ resource "f5xc_app_setting" "example" {
|
|
|
32
32
|
}
|
|
33
33
|
|
|
34
34
|
# Resource-specific configuration
|
|
35
|
-
#
|
|
35
|
+
# List of settings to enable for each AppType, given instan...
|
|
36
36
|
app_type_settings {
|
|
37
37
|
# Configure app_type_settings settings
|
|
38
38
|
}
|
|
39
|
-
#
|
|
39
|
+
# The AppType of App instance in current Namespace. Associa...
|
|
40
40
|
app_type_ref {
|
|
41
41
|
# Configure app_type_ref settings
|
|
42
42
|
}
|
|
43
|
-
#
|
|
43
|
+
# Settings specifying how API Discovery will be performed.
|
|
44
44
|
business_logic_markup_setting {
|
|
45
45
|
# Configure business_logic_markup_setting settings
|
|
46
46
|
}
|
|
@@ -66,7 +66,7 @@ resource "f5xc_app_setting" "example" {
|
|
|
66
66
|
|
|
67
67
|
### Spec Argument Reference
|
|
68
68
|
|
|
69
|
-
<a id="app-type-settings"></a>• [`app_type_settings`](#app-type-settings) - Optional Block<br>
|
|
69
|
+
<a id="app-type-settings"></a>• [`app_type_settings`](#app-type-settings) - Optional Block<br>List of settings to enable for each AppType, given instance of AppType Exist in this Namespace<br>See [App Type Settings](#app-type-settings) below for details.
|
|
70
70
|
|
|
71
71
|
<a id="timeouts"></a>• [`timeouts`](#timeouts) - Optional Block<br>See [Timeouts](#timeouts) below for details.
|
|
72
72
|
|
|
@@ -82,41 +82,41 @@ In addition to all arguments above, the following attributes are exported:
|
|
|
82
82
|
|
|
83
83
|
An [`app_type_settings`](#app-type-settings) block supports the following:
|
|
84
84
|
|
|
85
|
-
<a id="app-type-settings-app-type-ref"></a>• [`app_type_ref`](#app-type-settings-app-type-ref) - Optional Block<br>
|
|
85
|
+
<a id="app-type-settings-app-type-ref"></a>• [`app_type_ref`](#app-type-settings-app-type-ref) - Optional Block<br>The AppType of App instance in current Namespace. Associating an AppType reference, will enable analysis on this instance's generated data<br>See [App Type Ref](#app-type-settings-app-type-ref) below.
|
|
86
86
|
|
|
87
|
-
<a id="setting-ebbad6"></a>• [`business_logic_markup_setting`](#setting-ebbad6) - Optional Block<br>
|
|
87
|
+
<a id="setting-ebbad6"></a>• [`business_logic_markup_setting`](#setting-ebbad6) - Optional Block<br>Settings specifying how API Discovery will be performed<br>See [Business Logic Markup Setting](#setting-ebbad6) below.
|
|
88
88
|
|
|
89
89
|
<a id="setting-7d0042"></a>• [`timeseries_analyses_setting`](#setting-7d0042) - Optional Block<br>DDOS Settings. Configuration for DDOS Detection<br>See [Timeseries Analyses Setting](#setting-7d0042) below.
|
|
90
90
|
|
|
91
|
-
<a id="setting-2c7217"></a>• [`user_behavior_analysis_setting`](#setting-2c7217) - Optional Block<br>
|
|
91
|
+
<a id="setting-2c7217"></a>• [`user_behavior_analysis_setting`](#setting-2c7217) - Optional Block<br>Configuration for user behavior analysis<br>See [User Behavior Analysis Setting](#setting-2c7217) below.
|
|
92
92
|
|
|
93
93
|
#### App Type Settings App Type Ref
|
|
94
94
|
|
|
95
95
|
An [`app_type_ref`](#app-type-settings-app-type-ref) block (within [`app_type_settings`](#app-type-settings)) supports the following:
|
|
96
96
|
|
|
97
|
-
<a id="app-type-settings-app-type-ref-kind"></a>• [`kind`](#app-type-settings-app-type-ref-kind) - Optional String<br>
|
|
97
|
+
<a id="app-type-settings-app-type-ref-kind"></a>• [`kind`](#app-type-settings-app-type-ref-kind) - Optional String<br>When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object's kind (e.g. 'route')
|
|
98
98
|
|
|
99
|
-
<a id="app-type-settings-app-type-ref-name"></a>• [`name`](#app-type-settings-app-type-ref-name) - Optional String<br>
|
|
99
|
+
<a id="app-type-settings-app-type-ref-name"></a>• [`name`](#app-type-settings-app-type-ref-name) - Optional String<br>When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g. Route's) name
|
|
100
100
|
|
|
101
|
-
<a id="namespace-49608f"></a>• [`namespace`](#namespace-49608f) - Optional String<br>
|
|
101
|
+
<a id="namespace-49608f"></a>• [`namespace`](#namespace-49608f) - Optional String<br>When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g. Route's) namespace
|
|
102
102
|
|
|
103
|
-
<a id="app-type-settings-app-type-ref-tenant"></a>• [`tenant`](#app-type-settings-app-type-ref-tenant) - Optional String<br>
|
|
103
|
+
<a id="app-type-settings-app-type-ref-tenant"></a>• [`tenant`](#app-type-settings-app-type-ref-tenant) - Optional String<br>When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object's(e.g. Route's) tenant
|
|
104
104
|
|
|
105
|
-
<a id="app-type-settings-app-type-ref-uid"></a>• [`uid`](#app-type-settings-app-type-ref-uid) - Optional String<br>
|
|
105
|
+
<a id="app-type-settings-app-type-ref-uid"></a>• [`uid`](#app-type-settings-app-type-ref-uid) - Optional String<br>When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object's(e.g. Route's) uid
|
|
106
106
|
|
|
107
107
|
#### App Type Settings Business Logic Markup Setting
|
|
108
108
|
|
|
109
109
|
A [`business_logic_markup_setting`](#setting-ebbad6) block (within [`app_type_settings`](#app-type-settings)) supports the following:
|
|
110
110
|
|
|
111
|
-
<a id="disable-d65146"></a>• [`disable`](#disable-d65146) - Optional Block<br>
|
|
111
|
+
<a id="disable-d65146"></a>• [`disable`](#disable-d65146) - Optional Block<br>Can be used for messages where no values are needed
|
|
112
112
|
|
|
113
|
-
<a id="enable-280dfb"></a>• [`enable`](#enable-280dfb) - Optional Block<br>
|
|
113
|
+
<a id="enable-280dfb"></a>• [`enable`](#enable-280dfb) - Optional Block<br>Can be used for messages where no values are needed
|
|
114
114
|
|
|
115
115
|
#### App Type Settings Timeseries Analyses Setting
|
|
116
116
|
|
|
117
117
|
A [`timeseries_analyses_setting`](#setting-7d0042) block (within [`app_type_settings`](#app-type-settings)) supports the following:
|
|
118
118
|
|
|
119
|
-
<a id="selectors-2cc4b7"></a>• [`metric_selectors`](#selectors-2cc4b7) - Optional Block<br>
|
|
119
|
+
<a id="selectors-2cc4b7"></a>• [`metric_selectors`](#selectors-2cc4b7) - Optional Block<br>Define the metric selection criteria, i.e. The metrics source and the actual metrics that should be included in the detection logic<br>See [Metric Selectors](#selectors-2cc4b7) below.
|
|
120
120
|
|
|
121
121
|
#### App Type Settings Timeseries Analyses Setting Metric Selectors
|
|
122
122
|
|
|
@@ -126,13 +126,13 @@ A [`timeseries_analyses_setting`](#setting-7d0042) block (within [`app_type_sett
|
|
|
126
126
|
|
|
127
127
|
An [`user_behavior_analysis_setting`](#setting-2c7217) block (within [`app_type_settings`](#app-type-settings)) supports the following:
|
|
128
128
|
|
|
129
|
-
<a id="detection-dd4d64"></a>• [`disable_detection`](#detection-dd4d64) - Optional Block<br>
|
|
129
|
+
<a id="detection-dd4d64"></a>• [`disable_detection`](#detection-dd4d64) - Optional Block<br>Can be used for messages where no values are needed
|
|
130
130
|
|
|
131
|
-
<a id="learning-b549ee"></a>• [`disable_learning`](#learning-b549ee) - Optional Block<br>
|
|
131
|
+
<a id="learning-b549ee"></a>• [`disable_learning`](#learning-b549ee) - Optional Block<br>Can be used for messages where no values are needed
|
|
132
132
|
|
|
133
|
-
<a id="detection-4127d2"></a>• [`enable_detection`](#detection-4127d2) - Optional Block<br>
|
|
133
|
+
<a id="detection-4127d2"></a>• [`enable_detection`](#detection-4127d2) - Optional Block<br>Various factors about user activity are monitored and analysed to determine malicious users. These settings allow tuning those factors used by the system to detect malicious users<br>See [Enable Detection](#detection-4127d2) below.
|
|
134
134
|
|
|
135
|
-
<a id="learning-94d2dc"></a>• [`enable_learning`](#learning-94d2dc) - Optional Block<br>
|
|
135
|
+
<a id="learning-94d2dc"></a>• [`enable_learning`](#learning-94d2dc) - Optional Block<br>Can be used for messages where no values are needed
|
|
136
136
|
|
|
137
137
|
#### App Type Settings User Behavior Analysis Setting Enable Detection
|
|
138
138
|
|
|
@@ -32,11 +32,11 @@ resource "f5xc_app_type" "example" {
|
|
|
32
32
|
}
|
|
33
33
|
|
|
34
34
|
# Resource-specific configuration
|
|
35
|
-
#
|
|
35
|
+
# Settings specifying how API Discovery will be performed.
|
|
36
36
|
business_logic_markup_setting {
|
|
37
37
|
# Configure business_logic_markup_setting settings
|
|
38
38
|
}
|
|
39
|
-
#
|
|
39
|
+
# Can be used for messages where no values are needed.
|
|
40
40
|
disable {
|
|
41
41
|
# Configure disable settings
|
|
42
42
|
}
|
|
@@ -66,7 +66,7 @@ resource "f5xc_app_type" "example" {
|
|
|
66
66
|
|
|
67
67
|
### Spec Argument Reference
|
|
68
68
|
|
|
69
|
-
<a id="business-logic-markup-setting"></a>• [`business_logic_markup_setting`](#business-logic-markup-setting) - Optional Block<br>
|
|
69
|
+
<a id="business-logic-markup-setting"></a>• [`business_logic_markup_setting`](#business-logic-markup-setting) - Optional Block<br>Settings specifying how API Discovery will be performed<br>See [Business Logic Markup Setting](#business-logic-markup-setting) below for details.
|
|
70
70
|
|
|
71
71
|
<a id="features"></a>• [`features`](#features) - Optional Block<br>Features. List of various AI/ML features enabled<br>See [Features](#features) below for details.
|
|
72
72
|
|
|
@@ -84,23 +84,23 @@ In addition to all arguments above, the following attributes are exported:
|
|
|
84
84
|
|
|
85
85
|
A [`business_logic_markup_setting`](#business-logic-markup-setting) block supports the following:
|
|
86
86
|
|
|
87
|
-
<a id="business-logic-markup-setting-disable"></a>• [`disable`](#business-logic-markup-setting-disable) - Optional Block<br>
|
|
87
|
+
<a id="business-logic-markup-setting-disable"></a>• [`disable`](#business-logic-markup-setting-disable) - Optional Block<br>Can be used for messages where no values are needed
|
|
88
88
|
|
|
89
89
|
<a id="settings-c32a65"></a>• [`discovered_api_settings`](#settings-c32a65) - Optional Block<br>Discovered API Settings. Configure Discovered API Settings<br>See [Discovered API Settings](#settings-c32a65) below.
|
|
90
90
|
|
|
91
|
-
<a id="business-logic-markup-setting-enable"></a>• [`enable`](#business-logic-markup-setting-enable) - Optional Block<br>
|
|
91
|
+
<a id="business-logic-markup-setting-enable"></a>• [`enable`](#business-logic-markup-setting-enable) - Optional Block<br>Can be used for messages where no values are needed
|
|
92
92
|
|
|
93
93
|
#### Business Logic Markup Setting Discovered API Settings
|
|
94
94
|
|
|
95
95
|
A [`discovered_api_settings`](#settings-c32a65) block (within [`business_logic_markup_setting`](#business-logic-markup-setting)) supports the following:
|
|
96
96
|
|
|
97
|
-
<a id="apis-85d7fa"></a>• [`purge_duration_for_inactive_discovered_apis`](#apis-85d7fa) - Optional Number<br>
|
|
97
|
+
<a id="apis-85d7fa"></a>• [`purge_duration_for_inactive_discovered_apis`](#apis-85d7fa) - Optional Number<br>Inactive discovered API will be deleted after configured duration
|
|
98
98
|
|
|
99
99
|
#### Features
|
|
100
100
|
|
|
101
101
|
A [`features`](#features) block supports the following:
|
|
102
102
|
|
|
103
|
-
<a id="features-type"></a>• [`type`](#features-type) - Optional String Defaults to `BUSINESS_LOGIC_MARKUP`<br>Possible values are `BUSINESS_LOGIC_MARKUP`, `TIMESERIES_ANOMALY_DETECTION`, `PER_REQ_ANOMALY_DETECTION`, `USER_BEHAVIOR_ANALYSIS`<br>[Enum: BUSINESS_LOGIC_MARKUP|TIMESERIES_ANOMALY_DETECTION|PER_REQ_ANOMALY_DETECTION|USER_BEHAVIOR_ANALYSIS]
|
|
103
|
+
<a id="features-type"></a>• [`type`](#features-type) - Optional String Defaults to `BUSINESS_LOGIC_MARKUP`<br>Possible values are `BUSINESS_LOGIC_MARKUP`, `TIMESERIES_ANOMALY_DETECTION`, `PER_REQ_ANOMALY_DETECTION`, `USER_BEHAVIOR_ANALYSIS`<br>[Enum: BUSINESS_LOGIC_MARKUP|TIMESERIES_ANOMALY_DETECTION|PER_REQ_ANOMALY_DETECTION|USER_BEHAVIOR_ANALYSIS] Enumeration for AI/ML features supported API Discovery enables generation of model for various API interactions between services of App type. Enable analysis of timeseries for various metric collected like requests, errors, latency etc. Enable anomaly detection per API request, i.e
|
|
104
104
|
|
|
105
105
|
#### Timeouts
|
|
106
106
|
|