@robinmordasiewicz/f5xc-terraform-mcp 3.10.2 → 3.10.4
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/log_receiver.md +2 -2
- package/dist/docs/data-sources/network_policy.md +2 -2
- package/dist/docs/data-sources/site.md +2 -2
- package/dist/docs/resources/advertise_policy.md +10 -10
- package/dist/docs/resources/alert_policy.md +9 -9
- package/dist/docs/resources/alert_receiver.md +4 -4
- package/dist/docs/resources/api_definition.md +2 -2
- package/dist/docs/resources/api_testing.md +6 -6
- package/dist/docs/resources/apm.md +8 -8
- package/dist/docs/resources/app_firewall.md +19 -19
- package/dist/docs/resources/app_setting.md +5 -5
- package/dist/docs/resources/app_type.md +3 -3
- package/dist/docs/resources/aws_tgw_site.md +50 -50
- package/dist/docs/resources/aws_vpc_site.md +66 -66
- package/dist/docs/resources/azure_vnet_site.md +93 -93
- package/dist/docs/resources/bgp.md +205 -37
- package/dist/docs/resources/bgp_routing_policy.md +7 -7
- package/dist/docs/resources/cdn_cache_rule.md +2 -2
- package/dist/docs/resources/cdn_loadbalancer.md +122 -122
- package/dist/docs/resources/cloud_connect.md +2 -2
- package/dist/docs/resources/cloud_credentials.md +2 -2
- package/dist/docs/resources/cloud_link.md +3 -3
- package/dist/docs/resources/cluster.md +18 -18
- package/dist/docs/resources/dc_cluster_group.md +4 -4
- package/dist/docs/resources/discovery.md +259 -8
- package/dist/docs/resources/dns_domain.md +2 -2
- package/dist/docs/resources/endpoint.md +5 -5
- package/dist/docs/resources/enhanced_firewall_policy.md +15 -15
- package/dist/docs/resources/external_connector.md +7 -7
- package/dist/docs/resources/fast_acl.md +166 -60
- package/dist/docs/resources/fast_acl_rule.md +2 -2
- package/dist/docs/resources/fleet.md +25 -25
- package/dist/docs/resources/forward_proxy_policy.md +15 -15
- package/dist/docs/resources/forwarding_class.md +5 -5
- package/dist/docs/resources/gcp_vpc_site.md +37 -37
- package/dist/docs/resources/global_log_receiver.md +104 -104
- package/dist/docs/resources/healthcheck.md +2 -2
- package/dist/docs/resources/http_loadbalancer.md +287 -287
- package/dist/docs/resources/log_receiver.md +44 -825
- package/dist/docs/resources/malicious_user_mitigation.md +6 -6
- package/dist/docs/resources/nat_policy.md +10 -10
- package/dist/docs/resources/network_connector.md +9 -9
- package/dist/docs/resources/network_firewall.md +3 -3
- package/dist/docs/resources/network_interface.md +28 -28
- package/dist/docs/resources/network_policy.md +217 -38
- package/dist/docs/resources/network_policy_view.md +16 -16
- package/dist/docs/resources/nfv_service.md +26 -26
- package/dist/docs/resources/origin_pool.md +48 -48
- package/dist/docs/resources/policy_based_routing.md +8 -8
- package/dist/docs/resources/protocol_inspection.md +4 -4
- package/dist/docs/resources/proxy.md +23 -23
- package/dist/docs/resources/rate_limiter.md +1 -1
- package/dist/docs/resources/rate_limiter_policy.md +8 -8
- package/dist/docs/resources/route.md +36 -36
- package/dist/docs/resources/secret_management_access.md +8 -8
- package/dist/docs/resources/securemesh_site.md +258 -1619
- package/dist/docs/resources/segment.md +4 -4
- package/dist/docs/resources/service_policy.md +44 -44
- package/dist/docs/resources/service_policy_rule.md +37 -37
- package/dist/docs/resources/site.md +244 -322
- package/dist/docs/resources/site_mesh_group.md +8 -8
- package/dist/docs/resources/subnet.md +5 -5
- package/dist/docs/resources/tcp_loadbalancer.md +37 -37
- package/dist/docs/resources/tunnel.md +4 -4
- package/dist/docs/resources/udp_loadbalancer.md +9 -9
- package/dist/docs/resources/user_identification.md +10 -10
- package/dist/docs/resources/virtual_host.md +42 -42
- package/dist/docs/resources/virtual_network.md +4 -4
- package/dist/docs/resources/voltstack_site.md +59 -59
- package/dist/docs/resources/waf_exclusion_policy.md +5 -5
- package/dist/docs/resources/workload.md +24 -24
- package/dist/metadata/resource-metadata.json +394 -948
- package/dist/metadata/validation-patterns.json +1 -1
- package/package.json +1 -1
|
@@ -79,11 +79,11 @@ resource "f5xc_cdn_loadbalancer" "example" {
|
|
|
79
79
|
|
|
80
80
|
-> **One of the following:**
|
|
81
81
|
• <a id="active-service-policies"></a>[`active_service_policies`](#active-service-policies) - Optional Block<br>Service Policy List. List of service policies<br>See [Active Service Policies](#active-service-policies) below for details.
|
|
82
|
-
<br><br>• <a id="no-service-policies"></a>[`no_service_policies`](#no-service-policies) - Optional Block<br>
|
|
82
|
+
<br><br>• <a id="no-service-policies"></a>[`no_service_policies`](#no-service-policies) - Optional Block<br>Enable this option
|
|
83
83
|
|
|
84
84
|
-> **One of the following:**
|
|
85
85
|
• <a id="api-rate-limit"></a>[`api_rate_limit`](#api-rate-limit) - Optional Block<br>APIRateLimit<br>See [API Rate Limit](#api-rate-limit) below for details.
|
|
86
|
-
<br><br>• <a id="disable-rate-limit"></a>[`disable_rate_limit`](#disable-rate-limit) - Optional Block<br>
|
|
86
|
+
<br><br>• <a id="disable-rate-limit"></a>[`disable_rate_limit`](#disable-rate-limit) - Optional Block<br>Enable this option
|
|
87
87
|
|
|
88
88
|
-> **One of the following:**
|
|
89
89
|
• <a id="api-specification"></a>[`api_specification`](#api-specification) - Optional Block<br>Settings for API specification (API definition, OpenAPI validation, etc.)
|
|
@@ -99,7 +99,7 @@ resource "f5xc_cdn_loadbalancer" "example" {
|
|
|
99
99
|
• <a id="captcha-challenge"></a>[`captcha_challenge`](#captcha-challenge) - Optional Block<br>Enables loadbalancer to perform captcha challenge Captcha challenge will be based on Google Recaptcha. With this feature enabled, only clients that pass the captcha challenge will be allowed to complete the HTTP request. When loadbalancer is configured to do Captcha Challenge, it will redirect
|
|
100
100
|
<br><br>• <a id="enable-challenge"></a>[`enable_challenge`](#enable-challenge) - Optional Block<br>Configure auto mitigation i.e risk based challenges for malicious users
|
|
101
101
|
<br><br>• <a id="js-challenge"></a>[`js_challenge`](#js-challenge) - Optional Block<br>Enables loadbalancer to perform client browser compatibility test by redirecting to a page with Javascript. With this feature enabled, only clients that are capable of executing Javascript(mostly browsers) will be allowed to complete the HTTP request. When loadbalancer is configured to do
|
|
102
|
-
<br><br>• <a id="no-challenge"></a>[`no_challenge`](#no-challenge) - Optional Block<br>
|
|
102
|
+
<br><br>• <a id="no-challenge"></a>[`no_challenge`](#no-challenge) - Optional Block<br>Enable this option
|
|
103
103
|
|
|
104
104
|
-> **One of the following:**
|
|
105
105
|
• <a id="client-side-defense"></a>[`client_side_defense`](#client-side-defense) - Optional Block<br>Defines various configuration OPTIONS for Client-Side Defense Policy
|
|
@@ -117,25 +117,25 @@ resource "f5xc_cdn_loadbalancer" "example" {
|
|
|
117
117
|
<a id="default-cache-action"></a>• [`default_cache_action`](#default-cache-action) - Optional Block<br>Default Cache Behaviour. This defines a Default Cache Action
|
|
118
118
|
|
|
119
119
|
-> **One of the following:**
|
|
120
|
-
• <a id="default-sensitive-data-policy"></a>[`default_sensitive_data_policy`](#default-sensitive-data-policy) - Optional Block<br>
|
|
120
|
+
• <a id="default-sensitive-data-policy"></a>[`default_sensitive_data_policy`](#default-sensitive-data-policy) - Optional Block<br>Enable this option
|
|
121
121
|
|
|
122
|
-
<a id="disable-api-definition"></a>• [`disable_api_definition`](#disable-api-definition) - Optional Block<br>
|
|
122
|
+
<a id="disable-api-definition"></a>• [`disable_api_definition`](#disable-api-definition) - Optional Block<br>Enable this option
|
|
123
123
|
|
|
124
124
|
-> **One of the following:**
|
|
125
|
-
• <a id="disable-api-discovery"></a>[`disable_api_discovery`](#disable-api-discovery) - Optional Block<br>
|
|
125
|
+
• <a id="disable-api-discovery"></a>[`disable_api_discovery`](#disable-api-discovery) - Optional Block<br>Enable this option
|
|
126
126
|
|
|
127
|
-
<a id="disable-client-side-defense"></a>• [`disable_client_side_defense`](#disable-client-side-defense) - Optional Block<br>
|
|
127
|
+
<a id="disable-client-side-defense"></a>• [`disable_client_side_defense`](#disable-client-side-defense) - Optional Block<br>Enable this option
|
|
128
128
|
|
|
129
129
|
-> **One of the following:**
|
|
130
|
-
• <a id="disable-ip-reputation"></a>[`disable_ip_reputation`](#disable-ip-reputation) - Optional Block<br>
|
|
130
|
+
• <a id="disable-ip-reputation"></a>[`disable_ip_reputation`](#disable-ip-reputation) - Optional Block<br>Enable this option
|
|
131
131
|
|
|
132
132
|
-> **One of the following:**
|
|
133
|
-
• <a id="disable-malicious-user-detection"></a>[`disable_malicious_user_detection`](#disable-malicious-user-detection) - Optional Block<br>
|
|
133
|
+
• <a id="disable-malicious-user-detection"></a>[`disable_malicious_user_detection`](#disable-malicious-user-detection) - Optional Block<br>Enable this option
|
|
134
134
|
|
|
135
135
|
-> **One of the following:**
|
|
136
|
-
• <a id="disable-threat-mesh"></a>[`disable_threat_mesh`](#disable-threat-mesh) - Optional Block<br>
|
|
136
|
+
• <a id="disable-threat-mesh"></a>[`disable_threat_mesh`](#disable-threat-mesh) - Optional Block<br>Enable this option
|
|
137
137
|
|
|
138
|
-
<a id="disable-waf"></a>• [`disable_waf`](#disable-waf) - Optional Block<br>
|
|
138
|
+
<a id="disable-waf"></a>• [`disable_waf`](#disable-waf) - Optional Block<br>Enable this option
|
|
139
139
|
|
|
140
140
|
<a id="domains"></a>• [`domains`](#domains) - Optional List<br>List of fully qualified domain names. The CDN Distribution will be setup for these FQDN name(s). [This can be a domain or a sub-domain]
|
|
141
141
|
|
|
@@ -143,9 +143,9 @@ resource "f5xc_cdn_loadbalancer" "example" {
|
|
|
143
143
|
|
|
144
144
|
<a id="enable-ip-reputation"></a>• [`enable_ip_reputation`](#enable-ip-reputation) - Optional Block<br>IP Threat Category List. List of IP threat categories
|
|
145
145
|
|
|
146
|
-
<a id="enable-malicious-user-detection"></a>• [`enable_malicious_user_detection`](#enable-malicious-user-detection) - Optional Block<br>
|
|
146
|
+
<a id="enable-malicious-user-detection"></a>• [`enable_malicious_user_detection`](#enable-malicious-user-detection) - Optional Block<br>Enable this option
|
|
147
147
|
|
|
148
|
-
<a id="enable-threat-mesh"></a>• [`enable_threat_mesh`](#enable-threat-mesh) - Optional Block<br>
|
|
148
|
+
<a id="enable-threat-mesh"></a>• [`enable_threat_mesh`](#enable-threat-mesh) - Optional Block<br>Enable this option
|
|
149
149
|
|
|
150
150
|
<a id="graphql-rules"></a>• [`graphql_rules`](#graphql-rules) - Optional Block<br>GraphQL is a query language and server-side runtime for APIs which provides a complete and understandable description of the data in API. GraphQL gives clients the power to ask for exactly what they need, makes it easier to evolve APIs over time, and enables powerful developer tools. Policy
|
|
151
151
|
|
|
@@ -158,8 +158,8 @@ resource "f5xc_cdn_loadbalancer" "example" {
|
|
|
158
158
|
<a id="jwt-validation"></a>• [`jwt_validation`](#jwt-validation) - Optional Block<br>JWT Validation stops JWT replay attacks and JWT tampering by cryptographically verifying incoming JWTs before they are passed to your API origin. JWT Validation will also stop requests with expired tokens or tokens that are not yet valid
|
|
159
159
|
|
|
160
160
|
-> **One of the following:**
|
|
161
|
-
• <a id="l7-ddos-action-block"></a>[`l7_ddos_action_block`](#l7-ddos-action-block) - Optional Block<br>
|
|
162
|
-
<br><br>• <a id="l7-ddos-action-default"></a>[`l7_ddos_action_default`](#l7-ddos-action-default) - Optional Block<br>
|
|
161
|
+
• <a id="l7-ddos-action-block"></a>[`l7_ddos_action_block`](#l7-ddos-action-block) - Optional Block<br>Enable this option
|
|
162
|
+
<br><br>• <a id="l7-ddos-action-default"></a>[`l7_ddos_action_default`](#l7-ddos-action-default) - Optional Block<br>Enable this option
|
|
163
163
|
|
|
164
164
|
<a id="l7-ddos-action-js-challenge"></a>• [`l7_ddos_action_js_challenge`](#l7-ddos-action-js-challenge) - Optional Block<br>Enables loadbalancer to perform client browser compatibility test by redirecting to a page with Javascript. With this feature enabled, only clients that are capable of executing Javascript(mostly browsers) will be allowed to complete the HTTP request. When loadbalancer is configured to do
|
|
165
165
|
|
|
@@ -175,19 +175,19 @@ resource "f5xc_cdn_loadbalancer" "example" {
|
|
|
175
175
|
|
|
176
176
|
<a id="sensitive-data-policy"></a>• [`sensitive_data_policy`](#sensitive-data-policy) - Optional Block<br>Sensitive Data Discovery. Settings for data type policy
|
|
177
177
|
|
|
178
|
-
<a id="service-policies-from-namespace"></a>• [`service_policies_from_namespace`](#service-policies-from-namespace) - Optional Block<br>
|
|
178
|
+
<a id="service-policies-from-namespace"></a>• [`service_policies_from_namespace`](#service-policies-from-namespace) - Optional Block<br>Enable this option
|
|
179
179
|
|
|
180
180
|
-> **One of the following:**
|
|
181
181
|
• <a id="slow-ddos-mitigation"></a>[`slow_ddos_mitigation`](#slow-ddos-mitigation) - Optional Block<br>'Slow and low' attacks tie up server resources, leaving none available for servicing requests from actual users
|
|
182
182
|
|
|
183
|
-
<a id="system-default-timeouts"></a>• [`system_default_timeouts`](#system-default-timeouts) - Optional Block<br>
|
|
183
|
+
<a id="system-default-timeouts"></a>• [`system_default_timeouts`](#system-default-timeouts) - Optional Block<br>Enable this option
|
|
184
184
|
|
|
185
185
|
<a id="timeouts"></a>• [`timeouts`](#timeouts) - Optional Block
|
|
186
186
|
|
|
187
187
|
<a id="trusted-clients"></a>• [`trusted_clients`](#trusted-clients) - Optional Block<br>Define rules to skip processing of one or more features such as WAF, Bot Defense etc
|
|
188
188
|
|
|
189
189
|
-> **One of the following:**
|
|
190
|
-
• <a id="user-id-client-ip"></a>[`user_id_client_ip`](#user-id-client-ip) - Optional Block<br>
|
|
190
|
+
• <a id="user-id-client-ip"></a>[`user_id_client_ip`](#user-id-client-ip) - Optional Block<br>Enable this option
|
|
191
191
|
<br><br>• <a id="user-identification"></a>[`user_identification`](#user-identification) - 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
|
|
192
192
|
|
|
193
193
|
<a id="waf-exclusion"></a>• [`waf_exclusion`](#waf-exclusion) - Optional Block<br>WAF Exclusion
|
|
@@ -228,7 +228,7 @@ An [`api_rate_limit`](#api-rate-limit) block supports the following:
|
|
|
228
228
|
|
|
229
229
|
<a id="api-rate-limit-ip-allowed-list"></a>• [`ip_allowed_list`](#api-rate-limit-ip-allowed-list) - Optional Block<br>List of IPv4 prefixes that represent an endpoint<br>See [IP Allowed List](#api-rate-limit-ip-allowed-list) below.
|
|
230
230
|
|
|
231
|
-
<a id="api-rate-limit-no-ip-allowed-list"></a>• [`no_ip_allowed_list`](#api-rate-limit-no-ip-allowed-list) - Optional Block<br>
|
|
231
|
+
<a id="api-rate-limit-no-ip-allowed-list"></a>• [`no_ip_allowed_list`](#api-rate-limit-no-ip-allowed-list) - Optional Block<br>Enable this option
|
|
232
232
|
|
|
233
233
|
<a id="api-rate-limit-server-url-rules"></a>• [`server_url_rules`](#api-rate-limit-server-url-rules) - Optional Block<br>Set of rules for entire domain or base path that contain multiple endpoints. Order is matter as it uses first match policy. For matching also specific endpoints you can use the API endpoint rules set bellow<br>See [Server URL Rules](#api-rate-limit-server-url-rules) below.
|
|
234
234
|
|
|
@@ -236,7 +236,7 @@ An [`api_rate_limit`](#api-rate-limit) block supports the following:
|
|
|
236
236
|
|
|
237
237
|
An [`api_endpoint_rules`](#api-rate-limit-api-endpoint-rules) block (within [`api_rate_limit`](#api-rate-limit)) supports the following:
|
|
238
238
|
|
|
239
|
-
<a id="domain-cf087c"></a>• [`any_domain`](#domain-cf087c) - Optional Block<br>
|
|
239
|
+
<a id="domain-cf087c"></a>• [`any_domain`](#domain-cf087c) - Optional Block<br>Enable this option
|
|
240
240
|
|
|
241
241
|
<a id="method-1e49b0"></a>• [`api_endpoint_method`](#method-1e49b0) - Optional Block<br>HTTP method matcher specifies a list of methods to match an input HTTP method. The match is considered successful if the input method is a member of the list. The result of the match based on the method list is inverted if invert_matcher is true<br>See [API Endpoint Method](#method-1e49b0) below.
|
|
242
242
|
|
|
@@ -458,7 +458,7 @@ An [`ip_allowed_list`](#api-rate-limit-ip-allowed-list) block (within [`api_rate
|
|
|
458
458
|
|
|
459
459
|
A [`server_url_rules`](#api-rate-limit-server-url-rules) block (within [`api_rate_limit`](#api-rate-limit)) supports the following:
|
|
460
460
|
|
|
461
|
-
<a id="domain-0747c9"></a>• [`any_domain`](#domain-0747c9) - Optional Block<br>
|
|
461
|
+
<a id="domain-0747c9"></a>• [`any_domain`](#domain-0747c9) - Optional Block<br>Enable this option
|
|
462
462
|
|
|
463
463
|
<a id="group-15c11a"></a>• [`api_group`](#group-15c11a) - Optional String<br>API groups derived from API Definition swaggers. For example oas-all-operations including all paths and methods from the swaggers, oas-base-URLs covering all requests under base-paths from the swaggers. Custom groups can be created if user tags paths or operations with 'x-F5 Distributed
|
|
464
464
|
|
|
@@ -572,7 +572,7 @@ An [`api_specification`](#api-specification) block supports the following:
|
|
|
572
572
|
|
|
573
573
|
<a id="list-23b577"></a>• [`validation_custom_list`](#list-23b577) - Optional Block<br>Define API groups, base paths, or API endpoints and their OpenAPI validation modes. Any other API-endpoint not listed will act according to 'Fall Through Mode'<br>See [Validation Custom List](#list-23b577) below.
|
|
574
574
|
|
|
575
|
-
<a id="api-specification-validation-disabled"></a>• [`validation_disabled`](#api-specification-validation-disabled) - Optional Block<br>
|
|
575
|
+
<a id="api-specification-validation-disabled"></a>• [`validation_disabled`](#api-specification-validation-disabled) - Optional Block<br>Enable this option
|
|
576
576
|
|
|
577
577
|
#### API Specification API Definition
|
|
578
578
|
|
|
@@ -618,13 +618,13 @@ A [`validation_all_spec_endpoints`](#endpoints-4158a4) block (within [`api_speci
|
|
|
618
618
|
|
|
619
619
|
A [`settings`](#settings-a83a93) block (within [`api_specification.validation_all_spec_endpoints`](#endpoints-4158a4)) supports the following:
|
|
620
620
|
|
|
621
|
-
<a id="validation-462f95"></a>• [`oversized_body_fail_validation`](#validation-462f95) - Optional Block<br>
|
|
621
|
+
<a id="validation-462f95"></a>• [`oversized_body_fail_validation`](#validation-462f95) - Optional Block<br>Enable this option
|
|
622
622
|
|
|
623
|
-
<a id="validation-7ffaab"></a>• [`oversized_body_skip_validation`](#validation-7ffaab) - Optional Block<br>
|
|
623
|
+
<a id="validation-7ffaab"></a>• [`oversized_body_skip_validation`](#validation-7ffaab) - Optional Block<br>Enable this option
|
|
624
624
|
|
|
625
625
|
<a id="custom-8254df"></a>• [`property_validation_settings_custom`](#custom-8254df) - Optional Block<br>Validation Property Settings. Custom property validation settings<br>See [Property Validation Settings Custom](#custom-8254df) below.
|
|
626
626
|
|
|
627
|
-
<a id="default-f746bd"></a>• [`property_validation_settings_default`](#default-f746bd) - Optional Block<br>
|
|
627
|
+
<a id="default-f746bd"></a>• [`property_validation_settings_default`](#default-f746bd) - Optional Block<br>Enable this option
|
|
628
628
|
|
|
629
629
|
#### API Specification Validation All Spec Endpoints Settings Property Validation Settings Custom
|
|
630
630
|
|
|
@@ -704,13 +704,13 @@ A [`validation_custom_list`](#list-23b577) block (within [`api_specification`](#
|
|
|
704
704
|
|
|
705
705
|
A [`settings`](#settings-940e64) block (within [`api_specification.validation_custom_list`](#list-23b577)) supports the following:
|
|
706
706
|
|
|
707
|
-
<a id="validation-cfaf7f"></a>• [`oversized_body_fail_validation`](#validation-cfaf7f) - Optional Block<br>
|
|
707
|
+
<a id="validation-cfaf7f"></a>• [`oversized_body_fail_validation`](#validation-cfaf7f) - Optional Block<br>Enable this option
|
|
708
708
|
|
|
709
|
-
<a id="validation-0639fa"></a>• [`oversized_body_skip_validation`](#validation-0639fa) - Optional Block<br>
|
|
709
|
+
<a id="validation-0639fa"></a>• [`oversized_body_skip_validation`](#validation-0639fa) - Optional Block<br>Enable this option
|
|
710
710
|
|
|
711
711
|
<a id="custom-8e6ea6"></a>• [`property_validation_settings_custom`](#custom-8e6ea6) - Optional Block<br>Validation Property Settings. Custom property validation settings<br>See [Property Validation Settings Custom](#custom-8e6ea6) below.
|
|
712
712
|
|
|
713
|
-
<a id="default-baec50"></a>• [`property_validation_settings_default`](#default-baec50) - Optional Block<br>
|
|
713
|
+
<a id="default-baec50"></a>• [`property_validation_settings_default`](#default-baec50) - Optional Block<br>Enable this option
|
|
714
714
|
|
|
715
715
|
#### API Specification Validation Custom List Settings Property Validation Settings Custom
|
|
716
716
|
|
|
@@ -738,7 +738,7 @@ A [`blocked_clients`](#blocked-clients) block supports the following:
|
|
|
738
738
|
|
|
739
739
|
<a id="blocked-clients-as-number"></a>• [`as_number`](#blocked-clients-as-number) - Optional Number<br>RFC 6793 defined 4-byte AS number
|
|
740
740
|
|
|
741
|
-
<a id="blocked-clients-bot-skip-processing"></a>• [`bot_skip_processing`](#blocked-clients-bot-skip-processing) - Optional Block<br>
|
|
741
|
+
<a id="blocked-clients-bot-skip-processing"></a>• [`bot_skip_processing`](#blocked-clients-bot-skip-processing) - Optional Block<br>Enable this option
|
|
742
742
|
|
|
743
743
|
<a id="blocked-clients-expiration-timestamp"></a>• [`expiration_timestamp`](#blocked-clients-expiration-timestamp) - Optional String<br>Specifies expiration_timestamp the RFC 3339 format timestamp at which the containing rule is considered to be logically expired. The rule continues to exist in the configuration but is not applied anymore
|
|
744
744
|
|
|
@@ -750,11 +750,11 @@ A [`blocked_clients`](#blocked-clients) block supports the following:
|
|
|
750
750
|
|
|
751
751
|
<a id="blocked-clients-metadata"></a>• [`metadata`](#blocked-clients-metadata) - Optional Block<br>MessageMetaType is metadata (common attributes) of a message that only certain messages have. This information is propagated to the metadata of a child object that gets created from the containing message during view processing. The information in this type can be specified by user during create<br>See [Metadata](#blocked-clients-metadata) below.
|
|
752
752
|
|
|
753
|
-
<a id="blocked-clients-skip-processing"></a>• [`skip_processing`](#blocked-clients-skip-processing) - Optional Block<br>
|
|
753
|
+
<a id="blocked-clients-skip-processing"></a>• [`skip_processing`](#blocked-clients-skip-processing) - Optional Block<br>Enable this option
|
|
754
754
|
|
|
755
755
|
<a id="blocked-clients-user-identifier"></a>• [`user_identifier`](#blocked-clients-user-identifier) - Optional String<br>Identify user based on user identifier. User identifier value needs to be copied from security event
|
|
756
756
|
|
|
757
|
-
<a id="blocked-clients-waf-skip-processing"></a>• [`waf_skip_processing`](#blocked-clients-waf-skip-processing) - Optional Block<br>
|
|
757
|
+
<a id="blocked-clients-waf-skip-processing"></a>• [`waf_skip_processing`](#blocked-clients-waf-skip-processing) - Optional Block<br>Enable this option
|
|
758
758
|
|
|
759
759
|
#### Blocked Clients HTTP Header
|
|
760
760
|
|
|
@@ -788,9 +788,9 @@ A [`metadata`](#blocked-clients-metadata) block (within [`blocked_clients`](#blo
|
|
|
788
788
|
|
|
789
789
|
A [`bot_defense`](#bot-defense) block supports the following:
|
|
790
790
|
|
|
791
|
-
<a id="bot-defense-disable-cors-support"></a>• [`disable_cors_support`](#bot-defense-disable-cors-support) - Optional Block<br>
|
|
791
|
+
<a id="bot-defense-disable-cors-support"></a>• [`disable_cors_support`](#bot-defense-disable-cors-support) - Optional Block<br>Enable this option
|
|
792
792
|
|
|
793
|
-
<a id="bot-defense-enable-cors-support"></a>• [`enable_cors_support`](#bot-defense-enable-cors-support) - Optional Block<br>
|
|
793
|
+
<a id="bot-defense-enable-cors-support"></a>• [`enable_cors_support`](#bot-defense-enable-cors-support) - Optional Block<br>Enable this option
|
|
794
794
|
|
|
795
795
|
<a id="bot-defense-policy"></a>• [`policy`](#bot-defense-policy) - Optional Block<br>Defines various configuration OPTIONS for Bot Defense policy<br>See [Policy](#bot-defense-policy) below.
|
|
796
796
|
|
|
@@ -802,9 +802,9 @@ A [`bot_defense`](#bot-defense) block supports the following:
|
|
|
802
802
|
|
|
803
803
|
A [`policy`](#bot-defense-policy) block (within [`bot_defense`](#bot-defense)) supports the following:
|
|
804
804
|
|
|
805
|
-
<a id="bot-defense-policy-disable-js-insert"></a>• [`disable_js_insert`](#bot-defense-policy-disable-js-insert) - Optional Block<br>
|
|
805
|
+
<a id="bot-defense-policy-disable-js-insert"></a>• [`disable_js_insert`](#bot-defense-policy-disable-js-insert) - Optional Block<br>Enable this option
|
|
806
806
|
|
|
807
|
-
<a id="bot-defense-policy-disable-mobile-sdk"></a>• [`disable_mobile_sdk`](#bot-defense-policy-disable-mobile-sdk) - Optional Block<br>
|
|
807
|
+
<a id="bot-defense-policy-disable-mobile-sdk"></a>• [`disable_mobile_sdk`](#bot-defense-policy-disable-mobile-sdk) - Optional Block<br>Enable this option
|
|
808
808
|
|
|
809
809
|
<a id="bot-defense-policy-javascript-mode"></a>• [`javascript_mode`](#bot-defense-policy-javascript-mode) - Optional String Defaults to `ASYNC_JS_NO_CACHING`<br>Possible values are `ASYNC_JS_NO_CACHING`, `ASYNC_JS_CACHING`, `SYNC_JS_NO_CACHING`, `SYNC_JS_CACHING`<br>[Enum: ASYNC_JS_NO_CACHING|ASYNC_JS_CACHING|SYNC_JS_NO_CACHING|SYNC_JS_CACHING] Web Client JavaScript Mode. Bot Defense JavaScript for telemetry collection is requested asynchronously, and it is non-cacheable Bot Defense JavaScript for telemetry collection is requested asynchronously, and it is cacheable Bot Defense JavaScript for telemetry collection is requested
|
|
810
810
|
|
|
@@ -874,7 +874,7 @@ A [`js_insertion_rules`](#bot-defense-policy-js-insertion-rules) block (within [
|
|
|
874
874
|
|
|
875
875
|
A [`rules`](#rules-15d983) block (within [`bot_defense.policy.js_insertion_rules`](#bot-defense-policy-js-insertion-rules)) supports the following:
|
|
876
876
|
|
|
877
|
-
<a id="domain-f27f00"></a>• [`any_domain`](#domain-f27f00) - Optional Block<br>
|
|
877
|
+
<a id="domain-f27f00"></a>• [`any_domain`](#domain-f27f00) - Optional Block<br>Enable this option
|
|
878
878
|
|
|
879
879
|
<a id="domain-834b0f"></a>• [`domain`](#domain-834b0f) - Optional Block<br>Domains. Domains names<br>See [Domain](#domain-834b0f) below.
|
|
880
880
|
|
|
@@ -918,9 +918,9 @@ A [`mobile_sdk_config`](#bot-defense-policy-mobile-sdk-config) block (within [`b
|
|
|
918
918
|
|
|
919
919
|
A [`protected_app_endpoints`](#endpoints-01a2f3) block (within [`bot_defense.policy`](#bot-defense-policy)) supports the following:
|
|
920
920
|
|
|
921
|
-
<a id="bots-cfdb6f"></a>• [`allow_good_bots`](#bots-cfdb6f) - Optional Block<br>
|
|
921
|
+
<a id="bots-cfdb6f"></a>• [`allow_good_bots`](#bots-cfdb6f) - Optional Block<br>Enable this option
|
|
922
922
|
|
|
923
|
-
<a id="domain-f4f253"></a>• [`any_domain`](#domain-f4f253) - Optional Block<br>
|
|
923
|
+
<a id="domain-f4f253"></a>• [`any_domain`](#domain-f4f253) - Optional Block<br>Enable this option
|
|
924
924
|
|
|
925
925
|
<a id="domain-18bf1a"></a>• [`domain`](#domain-18bf1a) - Optional Block<br>Domains. Domains names<br>See [Domain](#domain-18bf1a) below.
|
|
926
926
|
|
|
@@ -932,11 +932,11 @@ A [`protected_app_endpoints`](#endpoints-01a2f3) block (within [`bot_defense.pol
|
|
|
932
932
|
|
|
933
933
|
<a id="metadata-c93137"></a>• [`metadata`](#metadata-c93137) - Optional Block<br>MessageMetaType is metadata (common attributes) of a message that only certain messages have. This information is propagated to the metadata of a child object that gets created from the containing message during view processing. The information in this type can be specified by user during create<br>See [Metadata](#metadata-c93137) below.
|
|
934
934
|
|
|
935
|
-
<a id="bots-5c9c05"></a>• [`mitigate_good_bots`](#bots-5c9c05) - Optional Block<br>
|
|
935
|
+
<a id="bots-5c9c05"></a>• [`mitigate_good_bots`](#bots-5c9c05) - Optional Block<br>Enable this option
|
|
936
936
|
|
|
937
937
|
<a id="mitigation-cc96eb"></a>• [`mitigation`](#mitigation-cc96eb) - Optional Block<br>Modify Bot Defense behavior for a matching request<br>See [Mitigation](#mitigation-cc96eb) below.
|
|
938
938
|
|
|
939
|
-
<a id="mobile-2839a0"></a>• [`mobile`](#mobile-2839a0) - Optional Block<br>
|
|
939
|
+
<a id="mobile-2839a0"></a>• [`mobile`](#mobile-2839a0) - Optional Block<br>Enable this option
|
|
940
940
|
|
|
941
941
|
<a id="path-d5ee15"></a>• [`path`](#path-d5ee15) - Optional Block<br>Path match of the URI can be either be, Prefix match or exact match or regular expression match<br>See [Path](#path-d5ee15) below.
|
|
942
942
|
|
|
@@ -944,9 +944,9 @@ A [`protected_app_endpoints`](#endpoints-01a2f3) block (within [`bot_defense.pol
|
|
|
944
944
|
|
|
945
945
|
<a id="params-8f5791"></a>• [`query_params`](#params-8f5791) - Optional Block<br>List of predicates for all query parameters that need to be matched. The criteria for matching each query parameter are described in individual instances of QueryParameterMatcherType. The actual query parameter values are extracted from the request API as a list of strings for each query<br>See [Query Params](#params-8f5791) below.
|
|
946
946
|
|
|
947
|
-
<a id="label-a84f6e"></a>• [`undefined_flow_label`](#label-a84f6e) - Optional Block<br>
|
|
947
|
+
<a id="label-a84f6e"></a>• [`undefined_flow_label`](#label-a84f6e) - Optional Block<br>Enable this option
|
|
948
948
|
|
|
949
|
-
<a id="web-a33d3d"></a>• [`web`](#web-a33d3d) - Optional Block<br>
|
|
949
|
+
<a id="web-a33d3d"></a>• [`web`](#web-a33d3d) - Optional Block<br>Enable this option
|
|
950
950
|
|
|
951
951
|
<a id="mobile-0ffdfb"></a>• [`web_mobile`](#mobile-0ffdfb) - Optional Block<br>Web and Mobile traffic type. Web and Mobile traffic type<br>See [Web Mobile](#mobile-0ffdfb) below.
|
|
952
952
|
|
|
@@ -1012,9 +1012,9 @@ A [`domain`](#domain-18bf1a) block (within [`bot_defense.policy.protected_app_en
|
|
|
1012
1012
|
|
|
1013
1013
|
A [`headers`](#headers-986193) block (within [`bot_defense.policy.protected_app_endpoints`](#endpoints-01a2f3)) supports the following:
|
|
1014
1014
|
|
|
1015
|
-
<a id="present-2e9857"></a>• [`check_not_present`](#present-2e9857) - Optional Block<br>
|
|
1015
|
+
<a id="present-2e9857"></a>• [`check_not_present`](#present-2e9857) - Optional Block<br>Enable this option
|
|
1016
1016
|
|
|
1017
|
-
<a id="present-3a1075"></a>• [`check_present`](#present-3a1075) - Optional Block<br>
|
|
1017
|
+
<a id="present-3a1075"></a>• [`check_present`](#present-3a1075) - Optional Block<br>Enable this option
|
|
1018
1018
|
|
|
1019
1019
|
<a id="matcher-66fb69"></a>• [`invert_matcher`](#matcher-66fb69) - Optional Bool<br>Invert Header Matcher. Invert the match result
|
|
1020
1020
|
|
|
@@ -1100,9 +1100,9 @@ A [`client_side_defense`](#client-side-defense) block supports the following:
|
|
|
1100
1100
|
|
|
1101
1101
|
A [`policy`](#client-side-defense-policy) block (within [`client_side_defense`](#client-side-defense)) supports the following:
|
|
1102
1102
|
|
|
1103
|
-
<a id="insert-683e69"></a>• [`disable_js_insert`](#insert-683e69) - Optional Block<br>
|
|
1103
|
+
<a id="insert-683e69"></a>• [`disable_js_insert`](#insert-683e69) - Optional Block<br>Enable this option
|
|
1104
1104
|
|
|
1105
|
-
<a id="pages-38bd1c"></a>• [`js_insert_all_pages`](#pages-38bd1c) - Optional Block<br>
|
|
1105
|
+
<a id="pages-38bd1c"></a>• [`js_insert_all_pages`](#pages-38bd1c) - Optional Block<br>Enable this option
|
|
1106
1106
|
|
|
1107
1107
|
<a id="except-7bfe85"></a>• [`js_insert_all_pages_except`](#except-7bfe85) - Optional Block<br>Insert Client-Side Defense JavaScript in all pages with the exceptions<br>See [Js Insert All Pages Except](#except-7bfe85) below.
|
|
1108
1108
|
|
|
@@ -1192,11 +1192,11 @@ A [`cors_policy`](#cors-policy) block supports the following:
|
|
|
1192
1192
|
|
|
1193
1193
|
A [`csrf_policy`](#csrf-policy) block supports the following:
|
|
1194
1194
|
|
|
1195
|
-
<a id="csrf-policy-all-load-balancer-domains"></a>• [`all_load_balancer_domains`](#csrf-policy-all-load-balancer-domains) - Optional Block<br>
|
|
1195
|
+
<a id="csrf-policy-all-load-balancer-domains"></a>• [`all_load_balancer_domains`](#csrf-policy-all-load-balancer-domains) - Optional Block<br>Enable this option
|
|
1196
1196
|
|
|
1197
1197
|
<a id="csrf-policy-custom-domain-list"></a>• [`custom_domain_list`](#csrf-policy-custom-domain-list) - Optional Block<br>List of domain names used for Host header matching<br>See [Custom Domain List](#csrf-policy-custom-domain-list) below.
|
|
1198
1198
|
|
|
1199
|
-
<a id="csrf-policy-disabled"></a>• [`disabled`](#csrf-policy-disabled) - Optional Block<br>
|
|
1199
|
+
<a id="csrf-policy-disabled"></a>• [`disabled`](#csrf-policy-disabled) - Optional Block<br>Enable this option
|
|
1200
1200
|
|
|
1201
1201
|
#### CSRF Policy Custom Domain List
|
|
1202
1202
|
|
|
@@ -1224,9 +1224,9 @@ A [`cdn_cache_rules`](#custom-cache-rule-cdn-cache-rules) block (within [`custom
|
|
|
1224
1224
|
|
|
1225
1225
|
A [`data_guard_rules`](#data-guard-rules) block supports the following:
|
|
1226
1226
|
|
|
1227
|
-
<a id="data-guard-rules-any-domain"></a>• [`any_domain`](#data-guard-rules-any-domain) - Optional Block<br>
|
|
1227
|
+
<a id="data-guard-rules-any-domain"></a>• [`any_domain`](#data-guard-rules-any-domain) - Optional Block<br>Enable this option
|
|
1228
1228
|
|
|
1229
|
-
<a id="data-guard-rules-apply-data-guard"></a>• [`apply_data_guard`](#data-guard-rules-apply-data-guard) - Optional Block<br>
|
|
1229
|
+
<a id="data-guard-rules-apply-data-guard"></a>• [`apply_data_guard`](#data-guard-rules-apply-data-guard) - Optional Block<br>Enable this option
|
|
1230
1230
|
|
|
1231
1231
|
<a id="data-guard-rules-exact-value"></a>• [`exact_value`](#data-guard-rules-exact-value) - Optional String<br>Exact domain name
|
|
1232
1232
|
|
|
@@ -1234,7 +1234,7 @@ A [`data_guard_rules`](#data-guard-rules) block supports the following:
|
|
|
1234
1234
|
|
|
1235
1235
|
<a id="data-guard-rules-path"></a>• [`path`](#data-guard-rules-path) - Optional Block<br>Path match of the URI can be either be, Prefix match or exact match or regular expression match<br>See [Path](#data-guard-rules-path) below.
|
|
1236
1236
|
|
|
1237
|
-
<a id="data-guard-rules-skip-data-guard"></a>• [`skip_data_guard`](#data-guard-rules-skip-data-guard) - Optional Block<br>
|
|
1237
|
+
<a id="data-guard-rules-skip-data-guard"></a>• [`skip_data_guard`](#data-guard-rules-skip-data-guard) - Optional Block<br>Enable this option
|
|
1238
1238
|
|
|
1239
1239
|
<a id="data-guard-rules-suffix-value"></a>• [`suffix_value`](#data-guard-rules-suffix-value) - Optional String<br>Suffix of domain name e.g 'xyz.com' will match '*.xyz.com' and 'xyz.com'
|
|
1240
1240
|
|
|
@@ -1260,7 +1260,7 @@ A [`path`](#data-guard-rules-path) block (within [`data_guard_rules`](#data-guar
|
|
|
1260
1260
|
|
|
1261
1261
|
A [`ddos_mitigation_rules`](#ddos-mitigation-rules) block supports the following:
|
|
1262
1262
|
|
|
1263
|
-
<a id="ddos-mitigation-rules-block"></a>• [`block`](#ddos-mitigation-rules-block) - Optional Block<br>
|
|
1263
|
+
<a id="ddos-mitigation-rules-block"></a>• [`block`](#ddos-mitigation-rules-block) - Optional Block<br>Enable this option
|
|
1264
1264
|
|
|
1265
1265
|
<a id="source-02aa55"></a>• [`ddos_client_source`](#source-02aa55) - Optional Block<br>DDOS Client Source Choice. DDOS Mitigation sources to be blocked<br>See [DDOS Client Source](#source-02aa55) below.
|
|
1266
1266
|
|
|
@@ -1314,7 +1314,7 @@ A [`metadata`](#ddos-mitigation-rules-metadata) block (within [`ddos_mitigation_
|
|
|
1314
1314
|
|
|
1315
1315
|
A [`default_cache_action`](#default-cache-action) block supports the following:
|
|
1316
1316
|
|
|
1317
|
-
<a id="default-cache-action-cache-disabled"></a>• [`cache_disabled`](#default-cache-action-cache-disabled) - Optional Block<br>
|
|
1317
|
+
<a id="default-cache-action-cache-disabled"></a>• [`cache_disabled`](#default-cache-action-cache-disabled) - Optional Block<br>Enable this option
|
|
1318
1318
|
|
|
1319
1319
|
<a id="default-cache-action-cache-ttl-default"></a>• [`cache_ttl_default`](#default-cache-action-cache-ttl-default) - Optional String<br>Use Cache TTL Provided by Origin, and set a contigency TTL value in case one is not provided
|
|
1320
1320
|
|
|
@@ -1330,13 +1330,13 @@ An [`enable_api_discovery`](#enable-api-discovery) block supports the following:
|
|
|
1330
1330
|
|
|
1331
1331
|
<a id="discovery-54db29"></a>• [`custom_api_auth_discovery`](#discovery-54db29) - Optional Block<br>API Discovery Advanced Settings. API Discovery Advanced settings<br>See [Custom API Auth Discovery](#discovery-54db29) below.
|
|
1332
1332
|
|
|
1333
|
-
<a id="discovery-29517f"></a>• [`default_api_auth_discovery`](#discovery-29517f) - Optional Block<br>
|
|
1333
|
+
<a id="discovery-29517f"></a>• [`default_api_auth_discovery`](#discovery-29517f) - Optional Block<br>Enable this option
|
|
1334
1334
|
|
|
1335
|
-
<a id="traffic-90c445"></a>• [`disable_learn_from_redirect_traffic`](#traffic-90c445) - Optional Block<br>
|
|
1335
|
+
<a id="traffic-90c445"></a>• [`disable_learn_from_redirect_traffic`](#traffic-90c445) - Optional Block<br>Enable this option
|
|
1336
1336
|
|
|
1337
1337
|
<a id="settings-c31c55"></a>• [`discovered_api_settings`](#settings-c31c55) - Optional Block<br>Discovered API Settings. Configure Discovered API Settings<br>See [Discovered API Settings](#settings-c31c55) below.
|
|
1338
1338
|
|
|
1339
|
-
<a id="traffic-074877"></a>• [`enable_learn_from_redirect_traffic`](#traffic-074877) - Optional Block<br>
|
|
1339
|
+
<a id="traffic-074877"></a>• [`enable_learn_from_redirect_traffic`](#traffic-074877) - Optional Block<br>Enable this option
|
|
1340
1340
|
|
|
1341
1341
|
#### Enable API Discovery API Crawler
|
|
1342
1342
|
|
|
@@ -1344,7 +1344,7 @@ An [`api_crawler`](#enable-api-discovery-api-crawler) block (within [`enable_api
|
|
|
1344
1344
|
|
|
1345
1345
|
<a id="config-1070d6"></a>• [`api_crawler_config`](#config-1070d6) - Optional Block<br>Crawler Configure<br>See [API Crawler Config](#config-1070d6) below.
|
|
1346
1346
|
|
|
1347
|
-
<a id="crawler-167f20"></a>• [`disable_api_crawler`](#crawler-167f20) - Optional Block<br>
|
|
1347
|
+
<a id="crawler-167f20"></a>• [`disable_api_crawler`](#crawler-167f20) - Optional Block<br>Enable this option
|
|
1348
1348
|
|
|
1349
1349
|
#### Enable API Discovery API Crawler API Crawler Config
|
|
1350
1350
|
|
|
@@ -1408,11 +1408,11 @@ An [`enable_challenge`](#enable-challenge) block supports the following:
|
|
|
1408
1408
|
|
|
1409
1409
|
<a id="parameters-13a9c7"></a>• [`captcha_challenge_parameters`](#parameters-13a9c7) - Optional Block<br>Enables loadbalancer to perform captcha challenge Captcha challenge will be based on Google Recaptcha. With this feature enabled, only clients that pass the captcha challenge will be allowed to complete the HTTP request. When loadbalancer is configured to do Captcha Challenge, it will redirect<br>See [Captcha Challenge Parameters](#parameters-13a9c7) below.
|
|
1410
1410
|
|
|
1411
|
-
<a id="parameters-247f74"></a>• [`default_captcha_challenge_parameters`](#parameters-247f74) - Optional Block<br>
|
|
1411
|
+
<a id="parameters-247f74"></a>• [`default_captcha_challenge_parameters`](#parameters-247f74) - Optional Block<br>Enable this option
|
|
1412
1412
|
|
|
1413
|
-
<a id="parameters-e2729d"></a>• [`default_js_challenge_parameters`](#parameters-e2729d) - Optional Block<br>
|
|
1413
|
+
<a id="parameters-e2729d"></a>• [`default_js_challenge_parameters`](#parameters-e2729d) - Optional Block<br>Enable this option
|
|
1414
1414
|
|
|
1415
|
-
<a id="settings-f4fda5"></a>• [`default_mitigation_settings`](#settings-f4fda5) - Optional Block<br>
|
|
1415
|
+
<a id="settings-f4fda5"></a>• [`default_mitigation_settings`](#settings-f4fda5) - Optional Block<br>Enable this option
|
|
1416
1416
|
|
|
1417
1417
|
<a id="parameters-6f7506"></a>• [`js_challenge_parameters`](#parameters-6f7506) - Optional Block<br>Enables loadbalancer to perform client browser compatibility test by redirecting to a page with Javascript. With this feature enabled, only clients that are capable of executing Javascript(mostly browsers) will be allowed to complete the HTTP request. When loadbalancer is configured to do<br>See [Js Challenge Parameters](#parameters-6f7506) below.
|
|
1418
1418
|
|
|
@@ -1456,7 +1456,7 @@ An [`enable_ip_reputation`](#enable-ip-reputation) block supports the following:
|
|
|
1456
1456
|
|
|
1457
1457
|
A [`graphql_rules`](#graphql-rules) block supports the following:
|
|
1458
1458
|
|
|
1459
|
-
<a id="graphql-rules-any-domain"></a>• [`any_domain`](#graphql-rules-any-domain) - Optional Block<br>
|
|
1459
|
+
<a id="graphql-rules-any-domain"></a>• [`any_domain`](#graphql-rules-any-domain) - Optional Block<br>Enable this option
|
|
1460
1460
|
|
|
1461
1461
|
<a id="graphql-rules-exact-path"></a>• [`exact_path`](#graphql-rules-exact-path) - Optional String Defaults to `/GraphQL`<br>Specifies the exact path to GraphQL endpoint
|
|
1462
1462
|
|
|
@@ -1466,9 +1466,9 @@ A [`graphql_rules`](#graphql-rules) block supports the following:
|
|
|
1466
1466
|
|
|
1467
1467
|
<a id="graphql-rules-metadata"></a>• [`metadata`](#graphql-rules-metadata) - Optional Block<br>MessageMetaType is metadata (common attributes) of a message that only certain messages have. This information is propagated to the metadata of a child object that gets created from the containing message during view processing. The information in this type can be specified by user during create<br>See [Metadata](#graphql-rules-metadata) below.
|
|
1468
1468
|
|
|
1469
|
-
<a id="graphql-rules-method-get"></a>• [`method_get`](#graphql-rules-method-get) - Optional Block<br>
|
|
1469
|
+
<a id="graphql-rules-method-get"></a>• [`method_get`](#graphql-rules-method-get) - Optional Block<br>Enable this option
|
|
1470
1470
|
|
|
1471
|
-
<a id="graphql-rules-method-post"></a>• [`method_post`](#graphql-rules-method-post) - Optional Block<br>
|
|
1471
|
+
<a id="graphql-rules-method-post"></a>• [`method_post`](#graphql-rules-method-post) - Optional Block<br>Enable this option
|
|
1472
1472
|
|
|
1473
1473
|
<a id="graphql-rules-suffix-value"></a>• [`suffix_value`](#graphql-rules-suffix-value) - Optional String<br>Suffix of domain name e.g 'xyz.com' will match '*.xyz.com' and 'xyz.com'
|
|
1474
1474
|
|
|
@@ -1476,9 +1476,9 @@ A [`graphql_rules`](#graphql-rules) block supports the following:
|
|
|
1476
1476
|
|
|
1477
1477
|
A [`graphql_settings`](#graphql-rules-graphql-settings) block (within [`graphql_rules`](#graphql-rules)) supports the following:
|
|
1478
1478
|
|
|
1479
|
-
<a id="introspection-492a5f"></a>• [`disable_introspection`](#introspection-492a5f) - Optional Block<br>
|
|
1479
|
+
<a id="introspection-492a5f"></a>• [`disable_introspection`](#introspection-492a5f) - Optional Block<br>Enable this option
|
|
1480
1480
|
|
|
1481
|
-
<a id="introspection-762fd0"></a>• [`enable_introspection`](#introspection-762fd0) - Optional Block<br>
|
|
1481
|
+
<a id="introspection-762fd0"></a>• [`enable_introspection`](#introspection-762fd0) - Optional Block<br>Enable this option
|
|
1482
1482
|
|
|
1483
1483
|
<a id="queries-f5cdb7"></a>• [`max_batched_queries`](#queries-f5cdb7) - Optional Number<br>Specify maximum number of queries in a single batched request
|
|
1484
1484
|
|
|
@@ -1528,7 +1528,7 @@ A [`tls_cert_params`](#https-tls-cert-options-tls-cert-params) block (within [`h
|
|
|
1528
1528
|
|
|
1529
1529
|
<a id="certificates-07e388"></a>• [`certificates`](#certificates-07e388) - Optional Block<br>Select one or more certificates with any domain names<br>See [Certificates](#certificates-07e388) below.
|
|
1530
1530
|
|
|
1531
|
-
<a id="mtls-5bfdd8"></a>• [`no_mtls`](#mtls-5bfdd8) - Optional Block<br>
|
|
1531
|
+
<a id="mtls-5bfdd8"></a>• [`no_mtls`](#mtls-5bfdd8) - Optional Block<br>Enable this option
|
|
1532
1532
|
|
|
1533
1533
|
<a id="config-904431"></a>• [`tls_config`](#config-904431) - Optional Block<br>Defines various OPTIONS to configure TLS configuration parameters<br>See [TLS Config](#config-904431) below.
|
|
1534
1534
|
|
|
@@ -1566,7 +1566,7 @@ A [`tls_cert_params`](#https-tls-cert-options-tls-cert-params) block (within [`h
|
|
|
1566
1566
|
|
|
1567
1567
|
A [`tls_inline_params`](#params-9a3f4e) block (within [`https.tls_cert_options`](#https-tls-cert-options)) supports the following:
|
|
1568
1568
|
|
|
1569
|
-
<a id="mtls-39e986"></a>• [`no_mtls`](#mtls-39e986) - Optional Block<br>
|
|
1569
|
+
<a id="mtls-39e986"></a>• [`no_mtls`](#mtls-39e986) - Optional Block<br>Enable this option
|
|
1570
1570
|
|
|
1571
1571
|
<a id="certificates-f306b2"></a>• [`tls_certificates`](#certificates-f306b2) - Optional Block<br>Users can add one or more certificates that share the same set of domains. For example, domain.com and \*.domain.com - but use different signature algorithms<br>See [TLS Certificates](#certificates-f306b2) below.
|
|
1572
1572
|
|
|
@@ -1632,9 +1632,9 @@ A [`https_auto_cert`](#https-auto-cert) block supports the following:
|
|
|
1632
1632
|
|
|
1633
1633
|
A [`tls_config`](#https-auto-cert-tls-config) block (within [`https_auto_cert`](#https-auto-cert)) supports the following:
|
|
1634
1634
|
|
|
1635
|
-
<a id="https-auto-cert-tls-config-tls-11-plus"></a>• [`tls_11_plus`](#https-auto-cert-tls-config-tls-11-plus) - Optional Block<br>
|
|
1635
|
+
<a id="https-auto-cert-tls-config-tls-11-plus"></a>• [`tls_11_plus`](#https-auto-cert-tls-config-tls-11-plus) - Optional Block<br>Enable this option
|
|
1636
1636
|
|
|
1637
|
-
<a id="https-auto-cert-tls-config-tls-12-plus"></a>• [`tls_12_plus`](#https-auto-cert-tls-config-tls-12-plus) - Optional Block<br>
|
|
1637
|
+
<a id="https-auto-cert-tls-config-tls-12-plus"></a>• [`tls_12_plus`](#https-auto-cert-tls-config-tls-12-plus) - Optional Block<br>Enable this option
|
|
1638
1638
|
|
|
1639
1639
|
#### Js Challenge
|
|
1640
1640
|
|
|
@@ -1666,9 +1666,9 @@ A [`jwt_validation`](#jwt-validation) block supports the following:
|
|
|
1666
1666
|
|
|
1667
1667
|
An [`action`](#jwt-validation-action) block (within [`jwt_validation`](#jwt-validation)) supports the following:
|
|
1668
1668
|
|
|
1669
|
-
<a id="jwt-validation-action-block"></a>• [`block`](#jwt-validation-action-block) - Optional Block<br>
|
|
1669
|
+
<a id="jwt-validation-action-block"></a>• [`block`](#jwt-validation-action-block) - Optional Block<br>Enable this option
|
|
1670
1670
|
|
|
1671
|
-
<a id="jwt-validation-action-report"></a>• [`report`](#jwt-validation-action-report) - Optional Block<br>
|
|
1671
|
+
<a id="jwt-validation-action-report"></a>• [`report`](#jwt-validation-action-report) - Optional Block<br>Enable this option
|
|
1672
1672
|
|
|
1673
1673
|
#### JWT Validation Jwks Config
|
|
1674
1674
|
|
|
@@ -1688,15 +1688,15 @@ A [`reserved_claims`](#jwt-validation-reserved-claims) block (within [`jwt_valid
|
|
|
1688
1688
|
|
|
1689
1689
|
<a id="jwt-validation-reserved-claims-audience"></a>• [`audience`](#jwt-validation-reserved-claims-audience) - Optional Block<br>Audiences<br>See [Audience](#jwt-validation-reserved-claims-audience) below.
|
|
1690
1690
|
|
|
1691
|
-
<a id="disable-dcfb50"></a>• [`audience_disable`](#disable-dcfb50) - Optional Block<br>
|
|
1691
|
+
<a id="disable-dcfb50"></a>• [`audience_disable`](#disable-dcfb50) - Optional Block<br>Enable this option
|
|
1692
1692
|
|
|
1693
1693
|
<a id="jwt-validation-reserved-claims-issuer"></a>• [`issuer`](#jwt-validation-reserved-claims-issuer) - Optional String<br>Exact Match
|
|
1694
1694
|
|
|
1695
|
-
<a id="disable-c89c1c"></a>• [`issuer_disable`](#disable-c89c1c) - Optional Block<br>
|
|
1695
|
+
<a id="disable-c89c1c"></a>• [`issuer_disable`](#disable-c89c1c) - Optional Block<br>Enable this option
|
|
1696
1696
|
|
|
1697
|
-
<a id="disable-5d3cb1"></a>• [`validate_period_disable`](#disable-5d3cb1) - Optional Block<br>
|
|
1697
|
+
<a id="disable-5d3cb1"></a>• [`validate_period_disable`](#disable-5d3cb1) - Optional Block<br>Enable this option
|
|
1698
1698
|
|
|
1699
|
-
<a id="enable-66243b"></a>• [`validate_period_enable`](#enable-66243b) - Optional Block<br>
|
|
1699
|
+
<a id="enable-66243b"></a>• [`validate_period_enable`](#enable-66243b) - Optional Block<br>Enable this option
|
|
1700
1700
|
|
|
1701
1701
|
#### JWT Validation Reserved Claims Audience
|
|
1702
1702
|
|
|
@@ -1708,7 +1708,7 @@ An [`audience`](#jwt-validation-reserved-claims-audience) block (within [`jwt_va
|
|
|
1708
1708
|
|
|
1709
1709
|
A [`target`](#jwt-validation-target) block (within [`jwt_validation`](#jwt-validation)) supports the following:
|
|
1710
1710
|
|
|
1711
|
-
<a id="jwt-validation-target-all-endpoint"></a>• [`all_endpoint`](#jwt-validation-target-all-endpoint) - Optional Block<br>
|
|
1711
|
+
<a id="jwt-validation-target-all-endpoint"></a>• [`all_endpoint`](#jwt-validation-target-all-endpoint) - Optional Block<br>Enable this option
|
|
1712
1712
|
|
|
1713
1713
|
<a id="jwt-validation-target-api-groups"></a>• [`api_groups`](#jwt-validation-target-api-groups) - Optional Block<br>API Groups<br>See [API Groups](#jwt-validation-target-api-groups) below.
|
|
1714
1714
|
|
|
@@ -1730,7 +1730,7 @@ A [`base_paths`](#jwt-validation-target-base-paths) block (within [`jwt_validati
|
|
|
1730
1730
|
|
|
1731
1731
|
A [`token_location`](#jwt-validation-token-location) block (within [`jwt_validation`](#jwt-validation)) supports the following:
|
|
1732
1732
|
|
|
1733
|
-
<a id="token-e5c0e3"></a>• [`bearer_token`](#token-e5c0e3) - Optional Block<br>
|
|
1733
|
+
<a id="token-e5c0e3"></a>• [`bearer_token`](#token-e5c0e3) - Optional Block<br>Enable this option
|
|
1734
1734
|
|
|
1735
1735
|
#### L7 DDOS Action Js Challenge
|
|
1736
1736
|
|
|
@@ -1748,7 +1748,7 @@ An [`origin_pool`](#origin-pool) block supports the following:
|
|
|
1748
1748
|
|
|
1749
1749
|
<a id="origin-pool-more-origin-options"></a>• [`more_origin_options`](#origin-pool-more-origin-options) - Optional Block<br>Origin Byte Range Request Config<br>See [More Origin Options](#origin-pool-more-origin-options) below.
|
|
1750
1750
|
|
|
1751
|
-
<a id="origin-pool-no-tls"></a>• [`no_tls`](#origin-pool-no-tls) - Optional Block<br>
|
|
1751
|
+
<a id="origin-pool-no-tls"></a>• [`no_tls`](#origin-pool-no-tls) - Optional Block<br>Enable this option
|
|
1752
1752
|
|
|
1753
1753
|
<a id="origin-pool-origin-request-timeout"></a>• [`origin_request_timeout`](#origin-pool-origin-request-timeout) - Optional String<br>Configures the time after which a request to the origin will time out waiting for a response
|
|
1754
1754
|
|
|
@@ -1802,23 +1802,23 @@ A [`public_name`](#origin-pool-public-name) block (within [`origin_pool`](#origi
|
|
|
1802
1802
|
|
|
1803
1803
|
An [`use_tls`](#origin-pool-use-tls) block (within [`origin_pool`](#origin-pool)) supports the following:
|
|
1804
1804
|
|
|
1805
|
-
<a id="caching-7b69f7"></a>• [`default_session_key_caching`](#caching-7b69f7) - Optional Block<br>
|
|
1805
|
+
<a id="caching-7b69f7"></a>• [`default_session_key_caching`](#caching-7b69f7) - Optional Block<br>Enable this option
|
|
1806
1806
|
|
|
1807
|
-
<a id="caching-486555"></a>• [`disable_session_key_caching`](#caching-486555) - Optional Block<br>
|
|
1807
|
+
<a id="caching-486555"></a>• [`disable_session_key_caching`](#caching-486555) - Optional Block<br>Enable this option
|
|
1808
1808
|
|
|
1809
|
-
<a id="origin-pool-use-tls-disable-sni"></a>• [`disable_sni`](#origin-pool-use-tls-disable-sni) - Optional Block<br>
|
|
1809
|
+
<a id="origin-pool-use-tls-disable-sni"></a>• [`disable_sni`](#origin-pool-use-tls-disable-sni) - Optional Block<br>Enable this option
|
|
1810
1810
|
|
|
1811
1811
|
<a id="origin-pool-use-tls-max-session-keys"></a>• [`max_session_keys`](#origin-pool-use-tls-max-session-keys) - Optional Number<br>Number of session keys that are cached
|
|
1812
1812
|
|
|
1813
|
-
<a id="origin-pool-use-tls-no-mtls"></a>• [`no_mtls`](#origin-pool-use-tls-no-mtls) - Optional Block<br>
|
|
1813
|
+
<a id="origin-pool-use-tls-no-mtls"></a>• [`no_mtls`](#origin-pool-use-tls-no-mtls) - Optional Block<br>Enable this option
|
|
1814
1814
|
|
|
1815
|
-
<a id="verification-5ba048"></a>• [`skip_server_verification`](#verification-5ba048) - Optional Block<br>
|
|
1815
|
+
<a id="verification-5ba048"></a>• [`skip_server_verification`](#verification-5ba048) - Optional Block<br>Enable this option
|
|
1816
1816
|
|
|
1817
1817
|
<a id="origin-pool-use-tls-sni"></a>• [`sni`](#origin-pool-use-tls-sni) - Optional String<br>SNI value to be used
|
|
1818
1818
|
|
|
1819
1819
|
<a id="origin-pool-use-tls-tls-config"></a>• [`tls_config`](#origin-pool-use-tls-tls-config) - Optional Block<br>Defines various OPTIONS to configure TLS configuration parameters<br>See [TLS Config](#origin-pool-use-tls-tls-config) below.
|
|
1820
1820
|
|
|
1821
|
-
<a id="sni-097beb"></a>• [`use_host_header_as_sni`](#sni-097beb) - Optional Block<br>
|
|
1821
|
+
<a id="sni-097beb"></a>• [`use_host_header_as_sni`](#sni-097beb) - Optional Block<br>Enable this option
|
|
1822
1822
|
|
|
1823
1823
|
<a id="origin-pool-use-tls-use-mtls"></a>• [`use_mtls`](#origin-pool-use-tls-use-mtls) - Optional Block<br>mTLS Certificate. mTLS Client Certificate<br>See [Use mTLS](#origin-pool-use-tls-use-mtls) below.
|
|
1824
1824
|
|
|
@@ -1826,7 +1826,7 @@ An [`use_tls`](#origin-pool-use-tls) block (within [`origin_pool`](#origin-pool)
|
|
|
1826
1826
|
|
|
1827
1827
|
<a id="verification-1ac9e2"></a>• [`use_server_verification`](#verification-1ac9e2) - Optional Block<br>TLS Validation Context for Origin Servers. Upstream TLS Validation Context<br>See [Use Server Verification](#verification-1ac9e2) below.
|
|
1828
1828
|
|
|
1829
|
-
<a id="origin-pool-use-tls-volterra-trusted-ca"></a>• [`volterra_trusted_ca`](#origin-pool-use-tls-volterra-trusted-ca) - Optional Block<br>
|
|
1829
|
+
<a id="origin-pool-use-tls-volterra-trusted-ca"></a>• [`volterra_trusted_ca`](#origin-pool-use-tls-volterra-trusted-ca) - Optional Block<br>Enable this option
|
|
1830
1830
|
|
|
1831
1831
|
#### Origin Pool Use TLS TLS Config
|
|
1832
1832
|
|
|
@@ -1834,11 +1834,11 @@ A [`tls_config`](#origin-pool-use-tls-tls-config) block (within [`origin_pool.us
|
|
|
1834
1834
|
|
|
1835
1835
|
<a id="security-0634ba"></a>• [`custom_security`](#security-0634ba) - Optional Block<br>Defines TLS protocol config including min/max versions and allowed ciphers<br>See [Custom Security](#security-0634ba) below.
|
|
1836
1836
|
|
|
1837
|
-
<a id="security-2e5168"></a>• [`default_security`](#security-2e5168) - Optional Block<br>
|
|
1837
|
+
<a id="security-2e5168"></a>• [`default_security`](#security-2e5168) - Optional Block<br>Enable this option
|
|
1838
1838
|
|
|
1839
|
-
<a id="security-894811"></a>• [`low_security`](#security-894811) - Optional Block<br>
|
|
1839
|
+
<a id="security-894811"></a>• [`low_security`](#security-894811) - Optional Block<br>Enable this option
|
|
1840
1840
|
|
|
1841
|
-
<a id="security-07625b"></a>• [`medium_security`](#security-07625b) - Optional Block<br>
|
|
1841
|
+
<a id="security-07625b"></a>• [`medium_security`](#security-07625b) - Optional Block<br>Enable this option
|
|
1842
1842
|
|
|
1843
1843
|
#### Origin Pool Use TLS TLS Config Custom Security
|
|
1844
1844
|
|
|
@@ -1970,25 +1970,25 @@ An [`origin_log_options`](#options-c9d79f) block (within [`other_settings.loggin
|
|
|
1970
1970
|
|
|
1971
1971
|
A [`policy_based_challenge`](#policy-based-challenge) block supports the following:
|
|
1972
1972
|
|
|
1973
|
-
<a id="challenge-a53c7e"></a>• [`always_enable_captcha_challenge`](#challenge-a53c7e) - Optional Block<br>
|
|
1973
|
+
<a id="challenge-a53c7e"></a>• [`always_enable_captcha_challenge`](#challenge-a53c7e) - Optional Block<br>Enable this option
|
|
1974
1974
|
|
|
1975
|
-
<a id="challenge-3ba035"></a>• [`always_enable_js_challenge`](#challenge-3ba035) - Optional Block<br>
|
|
1975
|
+
<a id="challenge-3ba035"></a>• [`always_enable_js_challenge`](#challenge-3ba035) - Optional Block<br>Enable this option
|
|
1976
1976
|
|
|
1977
1977
|
<a id="parameters-699e87"></a>• [`captcha_challenge_parameters`](#parameters-699e87) - Optional Block<br>Enables loadbalancer to perform captcha challenge Captcha challenge will be based on Google Recaptcha. With this feature enabled, only clients that pass the captcha challenge will be allowed to complete the HTTP request. When loadbalancer is configured to do Captcha Challenge, it will redirect<br>See [Captcha Challenge Parameters](#parameters-699e87) below.
|
|
1978
1978
|
|
|
1979
|
-
<a id="parameters-1afe14"></a>• [`default_captcha_challenge_parameters`](#parameters-1afe14) - Optional Block<br>
|
|
1979
|
+
<a id="parameters-1afe14"></a>• [`default_captcha_challenge_parameters`](#parameters-1afe14) - Optional Block<br>Enable this option
|
|
1980
1980
|
|
|
1981
|
-
<a id="parameters-d11492"></a>• [`default_js_challenge_parameters`](#parameters-d11492) - Optional Block<br>
|
|
1981
|
+
<a id="parameters-d11492"></a>• [`default_js_challenge_parameters`](#parameters-d11492) - Optional Block<br>Enable this option
|
|
1982
1982
|
|
|
1983
|
-
<a id="settings-3c8e74"></a>• [`default_mitigation_settings`](#settings-3c8e74) - Optional Block<br>
|
|
1983
|
+
<a id="settings-3c8e74"></a>• [`default_mitigation_settings`](#settings-3c8e74) - Optional Block<br>Enable this option
|
|
1984
1984
|
|
|
1985
|
-
<a id="parameters-f17f1a"></a>• [`default_temporary_blocking_parameters`](#parameters-f17f1a) - Optional Block<br>
|
|
1985
|
+
<a id="parameters-f17f1a"></a>• [`default_temporary_blocking_parameters`](#parameters-f17f1a) - Optional Block<br>Enable this option
|
|
1986
1986
|
|
|
1987
1987
|
<a id="parameters-65055e"></a>• [`js_challenge_parameters`](#parameters-65055e) - Optional Block<br>Enables loadbalancer to perform client browser compatibility test by redirecting to a page with Javascript. With this feature enabled, only clients that are capable of executing Javascript(mostly browsers) will be allowed to complete the HTTP request. When loadbalancer is configured to do<br>See [Js Challenge Parameters](#parameters-65055e) below.
|
|
1988
1988
|
|
|
1989
1989
|
<a id="mitigation-d19aea"></a>• [`malicious_user_mitigation`](#mitigation-d19aea) - 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 [Malicious User Mitigation](#mitigation-d19aea) below.
|
|
1990
1990
|
|
|
1991
|
-
<a id="policy-based-challenge-no-challenge"></a>• [`no_challenge`](#policy-based-challenge-no-challenge) - Optional Block<br>
|
|
1991
|
+
<a id="policy-based-challenge-no-challenge"></a>• [`no_challenge`](#policy-based-challenge-no-challenge) - Optional Block<br>Enable this option
|
|
1992
1992
|
|
|
1993
1993
|
<a id="policy-based-challenge-rule-list"></a>• [`rule_list`](#policy-based-challenge-rule-list) - Optional Block<br>List of challenge rules to be used in policy based challenge<br>See [Rule List](#policy-based-challenge-rule-list) below.
|
|
1994
1994
|
|
|
@@ -2048,11 +2048,11 @@ A [`metadata`](#metadata-72ce94) block (within [`policy_based_challenge.rule_lis
|
|
|
2048
2048
|
|
|
2049
2049
|
A [`spec`](#spec-fbd0f9) block (within [`policy_based_challenge.rule_list.rules`](#policy-based-challenge-rule-list-rules)) supports the following:
|
|
2050
2050
|
|
|
2051
|
-
<a id="asn-cae05d"></a>• [`any_asn`](#asn-cae05d) - Optional Block<br>
|
|
2051
|
+
<a id="asn-cae05d"></a>• [`any_asn`](#asn-cae05d) - Optional Block<br>Enable this option
|
|
2052
2052
|
|
|
2053
|
-
<a id="client-df7cdb"></a>• [`any_client`](#client-df7cdb) - Optional Block<br>
|
|
2053
|
+
<a id="client-df7cdb"></a>• [`any_client`](#client-df7cdb) - Optional Block<br>Enable this option
|
|
2054
2054
|
|
|
2055
|
-
<a id="any-ip-6a2554"></a>• [`any_ip`](#any-ip-6a2554) - Optional Block<br>
|
|
2055
|
+
<a id="any-ip-6a2554"></a>• [`any_ip`](#any-ip-6a2554) - Optional Block<br>Enable this option
|
|
2056
2056
|
|
|
2057
2057
|
<a id="matchers-86dff2"></a>• [`arg_matchers`](#matchers-86dff2) - Optional Block<br>List of predicates for all POST args that need to be matched. The criteria for matching each arg are described in individual instances of ArgMatcherType. The actual arg values are extracted from the request API as a list of strings for each arg selector name<br>See [Arg Matchers](#matchers-86dff2) below.
|
|
2058
2058
|
|
|
@@ -2066,13 +2066,13 @@ A [`spec`](#spec-fbd0f9) block (within [`policy_based_challenge.rule_list.rules`
|
|
|
2066
2066
|
|
|
2067
2067
|
<a id="matchers-cb349b"></a>• [`cookie_matchers`](#matchers-cb349b) - Optional Block<br>List of predicates for all cookies that need to be matched. The criteria for matching each cookie is described in individual instances of CookieMatcherType. The actual cookie values are extracted from the request API as a list of strings for each cookie name<br>See [Cookie Matchers](#matchers-cb349b) below.
|
|
2068
2068
|
|
|
2069
|
-
<a id="challenge-fbd9a1"></a>• [`disable_challenge`](#challenge-fbd9a1) - Optional Block<br>
|
|
2069
|
+
<a id="challenge-fbd9a1"></a>• [`disable_challenge`](#challenge-fbd9a1) - Optional Block<br>Enable this option
|
|
2070
2070
|
|
|
2071
2071
|
<a id="matcher-888f5a"></a>• [`domain_matcher`](#matcher-888f5a) - Optional Block<br>Matcher specifies multiple criteria for matching an input string. The match is considered successful if any of the criteria are satisfied. The set of supported match criteria includes a list of exact values and a list of regular expressions<br>See [Domain Matcher](#matcher-888f5a) below.
|
|
2072
2072
|
|
|
2073
|
-
<a id="challenge-e0353b"></a>• [`enable_captcha_challenge`](#challenge-e0353b) - Optional Block<br>
|
|
2073
|
+
<a id="challenge-e0353b"></a>• [`enable_captcha_challenge`](#challenge-e0353b) - Optional Block<br>Enable this option
|
|
2074
2074
|
|
|
2075
|
-
<a id="challenge-3644c3"></a>• [`enable_javascript_challenge`](#challenge-3644c3) - Optional Block<br>
|
|
2075
|
+
<a id="challenge-3644c3"></a>• [`enable_javascript_challenge`](#challenge-3644c3) - Optional Block<br>Enable this option
|
|
2076
2076
|
|
|
2077
2077
|
<a id="timestamp-6d26e1"></a>• [`expiration_timestamp`](#timestamp-6d26e1) - Optional String<br>Specifies expiration_timestamp the RFC 3339 format timestamp at which the containing rule is considered to be logically expired. The rule continues to exist in the configuration but is not applied anymore
|
|
2078
2078
|
|
|
@@ -2180,31 +2180,31 @@ A [`temporary_user_blocking`](#blocking-9fdca7) block (within [`policy_based_cha
|
|
|
2180
2180
|
|
|
2181
2181
|
A [`protected_cookies`](#protected-cookies) block supports the following:
|
|
2182
2182
|
|
|
2183
|
-
<a id="protected-cookies-add-httponly"></a>• [`add_httponly`](#protected-cookies-add-httponly) - Optional Block<br>
|
|
2183
|
+
<a id="protected-cookies-add-httponly"></a>• [`add_httponly`](#protected-cookies-add-httponly) - Optional Block<br>Enable this option
|
|
2184
2184
|
|
|
2185
|
-
<a id="protected-cookies-add-secure"></a>• [`add_secure`](#protected-cookies-add-secure) - Optional Block<br>
|
|
2185
|
+
<a id="protected-cookies-add-secure"></a>• [`add_secure`](#protected-cookies-add-secure) - Optional Block<br>Enable this option
|
|
2186
2186
|
|
|
2187
|
-
<a id="protection-51c741"></a>• [`disable_tampering_protection`](#protection-51c741) - Optional Block<br>
|
|
2187
|
+
<a id="protection-51c741"></a>• [`disable_tampering_protection`](#protection-51c741) - Optional Block<br>Enable this option
|
|
2188
2188
|
|
|
2189
|
-
<a id="protection-d59c9f"></a>• [`enable_tampering_protection`](#protection-d59c9f) - Optional Block<br>
|
|
2189
|
+
<a id="protection-d59c9f"></a>• [`enable_tampering_protection`](#protection-d59c9f) - Optional Block<br>Enable this option
|
|
2190
2190
|
|
|
2191
|
-
<a id="protected-cookies-ignore-httponly"></a>• [`ignore_httponly`](#protected-cookies-ignore-httponly) - Optional Block<br>
|
|
2191
|
+
<a id="protected-cookies-ignore-httponly"></a>• [`ignore_httponly`](#protected-cookies-ignore-httponly) - Optional Block<br>Enable this option
|
|
2192
2192
|
|
|
2193
|
-
<a id="protected-cookies-ignore-max-age"></a>• [`ignore_max_age`](#protected-cookies-ignore-max-age) - Optional Block<br>
|
|
2193
|
+
<a id="protected-cookies-ignore-max-age"></a>• [`ignore_max_age`](#protected-cookies-ignore-max-age) - Optional Block<br>Enable this option
|
|
2194
2194
|
|
|
2195
|
-
<a id="protected-cookies-ignore-samesite"></a>• [`ignore_samesite`](#protected-cookies-ignore-samesite) - Optional Block<br>
|
|
2195
|
+
<a id="protected-cookies-ignore-samesite"></a>• [`ignore_samesite`](#protected-cookies-ignore-samesite) - Optional Block<br>Enable this option
|
|
2196
2196
|
|
|
2197
|
-
<a id="protected-cookies-ignore-secure"></a>• [`ignore_secure`](#protected-cookies-ignore-secure) - Optional Block<br>
|
|
2197
|
+
<a id="protected-cookies-ignore-secure"></a>• [`ignore_secure`](#protected-cookies-ignore-secure) - Optional Block<br>Enable this option
|
|
2198
2198
|
|
|
2199
2199
|
<a id="protected-cookies-max-age-value"></a>• [`max_age_value`](#protected-cookies-max-age-value) - Optional Number<br>Add max age attribute
|
|
2200
2200
|
|
|
2201
2201
|
<a id="protected-cookies-name"></a>• [`name`](#protected-cookies-name) - Optional String<br>Cookie Name. Name of the Cookie
|
|
2202
2202
|
|
|
2203
|
-
<a id="protected-cookies-samesite-lax"></a>• [`samesite_lax`](#protected-cookies-samesite-lax) - Optional Block<br>
|
|
2203
|
+
<a id="protected-cookies-samesite-lax"></a>• [`samesite_lax`](#protected-cookies-samesite-lax) - Optional Block<br>Enable this option
|
|
2204
2204
|
|
|
2205
|
-
<a id="protected-cookies-samesite-none"></a>• [`samesite_none`](#protected-cookies-samesite-none) - Optional Block<br>
|
|
2205
|
+
<a id="protected-cookies-samesite-none"></a>• [`samesite_none`](#protected-cookies-samesite-none) - Optional Block<br>Enable this option
|
|
2206
2206
|
|
|
2207
|
-
<a id="protected-cookies-samesite-strict"></a>• [`samesite_strict`](#protected-cookies-samesite-strict) - Optional Block<br>
|
|
2207
|
+
<a id="protected-cookies-samesite-strict"></a>• [`samesite_strict`](#protected-cookies-samesite-strict) - Optional Block<br>Enable this option
|
|
2208
2208
|
|
|
2209
2209
|
#### Rate Limit
|
|
2210
2210
|
|
|
@@ -2214,9 +2214,9 @@ A [`rate_limit`](#rate-limit) block supports the following:
|
|
|
2214
2214
|
|
|
2215
2215
|
<a id="rate-limit-ip-allowed-list"></a>• [`ip_allowed_list`](#rate-limit-ip-allowed-list) - Optional Block<br>List of IPv4 prefixes that represent an endpoint<br>See [IP Allowed List](#rate-limit-ip-allowed-list) below.
|
|
2216
2216
|
|
|
2217
|
-
<a id="rate-limit-no-ip-allowed-list"></a>• [`no_ip_allowed_list`](#rate-limit-no-ip-allowed-list) - Optional Block<br>
|
|
2217
|
+
<a id="rate-limit-no-ip-allowed-list"></a>• [`no_ip_allowed_list`](#rate-limit-no-ip-allowed-list) - Optional Block<br>Enable this option
|
|
2218
2218
|
|
|
2219
|
-
<a id="rate-limit-no-policies"></a>• [`no_policies`](#rate-limit-no-policies) - Optional Block<br>
|
|
2219
|
+
<a id="rate-limit-no-policies"></a>• [`no_policies`](#rate-limit-no-policies) - Optional Block<br>Enable this option
|
|
2220
2220
|
|
|
2221
2221
|
<a id="rate-limit-policies"></a>• [`policies`](#rate-limit-policies) - Optional Block<br>List of rate limiter policies to be applied<br>See [Policies](#rate-limit-policies) below.
|
|
2222
2222
|
|
|
@@ -2262,7 +2262,7 @@ A [`rate_limiter`](#rate-limit-rate-limiter) block (within [`rate_limit`](#rate-
|
|
|
2262
2262
|
|
|
2263
2263
|
<a id="multiplier-1bc2e7"></a>• [`burst_multiplier`](#multiplier-1bc2e7) - Optional Number<br>The maximum burst of requests to accommodate, expressed as a multiple of the rate
|
|
2264
2264
|
|
|
2265
|
-
<a id="rate-limit-rate-limiter-disabled"></a>• [`disabled`](#rate-limit-rate-limiter-disabled) - Optional Block<br>
|
|
2265
|
+
<a id="rate-limit-rate-limiter-disabled"></a>• [`disabled`](#rate-limit-rate-limiter-disabled) - Optional Block<br>Enable this option
|
|
2266
2266
|
|
|
2267
2267
|
<a id="rate-limit-rate-limiter-leaky-bucket"></a>• [`leaky_bucket`](#rate-limit-rate-limiter-leaky-bucket) - Optional Block<br>Leaky-Bucket is the default rate limiter algorithm for F5
|
|
2268
2268
|
|
|
@@ -2322,7 +2322,7 @@ A [`sensitive_data_policy_ref`](#ref-55b260) block (within [`sensitive_data_poli
|
|
|
2322
2322
|
|
|
2323
2323
|
A [`slow_ddos_mitigation`](#slow-ddos-mitigation) block supports the following:
|
|
2324
2324
|
|
|
2325
|
-
<a id="timeout-81071e"></a>• [`disable_request_timeout`](#timeout-81071e) - Optional Block<br>
|
|
2325
|
+
<a id="timeout-81071e"></a>• [`disable_request_timeout`](#timeout-81071e) - Optional Block<br>Enable this option
|
|
2326
2326
|
|
|
2327
2327
|
<a id="timeout-da89d3"></a>• [`request_headers_timeout`](#timeout-da89d3) - Optional Number Defaults to `10000`<br>The amount of time the client has to send only the headers on the request stream before the stream is cancelled. The milliseconds. This setting provides protection against Slowloris attacks
|
|
2328
2328
|
|
|
@@ -2348,7 +2348,7 @@ A [`trusted_clients`](#trusted-clients) block supports the following:
|
|
|
2348
2348
|
|
|
2349
2349
|
<a id="trusted-clients-as-number"></a>• [`as_number`](#trusted-clients-as-number) - Optional Number<br>RFC 6793 defined 4-byte AS number
|
|
2350
2350
|
|
|
2351
|
-
<a id="trusted-clients-bot-skip-processing"></a>• [`bot_skip_processing`](#trusted-clients-bot-skip-processing) - Optional Block<br>
|
|
2351
|
+
<a id="trusted-clients-bot-skip-processing"></a>• [`bot_skip_processing`](#trusted-clients-bot-skip-processing) - Optional Block<br>Enable this option
|
|
2352
2352
|
|
|
2353
2353
|
<a id="trusted-clients-expiration-timestamp"></a>• [`expiration_timestamp`](#trusted-clients-expiration-timestamp) - Optional String<br>Specifies expiration_timestamp the RFC 3339 format timestamp at which the containing rule is considered to be logically expired. The rule continues to exist in the configuration but is not applied anymore
|
|
2354
2354
|
|
|
@@ -2360,11 +2360,11 @@ A [`trusted_clients`](#trusted-clients) block supports the following:
|
|
|
2360
2360
|
|
|
2361
2361
|
<a id="trusted-clients-metadata"></a>• [`metadata`](#trusted-clients-metadata) - Optional Block<br>MessageMetaType is metadata (common attributes) of a message that only certain messages have. This information is propagated to the metadata of a child object that gets created from the containing message during view processing. The information in this type can be specified by user during create<br>See [Metadata](#trusted-clients-metadata) below.
|
|
2362
2362
|
|
|
2363
|
-
<a id="trusted-clients-skip-processing"></a>• [`skip_processing`](#trusted-clients-skip-processing) - Optional Block<br>
|
|
2363
|
+
<a id="trusted-clients-skip-processing"></a>• [`skip_processing`](#trusted-clients-skip-processing) - Optional Block<br>Enable this option
|
|
2364
2364
|
|
|
2365
2365
|
<a id="trusted-clients-user-identifier"></a>• [`user_identifier`](#trusted-clients-user-identifier) - Optional String<br>Identify user based on user identifier. User identifier value needs to be copied from security event
|
|
2366
2366
|
|
|
2367
|
-
<a id="trusted-clients-waf-skip-processing"></a>• [`waf_skip_processing`](#trusted-clients-waf-skip-processing) - Optional Block<br>
|
|
2367
|
+
<a id="trusted-clients-waf-skip-processing"></a>• [`waf_skip_processing`](#trusted-clients-waf-skip-processing) - Optional Block<br>Enable this option
|
|
2368
2368
|
|
|
2369
2369
|
#### Trusted Clients HTTP Header
|
|
2370
2370
|
|
|
@@ -2422,9 +2422,9 @@ A [`waf_exclusion_inline_rules`](#rules-6d8efc) block (within [`waf_exclusion`](
|
|
|
2422
2422
|
|
|
2423
2423
|
A [`rules`](#rules-28cf34) block (within [`waf_exclusion.waf_exclusion_inline_rules`](#rules-6d8efc)) supports the following:
|
|
2424
2424
|
|
|
2425
|
-
<a id="domain-3f85e2"></a>• [`any_domain`](#domain-3f85e2) - Optional Block<br>
|
|
2425
|
+
<a id="domain-3f85e2"></a>• [`any_domain`](#domain-3f85e2) - Optional Block<br>Enable this option
|
|
2426
2426
|
|
|
2427
|
-
<a id="path-f75bfe"></a>• [`any_path`](#path-f75bfe) - Optional Block<br>
|
|
2427
|
+
<a id="path-f75bfe"></a>• [`any_path`](#path-f75bfe) - Optional Block<br>Enable this option
|
|
2428
2428
|
|
|
2429
2429
|
<a id="control-0cb52d"></a>• [`app_firewall_detection_control`](#control-0cb52d) - Optional Block<br>Define the list of Signature IDs, Violations, Attack Types and Bot Names that should be excluded from triggering on the defined match criteria<br>See [App Firewall Detection Control](#control-0cb52d) below.
|
|
2430
2430
|
|
|
@@ -2442,7 +2442,7 @@ A [`rules`](#rules-28cf34) block (within [`waf_exclusion.waf_exclusion_inline_ru
|
|
|
2442
2442
|
|
|
2443
2443
|
<a id="value-6f2f58"></a>• [`suffix_value`](#value-6f2f58) - Optional String<br>Suffix of domain name e.g 'xyz.com' will match '*.xyz.com' and 'xyz.com'
|
|
2444
2444
|
|
|
2445
|
-
<a id="processing-8c8391"></a>• [`waf_skip_processing`](#processing-8c8391) - Optional Block<br>
|
|
2445
|
+
<a id="processing-8c8391"></a>• [`waf_skip_processing`](#processing-8c8391) - Optional Block<br>Enable this option
|
|
2446
2446
|
|
|
2447
2447
|
#### WAF Exclusion WAF Exclusion Inline Rules Rules App Firewall Detection Control
|
|
2448
2448
|
|