@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
|
@@ -79,116 +79,116 @@ 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>Can be used for messages where no values are needed
|
|
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>Can be used for messages where no values are needed
|
|
87
87
|
|
|
88
88
|
-> **One of the following:**
|
|
89
|
-
• <a id="api-specification"></a>[`api_specification`](#api-specification) - Optional Block<br>
|
|
89
|
+
• <a id="api-specification"></a>[`api_specification`](#api-specification) - Optional Block<br>Settings for API specification (API definition, OpenAPI validation, etc.)
|
|
90
90
|
|
|
91
91
|
-> **One of the following:**
|
|
92
|
-
• <a id="app-firewall"></a>[`app_firewall`](#app-firewall) - Optional Block<br>
|
|
92
|
+
• <a id="app-firewall"></a>[`app_firewall`](#app-firewall) - 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
|
|
93
93
|
|
|
94
|
-
<a id="blocked-clients"></a>• [`blocked_clients`](#blocked-clients) - Optional Block<br>
|
|
94
|
+
<a id="blocked-clients"></a>• [`blocked_clients`](#blocked-clients) - Optional Block<br>Define rules to block IP Prefixes or AS numbers
|
|
95
95
|
|
|
96
|
-
<a id="bot-defense"></a>• [`bot_defense`](#bot-defense) - Optional Block<br>
|
|
96
|
+
<a id="bot-defense"></a>• [`bot_defense`](#bot-defense) - Optional Block<br>Defines various configuration OPTIONS for Bot Defense Policy
|
|
97
97
|
|
|
98
98
|
-> **One of the following:**
|
|
99
|
-
• <a id="captcha-challenge"></a>[`captcha_challenge`](#captcha-challenge) - Optional Block<br>
|
|
100
|
-
<br><br>• <a id="enable-challenge"></a>[`enable_challenge`](#enable-challenge) - Optional Block<br>
|
|
101
|
-
<br><br>• <a id="js-challenge"></a>[`js_challenge`](#js-challenge) - Optional Block<br>
|
|
102
|
-
<br><br>• <a id="no-challenge"></a>[`no_challenge`](#no-challenge) - Optional Block<br>
|
|
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
|
+
<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
|
+
<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>Can be used for messages where no values are needed
|
|
103
103
|
|
|
104
104
|
-> **One of the following:**
|
|
105
|
-
• <a id="client-side-defense"></a>[`client_side_defense`](#client-side-defense) - Optional Block<br>
|
|
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
|
|
106
106
|
|
|
107
|
-
<a id="cors-policy"></a>• [`cors_policy`](#cors-policy) - Optional Block<br>
|
|
107
|
+
<a id="cors-policy"></a>• [`cors_policy`](#cors-policy) - Optional Block<br>Cross-Origin Resource Sharing requests configuration specified at Virtual-host or Route level. Route level configuration takes precedence. An example of an Cross origin HTTP request GET /resources/public-data/ HTTP/1.1 Host: bar.other User-Agent: Mozilla/5.0 (Macintosh; U; Intel MAC OS X 10.5
|
|
108
108
|
|
|
109
|
-
<a id="csrf-policy"></a>• [`csrf_policy`](#csrf-policy) - Optional Block<br>
|
|
109
|
+
<a id="csrf-policy"></a>• [`csrf_policy`](#csrf-policy) - Optional Block<br>To mitigate CSRF attack , the policy checks where a request is coming from to determine if the request's origin is the same as its detination.the policy relies on two pieces of information used in determining if a request originated from the same host. 1. The origin that caused the user agent to
|
|
110
110
|
|
|
111
111
|
<a id="custom-cache-rule"></a>• [`custom_cache_rule`](#custom-cache-rule) - Optional Block<br>Custom Cache Rules. Caching policies for CDN
|
|
112
112
|
|
|
113
|
-
<a id="data-guard-rules"></a>• [`data_guard_rules`](#data-guard-rules) - Optional Block<br>Data Guard
|
|
113
|
+
<a id="data-guard-rules"></a>• [`data_guard_rules`](#data-guard-rules) - Optional Block<br>Data Guard prevents responses from exposing sensitive information by masking the data. The system masks credit card numbers and social security numbers leaked from the application from within the HTTP response with a string of asterisks (*)
|
|
114
114
|
|
|
115
|
-
<a id="ddos-mitigation-rules"></a>• [`ddos_mitigation_rules`](#ddos-mitigation-rules) - Optional Block<br>
|
|
115
|
+
<a id="ddos-mitigation-rules"></a>• [`ddos_mitigation_rules`](#ddos-mitigation-rules) - Optional Block<br>Define manual mitigation rules to block L7 DDOS attacks
|
|
116
116
|
|
|
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>Can be used for messages where no values are needed
|
|
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>Can be used for messages where no values are needed
|
|
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>Can be used for messages where no values are needed
|
|
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>Can be used for messages where no values are needed
|
|
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>Can be used for messages where no values are needed
|
|
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>Can be used for messages where no values are needed
|
|
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>Can be used for messages where no values are needed
|
|
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>Can be used for messages where no values are needed
|
|
139
139
|
|
|
140
|
-
<a id="domains"></a>• [`domains`](#domains) - Optional List<br>
|
|
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
|
|
|
142
|
-
<a id="enable-api-discovery"></a>• [`enable_api_discovery`](#enable-api-discovery) - Optional Block<br>
|
|
142
|
+
<a id="enable-api-discovery"></a>• [`enable_api_discovery`](#enable-api-discovery) - Optional Block<br>Specifies the settings used for API discovery
|
|
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>Can be used for messages where no values are needed
|
|
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>Can be used for messages where no values are needed
|
|
149
149
|
|
|
150
|
-
<a id="graphql-rules"></a>• [`graphql_rules`](#graphql-rules) - Optional Block<br>GraphQL
|
|
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
|
|
|
152
152
|
-> **One of the following:**
|
|
153
153
|
• <a id="http"></a>[`http`](#http) - Optional Block<br>HTTP Choice. Choice for selecting HTTP proxy
|
|
154
|
-
<br><br>• <a id="https"></a>[`https`](#https) - Optional Block<br>
|
|
154
|
+
<br><br>• <a id="https"></a>[`https`](#https) - Optional Block<br>Choice for selecting CDN Distribution with bring your own certificates
|
|
155
155
|
|
|
156
|
-
<a id="https-auto-cert"></a>• [`https_auto_cert`](#https-auto-cert) - Optional Block<br>
|
|
156
|
+
<a id="https-auto-cert"></a>• [`https_auto_cert`](#https-auto-cert) - Optional Block<br>Choice for selecting HTTPS CDN distribution with bring your own certificates
|
|
157
157
|
|
|
158
|
-
<a id="jwt-validation"></a>• [`jwt_validation`](#jwt-validation) - Optional Block<br>JWT Validation
|
|
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>Can be used for messages where no values are needed
|
|
162
|
+
<br><br>• <a id="l7-ddos-action-default"></a>[`l7_ddos_action_default`](#l7-ddos-action-default) - Optional Block<br>Can be used for messages where no values are needed
|
|
163
163
|
|
|
164
|
-
<a id="l7-ddos-action-js-challenge"></a>• [`l7_ddos_action_js_challenge`](#l7-ddos-action-js-challenge) - Optional Block<br>
|
|
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
|
|
|
166
166
|
<a id="origin-pool"></a>• [`origin_pool`](#origin-pool) - Optional Block<br>CDN Origin Pool. Origin Pool for the CDN distribution
|
|
167
167
|
|
|
168
168
|
<a id="other-settings"></a>• [`other_settings`](#other-settings) - Optional Block<br>Other Settings. Other Settings
|
|
169
169
|
|
|
170
|
-
<a id="policy-based-challenge"></a>• [`policy_based_challenge`](#policy-based-challenge) - Optional Block<br>
|
|
170
|
+
<a id="policy-based-challenge"></a>• [`policy_based_challenge`](#policy-based-challenge) - Optional Block<br>Specifies the settings for policy rule based challenge
|
|
171
171
|
|
|
172
|
-
<a id="protected-cookies"></a>• [`protected_cookies`](#protected-cookies) - Optional Block<br>
|
|
172
|
+
<a id="protected-cookies"></a>• [`protected_cookies`](#protected-cookies) - Optional Block<br>Allows setting attributes (SameSite, Secure, and HttpOnly) on cookies in responses. Cookie Tampering Protection prevents attackers from modifying the value of session cookies. For Cookie Tampering Protection, enabling a web app firewall (WAF) is a prerequisite
|
|
173
173
|
|
|
174
174
|
<a id="rate-limit"></a>• [`rate_limit`](#rate-limit) - Optional Block<br>RateLimitConfigType
|
|
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>Can be used for messages where no values are needed
|
|
179
179
|
|
|
180
180
|
-> **One of the following:**
|
|
181
|
-
• <a id="slow-ddos-mitigation"></a>[`slow_ddos_mitigation`](#slow-ddos-mitigation) - Optional Block<br>
|
|
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>Can be used for messages where no values are needed
|
|
184
184
|
|
|
185
185
|
<a id="timeouts"></a>• [`timeouts`](#timeouts) - Optional Block
|
|
186
186
|
|
|
187
|
-
<a id="trusted-clients"></a>• [`trusted_clients`](#trusted-clients) - Optional Block<br>
|
|
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>
|
|
191
|
-
<br><br>• <a id="user-identification"></a>[`user_identification`](#user-identification) - Optional Block<br>
|
|
190
|
+
• <a id="user-id-client-ip"></a>[`user_id_client_ip`](#user-id-client-ip) - Optional Block<br>Can be used for messages where no values are needed
|
|
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
|
|
194
194
|
|
|
@@ -204,53 +204,53 @@ In addition to all arguments above, the following attributes are exported:
|
|
|
204
204
|
|
|
205
205
|
An [`active_service_policies`](#active-service-policies) block supports the following:
|
|
206
206
|
|
|
207
|
-
<a id="active-service-policies-policies"></a>• [`policies`](#active-service-policies-policies) - Optional Block<br>
|
|
207
|
+
<a id="active-service-policies-policies"></a>• [`policies`](#active-service-policies-policies) - Optional Block<br>Service Policies is a sequential engine where policies (and rules within the policy) are evaluated one after the other. It's important to define the correct order (policies evaluated from top to bottom in the list) for service policies, to GET the intended result. For each request, its<br>See [Policies](#active-service-policies-policies) below.
|
|
208
208
|
|
|
209
209
|
#### Active Service Policies Policies
|
|
210
210
|
|
|
211
211
|
A [`policies`](#active-service-policies-policies) block (within [`active_service_policies`](#active-service-policies)) supports the following:
|
|
212
212
|
|
|
213
|
-
<a id="active-service-policies-policies-name"></a>• [`name`](#active-service-policies-policies-name) - Optional String<br>
|
|
213
|
+
<a id="active-service-policies-policies-name"></a>• [`name`](#active-service-policies-policies-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
|
|
214
214
|
|
|
215
|
-
<a id="namespace-df0e5f"></a>• [`namespace`](#namespace-df0e5f) - Optional String<br>
|
|
215
|
+
<a id="namespace-df0e5f"></a>• [`namespace`](#namespace-df0e5f) - 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
|
|
216
216
|
|
|
217
|
-
<a id="active-service-policies-policies-tenant"></a>• [`tenant`](#active-service-policies-policies-tenant) - Optional String<br>
|
|
217
|
+
<a id="active-service-policies-policies-tenant"></a>• [`tenant`](#active-service-policies-policies-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
|
|
218
218
|
|
|
219
219
|
#### API Rate Limit
|
|
220
220
|
|
|
221
221
|
An [`api_rate_limit`](#api-rate-limit) block supports the following:
|
|
222
222
|
|
|
223
|
-
<a id="api-rate-limit-api-endpoint-rules"></a>• [`api_endpoint_rules`](#api-rate-limit-api-endpoint-rules) - Optional Block<br>
|
|
223
|
+
<a id="api-rate-limit-api-endpoint-rules"></a>• [`api_endpoint_rules`](#api-rate-limit-api-endpoint-rules) - Optional Block<br>Sets of rules for a specific endpoints. Order is matter as it uses first match policy. For creating rule that contain a whole domain or group of endpoints, please use the server URL rules above<br>See [API Endpoint Rules](#api-rate-limit-api-endpoint-rules) below.
|
|
224
224
|
|
|
225
|
-
<a id="rules-776e97"></a>• [`bypass_rate_limiting_rules`](#rules-776e97) - Optional Block<br>
|
|
225
|
+
<a id="rules-776e97"></a>• [`bypass_rate_limiting_rules`](#rules-776e97) - Optional Block<br>Category defines rules per URL or API group. If request matches any of these rules, skip Rate Limiting<br>See [Bypass Rate Limiting Rules](#rules-776e97) below.
|
|
226
226
|
|
|
227
|
-
<a id="api-rate-limit-custom-ip-allowed-list"></a>• [`custom_ip_allowed_list`](#api-rate-limit-custom-ip-allowed-list) - Optional Block<br>
|
|
227
|
+
<a id="api-rate-limit-custom-ip-allowed-list"></a>• [`custom_ip_allowed_list`](#api-rate-limit-custom-ip-allowed-list) - Optional Block<br>IP Allowed list using existing ip_prefix_set objects<br>See [Custom IP Allowed List](#api-rate-limit-custom-ip-allowed-list) below.
|
|
228
228
|
|
|
229
|
-
<a id="api-rate-limit-ip-allowed-list"></a>• [`ip_allowed_list`](#api-rate-limit-ip-allowed-list) - Optional Block<br>
|
|
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>Can be used for messages where no values are needed
|
|
232
232
|
|
|
233
|
-
<a id="api-rate-limit-server-url-rules"></a>• [`server_url_rules`](#api-rate-limit-server-url-rules) - Optional Block<br>
|
|
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
|
|
|
235
235
|
#### API Rate Limit API Endpoint Rules
|
|
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>Can be used for messages where no values are needed
|
|
240
240
|
|
|
241
|
-
<a id="method-1e49b0"></a>• [`api_endpoint_method`](#method-1e49b0) - Optional Block<br>HTTP
|
|
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
|
|
|
243
|
-
<a id="path-297bf2"></a>• [`api_endpoint_path`](#path-297bf2) - Optional String<br>
|
|
243
|
+
<a id="path-297bf2"></a>• [`api_endpoint_path`](#path-297bf2) - Optional String<br>The endpoint (path) of the request
|
|
244
244
|
|
|
245
245
|
<a id="matcher-794c7c"></a>• [`client_matcher`](#matcher-794c7c) - Optional Block<br>Client Matcher. Client conditions for matching a rule<br>See [Client Matcher](#matcher-794c7c) below.
|
|
246
246
|
|
|
247
247
|
<a id="limiter-38a124"></a>• [`inline_rate_limiter`](#limiter-38a124) - Optional Block<br>InlineRateLimiter<br>See [Inline Rate Limiter](#limiter-38a124) below.
|
|
248
248
|
|
|
249
|
-
<a id="limiter-f23897"></a>• [`ref_rate_limiter`](#limiter-f23897) - Optional Block<br>
|
|
249
|
+
<a id="limiter-f23897"></a>• [`ref_rate_limiter`](#limiter-f23897) - 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 [Ref Rate Limiter](#limiter-f23897) below.
|
|
250
250
|
|
|
251
251
|
<a id="matcher-869fa1"></a>• [`request_matcher`](#matcher-869fa1) - Optional Block<br>Request Matcher. Request conditions for matching a rule<br>See [Request Matcher](#matcher-869fa1) below.
|
|
252
252
|
|
|
253
|
-
<a id="domain-1ce4ba"></a>• [`specific_domain`](#domain-1ce4ba) - Optional String<br>
|
|
253
|
+
<a id="domain-1ce4ba"></a>• [`specific_domain`](#domain-1ce4ba) - Optional String<br>The rule will apply for a specific domain
|
|
254
254
|
|
|
255
255
|
#### API Rate Limit API Endpoint Rules API Endpoint Method
|
|
256
256
|
|
|
@@ -348,7 +348,7 @@ An [`api_endpoint_rules`](#api-rate-limit-api-endpoint-rules) block (within [`ap
|
|
|
348
348
|
|
|
349
349
|
A [`bypass_rate_limiting_rules`](#rules-776e97) block (within [`api_rate_limit`](#api-rate-limit)) supports the following:
|
|
350
350
|
|
|
351
|
-
<a id="rules-51aa34"></a>• [`bypass_rate_limiting_rules`](#rules-51aa34) - Optional Block<br>
|
|
351
|
+
<a id="rules-51aa34"></a>• [`bypass_rate_limiting_rules`](#rules-51aa34) - Optional Block<br>Category defines rules per URL or API group. If request matches any of these rules, skip Rate Limiting<br>See [Bypass Rate Limiting Rules](#rules-51aa34) below.
|
|
352
352
|
|
|
353
353
|
#### API Rate Limit Bypass Rate Limiting Rules Bypass Rate Limiting Rules
|
|
354
354
|
|
|
@@ -442,7 +442,7 @@ A [`bypass_rate_limiting_rules`](#rules-776e97) block (within [`api_rate_limit`]
|
|
|
442
442
|
|
|
443
443
|
A [`custom_ip_allowed_list`](#api-rate-limit-custom-ip-allowed-list) block (within [`api_rate_limit`](#api-rate-limit)) supports the following:
|
|
444
444
|
|
|
445
|
-
<a id="prefixes-73df46"></a>• [`rate_limiter_allowed_prefixes`](#prefixes-73df46) - Optional Block<br>
|
|
445
|
+
<a id="prefixes-73df46"></a>• [`rate_limiter_allowed_prefixes`](#prefixes-73df46) - Optional Block<br>References to ip_prefix_set objects. Requests from source IP addresses that are covered by one of the allowed IP Prefixes are not subjected to rate limiting<br>See [Rate Limiter Allowed Prefixes](#prefixes-73df46) below.
|
|
446
446
|
|
|
447
447
|
#### API Rate Limit Custom IP Allowed List Rate Limiter Allowed Prefixes
|
|
448
448
|
|
|
@@ -452,27 +452,27 @@ A [`custom_ip_allowed_list`](#api-rate-limit-custom-ip-allowed-list) block (with
|
|
|
452
452
|
|
|
453
453
|
An [`ip_allowed_list`](#api-rate-limit-ip-allowed-list) block (within [`api_rate_limit`](#api-rate-limit)) supports the following:
|
|
454
454
|
|
|
455
|
-
<a id="api-rate-limit-ip-allowed-list-prefixes"></a>• [`prefixes`](#api-rate-limit-ip-allowed-list-prefixes) - Optional List<br>
|
|
455
|
+
<a id="api-rate-limit-ip-allowed-list-prefixes"></a>• [`prefixes`](#api-rate-limit-ip-allowed-list-prefixes) - Optional List<br>List of IPv4 prefixes that represent an endpoint
|
|
456
456
|
|
|
457
457
|
#### API Rate Limit Server URL Rules
|
|
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>Can be used for messages where no values are needed
|
|
462
462
|
|
|
463
|
-
<a id="group-15c11a"></a>• [`api_group`](#group-15c11a) - Optional String<br>API
|
|
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
|
|
|
465
|
-
<a id="path-44dbff"></a>• [`base_path`](#path-44dbff) - Optional String<br>
|
|
465
|
+
<a id="path-44dbff"></a>• [`base_path`](#path-44dbff) - Optional String<br>Prefix of the request path
|
|
466
466
|
|
|
467
467
|
<a id="matcher-ed4b34"></a>• [`client_matcher`](#matcher-ed4b34) - Optional Block<br>Client Matcher. Client conditions for matching a rule<br>See [Client Matcher](#matcher-ed4b34) below.
|
|
468
468
|
|
|
469
469
|
<a id="limiter-9faa53"></a>• [`inline_rate_limiter`](#limiter-9faa53) - Optional Block<br>InlineRateLimiter<br>See [Inline Rate Limiter](#limiter-9faa53) below.
|
|
470
470
|
|
|
471
|
-
<a id="limiter-383ca9"></a>• [`ref_rate_limiter`](#limiter-383ca9) - Optional Block<br>
|
|
471
|
+
<a id="limiter-383ca9"></a>• [`ref_rate_limiter`](#limiter-383ca9) - 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 [Ref Rate Limiter](#limiter-383ca9) below.
|
|
472
472
|
|
|
473
473
|
<a id="matcher-d0eea8"></a>• [`request_matcher`](#matcher-d0eea8) - Optional Block<br>Request Matcher. Request conditions for matching a rule<br>See [Request Matcher](#matcher-d0eea8) below.
|
|
474
474
|
|
|
475
|
-
<a id="domain-dca9c1"></a>• [`specific_domain`](#domain-dca9c1) - Optional String<br>
|
|
475
|
+
<a id="domain-dca9c1"></a>• [`specific_domain`](#domain-dca9c1) - Optional String<br>The rule will apply for a specific domain
|
|
476
476
|
|
|
477
477
|
#### API Rate Limit Server URL Rules Client Matcher
|
|
478
478
|
|
|
@@ -566,33 +566,33 @@ A [`server_url_rules`](#api-rate-limit-server-url-rules) block (within [`api_rat
|
|
|
566
566
|
|
|
567
567
|
An [`api_specification`](#api-specification) block supports the following:
|
|
568
568
|
|
|
569
|
-
<a id="api-specification-api-definition"></a>• [`api_definition`](#api-specification-api-definition) - Optional Block<br>
|
|
569
|
+
<a id="api-specification-api-definition"></a>• [`api_definition`](#api-specification-api-definition) - 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 [API Definition](#api-specification-api-definition) below.
|
|
570
570
|
|
|
571
571
|
<a id="endpoints-4158a4"></a>• [`validation_all_spec_endpoints`](#endpoints-4158a4) - Optional Block<br>API Inventory. Settings for API Inventory validation<br>See [Validation All Spec Endpoints](#endpoints-4158a4) below.
|
|
572
572
|
|
|
573
|
-
<a id="list-23b577"></a>• [`validation_custom_list`](#list-23b577) - Optional Block<br>
|
|
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>Can be used for messages where no values are needed
|
|
576
576
|
|
|
577
577
|
#### API Specification API Definition
|
|
578
578
|
|
|
579
579
|
An [`api_definition`](#api-specification-api-definition) block (within [`api_specification`](#api-specification)) supports the following:
|
|
580
580
|
|
|
581
|
-
<a id="api-specification-api-definition-name"></a>• [`name`](#api-specification-api-definition-name) - Optional String<br>
|
|
581
|
+
<a id="api-specification-api-definition-name"></a>• [`name`](#api-specification-api-definition-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
|
|
582
582
|
|
|
583
|
-
<a id="namespace-c685bf"></a>• [`namespace`](#namespace-c685bf) - Optional String<br>
|
|
583
|
+
<a id="namespace-c685bf"></a>• [`namespace`](#namespace-c685bf) - 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
|
|
584
584
|
|
|
585
|
-
<a id="api-specification-api-definition-tenant"></a>• [`tenant`](#api-specification-api-definition-tenant) - Optional String<br>
|
|
585
|
+
<a id="api-specification-api-definition-tenant"></a>• [`tenant`](#api-specification-api-definition-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
|
|
586
586
|
|
|
587
587
|
#### API Specification Validation All Spec Endpoints
|
|
588
588
|
|
|
589
589
|
A [`validation_all_spec_endpoints`](#endpoints-4158a4) block (within [`api_specification`](#api-specification)) supports the following:
|
|
590
590
|
|
|
591
|
-
<a id="mode-8425c5"></a>• [`fall_through_mode`](#mode-8425c5) - Optional Block<br>
|
|
591
|
+
<a id="mode-8425c5"></a>• [`fall_through_mode`](#mode-8425c5) - Optional Block<br>Determine what to do with unprotected endpoints (not in the OpenAPI specification file (a.k.a. Swagger) or doesn't have a specific rule in custom rules)<br>See [Fall Through Mode](#mode-8425c5) below.
|
|
592
592
|
|
|
593
|
-
<a id="settings-a83a93"></a>• [`settings`](#settings-a83a93) - Optional Block<br>
|
|
593
|
+
<a id="settings-a83a93"></a>• [`settings`](#settings-a83a93) - Optional Block<br>OpenAPI specification validation settings relevant for 'API Inventory' enforcement and for 'Custom list' enforcement<br>See [Settings](#settings-a83a93) below.
|
|
594
594
|
|
|
595
|
-
<a id="mode-cd4a1c"></a>• [`validation_mode`](#mode-cd4a1c) - Optional Block<br>Validation
|
|
595
|
+
<a id="mode-cd4a1c"></a>• [`validation_mode`](#mode-cd4a1c) - Optional Block<br>Validation mode of OpenAPI specification. When a validation mismatch occurs on a request to one of the endpoints listed on the OpenAPI specification file (a.k.a. Swagger)<br>See [Validation Mode](#mode-cd4a1c) below.
|
|
596
596
|
|
|
597
597
|
#### API Specification Validation All Spec Endpoints Fall Through Mode
|
|
598
598
|
|
|
@@ -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>Can be used for messages where no values are needed
|
|
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>Can be used for messages where no values are needed
|
|
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>Can be used for messages where no values are needed
|
|
628
628
|
|
|
629
629
|
#### API Specification Validation All Spec Endpoints Settings Property Validation Settings Custom
|
|
630
630
|
|
|
@@ -650,11 +650,11 @@ A [`settings`](#settings-a83a93) block (within [`api_specification.validation_al
|
|
|
650
650
|
|
|
651
651
|
A [`validation_custom_list`](#list-23b577) block (within [`api_specification`](#api-specification)) supports the following:
|
|
652
652
|
|
|
653
|
-
<a id="mode-146cc3"></a>• [`fall_through_mode`](#mode-146cc3) - Optional Block<br>
|
|
653
|
+
<a id="mode-146cc3"></a>• [`fall_through_mode`](#mode-146cc3) - Optional Block<br>Determine what to do with unprotected endpoints (not in the OpenAPI specification file (a.k.a. Swagger) or doesn't have a specific rule in custom rules)<br>See [Fall Through Mode](#mode-146cc3) below.
|
|
654
654
|
|
|
655
655
|
<a id="rules-f51668"></a>• [`open_api_validation_rules`](#rules-f51668) - Optional Block<br>Validation List<br>See [Open API Validation Rules](#rules-f51668) below.
|
|
656
656
|
|
|
657
|
-
<a id="settings-940e64"></a>• [`settings`](#settings-940e64) - Optional Block<br>
|
|
657
|
+
<a id="settings-940e64"></a>• [`settings`](#settings-940e64) - Optional Block<br>OpenAPI specification validation settings relevant for 'API Inventory' enforcement and for 'Custom list' enforcement<br>See [Settings](#settings-940e64) below.
|
|
658
658
|
|
|
659
659
|
#### API Specification Validation Custom List Fall Through Mode
|
|
660
660
|
|
|
@@ -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>Can be used for messages where no values are needed
|
|
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>Can be used for messages where no values are needed
|
|
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>Can be used for messages where no values are needed
|
|
714
714
|
|
|
715
715
|
#### API Specification Validation Custom List Settings Property Validation Settings Custom
|
|
716
716
|
|
|
@@ -724,57 +724,57 @@ A [`settings`](#settings-940e64) block (within [`api_specification.validation_cu
|
|
|
724
724
|
|
|
725
725
|
An [`app_firewall`](#app-firewall) block supports the following:
|
|
726
726
|
|
|
727
|
-
<a id="app-firewall-name"></a>• [`name`](#app-firewall-name) - Optional String<br>
|
|
727
|
+
<a id="app-firewall-name"></a>• [`name`](#app-firewall-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
|
|
728
728
|
|
|
729
|
-
<a id="app-firewall-namespace"></a>• [`namespace`](#app-firewall-namespace) - Optional String<br>
|
|
729
|
+
<a id="app-firewall-namespace"></a>• [`namespace`](#app-firewall-namespace) - 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
|
|
730
730
|
|
|
731
|
-
<a id="app-firewall-tenant"></a>• [`tenant`](#app-firewall-tenant) - Optional String<br>
|
|
731
|
+
<a id="app-firewall-tenant"></a>• [`tenant`](#app-firewall-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
|
|
732
732
|
|
|
733
733
|
#### Blocked Clients
|
|
734
734
|
|
|
735
735
|
A [`blocked_clients`](#blocked-clients) block supports the following:
|
|
736
736
|
|
|
737
|
-
<a id="blocked-clients-actions"></a>• [`actions`](#blocked-clients-actions) - Optional List Defaults to `SKIP_PROCESSING_WAF`<br>Possible values are `SKIP_PROCESSING_WAF`, `SKIP_PROCESSING_BOT`, `SKIP_PROCESSING_MUM`, `SKIP_PROCESSING_IP_REPUTATION`, `SKIP_PROCESSING_API_PROTECTION`, `SKIP_PROCESSING_OAS_VALIDATION`, `SKIP_PROCESSING_DDOS_PROTECTION`, `SKIP_PROCESSING_THREAT_MESH`, `SKIP_PROCESSING_MALWARE_PROTECTION`<br>[Enum: SKIP_PROCESSING_WAF|SKIP_PROCESSING_BOT|SKIP_PROCESSING_MUM|SKIP_PROCESSING_IP_REPUTATION|SKIP_PROCESSING_API_PROTECTION|SKIP_PROCESSING_OAS_VALIDATION|SKIP_PROCESSING_DDOS_PROTECTION|SKIP_PROCESSING_THREAT_MESH|SKIP_PROCESSING_MALWARE_PROTECTION] Actions
|
|
737
|
+
<a id="blocked-clients-actions"></a>• [`actions`](#blocked-clients-actions) - Optional List Defaults to `SKIP_PROCESSING_WAF`<br>Possible values are `SKIP_PROCESSING_WAF`, `SKIP_PROCESSING_BOT`, `SKIP_PROCESSING_MUM`, `SKIP_PROCESSING_IP_REPUTATION`, `SKIP_PROCESSING_API_PROTECTION`, `SKIP_PROCESSING_OAS_VALIDATION`, `SKIP_PROCESSING_DDOS_PROTECTION`, `SKIP_PROCESSING_THREAT_MESH`, `SKIP_PROCESSING_MALWARE_PROTECTION`<br>[Enum: SKIP_PROCESSING_WAF|SKIP_PROCESSING_BOT|SKIP_PROCESSING_MUM|SKIP_PROCESSING_IP_REPUTATION|SKIP_PROCESSING_API_PROTECTION|SKIP_PROCESSING_OAS_VALIDATION|SKIP_PROCESSING_DDOS_PROTECTION|SKIP_PROCESSING_THREAT_MESH|SKIP_PROCESSING_MALWARE_PROTECTION] Actions that should be taken when client identifier matches the rule
|
|
738
738
|
|
|
739
|
-
<a id="blocked-clients-as-number"></a>• [`as_number`](#blocked-clients-as-number) - Optional Number<br>
|
|
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>Can be used for messages where no values are needed
|
|
742
742
|
|
|
743
|
-
<a id="blocked-clients-expiration-timestamp"></a>• [`expiration_timestamp`](#blocked-clients-expiration-timestamp) - Optional String<br>
|
|
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
|
|
|
745
745
|
<a id="blocked-clients-http-header"></a>• [`http_header`](#blocked-clients-http-header) - Optional Block<br>HTTP Header. Request header name and value pairs<br>See [HTTP Header](#blocked-clients-http-header) below.
|
|
746
746
|
|
|
747
|
-
<a id="blocked-clients-ip-prefix"></a>• [`ip_prefix`](#blocked-clients-ip-prefix) - Optional String<br>IPv4
|
|
747
|
+
<a id="blocked-clients-ip-prefix"></a>• [`ip_prefix`](#blocked-clients-ip-prefix) - Optional String<br>IPv4 prefix string
|
|
748
748
|
|
|
749
|
-
<a id="blocked-clients-ipv6-prefix"></a>• [`ipv6_prefix`](#blocked-clients-ipv6-prefix) - Optional String<br>IPv6
|
|
749
|
+
<a id="blocked-clients-ipv6-prefix"></a>• [`ipv6_prefix`](#blocked-clients-ipv6-prefix) - Optional String<br>IPv6 prefix string
|
|
750
750
|
|
|
751
|
-
<a id="blocked-clients-metadata"></a>• [`metadata`](#blocked-clients-metadata) - Optional Block<br>
|
|
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>Can be used for messages where no values are needed
|
|
754
754
|
|
|
755
|
-
<a id="blocked-clients-user-identifier"></a>• [`user_identifier`](#blocked-clients-user-identifier) - Optional String<br>
|
|
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>Can be used for messages where no values are needed
|
|
758
758
|
|
|
759
759
|
#### Blocked Clients HTTP Header
|
|
760
760
|
|
|
761
761
|
A [`http_header`](#blocked-clients-http-header) block (within [`blocked_clients`](#blocked-clients)) supports the following:
|
|
762
762
|
|
|
763
|
-
<a id="blocked-clients-http-header-headers"></a>• [`headers`](#blocked-clients-http-header-headers) - Optional Block<br>
|
|
763
|
+
<a id="blocked-clients-http-header-headers"></a>• [`headers`](#blocked-clients-http-header-headers) - Optional Block<br>List of HTTP header name and value pairs<br>See [Headers](#blocked-clients-http-header-headers) below.
|
|
764
764
|
|
|
765
765
|
#### Blocked Clients HTTP Header Headers
|
|
766
766
|
|
|
767
767
|
A [`headers`](#blocked-clients-http-header-headers) block (within [`blocked_clients.http_header`](#blocked-clients-http-header)) supports the following:
|
|
768
768
|
|
|
769
|
-
<a id="exact-a1dbef"></a>• [`exact`](#exact-a1dbef) - Optional String<br>
|
|
769
|
+
<a id="exact-a1dbef"></a>• [`exact`](#exact-a1dbef) - Optional String<br>Header value to match exactly
|
|
770
770
|
|
|
771
|
-
<a id="match-b2ef8e"></a>• [`invert_match`](#match-b2ef8e) - Optional Bool<br>
|
|
771
|
+
<a id="match-b2ef8e"></a>• [`invert_match`](#match-b2ef8e) - Optional Bool<br>Invert the result of the match to detect missing header or non-matching value
|
|
772
772
|
|
|
773
773
|
<a id="name-dc6d90"></a>• [`name`](#name-dc6d90) - Optional String<br>Name. Name of the header
|
|
774
774
|
|
|
775
|
-
<a id="presence-659464"></a>• [`presence`](#presence-659464) - Optional Bool<br>
|
|
775
|
+
<a id="presence-659464"></a>• [`presence`](#presence-659464) - Optional Bool<br>If true, check for presence of header
|
|
776
776
|
|
|
777
|
-
<a id="regex-6757d0"></a>• [`regex`](#regex-6757d0) - Optional String<br>Regex
|
|
777
|
+
<a id="regex-6757d0"></a>• [`regex`](#regex-6757d0) - Optional String<br>Regex match of the header value in re2 format
|
|
778
778
|
|
|
779
779
|
#### Blocked Clients Metadata
|
|
780
780
|
|
|
@@ -782,49 +782,49 @@ A [`metadata`](#blocked-clients-metadata) block (within [`blocked_clients`](#blo
|
|
|
782
782
|
|
|
783
783
|
<a id="spec-b8ecbc"></a>• [`description_spec`](#spec-b8ecbc) - Optional String<br>Description. Human readable description
|
|
784
784
|
|
|
785
|
-
<a id="blocked-clients-metadata-name"></a>• [`name`](#blocked-clients-metadata-name) - Optional String<br>Name
|
|
785
|
+
<a id="blocked-clients-metadata-name"></a>• [`name`](#blocked-clients-metadata-name) - Optional String<br>Name of the message. The value of name has to follow DNS-1035 format
|
|
786
786
|
|
|
787
787
|
#### Bot Defense
|
|
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>Can be used for messages where no values are needed
|
|
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>Can be used for messages where no values are needed
|
|
794
794
|
|
|
795
|
-
<a id="bot-defense-policy"></a>• [`policy`](#bot-defense-policy) - Optional Block<br>
|
|
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
|
|
|
797
|
-
<a id="bot-defense-regional-endpoint"></a>• [`regional_endpoint`](#bot-defense-regional-endpoint) - Optional String Defaults to `AUTO`<br>Possible values are `AUTO`, `US`, `EU`, `ASIA`<br>[Enum: AUTO|US|EU|ASIA]
|
|
797
|
+
<a id="bot-defense-regional-endpoint"></a>• [`regional_endpoint`](#bot-defense-regional-endpoint) - Optional String Defaults to `AUTO`<br>Possible values are `AUTO`, `US`, `EU`, `ASIA`<br>[Enum: AUTO|US|EU|ASIA] Defines a selection for Bot Defense region - AUTO: AUTO Automatic selection based on client IP address - US: US US region - EU: EU European Union region - ASIA: ASIA Asia region
|
|
798
798
|
|
|
799
|
-
<a id="bot-defense-timeout"></a>• [`timeout`](#bot-defense-timeout) - Optional Number<br>
|
|
799
|
+
<a id="bot-defense-timeout"></a>• [`timeout`](#bot-defense-timeout) - Optional Number<br>The timeout for the inference check, in milliseconds
|
|
800
800
|
|
|
801
801
|
#### Bot Defense Policy
|
|
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>Can be used for messages where no values are needed
|
|
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>Can be used for messages where no values are needed
|
|
808
808
|
|
|
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.
|
|
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
|
|
|
811
|
-
<a id="bot-defense-policy-js-download-path"></a>• [`js_download_path`](#bot-defense-policy-js-download-path) - Optional String<br>
|
|
811
|
+
<a id="bot-defense-policy-js-download-path"></a>• [`js_download_path`](#bot-defense-policy-js-download-path) - Optional String<br>Customize Bot Defense Client JavaScript path. If not specified, default
|
|
812
812
|
|
|
813
|
-
<a id="bot-defense-policy-js-insert-all-pages"></a>• [`js_insert_all_pages`](#bot-defense-policy-js-insert-all-pages) - Optional Block<br>Insert Bot Defense JavaScript in
|
|
813
|
+
<a id="bot-defense-policy-js-insert-all-pages"></a>• [`js_insert_all_pages`](#bot-defense-policy-js-insert-all-pages) - Optional Block<br>Insert Bot Defense JavaScript in all pages<br>See [Js Insert All Pages](#bot-defense-policy-js-insert-all-pages) below.
|
|
814
814
|
|
|
815
|
-
<a id="except-2f0f51"></a>• [`js_insert_all_pages_except`](#except-2f0f51) - Optional Block<br>Insert
|
|
815
|
+
<a id="except-2f0f51"></a>• [`js_insert_all_pages_except`](#except-2f0f51) - Optional Block<br>Insert Bot Defense JavaScript in all pages with the exceptions<br>See [Js Insert All Pages Except](#except-2f0f51) below.
|
|
816
816
|
|
|
817
|
-
<a id="bot-defense-policy-js-insertion-rules"></a>• [`js_insertion_rules`](#bot-defense-policy-js-insertion-rules) - Optional Block<br>
|
|
817
|
+
<a id="bot-defense-policy-js-insertion-rules"></a>• [`js_insertion_rules`](#bot-defense-policy-js-insertion-rules) - Optional Block<br>Defines custom JavaScript insertion rules for Bot Defense Policy<br>See [Js Insertion Rules](#bot-defense-policy-js-insertion-rules) below.
|
|
818
818
|
|
|
819
819
|
<a id="bot-defense-policy-mobile-sdk-config"></a>• [`mobile_sdk_config`](#bot-defense-policy-mobile-sdk-config) - Optional Block<br>Mobile SDK Configuration. Mobile SDK configuration<br>See [Mobile Sdk Config](#bot-defense-policy-mobile-sdk-config) below.
|
|
820
820
|
|
|
821
|
-
<a id="endpoints-01a2f3"></a>• [`protected_app_endpoints`](#endpoints-01a2f3) - Optional Block<br>
|
|
821
|
+
<a id="endpoints-01a2f3"></a>• [`protected_app_endpoints`](#endpoints-01a2f3) - Optional Block<br>List of protected endpoints. Limit: Approx '128 endpoints per Load Balancer (LB)' upto 4 LBs, '32 endpoints per LB' after 4 LBs<br>See [Protected App Endpoints](#endpoints-01a2f3) below.
|
|
822
822
|
|
|
823
823
|
#### Bot Defense Policy Js Insert All Pages
|
|
824
824
|
|
|
825
825
|
A [`js_insert_all_pages`](#bot-defense-policy-js-insert-all-pages) block (within [`bot_defense.policy`](#bot-defense-policy)) supports the following:
|
|
826
826
|
|
|
827
|
-
<a id="location-3a398d"></a>• [`javascript_location`](#location-3a398d) - Optional String Defaults to `AFTER_HEAD`<br>Possible values are `AFTER_HEAD`, `AFTER_TITLE_END`, `BEFORE_SCRIPT`<br>[Enum: AFTER_HEAD|AFTER_TITLE_END|BEFORE_SCRIPT]
|
|
827
|
+
<a id="location-3a398d"></a>• [`javascript_location`](#location-3a398d) - Optional String Defaults to `AFTER_HEAD`<br>Possible values are `AFTER_HEAD`, `AFTER_TITLE_END`, `BEFORE_SCRIPT`<br>[Enum: AFTER_HEAD|AFTER_TITLE_END|BEFORE_SCRIPT] All inside networks. Insert JavaScript after `<HEAD>` tag Insert JavaScript after `</title>` tag. Insert JavaScript before first <script> tag
|
|
828
828
|
|
|
829
829
|
#### Bot Defense Policy Js Insert All Pages Except
|
|
830
830
|
|
|
@@ -850,9 +850,9 @@ A [`js_insert_all_pages`](#bot-defense-policy-js-insert-all-pages) block (within
|
|
|
850
850
|
|
|
851
851
|
A [`js_insertion_rules`](#bot-defense-policy-js-insertion-rules) block (within [`bot_defense.policy`](#bot-defense-policy)) supports the following:
|
|
852
852
|
|
|
853
|
-
<a id="list-51668b"></a>• [`exclude_list`](#list-51668b) - Optional Block<br>
|
|
853
|
+
<a id="list-51668b"></a>• [`exclude_list`](#list-51668b) - Optional Block<br>Optional JavaScript insertions exclude list of domain and path matchers<br>See [Exclude List](#list-51668b) below.
|
|
854
854
|
|
|
855
|
-
<a id="rules-15d983"></a>• [`rules`](#rules-15d983) - Optional Block<br>
|
|
855
|
+
<a id="rules-15d983"></a>• [`rules`](#rules-15d983) - Optional Block<br>Required list of pages to insert Bot Defense client JavaScript<br>See [Rules](#rules-15d983) below.
|
|
856
856
|
|
|
857
857
|
#### Bot Defense Policy Js Insertion Rules Exclude List
|
|
858
858
|
|
|
@@ -874,15 +874,15 @@ 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>Can be used for messages where no values are needed
|
|
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
|
|
|
881
|
-
<a id="location-16277f"></a>• [`javascript_location`](#location-16277f) - Optional String Defaults to `AFTER_HEAD`<br>Possible values are `AFTER_HEAD`, `AFTER_TITLE_END`, `BEFORE_SCRIPT`<br>[Enum: AFTER_HEAD|AFTER_TITLE_END|BEFORE_SCRIPT]
|
|
881
|
+
<a id="location-16277f"></a>• [`javascript_location`](#location-16277f) - Optional String Defaults to `AFTER_HEAD`<br>Possible values are `AFTER_HEAD`, `AFTER_TITLE_END`, `BEFORE_SCRIPT`<br>[Enum: AFTER_HEAD|AFTER_TITLE_END|BEFORE_SCRIPT] All inside networks. Insert JavaScript after `<HEAD>` tag Insert JavaScript after `</title>` tag. Insert JavaScript before first <script> tag
|
|
882
882
|
|
|
883
|
-
<a id="metadata-e15703"></a>• [`metadata`](#metadata-e15703) - Optional Block<br>
|
|
883
|
+
<a id="metadata-e15703"></a>• [`metadata`](#metadata-e15703) - 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-e15703) below.
|
|
884
884
|
|
|
885
|
-
<a id="path-711518"></a>• [`path`](#path-711518) - Optional Block<br>Path
|
|
885
|
+
<a id="path-711518"></a>• [`path`](#path-711518) - 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-711518) below.
|
|
886
886
|
|
|
887
887
|
#### Bot Defense Policy Js Insertion Rules Rules Domain
|
|
888
888
|
|
|
@@ -918,35 +918,35 @@ 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>Can be used for messages where no values are needed
|
|
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>Can be used for messages where no values are needed
|
|
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
|
|
|
927
|
-
<a id="label-244fef"></a>• [`flow_label`](#label-244fef) - Optional Block<br>Bot Defense Flow Label Category
|
|
927
|
+
<a id="label-244fef"></a>• [`flow_label`](#label-244fef) - Optional Block<br>Bot Defense Flow Label Category allows to associate traffic with selected category<br>See [Flow Label](#label-244fef) below.
|
|
928
928
|
|
|
929
|
-
<a id="headers-986193"></a>• [`headers`](#headers-986193) - Optional Block<br>
|
|
929
|
+
<a id="headers-986193"></a>• [`headers`](#headers-986193) - Optional Block<br>List of predicates for various HTTP headers that need to match. The criteria for matching each HTTP header are described in individual HeaderMatcherType instances. The actual HTTP header values are extracted from the request API as a list of strings for each HTTP header type<br>See [Headers](#headers-986193) below.
|
|
930
930
|
|
|
931
931
|
<a id="methods-2d1fa7"></a>• [`http_methods`](#methods-2d1fa7) - Optional List Defaults to `METHOD_ANY`<br>Possible values are `METHOD_ANY`, `METHOD_GET`, `METHOD_POST`, `METHOD_PUT`, `METHOD_PATCH`, `METHOD_DELETE`, `METHOD_GET_DOCUMENT`<br>[Enum: METHOD_ANY|METHOD_GET|METHOD_POST|METHOD_PUT|METHOD_PATCH|METHOD_DELETE|METHOD_GET_DOCUMENT] HTTP Methods. List of HTTP methods
|
|
932
932
|
|
|
933
|
-
<a id="metadata-c93137"></a>• [`metadata`](#metadata-c93137) - Optional Block<br>
|
|
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>Can be used for messages where no values are needed
|
|
936
936
|
|
|
937
|
-
<a id="mitigation-cc96eb"></a>• [`mitigation`](#mitigation-cc96eb) - Optional Block<br>
|
|
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>Can be used for messages where no values are needed
|
|
940
940
|
|
|
941
|
-
<a id="path-d5ee15"></a>• [`path`](#path-d5ee15) - Optional Block<br>Path
|
|
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
|
|
|
943
|
-
<a id="protocol-21c1f1"></a>• [`protocol`](#protocol-21c1f1) - Optional String Defaults to `BOTH`<br>Possible values are `BOTH`, `HTTP`, `HTTPS`<br>[Enum: BOTH|HTTP|HTTPS]
|
|
943
|
+
<a id="protocol-21c1f1"></a>• [`protocol`](#protocol-21c1f1) - Optional String Defaults to `BOTH`<br>Possible values are `BOTH`, `HTTP`, `HTTPS`<br>[Enum: BOTH|HTTP|HTTPS] SchemeType is used to indicate URL scheme. - BOTH: BOTH URL scheme for HTTPS:// or HTTP://. - HTTP: HTTP URL scheme HTTP:// only. - HTTPS: HTTPS URL scheme HTTPS:// only
|
|
944
944
|
|
|
945
|
-
<a id="params-8f5791"></a>• [`query_params`](#params-8f5791) - Optional Block<br>
|
|
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>Can be used for messages where no values are needed
|
|
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>Can be used for messages where no values are needed
|
|
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
|
|
|
@@ -954,11 +954,11 @@ A [`protected_app_endpoints`](#endpoints-01a2f3) block (within [`bot_defense.pol
|
|
|
954
954
|
|
|
955
955
|
A [`domain`](#domain-18bf1a) block (within [`bot_defense.policy.protected_app_endpoints`](#endpoints-01a2f3)) supports the following:
|
|
956
956
|
|
|
957
|
-
<a id="value-d5b836"></a>• [`exact_value`](#value-d5b836) - Optional String<br>Exact
|
|
957
|
+
<a id="value-d5b836"></a>• [`exact_value`](#value-d5b836) - Optional String<br>Exact domain name
|
|
958
958
|
|
|
959
|
-
<a id="value-4e4756"></a>• [`regex_value`](#value-4e4756) - Optional String<br>
|
|
959
|
+
<a id="value-4e4756"></a>• [`regex_value`](#value-4e4756) - Optional String<br>Regular Expression value for the domain name
|
|
960
960
|
|
|
961
|
-
<a id="value-89654e"></a>• [`suffix_value`](#value-89654e) - Optional String<br>Suffix
|
|
961
|
+
<a id="value-89654e"></a>• [`suffix_value`](#value-89654e) - Optional String<br>Suffix of domain name e.g 'xyz.com' will match '*.xyz.com' and 'xyz.com'
|
|
962
962
|
|
|
963
963
|
#### Bot Defense Policy Protected App Endpoints Flow Label
|
|
964
964
|
|
|
@@ -1012,15 +1012,15 @@ 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>Can be used for messages where no values are needed
|
|
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>Can be used for messages where no values are needed
|
|
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
|
|
|
1021
|
-
<a id="item-ca0df2"></a>• [`item`](#item-ca0df2) - Optional Block<br>Matcher
|
|
1021
|
+
<a id="item-ca0df2"></a>• [`item`](#item-ca0df2) - 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 [Item](#item-ca0df2) below.
|
|
1022
1022
|
|
|
1023
|
-
<a id="name-34d16a"></a>• [`name`](#name-34d16a) - Optional String<br>
|
|
1023
|
+
<a id="name-34d16a"></a>• [`name`](#name-34d16a) - Optional String<br>Case-insensitive HTTP header name
|
|
1024
1024
|
|
|
1025
1025
|
#### Bot Defense Policy Protected App Endpoints Headers Item
|
|
1026
1026
|
|
|
@@ -1032,13 +1032,13 @@ A [`metadata`](#metadata-c93137) block (within [`bot_defense.policy.protected_ap
|
|
|
1032
1032
|
|
|
1033
1033
|
<a id="spec-e767de"></a>• [`description_spec`](#spec-e767de) - Optional String<br>Description. Human readable description
|
|
1034
1034
|
|
|
1035
|
-
<a id="name-324216"></a>• [`name`](#name-324216) - Optional String<br>Name
|
|
1035
|
+
<a id="name-324216"></a>• [`name`](#name-324216) - Optional String<br>Name of the message. The value of name has to follow DNS-1035 format
|
|
1036
1036
|
|
|
1037
1037
|
#### Bot Defense Policy Protected App Endpoints Mitigation
|
|
1038
1038
|
|
|
1039
1039
|
A [`mitigation`](#mitigation-cc96eb) block (within [`bot_defense.policy.protected_app_endpoints`](#endpoints-01a2f3)) supports the following:
|
|
1040
1040
|
|
|
1041
|
-
<a id="block-d25b81"></a>• [`block`](#block-d25b81) - Optional Block<br>Block
|
|
1041
|
+
<a id="block-d25b81"></a>• [`block`](#block-d25b81) - Optional Block<br>Block request and respond with custom content<br>See [Block](#block-d25b81) below.
|
|
1042
1042
|
|
|
1043
1043
|
<a id="flag-50a52b"></a>• [`flag`](#flag-50a52b) - Optional Block<br>Select Flag Bot Mitigation Action. Flag mitigation action<br>See [Flag](#flag-50a52b) below.
|
|
1044
1044
|
|
|
@@ -1064,11 +1064,11 @@ A [`mitigation`](#mitigation-cc96eb) block (within [`bot_defense.policy.protecte
|
|
|
1064
1064
|
|
|
1065
1065
|
A [`path`](#path-d5ee15) block (within [`bot_defense.policy.protected_app_endpoints`](#endpoints-01a2f3)) supports the following:
|
|
1066
1066
|
|
|
1067
|
-
<a id="path-16664a"></a>• [`path`](#path-16664a) - Optional String<br>Exact
|
|
1067
|
+
<a id="path-16664a"></a>• [`path`](#path-16664a) - Optional String<br>Exact path value to match
|
|
1068
1068
|
|
|
1069
|
-
<a id="prefix-5a090b"></a>• [`prefix`](#prefix-5a090b) - Optional String<br>
|
|
1069
|
+
<a id="prefix-5a090b"></a>• [`prefix`](#prefix-5a090b) - Optional String<br>Path prefix to match (e.g. The value / will match on all paths)
|
|
1070
1070
|
|
|
1071
|
-
<a id="regex-1a10e9"></a>• [`regex`](#regex-1a10e9) - Optional String<br>
|
|
1071
|
+
<a id="regex-1a10e9"></a>• [`regex`](#regex-1a10e9) - Optional String<br>Regular expression of path match (e.g. The value .* will match on all paths)
|
|
1072
1072
|
|
|
1073
1073
|
#### Bot Defense Policy Protected App Endpoints Query Params
|
|
1074
1074
|
|
|
@@ -1086,27 +1086,27 @@ A [`path`](#path-d5ee15) block (within [`bot_defense.policy.protected_app_endpoi
|
|
|
1086
1086
|
|
|
1087
1087
|
A [`captcha_challenge`](#captcha-challenge) block supports the following:
|
|
1088
1088
|
|
|
1089
|
-
<a id="captcha-challenge-cookie-expiry"></a>• [`cookie_expiry`](#captcha-challenge-cookie-expiry) - Optional Number<br>Cookie
|
|
1089
|
+
<a id="captcha-challenge-cookie-expiry"></a>• [`cookie_expiry`](#captcha-challenge-cookie-expiry) - Optional Number<br>Cookie expiration period, in seconds. An expired cookie causes the loadbalancer to issue a new challenge
|
|
1090
1090
|
|
|
1091
|
-
<a id="captcha-challenge-custom-page"></a>• [`custom_page`](#captcha-challenge-custom-page) - Optional String<br>Custom message
|
|
1091
|
+
<a id="captcha-challenge-custom-page"></a>• [`custom_page`](#captcha-challenge-custom-page) - Optional String<br>Custom message is of type uri_ref. Currently supported URL schemes is string:///. For string:/// scheme, message needs to be encoded in Base64 format
|
|
1092
1092
|
|
|
1093
1093
|
#### Client Side Defense
|
|
1094
1094
|
|
|
1095
1095
|
A [`client_side_defense`](#client-side-defense) block supports the following:
|
|
1096
1096
|
|
|
1097
|
-
<a id="client-side-defense-policy"></a>• [`policy`](#client-side-defense-policy) - Optional Block<br>
|
|
1097
|
+
<a id="client-side-defense-policy"></a>• [`policy`](#client-side-defense-policy) - Optional Block<br>Defines various configuration OPTIONS for Client-Side Defense policy<br>See [Policy](#client-side-defense-policy) below.
|
|
1098
1098
|
|
|
1099
1099
|
#### Client Side Defense Policy
|
|
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>Can be used for messages where no values are needed
|
|
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>Can be used for messages where no values are needed
|
|
1106
1106
|
|
|
1107
|
-
<a id="except-7bfe85"></a>• [`js_insert_all_pages_except`](#except-7bfe85) - Optional Block<br>Insert
|
|
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
|
|
|
1109
|
-
<a id="rules-ad3671"></a>• [`js_insertion_rules`](#rules-ad3671) - Optional Block<br>
|
|
1109
|
+
<a id="rules-ad3671"></a>• [`js_insertion_rules`](#rules-ad3671) - Optional Block<br>Defines custom JavaScript insertion rules for Client-Side Defense Policy<br>See [Js Insertion Rules](#rules-ad3671) below.
|
|
1110
1110
|
|
|
1111
1111
|
#### Client Side Defense Policy Js Insert All Pages Except
|
|
1112
1112
|
|
|
@@ -1132,9 +1132,9 @@ A [`policy`](#client-side-defense-policy) block (within [`client_side_defense`](
|
|
|
1132
1132
|
|
|
1133
1133
|
A [`js_insertion_rules`](#rules-ad3671) block (within [`client_side_defense.policy`](#client-side-defense-policy)) supports the following:
|
|
1134
1134
|
|
|
1135
|
-
<a id="list-dfecb6"></a>• [`exclude_list`](#list-dfecb6) - Optional Block<br>
|
|
1135
|
+
<a id="list-dfecb6"></a>• [`exclude_list`](#list-dfecb6) - Optional Block<br>Optional JavaScript insertions exclude list of domain and path matchers<br>See [Exclude List](#list-dfecb6) below.
|
|
1136
1136
|
|
|
1137
|
-
<a id="rules-6276bc"></a>• [`rules`](#rules-6276bc) - Optional Block<br>
|
|
1137
|
+
<a id="rules-6276bc"></a>• [`rules`](#rules-6276bc) - Optional Block<br>Required list of pages to insert Client-Side Defense client JavaScript<br>See [Rules](#rules-6276bc) below.
|
|
1138
1138
|
|
|
1139
1139
|
#### Client Side Defense Policy Js Insertion Rules Exclude List
|
|
1140
1140
|
|
|
@@ -1172,71 +1172,71 @@ A [`js_insertion_rules`](#rules-ad3671) block (within [`client_side_defense.poli
|
|
|
1172
1172
|
|
|
1173
1173
|
A [`cors_policy`](#cors-policy) block supports the following:
|
|
1174
1174
|
|
|
1175
|
-
<a id="cors-policy-allow-credentials"></a>• [`allow_credentials`](#cors-policy-allow-credentials) - Optional Bool<br>
|
|
1175
|
+
<a id="cors-policy-allow-credentials"></a>• [`allow_credentials`](#cors-policy-allow-credentials) - Optional Bool<br>Specifies whether the resource allows credentials
|
|
1176
1176
|
|
|
1177
|
-
<a id="cors-policy-allow-headers"></a>• [`allow_headers`](#cors-policy-allow-headers) - Optional String<br>
|
|
1177
|
+
<a id="cors-policy-allow-headers"></a>• [`allow_headers`](#cors-policy-allow-headers) - Optional String<br>Specifies the content for the access-control-allow-headers header
|
|
1178
1178
|
|
|
1179
|
-
<a id="cors-policy-allow-methods"></a>• [`allow_methods`](#cors-policy-allow-methods) - Optional String<br>
|
|
1179
|
+
<a id="cors-policy-allow-methods"></a>• [`allow_methods`](#cors-policy-allow-methods) - Optional String<br>Specifies the content for the access-control-allow-methods header
|
|
1180
1180
|
|
|
1181
|
-
<a id="cors-policy-allow-origin"></a>• [`allow_origin`](#cors-policy-allow-origin) - Optional List<br>
|
|
1181
|
+
<a id="cors-policy-allow-origin"></a>• [`allow_origin`](#cors-policy-allow-origin) - Optional List<br>Specifies the origins that will be allowed to do CORS requests. An origin is allowed if either allow_origin or allow_origin_regex match
|
|
1182
1182
|
|
|
1183
|
-
<a id="cors-policy-allow-origin-regex"></a>• [`allow_origin_regex`](#cors-policy-allow-origin-regex) - Optional List<br>
|
|
1183
|
+
<a id="cors-policy-allow-origin-regex"></a>• [`allow_origin_regex`](#cors-policy-allow-origin-regex) - Optional List<br>Specifies regex patterns that match allowed origins. An origin is allowed if either allow_origin or allow_origin_regex match
|
|
1184
1184
|
|
|
1185
|
-
<a id="cors-policy-disabled"></a>• [`disabled`](#cors-policy-disabled) - Optional Bool<br>
|
|
1185
|
+
<a id="cors-policy-disabled"></a>• [`disabled`](#cors-policy-disabled) - Optional Bool<br>Disable the CorsPolicy for a particular route. This is useful when virtual-host has CorsPolicy, but we need to disable it on a specific route. The value of this field is ignored for virtual-host
|
|
1186
1186
|
|
|
1187
|
-
<a id="cors-policy-expose-headers"></a>• [`expose_headers`](#cors-policy-expose-headers) - Optional String<br>
|
|
1187
|
+
<a id="cors-policy-expose-headers"></a>• [`expose_headers`](#cors-policy-expose-headers) - Optional String<br>Specifies the content for the access-control-expose-headers header
|
|
1188
1188
|
|
|
1189
|
-
<a id="cors-policy-maximum-age"></a>• [`maximum_age`](#cors-policy-maximum-age) - Optional Number<br>
|
|
1189
|
+
<a id="cors-policy-maximum-age"></a>• [`maximum_age`](#cors-policy-maximum-age) - Optional Number<br>Specifies the content for the access-control-max-age header in seconds. This indicates the maximum number of seconds the results can be cached A value of -1 will disable caching. Maximum permitted value is 86400 seconds (24 hours)
|
|
1190
1190
|
|
|
1191
1191
|
#### CSRF Policy
|
|
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>Can be used for messages where no values are needed
|
|
1196
1196
|
|
|
1197
|
-
<a id="csrf-policy-custom-domain-list"></a>• [`custom_domain_list`](#csrf-policy-custom-domain-list) - Optional Block<br>
|
|
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>Can be used for messages where no values are needed
|
|
1200
1200
|
|
|
1201
1201
|
#### CSRF Policy Custom Domain List
|
|
1202
1202
|
|
|
1203
1203
|
A [`custom_domain_list`](#csrf-policy-custom-domain-list) block (within [`csrf_policy`](#csrf-policy)) supports the following:
|
|
1204
1204
|
|
|
1205
|
-
<a id="csrf-policy-custom-domain-list-domains"></a>• [`domains`](#csrf-policy-custom-domain-list-domains) - Optional List<br>
|
|
1205
|
+
<a id="csrf-policy-custom-domain-list-domains"></a>• [`domains`](#csrf-policy-custom-domain-list-domains) - Optional List<br>List of domain names that will be matched to loadbalancer. These domains are not used for SNI match. Wildcard names are supported in the suffix or prefix form
|
|
1206
1206
|
|
|
1207
1207
|
#### Custom Cache Rule
|
|
1208
1208
|
|
|
1209
1209
|
A [`custom_cache_rule`](#custom-cache-rule) block supports the following:
|
|
1210
1210
|
|
|
1211
|
-
<a id="custom-cache-rule-cdn-cache-rules"></a>• [`cdn_cache_rules`](#custom-cache-rule-cdn-cache-rules) - Optional Block<br>
|
|
1211
|
+
<a id="custom-cache-rule-cdn-cache-rules"></a>• [`cdn_cache_rules`](#custom-cache-rule-cdn-cache-rules) - Optional Block<br>Reference to CDN Cache Rule configuration object<br>See [CDN Cache Rules](#custom-cache-rule-cdn-cache-rules) below.
|
|
1212
1212
|
|
|
1213
1213
|
#### Custom Cache Rule CDN Cache Rules
|
|
1214
1214
|
|
|
1215
1215
|
A [`cdn_cache_rules`](#custom-cache-rule-cdn-cache-rules) block (within [`custom_cache_rule`](#custom-cache-rule)) supports the following:
|
|
1216
1216
|
|
|
1217
|
-
<a id="custom-cache-rule-cdn-cache-rules-name"></a>• [`name`](#custom-cache-rule-cdn-cache-rules-name) - Optional String<br>
|
|
1217
|
+
<a id="custom-cache-rule-cdn-cache-rules-name"></a>• [`name`](#custom-cache-rule-cdn-cache-rules-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
|
|
1218
1218
|
|
|
1219
|
-
<a id="namespace-953951"></a>• [`namespace`](#namespace-953951) - Optional String<br>
|
|
1219
|
+
<a id="namespace-953951"></a>• [`namespace`](#namespace-953951) - 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
|
|
1220
1220
|
|
|
1221
|
-
<a id="tenant-f1c5ea"></a>• [`tenant`](#tenant-f1c5ea) - Optional String<br>
|
|
1221
|
+
<a id="tenant-f1c5ea"></a>• [`tenant`](#tenant-f1c5ea) - 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
|
|
1222
1222
|
|
|
1223
1223
|
#### Data Guard Rules
|
|
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>Can be used for messages where no values are needed
|
|
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>Can be used for messages where no values are needed
|
|
1230
1230
|
|
|
1231
|
-
<a id="data-guard-rules-exact-value"></a>• [`exact_value`](#data-guard-rules-exact-value) - Optional String<br>Exact
|
|
1231
|
+
<a id="data-guard-rules-exact-value"></a>• [`exact_value`](#data-guard-rules-exact-value) - Optional String<br>Exact domain name
|
|
1232
1232
|
|
|
1233
|
-
<a id="data-guard-rules-metadata"></a>• [`metadata`](#data-guard-rules-metadata) - Optional Block<br>
|
|
1233
|
+
<a id="data-guard-rules-metadata"></a>• [`metadata`](#data-guard-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](#data-guard-rules-metadata) below.
|
|
1234
1234
|
|
|
1235
|
-
<a id="data-guard-rules-path"></a>• [`path`](#data-guard-rules-path) - Optional Block<br>Path
|
|
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>Can be used for messages where no values are needed
|
|
1238
1238
|
|
|
1239
|
-
<a id="data-guard-rules-suffix-value"></a>• [`suffix_value`](#data-guard-rules-suffix-value) - Optional String<br>Suffix
|
|
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
|
|
|
1241
1241
|
#### Data Guard Rules Metadata
|
|
1242
1242
|
|
|
@@ -1244,43 +1244,43 @@ A [`metadata`](#data-guard-rules-metadata) block (within [`data_guard_rules`](#d
|
|
|
1244
1244
|
|
|
1245
1245
|
<a id="spec-bca77c"></a>• [`description_spec`](#spec-bca77c) - Optional String<br>Description. Human readable description
|
|
1246
1246
|
|
|
1247
|
-
<a id="data-guard-rules-metadata-name"></a>• [`name`](#data-guard-rules-metadata-name) - Optional String<br>Name
|
|
1247
|
+
<a id="data-guard-rules-metadata-name"></a>• [`name`](#data-guard-rules-metadata-name) - Optional String<br>Name of the message. The value of name has to follow DNS-1035 format
|
|
1248
1248
|
|
|
1249
1249
|
#### Data Guard Rules Path
|
|
1250
1250
|
|
|
1251
1251
|
A [`path`](#data-guard-rules-path) block (within [`data_guard_rules`](#data-guard-rules)) supports the following:
|
|
1252
1252
|
|
|
1253
|
-
<a id="data-guard-rules-path-path"></a>• [`path`](#data-guard-rules-path-path) - Optional String<br>Exact
|
|
1253
|
+
<a id="data-guard-rules-path-path"></a>• [`path`](#data-guard-rules-path-path) - Optional String<br>Exact path value to match
|
|
1254
1254
|
|
|
1255
|
-
<a id="data-guard-rules-path-prefix"></a>• [`prefix`](#data-guard-rules-path-prefix) - Optional String<br>
|
|
1255
|
+
<a id="data-guard-rules-path-prefix"></a>• [`prefix`](#data-guard-rules-path-prefix) - Optional String<br>Path prefix to match (e.g. The value / will match on all paths)
|
|
1256
1256
|
|
|
1257
|
-
<a id="data-guard-rules-path-regex"></a>• [`regex`](#data-guard-rules-path-regex) - Optional String<br>
|
|
1257
|
+
<a id="data-guard-rules-path-regex"></a>• [`regex`](#data-guard-rules-path-regex) - Optional String<br>Regular expression of path match (e.g. The value .* will match on all paths)
|
|
1258
1258
|
|
|
1259
1259
|
#### DDOS Mitigation Rules
|
|
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>Can be used for messages where no values are needed
|
|
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
|
|
|
1267
|
-
<a id="timestamp-bd6f49"></a>• [`expiration_timestamp`](#timestamp-bd6f49) - Optional String<br>
|
|
1267
|
+
<a id="timestamp-bd6f49"></a>• [`expiration_timestamp`](#timestamp-bd6f49) - 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
|
|
1268
1268
|
|
|
1269
|
-
<a id="ddos-mitigation-rules-ip-prefix-list"></a>• [`ip_prefix_list`](#ddos-mitigation-rules-ip-prefix-list) - Optional Block<br>
|
|
1269
|
+
<a id="ddos-mitigation-rules-ip-prefix-list"></a>• [`ip_prefix_list`](#ddos-mitigation-rules-ip-prefix-list) - Optional Block<br>List of IP Prefix strings to match against<br>See [IP Prefix List](#ddos-mitigation-rules-ip-prefix-list) below.
|
|
1270
1270
|
|
|
1271
|
-
<a id="ddos-mitigation-rules-metadata"></a>• [`metadata`](#ddos-mitigation-rules-metadata) - Optional Block<br>
|
|
1271
|
+
<a id="ddos-mitigation-rules-metadata"></a>• [`metadata`](#ddos-mitigation-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](#ddos-mitigation-rules-metadata) below.
|
|
1272
1272
|
|
|
1273
1273
|
#### DDOS Mitigation Rules DDOS Client Source
|
|
1274
1274
|
|
|
1275
1275
|
A [`ddos_client_source`](#source-02aa55) block (within [`ddos_mitigation_rules`](#ddos-mitigation-rules)) supports the following:
|
|
1276
1276
|
|
|
1277
|
-
<a id="list-20cb78"></a>• [`asn_list`](#list-20cb78) - Optional Block<br>
|
|
1277
|
+
<a id="list-20cb78"></a>• [`asn_list`](#list-20cb78) - Optional Block<br>Unordered set of RFC 6793 defined 4-byte AS numbers that can be used to create allow or deny lists for use in network policy or service policy. It can be used to create the allow list only for DNS Load Balancer<br>See [Asn List](#list-20cb78) below.
|
|
1278
1278
|
|
|
1279
|
-
<a id="list-78d261"></a>• [`country_list`](#list-78d261) - Optional List Defaults to `COUNTRY_NONE`<br>Possible values are `COUNTRY_NONE`, `COUNTRY_AD`, `COUNTRY_AE`, `COUNTRY_AF`, `COUNTRY_AG`, `COUNTRY_AI`, `COUNTRY_AL`, `COUNTRY_AM`, `COUNTRY_AN`, `COUNTRY_AO`, `COUNTRY_AQ`, `COUNTRY_AR`, `COUNTRY_AS`, `COUNTRY_AT`, `COUNTRY_AU`, `COUNTRY_AW`, `COUNTRY_AX`, `COUNTRY_AZ`, `COUNTRY_BA`, `COUNTRY_BB`, `COUNTRY_BD`, `COUNTRY_BE`, `COUNTRY_BF`, `COUNTRY_BG`, `COUNTRY_BH`, `COUNTRY_BI`, `COUNTRY_BJ`, `COUNTRY_BL`, `COUNTRY_BM`, `COUNTRY_BN`, `COUNTRY_BO`, `COUNTRY_BQ`, `COUNTRY_BR`, `COUNTRY_BS`, `COUNTRY_BT`, `COUNTRY_BV`, `COUNTRY_BW`, `COUNTRY_BY`, `COUNTRY_BZ`, `COUNTRY_CA`, `COUNTRY_CC`, `COUNTRY_CD`, `COUNTRY_CF`, `COUNTRY_CG`, `COUNTRY_CH`, `COUNTRY_CI`, `COUNTRY_CK`, `COUNTRY_CL`, `COUNTRY_CM`, `COUNTRY_CN`, `COUNTRY_CO`, `COUNTRY_CR`, `COUNTRY_CS`, `COUNTRY_CU`, `COUNTRY_CV`, `COUNTRY_CW`, `COUNTRY_CX`, `COUNTRY_CY`, `COUNTRY_CZ`, `COUNTRY_DE`, `COUNTRY_DJ`, `COUNTRY_DK`, `COUNTRY_DM`, `COUNTRY_DO`, `COUNTRY_DZ`, `COUNTRY_EC`, `COUNTRY_EE`, `COUNTRY_EG`, `COUNTRY_EH`, `COUNTRY_ER`, `COUNTRY_ES`, `COUNTRY_ET`, `COUNTRY_FI`, `COUNTRY_FJ`, `COUNTRY_FK`, `COUNTRY_FM`, `COUNTRY_FO`, `COUNTRY_FR`, `COUNTRY_GA`, `COUNTRY_GB`, `COUNTRY_GD`, `COUNTRY_GE`, `COUNTRY_GF`, `COUNTRY_GG`, `COUNTRY_GH`, `COUNTRY_GI`, `COUNTRY_GL`, `COUNTRY_GM`, `COUNTRY_GN`, `COUNTRY_GP`, `COUNTRY_GQ`, `COUNTRY_GR`, `COUNTRY_GS`, `COUNTRY_GT`, `COUNTRY_GU`, `COUNTRY_GW`, `COUNTRY_GY`, `COUNTRY_HK`, `COUNTRY_HM`, `COUNTRY_HN`, `COUNTRY_HR`, `COUNTRY_HT`, `COUNTRY_HU`, `COUNTRY_ID`, `COUNTRY_IE`, `COUNTRY_IL`, `COUNTRY_IM`, `COUNTRY_IN`, `COUNTRY_IO`, `COUNTRY_IQ`, `COUNTRY_IR`, `COUNTRY_IS`, `COUNTRY_IT`, `COUNTRY_JE`, `COUNTRY_JM`, `COUNTRY_JO`, `COUNTRY_JP`, `COUNTRY_KE`, `COUNTRY_KG`, `COUNTRY_KH`, `COUNTRY_KI`, `COUNTRY_KM`, `COUNTRY_KN`, `COUNTRY_KP`, `COUNTRY_KR`, `COUNTRY_KW`, `COUNTRY_KY`, `COUNTRY_KZ`, `COUNTRY_LA`, `COUNTRY_LB`, `COUNTRY_LC`, `COUNTRY_LI`, `COUNTRY_LK`, `COUNTRY_LR`, `COUNTRY_LS`, `COUNTRY_LT`, `COUNTRY_LU`, `COUNTRY_LV`, `COUNTRY_LY`, `COUNTRY_MA`, `COUNTRY_MC`, `COUNTRY_MD`, `COUNTRY_ME`, `COUNTRY_MF`, `COUNTRY_MG`, `COUNTRY_MH`, `COUNTRY_MK`, `COUNTRY_ML`, `COUNTRY_MM`, `COUNTRY_MN`, `COUNTRY_MO`, `COUNTRY_MP`, `COUNTRY_MQ`, `COUNTRY_MR`, `COUNTRY_MS`, `COUNTRY_MT`, `COUNTRY_MU`, `COUNTRY_MV`, `COUNTRY_MW`, `COUNTRY_MX`, `COUNTRY_MY`, `COUNTRY_MZ`, `COUNTRY_NA`, `COUNTRY_NC`, `COUNTRY_NE`, `COUNTRY_NF`, `COUNTRY_NG`, `COUNTRY_NI`, `COUNTRY_NL`, `COUNTRY_NO`, `COUNTRY_NP`, `COUNTRY_NR`, `COUNTRY_NU`, `COUNTRY_NZ`, `COUNTRY_OM`, `COUNTRY_PA`, `COUNTRY_PE`, `COUNTRY_PF`, `COUNTRY_PG`, `COUNTRY_PH`, `COUNTRY_PK`, `COUNTRY_PL`, `COUNTRY_PM`, `COUNTRY_PN`, `COUNTRY_PR`, `COUNTRY_PS`, `COUNTRY_PT`, `COUNTRY_PW`, `COUNTRY_PY`, `COUNTRY_QA`, `COUNTRY_RE`, `COUNTRY_RO`, `COUNTRY_RS`, `COUNTRY_RU`, `COUNTRY_RW`, `COUNTRY_SA`, `COUNTRY_SB`, `COUNTRY_SC`, `COUNTRY_SD`, `COUNTRY_SE`, `COUNTRY_SG`, `COUNTRY_SH`, `COUNTRY_SI`, `COUNTRY_SJ`, `COUNTRY_SK`, `COUNTRY_SL`, `COUNTRY_SM`, `COUNTRY_SN`, `COUNTRY_SO`, `COUNTRY_SR`, `COUNTRY_SS`, `COUNTRY_ST`, `COUNTRY_SV`, `COUNTRY_SX`, `COUNTRY_SY`, `COUNTRY_SZ`, `COUNTRY_TC`, `COUNTRY_TD`, `COUNTRY_TF`, `COUNTRY_TG`, `COUNTRY_TH`, `COUNTRY_TJ`, `COUNTRY_TK`, `COUNTRY_TL`, `COUNTRY_TM`, `COUNTRY_TN`, `COUNTRY_TO`, `COUNTRY_TR`, `COUNTRY_TT`, `COUNTRY_TV`, `COUNTRY_TW`, `COUNTRY_TZ`, `COUNTRY_UA`, `COUNTRY_UG`, `COUNTRY_UM`, `COUNTRY_US`, `COUNTRY_UY`, `COUNTRY_UZ`, `COUNTRY_VA`, `COUNTRY_VC`, `COUNTRY_VE`, `COUNTRY_VG`, `COUNTRY_VI`, `COUNTRY_VN`, `COUNTRY_VU`, `COUNTRY_WF`, `COUNTRY_WS`, `COUNTRY_XK`, `COUNTRY_XT`, `COUNTRY_YE`, `COUNTRY_YT`, `COUNTRY_ZA`, `COUNTRY_ZM`, `COUNTRY_ZW`<br>[Enum: COUNTRY_NONE|COUNTRY_AD|COUNTRY_AE|COUNTRY_AF|COUNTRY_AG|COUNTRY_AI|COUNTRY_AL|COUNTRY_AM|COUNTRY_AN|COUNTRY_AO|COUNTRY_AQ|COUNTRY_AR|COUNTRY_AS|COUNTRY_AT|COUNTRY_AU|COUNTRY_AW|COUNTRY_AX|COUNTRY_AZ|COUNTRY_BA|COUNTRY_BB|COUNTRY_BD|COUNTRY_BE|COUNTRY_BF|COUNTRY_BG|COUNTRY_BH|COUNTRY_BI|COUNTRY_BJ|COUNTRY_BL|COUNTRY_BM|COUNTRY_BN|COUNTRY_BO|COUNTRY_BQ|COUNTRY_BR|COUNTRY_BS|COUNTRY_BT|COUNTRY_BV|COUNTRY_BW|COUNTRY_BY|COUNTRY_BZ|COUNTRY_CA|COUNTRY_CC|COUNTRY_CD|COUNTRY_CF|COUNTRY_CG|COUNTRY_CH|COUNTRY_CI|COUNTRY_CK|COUNTRY_CL|COUNTRY_CM|COUNTRY_CN|COUNTRY_CO|COUNTRY_CR|COUNTRY_CS|COUNTRY_CU|COUNTRY_CV|COUNTRY_CW|COUNTRY_CX|COUNTRY_CY|COUNTRY_CZ|COUNTRY_DE|COUNTRY_DJ|COUNTRY_DK|COUNTRY_DM|COUNTRY_DO|COUNTRY_DZ|COUNTRY_EC|COUNTRY_EE|COUNTRY_EG|COUNTRY_EH|COUNTRY_ER|COUNTRY_ES|COUNTRY_ET|COUNTRY_FI|COUNTRY_FJ|COUNTRY_FK|COUNTRY_FM|COUNTRY_FO|COUNTRY_FR|COUNTRY_GA|COUNTRY_GB|COUNTRY_GD|COUNTRY_GE|COUNTRY_GF|COUNTRY_GG|COUNTRY_GH|COUNTRY_GI|COUNTRY_GL|COUNTRY_GM|COUNTRY_GN|COUNTRY_GP|COUNTRY_GQ|COUNTRY_GR|COUNTRY_GS|COUNTRY_GT|COUNTRY_GU|COUNTRY_GW|COUNTRY_GY|COUNTRY_HK|COUNTRY_HM|COUNTRY_HN|COUNTRY_HR|COUNTRY_HT|COUNTRY_HU|COUNTRY_ID|COUNTRY_IE|COUNTRY_IL|COUNTRY_IM|COUNTRY_IN|COUNTRY_IO|COUNTRY_IQ|COUNTRY_IR|COUNTRY_IS|COUNTRY_IT|COUNTRY_JE|COUNTRY_JM|COUNTRY_JO|COUNTRY_JP|COUNTRY_KE|COUNTRY_KG|COUNTRY_KH|COUNTRY_KI|COUNTRY_KM|COUNTRY_KN|COUNTRY_KP|COUNTRY_KR|COUNTRY_KW|COUNTRY_KY|COUNTRY_KZ|COUNTRY_LA|COUNTRY_LB|COUNTRY_LC|COUNTRY_LI|COUNTRY_LK|COUNTRY_LR|COUNTRY_LS|COUNTRY_LT|COUNTRY_LU|COUNTRY_LV|COUNTRY_LY|COUNTRY_MA|COUNTRY_MC|COUNTRY_MD|COUNTRY_ME|COUNTRY_MF|COUNTRY_MG|COUNTRY_MH|COUNTRY_MK|COUNTRY_ML|COUNTRY_MM|COUNTRY_MN|COUNTRY_MO|COUNTRY_MP|COUNTRY_MQ|COUNTRY_MR|COUNTRY_MS|COUNTRY_MT|COUNTRY_MU|COUNTRY_MV|COUNTRY_MW|COUNTRY_MX|COUNTRY_MY|COUNTRY_MZ|COUNTRY_NA|COUNTRY_NC|COUNTRY_NE|COUNTRY_NF|COUNTRY_NG|COUNTRY_NI|COUNTRY_NL|COUNTRY_NO|COUNTRY_NP|COUNTRY_NR|COUNTRY_NU|COUNTRY_NZ|COUNTRY_OM|COUNTRY_PA|COUNTRY_PE|COUNTRY_PF|COUNTRY_PG|COUNTRY_PH|COUNTRY_PK|COUNTRY_PL|COUNTRY_PM|COUNTRY_PN|COUNTRY_PR|COUNTRY_PS|COUNTRY_PT|COUNTRY_PW|COUNTRY_PY|COUNTRY_QA|COUNTRY_RE|COUNTRY_RO|COUNTRY_RS|COUNTRY_RU|COUNTRY_RW|COUNTRY_SA|COUNTRY_SB|COUNTRY_SC|COUNTRY_SD|COUNTRY_SE|COUNTRY_SG|COUNTRY_SH|COUNTRY_SI|COUNTRY_SJ|COUNTRY_SK|COUNTRY_SL|COUNTRY_SM|COUNTRY_SN|COUNTRY_SO|COUNTRY_SR|COUNTRY_SS|COUNTRY_ST|COUNTRY_SV|COUNTRY_SX|COUNTRY_SY|COUNTRY_SZ|COUNTRY_TC|COUNTRY_TD|COUNTRY_TF|COUNTRY_TG|COUNTRY_TH|COUNTRY_TJ|COUNTRY_TK|COUNTRY_TL|COUNTRY_TM|COUNTRY_TN|COUNTRY_TO|COUNTRY_TR|COUNTRY_TT|COUNTRY_TV|COUNTRY_TW|COUNTRY_TZ|COUNTRY_UA|COUNTRY_UG|COUNTRY_UM|COUNTRY_US|COUNTRY_UY|COUNTRY_UZ|COUNTRY_VA|COUNTRY_VC|COUNTRY_VE|COUNTRY_VG|COUNTRY_VI|COUNTRY_VN|COUNTRY_VU|COUNTRY_WF|COUNTRY_WS|COUNTRY_XK|COUNTRY_XT|COUNTRY_YE|COUNTRY_YT|COUNTRY_ZA|COUNTRY_ZM|COUNTRY_ZW]
|
|
1279
|
+
<a id="list-78d261"></a>• [`country_list`](#list-78d261) - Optional List Defaults to `COUNTRY_NONE`<br>Possible values are `COUNTRY_NONE`, `COUNTRY_AD`, `COUNTRY_AE`, `COUNTRY_AF`, `COUNTRY_AG`, `COUNTRY_AI`, `COUNTRY_AL`, `COUNTRY_AM`, `COUNTRY_AN`, `COUNTRY_AO`, `COUNTRY_AQ`, `COUNTRY_AR`, `COUNTRY_AS`, `COUNTRY_AT`, `COUNTRY_AU`, `COUNTRY_AW`, `COUNTRY_AX`, `COUNTRY_AZ`, `COUNTRY_BA`, `COUNTRY_BB`, `COUNTRY_BD`, `COUNTRY_BE`, `COUNTRY_BF`, `COUNTRY_BG`, `COUNTRY_BH`, `COUNTRY_BI`, `COUNTRY_BJ`, `COUNTRY_BL`, `COUNTRY_BM`, `COUNTRY_BN`, `COUNTRY_BO`, `COUNTRY_BQ`, `COUNTRY_BR`, `COUNTRY_BS`, `COUNTRY_BT`, `COUNTRY_BV`, `COUNTRY_BW`, `COUNTRY_BY`, `COUNTRY_BZ`, `COUNTRY_CA`, `COUNTRY_CC`, `COUNTRY_CD`, `COUNTRY_CF`, `COUNTRY_CG`, `COUNTRY_CH`, `COUNTRY_CI`, `COUNTRY_CK`, `COUNTRY_CL`, `COUNTRY_CM`, `COUNTRY_CN`, `COUNTRY_CO`, `COUNTRY_CR`, `COUNTRY_CS`, `COUNTRY_CU`, `COUNTRY_CV`, `COUNTRY_CW`, `COUNTRY_CX`, `COUNTRY_CY`, `COUNTRY_CZ`, `COUNTRY_DE`, `COUNTRY_DJ`, `COUNTRY_DK`, `COUNTRY_DM`, `COUNTRY_DO`, `COUNTRY_DZ`, `COUNTRY_EC`, `COUNTRY_EE`, `COUNTRY_EG`, `COUNTRY_EH`, `COUNTRY_ER`, `COUNTRY_ES`, `COUNTRY_ET`, `COUNTRY_FI`, `COUNTRY_FJ`, `COUNTRY_FK`, `COUNTRY_FM`, `COUNTRY_FO`, `COUNTRY_FR`, `COUNTRY_GA`, `COUNTRY_GB`, `COUNTRY_GD`, `COUNTRY_GE`, `COUNTRY_GF`, `COUNTRY_GG`, `COUNTRY_GH`, `COUNTRY_GI`, `COUNTRY_GL`, `COUNTRY_GM`, `COUNTRY_GN`, `COUNTRY_GP`, `COUNTRY_GQ`, `COUNTRY_GR`, `COUNTRY_GS`, `COUNTRY_GT`, `COUNTRY_GU`, `COUNTRY_GW`, `COUNTRY_GY`, `COUNTRY_HK`, `COUNTRY_HM`, `COUNTRY_HN`, `COUNTRY_HR`, `COUNTRY_HT`, `COUNTRY_HU`, `COUNTRY_ID`, `COUNTRY_IE`, `COUNTRY_IL`, `COUNTRY_IM`, `COUNTRY_IN`, `COUNTRY_IO`, `COUNTRY_IQ`, `COUNTRY_IR`, `COUNTRY_IS`, `COUNTRY_IT`, `COUNTRY_JE`, `COUNTRY_JM`, `COUNTRY_JO`, `COUNTRY_JP`, `COUNTRY_KE`, `COUNTRY_KG`, `COUNTRY_KH`, `COUNTRY_KI`, `COUNTRY_KM`, `COUNTRY_KN`, `COUNTRY_KP`, `COUNTRY_KR`, `COUNTRY_KW`, `COUNTRY_KY`, `COUNTRY_KZ`, `COUNTRY_LA`, `COUNTRY_LB`, `COUNTRY_LC`, `COUNTRY_LI`, `COUNTRY_LK`, `COUNTRY_LR`, `COUNTRY_LS`, `COUNTRY_LT`, `COUNTRY_LU`, `COUNTRY_LV`, `COUNTRY_LY`, `COUNTRY_MA`, `COUNTRY_MC`, `COUNTRY_MD`, `COUNTRY_ME`, `COUNTRY_MF`, `COUNTRY_MG`, `COUNTRY_MH`, `COUNTRY_MK`, `COUNTRY_ML`, `COUNTRY_MM`, `COUNTRY_MN`, `COUNTRY_MO`, `COUNTRY_MP`, `COUNTRY_MQ`, `COUNTRY_MR`, `COUNTRY_MS`, `COUNTRY_MT`, `COUNTRY_MU`, `COUNTRY_MV`, `COUNTRY_MW`, `COUNTRY_MX`, `COUNTRY_MY`, `COUNTRY_MZ`, `COUNTRY_NA`, `COUNTRY_NC`, `COUNTRY_NE`, `COUNTRY_NF`, `COUNTRY_NG`, `COUNTRY_NI`, `COUNTRY_NL`, `COUNTRY_NO`, `COUNTRY_NP`, `COUNTRY_NR`, `COUNTRY_NU`, `COUNTRY_NZ`, `COUNTRY_OM`, `COUNTRY_PA`, `COUNTRY_PE`, `COUNTRY_PF`, `COUNTRY_PG`, `COUNTRY_PH`, `COUNTRY_PK`, `COUNTRY_PL`, `COUNTRY_PM`, `COUNTRY_PN`, `COUNTRY_PR`, `COUNTRY_PS`, `COUNTRY_PT`, `COUNTRY_PW`, `COUNTRY_PY`, `COUNTRY_QA`, `COUNTRY_RE`, `COUNTRY_RO`, `COUNTRY_RS`, `COUNTRY_RU`, `COUNTRY_RW`, `COUNTRY_SA`, `COUNTRY_SB`, `COUNTRY_SC`, `COUNTRY_SD`, `COUNTRY_SE`, `COUNTRY_SG`, `COUNTRY_SH`, `COUNTRY_SI`, `COUNTRY_SJ`, `COUNTRY_SK`, `COUNTRY_SL`, `COUNTRY_SM`, `COUNTRY_SN`, `COUNTRY_SO`, `COUNTRY_SR`, `COUNTRY_SS`, `COUNTRY_ST`, `COUNTRY_SV`, `COUNTRY_SX`, `COUNTRY_SY`, `COUNTRY_SZ`, `COUNTRY_TC`, `COUNTRY_TD`, `COUNTRY_TF`, `COUNTRY_TG`, `COUNTRY_TH`, `COUNTRY_TJ`, `COUNTRY_TK`, `COUNTRY_TL`, `COUNTRY_TM`, `COUNTRY_TN`, `COUNTRY_TO`, `COUNTRY_TR`, `COUNTRY_TT`, `COUNTRY_TV`, `COUNTRY_TW`, `COUNTRY_TZ`, `COUNTRY_UA`, `COUNTRY_UG`, `COUNTRY_UM`, `COUNTRY_US`, `COUNTRY_UY`, `COUNTRY_UZ`, `COUNTRY_VA`, `COUNTRY_VC`, `COUNTRY_VE`, `COUNTRY_VG`, `COUNTRY_VI`, `COUNTRY_VN`, `COUNTRY_VU`, `COUNTRY_WF`, `COUNTRY_WS`, `COUNTRY_XK`, `COUNTRY_XT`, `COUNTRY_YE`, `COUNTRY_YT`, `COUNTRY_ZA`, `COUNTRY_ZM`, `COUNTRY_ZW`<br>[Enum: COUNTRY_NONE|COUNTRY_AD|COUNTRY_AE|COUNTRY_AF|COUNTRY_AG|COUNTRY_AI|COUNTRY_AL|COUNTRY_AM|COUNTRY_AN|COUNTRY_AO|COUNTRY_AQ|COUNTRY_AR|COUNTRY_AS|COUNTRY_AT|COUNTRY_AU|COUNTRY_AW|COUNTRY_AX|COUNTRY_AZ|COUNTRY_BA|COUNTRY_BB|COUNTRY_BD|COUNTRY_BE|COUNTRY_BF|COUNTRY_BG|COUNTRY_BH|COUNTRY_BI|COUNTRY_BJ|COUNTRY_BL|COUNTRY_BM|COUNTRY_BN|COUNTRY_BO|COUNTRY_BQ|COUNTRY_BR|COUNTRY_BS|COUNTRY_BT|COUNTRY_BV|COUNTRY_BW|COUNTRY_BY|COUNTRY_BZ|COUNTRY_CA|COUNTRY_CC|COUNTRY_CD|COUNTRY_CF|COUNTRY_CG|COUNTRY_CH|COUNTRY_CI|COUNTRY_CK|COUNTRY_CL|COUNTRY_CM|COUNTRY_CN|COUNTRY_CO|COUNTRY_CR|COUNTRY_CS|COUNTRY_CU|COUNTRY_CV|COUNTRY_CW|COUNTRY_CX|COUNTRY_CY|COUNTRY_CZ|COUNTRY_DE|COUNTRY_DJ|COUNTRY_DK|COUNTRY_DM|COUNTRY_DO|COUNTRY_DZ|COUNTRY_EC|COUNTRY_EE|COUNTRY_EG|COUNTRY_EH|COUNTRY_ER|COUNTRY_ES|COUNTRY_ET|COUNTRY_FI|COUNTRY_FJ|COUNTRY_FK|COUNTRY_FM|COUNTRY_FO|COUNTRY_FR|COUNTRY_GA|COUNTRY_GB|COUNTRY_GD|COUNTRY_GE|COUNTRY_GF|COUNTRY_GG|COUNTRY_GH|COUNTRY_GI|COUNTRY_GL|COUNTRY_GM|COUNTRY_GN|COUNTRY_GP|COUNTRY_GQ|COUNTRY_GR|COUNTRY_GS|COUNTRY_GT|COUNTRY_GU|COUNTRY_GW|COUNTRY_GY|COUNTRY_HK|COUNTRY_HM|COUNTRY_HN|COUNTRY_HR|COUNTRY_HT|COUNTRY_HU|COUNTRY_ID|COUNTRY_IE|COUNTRY_IL|COUNTRY_IM|COUNTRY_IN|COUNTRY_IO|COUNTRY_IQ|COUNTRY_IR|COUNTRY_IS|COUNTRY_IT|COUNTRY_JE|COUNTRY_JM|COUNTRY_JO|COUNTRY_JP|COUNTRY_KE|COUNTRY_KG|COUNTRY_KH|COUNTRY_KI|COUNTRY_KM|COUNTRY_KN|COUNTRY_KP|COUNTRY_KR|COUNTRY_KW|COUNTRY_KY|COUNTRY_KZ|COUNTRY_LA|COUNTRY_LB|COUNTRY_LC|COUNTRY_LI|COUNTRY_LK|COUNTRY_LR|COUNTRY_LS|COUNTRY_LT|COUNTRY_LU|COUNTRY_LV|COUNTRY_LY|COUNTRY_MA|COUNTRY_MC|COUNTRY_MD|COUNTRY_ME|COUNTRY_MF|COUNTRY_MG|COUNTRY_MH|COUNTRY_MK|COUNTRY_ML|COUNTRY_MM|COUNTRY_MN|COUNTRY_MO|COUNTRY_MP|COUNTRY_MQ|COUNTRY_MR|COUNTRY_MS|COUNTRY_MT|COUNTRY_MU|COUNTRY_MV|COUNTRY_MW|COUNTRY_MX|COUNTRY_MY|COUNTRY_MZ|COUNTRY_NA|COUNTRY_NC|COUNTRY_NE|COUNTRY_NF|COUNTRY_NG|COUNTRY_NI|COUNTRY_NL|COUNTRY_NO|COUNTRY_NP|COUNTRY_NR|COUNTRY_NU|COUNTRY_NZ|COUNTRY_OM|COUNTRY_PA|COUNTRY_PE|COUNTRY_PF|COUNTRY_PG|COUNTRY_PH|COUNTRY_PK|COUNTRY_PL|COUNTRY_PM|COUNTRY_PN|COUNTRY_PR|COUNTRY_PS|COUNTRY_PT|COUNTRY_PW|COUNTRY_PY|COUNTRY_QA|COUNTRY_RE|COUNTRY_RO|COUNTRY_RS|COUNTRY_RU|COUNTRY_RW|COUNTRY_SA|COUNTRY_SB|COUNTRY_SC|COUNTRY_SD|COUNTRY_SE|COUNTRY_SG|COUNTRY_SH|COUNTRY_SI|COUNTRY_SJ|COUNTRY_SK|COUNTRY_SL|COUNTRY_SM|COUNTRY_SN|COUNTRY_SO|COUNTRY_SR|COUNTRY_SS|COUNTRY_ST|COUNTRY_SV|COUNTRY_SX|COUNTRY_SY|COUNTRY_SZ|COUNTRY_TC|COUNTRY_TD|COUNTRY_TF|COUNTRY_TG|COUNTRY_TH|COUNTRY_TJ|COUNTRY_TK|COUNTRY_TL|COUNTRY_TM|COUNTRY_TN|COUNTRY_TO|COUNTRY_TR|COUNTRY_TT|COUNTRY_TV|COUNTRY_TW|COUNTRY_TZ|COUNTRY_UA|COUNTRY_UG|COUNTRY_UM|COUNTRY_US|COUNTRY_UY|COUNTRY_UZ|COUNTRY_VA|COUNTRY_VC|COUNTRY_VE|COUNTRY_VG|COUNTRY_VI|COUNTRY_VN|COUNTRY_VU|COUNTRY_WF|COUNTRY_WS|COUNTRY_XK|COUNTRY_XT|COUNTRY_YE|COUNTRY_YT|COUNTRY_ZA|COUNTRY_ZM|COUNTRY_ZW] Sources that are located in one of the countries in the given list
|
|
1280
1280
|
|
|
1281
|
-
<a id="matcher-a7a10e"></a>• [`ja4_tls_fingerprint_matcher`](#matcher-a7a10e) - Optional Block<br>
|
|
1281
|
+
<a id="matcher-a7a10e"></a>• [`ja4_tls_fingerprint_matcher`](#matcher-a7a10e) - Optional Block<br>Extended version of JA3 that includes additional fields for more comprehensive fingerprinting of SSL/TLS clients and potentially has a different structure and length<br>See [Ja4 TLS Fingerprint Matcher](#matcher-a7a10e) below.
|
|
1282
1282
|
|
|
1283
|
-
<a id="matcher-d4dd17"></a>• [`tls_fingerprint_matcher`](#matcher-d4dd17) - Optional Block<br>TLS
|
|
1283
|
+
<a id="matcher-d4dd17"></a>• [`tls_fingerprint_matcher`](#matcher-d4dd17) - Optional Block<br>TLS fingerprint matcher specifies multiple criteria for matching a TLS fingerprint. The set of supported positve match criteria includes a list of known classes of TLS fingerprints and a list of exact values. The match is considered successful if either of these positive criteria are satisfied<br>See [TLS Fingerprint Matcher](#matcher-d4dd17) below.
|
|
1284
1284
|
|
|
1285
1285
|
#### DDOS Mitigation Rules DDOS Client Source Asn List
|
|
1286
1286
|
|
|
@@ -1308,17 +1308,17 @@ A [`metadata`](#ddos-mitigation-rules-metadata) block (within [`ddos_mitigation_
|
|
|
1308
1308
|
|
|
1309
1309
|
<a id="spec-f95573"></a>• [`description_spec`](#spec-f95573) - Optional String<br>Description. Human readable description
|
|
1310
1310
|
|
|
1311
|
-
<a id="ddos-mitigation-rules-metadata-name"></a>• [`name`](#ddos-mitigation-rules-metadata-name) - Optional String<br>Name
|
|
1311
|
+
<a id="ddos-mitigation-rules-metadata-name"></a>• [`name`](#ddos-mitigation-rules-metadata-name) - Optional String<br>Name of the message. The value of name has to follow DNS-1035 format
|
|
1312
1312
|
|
|
1313
1313
|
#### Default Cache Action
|
|
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>Can be used for messages where no values are needed
|
|
1318
1318
|
|
|
1319
|
-
<a id="default-cache-action-cache-ttl-default"></a>• [`cache_ttl_default`](#default-cache-action-cache-ttl-default) - Optional String<br>
|
|
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
|
|
|
1321
|
-
<a id="default-cache-action-cache-ttl-override"></a>• [`cache_ttl_override`](#default-cache-action-cache-ttl-override) - Optional String<br>
|
|
1321
|
+
<a id="default-cache-action-cache-ttl-override"></a>• [`cache_ttl_override`](#default-cache-action-cache-ttl-override) - Optional String<br>Always override the Cahce TTL provided by Origin
|
|
1322
1322
|
|
|
1323
1323
|
#### Enable API Discovery
|
|
1324
1324
|
|
|
@@ -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>Can be used for messages where no values are needed
|
|
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>Can be used for messages where no values are needed
|
|
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>Can be used for messages where no values are needed
|
|
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>Can be used for messages where no values are needed
|
|
1348
1348
|
|
|
1349
1349
|
#### Enable API Discovery API Crawler API Crawler Config
|
|
1350
1350
|
|
|
@@ -1390,7 +1390,7 @@ An [`api_crawler`](#enable-api-discovery-api-crawler) block (within [`enable_api
|
|
|
1390
1390
|
|
|
1391
1391
|
A [`custom_api_auth_discovery`](#discovery-54db29) block (within [`enable_api_discovery`](#enable-api-discovery)) supports the following:
|
|
1392
1392
|
|
|
1393
|
-
<a id="ref-a70328"></a>• [`api_discovery_ref`](#ref-a70328) - Optional Block<br>
|
|
1393
|
+
<a id="ref-a70328"></a>• [`api_discovery_ref`](#ref-a70328) - 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 [API Discovery Ref](#ref-a70328) below.
|
|
1394
1394
|
|
|
1395
1395
|
#### Enable API Discovery Custom API Auth Discovery API Discovery Ref
|
|
1396
1396
|
|
|
@@ -1400,91 +1400,91 @@ A [`custom_api_auth_discovery`](#discovery-54db29) block (within [`enable_api_di
|
|
|
1400
1400
|
|
|
1401
1401
|
A [`discovered_api_settings`](#settings-c31c55) block (within [`enable_api_discovery`](#enable-api-discovery)) supports the following:
|
|
1402
1402
|
|
|
1403
|
-
<a id="apis-cd00eb"></a>• [`purge_duration_for_inactive_discovered_apis`](#apis-cd00eb) - Optional Number<br>
|
|
1403
|
+
<a id="apis-cd00eb"></a>• [`purge_duration_for_inactive_discovered_apis`](#apis-cd00eb) - Optional Number<br>Inactive discovered API will be deleted after configured duration
|
|
1404
1404
|
|
|
1405
1405
|
#### Enable Challenge
|
|
1406
1406
|
|
|
1407
1407
|
An [`enable_challenge`](#enable-challenge) block supports the following:
|
|
1408
1408
|
|
|
1409
|
-
<a id="parameters-13a9c7"></a>• [`captcha_challenge_parameters`](#parameters-13a9c7) - Optional Block<br>
|
|
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>Can be used for messages where no values are needed
|
|
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>Can be used for messages where no values are needed
|
|
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>Can be used for messages where no values are needed
|
|
1416
1416
|
|
|
1417
|
-
<a id="parameters-6f7506"></a>• [`js_challenge_parameters`](#parameters-6f7506) - Optional Block<br>
|
|
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
|
|
|
1419
|
-
<a id="mitigation-b3e04b"></a>• [`malicious_user_mitigation`](#mitigation-b3e04b) - Optional Block<br>
|
|
1419
|
+
<a id="mitigation-b3e04b"></a>• [`malicious_user_mitigation`](#mitigation-b3e04b) - 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-b3e04b) below.
|
|
1420
1420
|
|
|
1421
1421
|
#### Enable Challenge Captcha Challenge Parameters
|
|
1422
1422
|
|
|
1423
1423
|
A [`captcha_challenge_parameters`](#parameters-13a9c7) block (within [`enable_challenge`](#enable-challenge)) supports the following:
|
|
1424
1424
|
|
|
1425
|
-
<a id="expiry-af25d3"></a>• [`cookie_expiry`](#expiry-af25d3) - Optional Number<br>Cookie
|
|
1425
|
+
<a id="expiry-af25d3"></a>• [`cookie_expiry`](#expiry-af25d3) - Optional Number<br>Cookie expiration period, in seconds. An expired cookie causes the loadbalancer to issue a new challenge
|
|
1426
1426
|
|
|
1427
|
-
<a id="page-1f96cf"></a>• [`custom_page`](#page-1f96cf) - Optional String<br>Custom message
|
|
1427
|
+
<a id="page-1f96cf"></a>• [`custom_page`](#page-1f96cf) - Optional String<br>Custom message is of type uri_ref. Currently supported URL schemes is string:///. For string:/// scheme, message needs to be encoded in Base64 format
|
|
1428
1428
|
|
|
1429
1429
|
#### Enable Challenge Js Challenge Parameters
|
|
1430
1430
|
|
|
1431
1431
|
A [`js_challenge_parameters`](#parameters-6f7506) block (within [`enable_challenge`](#enable-challenge)) supports the following:
|
|
1432
1432
|
|
|
1433
|
-
<a id="expiry-c03358"></a>• [`cookie_expiry`](#expiry-c03358) - Optional Number<br>Cookie
|
|
1433
|
+
<a id="expiry-c03358"></a>• [`cookie_expiry`](#expiry-c03358) - Optional Number<br>Cookie expiration period, in seconds. An expired cookie causes the loadbalancer to issue a new challenge
|
|
1434
1434
|
|
|
1435
|
-
<a id="page-831ba9"></a>• [`custom_page`](#page-831ba9) - Optional String<br>Custom
|
|
1435
|
+
<a id="page-831ba9"></a>• [`custom_page`](#page-831ba9) - Optional String<br>Custom message is of type uri_ref. Currently supported URL schemes is string:///. For string:/// scheme, message needs to be encoded in Base64 format
|
|
1436
1436
|
|
|
1437
|
-
<a id="delay-a5405d"></a>• [`js_script_delay`](#delay-a5405d) - Optional Number<br>
|
|
1437
|
+
<a id="delay-a5405d"></a>• [`js_script_delay`](#delay-a5405d) - Optional Number<br>Delay introduced by Javascript, in milliseconds
|
|
1438
1438
|
|
|
1439
1439
|
#### Enable Challenge Malicious User Mitigation
|
|
1440
1440
|
|
|
1441
1441
|
A [`malicious_user_mitigation`](#mitigation-b3e04b) block (within [`enable_challenge`](#enable-challenge)) supports the following:
|
|
1442
1442
|
|
|
1443
|
-
<a id="name-3a9364"></a>• [`name`](#name-3a9364) - Optional String<br>
|
|
1443
|
+
<a id="name-3a9364"></a>• [`name`](#name-3a9364) - 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
|
|
1444
1444
|
|
|
1445
|
-
<a id="namespace-38ef32"></a>• [`namespace`](#namespace-38ef32) - Optional String<br>
|
|
1445
|
+
<a id="namespace-38ef32"></a>• [`namespace`](#namespace-38ef32) - 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
|
|
1446
1446
|
|
|
1447
|
-
<a id="tenant-78def2"></a>• [`tenant`](#tenant-78def2) - Optional String<br>
|
|
1447
|
+
<a id="tenant-78def2"></a>• [`tenant`](#tenant-78def2) - 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
|
|
1448
1448
|
|
|
1449
1449
|
#### Enable IP Reputation
|
|
1450
1450
|
|
|
1451
1451
|
An [`enable_ip_reputation`](#enable-ip-reputation) block supports the following:
|
|
1452
1452
|
|
|
1453
|
-
<a id="categories-bb360f"></a>• [`ip_threat_categories`](#categories-bb360f) - Optional List Defaults to `SPAM_SOURCES`<br>See [IP Threat Categories](#common-ip-threat-categories)<br>[Enum: SPAM_SOURCES|WINDOWS_EXPLOITS|WEB_ATTACKS|BOTNETS|SCANNERS|REPUTATION|PHISHING|PROXY|MOBILE_THREATS|TOR_PROXY|DENIAL_OF_SERVICE|NETWORK]
|
|
1453
|
+
<a id="categories-bb360f"></a>• [`ip_threat_categories`](#categories-bb360f) - Optional List Defaults to `SPAM_SOURCES`<br>See [IP Threat Categories](#common-ip-threat-categories)<br>[Enum: SPAM_SOURCES|WINDOWS_EXPLOITS|WEB_ATTACKS|BOTNETS|SCANNERS|REPUTATION|PHISHING|PROXY|MOBILE_THREATS|TOR_PROXY|DENIAL_OF_SERVICE|NETWORK] If the source IP matches on atleast one of the enabled IP threat categories, the request will be denied
|
|
1454
1454
|
|
|
1455
1455
|
#### GraphQL Rules
|
|
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>Can be used for messages where no values are needed
|
|
1460
1460
|
|
|
1461
|
-
<a id="graphql-rules-exact-path"></a>• [`exact_path`](#graphql-rules-exact-path) - Optional String Defaults to `/GraphQL`<br>
|
|
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
|
|
|
1463
|
-
<a id="graphql-rules-exact-value"></a>• [`exact_value`](#graphql-rules-exact-value) - Optional String<br>Exact
|
|
1463
|
+
<a id="graphql-rules-exact-value"></a>• [`exact_value`](#graphql-rules-exact-value) - Optional String<br>Exact domain name
|
|
1464
1464
|
|
|
1465
1465
|
<a id="graphql-rules-graphql-settings"></a>• [`graphql_settings`](#graphql-rules-graphql-settings) - Optional Block<br>GraphQL Settings. GraphQL configuration<br>See [GraphQL Settings](#graphql-rules-graphql-settings) below.
|
|
1466
1466
|
|
|
1467
|
-
<a id="graphql-rules-metadata"></a>• [`metadata`](#graphql-rules-metadata) - Optional Block<br>
|
|
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>Can be used for messages where no values are needed
|
|
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>Can be used for messages where no values are needed
|
|
1472
1472
|
|
|
1473
|
-
<a id="graphql-rules-suffix-value"></a>• [`suffix_value`](#graphql-rules-suffix-value) - Optional String<br>Suffix
|
|
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
|
|
|
1475
1475
|
#### GraphQL Rules GraphQL Settings
|
|
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>Can be used for messages where no values are needed
|
|
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>Can be used for messages where no values are needed
|
|
1482
1482
|
|
|
1483
|
-
<a id="queries-f5cdb7"></a>• [`max_batched_queries`](#queries-f5cdb7) - Optional Number<br>
|
|
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
|
|
|
1485
|
-
<a id="depth-42541b"></a>• [`max_depth`](#depth-42541b) - Optional Number<br>
|
|
1485
|
+
<a id="depth-42541b"></a>• [`max_depth`](#depth-42541b) - Optional Number<br>Specify maximum depth for the GraphQL query
|
|
1486
1486
|
|
|
1487
|
-
<a id="length-21ac73"></a>• [`max_total_length`](#length-21ac73) - Optional Number<br>
|
|
1487
|
+
<a id="length-21ac73"></a>• [`max_total_length`](#length-21ac73) - Optional Number<br>Specify maximum length in bytes for the GraphQL query
|
|
1488
1488
|
|
|
1489
1489
|
#### GraphQL Rules Metadata
|
|
1490
1490
|
|
|
@@ -1492,23 +1492,23 @@ A [`metadata`](#graphql-rules-metadata) block (within [`graphql_rules`](#graphql
|
|
|
1492
1492
|
|
|
1493
1493
|
<a id="graphql-rules-metadata-description-spec"></a>• [`description_spec`](#graphql-rules-metadata-description-spec) - Optional String<br>Description. Human readable description
|
|
1494
1494
|
|
|
1495
|
-
<a id="graphql-rules-metadata-name"></a>• [`name`](#graphql-rules-metadata-name) - Optional String<br>Name
|
|
1495
|
+
<a id="graphql-rules-metadata-name"></a>• [`name`](#graphql-rules-metadata-name) - Optional String<br>Name of the message. The value of name has to follow DNS-1035 format
|
|
1496
1496
|
|
|
1497
1497
|
#### HTTP
|
|
1498
1498
|
|
|
1499
1499
|
A [`http`](#http) block supports the following:
|
|
1500
1500
|
|
|
1501
|
-
<a id="http-dns-volterra-managed"></a>• [`dns_volterra_managed`](#http-dns-volterra-managed) - Optional Bool<br>
|
|
1501
|
+
<a id="http-dns-volterra-managed"></a>• [`dns_volterra_managed`](#http-dns-volterra-managed) - Optional Bool<br>DNS records for domains will be managed automatically by F5 Distributed Cloud. As a prerequisite, the domain must be delegated to F5 Distributed Cloud using Delegated domain feature or a DNS CNAME record should be created in your DNS provider's portal
|
|
1502
1502
|
|
|
1503
|
-
<a id="http-port"></a>• [`port`](#http-port) - Optional Number<br>HTTP
|
|
1503
|
+
<a id="http-port"></a>• [`port`](#http-port) - Optional Number<br>HTTP port to Listen
|
|
1504
1504
|
|
|
1505
|
-
<a id="http-port-ranges"></a>• [`port_ranges`](#http-port-ranges) - Optional String<br>
|
|
1505
|
+
<a id="http-port-ranges"></a>• [`port_ranges`](#http-port-ranges) - Optional String<br>A string containing a comma separated list of port ranges. Each port range consists of a single port or two ports separated by '-'
|
|
1506
1506
|
|
|
1507
1507
|
#### HTTPS
|
|
1508
1508
|
|
|
1509
1509
|
A [`https`](#https) block supports the following:
|
|
1510
1510
|
|
|
1511
|
-
<a id="https-add-hsts"></a>• [`add_hsts`](#https-add-hsts) - Optional Bool<br>Add
|
|
1511
|
+
<a id="https-add-hsts"></a>• [`add_hsts`](#https-add-hsts) - Optional Bool<br>Add HTTP Strict-Transport-Security response header
|
|
1512
1512
|
|
|
1513
1513
|
<a id="https-http-redirect"></a>• [`http_redirect`](#https-http-redirect) - Optional Bool<br>HTTP Redirect to HTTPS. Redirect HTTP traffic to HTTPS
|
|
1514
1514
|
|
|
@@ -1526,13 +1526,13 @@ A [`tls_cert_options`](#https-tls-cert-options) block (within [`https`](#https))
|
|
|
1526
1526
|
|
|
1527
1527
|
A [`tls_cert_params`](#https-tls-cert-options-tls-cert-params) block (within [`https.tls_cert_options`](#https-tls-cert-options)) supports the following:
|
|
1528
1528
|
|
|
1529
|
-
<a id="certificates-07e388"></a>• [`certificates`](#certificates-07e388) - Optional Block<br>
|
|
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>Can be used for messages where no values are needed
|
|
1532
1532
|
|
|
1533
|
-
<a id="config-904431"></a>• [`tls_config`](#config-904431) - Optional Block<br>
|
|
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
|
|
|
1535
|
-
<a id="mtls-5b281c"></a>• [`use_mtls`](#mtls-5b281c) - Optional Block<br>
|
|
1535
|
+
<a id="mtls-5b281c"></a>• [`use_mtls`](#mtls-5b281c) - Optional Block<br>Validation context for downstream client TLS connections<br>See [Use mTLS](#mtls-5b281c) below.
|
|
1536
1536
|
|
|
1537
1537
|
#### HTTPS TLS Cert Options TLS Cert Params Certificates
|
|
1538
1538
|
|
|
@@ -1566,13 +1566,13 @@ 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>Can be used for messages where no values are needed
|
|
1570
1570
|
|
|
1571
|
-
<a id="certificates-f306b2"></a>• [`tls_certificates`](#certificates-f306b2) - Optional Block<br>
|
|
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
|
|
|
1573
|
-
<a id="config-22f363"></a>• [`tls_config`](#config-22f363) - Optional Block<br>
|
|
1573
|
+
<a id="config-22f363"></a>• [`tls_config`](#config-22f363) - Optional Block<br>Defines various OPTIONS to configure TLS configuration parameters<br>See [TLS Config](#config-22f363) below.
|
|
1574
1574
|
|
|
1575
|
-
<a id="mtls-fdc332"></a>• [`use_mtls`](#mtls-fdc332) - Optional Block<br>
|
|
1575
|
+
<a id="mtls-fdc332"></a>• [`use_mtls`](#mtls-fdc332) - Optional Block<br>Validation context for downstream client TLS connections<br>See [Use mTLS](#mtls-fdc332) below.
|
|
1576
1576
|
|
|
1577
1577
|
#### HTTPS TLS Cert Options TLS Inline Params TLS Certificates
|
|
1578
1578
|
|
|
@@ -1622,29 +1622,29 @@ A [`tls_inline_params`](#params-9a3f4e) block (within [`https.tls_cert_options`]
|
|
|
1622
1622
|
|
|
1623
1623
|
A [`https_auto_cert`](#https-auto-cert) block supports the following:
|
|
1624
1624
|
|
|
1625
|
-
<a id="https-auto-cert-add-hsts"></a>• [`add_hsts`](#https-auto-cert-add-hsts) - Optional Bool<br>Add
|
|
1625
|
+
<a id="https-auto-cert-add-hsts"></a>• [`add_hsts`](#https-auto-cert-add-hsts) - Optional Bool<br>Add HTTP Strict-Transport-Security response header
|
|
1626
1626
|
|
|
1627
1627
|
<a id="https-auto-cert-http-redirect"></a>• [`http_redirect`](#https-auto-cert-http-redirect) - Optional Bool<br>HTTP Redirect to HTTPS. Redirect HTTP traffic to HTTPS
|
|
1628
1628
|
|
|
1629
|
-
<a id="https-auto-cert-tls-config"></a>• [`tls_config`](#https-auto-cert-tls-config) - Optional Block<br>
|
|
1629
|
+
<a id="https-auto-cert-tls-config"></a>• [`tls_config`](#https-auto-cert-tls-config) - Optional Block<br>Defines various OPTIONS to configure TLS configuration parameters<br>See [TLS Config](#https-auto-cert-tls-config) below.
|
|
1630
1630
|
|
|
1631
1631
|
#### HTTPS Auto Cert TLS Config
|
|
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>Can be used for messages where no values are needed
|
|
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>Can be used for messages where no values are needed
|
|
1638
1638
|
|
|
1639
1639
|
#### Js Challenge
|
|
1640
1640
|
|
|
1641
1641
|
A [`js_challenge`](#js-challenge) block supports the following:
|
|
1642
1642
|
|
|
1643
|
-
<a id="js-challenge-cookie-expiry"></a>• [`cookie_expiry`](#js-challenge-cookie-expiry) - Optional Number<br>Cookie
|
|
1643
|
+
<a id="js-challenge-cookie-expiry"></a>• [`cookie_expiry`](#js-challenge-cookie-expiry) - Optional Number<br>Cookie expiration period, in seconds. An expired cookie causes the loadbalancer to issue a new challenge
|
|
1644
1644
|
|
|
1645
|
-
<a id="js-challenge-custom-page"></a>• [`custom_page`](#js-challenge-custom-page) - Optional String<br>Custom
|
|
1645
|
+
<a id="js-challenge-custom-page"></a>• [`custom_page`](#js-challenge-custom-page) - Optional String<br>Custom message is of type uri_ref. Currently supported URL schemes is string:///. For string:/// scheme, message needs to be encoded in Base64 format
|
|
1646
1646
|
|
|
1647
|
-
<a id="js-challenge-js-script-delay"></a>• [`js_script_delay`](#js-challenge-js-script-delay) - Optional Number<br>
|
|
1647
|
+
<a id="js-challenge-js-script-delay"></a>• [`js_script_delay`](#js-challenge-js-script-delay) - Optional Number<br>Delay introduced by Javascript, in milliseconds
|
|
1648
1648
|
|
|
1649
1649
|
#### JWT Validation
|
|
1650
1650
|
|
|
@@ -1652,13 +1652,13 @@ A [`jwt_validation`](#jwt-validation) block supports the following:
|
|
|
1652
1652
|
|
|
1653
1653
|
<a id="jwt-validation-action"></a>• [`action`](#jwt-validation-action) - Optional Block<br>Action<br>See [Action](#jwt-validation-action) below.
|
|
1654
1654
|
|
|
1655
|
-
<a id="jwt-validation-jwks-config"></a>• [`jwks_config`](#jwt-validation-jwks-config) - Optional Block<br>
|
|
1655
|
+
<a id="jwt-validation-jwks-config"></a>• [`jwks_config`](#jwt-validation-jwks-config) - Optional Block<br>The JSON Web Key Set (JWKS) is a set of keys used to verify JSON Web Token (JWT) issued by the Authorization Server. See RFC 7517 for more details<br>See [Jwks Config](#jwt-validation-jwks-config) below.
|
|
1656
1656
|
|
|
1657
|
-
<a id="jwt-validation-mandatory-claims"></a>• [`mandatory_claims`](#jwt-validation-mandatory-claims) - Optional Block<br>
|
|
1657
|
+
<a id="jwt-validation-mandatory-claims"></a>• [`mandatory_claims`](#jwt-validation-mandatory-claims) - Optional Block<br>Configurable Validation of mandatory Claims<br>See [Mandatory Claims](#jwt-validation-mandatory-claims) below.
|
|
1658
1658
|
|
|
1659
|
-
<a id="jwt-validation-reserved-claims"></a>• [`reserved_claims`](#jwt-validation-reserved-claims) - Optional Block<br>
|
|
1659
|
+
<a id="jwt-validation-reserved-claims"></a>• [`reserved_claims`](#jwt-validation-reserved-claims) - Optional Block<br>Configurable Validation of reserved Claims<br>See [Reserved Claims](#jwt-validation-reserved-claims) below.
|
|
1660
1660
|
|
|
1661
|
-
<a id="jwt-validation-target"></a>• [`target`](#jwt-validation-target) - Optional Block<br>
|
|
1661
|
+
<a id="jwt-validation-target"></a>• [`target`](#jwt-validation-target) - Optional Block<br>Define endpoints for which JWT token validation will be performed<br>See [Target](#jwt-validation-target) below.
|
|
1662
1662
|
|
|
1663
1663
|
<a id="jwt-validation-token-location"></a>• [`token_location`](#jwt-validation-token-location) - Optional Block<br>Token Location. Location of JWT in HTTP request<br>See [Token Location](#jwt-validation-token-location) below.
|
|
1664
1664
|
|
|
@@ -1666,15 +1666,15 @@ 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>Can be used for messages where no values are needed
|
|
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>Can be used for messages where no values are needed
|
|
1672
1672
|
|
|
1673
1673
|
#### JWT Validation Jwks Config
|
|
1674
1674
|
|
|
1675
1675
|
A [`jwks_config`](#jwt-validation-jwks-config) block (within [`jwt_validation`](#jwt-validation)) supports the following:
|
|
1676
1676
|
|
|
1677
|
-
<a id="jwt-validation-jwks-config-cleartext"></a>• [`cleartext`](#jwt-validation-jwks-config-cleartext) - Optional String<br>
|
|
1677
|
+
<a id="jwt-validation-jwks-config-cleartext"></a>• [`cleartext`](#jwt-validation-jwks-config-cleartext) - Optional String<br>The JSON Web Key Set (JWKS) is a set of keys used to verify JSON Web Token (JWT) issued by the Authorization Server. See RFC 7517 for more details
|
|
1678
1678
|
|
|
1679
1679
|
#### JWT Validation Mandatory Claims
|
|
1680
1680
|
|
|
@@ -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>Can be used for messages where no values are needed
|
|
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>Can be used for messages where no values are needed
|
|
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>Can be used for messages where no values are needed
|
|
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>Can be used for messages where no values are needed
|
|
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>Can be used for messages where no values are needed
|
|
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,17 +1730,17 @@ 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>Can be used for messages where no values are needed
|
|
1734
1734
|
|
|
1735
1735
|
#### L7 DDOS Action Js Challenge
|
|
1736
1736
|
|
|
1737
1737
|
A [`l7_ddos_action_js_challenge`](#l7-ddos-action-js-challenge) block supports the following:
|
|
1738
1738
|
|
|
1739
|
-
<a id="expiry-2697a0"></a>• [`cookie_expiry`](#expiry-2697a0) - Optional Number<br>Cookie
|
|
1739
|
+
<a id="expiry-2697a0"></a>• [`cookie_expiry`](#expiry-2697a0) - Optional Number<br>Cookie expiration period, in seconds. An expired cookie causes the loadbalancer to issue a new challenge
|
|
1740
1740
|
|
|
1741
|
-
<a id="l7-ddos-action-js-challenge-custom-page"></a>• [`custom_page`](#l7-ddos-action-js-challenge-custom-page) - Optional String<br>Custom
|
|
1741
|
+
<a id="l7-ddos-action-js-challenge-custom-page"></a>• [`custom_page`](#l7-ddos-action-js-challenge-custom-page) - Optional String<br>Custom message is of type uri_ref. Currently supported URL schemes is string:///. For string:/// scheme, message needs to be encoded in Base64 format
|
|
1742
1742
|
|
|
1743
|
-
<a id="delay-88f51d"></a>• [`js_script_delay`](#delay-88f51d) - Optional Number<br>
|
|
1743
|
+
<a id="delay-88f51d"></a>• [`js_script_delay`](#delay-88f51d) - Optional Number<br>Delay introduced by Javascript, in milliseconds
|
|
1744
1744
|
|
|
1745
1745
|
#### Origin Pool
|
|
1746
1746
|
|
|
@@ -1748,13 +1748,13 @@ 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>Can be used for messages where no values are needed
|
|
1752
1752
|
|
|
1753
|
-
<a id="origin-pool-origin-request-timeout"></a>• [`origin_request_timeout`](#origin-pool-origin-request-timeout) - Optional String<br>
|
|
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
|
|
|
1755
1755
|
<a id="origin-pool-origin-servers"></a>• [`origin_servers`](#origin-pool-origin-servers) - Optional Block<br>List Of Origin Servers. List of original servers<br>See [Origin Servers](#origin-pool-origin-servers) below.
|
|
1756
1756
|
|
|
1757
|
-
<a id="origin-pool-public-name"></a>• [`public_name`](#origin-pool-public-name) - Optional Block<br>
|
|
1757
|
+
<a id="origin-pool-public-name"></a>• [`public_name`](#origin-pool-public-name) - Optional Block<br>Specify origin server with public DNS name<br>See [Public Name](#origin-pool-public-name) below.
|
|
1758
1758
|
|
|
1759
1759
|
<a id="origin-pool-use-tls"></a>• [`use_tls`](#origin-pool-use-tls) - Optional Block<br>TLS Parameters for Origin Servers. Upstream TLS Parameters<br>See [Use TLS](#origin-pool-use-tls) below.
|
|
1760
1760
|
|
|
@@ -1762,9 +1762,9 @@ An [`origin_pool`](#origin-pool) block supports the following:
|
|
|
1762
1762
|
|
|
1763
1763
|
A [`more_origin_options`](#origin-pool-more-origin-options) block (within [`origin_pool`](#origin-pool)) supports the following:
|
|
1764
1764
|
|
|
1765
|
-
<a id="request-264c69"></a>• [`enable_byte_range_request`](#request-264c69) - Optional Bool<br>
|
|
1765
|
+
<a id="request-264c69"></a>• [`enable_byte_range_request`](#request-264c69) - Optional Bool<br>Choice to enable/disable byte range requests towards origin
|
|
1766
1766
|
|
|
1767
|
-
<a id="proxy-2bb9b7"></a>• [`websocket_proxy`](#proxy-2bb9b7) - Optional Bool<br>
|
|
1767
|
+
<a id="proxy-2bb9b7"></a>• [`websocket_proxy`](#proxy-2bb9b7) - Optional Bool<br>Option to enable proxying of WebSocket connections to the origin server
|
|
1768
1768
|
|
|
1769
1769
|
#### Origin Pool Origin Servers
|
|
1770
1770
|
|
|
@@ -1772,9 +1772,9 @@ An [`origin_servers`](#origin-pool-origin-servers) block (within [`origin_pool`]
|
|
|
1772
1772
|
|
|
1773
1773
|
<a id="origin-pool-origin-servers-port"></a>• [`port`](#origin-pool-origin-servers-port) - Optional Number<br>Origin Server Port. Port the workload can be reached on
|
|
1774
1774
|
|
|
1775
|
-
<a id="origin-pool-origin-servers-public-ip"></a>• [`public_ip`](#origin-pool-origin-servers-public-ip) - Optional Block<br>
|
|
1775
|
+
<a id="origin-pool-origin-servers-public-ip"></a>• [`public_ip`](#origin-pool-origin-servers-public-ip) - Optional Block<br>Specify origin server with public IP address<br>See [Public IP](#origin-pool-origin-servers-public-ip) below.
|
|
1776
1776
|
|
|
1777
|
-
<a id="origin-pool-origin-servers-public-name"></a>• [`public_name`](#origin-pool-origin-servers-public-name) - Optional Block<br>
|
|
1777
|
+
<a id="origin-pool-origin-servers-public-name"></a>• [`public_name`](#origin-pool-origin-servers-public-name) - Optional Block<br>Specify origin server with public DNS name<br>See [Public Name](#origin-pool-origin-servers-public-name) below.
|
|
1778
1778
|
|
|
1779
1779
|
#### Origin Pool Origin Servers Public IP
|
|
1780
1780
|
|
|
@@ -1788,7 +1788,7 @@ A [`public_name`](#origin-pool-origin-servers-public-name) block (within [`origi
|
|
|
1788
1788
|
|
|
1789
1789
|
<a id="name-f3c8e7"></a>• [`dns_name`](#name-f3c8e7) - Optional String<br>DNS Name. DNS Name
|
|
1790
1790
|
|
|
1791
|
-
<a id="interval-5536ea"></a>• [`refresh_interval`](#interval-5536ea) - Optional Number<br>
|
|
1791
|
+
<a id="interval-5536ea"></a>• [`refresh_interval`](#interval-5536ea) - Optional Number<br>Interval for DNS refresh in seconds. Max value is 7 days as per `HTTPS://datatracker.ietf.org/doc/HTML/rfc8767.`
|
|
1792
1792
|
|
|
1793
1793
|
#### Origin Pool Public Name
|
|
1794
1794
|
|
|
@@ -1796,49 +1796,49 @@ A [`public_name`](#origin-pool-public-name) block (within [`origin_pool`](#origi
|
|
|
1796
1796
|
|
|
1797
1797
|
<a id="origin-pool-public-name-dns-name"></a>• [`dns_name`](#origin-pool-public-name-dns-name) - Optional String<br>DNS Name. DNS Name
|
|
1798
1798
|
|
|
1799
|
-
<a id="interval-87876b"></a>• [`refresh_interval`](#interval-87876b) - Optional Number<br>
|
|
1799
|
+
<a id="interval-87876b"></a>• [`refresh_interval`](#interval-87876b) - Optional Number<br>Interval for DNS refresh in seconds. Max value is 7 days as per `HTTPS://datatracker.ietf.org/doc/HTML/rfc8767.`
|
|
1800
1800
|
|
|
1801
1801
|
#### Origin Pool Use TLS
|
|
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>Can be used for messages where no values are needed
|
|
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>Can be used for messages where no values are needed
|
|
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>Can be used for messages where no values are needed
|
|
1810
1810
|
|
|
1811
|
-
<a id="origin-pool-use-tls-max-session-keys"></a>• [`max_session_keys`](#origin-pool-use-tls-max-session-keys) - Optional Number<br>
|
|
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>Can be used for messages where no values are needed
|
|
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>Can be used for messages where no values are needed
|
|
1816
1816
|
|
|
1817
|
-
<a id="origin-pool-use-tls-sni"></a>• [`sni`](#origin-pool-use-tls-sni) - Optional String<br>SNI
|
|
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
|
-
<a id="origin-pool-use-tls-tls-config"></a>• [`tls_config`](#origin-pool-use-tls-tls-config) - Optional Block<br>
|
|
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>Can be used for messages where no values are needed
|
|
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
|
|
|
1825
|
-
<a id="origin-pool-use-tls-use-mtls-obj"></a>• [`use_mtls_obj`](#origin-pool-use-tls-use-mtls-obj) - Optional Block<br>
|
|
1825
|
+
<a id="origin-pool-use-tls-use-mtls-obj"></a>• [`use_mtls_obj`](#origin-pool-use-tls-use-mtls-obj) - 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 [Use mTLS Obj](#origin-pool-use-tls-use-mtls-obj) below.
|
|
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>Can be used for messages where no values are needed
|
|
1830
1830
|
|
|
1831
1831
|
#### Origin Pool Use TLS TLS Config
|
|
1832
1832
|
|
|
1833
1833
|
A [`tls_config`](#origin-pool-use-tls-tls-config) block (within [`origin_pool.use_tls`](#origin-pool-use-tls)) supports the following:
|
|
1834
1834
|
|
|
1835
|
-
<a id="security-0634ba"></a>• [`custom_security`](#security-0634ba) - Optional Block<br>
|
|
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>Can be used for messages where no values are needed
|
|
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>Can be used for messages where no values are needed
|
|
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>Can be used for messages where no values are needed
|
|
1842
1842
|
|
|
1843
1843
|
#### Origin Pool Use TLS TLS Config Custom Security
|
|
1844
1844
|
|
|
@@ -1874,19 +1874,19 @@ An [`use_mtls`](#origin-pool-use-tls-use-mtls) block (within [`origin_pool.use_t
|
|
|
1874
1874
|
|
|
1875
1875
|
An [`use_mtls_obj`](#origin-pool-use-tls-use-mtls-obj) block (within [`origin_pool.use_tls`](#origin-pool-use-tls)) supports the following:
|
|
1876
1876
|
|
|
1877
|
-
<a id="origin-pool-use-tls-use-mtls-obj-name"></a>• [`name`](#origin-pool-use-tls-use-mtls-obj-name) - Optional String<br>
|
|
1877
|
+
<a id="origin-pool-use-tls-use-mtls-obj-name"></a>• [`name`](#origin-pool-use-tls-use-mtls-obj-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
|
|
1878
1878
|
|
|
1879
|
-
<a id="namespace-cadfb2"></a>• [`namespace`](#namespace-cadfb2) - Optional String<br>
|
|
1879
|
+
<a id="namespace-cadfb2"></a>• [`namespace`](#namespace-cadfb2) - 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
|
|
1880
1880
|
|
|
1881
|
-
<a id="origin-pool-use-tls-use-mtls-obj-tenant"></a>• [`tenant`](#origin-pool-use-tls-use-mtls-obj-tenant) - Optional String<br>
|
|
1881
|
+
<a id="origin-pool-use-tls-use-mtls-obj-tenant"></a>• [`tenant`](#origin-pool-use-tls-use-mtls-obj-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
|
|
1882
1882
|
|
|
1883
1883
|
#### Origin Pool Use TLS Use Server Verification
|
|
1884
1884
|
|
|
1885
1885
|
An [`use_server_verification`](#verification-1ac9e2) block (within [`origin_pool.use_tls`](#origin-pool-use-tls)) supports the following:
|
|
1886
1886
|
|
|
1887
|
-
<a id="trusted-ca-c2c605"></a>• [`trusted_ca`](#trusted-ca-c2c605) - Optional Block<br>
|
|
1887
|
+
<a id="trusted-ca-c2c605"></a>• [`trusted_ca`](#trusted-ca-c2c605) - 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 [Trusted CA](#trusted-ca-c2c605) below.
|
|
1888
1888
|
|
|
1889
|
-
<a id="url-f58089"></a>• [`trusted_ca_url`](#url-f58089) - Optional String<br>
|
|
1889
|
+
<a id="url-f58089"></a>• [`trusted_ca_url`](#url-f58089) - Optional String<br>Upload a Root CA Certificate specifically for this Origin Pool for verification of server's certificate
|
|
1890
1890
|
|
|
1891
1891
|
#### Origin Pool Use TLS Use Server Verification Trusted CA
|
|
1892
1892
|
|
|
@@ -1898,21 +1898,21 @@ An [`other_settings`](#other-settings) block supports the following:
|
|
|
1898
1898
|
|
|
1899
1899
|
<a id="other-settings-add-location"></a>• [`add_location`](#other-settings-add-location) - Optional Bool<br>Add Location. X-example: true Appends header x-F5 Distributed Cloud-location = `<RE-site-name>` in responses
|
|
1900
1900
|
|
|
1901
|
-
<a id="other-settings-header-options"></a>• [`header_options`](#other-settings-header-options) - Optional Block<br>
|
|
1901
|
+
<a id="other-settings-header-options"></a>• [`header_options`](#other-settings-header-options) - Optional Block<br>Defines various OPTIONS related to request/response headers<br>See [Header Options](#other-settings-header-options) below.
|
|
1902
1902
|
|
|
1903
|
-
<a id="other-settings-logging-options"></a>• [`logging_options`](#other-settings-logging-options) - Optional Block<br>
|
|
1903
|
+
<a id="other-settings-logging-options"></a>• [`logging_options`](#other-settings-logging-options) - Optional Block<br>Defines various OPTIONS related to logging<br>See [Logging Options](#other-settings-logging-options) below.
|
|
1904
1904
|
|
|
1905
1905
|
#### Other Settings Header Options
|
|
1906
1906
|
|
|
1907
1907
|
A [`header_options`](#other-settings-header-options) block (within [`other_settings`](#other-settings)) supports the following:
|
|
1908
1908
|
|
|
1909
|
-
<a id="add-efdf59"></a>• [`request_headers_to_add`](#add-efdf59) - Optional Block<br>
|
|
1909
|
+
<a id="add-efdf59"></a>• [`request_headers_to_add`](#add-efdf59) - Optional Block<br>Headers are key-value pairs to be added to HTTP request being routed towards upstream. Headers specified at this level are applied after headers from matched Route are applied<br>See [Request Headers To Add](#add-efdf59) below.
|
|
1910
1910
|
|
|
1911
|
-
<a id="remove-0577c9"></a>• [`request_headers_to_remove`](#remove-0577c9) - Optional List<br>
|
|
1911
|
+
<a id="remove-0577c9"></a>• [`request_headers_to_remove`](#remove-0577c9) - Optional List<br>List of keys of Headers to be removed from the HTTP request being sent towards upstream
|
|
1912
1912
|
|
|
1913
|
-
<a id="add-f6ecb9"></a>• [`response_headers_to_add`](#add-f6ecb9) - Optional Block<br>
|
|
1913
|
+
<a id="add-f6ecb9"></a>• [`response_headers_to_add`](#add-f6ecb9) - Optional Block<br>Headers are key-value pairs to be added to HTTP response being sent towards downstream. Headers specified at this level are applied after headers from matched Route are applied<br>See [Response Headers To Add](#add-f6ecb9) below.
|
|
1914
1914
|
|
|
1915
|
-
<a id="remove-5abdb9"></a>• [`response_headers_to_remove`](#remove-5abdb9) - Optional List<br>
|
|
1915
|
+
<a id="remove-5abdb9"></a>• [`response_headers_to_remove`](#remove-5abdb9) - Optional List<br>List of keys of Headers to be removed from the HTTP response being sent towards downstream
|
|
1916
1916
|
|
|
1917
1917
|
#### Other Settings Header Options Request Headers To Add
|
|
1918
1918
|
|
|
@@ -1970,71 +1970,71 @@ 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>Can be used for messages where no values are needed
|
|
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>Can be used for messages where no values are needed
|
|
1976
1976
|
|
|
1977
|
-
<a id="parameters-699e87"></a>• [`captcha_challenge_parameters`](#parameters-699e87) - Optional Block<br>
|
|
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>Can be used for messages where no values are needed
|
|
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>Can be used for messages where no values are needed
|
|
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>Can be used for messages where no values are needed
|
|
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>Can be used for messages where no values are needed
|
|
1986
1986
|
|
|
1987
|
-
<a id="parameters-65055e"></a>• [`js_challenge_parameters`](#parameters-65055e) - Optional Block<br>
|
|
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
|
-
<a id="mitigation-d19aea"></a>• [`malicious_user_mitigation`](#mitigation-d19aea) - Optional Block<br>
|
|
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>Can be used for messages where no values are needed
|
|
1992
1992
|
|
|
1993
|
-
<a id="policy-based-challenge-rule-list"></a>• [`rule_list`](#policy-based-challenge-rule-list) - Optional Block<br>
|
|
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
|
|
|
1995
|
-
<a id="blocking-9fdca7"></a>• [`temporary_user_blocking`](#blocking-9fdca7) - Optional Block<br>
|
|
1995
|
+
<a id="blocking-9fdca7"></a>• [`temporary_user_blocking`](#blocking-9fdca7) - Optional Block<br>Specifies configuration for temporary user blocking resulting from user behavior analysis. When Malicious User Mitigation is enabled from service policy rules, users' accessing the application will be analyzed for malicious activity and the configured mitigation actions will be taken on<br>See [Temporary User Blocking](#blocking-9fdca7) below.
|
|
1996
1996
|
|
|
1997
1997
|
#### Policy Based Challenge Captcha Challenge Parameters
|
|
1998
1998
|
|
|
1999
1999
|
A [`captcha_challenge_parameters`](#parameters-699e87) block (within [`policy_based_challenge`](#policy-based-challenge)) supports the following:
|
|
2000
2000
|
|
|
2001
|
-
<a id="expiry-fff199"></a>• [`cookie_expiry`](#expiry-fff199) - Optional Number<br>Cookie
|
|
2001
|
+
<a id="expiry-fff199"></a>• [`cookie_expiry`](#expiry-fff199) - Optional Number<br>Cookie expiration period, in seconds. An expired cookie causes the loadbalancer to issue a new challenge
|
|
2002
2002
|
|
|
2003
|
-
<a id="page-46537d"></a>• [`custom_page`](#page-46537d) - Optional String<br>Custom message
|
|
2003
|
+
<a id="page-46537d"></a>• [`custom_page`](#page-46537d) - Optional String<br>Custom message is of type uri_ref. Currently supported URL schemes is string:///. For string:/// scheme, message needs to be encoded in Base64 format
|
|
2004
2004
|
|
|
2005
2005
|
#### Policy Based Challenge Js Challenge Parameters
|
|
2006
2006
|
|
|
2007
2007
|
A [`js_challenge_parameters`](#parameters-65055e) block (within [`policy_based_challenge`](#policy-based-challenge)) supports the following:
|
|
2008
2008
|
|
|
2009
|
-
<a id="expiry-745058"></a>• [`cookie_expiry`](#expiry-745058) - Optional Number<br>Cookie
|
|
2009
|
+
<a id="expiry-745058"></a>• [`cookie_expiry`](#expiry-745058) - Optional Number<br>Cookie expiration period, in seconds. An expired cookie causes the loadbalancer to issue a new challenge
|
|
2010
2010
|
|
|
2011
|
-
<a id="page-59809e"></a>• [`custom_page`](#page-59809e) - Optional String<br>Custom
|
|
2011
|
+
<a id="page-59809e"></a>• [`custom_page`](#page-59809e) - Optional String<br>Custom message is of type uri_ref. Currently supported URL schemes is string:///. For string:/// scheme, message needs to be encoded in Base64 format
|
|
2012
2012
|
|
|
2013
|
-
<a id="delay-6a6ceb"></a>• [`js_script_delay`](#delay-6a6ceb) - Optional Number<br>
|
|
2013
|
+
<a id="delay-6a6ceb"></a>• [`js_script_delay`](#delay-6a6ceb) - Optional Number<br>Delay introduced by Javascript, in milliseconds
|
|
2014
2014
|
|
|
2015
2015
|
#### Policy Based Challenge Malicious User Mitigation
|
|
2016
2016
|
|
|
2017
2017
|
A [`malicious_user_mitigation`](#mitigation-d19aea) block (within [`policy_based_challenge`](#policy-based-challenge)) supports the following:
|
|
2018
2018
|
|
|
2019
|
-
<a id="name-0fb02d"></a>• [`name`](#name-0fb02d) - Optional String<br>
|
|
2019
|
+
<a id="name-0fb02d"></a>• [`name`](#name-0fb02d) - 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
|
|
2020
2020
|
|
|
2021
|
-
<a id="namespace-490d76"></a>• [`namespace`](#namespace-490d76) - Optional String<br>
|
|
2021
|
+
<a id="namespace-490d76"></a>• [`namespace`](#namespace-490d76) - 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
|
|
2022
2022
|
|
|
2023
|
-
<a id="tenant-cf334a"></a>• [`tenant`](#tenant-cf334a) - Optional String<br>
|
|
2023
|
+
<a id="tenant-cf334a"></a>• [`tenant`](#tenant-cf334a) - 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
|
|
2024
2024
|
|
|
2025
2025
|
#### Policy Based Challenge Rule List
|
|
2026
2026
|
|
|
2027
2027
|
A [`rule_list`](#policy-based-challenge-rule-list) block (within [`policy_based_challenge`](#policy-based-challenge)) supports the following:
|
|
2028
2028
|
|
|
2029
|
-
<a id="policy-based-challenge-rule-list-rules"></a>• [`rules`](#policy-based-challenge-rule-list-rules) - Optional Block<br>Rules
|
|
2029
|
+
<a id="policy-based-challenge-rule-list-rules"></a>• [`rules`](#policy-based-challenge-rule-list-rules) - Optional Block<br>Rules that specify the match conditions and challenge type to be launched. When a challenge type is selected to be always enabled, these rules can be used to disable challenge or launch a different challenge for requests that match the specified conditions<br>See [Rules](#policy-based-challenge-rule-list-rules) below.
|
|
2030
2030
|
|
|
2031
2031
|
#### Policy Based Challenge Rule List Rules
|
|
2032
2032
|
|
|
2033
2033
|
A [`rules`](#policy-based-challenge-rule-list-rules) block (within [`policy_based_challenge.rule_list`](#policy-based-challenge-rule-list)) supports the following:
|
|
2034
2034
|
|
|
2035
|
-
<a id="metadata-72ce94"></a>• [`metadata`](#metadata-72ce94) - Optional Block<br>
|
|
2035
|
+
<a id="metadata-72ce94"></a>• [`metadata`](#metadata-72ce94) - 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-72ce94) below.
|
|
2036
2036
|
|
|
2037
|
-
<a id="spec-fbd0f9"></a>• [`spec`](#spec-fbd0f9) - Optional Block<br>Challenge Rule
|
|
2037
|
+
<a id="spec-fbd0f9"></a>• [`spec`](#spec-fbd0f9) - Optional Block<br>Challenge Rule consists of an unordered list of predicates and an action. The predicates are evaluated against a set of input fields that are extracted from or derived from an L7 request API. A request API is considered to match the rule if all predicates in the rule evaluate to true for that<br>See [Spec](#spec-fbd0f9) below.
|
|
2038
2038
|
|
|
2039
2039
|
#### Policy Based Challenge Rule List Rules Metadata
|
|
2040
2040
|
|
|
@@ -2042,53 +2042,53 @@ A [`metadata`](#metadata-72ce94) block (within [`policy_based_challenge.rule_lis
|
|
|
2042
2042
|
|
|
2043
2043
|
<a id="spec-760f37"></a>• [`description_spec`](#spec-760f37) - Optional String<br>Description. Human readable description
|
|
2044
2044
|
|
|
2045
|
-
<a id="name-44607a"></a>• [`name`](#name-44607a) - Optional String<br>Name
|
|
2045
|
+
<a id="name-44607a"></a>• [`name`](#name-44607a) - Optional String<br>Name of the message. The value of name has to follow DNS-1035 format
|
|
2046
2046
|
|
|
2047
2047
|
#### Policy Based Challenge Rule List Rules Spec
|
|
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>Can be used for messages where no values are needed
|
|
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>Can be used for messages where no values are needed
|
|
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>Can be used for messages where no values are needed
|
|
2056
2056
|
|
|
2057
|
-
<a id="matchers-86dff2"></a>• [`arg_matchers`](#matchers-86dff2) - Optional Block<br>
|
|
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
|
|
|
2059
|
-
<a id="list-628bd4"></a>• [`asn_list`](#list-628bd4) - Optional Block<br>
|
|
2059
|
+
<a id="list-628bd4"></a>• [`asn_list`](#list-628bd4) - Optional Block<br>Unordered set of RFC 6793 defined 4-byte AS numbers that can be used to create allow or deny lists for use in network policy or service policy. It can be used to create the allow list only for DNS Load Balancer<br>See [Asn List](#list-628bd4) below.
|
|
2060
2060
|
|
|
2061
|
-
<a id="matcher-6b840c"></a>• [`asn_matcher`](#matcher-6b840c) - Optional Block<br>
|
|
2061
|
+
<a id="matcher-6b840c"></a>• [`asn_matcher`](#matcher-6b840c) - Optional Block<br>Match any AS number contained in the list of bgp_asn_sets<br>See [Asn Matcher](#matcher-6b840c) below.
|
|
2062
2062
|
|
|
2063
|
-
<a id="matcher-4075fc"></a>• [`body_matcher`](#matcher-4075fc) - Optional Block<br>Matcher
|
|
2063
|
+
<a id="matcher-4075fc"></a>• [`body_matcher`](#matcher-4075fc) - 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 [Body Matcher](#matcher-4075fc) below.
|
|
2064
2064
|
|
|
2065
|
-
<a id="selector-ca44f5"></a>• [`client_selector`](#selector-ca44f5) - Optional Block<br>
|
|
2065
|
+
<a id="selector-ca44f5"></a>• [`client_selector`](#selector-ca44f5) - Optional Block<br>Type can be used to establish a 'selector reference' from one object(called selector) to a set of other objects(called selectees) based on the value of expresssions. A label selector is a label query over a set of resources. An empty label selector matches all objects<br>See [Client Selector](#selector-ca44f5) below.
|
|
2066
2066
|
|
|
2067
|
-
<a id="matchers-cb349b"></a>• [`cookie_matchers`](#matchers-cb349b) - Optional Block<br>
|
|
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>Can be used for messages where no values are needed
|
|
2070
2070
|
|
|
2071
|
-
<a id="matcher-888f5a"></a>• [`domain_matcher`](#matcher-888f5a) - Optional Block<br>Matcher
|
|
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>Can be used for messages where no values are needed
|
|
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>Can be used for messages where no values are needed
|
|
2076
2076
|
|
|
2077
|
-
<a id="timestamp-6d26e1"></a>• [`expiration_timestamp`](#timestamp-6d26e1) - Optional String<br>
|
|
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
|
|
|
2079
|
-
<a id="headers-1bea3b"></a>• [`headers`](#headers-1bea3b) - Optional Block<br>
|
|
2079
|
+
<a id="headers-1bea3b"></a>• [`headers`](#headers-1bea3b) - Optional Block<br>List of predicates for various HTTP headers that need to match. The criteria for matching each HTTP header are described in individual HeaderMatcherType instances. The actual HTTP header values are extracted from the request API as a list of strings for each HTTP header type<br>See [Headers](#headers-1bea3b) below.
|
|
2080
2080
|
|
|
2081
|
-
<a id="method-9ab722"></a>• [`http_method`](#method-9ab722) - Optional Block<br>HTTP
|
|
2081
|
+
<a id="method-9ab722"></a>• [`http_method`](#method-9ab722) - 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 [HTTP Method](#method-9ab722) below.
|
|
2082
2082
|
|
|
2083
|
-
<a id="matcher-82616b"></a>• [`ip_matcher`](#matcher-82616b) - Optional Block<br>
|
|
2083
|
+
<a id="matcher-82616b"></a>• [`ip_matcher`](#matcher-82616b) - Optional Block<br>Match any IP prefix contained in the list of ip_prefix_sets. The result of the match is inverted if invert_matcher is true<br>See [IP Matcher](#matcher-82616b) below.
|
|
2084
2084
|
|
|
2085
|
-
<a id="list-537143"></a>• [`ip_prefix_list`](#list-537143) - Optional Block<br>
|
|
2085
|
+
<a id="list-537143"></a>• [`ip_prefix_list`](#list-537143) - Optional Block<br>List of IP Prefix strings to match against<br>See [IP Prefix List](#list-537143) below.
|
|
2086
2086
|
|
|
2087
|
-
<a id="path-acb3cc"></a>• [`path`](#path-acb3cc) - Optional Block<br>Path
|
|
2087
|
+
<a id="path-acb3cc"></a>• [`path`](#path-acb3cc) - Optional Block<br>Path matcher specifies multiple criteria for matching an HTTP path string. The match is considered successful if any of the criteria are satisfied. The set of supported match criteria includes a list of path prefixes, a list of exact path values and a list of regular expressions<br>See [Path](#path-acb3cc) below.
|
|
2088
2088
|
|
|
2089
|
-
<a id="params-04b1ad"></a>• [`query_params`](#params-04b1ad) - Optional Block<br>
|
|
2089
|
+
<a id="params-04b1ad"></a>• [`query_params`](#params-04b1ad) - 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-04b1ad) below.
|
|
2090
2090
|
|
|
2091
|
-
<a id="matcher-3cbc4b"></a>• [`tls_fingerprint_matcher`](#matcher-3cbc4b) - Optional Block<br>TLS
|
|
2091
|
+
<a id="matcher-3cbc4b"></a>• [`tls_fingerprint_matcher`](#matcher-3cbc4b) - Optional Block<br>TLS fingerprint matcher specifies multiple criteria for matching a TLS fingerprint. The set of supported positve match criteria includes a list of known classes of TLS fingerprints and a list of exact values. The match is considered successful if either of these positive criteria are satisfied<br>See [TLS Fingerprint Matcher](#matcher-3cbc4b) below.
|
|
2092
2092
|
|
|
2093
2093
|
#### Policy Based Challenge Rule List Rules Spec Arg Matchers
|
|
2094
2094
|
|
|
@@ -2174,59 +2174,59 @@ A [`spec`](#spec-fbd0f9) block (within [`policy_based_challenge.rule_list.rules`
|
|
|
2174
2174
|
|
|
2175
2175
|
A [`temporary_user_blocking`](#blocking-9fdca7) block (within [`policy_based_challenge`](#policy-based-challenge)) supports the following:
|
|
2176
2176
|
|
|
2177
|
-
<a id="page-dc34c2"></a>• [`custom_page`](#page-dc34c2) - Optional String<br>Custom
|
|
2177
|
+
<a id="page-dc34c2"></a>• [`custom_page`](#page-dc34c2) - Optional String<br>Custom message is of type . Currently supported URL schemes is . For scheme, message needs to be encoded in Base64 format. You can specify this message as base64 encoded plain text message e.g. 'Blocked.' or it can be HTML paragraph or a body string encoded as base64 string E.g. '`<p>` Blocked
|
|
2178
2178
|
|
|
2179
2179
|
#### Protected Cookies
|
|
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>Can be used for messages where no values are needed
|
|
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>Can be used for messages where no values are needed
|
|
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>Can be used for messages where no values are needed
|
|
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>Can be used for messages where no values are needed
|
|
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>Can be used for messages where no values are needed
|
|
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>Can be used for messages where no values are needed
|
|
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>Can be used for messages where no values are needed
|
|
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>Can be used for messages where no values are needed
|
|
2198
2198
|
|
|
2199
|
-
<a id="protected-cookies-max-age-value"></a>• [`max_age_value`](#protected-cookies-max-age-value) - Optional Number<br>Add
|
|
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>Can be used for messages where no values are needed
|
|
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>Can be used for messages where no values are needed
|
|
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>Can be used for messages where no values are needed
|
|
2208
2208
|
|
|
2209
2209
|
#### Rate Limit
|
|
2210
2210
|
|
|
2211
2211
|
A [`rate_limit`](#rate-limit) block supports the following:
|
|
2212
2212
|
|
|
2213
|
-
<a id="rate-limit-custom-ip-allowed-list"></a>• [`custom_ip_allowed_list`](#rate-limit-custom-ip-allowed-list) - Optional Block<br>
|
|
2213
|
+
<a id="rate-limit-custom-ip-allowed-list"></a>• [`custom_ip_allowed_list`](#rate-limit-custom-ip-allowed-list) - Optional Block<br>IP Allowed list using existing ip_prefix_set objects<br>See [Custom IP Allowed List](#rate-limit-custom-ip-allowed-list) below.
|
|
2214
2214
|
|
|
2215
|
-
<a id="rate-limit-ip-allowed-list"></a>• [`ip_allowed_list`](#rate-limit-ip-allowed-list) - Optional Block<br>
|
|
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>Can be used for messages where no values are needed
|
|
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>Can be used for messages where no values are needed
|
|
2220
2220
|
|
|
2221
|
-
<a id="rate-limit-policies"></a>• [`policies`](#rate-limit-policies) - Optional Block<br>
|
|
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
|
|
|
2223
|
-
<a id="rate-limit-rate-limiter"></a>• [`rate_limiter`](#rate-limit-rate-limiter) - Optional Block<br>
|
|
2223
|
+
<a id="rate-limit-rate-limiter"></a>• [`rate_limiter`](#rate-limit-rate-limiter) - Optional Block<br>Tuple consisting of a rate limit period unit and the total number of allowed requests for that period<br>See [Rate Limiter](#rate-limit-rate-limiter) below.
|
|
2224
2224
|
|
|
2225
2225
|
#### Rate Limit Custom IP Allowed List
|
|
2226
2226
|
|
|
2227
2227
|
A [`custom_ip_allowed_list`](#rate-limit-custom-ip-allowed-list) block (within [`rate_limit`](#rate-limit)) supports the following:
|
|
2228
2228
|
|
|
2229
|
-
<a id="prefixes-266335"></a>• [`rate_limiter_allowed_prefixes`](#prefixes-266335) - Optional Block<br>
|
|
2229
|
+
<a id="prefixes-266335"></a>• [`rate_limiter_allowed_prefixes`](#prefixes-266335) - Optional Block<br>References to ip_prefix_set objects. Requests from source IP addresses that are covered by one of the allowed IP Prefixes are not subjected to rate limiting<br>See [Rate Limiter Allowed Prefixes](#prefixes-266335) below.
|
|
2230
2230
|
|
|
2231
2231
|
#### Rate Limit Custom IP Allowed List Rate Limiter Allowed Prefixes
|
|
2232
2232
|
|
|
@@ -2236,43 +2236,43 @@ A [`custom_ip_allowed_list`](#rate-limit-custom-ip-allowed-list) block (within [
|
|
|
2236
2236
|
|
|
2237
2237
|
An [`ip_allowed_list`](#rate-limit-ip-allowed-list) block (within [`rate_limit`](#rate-limit)) supports the following:
|
|
2238
2238
|
|
|
2239
|
-
<a id="rate-limit-ip-allowed-list-prefixes"></a>• [`prefixes`](#rate-limit-ip-allowed-list-prefixes) - Optional List<br>
|
|
2239
|
+
<a id="rate-limit-ip-allowed-list-prefixes"></a>• [`prefixes`](#rate-limit-ip-allowed-list-prefixes) - Optional List<br>List of IPv4 prefixes that represent an endpoint
|
|
2240
2240
|
|
|
2241
2241
|
#### Rate Limit Policies
|
|
2242
2242
|
|
|
2243
2243
|
A [`policies`](#rate-limit-policies) block (within [`rate_limit`](#rate-limit)) supports the following:
|
|
2244
2244
|
|
|
2245
|
-
<a id="rate-limit-policies-policies"></a>• [`policies`](#rate-limit-policies-policies) - Optional Block<br>
|
|
2245
|
+
<a id="rate-limit-policies-policies"></a>• [`policies`](#rate-limit-policies-policies) - Optional Block<br>Ordered list of rate limiter policies<br>See [Policies](#rate-limit-policies-policies) below.
|
|
2246
2246
|
|
|
2247
2247
|
#### Rate Limit Policies Policies
|
|
2248
2248
|
|
|
2249
2249
|
A [`policies`](#rate-limit-policies-policies) block (within [`rate_limit.policies`](#rate-limit-policies)) supports the following:
|
|
2250
2250
|
|
|
2251
|
-
<a id="rate-limit-policies-policies-name"></a>• [`name`](#rate-limit-policies-policies-name) - Optional String<br>
|
|
2251
|
+
<a id="rate-limit-policies-policies-name"></a>• [`name`](#rate-limit-policies-policies-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
|
|
2252
2252
|
|
|
2253
|
-
<a id="rate-limit-policies-policies-namespace"></a>• [`namespace`](#rate-limit-policies-policies-namespace) - Optional String<br>
|
|
2253
|
+
<a id="rate-limit-policies-policies-namespace"></a>• [`namespace`](#rate-limit-policies-policies-namespace) - 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
|
|
2254
2254
|
|
|
2255
|
-
<a id="rate-limit-policies-policies-tenant"></a>• [`tenant`](#rate-limit-policies-policies-tenant) - Optional String<br>
|
|
2255
|
+
<a id="rate-limit-policies-policies-tenant"></a>• [`tenant`](#rate-limit-policies-policies-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
|
|
2256
2256
|
|
|
2257
2257
|
#### Rate Limit Rate Limiter
|
|
2258
2258
|
|
|
2259
2259
|
A [`rate_limiter`](#rate-limit-rate-limiter) block (within [`rate_limit`](#rate-limit)) supports the following:
|
|
2260
2260
|
|
|
2261
|
-
<a id="rate-limit-rate-limiter-action-block"></a>• [`action_block`](#rate-limit-rate-limiter-action-block) - Optional Block<br>
|
|
2261
|
+
<a id="rate-limit-rate-limiter-action-block"></a>• [`action_block`](#rate-limit-rate-limiter-action-block) - Optional Block<br>Action where a user is blocked from making further requests after exceeding rate limit threshold<br>See [Action Block](#rate-limit-rate-limiter-action-block) below.
|
|
2262
2262
|
|
|
2263
|
-
<a id="multiplier-1bc2e7"></a>• [`burst_multiplier`](#multiplier-1bc2e7) - Optional Number<br>
|
|
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>Can be used for messages where no values are needed
|
|
2266
2266
|
|
|
2267
|
-
<a id="rate-limit-rate-limiter-leaky-bucket"></a>• [`leaky_bucket`](#rate-limit-rate-limiter-leaky-bucket) - Optional Block<br>Leaky
|
|
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
|
|
|
2269
|
-
<a id="multiplier-07ace4"></a>• [`period_multiplier`](#multiplier-07ace4) - Optional Number<br>
|
|
2269
|
+
<a id="multiplier-07ace4"></a>• [`period_multiplier`](#multiplier-07ace4) - Optional Number<br>Setting, combined with Per Period units, provides a duration
|
|
2270
2270
|
|
|
2271
|
-
<a id="rate-limit-rate-limiter-token-bucket"></a>• [`token_bucket`](#rate-limit-rate-limiter-token-bucket) - Optional Block<br>Token
|
|
2271
|
+
<a id="rate-limit-rate-limiter-token-bucket"></a>• [`token_bucket`](#rate-limit-rate-limiter-token-bucket) - Optional Block<br>Token-Bucket is a rate limiter algorithm that is stricter with enforcing limits
|
|
2272
2272
|
|
|
2273
|
-
<a id="rate-limit-rate-limiter-total-number"></a>• [`total_number`](#rate-limit-rate-limiter-total-number) - Optional Number<br>
|
|
2273
|
+
<a id="rate-limit-rate-limiter-total-number"></a>• [`total_number`](#rate-limit-rate-limiter-total-number) - Optional Number<br>The total number of allowed requests per rate-limiting period
|
|
2274
2274
|
|
|
2275
|
-
<a id="rate-limit-rate-limiter-unit"></a>• [`unit`](#rate-limit-rate-limiter-unit) - Optional String Defaults to `SECOND`<br>Possible values are `SECOND`, `MINUTE`, `HOUR`<br>[Enum: SECOND|MINUTE|HOUR]
|
|
2275
|
+
<a id="rate-limit-rate-limiter-unit"></a>• [`unit`](#rate-limit-rate-limiter-unit) - Optional String Defaults to `SECOND`<br>Possible values are `SECOND`, `MINUTE`, `HOUR`<br>[Enum: SECOND|MINUTE|HOUR] Unit for the period per which the rate limit is applied. - SECOND: Second Rate limit period unit is seconds - MINUTE: Minute Rate limit period unit is minutes - HOUR: Hour Rate limit period unit is hours - DAY: Day Rate limit period unit is days
|
|
2276
2276
|
|
|
2277
2277
|
#### Rate Limit Rate Limiter Action Block
|
|
2278
2278
|
|
|
@@ -2306,27 +2306,27 @@ A [`seconds`](#seconds-8810ec) block (within [`rate_limit.rate_limiter.action_bl
|
|
|
2306
2306
|
|
|
2307
2307
|
A [`sensitive_data_policy`](#sensitive-data-policy) block supports the following:
|
|
2308
2308
|
|
|
2309
|
-
<a id="ref-55b260"></a>• [`sensitive_data_policy_ref`](#ref-55b260) - Optional Block<br>
|
|
2309
|
+
<a id="ref-55b260"></a>• [`sensitive_data_policy_ref`](#ref-55b260) - 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 [Sensitive Data Policy Ref](#ref-55b260) below.
|
|
2310
2310
|
|
|
2311
2311
|
#### Sensitive Data Policy Sensitive Data Policy Ref
|
|
2312
2312
|
|
|
2313
2313
|
A [`sensitive_data_policy_ref`](#ref-55b260) block (within [`sensitive_data_policy`](#sensitive-data-policy)) supports the following:
|
|
2314
2314
|
|
|
2315
|
-
<a id="name-d254a7"></a>• [`name`](#name-d254a7) - Optional String<br>
|
|
2315
|
+
<a id="name-d254a7"></a>• [`name`](#name-d254a7) - 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
|
|
2316
2316
|
|
|
2317
|
-
<a id="namespace-401387"></a>• [`namespace`](#namespace-401387) - Optional String<br>
|
|
2317
|
+
<a id="namespace-401387"></a>• [`namespace`](#namespace-401387) - 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
|
|
2318
2318
|
|
|
2319
|
-
<a id="tenant-d10cc7"></a>• [`tenant`](#tenant-d10cc7) - Optional String<br>
|
|
2319
|
+
<a id="tenant-d10cc7"></a>• [`tenant`](#tenant-d10cc7) - 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
|
|
2320
2320
|
|
|
2321
2321
|
#### Slow DDOS Mitigation
|
|
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>Can be used for messages where no values are needed
|
|
2326
2326
|
|
|
2327
|
-
<a id="timeout-da89d3"></a>• [`request_headers_timeout`](#timeout-da89d3) - Optional Number Defaults to `10000`<br>
|
|
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
|
|
|
2329
|
-
<a id="slow-ddos-mitigation-request-timeout"></a>• [`request_timeout`](#slow-ddos-mitigation-request-timeout) - Optional Number
|
|
2329
|
+
<a id="slow-ddos-mitigation-request-timeout"></a>• [`request_timeout`](#slow-ddos-mitigation-request-timeout) - Optional Number
|
|
2330
2330
|
|
|
2331
2331
|
#### Timeouts
|
|
2332
2332
|
|
|
@@ -2344,47 +2344,47 @@ A [`timeouts`](#timeouts) block supports the following:
|
|
|
2344
2344
|
|
|
2345
2345
|
A [`trusted_clients`](#trusted-clients) block supports the following:
|
|
2346
2346
|
|
|
2347
|
-
<a id="trusted-clients-actions"></a>• [`actions`](#trusted-clients-actions) - Optional List Defaults to `SKIP_PROCESSING_WAF`<br>Possible values are `SKIP_PROCESSING_WAF`, `SKIP_PROCESSING_BOT`, `SKIP_PROCESSING_MUM`, `SKIP_PROCESSING_IP_REPUTATION`, `SKIP_PROCESSING_API_PROTECTION`, `SKIP_PROCESSING_OAS_VALIDATION`, `SKIP_PROCESSING_DDOS_PROTECTION`, `SKIP_PROCESSING_THREAT_MESH`, `SKIP_PROCESSING_MALWARE_PROTECTION`<br>[Enum: SKIP_PROCESSING_WAF|SKIP_PROCESSING_BOT|SKIP_PROCESSING_MUM|SKIP_PROCESSING_IP_REPUTATION|SKIP_PROCESSING_API_PROTECTION|SKIP_PROCESSING_OAS_VALIDATION|SKIP_PROCESSING_DDOS_PROTECTION|SKIP_PROCESSING_THREAT_MESH|SKIP_PROCESSING_MALWARE_PROTECTION] Actions
|
|
2347
|
+
<a id="trusted-clients-actions"></a>• [`actions`](#trusted-clients-actions) - Optional List Defaults to `SKIP_PROCESSING_WAF`<br>Possible values are `SKIP_PROCESSING_WAF`, `SKIP_PROCESSING_BOT`, `SKIP_PROCESSING_MUM`, `SKIP_PROCESSING_IP_REPUTATION`, `SKIP_PROCESSING_API_PROTECTION`, `SKIP_PROCESSING_OAS_VALIDATION`, `SKIP_PROCESSING_DDOS_PROTECTION`, `SKIP_PROCESSING_THREAT_MESH`, `SKIP_PROCESSING_MALWARE_PROTECTION`<br>[Enum: SKIP_PROCESSING_WAF|SKIP_PROCESSING_BOT|SKIP_PROCESSING_MUM|SKIP_PROCESSING_IP_REPUTATION|SKIP_PROCESSING_API_PROTECTION|SKIP_PROCESSING_OAS_VALIDATION|SKIP_PROCESSING_DDOS_PROTECTION|SKIP_PROCESSING_THREAT_MESH|SKIP_PROCESSING_MALWARE_PROTECTION] Actions that should be taken when client identifier matches the rule
|
|
2348
2348
|
|
|
2349
|
-
<a id="trusted-clients-as-number"></a>• [`as_number`](#trusted-clients-as-number) - Optional Number<br>
|
|
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>Can be used for messages where no values are needed
|
|
2352
2352
|
|
|
2353
|
-
<a id="trusted-clients-expiration-timestamp"></a>• [`expiration_timestamp`](#trusted-clients-expiration-timestamp) - Optional String<br>
|
|
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
|
|
|
2355
2355
|
<a id="trusted-clients-http-header"></a>• [`http_header`](#trusted-clients-http-header) - Optional Block<br>HTTP Header. Request header name and value pairs<br>See [HTTP Header](#trusted-clients-http-header) below.
|
|
2356
2356
|
|
|
2357
|
-
<a id="trusted-clients-ip-prefix"></a>• [`ip_prefix`](#trusted-clients-ip-prefix) - Optional String<br>IPv4
|
|
2357
|
+
<a id="trusted-clients-ip-prefix"></a>• [`ip_prefix`](#trusted-clients-ip-prefix) - Optional String<br>IPv4 prefix string
|
|
2358
2358
|
|
|
2359
|
-
<a id="trusted-clients-ipv6-prefix"></a>• [`ipv6_prefix`](#trusted-clients-ipv6-prefix) - Optional String<br>IPv6
|
|
2359
|
+
<a id="trusted-clients-ipv6-prefix"></a>• [`ipv6_prefix`](#trusted-clients-ipv6-prefix) - Optional String<br>IPv6 prefix string
|
|
2360
2360
|
|
|
2361
|
-
<a id="trusted-clients-metadata"></a>• [`metadata`](#trusted-clients-metadata) - Optional Block<br>
|
|
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>Can be used for messages where no values are needed
|
|
2364
2364
|
|
|
2365
|
-
<a id="trusted-clients-user-identifier"></a>• [`user_identifier`](#trusted-clients-user-identifier) - Optional String<br>
|
|
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>Can be used for messages where no values are needed
|
|
2368
2368
|
|
|
2369
2369
|
#### Trusted Clients HTTP Header
|
|
2370
2370
|
|
|
2371
2371
|
A [`http_header`](#trusted-clients-http-header) block (within [`trusted_clients`](#trusted-clients)) supports the following:
|
|
2372
2372
|
|
|
2373
|
-
<a id="trusted-clients-http-header-headers"></a>• [`headers`](#trusted-clients-http-header-headers) - Optional Block<br>
|
|
2373
|
+
<a id="trusted-clients-http-header-headers"></a>• [`headers`](#trusted-clients-http-header-headers) - Optional Block<br>List of HTTP header name and value pairs<br>See [Headers](#trusted-clients-http-header-headers) below.
|
|
2374
2374
|
|
|
2375
2375
|
#### Trusted Clients HTTP Header Headers
|
|
2376
2376
|
|
|
2377
2377
|
A [`headers`](#trusted-clients-http-header-headers) block (within [`trusted_clients.http_header`](#trusted-clients-http-header)) supports the following:
|
|
2378
2378
|
|
|
2379
|
-
<a id="exact-1a048f"></a>• [`exact`](#exact-1a048f) - Optional String<br>
|
|
2379
|
+
<a id="exact-1a048f"></a>• [`exact`](#exact-1a048f) - Optional String<br>Header value to match exactly
|
|
2380
2380
|
|
|
2381
|
-
<a id="match-4d5659"></a>• [`invert_match`](#match-4d5659) - Optional Bool<br>
|
|
2381
|
+
<a id="match-4d5659"></a>• [`invert_match`](#match-4d5659) - Optional Bool<br>Invert the result of the match to detect missing header or non-matching value
|
|
2382
2382
|
|
|
2383
2383
|
<a id="name-b3a383"></a>• [`name`](#name-b3a383) - Optional String<br>Name. Name of the header
|
|
2384
2384
|
|
|
2385
|
-
<a id="presence-a73dd8"></a>• [`presence`](#presence-a73dd8) - Optional Bool<br>
|
|
2385
|
+
<a id="presence-a73dd8"></a>• [`presence`](#presence-a73dd8) - Optional Bool<br>If true, check for presence of header
|
|
2386
2386
|
|
|
2387
|
-
<a id="regex-d6b675"></a>• [`regex`](#regex-d6b675) - Optional String<br>Regex
|
|
2387
|
+
<a id="regex-d6b675"></a>• [`regex`](#regex-d6b675) - Optional String<br>Regex match of the header value in re2 format
|
|
2388
2388
|
|
|
2389
2389
|
#### Trusted Clients Metadata
|
|
2390
2390
|
|
|
@@ -2392,57 +2392,57 @@ A [`metadata`](#trusted-clients-metadata) block (within [`trusted_clients`](#tru
|
|
|
2392
2392
|
|
|
2393
2393
|
<a id="spec-766a6d"></a>• [`description_spec`](#spec-766a6d) - Optional String<br>Description. Human readable description
|
|
2394
2394
|
|
|
2395
|
-
<a id="trusted-clients-metadata-name"></a>• [`name`](#trusted-clients-metadata-name) - Optional String<br>Name
|
|
2395
|
+
<a id="trusted-clients-metadata-name"></a>• [`name`](#trusted-clients-metadata-name) - Optional String<br>Name of the message. The value of name has to follow DNS-1035 format
|
|
2396
2396
|
|
|
2397
2397
|
#### User Identification
|
|
2398
2398
|
|
|
2399
2399
|
An [`user_identification`](#user-identification) block supports the following:
|
|
2400
2400
|
|
|
2401
|
-
<a id="user-identification-name"></a>• [`name`](#user-identification-name) - Optional String<br>
|
|
2401
|
+
<a id="user-identification-name"></a>• [`name`](#user-identification-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
|
|
2402
2402
|
|
|
2403
|
-
<a id="user-identification-namespace"></a>• [`namespace`](#user-identification-namespace) - Optional String<br>
|
|
2403
|
+
<a id="user-identification-namespace"></a>• [`namespace`](#user-identification-namespace) - 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
|
|
2404
2404
|
|
|
2405
|
-
<a id="user-identification-tenant"></a>• [`tenant`](#user-identification-tenant) - Optional String<br>
|
|
2405
|
+
<a id="user-identification-tenant"></a>• [`tenant`](#user-identification-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
|
|
2406
2406
|
|
|
2407
2407
|
#### WAF Exclusion
|
|
2408
2408
|
|
|
2409
2409
|
A [`waf_exclusion`](#waf-exclusion) block supports the following:
|
|
2410
2410
|
|
|
2411
|
-
<a id="rules-6d8efc"></a>• [`waf_exclusion_inline_rules`](#rules-6d8efc) - Optional Block<br>
|
|
2411
|
+
<a id="rules-6d8efc"></a>• [`waf_exclusion_inline_rules`](#rules-6d8efc) - Optional Block<br>List of WAF exclusion rules that will be applied inline<br>See [WAF Exclusion Inline Rules](#rules-6d8efc) below.
|
|
2412
2412
|
|
|
2413
|
-
<a id="waf-exclusion-waf-exclusion-policy"></a>• [`waf_exclusion_policy`](#waf-exclusion-waf-exclusion-policy) - Optional Block<br>
|
|
2413
|
+
<a id="waf-exclusion-waf-exclusion-policy"></a>• [`waf_exclusion_policy`](#waf-exclusion-waf-exclusion-policy) - 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 [WAF Exclusion Policy](#waf-exclusion-waf-exclusion-policy) below.
|
|
2414
2414
|
|
|
2415
2415
|
#### WAF Exclusion WAF Exclusion Inline Rules
|
|
2416
2416
|
|
|
2417
2417
|
A [`waf_exclusion_inline_rules`](#rules-6d8efc) block (within [`waf_exclusion`](#waf-exclusion)) supports the following:
|
|
2418
2418
|
|
|
2419
|
-
<a id="rules-28cf34"></a>• [`rules`](#rules-28cf34) - Optional Block<br>
|
|
2419
|
+
<a id="rules-28cf34"></a>• [`rules`](#rules-28cf34) - Optional Block<br>Ordered list of WAF Exclusions specific to this Load Balancer<br>See [Rules](#rules-28cf34) below.
|
|
2420
2420
|
|
|
2421
2421
|
#### WAF Exclusion WAF Exclusion Inline Rules Rules
|
|
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>Can be used for messages where no values are needed
|
|
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>Can be used for messages where no values are needed
|
|
2428
2428
|
|
|
2429
|
-
<a id="control-0cb52d"></a>• [`app_firewall_detection_control`](#control-0cb52d) - Optional Block<br>
|
|
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
|
|
|
2431
|
-
<a id="value-451fbf"></a>• [`exact_value`](#value-451fbf) - Optional String<br>Exact
|
|
2431
|
+
<a id="value-451fbf"></a>• [`exact_value`](#value-451fbf) - Optional String<br>Exact domain name
|
|
2432
2432
|
|
|
2433
|
-
<a id="timestamp-423d81"></a>• [`expiration_timestamp`](#timestamp-423d81) - Optional String<br>
|
|
2433
|
+
<a id="timestamp-423d81"></a>• [`expiration_timestamp`](#timestamp-423d81) - 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
|
|
2434
2434
|
|
|
2435
|
-
<a id="metadata-09584f"></a>• [`metadata`](#metadata-09584f) - Optional Block<br>
|
|
2435
|
+
<a id="metadata-09584f"></a>• [`metadata`](#metadata-09584f) - 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-09584f) below.
|
|
2436
2436
|
|
|
2437
2437
|
<a id="methods-19f73d"></a>• [`methods`](#methods-19f73d) - Optional List Defaults to `ANY`<br>See [HTTP Methods](#common-http-methods)<br> Methods. Methods to be matched
|
|
2438
2438
|
|
|
2439
|
-
<a id="prefix-a857dd"></a>• [`path_prefix`](#prefix-a857dd) - Optional String<br>
|
|
2439
|
+
<a id="prefix-a857dd"></a>• [`path_prefix`](#prefix-a857dd) - Optional String<br>Path prefix to match (e.g. The value / will match on all paths)
|
|
2440
2440
|
|
|
2441
|
-
<a id="regex-fdbacd"></a>• [`path_regex`](#regex-fdbacd) - Optional String<br>
|
|
2441
|
+
<a id="regex-fdbacd"></a>• [`path_regex`](#regex-fdbacd) - Optional String<br>Define the regex for the path. For example, the regex ^/.*$ will match on all paths
|
|
2442
2442
|
|
|
2443
|
-
<a id="value-6f2f58"></a>• [`suffix_value`](#value-6f2f58) - Optional String<br>Suffix
|
|
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>Can be used for messages where no values are needed
|
|
2446
2446
|
|
|
2447
2447
|
#### WAF Exclusion WAF Exclusion Inline Rules Rules App Firewall Detection Control
|
|
2448
2448
|
|
|
@@ -2472,11 +2472,11 @@ A [`rules`](#rules-28cf34) block (within [`waf_exclusion.waf_exclusion_inline_ru
|
|
|
2472
2472
|
|
|
2473
2473
|
A [`waf_exclusion_policy`](#waf-exclusion-waf-exclusion-policy) block (within [`waf_exclusion`](#waf-exclusion)) supports the following:
|
|
2474
2474
|
|
|
2475
|
-
<a id="waf-exclusion-waf-exclusion-policy-name"></a>• [`name`](#waf-exclusion-waf-exclusion-policy-name) - Optional String<br>
|
|
2475
|
+
<a id="waf-exclusion-waf-exclusion-policy-name"></a>• [`name`](#waf-exclusion-waf-exclusion-policy-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
|
|
2476
2476
|
|
|
2477
|
-
<a id="namespace-d8f030"></a>• [`namespace`](#namespace-d8f030) - Optional String<br>
|
|
2477
|
+
<a id="namespace-d8f030"></a>• [`namespace`](#namespace-d8f030) - 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
|
|
2478
2478
|
|
|
2479
|
-
<a id="tenant-d841f0"></a>• [`tenant`](#tenant-d841f0) - Optional String<br>
|
|
2479
|
+
<a id="tenant-d841f0"></a>• [`tenant`](#tenant-d841f0) - 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
|
|
2480
2480
|
|
|
2481
2481
|
---
|
|
2482
2482
|
|