@robinmordasiewicz/f5xc-terraform-mcp 2.4.8 → 2.6.2

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.
Files changed (290) hide show
  1. package/dist/docs/data-sources/addon_subscription.md +85 -2
  2. package/dist/docs/data-sources/address_allocator.md +85 -2
  3. package/dist/docs/data-sources/advertise_policy.md +85 -2
  4. package/dist/docs/data-sources/alert_policy.md +85 -2
  5. package/dist/docs/data-sources/alert_receiver.md +85 -2
  6. package/dist/docs/data-sources/allowed_tenant.md +85 -2
  7. package/dist/docs/data-sources/api_crawler.md +85 -2
  8. package/dist/docs/data-sources/api_credential.md +85 -2
  9. package/dist/docs/data-sources/api_definition.md +85 -2
  10. package/dist/docs/data-sources/api_discovery.md +85 -2
  11. package/dist/docs/data-sources/api_testing.md +85 -2
  12. package/dist/docs/data-sources/apm.md +85 -2
  13. package/dist/docs/data-sources/app_api_group.md +85 -2
  14. package/dist/docs/data-sources/app_firewall.md +85 -2
  15. package/dist/docs/data-sources/app_setting.md +85 -2
  16. package/dist/docs/data-sources/app_type.md +85 -2
  17. package/dist/docs/data-sources/authentication.md +85 -2
  18. package/dist/docs/data-sources/aws_tgw_site.md +85 -2
  19. package/dist/docs/data-sources/aws_vpc_site.md +85 -2
  20. package/dist/docs/data-sources/azure_vnet_site.md +85 -2
  21. package/dist/docs/data-sources/bgp.md +85 -2
  22. package/dist/docs/data-sources/bgp_asn_set.md +85 -2
  23. package/dist/docs/data-sources/bgp_routing_policy.md +85 -2
  24. package/dist/docs/data-sources/bigip_irule.md +85 -2
  25. package/dist/docs/data-sources/bot_defense_app_infrastructure.md +85 -2
  26. package/dist/docs/data-sources/cdn_cache_rule.md +85 -2
  27. package/dist/docs/data-sources/cdn_loadbalancer.md +85 -2
  28. package/dist/docs/data-sources/certificate.md +85 -2
  29. package/dist/docs/data-sources/certificate_chain.md +85 -2
  30. package/dist/docs/data-sources/child_tenant.md +85 -2
  31. package/dist/docs/data-sources/child_tenant_manager.md +85 -2
  32. package/dist/docs/data-sources/cloud_connect.md +85 -2
  33. package/dist/docs/data-sources/cloud_credentials.md +85 -2
  34. package/dist/docs/data-sources/cloud_elastic_ip.md +85 -2
  35. package/dist/docs/data-sources/cloud_link.md +85 -2
  36. package/dist/docs/data-sources/cluster.md +85 -2
  37. package/dist/docs/data-sources/cminstance.md +85 -2
  38. package/dist/docs/data-sources/code_base_integration.md +85 -2
  39. package/dist/docs/data-sources/contact.md +85 -2
  40. package/dist/docs/data-sources/container_registry.md +85 -2
  41. package/dist/docs/data-sources/crl.md +85 -2
  42. package/dist/docs/data-sources/customer_support.md +85 -2
  43. package/dist/docs/data-sources/data_group.md +85 -2
  44. package/dist/docs/data-sources/data_type.md +85 -2
  45. package/dist/docs/data-sources/dc_cluster_group.md +85 -2
  46. package/dist/docs/data-sources/discovery.md +85 -2
  47. package/dist/docs/data-sources/dns_compliance_checks.md +85 -2
  48. package/dist/docs/data-sources/dns_domain.md +85 -2
  49. package/dist/docs/data-sources/dns_lb_health_check.md +85 -2
  50. package/dist/docs/data-sources/dns_lb_pool.md +85 -2
  51. package/dist/docs/data-sources/dns_load_balancer.md +85 -2
  52. package/dist/docs/data-sources/dns_zone.md +85 -2
  53. package/dist/docs/data-sources/endpoint.md +85 -2
  54. package/dist/docs/data-sources/enhanced_firewall_policy.md +85 -2
  55. package/dist/docs/data-sources/external_connector.md +85 -2
  56. package/dist/docs/data-sources/fast_acl.md +85 -2
  57. package/dist/docs/data-sources/fast_acl_rule.md +85 -2
  58. package/dist/docs/data-sources/filter_set.md +85 -2
  59. package/dist/docs/data-sources/fleet.md +85 -2
  60. package/dist/docs/data-sources/forward_proxy_policy.md +85 -2
  61. package/dist/docs/data-sources/forwarding_class.md +85 -2
  62. package/dist/docs/data-sources/gcp_vpc_site.md +85 -2
  63. package/dist/docs/data-sources/geo_location_set.md +85 -2
  64. package/dist/docs/data-sources/global_log_receiver.md +85 -2
  65. package/dist/docs/data-sources/healthcheck.md +85 -2
  66. package/dist/docs/data-sources/http_loadbalancer.md +85 -2
  67. package/dist/docs/data-sources/ike1.md +85 -2
  68. package/dist/docs/data-sources/ike2.md +85 -2
  69. package/dist/docs/data-sources/ike_phase1_profile.md +85 -2
  70. package/dist/docs/data-sources/ike_phase2_profile.md +85 -2
  71. package/dist/docs/data-sources/infraprotect_asn.md +85 -2
  72. package/dist/docs/data-sources/infraprotect_asn_prefix.md +85 -2
  73. package/dist/docs/data-sources/infraprotect_deny_list_rule.md +85 -2
  74. package/dist/docs/data-sources/infraprotect_firewall_rule.md +85 -2
  75. package/dist/docs/data-sources/infraprotect_firewall_rule_group.md +85 -2
  76. package/dist/docs/data-sources/infraprotect_internet_prefix_advertisement.md +85 -2
  77. package/dist/docs/data-sources/infraprotect_tunnel.md +85 -2
  78. package/dist/docs/data-sources/ip_prefix_set.md +85 -2
  79. package/dist/docs/data-sources/irule.md +85 -2
  80. package/dist/docs/data-sources/k8s_cluster.md +85 -2
  81. package/dist/docs/data-sources/k8s_cluster_role.md +85 -2
  82. package/dist/docs/data-sources/k8s_cluster_role_binding.md +85 -2
  83. package/dist/docs/data-sources/k8s_pod_security_admission.md +85 -2
  84. package/dist/docs/data-sources/k8s_pod_security_policy.md +85 -2
  85. package/dist/docs/data-sources/log_receiver.md +85 -2
  86. package/dist/docs/data-sources/malicious_user_mitigation.md +85 -2
  87. package/dist/docs/data-sources/managed_tenant.md +85 -2
  88. package/dist/docs/data-sources/namespace.md +85 -2
  89. package/dist/docs/data-sources/nat_policy.md +85 -2
  90. package/dist/docs/data-sources/network_connector.md +85 -2
  91. package/dist/docs/data-sources/network_firewall.md +85 -2
  92. package/dist/docs/data-sources/network_interface.md +85 -2
  93. package/dist/docs/data-sources/network_policy.md +85 -2
  94. package/dist/docs/data-sources/network_policy_rule.md +85 -2
  95. package/dist/docs/data-sources/network_policy_view.md +85 -2
  96. package/dist/docs/data-sources/nfv_service.md +85 -2
  97. package/dist/docs/data-sources/oidc_provider.md +85 -2
  98. package/dist/docs/data-sources/origin_pool.md +85 -2
  99. package/dist/docs/data-sources/policer.md +85 -2
  100. package/dist/docs/data-sources/policy_based_routing.md +85 -2
  101. package/dist/docs/data-sources/protocol_inspection.md +85 -2
  102. package/dist/docs/data-sources/protocol_policer.md +85 -2
  103. package/dist/docs/data-sources/proxy.md +85 -2
  104. package/dist/docs/data-sources/quota.md +85 -2
  105. package/dist/docs/data-sources/rate_limiter.md +85 -2
  106. package/dist/docs/data-sources/rate_limiter_policy.md +85 -2
  107. package/dist/docs/data-sources/registration.md +85 -2
  108. package/dist/docs/data-sources/report_config.md +85 -2
  109. package/dist/docs/data-sources/role.md +85 -2
  110. package/dist/docs/data-sources/route.md +85 -2
  111. package/dist/docs/data-sources/secret_management_access.md +85 -2
  112. package/dist/docs/data-sources/secret_policy.md +85 -2
  113. package/dist/docs/data-sources/secret_policy_rule.md +85 -2
  114. package/dist/docs/data-sources/securemesh_site.md +85 -2
  115. package/dist/docs/data-sources/securemesh_site_v2.md +85 -2
  116. package/dist/docs/data-sources/segment.md +85 -2
  117. package/dist/docs/data-sources/sensitive_data_policy.md +85 -2
  118. package/dist/docs/data-sources/service_policy.md +85 -2
  119. package/dist/docs/data-sources/service_policy_rule.md +85 -2
  120. package/dist/docs/data-sources/site_mesh_group.md +85 -2
  121. package/dist/docs/data-sources/srv6_network_slice.md +85 -2
  122. package/dist/docs/data-sources/subnet.md +85 -2
  123. package/dist/docs/data-sources/tcp_loadbalancer.md +85 -2
  124. package/dist/docs/data-sources/tenant_configuration.md +85 -2
  125. package/dist/docs/data-sources/tenant_profile.md +85 -2
  126. package/dist/docs/data-sources/ticket_tracking_system.md +85 -2
  127. package/dist/docs/data-sources/token.md +85 -2
  128. package/dist/docs/data-sources/tpm_api_key.md +85 -2
  129. package/dist/docs/data-sources/tpm_category.md +85 -2
  130. package/dist/docs/data-sources/tpm_manager.md +85 -2
  131. package/dist/docs/data-sources/trusted_ca_list.md +85 -2
  132. package/dist/docs/data-sources/tunnel.md +85 -2
  133. package/dist/docs/data-sources/udp_loadbalancer.md +85 -2
  134. package/dist/docs/data-sources/usb_policy.md +85 -2
  135. package/dist/docs/data-sources/user_identification.md +85 -2
  136. package/dist/docs/data-sources/virtual_host.md +85 -2
  137. package/dist/docs/data-sources/virtual_k8s.md +85 -2
  138. package/dist/docs/data-sources/virtual_network.md +85 -2
  139. package/dist/docs/data-sources/virtual_site.md +85 -2
  140. package/dist/docs/data-sources/voltshare_admin_policy.md +85 -2
  141. package/dist/docs/data-sources/voltstack_site.md +85 -2
  142. package/dist/docs/data-sources/waf_exclusion_policy.md +85 -2
  143. package/dist/docs/data-sources/workload.md +85 -2
  144. package/dist/docs/data-sources/workload_flavor.md +85 -2
  145. package/dist/docs/guides/advanced-http-loadbalancer.md +569 -0
  146. package/dist/docs/resources/addon_subscription.md +87 -10
  147. package/dist/docs/resources/address_allocator.md +86 -3
  148. package/dist/docs/resources/advertise_policy.md +112 -57
  149. package/dist/docs/resources/alert_policy.md +91 -8
  150. package/dist/docs/resources/alert_receiver.md +94 -55
  151. package/dist/docs/resources/allowed_tenant.md +87 -10
  152. package/dist/docs/resources/api_crawler.md +86 -3
  153. package/dist/docs/resources/api_credential.md +86 -3
  154. package/dist/docs/resources/api_definition.md +89 -6
  155. package/dist/docs/resources/api_discovery.md +86 -3
  156. package/dist/docs/resources/api_testing.md +95 -52
  157. package/dist/docs/resources/apm.md +156 -519
  158. package/dist/docs/resources/app_api_group.md +90 -25
  159. package/dist/docs/resources/app_firewall.md +87 -6
  160. package/dist/docs/resources/app_setting.md +97 -66
  161. package/dist/docs/resources/app_type.md +86 -3
  162. package/dist/docs/resources/authentication.md +90 -27
  163. package/dist/docs/resources/aws_tgw_site.md +125 -222
  164. package/dist/docs/resources/aws_vpc_site.md +149 -352
  165. package/dist/docs/resources/azure_vnet_site.md +233 -860
  166. package/dist/docs/resources/bgp.md +103 -32
  167. package/dist/docs/resources/bgp_asn_set.md +86 -3
  168. package/dist/docs/resources/bgp_routing_policy.md +86 -3
  169. package/dist/docs/resources/bigip_irule.md +86 -3
  170. package/dist/docs/resources/bot_defense_app_infrastructure.md +86 -3
  171. package/dist/docs/resources/cdn_cache_rule.md +97 -120
  172. package/dist/docs/resources/cdn_loadbalancer.md +325 -1620
  173. package/dist/docs/resources/certificate.md +87 -10
  174. package/dist/docs/resources/certificate_chain.md +86 -3
  175. package/dist/docs/resources/child_tenant.md +88 -17
  176. package/dist/docs/resources/child_tenant_manager.md +88 -17
  177. package/dist/docs/resources/cloud_connect.md +98 -63
  178. package/dist/docs/resources/cloud_credentials.md +92 -39
  179. package/dist/docs/resources/cloud_elastic_ip.md +91 -8
  180. package/dist/docs/resources/cloud_link.md +90 -29
  181. package/dist/docs/resources/cluster.md +109 -66
  182. package/dist/docs/resources/cminstance.md +86 -3
  183. package/dist/docs/resources/code_base_integration.md +100 -87
  184. package/dist/docs/resources/contact.md +86 -3
  185. package/dist/docs/resources/container_registry.md +86 -3
  186. package/dist/docs/resources/crl.md +86 -3
  187. package/dist/docs/resources/customer_support.md +91 -8
  188. package/dist/docs/resources/data_group.md +86 -3
  189. package/dist/docs/resources/data_type.md +88 -9
  190. package/dist/docs/resources/dc_cluster_group.md +86 -3
  191. package/dist/docs/resources/discovery.md +115 -104
  192. package/dist/docs/resources/dns_compliance_checks.md +86 -3
  193. package/dist/docs/resources/dns_domain.md +86 -3
  194. package/dist/docs/resources/dns_lb_health_check.md +86 -3
  195. package/dist/docs/resources/dns_lb_pool.md +87 -10
  196. package/dist/docs/resources/dns_load_balancer.md +95 -40
  197. package/dist/docs/resources/dns_zone.md +86 -3
  198. package/dist/docs/resources/endpoint.md +101 -18
  199. package/dist/docs/resources/enhanced_firewall_policy.md +89 -32
  200. package/dist/docs/resources/external_connector.md +94 -29
  201. package/dist/docs/resources/fast_acl.md +100 -101
  202. package/dist/docs/resources/fast_acl_rule.md +101 -18
  203. package/dist/docs/resources/filter_set.md +86 -3
  204. package/dist/docs/resources/fleet.md +170 -541
  205. package/dist/docs/resources/forward_proxy_policy.md +90 -31
  206. package/dist/docs/resources/forwarding_class.md +87 -10
  207. package/dist/docs/resources/gcp_vpc_site.md +141 -328
  208. package/dist/docs/resources/geo_location_set.md +86 -3
  209. package/dist/docs/resources/global_log_receiver.md +116 -181
  210. package/dist/docs/resources/healthcheck.md +86 -3
  211. package/dist/docs/resources/http_loadbalancer.md +523 -2778
  212. package/dist/docs/resources/ike1.md +86 -3
  213. package/dist/docs/resources/ike2.md +86 -3
  214. package/dist/docs/resources/ike_phase1_profile.md +86 -3
  215. package/dist/docs/resources/ike_phase2_profile.md +86 -3
  216. package/dist/docs/resources/infraprotect_asn.md +86 -3
  217. package/dist/docs/resources/infraprotect_asn_prefix.md +87 -10
  218. package/dist/docs/resources/infraprotect_deny_list_rule.md +86 -3
  219. package/dist/docs/resources/infraprotect_firewall_rule.md +86 -3
  220. package/dist/docs/resources/infraprotect_firewall_rule_group.md +86 -3
  221. package/dist/docs/resources/infraprotect_internet_prefix_advertisement.md +86 -3
  222. package/dist/docs/resources/infraprotect_tunnel.md +90 -29
  223. package/dist/docs/resources/ip_prefix_set.md +86 -3
  224. package/dist/docs/resources/irule.md +86 -3
  225. package/dist/docs/resources/k8s_cluster.md +93 -58
  226. package/dist/docs/resources/k8s_cluster_role.md +87 -8
  227. package/dist/docs/resources/k8s_cluster_role_binding.md +87 -10
  228. package/dist/docs/resources/k8s_pod_security_admission.md +86 -3
  229. package/dist/docs/resources/k8s_pod_security_policy.md +87 -8
  230. package/dist/docs/resources/log_receiver.md +88 -15
  231. package/dist/docs/resources/malicious_user_mitigation.md +86 -3
  232. package/dist/docs/resources/managed_tenant.md +89 -12
  233. package/dist/docs/resources/namespace.md +86 -3
  234. package/dist/docs/resources/nat_policy.md +126 -43
  235. package/dist/docs/resources/network_connector.md +94 -51
  236. package/dist/docs/resources/network_firewall.md +90 -31
  237. package/dist/docs/resources/network_interface.md +93 -46
  238. package/dist/docs/resources/network_policy.md +96 -13
  239. package/dist/docs/resources/network_policy_rule.md +91 -8
  240. package/dist/docs/resources/network_policy_view.md +96 -13
  241. package/dist/docs/resources/nfv_service.md +153 -446
  242. package/dist/docs/resources/oidc_provider.md +86 -3
  243. package/dist/docs/resources/origin_pool.md +108 -145
  244. package/dist/docs/resources/policer.md +86 -3
  245. package/dist/docs/resources/policy_based_routing.md +100 -89
  246. package/dist/docs/resources/protocol_inspection.md +87 -10
  247. package/dist/docs/resources/protocol_policer.md +91 -8
  248. package/dist/docs/resources/proxy.md +154 -571
  249. package/dist/docs/resources/quota.md +86 -3
  250. package/dist/docs/resources/rate_limiter.md +91 -8
  251. package/dist/docs/resources/rate_limiter_policy.md +100 -23
  252. package/dist/docs/resources/registration.md +86 -3
  253. package/dist/docs/resources/report_config.md +87 -10
  254. package/dist/docs/resources/role.md +86 -3
  255. package/dist/docs/resources/route.md +113 -82
  256. package/dist/docs/resources/secret_management_access.md +127 -156
  257. package/dist/docs/resources/secret_policy.md +87 -4
  258. package/dist/docs/resources/secret_policy_rule.md +86 -3
  259. package/dist/docs/resources/securemesh_site.md +137 -380
  260. package/dist/docs/resources/securemesh_site_v2.md +289 -1204
  261. package/dist/docs/resources/segment.md +86 -3
  262. package/dist/docs/resources/sensitive_data_policy.md +87 -10
  263. package/dist/docs/resources/service_policy.md +115 -122
  264. package/dist/docs/resources/service_policy_rule.md +110 -59
  265. package/dist/docs/resources/site_mesh_group.md +92 -15
  266. package/dist/docs/resources/srv6_network_slice.md +86 -3
  267. package/dist/docs/resources/subnet.md +89 -20
  268. package/dist/docs/resources/tcp_loadbalancer.md +114 -185
  269. package/dist/docs/resources/tenant_configuration.md +86 -3
  270. package/dist/docs/resources/tenant_profile.md +87 -10
  271. package/dist/docs/resources/ticket_tracking_system.md +86 -3
  272. package/dist/docs/resources/token.md +86 -3
  273. package/dist/docs/resources/tpm_api_key.md +91 -8
  274. package/dist/docs/resources/tpm_category.md +91 -8
  275. package/dist/docs/resources/tpm_manager.md +86 -3
  276. package/dist/docs/resources/trusted_ca_list.md +86 -3
  277. package/dist/docs/resources/tunnel.md +91 -8
  278. package/dist/docs/resources/udp_loadbalancer.md +97 -80
  279. package/dist/docs/resources/usb_policy.md +86 -3
  280. package/dist/docs/resources/user_identification.md +86 -3
  281. package/dist/docs/resources/virtual_host.md +152 -177
  282. package/dist/docs/resources/virtual_k8s.md +92 -15
  283. package/dist/docs/resources/virtual_network.md +91 -8
  284. package/dist/docs/resources/virtual_site.md +86 -3
  285. package/dist/docs/resources/voltshare_admin_policy.md +86 -11
  286. package/dist/docs/resources/voltstack_site.md +380 -1365
  287. package/dist/docs/resources/waf_exclusion_policy.md +91 -28
  288. package/dist/docs/resources/workload.md +1189 -4148
  289. package/dist/docs/resources/workload_flavor.md +86 -3
  290. package/package.json +1 -1
package/dist/docs/resources/cdn_loadbalancer.md CHANGED
@@ -2,12 +2,12 @@
2
2
  page_title: "f5xc_cdn_loadbalancer Resource - terraform-provider-f5xc"
3
3
  subcategory: "Load Balancing"
4
4
  description: |-
5
- [Category: Load Balancing] [Namespace: required] Manages a CDN Load Balancer resource in F5 Distributed Cloud for content delivery and edge caching with load balancing.
5
+ Manages a CDN Load Balancer resource in F5 Distributed Cloud for content delivery and edge caching with load balancing.
6
6
  ---
7
7
 
8
8
  # f5xc_cdn_loadbalancer (Resource)
9
9
 
10
- [Category: Load Balancing] [Namespace: required] Manages a CDN Load Balancer resource in F5 Distributed Cloud for content delivery and edge caching with load balancing.
10
+ Manages a CDN Load Balancer resource in F5 Distributed Cloud for content delivery and edge caching with load balancing.
11
11
 
12
12
  ~> **Note** Please refer to [CDN Loadbalancer API docs](https://docs.cloud.f5.com/docs-v2/api/views-cdn-loadbalancer) to learn more.
13
13
 
@@ -15,7 +15,7 @@ description: |-
15
15
 
16
16
  ```terraform
17
17
  # CDN Loadbalancer Resource Example
18
- # [Category: Load Balancing] [Namespace: required] Manages a CDN Load Balancer resource in F5 Distributed Cloud for content delivery and edge caching with load balancing.
18
+ # Manages a CDN Load Balancer resource in F5 Distributed Cloud for content delivery and edge caching with load balancing.
19
19
 
20
20
  # Basic CDN Loadbalancer configuration
21
21
  resource "f5xc_cdn_loadbalancer" "example" {
@@ -208,13 +208,7 @@ An [`active_service_policies`](#active-service-policies) block supports the foll
208
208
 
209
209
  #### Active Service Policies Policies
210
210
 
211
- A [`policies`](#active-service-policies-policies) block (within [`active_service_policies`](#active-service-policies)) supports the following:
212
-
213
- <a id="active-service-policies-policies-name"></a>&#x2022; [`name`](#active-service-policies-policies-name) - Optional String<br>Name. 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
-
215
- <a id="namespace-df0e5f"></a>&#x2022; [`namespace`](#namespace-df0e5f) - Optional String<br>Namespace. 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
-
217
- <a id="active-service-policies-policies-tenant"></a>&#x2022; [`tenant`](#active-service-policies-policies-tenant) - Optional String<br>Tenant. 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
211
+ <a id="objref-460dca"></a>Uses standard [Object Reference](#common-object-reference) fields (name, namespace, tenant).
218
212
 
219
213
  #### API Rate Limit
220
214
 
@@ -254,251 +248,95 @@ An [`api_endpoint_rules`](#api-rate-limit-api-endpoint-rules) block (within [`ap
254
248
 
255
249
  #### API Rate Limit API Endpoint Rules API Endpoint Method
256
250
 
257
- An [`api_endpoint_method`](#method-1e49b0) block (within [`api_rate_limit.api_endpoint_rules`](#api-rate-limit-api-endpoint-rules)) supports the following:
258
-
259
- <a id="matcher-25dd70"></a>&#x2022; [`invert_matcher`](#matcher-25dd70) - Optional Bool<br>Invert Method Matcher. Invert the match result
260
-
261
- <a id="methods-bf7e55"></a>&#x2022; [`methods`](#methods-bf7e55) - Optional List Defaults to `ANY`<br>Possible values are `ANY`, `GET`, `HEAD`, `POST`, `PUT`, `DELETE`, `CONNECT`, `OPTIONS`, `TRACE`, `PATCH`, `COPY`<br>[Enum: ANY|GET|HEAD|POST|PUT|DELETE|CONNECT|OPTIONS|TRACE|PATCH|COPY] Method List. List of methods values to match against
251
+ <a id="deep-e1c30c"></a>Deeply nested **Method** block collapsed for readability.
262
252
 
263
253
  #### API Rate Limit API Endpoint Rules Client Matcher
264
254
 
265
- A [`client_matcher`](#matcher-794c7c) block (within [`api_rate_limit.api_endpoint_rules`](#api-rate-limit-api-endpoint-rules)) supports the following:
266
-
267
- <a id="client-dd4b14"></a>&#x2022; [`any_client`](#client-dd4b14) - Optional Block<br>Enable this option
268
-
269
- <a id="any-ip-2507e5"></a>&#x2022; [`any_ip`](#any-ip-2507e5) - Optional Block<br>Enable this option
270
-
271
- <a id="list-541161"></a>&#x2022; [`asn_list`](#list-541161) - Optional Block<br>ASN Match List. An 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-541161) below.
272
-
273
- <a id="matcher-cd99ef"></a>&#x2022; [`asn_matcher`](#matcher-cd99ef) - Optional Block<br>ASN Matcher. Match any AS number contained in the list of bgp_asn_sets<br>See [Asn Matcher](#matcher-cd99ef) below.
274
-
275
- <a id="selector-1b39eb"></a>&#x2022; [`client_selector`](#selector-1b39eb) - Optional Block<br>Label Selector. This 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. A null label selector matches no objects. Label selector is immutable. expressions is a list of strings of label selection expression. Each string has ',' separated values which are 'AND' and all strings are logically 'OR'. BNF for expression string `<selector-syntax>` ::= `<requirement>` | `<requirement>` ',' `<selector-syntax>` `<requirement>` ::= [!] KEY [ `<set-based-restriction>` | `<exact-match-restriction>` ] `<set-based-restriction>` ::= '' | `<inclusion-exclusion>` `<value-set>` `<inclusion-exclusion>` ::= `<inclusion>` | `<exclusion>` `<exclusion>` ::= 'notin' `<inclusion>` ::= 'in' `<value-set>` ::= '(' `<values>` ')' `<values>` ::= VALUE | VALUE ',' `<values>` `<exact-match-restriction>` ::= ['='|'=='|'!='] VALUE<br>See [Client Selector](#selector-1b39eb) below.
276
-
277
- <a id="matcher-2d1e1b"></a>&#x2022; [`ip_matcher`](#matcher-2d1e1b) - Optional Block<br>IP Prefix Matcher. 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-2d1e1b) below.
278
-
279
- <a id="list-19e2d7"></a>&#x2022; [`ip_prefix_list`](#list-19e2d7) - Optional Block<br>IP Prefix Match List. List of IP Prefix strings to match against<br>See [IP Prefix List](#list-19e2d7) below.
280
-
281
- <a id="list-d4ce55"></a>&#x2022; [`ip_threat_category_list`](#list-d4ce55) - Optional Block<br>IP Threat Category List Type. List of IP threat categories<br>See [IP Threat Category List](#list-d4ce55) below.
282
-
283
- <a id="matcher-ab7cce"></a>&#x2022; [`tls_fingerprint_matcher`](#matcher-ab7cce) - Optional Block<br>TLS Fingerprint Matcher. A 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 and the input fingerprint is not one of the excluded values<br>See [TLS Fingerprint Matcher](#matcher-ab7cce) below.
255
+ <a id="deep-89d214"></a>Deeply nested **Matcher** block collapsed for readability.
284
256
 
285
257
  #### API Rate Limit API Endpoint Rules Client Matcher Asn List
286
258
 
287
- An [`asn_list`](#list-541161) block (within [`api_rate_limit.api_endpoint_rules.client_matcher`](#matcher-794c7c)) supports the following:
288
-
289
- <a id="numbers-7bb86e"></a>&#x2022; [`as_numbers`](#numbers-7bb86e) - Optional List<br>AS Numbers. An 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
259
+ <a id="deep-5b26f9"></a>Deeply nested **List** block collapsed for readability.
290
260
 
291
261
  #### API Rate Limit API Endpoint Rules Client Matcher Asn Matcher
292
262
 
293
- An [`asn_matcher`](#matcher-cd99ef) block (within [`api_rate_limit.api_endpoint_rules.client_matcher`](#matcher-794c7c)) supports the following:
294
-
295
- <a id="sets-d85457"></a>&#x2022; [`asn_sets`](#sets-d85457) - Optional Block<br>BGP ASN Sets. A list of references to bgp_asn_set objects<br>See [Asn Sets](#sets-d85457) below.
263
+ <a id="deep-fb456a"></a>Deeply nested **Matcher** block collapsed for readability.
296
264
 
297
265
  #### API Rate Limit API Endpoint Rules Client Matcher Asn Matcher Asn Sets
298
266
 
299
- An [`asn_sets`](#sets-d85457) block (within [`api_rate_limit.api_endpoint_rules.client_matcher.asn_matcher`](#matcher-cd99ef)) supports the following:
300
-
301
- <a id="kind-d515ee"></a>&#x2022; [`kind`](#kind-d515ee) - Optional String<br>Kind. When a configuration object(e.g. virtual_host) refers to another(e.g route) then kind will hold the referred object's kind (e.g. 'route')
302
-
303
- <a id="name-8f5645"></a>&#x2022; [`name`](#name-8f5645) - Optional String<br>Name. 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
304
-
305
- <a id="namespace-e278b9"></a>&#x2022; [`namespace`](#namespace-e278b9) - Optional String<br>Namespace. 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
306
-
307
- <a id="tenant-e59381"></a>&#x2022; [`tenant`](#tenant-e59381) - Optional String<br>Tenant. 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
308
-
309
- <a id="uid-3ba47f"></a>&#x2022; [`uid`](#uid-3ba47f) - Optional String<br>UID. When a configuration object(e.g. virtual_host) refers to another(e.g route) then uid will hold the referred object's(e.g. route's) uid
267
+ <a id="deep-5b15e9"></a>Deeply nested **Sets** block collapsed for readability.
310
268
 
311
269
  #### API Rate Limit API Endpoint Rules Client Matcher Client Selector
312
270
 
313
- A [`client_selector`](#selector-1b39eb) block (within [`api_rate_limit.api_endpoint_rules.client_matcher`](#matcher-794c7c)) supports the following:
314
-
315
- <a id="expressions-f101e1"></a>&#x2022; [`expressions`](#expressions-f101e1) - Optional List<br>Selector Expression. expressions contains the kubernetes style label expression for selections
271
+ <a id="deep-2d36e2"></a>Deeply nested **Selector** block collapsed for readability.
316
272
 
317
273
  #### API Rate Limit API Endpoint Rules Client Matcher IP Matcher
318
274
 
319
- An [`ip_matcher`](#matcher-2d1e1b) block (within [`api_rate_limit.api_endpoint_rules.client_matcher`](#matcher-794c7c)) supports the following:
320
-
321
- <a id="matcher-91fa13"></a>&#x2022; [`invert_matcher`](#matcher-91fa13) - Optional Bool<br>Invert IP Matcher. Invert the match result
322
-
323
- <a id="sets-cb5183"></a>&#x2022; [`prefix_sets`](#sets-cb5183) - Optional Block<br>IP Prefix Sets. A list of references to ip_prefix_set objects<br>See [Prefix Sets](#sets-cb5183) below.
275
+ <a id="deep-c0f678"></a>Deeply nested **Matcher** block collapsed for readability.
324
276
 
325
277
  #### API Rate Limit API Endpoint Rules Client Matcher IP Matcher Prefix Sets
326
278
 
327
- A [`prefix_sets`](#sets-cb5183) block (within [`api_rate_limit.api_endpoint_rules.client_matcher.ip_matcher`](#matcher-2d1e1b)) supports the following:
328
-
329
- <a id="kind-ccd934"></a>&#x2022; [`kind`](#kind-ccd934) - Optional String<br>Kind. When a configuration object(e.g. virtual_host) refers to another(e.g route) then kind will hold the referred object's kind (e.g. 'route')
330
-
331
- <a id="name-19bb1b"></a>&#x2022; [`name`](#name-19bb1b) - Optional String<br>Name. 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
332
-
333
- <a id="namespace-c8c75b"></a>&#x2022; [`namespace`](#namespace-c8c75b) - Optional String<br>Namespace. 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
334
-
335
- <a id="tenant-f57c6e"></a>&#x2022; [`tenant`](#tenant-f57c6e) - Optional String<br>Tenant. 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
336
-
337
- <a id="uid-97a716"></a>&#x2022; [`uid`](#uid-97a716) - Optional String<br>UID. When a configuration object(e.g. virtual_host) refers to another(e.g route) then uid will hold the referred object's(e.g. route's) uid
279
+ <a id="deep-70b0c0"></a>Deeply nested **Sets** block collapsed for readability.
338
280
 
339
281
  #### API Rate Limit API Endpoint Rules Client Matcher IP Prefix List
340
282
 
341
- An [`ip_prefix_list`](#list-19e2d7) block (within [`api_rate_limit.api_endpoint_rules.client_matcher`](#matcher-794c7c)) supports the following:
342
-
343
- <a id="match-169cde"></a>&#x2022; [`invert_match`](#match-169cde) - Optional Bool<br>Invert Match Result. Invert the match result
344
-
345
- <a id="prefixes-c54632"></a>&#x2022; [`ip_prefixes`](#prefixes-c54632) - Optional List<br>IPv4 Prefix List. List of IPv4 prefix strings
283
+ <a id="deep-5a2c8c"></a>Deeply nested **List** block collapsed for readability.
346
284
 
347
285
  #### API Rate Limit API Endpoint Rules Client Matcher IP Threat Category List
348
286
 
349
- An [`ip_threat_category_list`](#list-d4ce55) block (within [`api_rate_limit.api_endpoint_rules.client_matcher`](#matcher-794c7c)) supports the following:
350
-
351
- <a id="categories-33fa18"></a>&#x2022; [`ip_threat_categories`](#categories-33fa18) - Optional List Defaults to `SPAM_SOURCES`<br>Possible values are `SPAM_SOURCES`, `WINDOWS_EXPLOITS`, `WEB_ATTACKS`, `BOTNETS`, `SCANNERS`, `REPUTATION`, `PHISHING`, `PROXY`, `MOBILE_THREATS`, `TOR_PROXY`, `DENIAL_OF_SERVICE`, `NETWORK`<br>[Enum: SPAM_SOURCES|WINDOWS_EXPLOITS|WEB_ATTACKS|BOTNETS|SCANNERS|REPUTATION|PHISHING|PROXY|MOBILE_THREATS|TOR_PROXY|DENIAL_OF_SERVICE|NETWORK] List of IP Threat Categories to choose. The IP threat categories is obtained from the list and is used to auto-generate equivalent label selection expressions
287
+ <a id="deep-67d5ee"></a>Deeply nested **List** block collapsed for readability.
352
288
 
353
289
  #### API Rate Limit API Endpoint Rules Client Matcher TLS Fingerprint Matcher
354
290
 
355
- A [`tls_fingerprint_matcher`](#matcher-ab7cce) block (within [`api_rate_limit.api_endpoint_rules.client_matcher`](#matcher-794c7c)) supports the following:
356
-
357
- <a id="classes-fe5ffc"></a>&#x2022; [`classes`](#classes-fe5ffc) - Optional List Defaults to `TLS_FINGERPRINT_NONE`<br>Possible values are `TLS_FINGERPRINT_NONE`, `ANY_MALICIOUS_FINGERPRINT`, `ADWARE`, `ADWIND`, `DRIDEX`, `GOOTKIT`, `GOZI`, `JBIFROST`, `QUAKBOT`, `RANSOMWARE`, `TROLDESH`, `TOFSEE`, `TORRENTLOCKER`, `TRICKBOT`<br>[Enum: TLS_FINGERPRINT_NONE|ANY_MALICIOUS_FINGERPRINT|ADWARE|ADWIND|DRIDEX|GOOTKIT|GOZI|JBIFROST|QUAKBOT|RANSOMWARE|TROLDESH|TOFSEE|TORRENTLOCKER|TRICKBOT] TLS fingerprint classes. A list of known classes of TLS fingerprints to match the input TLS JA3 fingerprint against
358
-
359
- <a id="values-442dc5"></a>&#x2022; [`exact_values`](#values-442dc5) - Optional List<br>Exact Values. A list of exact TLS JA3 fingerprints to match the input TLS JA3 fingerprint against
360
-
361
- <a id="values-ea7eff"></a>&#x2022; [`excluded_values`](#values-ea7eff) - Optional List<br>Excluded Values. A list of TLS JA3 fingerprints to be excluded when matching the input TLS JA3 fingerprint. This can be used to skip known false positives when using one or more known TLS fingerprint classes in the enclosing matcher
291
+ <a id="deep-09252e"></a>Deeply nested **Matcher** block collapsed for readability.
362
292
 
363
293
  #### API Rate Limit API Endpoint Rules Inline Rate Limiter
364
294
 
365
- An [`inline_rate_limiter`](#limiter-38a124) block (within [`api_rate_limit.api_endpoint_rules`](#api-rate-limit-api-endpoint-rules)) supports the following:
366
-
367
- <a id="user-id-48be18"></a>&#x2022; [`ref_user_id`](#user-id-48be18) - Optional Block<br>Object reference. This 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 User ID](#user-id-48be18) below.
368
-
369
- <a id="threshold-e13d5c"></a>&#x2022; [`threshold`](#threshold-e13d5c) - Optional Number<br>Threshold. The total number of allowed requests for 1 unit (e.g. SECOND/MINUTE/HOUR etc.) of the specified period
370
-
371
- <a id="unit-4402df"></a>&#x2022; [`unit`](#unit-4402df) - Optional String Defaults to `SECOND`<br>Possible values are `SECOND`, `MINUTE`, `HOUR`<br>[Enum: SECOND|MINUTE|HOUR] Rate Limit Period Unit. 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
372
-
373
- <a id="user-id-ddc28d"></a>&#x2022; [`use_http_lb_user_id`](#user-id-ddc28d) - Optional Block<br>Enable this option
295
+ <a id="deep-5cd429"></a>Deeply nested **Limiter** block collapsed for readability.
374
296
 
375
297
  #### API Rate Limit API Endpoint Rules Inline Rate Limiter Ref User ID
376
298
 
377
- A [`ref_user_id`](#user-id-48be18) block (within [`api_rate_limit.api_endpoint_rules.inline_rate_limiter`](#limiter-38a124)) supports the following:
378
-
379
- <a id="name-44d974"></a>&#x2022; [`name`](#name-44d974) - Optional String<br>Name. 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
380
-
381
- <a id="namespace-7c0a17"></a>&#x2022; [`namespace`](#namespace-7c0a17) - Optional String<br>Namespace. 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
382
-
383
- <a id="tenant-568dd6"></a>&#x2022; [`tenant`](#tenant-568dd6) - Optional String<br>Tenant. 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
299
+ <a id="deep-70ee5d"></a>Deeply nested **ID** block collapsed for readability.
384
300
 
385
301
  #### API Rate Limit API Endpoint Rules Ref Rate Limiter
386
302
 
387
- A [`ref_rate_limiter`](#limiter-f23897) block (within [`api_rate_limit.api_endpoint_rules`](#api-rate-limit-api-endpoint-rules)) supports the following:
388
-
389
- <a id="name-feb57b"></a>&#x2022; [`name`](#name-feb57b) - Optional String<br>Name. 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
390
-
391
- <a id="namespace-8702e9"></a>&#x2022; [`namespace`](#namespace-8702e9) - Optional String<br>Namespace. 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
392
-
393
- <a id="tenant-93c30b"></a>&#x2022; [`tenant`](#tenant-93c30b) - Optional String<br>Tenant. 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
303
+ <a id="deep-1175ac"></a>Deeply nested **Limiter** block collapsed for readability.
394
304
 
395
305
  #### API Rate Limit API Endpoint Rules Request Matcher
396
306
 
397
- A [`request_matcher`](#matcher-869fa1) block (within [`api_rate_limit.api_endpoint_rules`](#api-rate-limit-api-endpoint-rules)) supports the following:
398
-
399
- <a id="matchers-77386d"></a>&#x2022; [`cookie_matchers`](#matchers-77386d) - Optional Block<br>Cookie Matchers. A 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. Note that all specified cookie matcher predicates must evaluate to true<br>See [Cookie Matchers](#matchers-77386d) below.
400
-
401
- <a id="headers-4b4f60"></a>&#x2022; [`headers`](#headers-4b4f60) - Optional Block<br>HTTP Headers. A 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. Note that all specified header predicates must evaluate to true<br>See [Headers](#headers-4b4f60) below.
402
-
403
- <a id="claims-eecbd4"></a>&#x2022; [`jwt_claims`](#claims-eecbd4) - Optional Block<br>JWT Claims. A list of predicates for various JWT claims that need to match. The criteria for matching each JWT claim are described in individual JWTClaimMatcherType instances. The actual JWT claims values are extracted from the JWT payload as a list of strings. Note that all specified JWT claim predicates must evaluate to true. Note that this feature only works on LBs with JWT Validation feature enabled<br>See [JWT Claims](#claims-eecbd4) below.
404
-
405
- <a id="params-153b4d"></a>&#x2022; [`query_params`](#params-153b4d) - Optional Block<br>HTTP Query Parameters. A 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 parameter name. Note that all specified query parameter predicates must evaluate to true<br>See [Query Params](#params-153b4d) below.
307
+ <a id="deep-b66b99"></a>Deeply nested **Matcher** block collapsed for readability.
406
308
 
407
309
  #### API Rate Limit API Endpoint Rules Request Matcher Cookie Matchers
408
310
 
409
- A [`cookie_matchers`](#matchers-77386d) block (within [`api_rate_limit.api_endpoint_rules.request_matcher`](#matcher-869fa1)) supports the following:
410
-
411
- <a id="present-50637d"></a>&#x2022; [`check_not_present`](#present-50637d) - Optional Block<br>Enable this option
412
-
413
- <a id="present-334dd3"></a>&#x2022; [`check_present`](#present-334dd3) - Optional Block<br>Enable this option
414
-
415
- <a id="matcher-3e072a"></a>&#x2022; [`invert_matcher`](#matcher-3e072a) - Optional Bool<br>Invert Matcher. Invert Match of the expression defined
416
-
417
- <a id="item-8fd79b"></a>&#x2022; [`item`](#item-8fd79b) - Optional Block<br>Matcher. A 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-8fd79b) below.
418
-
419
- <a id="name-0761c7"></a>&#x2022; [`name`](#name-0761c7) - Optional String<br>Cookie Name. A case-sensitive cookie name
311
+ <a id="deep-137e54"></a>Deeply nested **Matchers** block collapsed for readability.
420
312
 
421
313
  #### API Rate Limit API Endpoint Rules Request Matcher Cookie Matchers Item
422
314
 
423
- An [`item`](#item-8fd79b) block (within [`api_rate_limit.api_endpoint_rules.request_matcher.cookie_matchers`](#matchers-77386d)) supports the following:
424
-
425
- <a id="values-da29fa"></a>&#x2022; [`exact_values`](#values-da29fa) - Optional List<br>Exact Values. A list of exact values to match the input against
426
-
427
- <a id="values-cd25b5"></a>&#x2022; [`regex_values`](#values-cd25b5) - Optional List<br>Regex Values. A list of regular expressions to match the input against
428
-
429
- <a id="transformers-8d7fe4"></a>&#x2022; [`transformers`](#transformers-8d7fe4) - Optional List Defaults to `TRANSFORMER_NONE`<br>Possible values are `LOWER_CASE`, `UPPER_CASE`, `BASE64_DECODE`, `NORMALIZE_PATH`, `REMOVE_WHITESPACE`, `URL_DECODE`, `TRIM_LEFT`, `TRIM_RIGHT`, `TRIM`<br>[Enum: LOWER_CASE|UPPER_CASE|BASE64_DECODE|NORMALIZE_PATH|REMOVE_WHITESPACE|URL_DECODE|TRIM_LEFT|TRIM_RIGHT|TRIM] Transformers. An ordered list of transformers (starting from index 0) to be applied to the path before matching
315
+ <a id="deep-b2970b"></a>Deeply nested **Item** block collapsed for readability.
430
316
 
431
317
  #### API Rate Limit API Endpoint Rules Request Matcher Headers
432
318
 
433
- A [`headers`](#headers-4b4f60) block (within [`api_rate_limit.api_endpoint_rules.request_matcher`](#matcher-869fa1)) supports the following:
434
-
435
- <a id="present-4ee0a5"></a>&#x2022; [`check_not_present`](#present-4ee0a5) - Optional Block<br>Enable this option
436
-
437
- <a id="present-a33cbd"></a>&#x2022; [`check_present`](#present-a33cbd) - Optional Block<br>Enable this option
438
-
439
- <a id="matcher-633667"></a>&#x2022; [`invert_matcher`](#matcher-633667) - Optional Bool<br>Invert Header Matcher. Invert the match result
440
-
441
- <a id="item-ad545a"></a>&#x2022; [`item`](#item-ad545a) - Optional Block<br>Matcher. A 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-ad545a) below.
442
-
443
- <a id="name-9984d9"></a>&#x2022; [`name`](#name-9984d9) - Optional String<br>Header Name. A case-insensitive HTTP header name
319
+ <a id="deep-78dc03"></a>Deeply nested **Headers** block collapsed for readability.
444
320
 
445
321
  #### API Rate Limit API Endpoint Rules Request Matcher Headers Item
446
322
 
447
- An [`item`](#item-ad545a) block (within [`api_rate_limit.api_endpoint_rules.request_matcher.headers`](#headers-4b4f60)) supports the following:
448
-
449
- <a id="values-637456"></a>&#x2022; [`exact_values`](#values-637456) - Optional List<br>Exact Values. A list of exact values to match the input against
450
-
451
- <a id="values-2c77df"></a>&#x2022; [`regex_values`](#values-2c77df) - Optional List<br>Regex Values. A list of regular expressions to match the input against
452
-
453
- <a id="transformers-c3442a"></a>&#x2022; [`transformers`](#transformers-c3442a) - Optional List Defaults to `TRANSFORMER_NONE`<br>Possible values are `LOWER_CASE`, `UPPER_CASE`, `BASE64_DECODE`, `NORMALIZE_PATH`, `REMOVE_WHITESPACE`, `URL_DECODE`, `TRIM_LEFT`, `TRIM_RIGHT`, `TRIM`<br>[Enum: LOWER_CASE|UPPER_CASE|BASE64_DECODE|NORMALIZE_PATH|REMOVE_WHITESPACE|URL_DECODE|TRIM_LEFT|TRIM_RIGHT|TRIM] Transformers. An ordered list of transformers (starting from index 0) to be applied to the path before matching
323
+ <a id="deep-a29608"></a>Deeply nested **Item** block collapsed for readability.
454
324
 
455
325
  #### API Rate Limit API Endpoint Rules Request Matcher JWT Claims
456
326
 
457
- A [`jwt_claims`](#claims-eecbd4) block (within [`api_rate_limit.api_endpoint_rules.request_matcher`](#matcher-869fa1)) supports the following:
458
-
459
- <a id="present-935ed5"></a>&#x2022; [`check_not_present`](#present-935ed5) - Optional Block<br>Enable this option
460
-
461
- <a id="present-fcd929"></a>&#x2022; [`check_present`](#present-fcd929) - Optional Block<br>Enable this option
462
-
463
- <a id="matcher-cd173e"></a>&#x2022; [`invert_matcher`](#matcher-cd173e) - Optional Bool<br>Invert Matcher. Invert the match result
464
-
465
- <a id="item-69e131"></a>&#x2022; [`item`](#item-69e131) - Optional Block<br>Matcher. A 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-69e131) below.
466
-
467
- <a id="name-b37439"></a>&#x2022; [`name`](#name-b37439) - Optional String<br>JWT Claim Name. JWT claim name
327
+ <a id="deep-01f53c"></a>Deeply nested **Claims** block collapsed for readability.
468
328
 
469
329
  #### API Rate Limit API Endpoint Rules Request Matcher JWT Claims Item
470
330
 
471
- An [`item`](#item-69e131) block (within [`api_rate_limit.api_endpoint_rules.request_matcher.jwt_claims`](#claims-eecbd4)) supports the following:
472
-
473
- <a id="values-959e73"></a>&#x2022; [`exact_values`](#values-959e73) - Optional List<br>Exact Values. A list of exact values to match the input against
474
-
475
- <a id="values-e5f104"></a>&#x2022; [`regex_values`](#values-e5f104) - Optional List<br>Regex Values. A list of regular expressions to match the input against
476
-
477
- <a id="transformers-cedd59"></a>&#x2022; [`transformers`](#transformers-cedd59) - Optional List Defaults to `TRANSFORMER_NONE`<br>Possible values are `LOWER_CASE`, `UPPER_CASE`, `BASE64_DECODE`, `NORMALIZE_PATH`, `REMOVE_WHITESPACE`, `URL_DECODE`, `TRIM_LEFT`, `TRIM_RIGHT`, `TRIM`<br>[Enum: LOWER_CASE|UPPER_CASE|BASE64_DECODE|NORMALIZE_PATH|REMOVE_WHITESPACE|URL_DECODE|TRIM_LEFT|TRIM_RIGHT|TRIM] Transformers. An ordered list of transformers (starting from index 0) to be applied to the path before matching
331
+ <a id="deep-1ae8a7"></a>Deeply nested **Item** block collapsed for readability.
478
332
 
479
333
  #### API Rate Limit API Endpoint Rules Request Matcher Query Params
480
334
 
481
- A [`query_params`](#params-153b4d) block (within [`api_rate_limit.api_endpoint_rules.request_matcher`](#matcher-869fa1)) supports the following:
482
-
483
- <a id="present-6edbea"></a>&#x2022; [`check_not_present`](#present-6edbea) - Optional Block<br>Enable this option
484
-
485
- <a id="present-1cdabc"></a>&#x2022; [`check_present`](#present-1cdabc) - Optional Block<br>Enable this option
486
-
487
- <a id="matcher-c07a30"></a>&#x2022; [`invert_matcher`](#matcher-c07a30) - Optional Bool<br>Invert Query Parameter Matcher. Invert the match result
488
-
489
- <a id="item-b0554c"></a>&#x2022; [`item`](#item-b0554c) - Optional Block<br>Matcher. A 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-b0554c) below.
490
-
491
- <a id="key-c4c42f"></a>&#x2022; [`key`](#key-c4c42f) - Optional String<br>Query Parameter Name. A case-sensitive HTTP query parameter name
335
+ <a id="deep-bb70f4"></a>Deeply nested **Params** block collapsed for readability.
492
336
 
493
337
  #### API Rate Limit API Endpoint Rules Request Matcher Query Params Item
494
338
 
495
- An [`item`](#item-b0554c) block (within [`api_rate_limit.api_endpoint_rules.request_matcher.query_params`](#params-153b4d)) supports the following:
496
-
497
- <a id="values-36f490"></a>&#x2022; [`exact_values`](#values-36f490) - Optional List<br>Exact Values. A list of exact values to match the input against
498
-
499
- <a id="values-6e357a"></a>&#x2022; [`regex_values`](#values-6e357a) - Optional List<br>Regex Values. A list of regular expressions to match the input against
500
-
501
- <a id="transformers-03d03b"></a>&#x2022; [`transformers`](#transformers-03d03b) - Optional List Defaults to `TRANSFORMER_NONE`<br>Possible values are `LOWER_CASE`, `UPPER_CASE`, `BASE64_DECODE`, `NORMALIZE_PATH`, `REMOVE_WHITESPACE`, `URL_DECODE`, `TRIM_LEFT`, `TRIM_RIGHT`, `TRIM`<br>[Enum: LOWER_CASE|UPPER_CASE|BASE64_DECODE|NORMALIZE_PATH|REMOVE_WHITESPACE|URL_DECODE|TRIM_LEFT|TRIM_RIGHT|TRIM] Transformers. An ordered list of transformers (starting from index 0) to be applied to the path before matching
339
+ <a id="deep-8ff910"></a>Deeply nested **Item** block collapsed for readability.
502
340
 
503
341
  #### API Rate Limit Bypass Rate Limiting Rules
504
342
 
@@ -508,245 +346,91 @@ A [`bypass_rate_limiting_rules`](#rules-776e97) block (within [`api_rate_limit`]
508
346
 
509
347
  #### API Rate Limit Bypass Rate Limiting Rules Bypass Rate Limiting Rules
510
348
 
511
- A [`bypass_rate_limiting_rules`](#rules-51aa34) block (within [`api_rate_limit.bypass_rate_limiting_rules`](#rules-776e97)) supports the following:
512
-
513
- <a id="domain-0985ea"></a>&#x2022; [`any_domain`](#domain-0985ea) - Optional Block<br>Enable this option
514
-
515
- <a id="url-7b53df"></a>&#x2022; [`any_url`](#url-7b53df) - Optional Block<br>Enable this option
516
-
517
- <a id="endpoint-e28aa4"></a>&#x2022; [`api_endpoint`](#endpoint-e28aa4) - Optional Block<br>API Endpoint. This defines API endpoint<br>See [API Endpoint](#endpoint-e28aa4) below.
518
-
519
- <a id="groups-c92822"></a>&#x2022; [`api_groups`](#groups-c92822) - Optional Block<br>API Groups<br>See [API Groups](#groups-c92822) below.
520
-
521
- <a id="path-b16510"></a>&#x2022; [`base_path`](#path-b16510) - Optional String<br>Base Path. The base path which this validation applies to
522
-
523
- <a id="matcher-a9da18"></a>&#x2022; [`client_matcher`](#matcher-a9da18) - Optional Block<br>Client Matcher. Client conditions for matching a rule<br>See [Client Matcher](#matcher-a9da18) below.
524
-
525
- <a id="matcher-e9bb4d"></a>&#x2022; [`request_matcher`](#matcher-e9bb4d) - Optional Block<br>Request Matcher. Request conditions for matching a rule<br>See [Request Matcher](#matcher-e9bb4d) below.
526
-
527
- <a id="domain-451df1"></a>&#x2022; [`specific_domain`](#domain-451df1) - Optional String<br>Specific Domain. The rule will apply for a specific domain. For example: API.example.com
349
+ <a id="deep-057f78"></a>Deeply nested **Rules** block collapsed for readability.
528
350
 
529
351
  #### API Rate Limit Bypass Rate Limiting Rules Bypass Rate Limiting Rules API Endpoint
530
352
 
531
- An [`api_endpoint`](#endpoint-e28aa4) block (within [`api_rate_limit.bypass_rate_limiting_rules.bypass_rate_limiting_rules`](#rules-51aa34)) supports the following:
532
-
533
- <a id="methods-2f7610"></a>&#x2022; [`methods`](#methods-2f7610) - Optional List Defaults to `ANY`<br>Possible values are `ANY`, `GET`, `HEAD`, `POST`, `PUT`, `DELETE`, `CONNECT`, `OPTIONS`, `TRACE`, `PATCH`, `COPY`<br>[Enum: ANY|GET|HEAD|POST|PUT|DELETE|CONNECT|OPTIONS|TRACE|PATCH|COPY] Methods. Methods to be matched
534
-
535
- <a id="path-79e5a9"></a>&#x2022; [`path`](#path-79e5a9) - Optional String<br>Path. Path to be matched
353
+ <a id="deep-64f716"></a>Deeply nested **Endpoint** block collapsed for readability.
536
354
 
537
355
  #### API Rate Limit Bypass Rate Limiting Rules Bypass Rate Limiting Rules API Groups
538
356
 
539
- An [`api_groups`](#groups-c92822) block (within [`api_rate_limit.bypass_rate_limiting_rules.bypass_rate_limiting_rules`](#rules-51aa34)) supports the following:
540
-
541
- <a id="groups-56ebad"></a>&#x2022; [`api_groups`](#groups-56ebad) - Optional List<br>API Groups
357
+ <a id="deep-fc711c"></a>Deeply nested **Groups** block collapsed for readability.
542
358
 
543
359
  #### API Rate Limit Bypass Rate Limiting Rules Bypass Rate Limiting Rules Client Matcher
544
360
 
545
- A [`client_matcher`](#matcher-a9da18) block (within [`api_rate_limit.bypass_rate_limiting_rules.bypass_rate_limiting_rules`](#rules-51aa34)) supports the following:
546
-
547
- <a id="client-10be2f"></a>&#x2022; [`any_client`](#client-10be2f) - Optional Block<br>Enable this option
548
-
549
- <a id="any-ip-7c4970"></a>&#x2022; [`any_ip`](#any-ip-7c4970) - Optional Block<br>Enable this option
550
-
551
- <a id="list-221e4b"></a>&#x2022; [`asn_list`](#list-221e4b) - Optional Block<br>ASN Match List. An 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-221e4b) below.
552
-
553
- <a id="matcher-d64a47"></a>&#x2022; [`asn_matcher`](#matcher-d64a47) - Optional Block<br>ASN Matcher. Match any AS number contained in the list of bgp_asn_sets<br>See [Asn Matcher](#matcher-d64a47) below.
554
-
555
- <a id="selector-8bcea5"></a>&#x2022; [`client_selector`](#selector-8bcea5) - Optional Block<br>Label Selector. This 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. A null label selector matches no objects. Label selector is immutable. expressions is a list of strings of label selection expression. Each string has ',' separated values which are 'AND' and all strings are logically 'OR'. BNF for expression string `<selector-syntax>` ::= `<requirement>` | `<requirement>` ',' `<selector-syntax>` `<requirement>` ::= [!] KEY [ `<set-based-restriction>` | `<exact-match-restriction>` ] `<set-based-restriction>` ::= '' | `<inclusion-exclusion>` `<value-set>` `<inclusion-exclusion>` ::= `<inclusion>` | `<exclusion>` `<exclusion>` ::= 'notin' `<inclusion>` ::= 'in' `<value-set>` ::= '(' `<values>` ')' `<values>` ::= VALUE | VALUE ',' `<values>` `<exact-match-restriction>` ::= ['='|'=='|'!='] VALUE<br>See [Client Selector](#selector-8bcea5) below.
556
-
557
- <a id="matcher-273263"></a>&#x2022; [`ip_matcher`](#matcher-273263) - Optional Block<br>IP Prefix Matcher. 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-273263) below.
558
-
559
- <a id="list-3ef91d"></a>&#x2022; [`ip_prefix_list`](#list-3ef91d) - Optional Block<br>IP Prefix Match List. List of IP Prefix strings to match against<br>See [IP Prefix List](#list-3ef91d) below.
560
-
561
- <a id="list-94743d"></a>&#x2022; [`ip_threat_category_list`](#list-94743d) - Optional Block<br>IP Threat Category List Type. List of IP threat categories<br>See [IP Threat Category List](#list-94743d) below.
562
-
563
- <a id="matcher-c87ce2"></a>&#x2022; [`tls_fingerprint_matcher`](#matcher-c87ce2) - Optional Block<br>TLS Fingerprint Matcher. A 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 and the input fingerprint is not one of the excluded values<br>See [TLS Fingerprint Matcher](#matcher-c87ce2) below.
361
+ <a id="deep-ffaf3a"></a>Deeply nested **Matcher** block collapsed for readability.
564
362
 
565
363
  #### API Rate Limit Bypass Rate Limiting Rules Bypass Rate Limiting Rules Client Matcher Asn List
566
364
 
567
- An [`asn_list`](#list-221e4b) block (within [`api_rate_limit.bypass_rate_limiting_rules.bypass_rate_limiting_rules.client_matcher`](#matcher-a9da18)) supports the following:
568
-
569
- <a id="numbers-9c8ce1"></a>&#x2022; [`as_numbers`](#numbers-9c8ce1) - Optional List<br>AS Numbers. An 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
365
+ <a id="deep-242661"></a>Deeply nested **List** block collapsed for readability.
570
366
 
571
367
  #### API Rate Limit Bypass Rate Limiting Rules Bypass Rate Limiting Rules Client Matcher Asn Matcher
572
368
 
573
- An [`asn_matcher`](#matcher-d64a47) block (within [`api_rate_limit.bypass_rate_limiting_rules.bypass_rate_limiting_rules.client_matcher`](#matcher-a9da18)) supports the following:
574
-
575
- <a id="sets-489c65"></a>&#x2022; [`asn_sets`](#sets-489c65) - Optional Block<br>BGP ASN Sets. A list of references to bgp_asn_set objects<br>See [Asn Sets](#sets-489c65) below.
369
+ <a id="deep-d519c0"></a>Deeply nested **Matcher** block collapsed for readability.
576
370
 
577
371
  #### API Rate Limit Bypass Rate Limiting Rules Bypass Rate Limiting Rules Client Matcher Asn Matcher Asn Sets
578
372
 
579
- An [`asn_sets`](#sets-489c65) block (within [`api_rate_limit.bypass_rate_limiting_rules.bypass_rate_limiting_rules.client_matcher.asn_matcher`](#matcher-d64a47)) supports the following:
580
-
581
- <a id="kind-cf32d0"></a>&#x2022; [`kind`](#kind-cf32d0) - Optional String<br>Kind. When a configuration object(e.g. virtual_host) refers to another(e.g route) then kind will hold the referred object's kind (e.g. 'route')
582
-
583
- <a id="name-3a9c74"></a>&#x2022; [`name`](#name-3a9c74) - Optional String<br>Name. 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
584
-
585
- <a id="namespace-d9cfc4"></a>&#x2022; [`namespace`](#namespace-d9cfc4) - Optional String<br>Namespace. 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
586
-
587
- <a id="tenant-c5db47"></a>&#x2022; [`tenant`](#tenant-c5db47) - Optional String<br>Tenant. 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
588
-
589
- <a id="uid-d6cdd9"></a>&#x2022; [`uid`](#uid-d6cdd9) - Optional String<br>UID. When a configuration object(e.g. virtual_host) refers to another(e.g route) then uid will hold the referred object's(e.g. route's) uid
373
+ <a id="deep-30e257"></a>Deeply nested **Sets** block collapsed for readability.
590
374
 
591
375
  #### API Rate Limit Bypass Rate Limiting Rules Bypass Rate Limiting Rules Client Matcher Client Selector
592
376
 
593
- A [`client_selector`](#selector-8bcea5) block (within [`api_rate_limit.bypass_rate_limiting_rules.bypass_rate_limiting_rules.client_matcher`](#matcher-a9da18)) supports the following:
594
-
595
- <a id="expressions-e48729"></a>&#x2022; [`expressions`](#expressions-e48729) - Optional List<br>Selector Expression. expressions contains the kubernetes style label expression for selections
377
+ <a id="deep-4a08b6"></a>Deeply nested **Selector** block collapsed for readability.
596
378
 
597
379
  #### API Rate Limit Bypass Rate Limiting Rules Bypass Rate Limiting Rules Client Matcher IP Matcher
598
380
 
599
- An [`ip_matcher`](#matcher-273263) block (within [`api_rate_limit.bypass_rate_limiting_rules.bypass_rate_limiting_rules.client_matcher`](#matcher-a9da18)) supports the following:
600
-
601
- <a id="matcher-939f7d"></a>&#x2022; [`invert_matcher`](#matcher-939f7d) - Optional Bool<br>Invert IP Matcher. Invert the match result
602
-
603
- <a id="sets-377781"></a>&#x2022; [`prefix_sets`](#sets-377781) - Optional Block<br>IP Prefix Sets. A list of references to ip_prefix_set objects<br>See [Prefix Sets](#sets-377781) below.
381
+ <a id="deep-16bba4"></a>Deeply nested **Matcher** block collapsed for readability.
604
382
 
605
383
  #### API Rate Limit Bypass Rate Limiting Rules Bypass Rate Limiting Rules Client Matcher IP Matcher Prefix Sets
606
384
 
607
- A [`prefix_sets`](#sets-377781) block (within [`api_rate_limit.bypass_rate_limiting_rules.bypass_rate_limiting_rules.client_matcher.ip_matcher`](#matcher-273263)) supports the following:
608
-
609
- <a id="kind-566b63"></a>&#x2022; [`kind`](#kind-566b63) - Optional String<br>Kind. When a configuration object(e.g. virtual_host) refers to another(e.g route) then kind will hold the referred object's kind (e.g. 'route')
610
-
611
- <a id="name-80111f"></a>&#x2022; [`name`](#name-80111f) - Optional String<br>Name. 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
612
-
613
- <a id="namespace-39558d"></a>&#x2022; [`namespace`](#namespace-39558d) - Optional String<br>Namespace. 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
614
-
615
- <a id="tenant-80e0d0"></a>&#x2022; [`tenant`](#tenant-80e0d0) - Optional String<br>Tenant. 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
616
-
617
- <a id="uid-232063"></a>&#x2022; [`uid`](#uid-232063) - Optional String<br>UID. When a configuration object(e.g. virtual_host) refers to another(e.g route) then uid will hold the referred object's(e.g. route's) uid
385
+ <a id="deep-da95b1"></a>Deeply nested **Sets** block collapsed for readability.
618
386
 
619
387
  #### API Rate Limit Bypass Rate Limiting Rules Bypass Rate Limiting Rules Client Matcher IP Prefix List
620
388
 
621
- An [`ip_prefix_list`](#list-3ef91d) block (within [`api_rate_limit.bypass_rate_limiting_rules.bypass_rate_limiting_rules.client_matcher`](#matcher-a9da18)) supports the following:
622
-
623
- <a id="match-710e3e"></a>&#x2022; [`invert_match`](#match-710e3e) - Optional Bool<br>Invert Match Result. Invert the match result
624
-
625
- <a id="prefixes-fe1028"></a>&#x2022; [`ip_prefixes`](#prefixes-fe1028) - Optional List<br>IPv4 Prefix List. List of IPv4 prefix strings
389
+ <a id="deep-60dc79"></a>Deeply nested **List** block collapsed for readability.
626
390
 
627
391
  #### API Rate Limit Bypass Rate Limiting Rules Bypass Rate Limiting Rules Client Matcher IP Threat Category List
628
392
 
629
- An [`ip_threat_category_list`](#list-94743d) block (within [`api_rate_limit.bypass_rate_limiting_rules.bypass_rate_limiting_rules.client_matcher`](#matcher-a9da18)) supports the following:
630
-
631
- <a id="categories-abf09a"></a>&#x2022; [`ip_threat_categories`](#categories-abf09a) - Optional List Defaults to `SPAM_SOURCES`<br>Possible values are `SPAM_SOURCES`, `WINDOWS_EXPLOITS`, `WEB_ATTACKS`, `BOTNETS`, `SCANNERS`, `REPUTATION`, `PHISHING`, `PROXY`, `MOBILE_THREATS`, `TOR_PROXY`, `DENIAL_OF_SERVICE`, `NETWORK`<br>[Enum: SPAM_SOURCES|WINDOWS_EXPLOITS|WEB_ATTACKS|BOTNETS|SCANNERS|REPUTATION|PHISHING|PROXY|MOBILE_THREATS|TOR_PROXY|DENIAL_OF_SERVICE|NETWORK] List of IP Threat Categories to choose. The IP threat categories is obtained from the list and is used to auto-generate equivalent label selection expressions
393
+ <a id="deep-ed2c35"></a>Deeply nested **List** block collapsed for readability.
632
394
 
633
395
  #### API Rate Limit Bypass Rate Limiting Rules Bypass Rate Limiting Rules Client Matcher TLS Fingerprint Matcher
634
396
 
635
- A [`tls_fingerprint_matcher`](#matcher-c87ce2) block (within [`api_rate_limit.bypass_rate_limiting_rules.bypass_rate_limiting_rules.client_matcher`](#matcher-a9da18)) supports the following:
636
-
637
- <a id="classes-5a5e36"></a>&#x2022; [`classes`](#classes-5a5e36) - Optional List Defaults to `TLS_FINGERPRINT_NONE`<br>Possible values are `TLS_FINGERPRINT_NONE`, `ANY_MALICIOUS_FINGERPRINT`, `ADWARE`, `ADWIND`, `DRIDEX`, `GOOTKIT`, `GOZI`, `JBIFROST`, `QUAKBOT`, `RANSOMWARE`, `TROLDESH`, `TOFSEE`, `TORRENTLOCKER`, `TRICKBOT`<br>[Enum: TLS_FINGERPRINT_NONE|ANY_MALICIOUS_FINGERPRINT|ADWARE|ADWIND|DRIDEX|GOOTKIT|GOZI|JBIFROST|QUAKBOT|RANSOMWARE|TROLDESH|TOFSEE|TORRENTLOCKER|TRICKBOT] TLS fingerprint classes. A list of known classes of TLS fingerprints to match the input TLS JA3 fingerprint against
638
-
639
- <a id="values-918a08"></a>&#x2022; [`exact_values`](#values-918a08) - Optional List<br>Exact Values. A list of exact TLS JA3 fingerprints to match the input TLS JA3 fingerprint against
640
-
641
- <a id="values-a7d1eb"></a>&#x2022; [`excluded_values`](#values-a7d1eb) - Optional List<br>Excluded Values. A list of TLS JA3 fingerprints to be excluded when matching the input TLS JA3 fingerprint. This can be used to skip known false positives when using one or more known TLS fingerprint classes in the enclosing matcher
397
+ <a id="deep-0e8717"></a>Deeply nested **Matcher** block collapsed for readability.
642
398
 
643
399
  #### API Rate Limit Bypass Rate Limiting Rules Bypass Rate Limiting Rules Request Matcher
644
400
 
645
- A [`request_matcher`](#matcher-e9bb4d) block (within [`api_rate_limit.bypass_rate_limiting_rules.bypass_rate_limiting_rules`](#rules-51aa34)) supports the following:
646
-
647
- <a id="matchers-f34f88"></a>&#x2022; [`cookie_matchers`](#matchers-f34f88) - Optional Block<br>Cookie Matchers. A 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. Note that all specified cookie matcher predicates must evaluate to true<br>See [Cookie Matchers](#matchers-f34f88) below.
648
-
649
- <a id="headers-4161e4"></a>&#x2022; [`headers`](#headers-4161e4) - Optional Block<br>HTTP Headers. A 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. Note that all specified header predicates must evaluate to true<br>See [Headers](#headers-4161e4) below.
650
-
651
- <a id="claims-13ffa7"></a>&#x2022; [`jwt_claims`](#claims-13ffa7) - Optional Block<br>JWT Claims. A list of predicates for various JWT claims that need to match. The criteria for matching each JWT claim are described in individual JWTClaimMatcherType instances. The actual JWT claims values are extracted from the JWT payload as a list of strings. Note that all specified JWT claim predicates must evaluate to true. Note that this feature only works on LBs with JWT Validation feature enabled<br>See [JWT Claims](#claims-13ffa7) below.
652
-
653
- <a id="params-bfd454"></a>&#x2022; [`query_params`](#params-bfd454) - Optional Block<br>HTTP Query Parameters. A 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 parameter name. Note that all specified query parameter predicates must evaluate to true<br>See [Query Params](#params-bfd454) below.
401
+ <a id="deep-9eed33"></a>Deeply nested **Matcher** block collapsed for readability.
654
402
 
655
403
  #### API Rate Limit Bypass Rate Limiting Rules Bypass Rate Limiting Rules Request Matcher Cookie Matchers
656
404
 
657
- A [`cookie_matchers`](#matchers-f34f88) block (within [`api_rate_limit.bypass_rate_limiting_rules.bypass_rate_limiting_rules.request_matcher`](#matcher-e9bb4d)) supports the following:
658
-
659
- <a id="present-25beab"></a>&#x2022; [`check_not_present`](#present-25beab) - Optional Block<br>Enable this option
660
-
661
- <a id="present-c78615"></a>&#x2022; [`check_present`](#present-c78615) - Optional Block<br>Enable this option
662
-
663
- <a id="matcher-e0ea9b"></a>&#x2022; [`invert_matcher`](#matcher-e0ea9b) - Optional Bool<br>Invert Matcher. Invert Match of the expression defined
664
-
665
- <a id="item-69d8e4"></a>&#x2022; [`item`](#item-69d8e4) - Optional Block<br>Matcher. A 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-69d8e4) below.
666
-
667
- <a id="name-2d8fee"></a>&#x2022; [`name`](#name-2d8fee) - Optional String<br>Cookie Name. A case-sensitive cookie name
405
+ <a id="deep-dd7483"></a>Deeply nested **Matchers** block collapsed for readability.
668
406
 
669
407
  #### API Rate Limit Bypass Rate Limiting Rules Bypass Rate Limiting Rules Request Matcher Cookie Matchers Item
670
408
 
671
- An [`item`](#item-69d8e4) block (within [`api_rate_limit.bypass_rate_limiting_rules.bypass_rate_limiting_rules.request_matcher.cookie_matchers`](#matchers-f34f88)) supports the following:
672
-
673
- <a id="values-9bae32"></a>&#x2022; [`exact_values`](#values-9bae32) - Optional List<br>Exact Values. A list of exact values to match the input against
674
-
675
- <a id="values-9362bb"></a>&#x2022; [`regex_values`](#values-9362bb) - Optional List<br>Regex Values. A list of regular expressions to match the input against
676
-
677
- <a id="transformers-a8c5ff"></a>&#x2022; [`transformers`](#transformers-a8c5ff) - Optional List Defaults to `TRANSFORMER_NONE`<br>Possible values are `LOWER_CASE`, `UPPER_CASE`, `BASE64_DECODE`, `NORMALIZE_PATH`, `REMOVE_WHITESPACE`, `URL_DECODE`, `TRIM_LEFT`, `TRIM_RIGHT`, `TRIM`<br>[Enum: LOWER_CASE|UPPER_CASE|BASE64_DECODE|NORMALIZE_PATH|REMOVE_WHITESPACE|URL_DECODE|TRIM_LEFT|TRIM_RIGHT|TRIM] Transformers. An ordered list of transformers (starting from index 0) to be applied to the path before matching
409
+ <a id="deep-746a10"></a>Deeply nested **Item** block collapsed for readability.
678
410
 
679
411
  #### API Rate Limit Bypass Rate Limiting Rules Bypass Rate Limiting Rules Request Matcher Headers
680
412
 
681
- A [`headers`](#headers-4161e4) block (within [`api_rate_limit.bypass_rate_limiting_rules.bypass_rate_limiting_rules.request_matcher`](#matcher-e9bb4d)) supports the following:
682
-
683
- <a id="present-ae8198"></a>&#x2022; [`check_not_present`](#present-ae8198) - Optional Block<br>Enable this option
684
-
685
- <a id="present-2f4647"></a>&#x2022; [`check_present`](#present-2f4647) - Optional Block<br>Enable this option
686
-
687
- <a id="matcher-65dc3a"></a>&#x2022; [`invert_matcher`](#matcher-65dc3a) - Optional Bool<br>Invert Header Matcher. Invert the match result
688
-
689
- <a id="item-4706a3"></a>&#x2022; [`item`](#item-4706a3) - Optional Block<br>Matcher. A 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-4706a3) below.
690
-
691
- <a id="name-b0a7d3"></a>&#x2022; [`name`](#name-b0a7d3) - Optional String<br>Header Name. A case-insensitive HTTP header name
413
+ <a id="deep-4e8a54"></a>Deeply nested **Headers** block collapsed for readability.
692
414
 
693
415
  #### API Rate Limit Bypass Rate Limiting Rules Bypass Rate Limiting Rules Request Matcher Headers Item
694
416
 
695
- An [`item`](#item-4706a3) block (within [`api_rate_limit.bypass_rate_limiting_rules.bypass_rate_limiting_rules.request_matcher.headers`](#headers-4161e4)) supports the following:
696
-
697
- <a id="values-3baf40"></a>&#x2022; [`exact_values`](#values-3baf40) - Optional List<br>Exact Values. A list of exact values to match the input against
698
-
699
- <a id="values-ce8cc2"></a>&#x2022; [`regex_values`](#values-ce8cc2) - Optional List<br>Regex Values. A list of regular expressions to match the input against
700
-
701
- <a id="transformers-e84879"></a>&#x2022; [`transformers`](#transformers-e84879) - Optional List Defaults to `TRANSFORMER_NONE`<br>Possible values are `LOWER_CASE`, `UPPER_CASE`, `BASE64_DECODE`, `NORMALIZE_PATH`, `REMOVE_WHITESPACE`, `URL_DECODE`, `TRIM_LEFT`, `TRIM_RIGHT`, `TRIM`<br>[Enum: LOWER_CASE|UPPER_CASE|BASE64_DECODE|NORMALIZE_PATH|REMOVE_WHITESPACE|URL_DECODE|TRIM_LEFT|TRIM_RIGHT|TRIM] Transformers. An ordered list of transformers (starting from index 0) to be applied to the path before matching
417
+ <a id="deep-328c40"></a>Deeply nested **Item** block collapsed for readability.
702
418
 
703
419
  #### API Rate Limit Bypass Rate Limiting Rules Bypass Rate Limiting Rules Request Matcher JWT Claims
704
420
 
705
- A [`jwt_claims`](#claims-13ffa7) block (within [`api_rate_limit.bypass_rate_limiting_rules.bypass_rate_limiting_rules.request_matcher`](#matcher-e9bb4d)) supports the following:
706
-
707
- <a id="present-0e108d"></a>&#x2022; [`check_not_present`](#present-0e108d) - Optional Block<br>Enable this option
708
-
709
- <a id="present-0ac17d"></a>&#x2022; [`check_present`](#present-0ac17d) - Optional Block<br>Enable this option
710
-
711
- <a id="matcher-43cde9"></a>&#x2022; [`invert_matcher`](#matcher-43cde9) - Optional Bool<br>Invert Matcher. Invert the match result
712
-
713
- <a id="item-ca8646"></a>&#x2022; [`item`](#item-ca8646) - Optional Block<br>Matcher. A 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-ca8646) below.
714
-
715
- <a id="name-3618ff"></a>&#x2022; [`name`](#name-3618ff) - Optional String<br>JWT Claim Name. JWT claim name
421
+ <a id="deep-d34315"></a>Deeply nested **Claims** block collapsed for readability.
716
422
 
717
423
  #### API Rate Limit Bypass Rate Limiting Rules Bypass Rate Limiting Rules Request Matcher JWT Claims Item
718
424
 
719
- An [`item`](#item-ca8646) block (within [`api_rate_limit.bypass_rate_limiting_rules.bypass_rate_limiting_rules.request_matcher.jwt_claims`](#claims-13ffa7)) supports the following:
720
-
721
- <a id="values-1ac86b"></a>&#x2022; [`exact_values`](#values-1ac86b) - Optional List<br>Exact Values. A list of exact values to match the input against
722
-
723
- <a id="values-44ceff"></a>&#x2022; [`regex_values`](#values-44ceff) - Optional List<br>Regex Values. A list of regular expressions to match the input against
724
-
725
- <a id="transformers-c7f562"></a>&#x2022; [`transformers`](#transformers-c7f562) - Optional List Defaults to `TRANSFORMER_NONE`<br>Possible values are `LOWER_CASE`, `UPPER_CASE`, `BASE64_DECODE`, `NORMALIZE_PATH`, `REMOVE_WHITESPACE`, `URL_DECODE`, `TRIM_LEFT`, `TRIM_RIGHT`, `TRIM`<br>[Enum: LOWER_CASE|UPPER_CASE|BASE64_DECODE|NORMALIZE_PATH|REMOVE_WHITESPACE|URL_DECODE|TRIM_LEFT|TRIM_RIGHT|TRIM] Transformers. An ordered list of transformers (starting from index 0) to be applied to the path before matching
425
+ <a id="deep-9cd3b4"></a>Deeply nested **Item** block collapsed for readability.
726
426
 
727
427
  #### API Rate Limit Bypass Rate Limiting Rules Bypass Rate Limiting Rules Request Matcher Query Params
728
428
 
729
- A [`query_params`](#params-bfd454) block (within [`api_rate_limit.bypass_rate_limiting_rules.bypass_rate_limiting_rules.request_matcher`](#matcher-e9bb4d)) supports the following:
730
-
731
- <a id="present-928f2f"></a>&#x2022; [`check_not_present`](#present-928f2f) - Optional Block<br>Enable this option
732
-
733
- <a id="present-0997e1"></a>&#x2022; [`check_present`](#present-0997e1) - Optional Block<br>Enable this option
734
-
735
- <a id="matcher-94883f"></a>&#x2022; [`invert_matcher`](#matcher-94883f) - Optional Bool<br>Invert Query Parameter Matcher. Invert the match result
736
-
737
- <a id="item-1cc059"></a>&#x2022; [`item`](#item-1cc059) - Optional Block<br>Matcher. A 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-1cc059) below.
738
-
739
- <a id="key-4059d5"></a>&#x2022; [`key`](#key-4059d5) - Optional String<br>Query Parameter Name. A case-sensitive HTTP query parameter name
429
+ <a id="deep-8194a5"></a>Deeply nested **Params** block collapsed for readability.
740
430
 
741
431
  #### API Rate Limit Bypass Rate Limiting Rules Bypass Rate Limiting Rules Request Matcher Query Params Item
742
432
 
743
- An [`item`](#item-1cc059) block (within [`api_rate_limit.bypass_rate_limiting_rules.bypass_rate_limiting_rules.request_matcher.query_params`](#params-bfd454)) supports the following:
744
-
745
- <a id="values-1b4d75"></a>&#x2022; [`exact_values`](#values-1b4d75) - Optional List<br>Exact Values. A list of exact values to match the input against
746
-
747
- <a id="values-76def7"></a>&#x2022; [`regex_values`](#values-76def7) - Optional List<br>Regex Values. A list of regular expressions to match the input against
748
-
749
- <a id="transformers-9a24cd"></a>&#x2022; [`transformers`](#transformers-9a24cd) - Optional List Defaults to `TRANSFORMER_NONE`<br>Possible values are `LOWER_CASE`, `UPPER_CASE`, `BASE64_DECODE`, `NORMALIZE_PATH`, `REMOVE_WHITESPACE`, `URL_DECODE`, `TRIM_LEFT`, `TRIM_RIGHT`, `TRIM`<br>[Enum: LOWER_CASE|UPPER_CASE|BASE64_DECODE|NORMALIZE_PATH|REMOVE_WHITESPACE|URL_DECODE|TRIM_LEFT|TRIM_RIGHT|TRIM] Transformers. An ordered list of transformers (starting from index 0) to be applied to the path before matching
433
+ <a id="deep-4cdff3"></a>Deeply nested **Item** block collapsed for readability.
750
434
 
751
435
  #### API Rate Limit Custom IP Allowed List
752
436
 
@@ -756,13 +440,7 @@ A [`custom_ip_allowed_list`](#api-rate-limit-custom-ip-allowed-list) block (with
756
440
 
757
441
  #### API Rate Limit Custom IP Allowed List Rate Limiter Allowed Prefixes
758
442
 
759
- A [`rate_limiter_allowed_prefixes`](#prefixes-73df46) block (within [`api_rate_limit.custom_ip_allowed_list`](#api-rate-limit-custom-ip-allowed-list)) supports the following:
760
-
761
- <a id="name-3a08ca"></a>&#x2022; [`name`](#name-3a08ca) - Optional String<br>Name. 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
762
-
763
- <a id="namespace-8714e1"></a>&#x2022; [`namespace`](#namespace-8714e1) - Optional String<br>Namespace. 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
764
-
765
- <a id="tenant-89acd3"></a>&#x2022; [`tenant`](#tenant-89acd3) - Optional String<br>Tenant. 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
443
+ <a id="deep-85bfc8"></a>Deeply nested **Prefixes** block collapsed for readability.
766
444
 
767
445
  #### API Rate Limit IP Allowed List
768
446
 
@@ -792,243 +470,91 @@ A [`server_url_rules`](#api-rate-limit-server-url-rules) block (within [`api_rat
792
470
 
793
471
  #### API Rate Limit Server URL Rules Client Matcher
794
472
 
795
- A [`client_matcher`](#matcher-ed4b34) block (within [`api_rate_limit.server_url_rules`](#api-rate-limit-server-url-rules)) supports the following:
796
-
797
- <a id="client-d95ee8"></a>&#x2022; [`any_client`](#client-d95ee8) - Optional Block<br>Enable this option
798
-
799
- <a id="any-ip-e752c7"></a>&#x2022; [`any_ip`](#any-ip-e752c7) - Optional Block<br>Enable this option
800
-
801
- <a id="list-52dae1"></a>&#x2022; [`asn_list`](#list-52dae1) - Optional Block<br>ASN Match List. An 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-52dae1) below.
802
-
803
- <a id="matcher-9643c3"></a>&#x2022; [`asn_matcher`](#matcher-9643c3) - Optional Block<br>ASN Matcher. Match any AS number contained in the list of bgp_asn_sets<br>See [Asn Matcher](#matcher-9643c3) below.
804
-
805
- <a id="selector-75ec07"></a>&#x2022; [`client_selector`](#selector-75ec07) - Optional Block<br>Label Selector. This 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. A null label selector matches no objects. Label selector is immutable. expressions is a list of strings of label selection expression. Each string has ',' separated values which are 'AND' and all strings are logically 'OR'. BNF for expression string `<selector-syntax>` ::= `<requirement>` | `<requirement>` ',' `<selector-syntax>` `<requirement>` ::= [!] KEY [ `<set-based-restriction>` | `<exact-match-restriction>` ] `<set-based-restriction>` ::= '' | `<inclusion-exclusion>` `<value-set>` `<inclusion-exclusion>` ::= `<inclusion>` | `<exclusion>` `<exclusion>` ::= 'notin' `<inclusion>` ::= 'in' `<value-set>` ::= '(' `<values>` ')' `<values>` ::= VALUE | VALUE ',' `<values>` `<exact-match-restriction>` ::= ['='|'=='|'!='] VALUE<br>See [Client Selector](#selector-75ec07) below.
806
-
807
- <a id="matcher-74485b"></a>&#x2022; [`ip_matcher`](#matcher-74485b) - Optional Block<br>IP Prefix Matcher. 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-74485b) below.
808
-
809
- <a id="list-047465"></a>&#x2022; [`ip_prefix_list`](#list-047465) - Optional Block<br>IP Prefix Match List. List of IP Prefix strings to match against<br>See [IP Prefix List](#list-047465) below.
810
-
811
- <a id="list-ac4c85"></a>&#x2022; [`ip_threat_category_list`](#list-ac4c85) - Optional Block<br>IP Threat Category List Type. List of IP threat categories<br>See [IP Threat Category List](#list-ac4c85) below.
812
-
813
- <a id="matcher-d896f3"></a>&#x2022; [`tls_fingerprint_matcher`](#matcher-d896f3) - Optional Block<br>TLS Fingerprint Matcher. A 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 and the input fingerprint is not one of the excluded values<br>See [TLS Fingerprint Matcher](#matcher-d896f3) below.
473
+ <a id="deep-ecbdb7"></a>Deeply nested **Matcher** block collapsed for readability.
814
474
 
815
475
  #### API Rate Limit Server URL Rules Client Matcher Asn List
816
476
 
817
- An [`asn_list`](#list-52dae1) block (within [`api_rate_limit.server_url_rules.client_matcher`](#matcher-ed4b34)) supports the following:
818
-
819
- <a id="numbers-826050"></a>&#x2022; [`as_numbers`](#numbers-826050) - Optional List<br>AS Numbers. An 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
477
+ <a id="deep-e9df5c"></a>Deeply nested **List** block collapsed for readability.
820
478
 
821
479
  #### API Rate Limit Server URL Rules Client Matcher Asn Matcher
822
480
 
823
- An [`asn_matcher`](#matcher-9643c3) block (within [`api_rate_limit.server_url_rules.client_matcher`](#matcher-ed4b34)) supports the following:
824
-
825
- <a id="sets-2c4adf"></a>&#x2022; [`asn_sets`](#sets-2c4adf) - Optional Block<br>BGP ASN Sets. A list of references to bgp_asn_set objects<br>See [Asn Sets](#sets-2c4adf) below.
481
+ <a id="deep-da7cfe"></a>Deeply nested **Matcher** block collapsed for readability.
826
482
 
827
483
  #### API Rate Limit Server URL Rules Client Matcher Asn Matcher Asn Sets
828
484
 
829
- An [`asn_sets`](#sets-2c4adf) block (within [`api_rate_limit.server_url_rules.client_matcher.asn_matcher`](#matcher-9643c3)) supports the following:
830
-
831
- <a id="kind-901b29"></a>&#x2022; [`kind`](#kind-901b29) - Optional String<br>Kind. When a configuration object(e.g. virtual_host) refers to another(e.g route) then kind will hold the referred object's kind (e.g. 'route')
832
-
833
- <a id="name-b807d9"></a>&#x2022; [`name`](#name-b807d9) - Optional String<br>Name. 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
834
-
835
- <a id="namespace-f14602"></a>&#x2022; [`namespace`](#namespace-f14602) - Optional String<br>Namespace. 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
836
-
837
- <a id="tenant-d3fbe6"></a>&#x2022; [`tenant`](#tenant-d3fbe6) - Optional String<br>Tenant. 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
838
-
839
- <a id="uid-e2fb5d"></a>&#x2022; [`uid`](#uid-e2fb5d) - Optional String<br>UID. When a configuration object(e.g. virtual_host) refers to another(e.g route) then uid will hold the referred object's(e.g. route's) uid
485
+ <a id="deep-641e85"></a>Deeply nested **Sets** block collapsed for readability.
840
486
 
841
487
  #### API Rate Limit Server URL Rules Client Matcher Client Selector
842
488
 
843
- A [`client_selector`](#selector-75ec07) block (within [`api_rate_limit.server_url_rules.client_matcher`](#matcher-ed4b34)) supports the following:
844
-
845
- <a id="expressions-6e94c4"></a>&#x2022; [`expressions`](#expressions-6e94c4) - Optional List<br>Selector Expression. expressions contains the kubernetes style label expression for selections
489
+ <a id="deep-1cd130"></a>Deeply nested **Selector** block collapsed for readability.
846
490
 
847
491
  #### API Rate Limit Server URL Rules Client Matcher IP Matcher
848
492
 
849
- An [`ip_matcher`](#matcher-74485b) block (within [`api_rate_limit.server_url_rules.client_matcher`](#matcher-ed4b34)) supports the following:
850
-
851
- <a id="matcher-348dd9"></a>&#x2022; [`invert_matcher`](#matcher-348dd9) - Optional Bool<br>Invert IP Matcher. Invert the match result
852
-
853
- <a id="sets-13bcb5"></a>&#x2022; [`prefix_sets`](#sets-13bcb5) - Optional Block<br>IP Prefix Sets. A list of references to ip_prefix_set objects<br>See [Prefix Sets](#sets-13bcb5) below.
493
+ <a id="deep-51ff2b"></a>Deeply nested **Matcher** block collapsed for readability.
854
494
 
855
495
  #### API Rate Limit Server URL Rules Client Matcher IP Matcher Prefix Sets
856
496
 
857
- A [`prefix_sets`](#sets-13bcb5) block (within [`api_rate_limit.server_url_rules.client_matcher.ip_matcher`](#matcher-74485b)) supports the following:
858
-
859
- <a id="kind-6b5e2d"></a>&#x2022; [`kind`](#kind-6b5e2d) - Optional String<br>Kind. When a configuration object(e.g. virtual_host) refers to another(e.g route) then kind will hold the referred object's kind (e.g. 'route')
860
-
861
- <a id="name-f97673"></a>&#x2022; [`name`](#name-f97673) - Optional String<br>Name. 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
862
-
863
- <a id="namespace-77b4df"></a>&#x2022; [`namespace`](#namespace-77b4df) - Optional String<br>Namespace. 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
864
-
865
- <a id="tenant-2de84a"></a>&#x2022; [`tenant`](#tenant-2de84a) - Optional String<br>Tenant. 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
866
-
867
- <a id="uid-b93ef7"></a>&#x2022; [`uid`](#uid-b93ef7) - Optional String<br>UID. When a configuration object(e.g. virtual_host) refers to another(e.g route) then uid will hold the referred object's(e.g. route's) uid
497
+ <a id="deep-df562f"></a>Deeply nested **Sets** block collapsed for readability.
868
498
 
869
499
  #### API Rate Limit Server URL Rules Client Matcher IP Prefix List
870
500
 
871
- An [`ip_prefix_list`](#list-047465) block (within [`api_rate_limit.server_url_rules.client_matcher`](#matcher-ed4b34)) supports the following:
872
-
873
- <a id="match-2b3904"></a>&#x2022; [`invert_match`](#match-2b3904) - Optional Bool<br>Invert Match Result. Invert the match result
874
-
875
- <a id="prefixes-4fcef5"></a>&#x2022; [`ip_prefixes`](#prefixes-4fcef5) - Optional List<br>IPv4 Prefix List. List of IPv4 prefix strings
501
+ <a id="deep-d61862"></a>Deeply nested **List** block collapsed for readability.
876
502
 
877
503
  #### API Rate Limit Server URL Rules Client Matcher IP Threat Category List
878
504
 
879
- An [`ip_threat_category_list`](#list-ac4c85) block (within [`api_rate_limit.server_url_rules.client_matcher`](#matcher-ed4b34)) supports the following:
880
-
881
- <a id="categories-f2e19c"></a>&#x2022; [`ip_threat_categories`](#categories-f2e19c) - Optional List Defaults to `SPAM_SOURCES`<br>Possible values are `SPAM_SOURCES`, `WINDOWS_EXPLOITS`, `WEB_ATTACKS`, `BOTNETS`, `SCANNERS`, `REPUTATION`, `PHISHING`, `PROXY`, `MOBILE_THREATS`, `TOR_PROXY`, `DENIAL_OF_SERVICE`, `NETWORK`<br>[Enum: SPAM_SOURCES|WINDOWS_EXPLOITS|WEB_ATTACKS|BOTNETS|SCANNERS|REPUTATION|PHISHING|PROXY|MOBILE_THREATS|TOR_PROXY|DENIAL_OF_SERVICE|NETWORK] List of IP Threat Categories to choose. The IP threat categories is obtained from the list and is used to auto-generate equivalent label selection expressions
505
+ <a id="deep-d4b74b"></a>Deeply nested **List** block collapsed for readability.
882
506
 
883
507
  #### API Rate Limit Server URL Rules Client Matcher TLS Fingerprint Matcher
884
508
 
885
- A [`tls_fingerprint_matcher`](#matcher-d896f3) block (within [`api_rate_limit.server_url_rules.client_matcher`](#matcher-ed4b34)) supports the following:
886
-
887
- <a id="classes-c89726"></a>&#x2022; [`classes`](#classes-c89726) - Optional List Defaults to `TLS_FINGERPRINT_NONE`<br>Possible values are `TLS_FINGERPRINT_NONE`, `ANY_MALICIOUS_FINGERPRINT`, `ADWARE`, `ADWIND`, `DRIDEX`, `GOOTKIT`, `GOZI`, `JBIFROST`, `QUAKBOT`, `RANSOMWARE`, `TROLDESH`, `TOFSEE`, `TORRENTLOCKER`, `TRICKBOT`<br>[Enum: TLS_FINGERPRINT_NONE|ANY_MALICIOUS_FINGERPRINT|ADWARE|ADWIND|DRIDEX|GOOTKIT|GOZI|JBIFROST|QUAKBOT|RANSOMWARE|TROLDESH|TOFSEE|TORRENTLOCKER|TRICKBOT] TLS fingerprint classes. A list of known classes of TLS fingerprints to match the input TLS JA3 fingerprint against
888
-
889
- <a id="values-e9c2ed"></a>&#x2022; [`exact_values`](#values-e9c2ed) - Optional List<br>Exact Values. A list of exact TLS JA3 fingerprints to match the input TLS JA3 fingerprint against
890
-
891
- <a id="values-c878a8"></a>&#x2022; [`excluded_values`](#values-c878a8) - Optional List<br>Excluded Values. A list of TLS JA3 fingerprints to be excluded when matching the input TLS JA3 fingerprint. This can be used to skip known false positives when using one or more known TLS fingerprint classes in the enclosing matcher
509
+ <a id="deep-fab698"></a>Deeply nested **Matcher** block collapsed for readability.
892
510
 
893
511
  #### API Rate Limit Server URL Rules Inline Rate Limiter
894
512
 
895
- An [`inline_rate_limiter`](#limiter-9faa53) block (within [`api_rate_limit.server_url_rules`](#api-rate-limit-server-url-rules)) supports the following:
896
-
897
- <a id="user-id-2410cf"></a>&#x2022; [`ref_user_id`](#user-id-2410cf) - Optional Block<br>Object reference. This 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 User ID](#user-id-2410cf) below.
898
-
899
- <a id="threshold-e1f6ce"></a>&#x2022; [`threshold`](#threshold-e1f6ce) - Optional Number<br>Threshold. The total number of allowed requests for 1 unit (e.g. SECOND/MINUTE/HOUR etc.) of the specified period
900
-
901
- <a id="unit-23f142"></a>&#x2022; [`unit`](#unit-23f142) - Optional String Defaults to `SECOND`<br>Possible values are `SECOND`, `MINUTE`, `HOUR`<br>[Enum: SECOND|MINUTE|HOUR] Rate Limit Period Unit. 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
902
-
903
- <a id="user-id-560a62"></a>&#x2022; [`use_http_lb_user_id`](#user-id-560a62) - Optional Block<br>Enable this option
513
+ <a id="deep-758e39"></a>Deeply nested **Limiter** block collapsed for readability.
904
514
 
905
515
  #### API Rate Limit Server URL Rules Inline Rate Limiter Ref User ID
906
516
 
907
- A [`ref_user_id`](#user-id-2410cf) block (within [`api_rate_limit.server_url_rules.inline_rate_limiter`](#limiter-9faa53)) supports the following:
908
-
909
- <a id="name-91d5b8"></a>&#x2022; [`name`](#name-91d5b8) - Optional String<br>Name. 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
910
-
911
- <a id="namespace-9a5eae"></a>&#x2022; [`namespace`](#namespace-9a5eae) - Optional String<br>Namespace. 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
912
-
913
- <a id="tenant-4c9142"></a>&#x2022; [`tenant`](#tenant-4c9142) - Optional String<br>Tenant. 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
517
+ <a id="deep-37d9ec"></a>Deeply nested **ID** block collapsed for readability.
914
518
 
915
519
  #### API Rate Limit Server URL Rules Ref Rate Limiter
916
520
 
917
- A [`ref_rate_limiter`](#limiter-383ca9) block (within [`api_rate_limit.server_url_rules`](#api-rate-limit-server-url-rules)) supports the following:
918
-
919
- <a id="name-33d109"></a>&#x2022; [`name`](#name-33d109) - Optional String<br>Name. 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
920
-
921
- <a id="namespace-bdf110"></a>&#x2022; [`namespace`](#namespace-bdf110) - Optional String<br>Namespace. 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
922
-
923
- <a id="tenant-3c7e29"></a>&#x2022; [`tenant`](#tenant-3c7e29) - Optional String<br>Tenant. 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
521
+ <a id="deep-6a8465"></a>Deeply nested **Limiter** block collapsed for readability.
924
522
 
925
523
  #### API Rate Limit Server URL Rules Request Matcher
926
524
 
927
- A [`request_matcher`](#matcher-d0eea8) block (within [`api_rate_limit.server_url_rules`](#api-rate-limit-server-url-rules)) supports the following:
928
-
929
- <a id="matchers-834089"></a>&#x2022; [`cookie_matchers`](#matchers-834089) - Optional Block<br>Cookie Matchers. A 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. Note that all specified cookie matcher predicates must evaluate to true<br>See [Cookie Matchers](#matchers-834089) below.
930
-
931
- <a id="headers-f3e5bd"></a>&#x2022; [`headers`](#headers-f3e5bd) - Optional Block<br>HTTP Headers. A 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. Note that all specified header predicates must evaluate to true<br>See [Headers](#headers-f3e5bd) below.
932
-
933
- <a id="claims-12c338"></a>&#x2022; [`jwt_claims`](#claims-12c338) - Optional Block<br>JWT Claims. A list of predicates for various JWT claims that need to match. The criteria for matching each JWT claim are described in individual JWTClaimMatcherType instances. The actual JWT claims values are extracted from the JWT payload as a list of strings. Note that all specified JWT claim predicates must evaluate to true. Note that this feature only works on LBs with JWT Validation feature enabled<br>See [JWT Claims](#claims-12c338) below.
934
-
935
- <a id="params-176d8b"></a>&#x2022; [`query_params`](#params-176d8b) - Optional Block<br>HTTP Query Parameters. A 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 parameter name. Note that all specified query parameter predicates must evaluate to true<br>See [Query Params](#params-176d8b) below.
525
+ <a id="deep-f791bc"></a>Deeply nested **Matcher** block collapsed for readability.
936
526
 
937
527
  #### API Rate Limit Server URL Rules Request Matcher Cookie Matchers
938
528
 
939
- A [`cookie_matchers`](#matchers-834089) block (within [`api_rate_limit.server_url_rules.request_matcher`](#matcher-d0eea8)) supports the following:
940
-
941
- <a id="present-4a314d"></a>&#x2022; [`check_not_present`](#present-4a314d) - Optional Block<br>Enable this option
942
-
943
- <a id="present-bfd192"></a>&#x2022; [`check_present`](#present-bfd192) - Optional Block<br>Enable this option
944
-
945
- <a id="matcher-5a5e9f"></a>&#x2022; [`invert_matcher`](#matcher-5a5e9f) - Optional Bool<br>Invert Matcher. Invert Match of the expression defined
946
-
947
- <a id="item-4904af"></a>&#x2022; [`item`](#item-4904af) - Optional Block<br>Matcher. A 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-4904af) below.
948
-
949
- <a id="name-764850"></a>&#x2022; [`name`](#name-764850) - Optional String<br>Cookie Name. A case-sensitive cookie name
529
+ <a id="deep-11f932"></a>Deeply nested **Matchers** block collapsed for readability.
950
530
 
951
531
  #### API Rate Limit Server URL Rules Request Matcher Cookie Matchers Item
952
532
 
953
- An [`item`](#item-4904af) block (within [`api_rate_limit.server_url_rules.request_matcher.cookie_matchers`](#matchers-834089)) supports the following:
954
-
955
- <a id="values-1a1200"></a>&#x2022; [`exact_values`](#values-1a1200) - Optional List<br>Exact Values. A list of exact values to match the input against
956
-
957
- <a id="values-d6047d"></a>&#x2022; [`regex_values`](#values-d6047d) - Optional List<br>Regex Values. A list of regular expressions to match the input against
958
-
959
- <a id="transformers-c3e045"></a>&#x2022; [`transformers`](#transformers-c3e045) - Optional List Defaults to `TRANSFORMER_NONE`<br>Possible values are `LOWER_CASE`, `UPPER_CASE`, `BASE64_DECODE`, `NORMALIZE_PATH`, `REMOVE_WHITESPACE`, `URL_DECODE`, `TRIM_LEFT`, `TRIM_RIGHT`, `TRIM`<br>[Enum: LOWER_CASE|UPPER_CASE|BASE64_DECODE|NORMALIZE_PATH|REMOVE_WHITESPACE|URL_DECODE|TRIM_LEFT|TRIM_RIGHT|TRIM] Transformers. An ordered list of transformers (starting from index 0) to be applied to the path before matching
533
+ <a id="deep-b08554"></a>Deeply nested **Item** block collapsed for readability.
960
534
 
961
535
  #### API Rate Limit Server URL Rules Request Matcher Headers
962
536
 
963
- A [`headers`](#headers-f3e5bd) block (within [`api_rate_limit.server_url_rules.request_matcher`](#matcher-d0eea8)) supports the following:
964
-
965
- <a id="present-b8a223"></a>&#x2022; [`check_not_present`](#present-b8a223) - Optional Block<br>Enable this option
966
-
967
- <a id="present-de3982"></a>&#x2022; [`check_present`](#present-de3982) - Optional Block<br>Enable this option
968
-
969
- <a id="matcher-7ed807"></a>&#x2022; [`invert_matcher`](#matcher-7ed807) - Optional Bool<br>Invert Header Matcher. Invert the match result
970
-
971
- <a id="item-8635a7"></a>&#x2022; [`item`](#item-8635a7) - Optional Block<br>Matcher. A 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-8635a7) below.
972
-
973
- <a id="name-7ac50b"></a>&#x2022; [`name`](#name-7ac50b) - Optional String<br>Header Name. A case-insensitive HTTP header name
537
+ <a id="deep-a738af"></a>Deeply nested **Headers** block collapsed for readability.
974
538
 
975
539
  #### API Rate Limit Server URL Rules Request Matcher Headers Item
976
540
 
977
- An [`item`](#item-8635a7) block (within [`api_rate_limit.server_url_rules.request_matcher.headers`](#headers-f3e5bd)) supports the following:
978
-
979
- <a id="values-bb1d87"></a>&#x2022; [`exact_values`](#values-bb1d87) - Optional List<br>Exact Values. A list of exact values to match the input against
980
-
981
- <a id="values-99be35"></a>&#x2022; [`regex_values`](#values-99be35) - Optional List<br>Regex Values. A list of regular expressions to match the input against
982
-
983
- <a id="transformers-17e679"></a>&#x2022; [`transformers`](#transformers-17e679) - Optional List Defaults to `TRANSFORMER_NONE`<br>Possible values are `LOWER_CASE`, `UPPER_CASE`, `BASE64_DECODE`, `NORMALIZE_PATH`, `REMOVE_WHITESPACE`, `URL_DECODE`, `TRIM_LEFT`, `TRIM_RIGHT`, `TRIM`<br>[Enum: LOWER_CASE|UPPER_CASE|BASE64_DECODE|NORMALIZE_PATH|REMOVE_WHITESPACE|URL_DECODE|TRIM_LEFT|TRIM_RIGHT|TRIM] Transformers. An ordered list of transformers (starting from index 0) to be applied to the path before matching
541
+ <a id="deep-28a0f1"></a>Deeply nested **Item** block collapsed for readability.
984
542
 
985
543
  #### API Rate Limit Server URL Rules Request Matcher JWT Claims
986
544
 
987
- A [`jwt_claims`](#claims-12c338) block (within [`api_rate_limit.server_url_rules.request_matcher`](#matcher-d0eea8)) supports the following:
988
-
989
- <a id="present-b2dfb7"></a>&#x2022; [`check_not_present`](#present-b2dfb7) - Optional Block<br>Enable this option
990
-
991
- <a id="present-54a989"></a>&#x2022; [`check_present`](#present-54a989) - Optional Block<br>Enable this option
992
-
993
- <a id="matcher-a26813"></a>&#x2022; [`invert_matcher`](#matcher-a26813) - Optional Bool<br>Invert Matcher. Invert the match result
994
-
995
- <a id="item-b8fbc9"></a>&#x2022; [`item`](#item-b8fbc9) - Optional Block<br>Matcher. A 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-b8fbc9) below.
996
-
997
- <a id="name-eb48e1"></a>&#x2022; [`name`](#name-eb48e1) - Optional String<br>JWT Claim Name. JWT claim name
545
+ <a id="deep-4069dc"></a>Deeply nested **Claims** block collapsed for readability.
998
546
 
999
547
  #### API Rate Limit Server URL Rules Request Matcher JWT Claims Item
1000
548
 
1001
- An [`item`](#item-b8fbc9) block (within [`api_rate_limit.server_url_rules.request_matcher.jwt_claims`](#claims-12c338)) supports the following:
1002
-
1003
- <a id="values-db3fa8"></a>&#x2022; [`exact_values`](#values-db3fa8) - Optional List<br>Exact Values. A list of exact values to match the input against
1004
-
1005
- <a id="values-477cf3"></a>&#x2022; [`regex_values`](#values-477cf3) - Optional List<br>Regex Values. A list of regular expressions to match the input against
1006
-
1007
- <a id="transformers-9a6b31"></a>&#x2022; [`transformers`](#transformers-9a6b31) - Optional List Defaults to `TRANSFORMER_NONE`<br>Possible values are `LOWER_CASE`, `UPPER_CASE`, `BASE64_DECODE`, `NORMALIZE_PATH`, `REMOVE_WHITESPACE`, `URL_DECODE`, `TRIM_LEFT`, `TRIM_RIGHT`, `TRIM`<br>[Enum: LOWER_CASE|UPPER_CASE|BASE64_DECODE|NORMALIZE_PATH|REMOVE_WHITESPACE|URL_DECODE|TRIM_LEFT|TRIM_RIGHT|TRIM] Transformers. An ordered list of transformers (starting from index 0) to be applied to the path before matching
549
+ <a id="deep-e1e8f7"></a>Deeply nested **Item** block collapsed for readability.
1008
550
 
1009
551
  #### API Rate Limit Server URL Rules Request Matcher Query Params
1010
552
 
1011
- A [`query_params`](#params-176d8b) block (within [`api_rate_limit.server_url_rules.request_matcher`](#matcher-d0eea8)) supports the following:
1012
-
1013
- <a id="present-3444e4"></a>&#x2022; [`check_not_present`](#present-3444e4) - Optional Block<br>Enable this option
1014
-
1015
- <a id="present-e16059"></a>&#x2022; [`check_present`](#present-e16059) - Optional Block<br>Enable this option
1016
-
1017
- <a id="matcher-1e387b"></a>&#x2022; [`invert_matcher`](#matcher-1e387b) - Optional Bool<br>Invert Query Parameter Matcher. Invert the match result
1018
-
1019
- <a id="item-b75d42"></a>&#x2022; [`item`](#item-b75d42) - Optional Block<br>Matcher. A 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-b75d42) below.
1020
-
1021
- <a id="key-049198"></a>&#x2022; [`key`](#key-049198) - Optional String<br>Query Parameter Name. A case-sensitive HTTP query parameter name
553
+ <a id="deep-015644"></a>Deeply nested **Params** block collapsed for readability.
1022
554
 
1023
555
  #### API Rate Limit Server URL Rules Request Matcher Query Params Item
1024
556
 
1025
- An [`item`](#item-b75d42) block (within [`api_rate_limit.server_url_rules.request_matcher.query_params`](#params-176d8b)) supports the following:
1026
-
1027
- <a id="values-1feeac"></a>&#x2022; [`exact_values`](#values-1feeac) - Optional List<br>Exact Values. A list of exact values to match the input against
1028
-
1029
- <a id="values-2381e5"></a>&#x2022; [`regex_values`](#values-2381e5) - Optional List<br>Regex Values. A list of regular expressions to match the input against
1030
-
1031
- <a id="transformers-8b8f7c"></a>&#x2022; [`transformers`](#transformers-8b8f7c) - Optional List Defaults to `TRANSFORMER_NONE`<br>Possible values are `LOWER_CASE`, `UPPER_CASE`, `BASE64_DECODE`, `NORMALIZE_PATH`, `REMOVE_WHITESPACE`, `URL_DECODE`, `TRIM_LEFT`, `TRIM_RIGHT`, `TRIM`<br>[Enum: LOWER_CASE|UPPER_CASE|BASE64_DECODE|NORMALIZE_PATH|REMOVE_WHITESPACE|URL_DECODE|TRIM_LEFT|TRIM_RIGHT|TRIM] Transformers. An ordered list of transformers (starting from index 0) to be applied to the path before matching
557
+ <a id="deep-ba63fa"></a>Deeply nested **Item** block collapsed for readability.
1032
558
 
1033
559
  #### API Specification
1034
560
 
@@ -1044,13 +570,7 @@ An [`api_specification`](#api-specification) block supports the following:
1044
570
 
1045
571
  #### API Specification API Definition
1046
572
 
1047
- An [`api_definition`](#api-specification-api-definition) block (within [`api_specification`](#api-specification)) supports the following:
1048
-
1049
- <a id="api-specification-api-definition-name"></a>&#x2022; [`name`](#api-specification-api-definition-name) - Optional String<br>Name. 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
1050
-
1051
- <a id="namespace-c685bf"></a>&#x2022; [`namespace`](#namespace-c685bf) - Optional String<br>Namespace. 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
1052
-
1053
- <a id="api-specification-api-definition-tenant"></a>&#x2022; [`tenant`](#api-specification-api-definition-tenant) - Optional String<br>Tenant. 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
573
+ <a id="objref-d119bc"></a>Uses standard [Object Reference](#common-object-reference) fields (name, namespace, tenant).
1054
574
 
1055
575
  #### API Specification Validation All Spec Endpoints
1056
576
 
@@ -1064,51 +584,23 @@ A [`validation_all_spec_endpoints`](#endpoints-4158a4) block (within [`api_speci
1064
584
 
1065
585
  #### API Specification Validation All Spec Endpoints Fall Through Mode
1066
586
 
1067
- A [`fall_through_mode`](#mode-8425c5) block (within [`api_specification.validation_all_spec_endpoints`](#endpoints-4158a4)) supports the following:
1068
-
1069
- <a id="allow-fe1e6a"></a>&#x2022; [`fall_through_mode_allow`](#allow-fe1e6a) - Optional Block<br>Enable this option
1070
-
1071
- <a id="custom-aadcaa"></a>&#x2022; [`fall_through_mode_custom`](#custom-aadcaa) - Optional Block<br>Custom Fall Through Mode. Define the fall through settings<br>See [Fall Through Mode Custom](#custom-aadcaa) below.
587
+ <a id="deep-93854f"></a>Deeply nested **Mode** block collapsed for readability.
1072
588
 
1073
589
  #### API Specification Validation All Spec Endpoints Fall Through Mode Fall Through Mode Custom
1074
590
 
1075
- A [`fall_through_mode_custom`](#custom-aadcaa) block (within [`api_specification.validation_all_spec_endpoints.fall_through_mode`](#mode-8425c5)) supports the following:
1076
-
1077
- <a id="rules-7e1bb3"></a>&#x2022; [`open_api_validation_rules`](#rules-7e1bb3) - Optional Block<br>Custom Fall Through Rule List<br>See [Open API Validation Rules](#rules-7e1bb3) below.
591
+ <a id="deep-fcb4c6"></a>Deeply nested **Custom** block collapsed for readability.
1078
592
 
1079
593
  #### API Specification Validation All Spec Endpoints Fall Through Mode Fall Through Mode Custom Open API Validation Rules
1080
594
 
1081
- An [`open_api_validation_rules`](#rules-7e1bb3) block (within [`api_specification.validation_all_spec_endpoints.fall_through_mode.fall_through_mode_custom`](#custom-aadcaa)) supports the following:
1082
-
1083
- <a id="block-392345"></a>&#x2022; [`action_block`](#block-392345) - Optional Block<br>Enable this option
1084
-
1085
- <a id="report-70f264"></a>&#x2022; [`action_report`](#report-70f264) - Optional Block<br>Enable this option
1086
-
1087
- <a id="skip-5ad739"></a>&#x2022; [`action_skip`](#skip-5ad739) - Optional Block<br>Enable this option
1088
-
1089
- <a id="endpoint-eb6d3c"></a>&#x2022; [`api_endpoint`](#endpoint-eb6d3c) - Optional Block<br>API Endpoint. This defines API endpoint<br>See [API Endpoint](#endpoint-eb6d3c) below.
1090
-
1091
- <a id="group-ba04ab"></a>&#x2022; [`api_group`](#group-ba04ab) - Optional String<br>API Group. The API group which this validation applies to
1092
-
1093
- <a id="path-822099"></a>&#x2022; [`base_path`](#path-822099) - Optional String<br>Base Path. The base path which this validation applies to
1094
-
1095
- <a id="metadata-868613"></a>&#x2022; [`metadata`](#metadata-868613) - Optional Block<br>Message Metadata. 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 and replace APIs<br>See [Metadata](#metadata-868613) below.
595
+ <a id="deep-5bd981"></a>Deeply nested **Rules** block collapsed for readability.
1096
596
 
1097
597
  #### API Specification Validation All Spec Endpoints Fall Through Mode Fall Through Mode Custom Open API Validation Rules API Endpoint
1098
598
 
1099
- An [`api_endpoint`](#endpoint-eb6d3c) block (within [`api_specification.validation_all_spec_endpoints.fall_through_mode.fall_through_mode_custom.open_api_validation_rules`](#rules-7e1bb3)) supports the following:
1100
-
1101
- <a id="methods-782949"></a>&#x2022; [`methods`](#methods-782949) - Optional List Defaults to `ANY`<br>Possible values are `ANY`, `GET`, `HEAD`, `POST`, `PUT`, `DELETE`, `CONNECT`, `OPTIONS`, `TRACE`, `PATCH`, `COPY`<br>[Enum: ANY|GET|HEAD|POST|PUT|DELETE|CONNECT|OPTIONS|TRACE|PATCH|COPY] Methods. Methods to be matched
1102
-
1103
- <a id="path-f12bb6"></a>&#x2022; [`path`](#path-f12bb6) - Optional String<br>Path. Path to be matched
599
+ <a id="deep-96d6ca"></a>Deeply nested **Endpoint** block collapsed for readability.
1104
600
 
1105
601
  #### API Specification Validation All Spec Endpoints Fall Through Mode Fall Through Mode Custom Open API Validation Rules Metadata
1106
602
 
1107
- A [`metadata`](#metadata-868613) block (within [`api_specification.validation_all_spec_endpoints.fall_through_mode.fall_through_mode_custom.open_api_validation_rules`](#rules-7e1bb3)) supports the following:
1108
-
1109
- <a id="spec-d3d0fc"></a>&#x2022; [`description_spec`](#spec-d3d0fc) - Optional String<br>Description. Human readable description
1110
-
1111
- <a id="name-7c2811"></a>&#x2022; [`name`](#name-7c2811) - Optional String<br>Name. This is the name of the message. The value of name has to follow DNS-1035 format
603
+ <a id="deep-d275eb"></a>Deeply nested **Metadata** block collapsed for readability.
1112
604
 
1113
605
  #### API Specification Validation All Spec Endpoints Settings
1114
606
 
@@ -1124,49 +616,23 @@ A [`settings`](#settings-a83a93) block (within [`api_specification.validation_al
1124
616
 
1125
617
  #### API Specification Validation All Spec Endpoints Settings Property Validation Settings Custom
1126
618
 
1127
- A [`property_validation_settings_custom`](#custom-8254df) block (within [`api_specification.validation_all_spec_endpoints.settings`](#settings-a83a93)) supports the following:
1128
-
1129
- <a id="parameters-83e343"></a>&#x2022; [`query_parameters`](#parameters-83e343) - Optional Block<br>Validation Settings For Query Parameters. Custom settings for query parameters validation<br>See [Query Parameters](#parameters-83e343) below.
619
+ <a id="deep-57507d"></a>Deeply nested **Custom** block collapsed for readability.
1130
620
 
1131
621
  #### API Specification Validation All Spec Endpoints Settings Property Validation Settings Custom Query Parameters
1132
622
 
1133
- A [`query_parameters`](#parameters-83e343) block (within [`api_specification.validation_all_spec_endpoints.settings.property_validation_settings_custom`](#custom-8254df)) supports the following:
1134
-
1135
- <a id="parameters-788bd4"></a>&#x2022; [`allow_additional_parameters`](#parameters-788bd4) - Optional Block<br>Enable this option
1136
-
1137
- <a id="parameters-84cc51"></a>&#x2022; [`disallow_additional_parameters`](#parameters-84cc51) - Optional Block<br>Enable this option
623
+ <a id="deep-761ec3"></a>Deeply nested **Parameters** block collapsed for readability.
1138
624
 
1139
625
  #### API Specification Validation All Spec Endpoints Validation Mode
1140
626
 
1141
- A [`validation_mode`](#mode-cd4a1c) block (within [`api_specification.validation_all_spec_endpoints`](#endpoints-4158a4)) supports the following:
1142
-
1143
- <a id="active-df510e"></a>&#x2022; [`response_validation_mode_active`](#active-df510e) - Optional Block<br>Open API Validation Mode Active. Validation mode properties of response<br>See [Response Validation Mode Active](#active-df510e) below.
1144
-
1145
- <a id="validation-5ae35e"></a>&#x2022; [`skip_response_validation`](#validation-5ae35e) - Optional Block<br>Enable this option
1146
-
1147
- <a id="validation-a6bc43"></a>&#x2022; [`skip_validation`](#validation-a6bc43) - Optional Block<br>Enable this option
1148
-
1149
- <a id="active-876e02"></a>&#x2022; [`validation_mode_active`](#active-876e02) - Optional Block<br>Open API Validation Mode Active. Validation mode properties of request<br>See [Validation Mode Active](#active-876e02) below.
627
+ <a id="deep-a84c66"></a>Deeply nested **Mode** block collapsed for readability.
1150
628
 
1151
629
  #### API Specification Validation All Spec Endpoints Validation Mode Response Validation Mode Active
1152
630
 
1153
- A [`response_validation_mode_active`](#active-df510e) block (within [`api_specification.validation_all_spec_endpoints.validation_mode`](#mode-cd4a1c)) supports the following:
1154
-
1155
- <a id="block-ff5c27"></a>&#x2022; [`enforcement_block`](#block-ff5c27) - Optional Block<br>Enable this option
1156
-
1157
- <a id="report-0b6c08"></a>&#x2022; [`enforcement_report`](#report-0b6c08) - Optional Block<br>Enable this option
1158
-
1159
- <a id="properties-138811"></a>&#x2022; [`response_validation_properties`](#properties-138811) - Optional List Defaults to `PROPERTY_QUERY_PARAMETERS`<br>Possible values are `PROPERTY_QUERY_PARAMETERS`, `PROPERTY_PATH_PARAMETERS`, `PROPERTY_CONTENT_TYPE`, `PROPERTY_COOKIE_PARAMETERS`, `PROPERTY_HTTP_HEADERS`, `PROPERTY_HTTP_BODY`, `PROPERTY_SECURITY_SCHEMA`, `PROPERTY_RESPONSE_CODE`<br>[Enum: PROPERTY_QUERY_PARAMETERS|PROPERTY_PATH_PARAMETERS|PROPERTY_CONTENT_TYPE|PROPERTY_COOKIE_PARAMETERS|PROPERTY_HTTP_HEADERS|PROPERTY_HTTP_BODY|PROPERTY_SECURITY_SCHEMA|PROPERTY_RESPONSE_CODE] Response Validation Properties. List of properties of the response to validate according to the OpenAPI specification file (a.k.a. swagger)
631
+ <a id="deep-7d440a"></a>Deeply nested **Active** block collapsed for readability.
1160
632
 
1161
633
  #### API Specification Validation All Spec Endpoints Validation Mode Validation Mode Active
1162
634
 
1163
- A [`validation_mode_active`](#active-876e02) block (within [`api_specification.validation_all_spec_endpoints.validation_mode`](#mode-cd4a1c)) supports the following:
1164
-
1165
- <a id="block-cb8976"></a>&#x2022; [`enforcement_block`](#block-cb8976) - Optional Block<br>Enable this option
1166
-
1167
- <a id="report-c50e43"></a>&#x2022; [`enforcement_report`](#report-c50e43) - Optional Block<br>Enable this option
1168
-
1169
- <a id="properties-029aa9"></a>&#x2022; [`request_validation_properties`](#properties-029aa9) - Optional List Defaults to `PROPERTY_QUERY_PARAMETERS`<br>Possible values are `PROPERTY_QUERY_PARAMETERS`, `PROPERTY_PATH_PARAMETERS`, `PROPERTY_CONTENT_TYPE`, `PROPERTY_COOKIE_PARAMETERS`, `PROPERTY_HTTP_HEADERS`, `PROPERTY_HTTP_BODY`, `PROPERTY_SECURITY_SCHEMA`, `PROPERTY_RESPONSE_CODE`<br>[Enum: PROPERTY_QUERY_PARAMETERS|PROPERTY_PATH_PARAMETERS|PROPERTY_CONTENT_TYPE|PROPERTY_COOKIE_PARAMETERS|PROPERTY_HTTP_HEADERS|PROPERTY_HTTP_BODY|PROPERTY_SECURITY_SCHEMA|PROPERTY_RESPONSE_CODE] Request Validation Properties. List of properties of the request to validate according to the OpenAPI specification file (a.k.a. swagger)
635
+ <a id="deep-dcf3e9"></a>Deeply nested **Active** block collapsed for readability.
1170
636
 
1171
637
  #### API Specification Validation Custom List
1172
638
 
@@ -1180,117 +646,47 @@ A [`validation_custom_list`](#list-23b577) block (within [`api_specification`](#
1180
646
 
1181
647
  #### API Specification Validation Custom List Fall Through Mode
1182
648
 
1183
- A [`fall_through_mode`](#mode-146cc3) block (within [`api_specification.validation_custom_list`](#list-23b577)) supports the following:
1184
-
1185
- <a id="allow-c0dd39"></a>&#x2022; [`fall_through_mode_allow`](#allow-c0dd39) - Optional Block<br>Enable this option
1186
-
1187
- <a id="custom-c29bcd"></a>&#x2022; [`fall_through_mode_custom`](#custom-c29bcd) - Optional Block<br>Custom Fall Through Mode. Define the fall through settings<br>See [Fall Through Mode Custom](#custom-c29bcd) below.
649
+ <a id="deep-08870a"></a>Deeply nested **Mode** block collapsed for readability.
1188
650
 
1189
651
  #### API Specification Validation Custom List Fall Through Mode Fall Through Mode Custom
1190
652
 
1191
- A [`fall_through_mode_custom`](#custom-c29bcd) block (within [`api_specification.validation_custom_list.fall_through_mode`](#mode-146cc3)) supports the following:
1192
-
1193
- <a id="rules-ed6696"></a>&#x2022; [`open_api_validation_rules`](#rules-ed6696) - Optional Block<br>Custom Fall Through Rule List<br>See [Open API Validation Rules](#rules-ed6696) below.
653
+ <a id="deep-1af5fd"></a>Deeply nested **Custom** block collapsed for readability.
1194
654
 
1195
655
  #### API Specification Validation Custom List Fall Through Mode Fall Through Mode Custom Open API Validation Rules
1196
656
 
1197
- An [`open_api_validation_rules`](#rules-ed6696) block (within [`api_specification.validation_custom_list.fall_through_mode.fall_through_mode_custom`](#custom-c29bcd)) supports the following:
1198
-
1199
- <a id="block-31614e"></a>&#x2022; [`action_block`](#block-31614e) - Optional Block<br>Enable this option
1200
-
1201
- <a id="report-e29f47"></a>&#x2022; [`action_report`](#report-e29f47) - Optional Block<br>Enable this option
1202
-
1203
- <a id="skip-c4580b"></a>&#x2022; [`action_skip`](#skip-c4580b) - Optional Block<br>Enable this option
1204
-
1205
- <a id="endpoint-997b3f"></a>&#x2022; [`api_endpoint`](#endpoint-997b3f) - Optional Block<br>API Endpoint. This defines API endpoint<br>See [API Endpoint](#endpoint-997b3f) below.
1206
-
1207
- <a id="group-e515e8"></a>&#x2022; [`api_group`](#group-e515e8) - Optional String<br>API Group. The API group which this validation applies to
1208
-
1209
- <a id="path-835b18"></a>&#x2022; [`base_path`](#path-835b18) - Optional String<br>Base Path. The base path which this validation applies to
1210
-
1211
- <a id="metadata-6c686f"></a>&#x2022; [`metadata`](#metadata-6c686f) - Optional Block<br>Message Metadata. 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 and replace APIs<br>See [Metadata](#metadata-6c686f) below.
657
+ <a id="deep-e08601"></a>Deeply nested **Rules** block collapsed for readability.
1212
658
 
1213
659
  #### API Specification Validation Custom List Fall Through Mode Fall Through Mode Custom Open API Validation Rules API Endpoint
1214
660
 
1215
- An [`api_endpoint`](#endpoint-997b3f) block (within [`api_specification.validation_custom_list.fall_through_mode.fall_through_mode_custom.open_api_validation_rules`](#rules-ed6696)) supports the following:
1216
-
1217
- <a id="methods-9c3511"></a>&#x2022; [`methods`](#methods-9c3511) - Optional List Defaults to `ANY`<br>Possible values are `ANY`, `GET`, `HEAD`, `POST`, `PUT`, `DELETE`, `CONNECT`, `OPTIONS`, `TRACE`, `PATCH`, `COPY`<br>[Enum: ANY|GET|HEAD|POST|PUT|DELETE|CONNECT|OPTIONS|TRACE|PATCH|COPY] Methods. Methods to be matched
1218
-
1219
- <a id="path-0f1169"></a>&#x2022; [`path`](#path-0f1169) - Optional String<br>Path. Path to be matched
661
+ <a id="deep-f88a1e"></a>Deeply nested **Endpoint** block collapsed for readability.
1220
662
 
1221
663
  #### API Specification Validation Custom List Fall Through Mode Fall Through Mode Custom Open API Validation Rules Metadata
1222
664
 
1223
- A [`metadata`](#metadata-6c686f) block (within [`api_specification.validation_custom_list.fall_through_mode.fall_through_mode_custom.open_api_validation_rules`](#rules-ed6696)) supports the following:
1224
-
1225
- <a id="spec-a68d3b"></a>&#x2022; [`description_spec`](#spec-a68d3b) - Optional String<br>Description. Human readable description
1226
-
1227
- <a id="name-f578bb"></a>&#x2022; [`name`](#name-f578bb) - Optional String<br>Name. This is the name of the message. The value of name has to follow DNS-1035 format
665
+ <a id="deep-8b9a6c"></a>Deeply nested **Metadata** block collapsed for readability.
1228
666
 
1229
667
  #### API Specification Validation Custom List Open API Validation Rules
1230
668
 
1231
- An [`open_api_validation_rules`](#rules-f51668) block (within [`api_specification.validation_custom_list`](#list-23b577)) supports the following:
1232
-
1233
- <a id="domain-b31fd1"></a>&#x2022; [`any_domain`](#domain-b31fd1) - Optional Block<br>Enable this option
1234
-
1235
- <a id="endpoint-1f50db"></a>&#x2022; [`api_endpoint`](#endpoint-1f50db) - Optional Block<br>API Endpoint. This defines API endpoint<br>See [API Endpoint](#endpoint-1f50db) below.
1236
-
1237
- <a id="group-ba8ad2"></a>&#x2022; [`api_group`](#group-ba8ad2) - Optional String<br>API Group. The API group which this validation applies to
1238
-
1239
- <a id="path-ca1339"></a>&#x2022; [`base_path`](#path-ca1339) - Optional String<br>Base Path. The base path which this validation applies to
1240
-
1241
- <a id="metadata-304b10"></a>&#x2022; [`metadata`](#metadata-304b10) - Optional Block<br>Message Metadata. 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 and replace APIs<br>See [Metadata](#metadata-304b10) below.
1242
-
1243
- <a id="domain-221c29"></a>&#x2022; [`specific_domain`](#domain-221c29) - Optional String<br>Specific Domain. The rule will apply for a specific domain
1244
-
1245
- <a id="mode-79470e"></a>&#x2022; [`validation_mode`](#mode-79470e) - Optional Block<br>Validation Mode.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-79470e) below.
669
+ <a id="deep-59b908"></a>Deeply nested **Rules** block collapsed for readability.
1246
670
 
1247
671
  #### API Specification Validation Custom List Open API Validation Rules API Endpoint
1248
672
 
1249
- An [`api_endpoint`](#endpoint-1f50db) block (within [`api_specification.validation_custom_list.open_api_validation_rules`](#rules-f51668)) supports the following:
1250
-
1251
- <a id="methods-acc02e"></a>&#x2022; [`methods`](#methods-acc02e) - Optional List Defaults to `ANY`<br>Possible values are `ANY`, `GET`, `HEAD`, `POST`, `PUT`, `DELETE`, `CONNECT`, `OPTIONS`, `TRACE`, `PATCH`, `COPY`<br>[Enum: ANY|GET|HEAD|POST|PUT|DELETE|CONNECT|OPTIONS|TRACE|PATCH|COPY] Methods. Methods to be matched
1252
-
1253
- <a id="path-cb14d1"></a>&#x2022; [`path`](#path-cb14d1) - Optional String<br>Path. Path to be matched
673
+ <a id="deep-287681"></a>Deeply nested **Endpoint** block collapsed for readability.
1254
674
 
1255
675
  #### API Specification Validation Custom List Open API Validation Rules Metadata
1256
676
 
1257
- A [`metadata`](#metadata-304b10) block (within [`api_specification.validation_custom_list.open_api_validation_rules`](#rules-f51668)) supports the following:
1258
-
1259
- <a id="spec-cef192"></a>&#x2022; [`description_spec`](#spec-cef192) - Optional String<br>Description. Human readable description
1260
-
1261
- <a id="name-5500dd"></a>&#x2022; [`name`](#name-5500dd) - Optional String<br>Name. This is the name of the message. The value of name has to follow DNS-1035 format
677
+ <a id="deep-bdc351"></a>Deeply nested **Metadata** block collapsed for readability.
1262
678
 
1263
679
  #### API Specification Validation Custom List Open API Validation Rules Validation Mode
1264
680
 
1265
- A [`validation_mode`](#mode-79470e) block (within [`api_specification.validation_custom_list.open_api_validation_rules`](#rules-f51668)) supports the following:
1266
-
1267
- <a id="active-871b48"></a>&#x2022; [`response_validation_mode_active`](#active-871b48) - Optional Block<br>Open API Validation Mode Active. Validation mode properties of response<br>See [Response Validation Mode Active](#active-871b48) below.
1268
-
1269
- <a id="validation-6f1b64"></a>&#x2022; [`skip_response_validation`](#validation-6f1b64) - Optional Block<br>Enable this option
1270
-
1271
- <a id="validation-902520"></a>&#x2022; [`skip_validation`](#validation-902520) - Optional Block<br>Enable this option
1272
-
1273
- <a id="active-984dc6"></a>&#x2022; [`validation_mode_active`](#active-984dc6) - Optional Block<br>Open API Validation Mode Active. Validation mode properties of request<br>See [Validation Mode Active](#active-984dc6) below.
681
+ <a id="deep-e4ce7e"></a>Deeply nested **Mode** block collapsed for readability.
1274
682
 
1275
683
  #### API Specification Validation Custom List Open API Validation Rules Validation Mode Response Validation Mode Active
1276
684
 
1277
- A [`response_validation_mode_active`](#active-871b48) block (within [`api_specification.validation_custom_list.open_api_validation_rules.validation_mode`](#mode-79470e)) supports the following:
1278
-
1279
- <a id="block-410bdc"></a>&#x2022; [`enforcement_block`](#block-410bdc) - Optional Block<br>Enable this option
1280
-
1281
- <a id="report-129a90"></a>&#x2022; [`enforcement_report`](#report-129a90) - Optional Block<br>Enable this option
1282
-
1283
- <a id="properties-b162cc"></a>&#x2022; [`response_validation_properties`](#properties-b162cc) - Optional List Defaults to `PROPERTY_QUERY_PARAMETERS`<br>Possible values are `PROPERTY_QUERY_PARAMETERS`, `PROPERTY_PATH_PARAMETERS`, `PROPERTY_CONTENT_TYPE`, `PROPERTY_COOKIE_PARAMETERS`, `PROPERTY_HTTP_HEADERS`, `PROPERTY_HTTP_BODY`, `PROPERTY_SECURITY_SCHEMA`, `PROPERTY_RESPONSE_CODE`<br>[Enum: PROPERTY_QUERY_PARAMETERS|PROPERTY_PATH_PARAMETERS|PROPERTY_CONTENT_TYPE|PROPERTY_COOKIE_PARAMETERS|PROPERTY_HTTP_HEADERS|PROPERTY_HTTP_BODY|PROPERTY_SECURITY_SCHEMA|PROPERTY_RESPONSE_CODE] Response Validation Properties. List of properties of the response to validate according to the OpenAPI specification file (a.k.a. swagger)
685
+ <a id="deep-c312ba"></a>Deeply nested **Active** block collapsed for readability.
1284
686
 
1285
687
  #### API Specification Validation Custom List Open API Validation Rules Validation Mode Validation Mode Active
1286
688
 
1287
- A [`validation_mode_active`](#active-984dc6) block (within [`api_specification.validation_custom_list.open_api_validation_rules.validation_mode`](#mode-79470e)) supports the following:
1288
-
1289
- <a id="block-d25b95"></a>&#x2022; [`enforcement_block`](#block-d25b95) - Optional Block<br>Enable this option
1290
-
1291
- <a id="report-dda104"></a>&#x2022; [`enforcement_report`](#report-dda104) - Optional Block<br>Enable this option
1292
-
1293
- <a id="properties-aae899"></a>&#x2022; [`request_validation_properties`](#properties-aae899) - Optional List Defaults to `PROPERTY_QUERY_PARAMETERS`<br>Possible values are `PROPERTY_QUERY_PARAMETERS`, `PROPERTY_PATH_PARAMETERS`, `PROPERTY_CONTENT_TYPE`, `PROPERTY_COOKIE_PARAMETERS`, `PROPERTY_HTTP_HEADERS`, `PROPERTY_HTTP_BODY`, `PROPERTY_SECURITY_SCHEMA`, `PROPERTY_RESPONSE_CODE`<br>[Enum: PROPERTY_QUERY_PARAMETERS|PROPERTY_PATH_PARAMETERS|PROPERTY_CONTENT_TYPE|PROPERTY_COOKIE_PARAMETERS|PROPERTY_HTTP_HEADERS|PROPERTY_HTTP_BODY|PROPERTY_SECURITY_SCHEMA|PROPERTY_RESPONSE_CODE] Request Validation Properties. List of properties of the request to validate according to the OpenAPI specification file (a.k.a. swagger)
689
+ <a id="deep-0ccdf9"></a>Deeply nested **Active** block collapsed for readability.
1294
690
 
1295
691
  #### API Specification Validation Custom List Settings
1296
692
 
@@ -1306,27 +702,15 @@ A [`settings`](#settings-940e64) block (within [`api_specification.validation_cu
1306
702
 
1307
703
  #### API Specification Validation Custom List Settings Property Validation Settings Custom
1308
704
 
1309
- A [`property_validation_settings_custom`](#custom-8e6ea6) block (within [`api_specification.validation_custom_list.settings`](#settings-940e64)) supports the following:
1310
-
1311
- <a id="parameters-bb35d2"></a>&#x2022; [`query_parameters`](#parameters-bb35d2) - Optional Block<br>Validation Settings For Query Parameters. Custom settings for query parameters validation<br>See [Query Parameters](#parameters-bb35d2) below.
705
+ <a id="deep-c74d74"></a>Deeply nested **Custom** block collapsed for readability.
1312
706
 
1313
707
  #### API Specification Validation Custom List Settings Property Validation Settings Custom Query Parameters
1314
708
 
1315
- A [`query_parameters`](#parameters-bb35d2) block (within [`api_specification.validation_custom_list.settings.property_validation_settings_custom`](#custom-8e6ea6)) supports the following:
1316
-
1317
- <a id="parameters-547273"></a>&#x2022; [`allow_additional_parameters`](#parameters-547273) - Optional Block<br>Enable this option
1318
-
1319
- <a id="parameters-22e36d"></a>&#x2022; [`disallow_additional_parameters`](#parameters-22e36d) - Optional Block<br>Enable this option
709
+ <a id="deep-b42c34"></a>Deeply nested **Parameters** block collapsed for readability.
1320
710
 
1321
711
  #### App Firewall
1322
712
 
1323
- An [`app_firewall`](#app-firewall) block supports the following:
1324
-
1325
- <a id="app-firewall-name"></a>&#x2022; [`name`](#app-firewall-name) - Optional String<br>Name. 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
1326
-
1327
- <a id="app-firewall-namespace"></a>&#x2022; [`namespace`](#app-firewall-namespace) - Optional String<br>Namespace. 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
1328
-
1329
- <a id="app-firewall-tenant"></a>&#x2022; [`tenant`](#app-firewall-tenant) - Optional String<br>Tenant. 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
713
+ <a id="objref-f225e5"></a>Uses standard [Object Reference](#common-object-reference) fields (name, namespace, tenant).
1330
714
 
1331
715
  #### Blocked Clients
1332
716
 
@@ -1426,51 +810,23 @@ A [`js_insert_all_pages`](#bot-defense-policy-js-insert-all-pages) block (within
1426
810
 
1427
811
  #### Bot Defense Policy Js Insert All Pages Except
1428
812
 
1429
- A [`js_insert_all_pages_except`](#except-2f0f51) block (within [`bot_defense.policy`](#bot-defense-policy)) supports the following:
1430
-
1431
- <a id="list-c11e8a"></a>&#x2022; [`exclude_list`](#list-c11e8a) - Optional Block<br>Exclude Pages. Optional JavaScript insertions exclude list of domain and path matchers<br>See [Exclude List](#list-c11e8a) below.
1432
-
1433
- <a id="location-7d08dc"></a>&#x2022; [`javascript_location`](#location-7d08dc) - 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] JavaScript Location. All inside networks. Insert JavaScript after `<head>` tag Insert JavaScript after `</title>` tag. Insert JavaScript before first `<script>` tag
813
+ <a id="deep-5eada5"></a>Deeply nested **Except** block collapsed for readability.
1434
814
 
1435
815
  #### Bot Defense Policy Js Insert All Pages Except Exclude List
1436
816
 
1437
- An [`exclude_list`](#list-c11e8a) block (within [`bot_defense.policy.js_insert_all_pages_except`](#except-2f0f51)) supports the following:
1438
-
1439
- <a id="domain-73ce27"></a>&#x2022; [`any_domain`](#domain-73ce27) - Optional Block<br>Enable this option
1440
-
1441
- <a id="domain-503442"></a>&#x2022; [`domain`](#domain-503442) - Optional Block<br>Domains. Domains names<br>See [Domain](#domain-503442) below.
1442
-
1443
- <a id="metadata-f70b11"></a>&#x2022; [`metadata`](#metadata-f70b11) - Optional Block<br>Message Metadata. 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 and replace APIs<br>See [Metadata](#metadata-f70b11) below.
1444
-
1445
- <a id="path-e8b4e3"></a>&#x2022; [`path`](#path-e8b4e3) - Optional Block<br>Path to Match. Path match of the URI can be either be, Prefix match or exact match or regular expression match<br>See [Path](#path-e8b4e3) below.
817
+ <a id="deep-cc9d4f"></a>Deeply nested **List** block collapsed for readability.
1446
818
 
1447
819
  #### Bot Defense Policy Js Insert All Pages Except Exclude List Domain
1448
820
 
1449
- A [`domain`](#domain-503442) block (within [`bot_defense.policy.js_insert_all_pages_except.exclude_list`](#list-c11e8a)) supports the following:
1450
-
1451
- <a id="value-64604c"></a>&#x2022; [`exact_value`](#value-64604c) - Optional String<br>Exact Value. Exact domain name
1452
-
1453
- <a id="value-a33f5c"></a>&#x2022; [`regex_value`](#value-a33f5c) - Optional String<br>Regex Values of Domains. Regular Expression value for the domain name
1454
-
1455
- <a id="value-ae4d1e"></a>&#x2022; [`suffix_value`](#value-ae4d1e) - Optional String<br>Suffix Value. Suffix of domain name e.g 'xyz.com' will match '*.xyz.com' and 'xyz.com'
821
+ <a id="deep-58ae8c"></a>Deeply nested **Domain** block collapsed for readability.
1456
822
 
1457
823
  #### Bot Defense Policy Js Insert All Pages Except Exclude List Metadata
1458
824
 
1459
- A [`metadata`](#metadata-f70b11) block (within [`bot_defense.policy.js_insert_all_pages_except.exclude_list`](#list-c11e8a)) supports the following:
1460
-
1461
- <a id="spec-aabb87"></a>&#x2022; [`description_spec`](#spec-aabb87) - Optional String<br>Description. Human readable description
1462
-
1463
- <a id="name-644012"></a>&#x2022; [`name`](#name-644012) - Optional String<br>Name. This is the name of the message. The value of name has to follow DNS-1035 format
825
+ <a id="deep-ac7397"></a>Deeply nested **Metadata** block collapsed for readability.
1464
826
 
1465
827
  #### Bot Defense Policy Js Insert All Pages Except Exclude List Path
1466
828
 
1467
- A [`path`](#path-e8b4e3) block (within [`bot_defense.policy.js_insert_all_pages_except.exclude_list`](#list-c11e8a)) supports the following:
1468
-
1469
- <a id="path-39fb60"></a>&#x2022; [`path`](#path-39fb60) - Optional String<br>Exact. Exact path value to match
1470
-
1471
- <a id="prefix-fe375b"></a>&#x2022; [`prefix`](#prefix-fe375b) - Optional String<br>Prefix. Path prefix to match (e.g. the value / will match on all paths)
1472
-
1473
- <a id="regex-93d4f7"></a>&#x2022; [`regex`](#regex-93d4f7) - Optional String<br>Regex. Regular expression of path match (e.g. the value .* will match on all paths)
829
+ <a id="deep-9d17be"></a>Deeply nested **Path** block collapsed for readability.
1474
830
 
1475
831
  #### Bot Defense Policy Js Insertion Rules
1476
832
 
@@ -1482,43 +838,19 @@ A [`js_insertion_rules`](#bot-defense-policy-js-insertion-rules) block (within [
1482
838
 
1483
839
  #### Bot Defense Policy Js Insertion Rules Exclude List
1484
840
 
1485
- An [`exclude_list`](#list-51668b) block (within [`bot_defense.policy.js_insertion_rules`](#bot-defense-policy-js-insertion-rules)) supports the following:
1486
-
1487
- <a id="domain-090b66"></a>&#x2022; [`any_domain`](#domain-090b66) - Optional Block<br>Enable this option
1488
-
1489
- <a id="domain-47cfd3"></a>&#x2022; [`domain`](#domain-47cfd3) - Optional Block<br>Domains. Domains names<br>See [Domain](#domain-47cfd3) below.
1490
-
1491
- <a id="metadata-7d33fd"></a>&#x2022; [`metadata`](#metadata-7d33fd) - Optional Block<br>Message Metadata. 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 and replace APIs<br>See [Metadata](#metadata-7d33fd) below.
1492
-
1493
- <a id="path-a9cb42"></a>&#x2022; [`path`](#path-a9cb42) - Optional Block<br>Path to Match. Path match of the URI can be either be, Prefix match or exact match or regular expression match<br>See [Path](#path-a9cb42) below.
841
+ <a id="deep-5976c7"></a>Deeply nested **List** block collapsed for readability.
1494
842
 
1495
843
  #### Bot Defense Policy Js Insertion Rules Exclude List Domain
1496
844
 
1497
- A [`domain`](#domain-47cfd3) block (within [`bot_defense.policy.js_insertion_rules.exclude_list`](#list-51668b)) supports the following:
1498
-
1499
- <a id="value-19618a"></a>&#x2022; [`exact_value`](#value-19618a) - Optional String<br>Exact Value. Exact domain name
1500
-
1501
- <a id="value-84ab50"></a>&#x2022; [`regex_value`](#value-84ab50) - Optional String<br>Regex Values of Domains. Regular Expression value for the domain name
1502
-
1503
- <a id="value-f83edf"></a>&#x2022; [`suffix_value`](#value-f83edf) - Optional String<br>Suffix Value. Suffix of domain name e.g 'xyz.com' will match '*.xyz.com' and 'xyz.com'
845
+ <a id="deep-c9a8a1"></a>Deeply nested **Domain** block collapsed for readability.
1504
846
 
1505
847
  #### Bot Defense Policy Js Insertion Rules Exclude List Metadata
1506
848
 
1507
- A [`metadata`](#metadata-7d33fd) block (within [`bot_defense.policy.js_insertion_rules.exclude_list`](#list-51668b)) supports the following:
1508
-
1509
- <a id="spec-1f6f3a"></a>&#x2022; [`description_spec`](#spec-1f6f3a) - Optional String<br>Description. Human readable description
1510
-
1511
- <a id="name-487812"></a>&#x2022; [`name`](#name-487812) - Optional String<br>Name. This is the name of the message. The value of name has to follow DNS-1035 format
849
+ <a id="deep-4b3d6a"></a>Deeply nested **Metadata** block collapsed for readability.
1512
850
 
1513
851
  #### Bot Defense Policy Js Insertion Rules Exclude List Path
1514
852
 
1515
- A [`path`](#path-a9cb42) block (within [`bot_defense.policy.js_insertion_rules.exclude_list`](#list-51668b)) supports the following:
1516
-
1517
- <a id="path-0e9a9e"></a>&#x2022; [`path`](#path-0e9a9e) - Optional String<br>Exact. Exact path value to match
1518
-
1519
- <a id="prefix-635824"></a>&#x2022; [`prefix`](#prefix-635824) - Optional String<br>Prefix. Path prefix to match (e.g. the value / will match on all paths)
1520
-
1521
- <a id="regex-1d9ec1"></a>&#x2022; [`regex`](#regex-1d9ec1) - Optional String<br>Regex. Regular expression of path match (e.g. the value .* will match on all paths)
853
+ <a id="deep-fa04d6"></a>Deeply nested **Path** block collapsed for readability.
1522
854
 
1523
855
  #### Bot Defense Policy Js Insertion Rules Rules
1524
856
 
@@ -1536,31 +868,15 @@ A [`rules`](#rules-15d983) block (within [`bot_defense.policy.js_insertion_rules
1536
868
 
1537
869
  #### Bot Defense Policy Js Insertion Rules Rules Domain
1538
870
 
1539
- A [`domain`](#domain-834b0f) block (within [`bot_defense.policy.js_insertion_rules.rules`](#rules-15d983)) supports the following:
1540
-
1541
- <a id="value-761413"></a>&#x2022; [`exact_value`](#value-761413) - Optional String<br>Exact Value. Exact domain name
1542
-
1543
- <a id="value-626e98"></a>&#x2022; [`regex_value`](#value-626e98) - Optional String<br>Regex Values of Domains. Regular Expression value for the domain name
1544
-
1545
- <a id="value-a64bf5"></a>&#x2022; [`suffix_value`](#value-a64bf5) - Optional String<br>Suffix Value. Suffix of domain name e.g 'xyz.com' will match '*.xyz.com' and 'xyz.com'
871
+ <a id="deep-72024a"></a>Deeply nested **Domain** block collapsed for readability.
1546
872
 
1547
873
  #### Bot Defense Policy Js Insertion Rules Rules Metadata
1548
874
 
1549
- A [`metadata`](#metadata-e15703) block (within [`bot_defense.policy.js_insertion_rules.rules`](#rules-15d983)) supports the following:
1550
-
1551
- <a id="spec-bd4771"></a>&#x2022; [`description_spec`](#spec-bd4771) - Optional String<br>Description. Human readable description
1552
-
1553
- <a id="name-1bd3d4"></a>&#x2022; [`name`](#name-1bd3d4) - Optional String<br>Name. This is the name of the message. The value of name has to follow DNS-1035 format
875
+ <a id="deep-e9d554"></a>Deeply nested **Metadata** block collapsed for readability.
1554
876
 
1555
877
  #### Bot Defense Policy Js Insertion Rules Rules Path
1556
878
 
1557
- A [`path`](#path-711518) block (within [`bot_defense.policy.js_insertion_rules.rules`](#rules-15d983)) supports the following:
1558
-
1559
- <a id="path-6d550e"></a>&#x2022; [`path`](#path-6d550e) - Optional String<br>Exact. Exact path value to match
1560
-
1561
- <a id="prefix-cee2d1"></a>&#x2022; [`prefix`](#prefix-cee2d1) - Optional String<br>Prefix. Path prefix to match (e.g. the value / will match on all paths)
1562
-
1563
- <a id="regex-597dd8"></a>&#x2022; [`regex`](#regex-597dd8) - Optional String<br>Regex. Regular expression of path match (e.g. the value .* will match on all paths)
879
+ <a id="deep-3fdb24"></a>Deeply nested **Path** block collapsed for readability.
1564
880
 
1565
881
  #### Bot Defense Policy Mobile Sdk Config
1566
882
 
@@ -1570,31 +886,15 @@ A [`mobile_sdk_config`](#bot-defense-policy-mobile-sdk-config) block (within [`b
1570
886
 
1571
887
  #### Bot Defense Policy Mobile Sdk Config Mobile Identifier
1572
888
 
1573
- A [`mobile_identifier`](#identifier-e34e48) block (within [`bot_defense.policy.mobile_sdk_config`](#bot-defense-policy-mobile-sdk-config)) supports the following:
1574
-
1575
- <a id="headers-529e3c"></a>&#x2022; [`headers`](#headers-529e3c) - Optional Block<br>Headers. Headers that can be used to identify mobile traffic<br>See [Headers](#headers-529e3c) below.
889
+ <a id="deep-8f9ee4"></a>Deeply nested **Identifier** block collapsed for readability.
1576
890
 
1577
891
  #### Bot Defense Policy Mobile Sdk Config Mobile Identifier Headers
1578
892
 
1579
- A [`headers`](#headers-529e3c) block (within [`bot_defense.policy.mobile_sdk_config.mobile_identifier`](#identifier-e34e48)) supports the following:
1580
-
1581
- <a id="present-c23fa6"></a>&#x2022; [`check_not_present`](#present-c23fa6) - Optional Block<br>Enable this option
1582
-
1583
- <a id="present-1d1c99"></a>&#x2022; [`check_present`](#present-1d1c99) - Optional Block<br>Enable this option
1584
-
1585
- <a id="item-6622e2"></a>&#x2022; [`item`](#item-6622e2) - Optional Block<br>Matcher. A 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-6622e2) below.
1586
-
1587
- <a id="name-581daa"></a>&#x2022; [`name`](#name-581daa) - Optional String<br>Header Name. A case-insensitive HTTP header name
893
+ <a id="deep-235998"></a>Deeply nested **Headers** block collapsed for readability.
1588
894
 
1589
895
  #### Bot Defense Policy Mobile Sdk Config Mobile Identifier Headers Item
1590
896
 
1591
- An [`item`](#item-6622e2) block (within [`bot_defense.policy.mobile_sdk_config.mobile_identifier.headers`](#headers-529e3c)) supports the following:
1592
-
1593
- <a id="values-f1a647"></a>&#x2022; [`exact_values`](#values-f1a647) - Optional List<br>Exact Values. A list of exact values to match the input against
1594
-
1595
- <a id="values-102e01"></a>&#x2022; [`regex_values`](#values-102e01) - Optional List<br>Regex Values. A list of regular expressions to match the input against
1596
-
1597
- <a id="transformers-e54cc5"></a>&#x2022; [`transformers`](#transformers-e54cc5) - Optional List Defaults to `TRANSFORMER_NONE`<br>Possible values are `LOWER_CASE`, `UPPER_CASE`, `BASE64_DECODE`, `NORMALIZE_PATH`, `REMOVE_WHITESPACE`, `URL_DECODE`, `TRIM_LEFT`, `TRIM_RIGHT`, `TRIM`<br>[Enum: LOWER_CASE|UPPER_CASE|BASE64_DECODE|NORMALIZE_PATH|REMOVE_WHITESPACE|URL_DECODE|TRIM_LEFT|TRIM_RIGHT|TRIM] Transformers. An ordered list of transformers (starting from index 0) to be applied to the path before matching
897
+ <a id="deep-ba14c6"></a>Deeply nested **Item** block collapsed for readability.
1598
898
 
1599
899
  #### Bot Defense Policy Protected App Endpoints
1600
900
 
@@ -1644,143 +944,51 @@ A [`domain`](#domain-18bf1a) block (within [`bot_defense.policy.protected_app_en
1644
944
 
1645
945
  #### Bot Defense Policy Protected App Endpoints Flow Label
1646
946
 
1647
- A [`flow_label`](#label-244fef) block (within [`bot_defense.policy.protected_app_endpoints`](#endpoints-01a2f3)) supports the following:
1648
-
1649
- <a id="management-d237e9"></a>&#x2022; [`account_management`](#management-d237e9) - Optional Block<br>Bot Defense Flow Label Account Management Category. Bot Defense Flow Label Account Management Category<br>See [Account Management](#management-d237e9) below.
1650
-
1651
- <a id="authentication-60331f"></a>&#x2022; [`authentication`](#authentication-60331f) - Optional Block<br>Bot Defense Flow Label Authentication Category. Bot Defense Flow Label Authentication Category<br>See [Authentication](#authentication-60331f) below.
1652
-
1653
- <a id="services-acd29e"></a>&#x2022; [`financial_services`](#services-acd29e) - Optional Block<br>Bot Defense Flow Label Financial Services Category. Bot Defense Flow Label Financial Services Category<br>See [Financial Services](#services-acd29e) below.
1654
-
1655
- <a id="flight-0c8cf6"></a>&#x2022; [`flight`](#flight-0c8cf6) - Optional Block<br>Bot Defense Flow Label Flight Category. Bot Defense Flow Label Flight Category<br>See [Flight](#flight-0c8cf6) below.
1656
-
1657
- <a id="management-9be6b5"></a>&#x2022; [`profile_management`](#management-9be6b5) - Optional Block<br>Bot Defense Flow Label Profile Management Category. Bot Defense Flow Label Profile Management Category<br>See [Profile Management](#management-9be6b5) below.
1658
-
1659
- <a id="search-d60360"></a>&#x2022; [`search`](#search-d60360) - Optional Block<br>Bot Defense Flow Label Search Category. Bot Defense Flow Label Search Category<br>See [Search](#search-d60360) below.
1660
-
1661
- <a id="cards-f10d47"></a>&#x2022; [`shopping_gift_cards`](#cards-f10d47) - Optional Block<br>Bot Defense Flow Label Shopping & Gift Cards Category. Bot Defense Flow Label Shopping & Gift Cards Category<br>See [Shopping Gift Cards](#cards-f10d47) below.
947
+ <a id="deep-aedbc5"></a>Deeply nested **Label** block collapsed for readability.
1662
948
 
1663
949
  #### Bot Defense Policy Protected App Endpoints Flow Label Account Management
1664
950
 
1665
- An [`account_management`](#management-d237e9) block (within [`bot_defense.policy.protected_app_endpoints.flow_label`](#label-244fef)) supports the following:
1666
-
1667
- <a id="create-c8c685"></a>&#x2022; [`create`](#create-c8c685) - Optional Block<br>Enable this option
1668
-
1669
- <a id="reset-862ec4"></a>&#x2022; [`password_reset`](#reset-862ec4) - Optional Block<br>Enable this option
951
+ <a id="deep-e2bcec"></a>Deeply nested **Management** block collapsed for readability.
1670
952
 
1671
953
  #### Bot Defense Policy Protected App Endpoints Flow Label Authentication
1672
954
 
1673
- An [`authentication`](#authentication-60331f) block (within [`bot_defense.policy.protected_app_endpoints.flow_label`](#label-244fef)) supports the following:
1674
-
1675
- <a id="login-79d094"></a>&#x2022; [`login`](#login-79d094) - Optional Block<br>Bot Defense Transaction Result. Bot Defense Transaction Result<br>See [Login](#login-79d094) below.
1676
-
1677
- <a id="mfa-43e4fe"></a>&#x2022; [`login_mfa`](#mfa-43e4fe) - Optional Block<br>Enable this option
1678
-
1679
- <a id="partner-c06e70"></a>&#x2022; [`login_partner`](#partner-c06e70) - Optional Block<br>Enable this option
1680
-
1681
- <a id="logout-01c637"></a>&#x2022; [`logout`](#logout-01c637) - Optional Block<br>Enable this option
1682
-
1683
- <a id="refresh-89934b"></a>&#x2022; [`token_refresh`](#refresh-89934b) - Optional Block<br>Enable this option
955
+ <a id="deep-9d3bff"></a>Deeply nested **Authentication** block collapsed for readability.
1684
956
 
1685
957
  #### Bot Defense Policy Protected App Endpoints Flow Label Authentication Login
1686
958
 
1687
- A [`login`](#login-79d094) block (within [`bot_defense.policy.protected_app_endpoints.flow_label.authentication`](#authentication-60331f)) supports the following:
1688
-
1689
- <a id="result-60e1f0"></a>&#x2022; [`disable_transaction_result`](#result-60e1f0) - Optional Block<br>Enable this option
1690
-
1691
- <a id="result-c2e927"></a>&#x2022; [`transaction_result`](#result-c2e927) - Optional Block<br>Bot Defense Transaction Result Type. Bot Defense Transaction ResultType<br>See [Transaction Result](#result-c2e927) below.
959
+ <a id="deep-f6b65a"></a>Deeply nested **Login** block collapsed for readability.
1692
960
 
1693
961
  #### Bot Defense Policy Protected App Endpoints Flow Label Authentication Login Transaction Result
1694
962
 
1695
- A [`transaction_result`](#result-c2e927) block (within [`bot_defense.policy.protected_app_endpoints.flow_label.authentication.login`](#login-79d094)) supports the following:
1696
-
1697
- <a id="conditions-86ce87"></a>&#x2022; [`failure_conditions`](#conditions-86ce87) - Optional Block<br>Failure Conditions. Failure Conditions<br>See [Failure Conditions](#conditions-86ce87) below.
1698
-
1699
- <a id="conditions-0b5152"></a>&#x2022; [`success_conditions`](#conditions-0b5152) - Optional Block<br>Success Conditions. Success Conditions<br>See [Success Conditions](#conditions-0b5152) below.
963
+ <a id="deep-1cd500"></a>Deeply nested **Result** block collapsed for readability.
1700
964
 
1701
965
  #### Bot Defense Policy Protected App Endpoints Flow Label Authentication Login Transaction Result Failure Conditions
1702
966
 
1703
- A [`failure_conditions`](#conditions-86ce87) block (within [`bot_defense.policy.protected_app_endpoints.flow_label.authentication.login.transaction_result`](#result-c2e927)) supports the following:
1704
-
1705
- <a id="name-eed9c2"></a>&#x2022; [`name`](#name-eed9c2) - Optional String<br>Header Name. A case-insensitive HTTP header name
1706
-
1707
- <a id="values-15e71a"></a>&#x2022; [`regex_values`](#values-15e71a) - Optional List<br>Regex Values. A list of regular expressions to match the input against
1708
-
1709
- <a id="status-b492f7"></a>&#x2022; [`status`](#status-b492f7) - Optional String Defaults to `EmptyStatusCode`<br>Possible values are `EmptyStatusCode`, `Continue`, `OK`, `Created`, `Accepted`, `NonAuthoritativeInformation`, `NoContent`, `ResetContent`, `PartialContent`, `MultiStatus`, `AlreadyReported`, `IMUsed`, `MultipleChoices`, `MovedPermanently`, `Found`, `SeeOther`, `NotModified`, `UseProxy`, `TemporaryRedirect`, `PermanentRedirect`, `BadRequest`, `Unauthorized`, `PaymentRequired`, `Forbidden`, `NotFound`, `MethodNotAllowed`, `NotAcceptable`, `ProxyAuthenticationRequired`, `RequestTimeout`, `Conflict`, `Gone`, `LengthRequired`, `PreconditionFailed`, `PayloadTooLarge`, `URITooLong`, `UnsupportedMediaType`, `RangeNotSatisfiable`, `ExpectationFailed`, `MisdirectedRequest`, `UnprocessableEntity`, `Locked`, `FailedDependency`, `UpgradeRequired`, `PreconditionRequired`, `TooManyRequests`, `RequestHeaderFieldsTooLarge`, `InternalServerError`, `NotImplemented`, `BadGateway`, `ServiceUnavailable`, `GatewayTimeout`, `HTTPVersionNotSupported`, `VariantAlsoNegotiates`, `InsufficientStorage`, `LoopDetected`, `NotExtended`, `NetworkAuthenticationRequired`<br>[Enum: EmptyStatusCode|Continue|OK|Created|Accepted|NonAuthoritativeInformation|NoContent|ResetContent|PartialContent|MultiStatus|AlreadyReported|IMUsed|MultipleChoices|MovedPermanently|Found|SeeOther|NotModified|UseProxy|TemporaryRedirect|PermanentRedirect|BadRequest|Unauthorized|PaymentRequired|Forbidden|NotFound|MethodNotAllowed|NotAcceptable|ProxyAuthenticationRequired|RequestTimeout|Conflict|Gone|LengthRequired|PreconditionFailed|PayloadTooLarge|URITooLong|UnsupportedMediaType|RangeNotSatisfiable|ExpectationFailed|MisdirectedRequest|UnprocessableEntity|Locked|FailedDependency|UpgradeRequired|PreconditionRequired|TooManyRequests|RequestHeaderFieldsTooLarge|InternalServerError|NotImplemented|BadGateway|ServiceUnavailable|GatewayTimeout|HTTPVersionNotSupported|VariantAlsoNegotiates|InsufficientStorage|LoopDetected|NotExtended|NetworkAuthenticationRequired] HTTP Status Code. HTTP response status codes EmptyStatusCode response codes means it is not specified Continue status code OK status code Created status code Accepted status code Non Authoritative Information status code No Content status code Reset Content status code Partial Content status code Multi Status status code Already Reported status code Im Used status code Multiple Choices status code Moved Permanently status code Found status code See Other status code Not Modified status code Use Proxy status code Temporary Redirect status code Permanent Redirect status code Bad Request status code Unauthorized status code Payment Required status code Forbidden status code Not Found status code Method Not Allowed status code Not Acceptable status code Proxy Authentication Required status code Request Timeout status code Conflict status code Gone status code Length Required status code Precondition Failed status code Payload Too Large status code URI Too Long status code Unsupported Media Type status code Range Not Satisfiable status code Expectation Failed status code Misdirected Request status code Unprocessable Entity status code Locked status code Failed Dependency status code Upgrade Required status code Precondition Required status code Too Many Requests status code Request Header Fields Too Large status code Internal Server Error status code Not Implemented status code Bad Gateway status code Service Unavailable status code Gateway Timeout status code HTTP Version Not Supported status code Variant Also Negotiates status code Insufficient Storage status code Loop Detected status code Not Extended status code Network Authentication Required status code
967
+ <a id="deep-95bfe3"></a>Deeply nested **Conditions** block collapsed for readability.
1710
968
 
1711
969
  #### Bot Defense Policy Protected App Endpoints Flow Label Authentication Login Transaction Result Success Conditions
1712
970
 
1713
- A [`success_conditions`](#conditions-0b5152) block (within [`bot_defense.policy.protected_app_endpoints.flow_label.authentication.login.transaction_result`](#result-c2e927)) supports the following:
1714
-
1715
- <a id="name-98fa41"></a>&#x2022; [`name`](#name-98fa41) - Optional String<br>Header Name. A case-insensitive HTTP header name
1716
-
1717
- <a id="values-9be26f"></a>&#x2022; [`regex_values`](#values-9be26f) - Optional List<br>Regex Values. A list of regular expressions to match the input against
1718
-
1719
- <a id="status-c08615"></a>&#x2022; [`status`](#status-c08615) - Optional String Defaults to `EmptyStatusCode`<br>Possible values are `EmptyStatusCode`, `Continue`, `OK`, `Created`, `Accepted`, `NonAuthoritativeInformation`, `NoContent`, `ResetContent`, `PartialContent`, `MultiStatus`, `AlreadyReported`, `IMUsed`, `MultipleChoices`, `MovedPermanently`, `Found`, `SeeOther`, `NotModified`, `UseProxy`, `TemporaryRedirect`, `PermanentRedirect`, `BadRequest`, `Unauthorized`, `PaymentRequired`, `Forbidden`, `NotFound`, `MethodNotAllowed`, `NotAcceptable`, `ProxyAuthenticationRequired`, `RequestTimeout`, `Conflict`, `Gone`, `LengthRequired`, `PreconditionFailed`, `PayloadTooLarge`, `URITooLong`, `UnsupportedMediaType`, `RangeNotSatisfiable`, `ExpectationFailed`, `MisdirectedRequest`, `UnprocessableEntity`, `Locked`, `FailedDependency`, `UpgradeRequired`, `PreconditionRequired`, `TooManyRequests`, `RequestHeaderFieldsTooLarge`, `InternalServerError`, `NotImplemented`, `BadGateway`, `ServiceUnavailable`, `GatewayTimeout`, `HTTPVersionNotSupported`, `VariantAlsoNegotiates`, `InsufficientStorage`, `LoopDetected`, `NotExtended`, `NetworkAuthenticationRequired`<br>[Enum: EmptyStatusCode|Continue|OK|Created|Accepted|NonAuthoritativeInformation|NoContent|ResetContent|PartialContent|MultiStatus|AlreadyReported|IMUsed|MultipleChoices|MovedPermanently|Found|SeeOther|NotModified|UseProxy|TemporaryRedirect|PermanentRedirect|BadRequest|Unauthorized|PaymentRequired|Forbidden|NotFound|MethodNotAllowed|NotAcceptable|ProxyAuthenticationRequired|RequestTimeout|Conflict|Gone|LengthRequired|PreconditionFailed|PayloadTooLarge|URITooLong|UnsupportedMediaType|RangeNotSatisfiable|ExpectationFailed|MisdirectedRequest|UnprocessableEntity|Locked|FailedDependency|UpgradeRequired|PreconditionRequired|TooManyRequests|RequestHeaderFieldsTooLarge|InternalServerError|NotImplemented|BadGateway|ServiceUnavailable|GatewayTimeout|HTTPVersionNotSupported|VariantAlsoNegotiates|InsufficientStorage|LoopDetected|NotExtended|NetworkAuthenticationRequired] HTTP Status Code. HTTP response status codes EmptyStatusCode response codes means it is not specified Continue status code OK status code Created status code Accepted status code Non Authoritative Information status code No Content status code Reset Content status code Partial Content status code Multi Status status code Already Reported status code Im Used status code Multiple Choices status code Moved Permanently status code Found status code See Other status code Not Modified status code Use Proxy status code Temporary Redirect status code Permanent Redirect status code Bad Request status code Unauthorized status code Payment Required status code Forbidden status code Not Found status code Method Not Allowed status code Not Acceptable status code Proxy Authentication Required status code Request Timeout status code Conflict status code Gone status code Length Required status code Precondition Failed status code Payload Too Large status code URI Too Long status code Unsupported Media Type status code Range Not Satisfiable status code Expectation Failed status code Misdirected Request status code Unprocessable Entity status code Locked status code Failed Dependency status code Upgrade Required status code Precondition Required status code Too Many Requests status code Request Header Fields Too Large status code Internal Server Error status code Not Implemented status code Bad Gateway status code Service Unavailable status code Gateway Timeout status code HTTP Version Not Supported status code Variant Also Negotiates status code Insufficient Storage status code Loop Detected status code Not Extended status code Network Authentication Required status code
971
+ <a id="deep-0eb365"></a>Deeply nested **Conditions** block collapsed for readability.
1720
972
 
1721
973
  #### Bot Defense Policy Protected App Endpoints Flow Label Financial Services
1722
974
 
1723
- A [`financial_services`](#services-acd29e) block (within [`bot_defense.policy.protected_app_endpoints.flow_label`](#label-244fef)) supports the following:
1724
-
1725
- <a id="apply-9bb5b8"></a>&#x2022; [`apply`](#apply-9bb5b8) - Optional Block<br>Enable this option
1726
-
1727
- <a id="transfer-ec9dc0"></a>&#x2022; [`money_transfer`](#transfer-ec9dc0) - Optional Block<br>Enable this option
975
+ <a id="deep-e8aad0"></a>Deeply nested **Services** block collapsed for readability.
1728
976
 
1729
977
  #### Bot Defense Policy Protected App Endpoints Flow Label Flight
1730
978
 
1731
- A [`flight`](#flight-0c8cf6) block (within [`bot_defense.policy.protected_app_endpoints.flow_label`](#label-244fef)) supports the following:
1732
-
1733
- <a id="checkin-f1e656"></a>&#x2022; [`checkin`](#checkin-f1e656) - Optional Block<br>Enable this option
979
+ <a id="deep-fe2123"></a>Deeply nested **Flight** block collapsed for readability.
1734
980
 
1735
981
  #### Bot Defense Policy Protected App Endpoints Flow Label Profile Management
1736
982
 
1737
- A [`profile_management`](#management-9be6b5) block (within [`bot_defense.policy.protected_app_endpoints.flow_label`](#label-244fef)) supports the following:
1738
-
1739
- <a id="create-63ed29"></a>&#x2022; [`create`](#create-63ed29) - Optional Block<br>Enable this option
1740
-
1741
- <a id="update-c7e26c"></a>&#x2022; [`update`](#update-c7e26c) - Optional Block<br>Enable this option
1742
-
1743
- <a id="view-2c180c"></a>&#x2022; [`view`](#view-2c180c) - Optional Block<br>Enable this option
983
+ <a id="deep-e241e6"></a>Deeply nested **Management** block collapsed for readability.
1744
984
 
1745
985
  #### Bot Defense Policy Protected App Endpoints Flow Label Search
1746
986
 
1747
- A [`search`](#search-d60360) block (within [`bot_defense.policy.protected_app_endpoints.flow_label`](#label-244fef)) supports the following:
1748
-
1749
- <a id="search-de8571"></a>&#x2022; [`flight_search`](#search-de8571) - Optional Block<br>Enable this option
1750
-
1751
- <a id="search-389b2b"></a>&#x2022; [`product_search`](#search-389b2b) - Optional Block<br>Enable this option
1752
-
1753
- <a id="search-0f9951"></a>&#x2022; [`reservation_search`](#search-0f9951) - Optional Block<br>Enable this option
1754
-
1755
- <a id="search-3917b2"></a>&#x2022; [`room_search`](#search-3917b2) - Optional Block<br>Enable this option
987
+ <a id="deep-b86aa6"></a>Deeply nested **Search** block collapsed for readability.
1756
988
 
1757
989
  #### Bot Defense Policy Protected App Endpoints Flow Label Shopping Gift Cards
1758
990
 
1759
- A [`shopping_gift_cards`](#cards-f10d47) block (within [`bot_defense.policy.protected_app_endpoints.flow_label`](#label-244fef)) supports the following:
1760
-
1761
- <a id="card-a0f859"></a>&#x2022; [`gift_card_make_purchase_with_gift_card`](#card-a0f859) - Optional Block<br>Enable this option
1762
-
1763
- <a id="validation-1fa308"></a>&#x2022; [`gift_card_validation`](#validation-1fa308) - Optional Block<br>Enable this option
1764
-
1765
- <a id="cart-6e5d88"></a>&#x2022; [`shop_add_to_cart`](#cart-6e5d88) - Optional Block<br>Enable this option
1766
-
1767
- <a id="checkout-e4a04e"></a>&#x2022; [`shop_checkout`](#checkout-e4a04e) - Optional Block<br>Enable this option
1768
-
1769
- <a id="seat-cb52da"></a>&#x2022; [`shop_choose_seat`](#seat-cb52da) - Optional Block<br>Enable this option
1770
-
1771
- <a id="submission-f6e144"></a>&#x2022; [`shop_enter_drawing_submission`](#submission-f6e144) - Optional Block<br>Enable this option
1772
-
1773
- <a id="payment-d25ab7"></a>&#x2022; [`shop_make_payment`](#payment-d25ab7) - Optional Block<br>Enable this option
1774
-
1775
- <a id="order-c19bbe"></a>&#x2022; [`shop_order`](#order-c19bbe) - Optional Block<br>Enable this option
1776
-
1777
- <a id="inquiry-9ca8c2"></a>&#x2022; [`shop_price_inquiry`](#inquiry-9ca8c2) - Optional Block<br>Enable this option
1778
-
1779
- <a id="validation-b02840"></a>&#x2022; [`shop_promo_code_validation`](#validation-b02840) - Optional Block<br>Enable this option
1780
-
1781
- <a id="card-2cf94e"></a>&#x2022; [`shop_purchase_gift_card`](#card-2cf94e) - Optional Block<br>Enable this option
1782
-
1783
- <a id="quantity-4339b1"></a>&#x2022; [`shop_update_quantity`](#quantity-4339b1) - Optional Block<br>Enable this option
991
+ <a id="deep-ae3c07"></a>Deeply nested **Cards** block collapsed for readability.
1784
992
 
1785
993
  #### Bot Defense Policy Protected App Endpoints Headers
1786
994
 
@@ -1798,13 +1006,7 @@ A [`headers`](#headers-986193) block (within [`bot_defense.policy.protected_app_
1798
1006
 
1799
1007
  #### Bot Defense Policy Protected App Endpoints Headers Item
1800
1008
 
1801
- An [`item`](#item-ca0df2) block (within [`bot_defense.policy.protected_app_endpoints.headers`](#headers-986193)) supports the following:
1802
-
1803
- <a id="values-13c944"></a>&#x2022; [`exact_values`](#values-13c944) - Optional List<br>Exact Values. A list of exact values to match the input against
1804
-
1805
- <a id="values-b0d727"></a>&#x2022; [`regex_values`](#values-b0d727) - Optional List<br>Regex Values. A list of regular expressions to match the input against
1806
-
1807
- <a id="transformers-eb2f5b"></a>&#x2022; [`transformers`](#transformers-eb2f5b) - Optional List Defaults to `TRANSFORMER_NONE`<br>Possible values are `LOWER_CASE`, `UPPER_CASE`, `BASE64_DECODE`, `NORMALIZE_PATH`, `REMOVE_WHITESPACE`, `URL_DECODE`, `TRIM_LEFT`, `TRIM_RIGHT`, `TRIM`<br>[Enum: LOWER_CASE|UPPER_CASE|BASE64_DECODE|NORMALIZE_PATH|REMOVE_WHITESPACE|URL_DECODE|TRIM_LEFT|TRIM_RIGHT|TRIM] Transformers. An ordered list of transformers (starting from index 0) to be applied to the path before matching
1009
+ <a id="deep-92cb3a"></a>Deeply nested **Item** block collapsed for readability.
1808
1010
 
1809
1011
  #### Bot Defense Policy Protected App Endpoints Metadata
1810
1012
 
@@ -1826,33 +1028,19 @@ A [`mitigation`](#mitigation-cc96eb) block (within [`bot_defense.policy.protecte
1826
1028
 
1827
1029
  #### Bot Defense Policy Protected App Endpoints Mitigation Block
1828
1030
 
1829
- A [`block`](#block-d25b81) block (within [`bot_defense.policy.protected_app_endpoints.mitigation`](#mitigation-cc96eb)) supports the following:
1830
-
1831
- <a id="body-fe6d39"></a>&#x2022; [`body`](#body-fe6d39) - Optional String<br>Body. Custom body message is of type uri_ref. Currently supported URL schemes is string:///. For string:/// scheme, message needs to be encoded in Base64 format. You can specify this message as base64 encoded plain text message e.g. 'Your request was blocked' or it can be HTML paragraph or a body string encoded as base64 string E.g. '`<p>` Your request was blocked `</p>`'. Base64 encoded string for this HTML is 'LzxwPiBZb3VyIHJlcXVlc3Qgd2FzIGJsb2NrZWQgPC9wPg=='
1832
-
1833
- <a id="status-590093"></a>&#x2022; [`status`](#status-590093) - Optional String Defaults to `EmptyStatusCode`<br>Possible values are `EmptyStatusCode`, `Continue`, `OK`, `Created`, `Accepted`, `NonAuthoritativeInformation`, `NoContent`, `ResetContent`, `PartialContent`, `MultiStatus`, `AlreadyReported`, `IMUsed`, `MultipleChoices`, `MovedPermanently`, `Found`, `SeeOther`, `NotModified`, `UseProxy`, `TemporaryRedirect`, `PermanentRedirect`, `BadRequest`, `Unauthorized`, `PaymentRequired`, `Forbidden`, `NotFound`, `MethodNotAllowed`, `NotAcceptable`, `ProxyAuthenticationRequired`, `RequestTimeout`, `Conflict`, `Gone`, `LengthRequired`, `PreconditionFailed`, `PayloadTooLarge`, `URITooLong`, `UnsupportedMediaType`, `RangeNotSatisfiable`, `ExpectationFailed`, `MisdirectedRequest`, `UnprocessableEntity`, `Locked`, `FailedDependency`, `UpgradeRequired`, `PreconditionRequired`, `TooManyRequests`, `RequestHeaderFieldsTooLarge`, `InternalServerError`, `NotImplemented`, `BadGateway`, `ServiceUnavailable`, `GatewayTimeout`, `HTTPVersionNotSupported`, `VariantAlsoNegotiates`, `InsufficientStorage`, `LoopDetected`, `NotExtended`, `NetworkAuthenticationRequired`<br>[Enum: EmptyStatusCode|Continue|OK|Created|Accepted|NonAuthoritativeInformation|NoContent|ResetContent|PartialContent|MultiStatus|AlreadyReported|IMUsed|MultipleChoices|MovedPermanently|Found|SeeOther|NotModified|UseProxy|TemporaryRedirect|PermanentRedirect|BadRequest|Unauthorized|PaymentRequired|Forbidden|NotFound|MethodNotAllowed|NotAcceptable|ProxyAuthenticationRequired|RequestTimeout|Conflict|Gone|LengthRequired|PreconditionFailed|PayloadTooLarge|URITooLong|UnsupportedMediaType|RangeNotSatisfiable|ExpectationFailed|MisdirectedRequest|UnprocessableEntity|Locked|FailedDependency|UpgradeRequired|PreconditionRequired|TooManyRequests|RequestHeaderFieldsTooLarge|InternalServerError|NotImplemented|BadGateway|ServiceUnavailable|GatewayTimeout|HTTPVersionNotSupported|VariantAlsoNegotiates|InsufficientStorage|LoopDetected|NotExtended|NetworkAuthenticationRequired] HTTP Status Code. HTTP response status codes EmptyStatusCode response codes means it is not specified Continue status code OK status code Created status code Accepted status code Non Authoritative Information status code No Content status code Reset Content status code Partial Content status code Multi Status status code Already Reported status code Im Used status code Multiple Choices status code Moved Permanently status code Found status code See Other status code Not Modified status code Use Proxy status code Temporary Redirect status code Permanent Redirect status code Bad Request status code Unauthorized status code Payment Required status code Forbidden status code Not Found status code Method Not Allowed status code Not Acceptable status code Proxy Authentication Required status code Request Timeout status code Conflict status code Gone status code Length Required status code Precondition Failed status code Payload Too Large status code URI Too Long status code Unsupported Media Type status code Range Not Satisfiable status code Expectation Failed status code Misdirected Request status code Unprocessable Entity status code Locked status code Failed Dependency status code Upgrade Required status code Precondition Required status code Too Many Requests status code Request Header Fields Too Large status code Internal Server Error status code Not Implemented status code Bad Gateway status code Service Unavailable status code Gateway Timeout status code HTTP Version Not Supported status code Variant Also Negotiates status code Insufficient Storage status code Loop Detected status code Not Extended status code Network Authentication Required status code
1031
+ <a id="deep-3c0d5a"></a>Deeply nested **Block** block collapsed for readability.
1834
1032
 
1835
1033
  #### Bot Defense Policy Protected App Endpoints Mitigation Flag
1836
1034
 
1837
- A [`flag`](#flag-50a52b) block (within [`bot_defense.policy.protected_app_endpoints.mitigation`](#mitigation-cc96eb)) supports the following:
1838
-
1839
- <a id="headers-cba7f7"></a>&#x2022; [`append_headers`](#headers-cba7f7) - Optional Block<br>Append Flag Mitigation Headers. Append flag mitigation headers to forwarded request<br>See [Append Headers](#headers-cba7f7) below.
1840
-
1841
- <a id="headers-25974d"></a>&#x2022; [`no_headers`](#headers-25974d) - Optional Block<br>Enable this option
1035
+ <a id="deep-31a90f"></a>Deeply nested **Flag** block collapsed for readability.
1842
1036
 
1843
1037
  #### Bot Defense Policy Protected App Endpoints Mitigation Flag Append Headers
1844
1038
 
1845
- An [`append_headers`](#headers-cba7f7) block (within [`bot_defense.policy.protected_app_endpoints.mitigation.flag`](#flag-50a52b)) supports the following:
1846
-
1847
- <a id="name-c64f18"></a>&#x2022; [`auto_type_header_name`](#name-c64f18) - Optional String<br>Automation Type Header Name. A case-insensitive HTTP header name
1848
-
1849
- <a id="name-66a056"></a>&#x2022; [`inference_header_name`](#name-66a056) - Optional String<br>Inference Header Name. A case-insensitive HTTP header name
1039
+ <a id="deep-be96ae"></a>Deeply nested **Headers** block collapsed for readability.
1850
1040
 
1851
1041
  #### Bot Defense Policy Protected App Endpoints Mitigation Redirect
1852
1042
 
1853
- A [`redirect`](#redirect-2c8f41) block (within [`bot_defense.policy.protected_app_endpoints.mitigation`](#mitigation-cc96eb)) supports the following:
1854
-
1855
- <a id="uri-56c0f3"></a>&#x2022; [`uri`](#uri-56c0f3) - Optional String<br>URI. URI location for redirect may be relative or absolute
1043
+ <a id="deep-7565c4"></a>Deeply nested **Redirect** block collapsed for readability.
1856
1044
 
1857
1045
  #### Bot Defense Policy Protected App Endpoints Path
1858
1046
 
@@ -1866,33 +1054,15 @@ A [`path`](#path-d5ee15) block (within [`bot_defense.policy.protected_app_endpoi
1866
1054
 
1867
1055
  #### Bot Defense Policy Protected App Endpoints Query Params
1868
1056
 
1869
- A [`query_params`](#params-8f5791) block (within [`bot_defense.policy.protected_app_endpoints`](#endpoints-01a2f3)) supports the following:
1870
-
1871
- <a id="present-966c69"></a>&#x2022; [`check_not_present`](#present-966c69) - Optional Block<br>Enable this option
1872
-
1873
- <a id="present-f5250d"></a>&#x2022; [`check_present`](#present-f5250d) - Optional Block<br>Enable this option
1874
-
1875
- <a id="matcher-6361dd"></a>&#x2022; [`invert_matcher`](#matcher-6361dd) - Optional Bool<br>Invert Query Parameter Matcher. Invert the match result
1876
-
1877
- <a id="item-92c230"></a>&#x2022; [`item`](#item-92c230) - Optional Block<br>Matcher. A 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-92c230) below.
1878
-
1879
- <a id="key-2452b1"></a>&#x2022; [`key`](#key-2452b1) - Optional String<br>Query Parameter Name. A case-sensitive HTTP query parameter name
1057
+ <a id="deep-0d34ba"></a>Deeply nested **Params** block collapsed for readability.
1880
1058
 
1881
1059
  #### Bot Defense Policy Protected App Endpoints Query Params Item
1882
1060
 
1883
- An [`item`](#item-92c230) block (within [`bot_defense.policy.protected_app_endpoints.query_params`](#params-8f5791)) supports the following:
1884
-
1885
- <a id="values-b9ca65"></a>&#x2022; [`exact_values`](#values-b9ca65) - Optional List<br>Exact Values. A list of exact values to match the input against
1886
-
1887
- <a id="values-836047"></a>&#x2022; [`regex_values`](#values-836047) - Optional List<br>Regex Values. A list of regular expressions to match the input against
1888
-
1889
- <a id="transformers-794fb2"></a>&#x2022; [`transformers`](#transformers-794fb2) - Optional List Defaults to `TRANSFORMER_NONE`<br>Possible values are `LOWER_CASE`, `UPPER_CASE`, `BASE64_DECODE`, `NORMALIZE_PATH`, `REMOVE_WHITESPACE`, `URL_DECODE`, `TRIM_LEFT`, `TRIM_RIGHT`, `TRIM`<br>[Enum: LOWER_CASE|UPPER_CASE|BASE64_DECODE|NORMALIZE_PATH|REMOVE_WHITESPACE|URL_DECODE|TRIM_LEFT|TRIM_RIGHT|TRIM] Transformers. An ordered list of transformers (starting from index 0) to be applied to the path before matching
1061
+ <a id="deep-479116"></a>Deeply nested **Item** block collapsed for readability.
1890
1062
 
1891
1063
  #### Bot Defense Policy Protected App Endpoints Web Mobile
1892
1064
 
1893
- A [`web_mobile`](#mobile-0ffdfb) block (within [`bot_defense.policy.protected_app_endpoints`](#endpoints-01a2f3)) supports the following:
1894
-
1895
- <a id="identifier-0e0f05"></a>&#x2022; [`mobile_identifier`](#identifier-0e0f05) - Optional String Defaults to `HEADERS`<br>[Enum: HEADERS] Mobile Identifier. Mobile identifier type - HEADERS: Headers Headers. The only possible value is `HEADERS`
1065
+ <a id="deep-ee5137"></a>Deeply nested **Mobile** block collapsed for readability.
1896
1066
 
1897
1067
  #### Captcha Challenge
1898
1068
 
@@ -1922,137 +1092,63 @@ A [`policy`](#client-side-defense-policy) block (within [`client_side_defense`](
1922
1092
 
1923
1093
  #### Client Side Defense Policy Js Insert All Pages Except
1924
1094
 
1925
- A [`js_insert_all_pages_except`](#except-7bfe85) block (within [`client_side_defense.policy`](#client-side-defense-policy)) supports the following:
1926
-
1927
- <a id="list-fc1c50"></a>&#x2022; [`exclude_list`](#list-fc1c50) - Optional Block<br>Exclude Pages. Optional JavaScript insertions exclude list of domain and path matchers<br>See [Exclude List](#list-fc1c50) below.
1095
+ <a id="deep-357348"></a>Deeply nested **Except** block collapsed for readability.
1928
1096
 
1929
1097
  #### Client Side Defense Policy Js Insert All Pages Except Exclude List
1930
1098
 
1931
- An [`exclude_list`](#list-fc1c50) block (within [`client_side_defense.policy.js_insert_all_pages_except`](#except-7bfe85)) supports the following:
1932
-
1933
- <a id="domain-cfab55"></a>&#x2022; [`any_domain`](#domain-cfab55) - Optional Block<br>Enable this option
1934
-
1935
- <a id="domain-15fe0c"></a>&#x2022; [`domain`](#domain-15fe0c) - Optional Block<br>Domains. Domains names<br>See [Domain](#domain-15fe0c) below.
1936
-
1937
- <a id="metadata-50baa8"></a>&#x2022; [`metadata`](#metadata-50baa8) - Optional Block<br>Message Metadata. 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 and replace APIs<br>See [Metadata](#metadata-50baa8) below.
1938
-
1939
- <a id="path-82c392"></a>&#x2022; [`path`](#path-82c392) - Optional Block<br>Path to Match. Path match of the URI can be either be, Prefix match or exact match or regular expression match<br>See [Path](#path-82c392) below.
1940
-
1941
- #### Client Side Defense Policy Js Insert All Pages Except Exclude List Domain
1942
-
1943
- A [`domain`](#domain-15fe0c) block (within [`client_side_defense.policy.js_insert_all_pages_except.exclude_list`](#list-fc1c50)) supports the following:
1944
-
1945
- <a id="value-f9285b"></a>&#x2022; [`exact_value`](#value-f9285b) - Optional String<br>Exact Value. Exact domain name
1946
-
1947
- <a id="value-4207c5"></a>&#x2022; [`regex_value`](#value-4207c5) - Optional String<br>Regex Values of Domains. Regular Expression value for the domain name
1948
-
1949
- <a id="value-2a8824"></a>&#x2022; [`suffix_value`](#value-2a8824) - Optional String<br>Suffix Value. Suffix of domain name e.g 'xyz.com' will match '*.xyz.com' and 'xyz.com'
1950
-
1951
- #### Client Side Defense Policy Js Insert All Pages Except Exclude List Metadata
1952
-
1953
- A [`metadata`](#metadata-50baa8) block (within [`client_side_defense.policy.js_insert_all_pages_except.exclude_list`](#list-fc1c50)) supports the following:
1954
-
1955
- <a id="spec-28351b"></a>&#x2022; [`description_spec`](#spec-28351b) - Optional String<br>Description. Human readable description
1956
-
1957
- <a id="name-3e26d9"></a>&#x2022; [`name`](#name-3e26d9) - Optional String<br>Name. This is the name of the message. The value of name has to follow DNS-1035 format
1958
-
1959
- #### Client Side Defense Policy Js Insert All Pages Except Exclude List Path
1960
-
1961
- A [`path`](#path-82c392) block (within [`client_side_defense.policy.js_insert_all_pages_except.exclude_list`](#list-fc1c50)) supports the following:
1962
-
1963
- <a id="path-390fcf"></a>&#x2022; [`path`](#path-390fcf) - Optional String<br>Exact. Exact path value to match
1964
-
1965
- <a id="prefix-d5139b"></a>&#x2022; [`prefix`](#prefix-d5139b) - Optional String<br>Prefix. Path prefix to match (e.g. the value / will match on all paths)
1966
-
1967
- <a id="regex-0010b2"></a>&#x2022; [`regex`](#regex-0010b2) - Optional String<br>Regex. Regular expression of path match (e.g. the value .* will match on all paths)
1968
-
1969
- #### Client Side Defense Policy Js Insertion Rules
1970
-
1971
- A [`js_insertion_rules`](#rules-ad3671) block (within [`client_side_defense.policy`](#client-side-defense-policy)) supports the following:
1972
-
1973
- <a id="list-dfecb6"></a>&#x2022; [`exclude_list`](#list-dfecb6) - Optional Block<br>Exclude Paths. Optional JavaScript insertions exclude list of domain and path matchers<br>See [Exclude List](#list-dfecb6) below.
1974
-
1975
- <a id="rules-6276bc"></a>&#x2022; [`rules`](#rules-6276bc) - Optional Block<br>JavaScript Insertions. Required list of pages to insert Client-Side Defense client JavaScript<br>See [Rules](#rules-6276bc) below.
1976
-
1977
- #### Client Side Defense Policy Js Insertion Rules Exclude List
1978
-
1979
- An [`exclude_list`](#list-dfecb6) block (within [`client_side_defense.policy.js_insertion_rules`](#rules-ad3671)) supports the following:
1980
-
1981
- <a id="domain-7b414f"></a>&#x2022; [`any_domain`](#domain-7b414f) - Optional Block<br>Enable this option
1982
-
1983
- <a id="domain-7c7a7c"></a>&#x2022; [`domain`](#domain-7c7a7c) - Optional Block<br>Domains. Domains names<br>See [Domain](#domain-7c7a7c) below.
1984
-
1985
- <a id="metadata-bd2353"></a>&#x2022; [`metadata`](#metadata-bd2353) - Optional Block<br>Message Metadata. 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 and replace APIs<br>See [Metadata](#metadata-bd2353) below.
1986
-
1987
- <a id="path-962e59"></a>&#x2022; [`path`](#path-962e59) - Optional Block<br>Path to Match. Path match of the URI can be either be, Prefix match or exact match or regular expression match<br>See [Path](#path-962e59) below.
1988
-
1989
- #### Client Side Defense Policy Js Insertion Rules Exclude List Domain
1990
-
1991
- A [`domain`](#domain-7c7a7c) block (within [`client_side_defense.policy.js_insertion_rules.exclude_list`](#list-dfecb6)) supports the following:
1992
-
1993
- <a id="value-f64365"></a>&#x2022; [`exact_value`](#value-f64365) - Optional String<br>Exact Value. Exact domain name
1994
-
1995
- <a id="value-b28460"></a>&#x2022; [`regex_value`](#value-b28460) - Optional String<br>Regex Values of Domains. Regular Expression value for the domain name
1996
-
1997
- <a id="value-9e64cb"></a>&#x2022; [`suffix_value`](#value-9e64cb) - Optional String<br>Suffix Value. Suffix of domain name e.g 'xyz.com' will match '*.xyz.com' and 'xyz.com'
1998
-
1999
- #### Client Side Defense Policy Js Insertion Rules Exclude List Metadata
2000
-
2001
- A [`metadata`](#metadata-bd2353) block (within [`client_side_defense.policy.js_insertion_rules.exclude_list`](#list-dfecb6)) supports the following:
2002
-
2003
- <a id="spec-13fe6d"></a>&#x2022; [`description_spec`](#spec-13fe6d) - Optional String<br>Description. Human readable description
1099
+ <a id="deep-e071ac"></a>Deeply nested **List** block collapsed for readability.
2004
1100
 
2005
- <a id="name-b1fc08"></a>&#x2022; [`name`](#name-b1fc08) - Optional String<br>Name. This is the name of the message. The value of name has to follow DNS-1035 format
1101
+ #### Client Side Defense Policy Js Insert All Pages Except Exclude List Domain
2006
1102
 
2007
- #### Client Side Defense Policy Js Insertion Rules Exclude List Path
1103
+ <a id="deep-05664f"></a>Deeply nested **Domain** block collapsed for readability.
2008
1104
 
2009
- A [`path`](#path-962e59) block (within [`client_side_defense.policy.js_insertion_rules.exclude_list`](#list-dfecb6)) supports the following:
1105
+ #### Client Side Defense Policy Js Insert All Pages Except Exclude List Metadata
2010
1106
 
2011
- <a id="path-c659e3"></a>&#x2022; [`path`](#path-c659e3) - Optional String<br>Exact. Exact path value to match
1107
+ <a id="deep-ec44bf"></a>Deeply nested **Metadata** block collapsed for readability.
2012
1108
 
2013
- <a id="prefix-d88a45"></a>&#x2022; [`prefix`](#prefix-d88a45) - Optional String<br>Prefix. Path prefix to match (e.g. the value / will match on all paths)
1109
+ #### Client Side Defense Policy Js Insert All Pages Except Exclude List Path
2014
1110
 
2015
- <a id="regex-424dc4"></a>&#x2022; [`regex`](#regex-424dc4) - Optional String<br>Regex. Regular expression of path match (e.g. the value .* will match on all paths)
1111
+ <a id="deep-eba2d4"></a>Deeply nested **Path** block collapsed for readability.
2016
1112
 
2017
- #### Client Side Defense Policy Js Insertion Rules Rules
1113
+ #### Client Side Defense Policy Js Insertion Rules
2018
1114
 
2019
- A [`rules`](#rules-6276bc) block (within [`client_side_defense.policy.js_insertion_rules`](#rules-ad3671)) supports the following:
1115
+ A [`js_insertion_rules`](#rules-ad3671) block (within [`client_side_defense.policy`](#client-side-defense-policy)) supports the following:
2020
1116
 
2021
- <a id="domain-a7aac7"></a>&#x2022; [`any_domain`](#domain-a7aac7) - Optional Block<br>Enable this option
1117
+ <a id="list-dfecb6"></a>&#x2022; [`exclude_list`](#list-dfecb6) - Optional Block<br>Exclude Paths. Optional JavaScript insertions exclude list of domain and path matchers<br>See [Exclude List](#list-dfecb6) below.
2022
1118
 
2023
- <a id="domain-4b295f"></a>&#x2022; [`domain`](#domain-4b295f) - Optional Block<br>Domains. Domains names<br>See [Domain](#domain-4b295f) below.
1119
+ <a id="rules-6276bc"></a>&#x2022; [`rules`](#rules-6276bc) - Optional Block<br>JavaScript Insertions. Required list of pages to insert Client-Side Defense client JavaScript<br>See [Rules](#rules-6276bc) below.
2024
1120
 
2025
- <a id="metadata-60fc86"></a>&#x2022; [`metadata`](#metadata-60fc86) - Optional Block<br>Message Metadata. 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 and replace APIs<br>See [Metadata](#metadata-60fc86) below.
1121
+ #### Client Side Defense Policy Js Insertion Rules Exclude List
2026
1122
 
2027
- <a id="path-71b688"></a>&#x2022; [`path`](#path-71b688) - Optional Block<br>Path to Match. Path match of the URI can be either be, Prefix match or exact match or regular expression match<br>See [Path](#path-71b688) below.
1123
+ <a id="deep-1639b0"></a>Deeply nested **List** block collapsed for readability.
2028
1124
 
2029
- #### Client Side Defense Policy Js Insertion Rules Rules Domain
1125
+ #### Client Side Defense Policy Js Insertion Rules Exclude List Domain
2030
1126
 
2031
- A [`domain`](#domain-4b295f) block (within [`client_side_defense.policy.js_insertion_rules.rules`](#rules-6276bc)) supports the following:
1127
+ <a id="deep-949064"></a>Deeply nested **Domain** block collapsed for readability.
2032
1128
 
2033
- <a id="value-2357e4"></a>&#x2022; [`exact_value`](#value-2357e4) - Optional String<br>Exact Value. Exact domain name
1129
+ #### Client Side Defense Policy Js Insertion Rules Exclude List Metadata
2034
1130
 
2035
- <a id="value-a4f4ae"></a>&#x2022; [`regex_value`](#value-a4f4ae) - Optional String<br>Regex Values of Domains. Regular Expression value for the domain name
1131
+ <a id="deep-3af08a"></a>Deeply nested **Metadata** block collapsed for readability.
2036
1132
 
2037
- <a id="value-a7894b"></a>&#x2022; [`suffix_value`](#value-a7894b) - Optional String<br>Suffix Value. Suffix of domain name e.g 'xyz.com' will match '*.xyz.com' and 'xyz.com'
1133
+ #### Client Side Defense Policy Js Insertion Rules Exclude List Path
2038
1134
 
2039
- #### Client Side Defense Policy Js Insertion Rules Rules Metadata
1135
+ <a id="deep-44c104"></a>Deeply nested **Path** block collapsed for readability.
2040
1136
 
2041
- A [`metadata`](#metadata-60fc86) block (within [`client_side_defense.policy.js_insertion_rules.rules`](#rules-6276bc)) supports the following:
1137
+ #### Client Side Defense Policy Js Insertion Rules Rules
2042
1138
 
2043
- <a id="spec-f78d91"></a>&#x2022; [`description_spec`](#spec-f78d91) - Optional String<br>Description. Human readable description
1139
+ <a id="deep-ad681e"></a>Deeply nested **Rules** block collapsed for readability.
2044
1140
 
2045
- <a id="name-1afae7"></a>&#x2022; [`name`](#name-1afae7) - Optional String<br>Name. This is the name of the message. The value of name has to follow DNS-1035 format
1141
+ #### Client Side Defense Policy Js Insertion Rules Rules Domain
2046
1142
 
2047
- #### Client Side Defense Policy Js Insertion Rules Rules Path
1143
+ <a id="deep-15e025"></a>Deeply nested **Domain** block collapsed for readability.
2048
1144
 
2049
- A [`path`](#path-71b688) block (within [`client_side_defense.policy.js_insertion_rules.rules`](#rules-6276bc)) supports the following:
1145
+ #### Client Side Defense Policy Js Insertion Rules Rules Metadata
2050
1146
 
2051
- <a id="path-df67b6"></a>&#x2022; [`path`](#path-df67b6) - Optional String<br>Exact. Exact path value to match
1147
+ <a id="deep-6c411a"></a>Deeply nested **Metadata** block collapsed for readability.
2052
1148
 
2053
- <a id="prefix-7c1e21"></a>&#x2022; [`prefix`](#prefix-7c1e21) - Optional String<br>Prefix. Path prefix to match (e.g. the value / will match on all paths)
1149
+ #### Client Side Defense Policy Js Insertion Rules Rules Path
2054
1150
 
2055
- <a id="regex-248fb3"></a>&#x2022; [`regex`](#regex-248fb3) - Optional String<br>Regex. Regular expression of path match (e.g. the value .* will match on all paths)
1151
+ <a id="deep-880dda"></a>Deeply nested **Path** block collapsed for readability.
2056
1152
 
2057
1153
  #### CORS Policy
2058
1154
 
@@ -2098,13 +1194,7 @@ A [`custom_cache_rule`](#custom-cache-rule) block supports the following:
2098
1194
 
2099
1195
  #### Custom Cache Rule CDN Cache Rules
2100
1196
 
2101
- A [`cdn_cache_rules`](#custom-cache-rule-cdn-cache-rules) block (within [`custom_cache_rule`](#custom-cache-rule)) supports the following:
2102
-
2103
- <a id="custom-cache-rule-cdn-cache-rules-name"></a>&#x2022; [`name`](#custom-cache-rule-cdn-cache-rules-name) - Optional String<br>Name. 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
2104
-
2105
- <a id="namespace-953951"></a>&#x2022; [`namespace`](#namespace-953951) - Optional String<br>Namespace. 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
2106
-
2107
- <a id="tenant-f1c5ea"></a>&#x2022; [`tenant`](#tenant-f1c5ea) - Optional String<br>Tenant. 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
1197
+ <a id="objref-c6bad1"></a>Uses standard [Object Reference](#common-object-reference) fields (name, namespace, tenant).
2108
1198
 
2109
1199
  #### Data Guard Rules
2110
1200
 
@@ -2170,25 +1260,15 @@ A [`ddos_client_source`](#source-02aa55) block (within [`ddos_mitigation_rules`]
2170
1260
 
2171
1261
  #### DDOS Mitigation Rules DDOS Client Source Asn List
2172
1262
 
2173
- An [`asn_list`](#list-20cb78) block (within [`ddos_mitigation_rules.ddos_client_source`](#source-02aa55)) supports the following:
2174
-
2175
- <a id="numbers-a2cb60"></a>&#x2022; [`as_numbers`](#numbers-a2cb60) - Optional List<br>AS Numbers. An 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
1263
+ <a id="deep-4fa70d"></a>Deeply nested **List** block collapsed for readability.
2176
1264
 
2177
1265
  #### DDOS Mitigation Rules DDOS Client Source Ja4 TLS Fingerprint Matcher
2178
1266
 
2179
- A [`ja4_tls_fingerprint_matcher`](#matcher-a7a10e) block (within [`ddos_mitigation_rules.ddos_client_source`](#source-02aa55)) supports the following:
2180
-
2181
- <a id="values-d0a266"></a>&#x2022; [`exact_values`](#values-d0a266) - Optional List<br>Exact Values. A list of exact JA4 TLS fingerprint to match the input JA4 TLS fingerprint against
1267
+ <a id="deep-ae859d"></a>Deeply nested **Matcher** block collapsed for readability.
2182
1268
 
2183
1269
  #### DDOS Mitigation Rules DDOS Client Source TLS Fingerprint Matcher
2184
1270
 
2185
- A [`tls_fingerprint_matcher`](#matcher-d4dd17) block (within [`ddos_mitigation_rules.ddos_client_source`](#source-02aa55)) supports the following:
2186
-
2187
- <a id="classes-b8db1d"></a>&#x2022; [`classes`](#classes-b8db1d) - Optional List Defaults to `TLS_FINGERPRINT_NONE`<br>Possible values are `TLS_FINGERPRINT_NONE`, `ANY_MALICIOUS_FINGERPRINT`, `ADWARE`, `ADWIND`, `DRIDEX`, `GOOTKIT`, `GOZI`, `JBIFROST`, `QUAKBOT`, `RANSOMWARE`, `TROLDESH`, `TOFSEE`, `TORRENTLOCKER`, `TRICKBOT`<br>[Enum: TLS_FINGERPRINT_NONE|ANY_MALICIOUS_FINGERPRINT|ADWARE|ADWIND|DRIDEX|GOOTKIT|GOZI|JBIFROST|QUAKBOT|RANSOMWARE|TROLDESH|TOFSEE|TORRENTLOCKER|TRICKBOT] TLS fingerprint classes. A list of known classes of TLS fingerprints to match the input TLS JA3 fingerprint against
2188
-
2189
- <a id="values-2a6e72"></a>&#x2022; [`exact_values`](#values-2a6e72) - Optional List<br>Exact Values. A list of exact TLS JA3 fingerprints to match the input TLS JA3 fingerprint against
2190
-
2191
- <a id="values-7f5411"></a>&#x2022; [`excluded_values`](#values-7f5411) - Optional List<br>Excluded Values. A list of TLS JA3 fingerprints to be excluded when matching the input TLS JA3 fingerprint. This can be used to skip known false positives when using one or more known TLS fingerprint classes in the enclosing matcher
1271
+ <a id="deep-3d0bac"></a>Deeply nested **Matcher** block collapsed for readability.
2192
1272
 
2193
1273
  #### DDOS Mitigation Rules IP Prefix List
2194
1274
 
@@ -2244,83 +1324,43 @@ An [`api_crawler`](#enable-api-discovery-api-crawler) block (within [`enable_api
2244
1324
 
2245
1325
  #### Enable API Discovery API Crawler API Crawler Config
2246
1326
 
2247
- An [`api_crawler_config`](#config-1070d6) block (within [`enable_api_discovery.api_crawler`](#enable-api-discovery-api-crawler)) supports the following:
2248
-
2249
- <a id="domains-5b24a2"></a>&#x2022; [`domains`](#domains-5b24a2) - Optional Block<br>Domains to Crawl. Enter domains and their credentials to allow authenticated API crawling. You can only include domains you own that are associated with this Load Balancer<br>See [Domains](#domains-5b24a2) below.
1327
+ <a id="deep-038178"></a>Deeply nested **Config** block collapsed for readability.
2250
1328
 
2251
1329
  #### Enable API Discovery API Crawler API Crawler Config Domains
2252
1330
 
2253
- A [`domains`](#domains-5b24a2) block (within [`enable_api_discovery.api_crawler.api_crawler_config`](#config-1070d6)) supports the following:
2254
-
2255
- <a id="domain-101008"></a>&#x2022; [`domain`](#domain-101008) - Optional String<br>Domain. Select the domain to execute API Crawling with given credentials
2256
-
2257
- <a id="login-d7ed1c"></a>&#x2022; [`simple_login`](#login-d7ed1c) - Optional Block<br>Simple Login<br>See [Simple Login](#login-d7ed1c) below.
1331
+ <a id="deep-2dedc6"></a>Deeply nested **Domains** block collapsed for readability.
2258
1332
 
2259
1333
  #### Enable API Discovery API Crawler API Crawler Config Domains Simple Login
2260
1334
 
2261
- A [`simple_login`](#login-d7ed1c) block (within [`enable_api_discovery.api_crawler.api_crawler_config.domains`](#domains-5b24a2)) supports the following:
2262
-
2263
- <a id="password-6dce3d"></a>&#x2022; [`password`](#password-6dce3d) - Optional Block<br>Secret. SecretType is used in an object to indicate a sensitive/confidential field<br>See [Password](#password-6dce3d) below.
2264
-
2265
- <a id="user-6538fc"></a>&#x2022; [`user`](#user-6538fc) - Optional String<br>User. Enter the username to assign credentials for the selected domain to crawl
1335
+ <a id="deep-f94bfe"></a>Deeply nested **Login** block collapsed for readability.
2266
1336
 
2267
1337
  #### Enable API Discovery API Crawler API Crawler Config Domains Simple Login Password
2268
1338
 
2269
- A [`password`](#password-6dce3d) block (within [`enable_api_discovery.api_crawler.api_crawler_config.domains.simple_login`](#login-d7ed1c)) supports the following:
2270
-
2271
- <a id="info-0086db"></a>&#x2022; [`blindfold_secret_info`](#info-0086db) - Optional Block<br>Blindfold Secret. BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management<br>See [Blindfold Secret Info](#info-0086db) below.
2272
-
2273
- <a id="info-e77ed8"></a>&#x2022; [`clear_secret_info`](#info-e77ed8) - Optional Block<br>In-Clear Secret. ClearSecretInfoType specifies information about the Secret that is not encrypted<br>See [Clear Secret Info](#info-e77ed8) below.
1339
+ <a id="deep-dcac2b"></a>Deeply nested **Password** block collapsed for readability.
2274
1340
 
2275
1341
  #### Enable API Discovery API Crawler API Crawler Config Domains Simple Login Password Blindfold Secret Info
2276
1342
 
2277
- A [`blindfold_secret_info`](#info-0086db) block (within [`enable_api_discovery.api_crawler.api_crawler_config.domains.simple_login.password`](#password-6dce3d)) supports the following:
2278
-
2279
- <a id="provider-5866c6"></a>&#x2022; [`decryption_provider`](#provider-5866c6) - Optional String<br>Decryption Provider. Name of the Secret Management Access object that contains information about the backend Secret Management service
2280
-
2281
- <a id="location-c9ff51"></a>&#x2022; [`location`](#location-c9ff51) - Optional String<br>Location. Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location
2282
-
2283
- <a id="provider-a85d09"></a>&#x2022; [`store_provider`](#provider-a85d09) - Optional String<br>Store Provider. Name of the Secret Management Access object that contains information about the store to get encrypted bytes This field needs to be provided only if the URL scheme is not string:///
1343
+ <a id="deep-bb1337"></a>Deeply nested **Info** block collapsed for readability.
2284
1344
 
2285
1345
  #### Enable API Discovery API Crawler API Crawler Config Domains Simple Login Password Clear Secret Info
2286
1346
 
2287
- A [`clear_secret_info`](#info-e77ed8) block (within [`enable_api_discovery.api_crawler.api_crawler_config.domains.simple_login.password`](#password-6dce3d)) supports the following:
2288
-
2289
- <a id="ref-6d12d4"></a>&#x2022; [`provider_ref`](#ref-6d12d4) - Optional String<br>Provider. Name of the Secret Management Access object that contains information about the store to get encrypted bytes This field needs to be provided only if the URL scheme is not string:///
2290
-
2291
- <a id="url-54d163"></a>&#x2022; [`url`](#url-54d163) - Optional String<br>URL. URL of the secret. Currently supported URL schemes is string:///. For string:/// scheme, Secret needs to be encoded Base64 format. When asked for this secret, caller will get Secret bytes after Base64 decoding
1347
+ <a id="deep-790308"></a>Deeply nested **Info** block collapsed for readability.
2292
1348
 
2293
1349
  #### Enable API Discovery API Discovery From Code Scan
2294
1350
 
2295
- An [`api_discovery_from_code_scan`](#scan-930604) block (within [`enable_api_discovery`](#enable-api-discovery)) supports the following:
2296
-
2297
- <a id="integrations-684fd9"></a>&#x2022; [`code_base_integrations`](#integrations-684fd9) - Optional Block<br>Select Code Base Integrations<br>See [Code Base Integrations](#integrations-684fd9) below.
1351
+ <a id="deep-65081a"></a>Deeply nested **Scan** block collapsed for readability.
2298
1352
 
2299
1353
  #### Enable API Discovery API Discovery From Code Scan Code Base Integrations
2300
1354
 
2301
- A [`code_base_integrations`](#integrations-684fd9) block (within [`enable_api_discovery.api_discovery_from_code_scan`](#scan-930604)) supports the following:
2302
-
2303
- <a id="repos-6dd9b2"></a>&#x2022; [`all_repos`](#repos-6dd9b2) - Optional Block<br>Enable this option
2304
-
2305
- <a id="integration-65ad07"></a>&#x2022; [`code_base_integration`](#integration-65ad07) - Optional Block<br>Object reference. This 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 [Code Base Integration](#integration-65ad07) below.
2306
-
2307
- <a id="repos-85b753"></a>&#x2022; [`selected_repos`](#repos-85b753) - Optional Block<br>API Code Repositories. Select which API repositories represent the LB applications<br>See [Selected Repos](#repos-85b753) below.
1355
+ <a id="deep-655889"></a>Deeply nested **Integrations** block collapsed for readability.
2308
1356
 
2309
1357
  #### Enable API Discovery API Discovery From Code Scan Code Base Integrations Code Base Integration
2310
1358
 
2311
- A [`code_base_integration`](#integration-65ad07) block (within [`enable_api_discovery.api_discovery_from_code_scan.code_base_integrations`](#integrations-684fd9)) supports the following:
2312
-
2313
- <a id="name-c1c22e"></a>&#x2022; [`name`](#name-c1c22e) - Optional String<br>Name. 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
2314
-
2315
- <a id="namespace-758b47"></a>&#x2022; [`namespace`](#namespace-758b47) - Optional String<br>Namespace. 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
2316
-
2317
- <a id="tenant-ab614a"></a>&#x2022; [`tenant`](#tenant-ab614a) - Optional String<br>Tenant. 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
1359
+ <a id="deep-f966a5"></a>Deeply nested **Integration** block collapsed for readability.
2318
1360
 
2319
1361
  #### Enable API Discovery API Discovery From Code Scan Code Base Integrations Selected Repos
2320
1362
 
2321
- A [`selected_repos`](#repos-85b753) block (within [`enable_api_discovery.api_discovery_from_code_scan.code_base_integrations`](#integrations-684fd9)) supports the following:
2322
-
2323
- <a id="repo-27b7de"></a>&#x2022; [`api_code_repo`](#repo-27b7de) - Optional List<br>API Code Repository. Code repository which contain API endpoints
1363
+ <a id="deep-24c79f"></a>Deeply nested **Repos** block collapsed for readability.
2324
1364
 
2325
1365
  #### Enable API Discovery Custom API Auth Discovery
2326
1366
 
@@ -2330,13 +1370,7 @@ A [`custom_api_auth_discovery`](#discovery-54db29) block (within [`enable_api_di
2330
1370
 
2331
1371
  #### Enable API Discovery Custom API Auth Discovery API Discovery Ref
2332
1372
 
2333
- An [`api_discovery_ref`](#ref-a70328) block (within [`enable_api_discovery.custom_api_auth_discovery`](#discovery-54db29)) supports the following:
2334
-
2335
- <a id="name-168227"></a>&#x2022; [`name`](#name-168227) - Optional String<br>Name. 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
2336
-
2337
- <a id="namespace-3af87c"></a>&#x2022; [`namespace`](#namespace-3af87c) - Optional String<br>Namespace. 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
2338
-
2339
- <a id="tenant-e22b6f"></a>&#x2022; [`tenant`](#tenant-e22b6f) - Optional String<br>Tenant. 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
1373
+ <a id="deep-af0566"></a>Deeply nested **Ref** block collapsed for readability.
2340
1374
 
2341
1375
  #### Enable API Discovery Discovered API Settings
2342
1376
 
@@ -2380,19 +1414,13 @@ A [`js_challenge_parameters`](#parameters-6f7506) block (within [`enable_challen
2380
1414
 
2381
1415
  #### Enable Challenge Malicious User Mitigation
2382
1416
 
2383
- A [`malicious_user_mitigation`](#mitigation-b3e04b) block (within [`enable_challenge`](#enable-challenge)) supports the following:
2384
-
2385
- <a id="name-3a9364"></a>&#x2022; [`name`](#name-3a9364) - Optional String<br>Name. 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
2386
-
2387
- <a id="namespace-38ef32"></a>&#x2022; [`namespace`](#namespace-38ef32) - Optional String<br>Namespace. 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
2388
-
2389
- <a id="tenant-78def2"></a>&#x2022; [`tenant`](#tenant-78def2) - Optional String<br>Tenant. 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
1417
+ <a id="objref-b3e04b"></a>Uses standard [Object Reference](#common-object-reference) fields (name, namespace, tenant).
2390
1418
 
2391
1419
  #### Enable IP Reputation
2392
1420
 
2393
1421
  An [`enable_ip_reputation`](#enable-ip-reputation) block supports the following:
2394
1422
 
2395
- <a id="categories-bb360f"></a>&#x2022; [`ip_threat_categories`](#categories-bb360f) - Optional List Defaults to `SPAM_SOURCES`<br>Possible values are `SPAM_SOURCES`, `WINDOWS_EXPLOITS`, `WEB_ATTACKS`, `BOTNETS`, `SCANNERS`, `REPUTATION`, `PHISHING`, `PROXY`, `MOBILE_THREATS`, `TOR_PROXY`, `DENIAL_OF_SERVICE`, `NETWORK`<br>[Enum: SPAM_SOURCES|WINDOWS_EXPLOITS|WEB_ATTACKS|BOTNETS|SCANNERS|REPUTATION|PHISHING|PROXY|MOBILE_THREATS|TOR_PROXY|DENIAL_OF_SERVICE|NETWORK] List of IP Threat Categories to choose. If the source IP matches on atleast one of the enabled IP threat categories, the request will be denied
1423
+ <a id="categories-bb360f"></a>&#x2022; [`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] List of IP Threat Categories to choose. If the source IP matches on atleast one of the enabled IP threat categories, the request will be denied
2396
1424
 
2397
1425
  #### GraphQL Rules
2398
1426
 
@@ -2478,79 +1506,31 @@ A [`tls_cert_params`](#https-tls-cert-options-tls-cert-params) block (within [`h
2478
1506
 
2479
1507
  #### HTTPS TLS Cert Options TLS Cert Params Certificates
2480
1508
 
2481
- A [`certificates`](#certificates-07e388) block (within [`https.tls_cert_options.tls_cert_params`](#https-tls-cert-options-tls-cert-params)) supports the following:
2482
-
2483
- <a id="name-2c13b1"></a>&#x2022; [`name`](#name-2c13b1) - Optional String<br>Name. 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
2484
-
2485
- <a id="namespace-f0d4e9"></a>&#x2022; [`namespace`](#namespace-f0d4e9) - Optional String<br>Namespace. 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
2486
-
2487
- <a id="tenant-af79c9"></a>&#x2022; [`tenant`](#tenant-af79c9) - Optional String<br>Tenant. 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
1509
+ <a id="deep-5f8c05"></a>Deeply nested **Certificates** block collapsed for readability.
2488
1510
 
2489
1511
  #### HTTPS TLS Cert Options TLS Cert Params TLS Config
2490
1512
 
2491
- A [`tls_config`](#config-904431) block (within [`https.tls_cert_options.tls_cert_params`](#https-tls-cert-options-tls-cert-params)) supports the following:
2492
-
2493
- <a id="security-ad30cf"></a>&#x2022; [`custom_security`](#security-ad30cf) - Optional Block<br>Custom Ciphers. This defines TLS protocol config including min/max versions and allowed ciphers<br>See [Custom Security](#security-ad30cf) below.
2494
-
2495
- <a id="security-4a43be"></a>&#x2022; [`default_security`](#security-4a43be) - Optional Block<br>Enable this option
2496
-
2497
- <a id="security-da78dd"></a>&#x2022; [`low_security`](#security-da78dd) - Optional Block<br>Enable this option
2498
-
2499
- <a id="security-7528e8"></a>&#x2022; [`medium_security`](#security-7528e8) - Optional Block<br>Enable this option
1513
+ <a id="deep-aa9282"></a>Deeply nested **Config** block collapsed for readability.
2500
1514
 
2501
1515
  #### HTTPS TLS Cert Options TLS Cert Params TLS Config Custom Security
2502
1516
 
2503
- A [`custom_security`](#security-ad30cf) block (within [`https.tls_cert_options.tls_cert_params.tls_config`](#config-904431)) supports the following:
2504
-
2505
- <a id="suites-36b0f0"></a>&#x2022; [`cipher_suites`](#suites-36b0f0) - Optional List<br>Cipher Suites. The TLS listener will only support the specified cipher list
2506
-
2507
- <a id="version-c078c7"></a>&#x2022; [`max_version`](#version-c078c7) - Optional String Defaults to `TLS_AUTO`<br>Possible values are `TLS_AUTO`, `TLSv1_0`, `TLSv1_1`, `TLSv1_2`, `TLSv1_3`<br>[Enum: TLS_AUTO|TLSv1_0|TLSv1_1|TLSv1_2|TLSv1_3] TLS Protocol. TlsProtocol is enumeration of supported TLS versions F5 Distributed Cloud will choose the optimal TLS version
2508
-
2509
- <a id="version-b42c6c"></a>&#x2022; [`min_version`](#version-b42c6c) - Optional String Defaults to `TLS_AUTO`<br>Possible values are `TLS_AUTO`, `TLSv1_0`, `TLSv1_1`, `TLSv1_2`, `TLSv1_3`<br>[Enum: TLS_AUTO|TLSv1_0|TLSv1_1|TLSv1_2|TLSv1_3] TLS Protocol. TlsProtocol is enumeration of supported TLS versions F5 Distributed Cloud will choose the optimal TLS version
1517
+ <a id="deep-2b4fe8"></a>Deeply nested **Security** block collapsed for readability.
2510
1518
 
2511
1519
  #### HTTPS TLS Cert Options TLS Cert Params Use mTLS
2512
1520
 
2513
- An [`use_mtls`](#mtls-5b281c) block (within [`https.tls_cert_options.tls_cert_params`](#https-tls-cert-options-tls-cert-params)) supports the following:
2514
-
2515
- <a id="optional-6f691d"></a>&#x2022; [`client_certificate_optional`](#optional-6f691d) - Optional Bool<br>Client Certificate Optional. Client certificate is optional. If the client has provided a certificate, the load balancer will verify it. If certification verification fails, the connection will be terminated. If the client does not provide a certificate, the connection will be accepted
2516
-
2517
- <a id="crl-2e52b8"></a>&#x2022; [`crl`](#crl-2e52b8) - Optional Block<br>Object reference. This 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 [CRL](#crl-2e52b8) below.
2518
-
2519
- <a id="crl-cd3350"></a>&#x2022; [`no_crl`](#crl-cd3350) - Optional Block<br>Enable this option
2520
-
2521
- <a id="trusted-ca-67f63a"></a>&#x2022; [`trusted_ca`](#trusted-ca-67f63a) - Optional Block<br>Object reference. This 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-67f63a) below.
2522
-
2523
- <a id="url-d6b2d6"></a>&#x2022; [`trusted_ca_url`](#url-d6b2d6) - Optional String<br>Inline Root CA Certificate (legacy). Upload a Root CA Certificate specifically for this Load Balancer
2524
-
2525
- <a id="disabled-55daeb"></a>&#x2022; [`xfcc_disabled`](#disabled-55daeb) - Optional Block<br>Enable this option
2526
-
2527
- <a id="options-43be35"></a>&#x2022; [`xfcc_options`](#options-43be35) - Optional Block<br>XFCC Header Elements. X-Forwarded-Client-Cert header elements to be added to requests<br>See [Xfcc Options](#options-43be35) below.
1521
+ <a id="deep-0ddb80"></a>Deeply nested **mTLS** block collapsed for readability.
2528
1522
 
2529
1523
  #### HTTPS TLS Cert Options TLS Cert Params Use mTLS CRL
2530
1524
 
2531
- A [`crl`](#crl-2e52b8) block (within [`https.tls_cert_options.tls_cert_params.use_mtls`](#mtls-5b281c)) supports the following:
2532
-
2533
- <a id="name-6c5098"></a>&#x2022; [`name`](#name-6c5098) - Optional String<br>Name. 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
2534
-
2535
- <a id="namespace-1a2fad"></a>&#x2022; [`namespace`](#namespace-1a2fad) - Optional String<br>Namespace. 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
2536
-
2537
- <a id="tenant-792738"></a>&#x2022; [`tenant`](#tenant-792738) - Optional String<br>Tenant. 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
1525
+ <a id="deep-4e8956"></a>Deeply nested **CRL** block collapsed for readability.
2538
1526
 
2539
1527
  #### HTTPS TLS Cert Options TLS Cert Params Use mTLS Trusted CA
2540
1528
 
2541
- A [`trusted_ca`](#trusted-ca-67f63a) block (within [`https.tls_cert_options.tls_cert_params.use_mtls`](#mtls-5b281c)) supports the following:
2542
-
2543
- <a id="name-36f524"></a>&#x2022; [`name`](#name-36f524) - Optional String<br>Name. 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
2544
-
2545
- <a id="namespace-4d871a"></a>&#x2022; [`namespace`](#namespace-4d871a) - Optional String<br>Namespace. 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
2546
-
2547
- <a id="tenant-471ef0"></a>&#x2022; [`tenant`](#tenant-471ef0) - Optional String<br>Tenant. 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
1529
+ <a id="deep-4221b5"></a>Deeply nested **CA** block collapsed for readability.
2548
1530
 
2549
1531
  #### HTTPS TLS Cert Options TLS Cert Params Use mTLS Xfcc Options
2550
1532
 
2551
- A [`xfcc_options`](#options-43be35) block (within [`https.tls_cert_options.tls_cert_params.use_mtls`](#mtls-5b281c)) supports the following:
2552
-
2553
- <a id="elements-4c0634"></a>&#x2022; [`xfcc_header_elements`](#elements-4c0634) - Optional List Defaults to `XFCC_NONE`<br>Possible values are `XFCC_NONE`, `XFCC_CERT`, `XFCC_CHAIN`, `XFCC_SUBJECT`, `XFCC_URI`, `XFCC_DNS`<br>[Enum: XFCC_NONE|XFCC_CERT|XFCC_CHAIN|XFCC_SUBJECT|XFCC_URI|XFCC_DNS] XFCC Header Elements. X-Forwarded-Client-Cert header elements to be added to requests
1533
+ <a id="deep-96e88a"></a>Deeply nested **Options** block collapsed for readability.
2554
1534
 
2555
1535
  #### HTTPS TLS Cert Options TLS Inline Params
2556
1536
 
@@ -2566,117 +1546,47 @@ A [`tls_inline_params`](#params-9a3f4e) block (within [`https.tls_cert_options`]
2566
1546
 
2567
1547
  #### HTTPS TLS Cert Options TLS Inline Params TLS Certificates
2568
1548
 
2569
- A [`tls_certificates`](#certificates-f306b2) block (within [`https.tls_cert_options.tls_inline_params`](#params-9a3f4e)) supports the following:
2570
-
2571
- <a id="url-e06ef2"></a>&#x2022; [`certificate_url`](#url-e06ef2) - Optional String<br>Certificate. TLS certificate. Certificate or certificate chain in PEM format including the PEM headers
2572
-
2573
- <a id="algorithms-c24d80"></a>&#x2022; [`custom_hash_algorithms`](#algorithms-c24d80) - Optional Block<br>Hash Algorithms. Specifies the hash algorithms to be used<br>See [Custom Hash Algorithms](#algorithms-c24d80) below.
2574
-
2575
- <a id="spec-919b83"></a>&#x2022; [`description_spec`](#spec-919b83) - Optional String<br>Description. Description for the certificate
2576
-
2577
- <a id="stapling-6d0a79"></a>&#x2022; [`disable_ocsp_stapling`](#stapling-6d0a79) - Optional Block<br>Enable this option
2578
-
2579
- <a id="key-e4c2f5"></a>&#x2022; [`private_key`](#key-e4c2f5) - Optional Block<br>Secret. SecretType is used in an object to indicate a sensitive/confidential field<br>See [Private Key](#key-e4c2f5) below.
2580
-
2581
- <a id="defaults-fef4a6"></a>&#x2022; [`use_system_defaults`](#defaults-fef4a6) - Optional Block<br>Enable this option
1549
+ <a id="deep-910848"></a>Deeply nested **Certificates** block collapsed for readability.
2582
1550
 
2583
1551
  #### HTTPS TLS Cert Options TLS Inline Params TLS Certificates Custom Hash Algorithms
2584
1552
 
2585
- A [`custom_hash_algorithms`](#algorithms-c24d80) block (within [`https.tls_cert_options.tls_inline_params.tls_certificates`](#certificates-f306b2)) supports the following:
2586
-
2587
- <a id="algorithms-09af2e"></a>&#x2022; [`hash_algorithms`](#algorithms-09af2e) - Optional List Defaults to `INVALID_HASH_ALGORITHM`<br>Possible values are `INVALID_HASH_ALGORITHM`, `SHA256`, `SHA1`<br>[Enum: INVALID_HASH_ALGORITHM|SHA256|SHA1] Hash Algorithms. Ordered list of hash algorithms to be used
1553
+ <a id="deep-5f067d"></a>Deeply nested **Algorithms** block collapsed for readability.
2588
1554
 
2589
1555
  #### HTTPS TLS Cert Options TLS Inline Params TLS Certificates Private Key
2590
1556
 
2591
- A [`private_key`](#key-e4c2f5) block (within [`https.tls_cert_options.tls_inline_params.tls_certificates`](#certificates-f306b2)) supports the following:
2592
-
2593
- <a id="info-b1b95d"></a>&#x2022; [`blindfold_secret_info`](#info-b1b95d) - Optional Block<br>Blindfold Secret. BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management<br>See [Blindfold Secret Info](#info-b1b95d) below.
2594
-
2595
- <a id="info-c36e13"></a>&#x2022; [`clear_secret_info`](#info-c36e13) - Optional Block<br>In-Clear Secret. ClearSecretInfoType specifies information about the Secret that is not encrypted<br>See [Clear Secret Info](#info-c36e13) below.
1557
+ <a id="deep-1a10f5"></a>Deeply nested **Key** block collapsed for readability.
2596
1558
 
2597
1559
  #### HTTPS TLS Cert Options TLS Inline Params TLS Certificates Private Key Blindfold Secret Info
2598
1560
 
2599
- A [`blindfold_secret_info`](#info-b1b95d) block (within [`https.tls_cert_options.tls_inline_params.tls_certificates.private_key`](#key-e4c2f5)) supports the following:
2600
-
2601
- <a id="provider-2338d9"></a>&#x2022; [`decryption_provider`](#provider-2338d9) - Optional String<br>Decryption Provider. Name of the Secret Management Access object that contains information about the backend Secret Management service
2602
-
2603
- <a id="location-c1d1ee"></a>&#x2022; [`location`](#location-c1d1ee) - Optional String<br>Location. Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location
2604
-
2605
- <a id="provider-994646"></a>&#x2022; [`store_provider`](#provider-994646) - Optional String<br>Store Provider. Name of the Secret Management Access object that contains information about the store to get encrypted bytes This field needs to be provided only if the URL scheme is not string:///
1561
+ <a id="deep-475fb9"></a>Deeply nested **Info** block collapsed for readability.
2606
1562
 
2607
1563
  #### HTTPS TLS Cert Options TLS Inline Params TLS Certificates Private Key Clear Secret Info
2608
1564
 
2609
- A [`clear_secret_info`](#info-c36e13) block (within [`https.tls_cert_options.tls_inline_params.tls_certificates.private_key`](#key-e4c2f5)) supports the following:
2610
-
2611
- <a id="ref-a708bd"></a>&#x2022; [`provider_ref`](#ref-a708bd) - Optional String<br>Provider. Name of the Secret Management Access object that contains information about the store to get encrypted bytes This field needs to be provided only if the URL scheme is not string:///
2612
-
2613
- <a id="url-d2bf3c"></a>&#x2022; [`url`](#url-d2bf3c) - Optional String<br>URL. URL of the secret. Currently supported URL schemes is string:///. For string:/// scheme, Secret needs to be encoded Base64 format. When asked for this secret, caller will get Secret bytes after Base64 decoding
1565
+ <a id="deep-088787"></a>Deeply nested **Info** block collapsed for readability.
2614
1566
 
2615
1567
  #### HTTPS TLS Cert Options TLS Inline Params TLS Config
2616
1568
 
2617
- A [`tls_config`](#config-22f363) block (within [`https.tls_cert_options.tls_inline_params`](#params-9a3f4e)) supports the following:
2618
-
2619
- <a id="security-62ce0a"></a>&#x2022; [`custom_security`](#security-62ce0a) - Optional Block<br>Custom Ciphers. This defines TLS protocol config including min/max versions and allowed ciphers<br>See [Custom Security](#security-62ce0a) below.
2620
-
2621
- <a id="security-4764ca"></a>&#x2022; [`default_security`](#security-4764ca) - Optional Block<br>Enable this option
2622
-
2623
- <a id="security-59f0a3"></a>&#x2022; [`low_security`](#security-59f0a3) - Optional Block<br>Enable this option
2624
-
2625
- <a id="security-19669a"></a>&#x2022; [`medium_security`](#security-19669a) - Optional Block<br>Enable this option
1569
+ <a id="deep-218928"></a>Deeply nested **Config** block collapsed for readability.
2626
1570
 
2627
1571
  #### HTTPS TLS Cert Options TLS Inline Params TLS Config Custom Security
2628
1572
 
2629
- A [`custom_security`](#security-62ce0a) block (within [`https.tls_cert_options.tls_inline_params.tls_config`](#config-22f363)) supports the following:
2630
-
2631
- <a id="suites-33ea9f"></a>&#x2022; [`cipher_suites`](#suites-33ea9f) - Optional List<br>Cipher Suites. The TLS listener will only support the specified cipher list
2632
-
2633
- <a id="version-e0ff8d"></a>&#x2022; [`max_version`](#version-e0ff8d) - Optional String Defaults to `TLS_AUTO`<br>Possible values are `TLS_AUTO`, `TLSv1_0`, `TLSv1_1`, `TLSv1_2`, `TLSv1_3`<br>[Enum: TLS_AUTO|TLSv1_0|TLSv1_1|TLSv1_2|TLSv1_3] TLS Protocol. TlsProtocol is enumeration of supported TLS versions F5 Distributed Cloud will choose the optimal TLS version
2634
-
2635
- <a id="version-816966"></a>&#x2022; [`min_version`](#version-816966) - Optional String Defaults to `TLS_AUTO`<br>Possible values are `TLS_AUTO`, `TLSv1_0`, `TLSv1_1`, `TLSv1_2`, `TLSv1_3`<br>[Enum: TLS_AUTO|TLSv1_0|TLSv1_1|TLSv1_2|TLSv1_3] TLS Protocol. TlsProtocol is enumeration of supported TLS versions F5 Distributed Cloud will choose the optimal TLS version
1573
+ <a id="deep-0f112d"></a>Deeply nested **Security** block collapsed for readability.
2636
1574
 
2637
1575
  #### HTTPS TLS Cert Options TLS Inline Params Use mTLS
2638
1576
 
2639
- An [`use_mtls`](#mtls-fdc332) block (within [`https.tls_cert_options.tls_inline_params`](#params-9a3f4e)) supports the following:
2640
-
2641
- <a id="optional-e832ba"></a>&#x2022; [`client_certificate_optional`](#optional-e832ba) - Optional Bool<br>Client Certificate Optional. Client certificate is optional. If the client has provided a certificate, the load balancer will verify it. If certification verification fails, the connection will be terminated. If the client does not provide a certificate, the connection will be accepted
2642
-
2643
- <a id="crl-8ccb71"></a>&#x2022; [`crl`](#crl-8ccb71) - Optional Block<br>Object reference. This 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 [CRL](#crl-8ccb71) below.
2644
-
2645
- <a id="crl-8ecfcc"></a>&#x2022; [`no_crl`](#crl-8ecfcc) - Optional Block<br>Enable this option
2646
-
2647
- <a id="trusted-ca-ab61c8"></a>&#x2022; [`trusted_ca`](#trusted-ca-ab61c8) - Optional Block<br>Object reference. This 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-ab61c8) below.
2648
-
2649
- <a id="url-d741c1"></a>&#x2022; [`trusted_ca_url`](#url-d741c1) - Optional String<br>Inline Root CA Certificate (legacy). Upload a Root CA Certificate specifically for this Load Balancer
2650
-
2651
- <a id="disabled-1e1507"></a>&#x2022; [`xfcc_disabled`](#disabled-1e1507) - Optional Block<br>Enable this option
2652
-
2653
- <a id="options-e0ad26"></a>&#x2022; [`xfcc_options`](#options-e0ad26) - Optional Block<br>XFCC Header Elements. X-Forwarded-Client-Cert header elements to be added to requests<br>See [Xfcc Options](#options-e0ad26) below.
1577
+ <a id="deep-328647"></a>Deeply nested **mTLS** block collapsed for readability.
2654
1578
 
2655
1579
  #### HTTPS TLS Cert Options TLS Inline Params Use mTLS CRL
2656
1580
 
2657
- A [`crl`](#crl-8ccb71) block (within [`https.tls_cert_options.tls_inline_params.use_mtls`](#mtls-fdc332)) supports the following:
2658
-
2659
- <a id="name-f26227"></a>&#x2022; [`name`](#name-f26227) - Optional String<br>Name. 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
2660
-
2661
- <a id="namespace-0c8648"></a>&#x2022; [`namespace`](#namespace-0c8648) - Optional String<br>Namespace. 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
2662
-
2663
- <a id="tenant-0c861d"></a>&#x2022; [`tenant`](#tenant-0c861d) - Optional String<br>Tenant. 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
1581
+ <a id="deep-a76fcd"></a>Deeply nested **CRL** block collapsed for readability.
2664
1582
 
2665
1583
  #### HTTPS TLS Cert Options TLS Inline Params Use mTLS Trusted CA
2666
1584
 
2667
- A [`trusted_ca`](#trusted-ca-ab61c8) block (within [`https.tls_cert_options.tls_inline_params.use_mtls`](#mtls-fdc332)) supports the following:
2668
-
2669
- <a id="name-a58884"></a>&#x2022; [`name`](#name-a58884) - Optional String<br>Name. 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
2670
-
2671
- <a id="namespace-0d9b43"></a>&#x2022; [`namespace`](#namespace-0d9b43) - Optional String<br>Namespace. 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
2672
-
2673
- <a id="tenant-59dc74"></a>&#x2022; [`tenant`](#tenant-59dc74) - Optional String<br>Tenant. 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
1585
+ <a id="deep-079423"></a>Deeply nested **CA** block collapsed for readability.
2674
1586
 
2675
1587
  #### HTTPS TLS Cert Options TLS Inline Params Use mTLS Xfcc Options
2676
1588
 
2677
- A [`xfcc_options`](#options-e0ad26) block (within [`https.tls_cert_options.tls_inline_params.use_mtls`](#mtls-fdc332)) supports the following:
2678
-
2679
- <a id="elements-ac3e86"></a>&#x2022; [`xfcc_header_elements`](#elements-ac3e86) - Optional List Defaults to `XFCC_NONE`<br>Possible values are `XFCC_NONE`, `XFCC_CERT`, `XFCC_CHAIN`, `XFCC_SUBJECT`, `XFCC_URI`, `XFCC_DNS`<br>[Enum: XFCC_NONE|XFCC_CERT|XFCC_CHAIN|XFCC_SUBJECT|XFCC_URI|XFCC_DNS] XFCC Header Elements. X-Forwarded-Client-Cert header elements to be added to requests
1589
+ <a id="deep-5f17b1"></a>Deeply nested **Options** block collapsed for readability.
2680
1590
 
2681
1591
  #### HTTPS Auto Cert
2682
1592
 
@@ -2902,13 +1812,7 @@ A [`tls_config`](#origin-pool-use-tls-tls-config) block (within [`origin_pool.us
2902
1812
 
2903
1813
  #### Origin Pool Use TLS TLS Config Custom Security
2904
1814
 
2905
- A [`custom_security`](#security-0634ba) block (within [`origin_pool.use_tls.tls_config`](#origin-pool-use-tls-tls-config)) supports the following:
2906
-
2907
- <a id="suites-2b82dd"></a>&#x2022; [`cipher_suites`](#suites-2b82dd) - Optional List<br>Cipher Suites. The TLS listener will only support the specified cipher list
2908
-
2909
- <a id="version-a06e54"></a>&#x2022; [`max_version`](#version-a06e54) - Optional String Defaults to `TLS_AUTO`<br>Possible values are `TLS_AUTO`, `TLSv1_0`, `TLSv1_1`, `TLSv1_2`, `TLSv1_3`<br>[Enum: TLS_AUTO|TLSv1_0|TLSv1_1|TLSv1_2|TLSv1_3] TLS Protocol. TlsProtocol is enumeration of supported TLS versions F5 Distributed Cloud will choose the optimal TLS version
2910
-
2911
- <a id="version-601bac"></a>&#x2022; [`min_version`](#version-601bac) - Optional String Defaults to `TLS_AUTO`<br>Possible values are `TLS_AUTO`, `TLSv1_0`, `TLSv1_1`, `TLSv1_2`, `TLSv1_3`<br>[Enum: TLS_AUTO|TLSv1_0|TLSv1_1|TLSv1_2|TLSv1_3] TLS Protocol. TlsProtocol is enumeration of supported TLS versions F5 Distributed Cloud will choose the optimal TLS version
1815
+ <a id="deep-723457"></a>Deeply nested **Security** block collapsed for readability.
2912
1816
 
2913
1817
  #### Origin Pool Use TLS Use mTLS
2914
1818
 
@@ -2918,61 +1822,27 @@ An [`use_mtls`](#origin-pool-use-tls-use-mtls) block (within [`origin_pool.use_t
2918
1822
 
2919
1823
  #### Origin Pool Use TLS Use mTLS TLS Certificates
2920
1824
 
2921
- A [`tls_certificates`](#certificates-3ce4a4) block (within [`origin_pool.use_tls.use_mtls`](#origin-pool-use-tls-use-mtls)) supports the following:
2922
-
2923
- <a id="url-596918"></a>&#x2022; [`certificate_url`](#url-596918) - Optional String<br>Certificate. TLS certificate. Certificate or certificate chain in PEM format including the PEM headers
2924
-
2925
- <a id="algorithms-e11f25"></a>&#x2022; [`custom_hash_algorithms`](#algorithms-e11f25) - Optional Block<br>Hash Algorithms. Specifies the hash algorithms to be used<br>See [Custom Hash Algorithms](#algorithms-e11f25) below.
2926
-
2927
- <a id="spec-ad3e86"></a>&#x2022; [`description_spec`](#spec-ad3e86) - Optional String<br>Description. Description for the certificate
2928
-
2929
- <a id="stapling-33fd0f"></a>&#x2022; [`disable_ocsp_stapling`](#stapling-33fd0f) - Optional Block<br>Enable this option
2930
-
2931
- <a id="key-8f9e83"></a>&#x2022; [`private_key`](#key-8f9e83) - Optional Block<br>Secret. SecretType is used in an object to indicate a sensitive/confidential field<br>See [Private Key](#key-8f9e83) below.
2932
-
2933
- <a id="defaults-9efe50"></a>&#x2022; [`use_system_defaults`](#defaults-9efe50) - Optional Block<br>Enable this option
1825
+ <a id="deep-c44369"></a>Deeply nested **Certificates** block collapsed for readability.
2934
1826
 
2935
1827
  #### Origin Pool Use TLS Use mTLS TLS Certificates Custom Hash Algorithms
2936
1828
 
2937
- A [`custom_hash_algorithms`](#algorithms-e11f25) block (within [`origin_pool.use_tls.use_mtls.tls_certificates`](#certificates-3ce4a4)) supports the following:
2938
-
2939
- <a id="algorithms-ba9c4c"></a>&#x2022; [`hash_algorithms`](#algorithms-ba9c4c) - Optional List Defaults to `INVALID_HASH_ALGORITHM`<br>Possible values are `INVALID_HASH_ALGORITHM`, `SHA256`, `SHA1`<br>[Enum: INVALID_HASH_ALGORITHM|SHA256|SHA1] Hash Algorithms. Ordered list of hash algorithms to be used
1829
+ <a id="deep-b56fdc"></a>Deeply nested **Algorithms** block collapsed for readability.
2940
1830
 
2941
1831
  #### Origin Pool Use TLS Use mTLS TLS Certificates Private Key
2942
1832
 
2943
- A [`private_key`](#key-8f9e83) block (within [`origin_pool.use_tls.use_mtls.tls_certificates`](#certificates-3ce4a4)) supports the following:
2944
-
2945
- <a id="info-aa607f"></a>&#x2022; [`blindfold_secret_info`](#info-aa607f) - Optional Block<br>Blindfold Secret. BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management<br>See [Blindfold Secret Info](#info-aa607f) below.
2946
-
2947
- <a id="info-634eb3"></a>&#x2022; [`clear_secret_info`](#info-634eb3) - Optional Block<br>In-Clear Secret. ClearSecretInfoType specifies information about the Secret that is not encrypted<br>See [Clear Secret Info](#info-634eb3) below.
1833
+ <a id="deep-986401"></a>Deeply nested **Key** block collapsed for readability.
2948
1834
 
2949
1835
  #### Origin Pool Use TLS Use mTLS TLS Certificates Private Key Blindfold Secret Info
2950
1836
 
2951
- A [`blindfold_secret_info`](#info-aa607f) block (within [`origin_pool.use_tls.use_mtls.tls_certificates.private_key`](#key-8f9e83)) supports the following:
2952
-
2953
- <a id="provider-6c4e57"></a>&#x2022; [`decryption_provider`](#provider-6c4e57) - Optional String<br>Decryption Provider. Name of the Secret Management Access object that contains information about the backend Secret Management service
2954
-
2955
- <a id="location-07b7e9"></a>&#x2022; [`location`](#location-07b7e9) - Optional String<br>Location. Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location
2956
-
2957
- <a id="provider-5c59f1"></a>&#x2022; [`store_provider`](#provider-5c59f1) - Optional String<br>Store Provider. Name of the Secret Management Access object that contains information about the store to get encrypted bytes This field needs to be provided only if the URL scheme is not string:///
1837
+ <a id="deep-9ff3ae"></a>Deeply nested **Info** block collapsed for readability.
2958
1838
 
2959
1839
  #### Origin Pool Use TLS Use mTLS TLS Certificates Private Key Clear Secret Info
2960
1840
 
2961
- A [`clear_secret_info`](#info-634eb3) block (within [`origin_pool.use_tls.use_mtls.tls_certificates.private_key`](#key-8f9e83)) supports the following:
2962
-
2963
- <a id="ref-82e53f"></a>&#x2022; [`provider_ref`](#ref-82e53f) - Optional String<br>Provider. Name of the Secret Management Access object that contains information about the store to get encrypted bytes This field needs to be provided only if the URL scheme is not string:///
2964
-
2965
- <a id="url-64f788"></a>&#x2022; [`url`](#url-64f788) - Optional String<br>URL. URL of the secret. Currently supported URL schemes is string:///. For string:/// scheme, Secret needs to be encoded Base64 format. When asked for this secret, caller will get Secret bytes after Base64 decoding
1841
+ <a id="deep-385fe9"></a>Deeply nested **Info** block collapsed for readability.
2966
1842
 
2967
1843
  #### Origin Pool Use TLS Use mTLS Obj
2968
1844
 
2969
- An [`use_mtls_obj`](#origin-pool-use-tls-use-mtls-obj) block (within [`origin_pool.use_tls`](#origin-pool-use-tls)) supports the following:
2970
-
2971
- <a id="origin-pool-use-tls-use-mtls-obj-name"></a>&#x2022; [`name`](#origin-pool-use-tls-use-mtls-obj-name) - Optional String<br>Name. 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
2972
-
2973
- <a id="namespace-cadfb2"></a>&#x2022; [`namespace`](#namespace-cadfb2) - Optional String<br>Namespace. 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
2974
-
2975
- <a id="origin-pool-use-tls-use-mtls-obj-tenant"></a>&#x2022; [`tenant`](#origin-pool-use-tls-use-mtls-obj-tenant) - Optional String<br>Tenant. 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
1845
+ <a id="objref-86aaaa"></a>Uses standard [Object Reference](#common-object-reference) fields (name, namespace, tenant).
2976
1846
 
2977
1847
  #### Origin Pool Use TLS Use Server Verification
2978
1848
 
@@ -2984,13 +1854,7 @@ An [`use_server_verification`](#verification-1ac9e2) block (within [`origin_pool
2984
1854
 
2985
1855
  #### Origin Pool Use TLS Use Server Verification Trusted CA
2986
1856
 
2987
- A [`trusted_ca`](#trusted-ca-c2c605) block (within [`origin_pool.use_tls.use_server_verification`](#verification-1ac9e2)) supports the following:
2988
-
2989
- <a id="name-84293c"></a>&#x2022; [`name`](#name-84293c) - Optional String<br>Name. 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
2990
-
2991
- <a id="namespace-1ed910"></a>&#x2022; [`namespace`](#namespace-1ed910) - Optional String<br>Namespace. 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
2992
-
2993
- <a id="tenant-580b39"></a>&#x2022; [`tenant`](#tenant-580b39) - Optional String<br>Tenant. 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
1857
+ <a id="deep-33f32d"></a>Deeply nested **CA** block collapsed for readability.
2994
1858
 
2995
1859
  #### Other Settings
2996
1860
 
@@ -3016,79 +1880,35 @@ A [`header_options`](#other-settings-header-options) block (within [`other_setti
3016
1880
 
3017
1881
  #### Other Settings Header Options Request Headers To Add
3018
1882
 
3019
- A [`request_headers_to_add`](#add-efdf59) block (within [`other_settings.header_options`](#other-settings-header-options)) supports the following:
3020
-
3021
- <a id="append-064888"></a>&#x2022; [`append`](#append-064888) - Optional Bool Defaults to `do`<br>Append. Should the value be appended? If true, the value is appended to existing values. not append
3022
-
3023
- <a id="name-8a2e4c"></a>&#x2022; [`name`](#name-8a2e4c) - Optional String<br>Name. Name of the HTTP header
3024
-
3025
- <a id="value-1e6dac"></a>&#x2022; [`secret_value`](#value-1e6dac) - Optional Block<br>Secret. SecretType is used in an object to indicate a sensitive/confidential field<br>See [Secret Value](#value-1e6dac) below.
3026
-
3027
- <a id="value-bc0514"></a>&#x2022; [`value`](#value-bc0514) - Optional String<br>Value. Value of the HTTP header
1883
+ <a id="deep-8d939b"></a>Deeply nested **Add** block collapsed for readability.
3028
1884
 
3029
1885
  #### Other Settings Header Options Request Headers To Add Secret Value
3030
1886
 
3031
- A [`secret_value`](#value-1e6dac) block (within [`other_settings.header_options.request_headers_to_add`](#add-efdf59)) supports the following:
3032
-
3033
- <a id="info-e59735"></a>&#x2022; [`blindfold_secret_info`](#info-e59735) - Optional Block<br>Blindfold Secret. BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management<br>See [Blindfold Secret Info](#info-e59735) below.
3034
-
3035
- <a id="info-0a9b69"></a>&#x2022; [`clear_secret_info`](#info-0a9b69) - Optional Block<br>In-Clear Secret. ClearSecretInfoType specifies information about the Secret that is not encrypted<br>See [Clear Secret Info](#info-0a9b69) below.
1887
+ <a id="deep-0b788e"></a>Deeply nested **Value** block collapsed for readability.
3036
1888
 
3037
1889
  #### Other Settings Header Options Request Headers To Add Secret Value Blindfold Secret Info
3038
1890
 
3039
- A [`blindfold_secret_info`](#info-e59735) block (within [`other_settings.header_options.request_headers_to_add.secret_value`](#value-1e6dac)) supports the following:
3040
-
3041
- <a id="provider-7bfba7"></a>&#x2022; [`decryption_provider`](#provider-7bfba7) - Optional String<br>Decryption Provider. Name of the Secret Management Access object that contains information about the backend Secret Management service
3042
-
3043
- <a id="location-9709d8"></a>&#x2022; [`location`](#location-9709d8) - Optional String<br>Location. Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location
3044
-
3045
- <a id="provider-186f06"></a>&#x2022; [`store_provider`](#provider-186f06) - Optional String<br>Store Provider. Name of the Secret Management Access object that contains information about the store to get encrypted bytes This field needs to be provided only if the URL scheme is not string:///
1891
+ <a id="deep-da70e1"></a>Deeply nested **Info** block collapsed for readability.
3046
1892
 
3047
1893
  #### Other Settings Header Options Request Headers To Add Secret Value Clear Secret Info
3048
1894
 
3049
- A [`clear_secret_info`](#info-0a9b69) block (within [`other_settings.header_options.request_headers_to_add.secret_value`](#value-1e6dac)) supports the following:
3050
-
3051
- <a id="ref-cc7a80"></a>&#x2022; [`provider_ref`](#ref-cc7a80) - Optional String<br>Provider. Name of the Secret Management Access object that contains information about the store to get encrypted bytes This field needs to be provided only if the URL scheme is not string:///
3052
-
3053
- <a id="url-be193b"></a>&#x2022; [`url`](#url-be193b) - Optional String<br>URL. URL of the secret. Currently supported URL schemes is string:///. For string:/// scheme, Secret needs to be encoded Base64 format. When asked for this secret, caller will get Secret bytes after Base64 decoding
1895
+ <a id="deep-0e70d5"></a>Deeply nested **Info** block collapsed for readability.
3054
1896
 
3055
1897
  #### Other Settings Header Options Response Headers To Add
3056
1898
 
3057
- A [`response_headers_to_add`](#add-f6ecb9) block (within [`other_settings.header_options`](#other-settings-header-options)) supports the following:
3058
-
3059
- <a id="append-182d05"></a>&#x2022; [`append`](#append-182d05) - Optional Bool Defaults to `do`<br>Append. Should the value be appended? If true, the value is appended to existing values. not append
3060
-
3061
- <a id="name-f3846a"></a>&#x2022; [`name`](#name-f3846a) - Optional String<br>Name. Name of the HTTP header
3062
-
3063
- <a id="value-8ec2c3"></a>&#x2022; [`secret_value`](#value-8ec2c3) - Optional Block<br>Secret. SecretType is used in an object to indicate a sensitive/confidential field<br>See [Secret Value](#value-8ec2c3) below.
3064
-
3065
- <a id="value-fe1848"></a>&#x2022; [`value`](#value-fe1848) - Optional String<br>Value. Value of the HTTP header
1899
+ <a id="deep-91db8e"></a>Deeply nested **Add** block collapsed for readability.
3066
1900
 
3067
1901
  #### Other Settings Header Options Response Headers To Add Secret Value
3068
1902
 
3069
- A [`secret_value`](#value-8ec2c3) block (within [`other_settings.header_options.response_headers_to_add`](#add-f6ecb9)) supports the following:
3070
-
3071
- <a id="info-b99394"></a>&#x2022; [`blindfold_secret_info`](#info-b99394) - Optional Block<br>Blindfold Secret. BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management<br>See [Blindfold Secret Info](#info-b99394) below.
3072
-
3073
- <a id="info-665bff"></a>&#x2022; [`clear_secret_info`](#info-665bff) - Optional Block<br>In-Clear Secret. ClearSecretInfoType specifies information about the Secret that is not encrypted<br>See [Clear Secret Info](#info-665bff) below.
1903
+ <a id="deep-279dc7"></a>Deeply nested **Value** block collapsed for readability.
3074
1904
 
3075
1905
  #### Other Settings Header Options Response Headers To Add Secret Value Blindfold Secret Info
3076
1906
 
3077
- A [`blindfold_secret_info`](#info-b99394) block (within [`other_settings.header_options.response_headers_to_add.secret_value`](#value-8ec2c3)) supports the following:
3078
-
3079
- <a id="provider-f8b5cd"></a>&#x2022; [`decryption_provider`](#provider-f8b5cd) - Optional String<br>Decryption Provider. Name of the Secret Management Access object that contains information about the backend Secret Management service
3080
-
3081
- <a id="location-f7e39f"></a>&#x2022; [`location`](#location-f7e39f) - Optional String<br>Location. Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location
3082
-
3083
- <a id="provider-559907"></a>&#x2022; [`store_provider`](#provider-559907) - Optional String<br>Store Provider. Name of the Secret Management Access object that contains information about the store to get encrypted bytes This field needs to be provided only if the URL scheme is not string:///
1907
+ <a id="deep-6c7d71"></a>Deeply nested **Info** block collapsed for readability.
3084
1908
 
3085
1909
  #### Other Settings Header Options Response Headers To Add Secret Value Clear Secret Info
3086
1910
 
3087
- A [`clear_secret_info`](#info-665bff) block (within [`other_settings.header_options.response_headers_to_add.secret_value`](#value-8ec2c3)) supports the following:
3088
-
3089
- <a id="ref-3935ee"></a>&#x2022; [`provider_ref`](#ref-3935ee) - Optional String<br>Provider. Name of the Secret Management Access object that contains information about the store to get encrypted bytes This field needs to be provided only if the URL scheme is not string:///
3090
-
3091
- <a id="url-ca80b9"></a>&#x2022; [`url`](#url-ca80b9) - Optional String<br>URL. URL of the secret. Currently supported URL schemes is string:///. For string:/// scheme, Secret needs to be encoded Base64 format. When asked for this secret, caller will get Secret bytes after Base64 decoding
1911
+ <a id="deep-08104e"></a>Deeply nested **Info** block collapsed for readability.
3092
1912
 
3093
1913
  #### Other Settings Logging Options
3094
1914
 
@@ -3158,13 +1978,7 @@ A [`js_challenge_parameters`](#parameters-65055e) block (within [`policy_based_c
3158
1978
 
3159
1979
  #### Policy Based Challenge Malicious User Mitigation
3160
1980
 
3161
- A [`malicious_user_mitigation`](#mitigation-d19aea) block (within [`policy_based_challenge`](#policy-based-challenge)) supports the following:
3162
-
3163
- <a id="name-0fb02d"></a>&#x2022; [`name`](#name-0fb02d) - Optional String<br>Name. 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
3164
-
3165
- <a id="namespace-490d76"></a>&#x2022; [`namespace`](#namespace-490d76) - Optional String<br>Namespace. 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
3166
-
3167
- <a id="tenant-cf334a"></a>&#x2022; [`tenant`](#tenant-cf334a) - Optional String<br>Tenant. 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
1981
+ <a id="objref-d19aea"></a>Uses standard [Object Reference](#common-object-reference) fields (name, namespace, tenant).
3168
1982
 
3169
1983
  #### Policy Based Challenge Rule List
3170
1984
 
@@ -3236,213 +2050,83 @@ A [`spec`](#spec-fbd0f9) block (within [`policy_based_challenge.rule_list.rules`
3236
2050
 
3237
2051
  #### Policy Based Challenge Rule List Rules Spec Arg Matchers
3238
2052
 
3239
- An [`arg_matchers`](#matchers-86dff2) block (within [`policy_based_challenge.rule_list.rules.spec`](#spec-fbd0f9)) supports the following:
3240
-
3241
- <a id="present-9fee6d"></a>&#x2022; [`check_not_present`](#present-9fee6d) - Optional Block<br>Enable this option
3242
-
3243
- <a id="present-07ddc9"></a>&#x2022; [`check_present`](#present-07ddc9) - Optional Block<br>Enable this option
3244
-
3245
- <a id="matcher-e00de3"></a>&#x2022; [`invert_matcher`](#matcher-e00de3) - Optional Bool<br>Invert Matcher. Invert Match of the expression defined
3246
-
3247
- <a id="item-ab8776"></a>&#x2022; [`item`](#item-ab8776) - Optional Block<br>Matcher. A 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-ab8776) below.
3248
-
3249
- <a id="name-965072"></a>&#x2022; [`name`](#name-965072) - Optional String<br>Argument Name. A case-sensitive JSON path in the HTTP request body
2053
+ <a id="deep-eb8ffe"></a>Deeply nested **Matchers** block collapsed for readability.
3250
2054
 
3251
2055
  #### Policy Based Challenge Rule List Rules Spec Arg Matchers Item
3252
2056
 
3253
- An [`item`](#item-ab8776) block (within [`policy_based_challenge.rule_list.rules.spec.arg_matchers`](#matchers-86dff2)) supports the following:
3254
-
3255
- <a id="values-b5c3b2"></a>&#x2022; [`exact_values`](#values-b5c3b2) - Optional List<br>Exact Values. A list of exact values to match the input against
3256
-
3257
- <a id="values-8f235d"></a>&#x2022; [`regex_values`](#values-8f235d) - Optional List<br>Regex Values. A list of regular expressions to match the input against
3258
-
3259
- <a id="transformers-707b5a"></a>&#x2022; [`transformers`](#transformers-707b5a) - Optional List Defaults to `TRANSFORMER_NONE`<br>Possible values are `LOWER_CASE`, `UPPER_CASE`, `BASE64_DECODE`, `NORMALIZE_PATH`, `REMOVE_WHITESPACE`, `URL_DECODE`, `TRIM_LEFT`, `TRIM_RIGHT`, `TRIM`<br>[Enum: LOWER_CASE|UPPER_CASE|BASE64_DECODE|NORMALIZE_PATH|REMOVE_WHITESPACE|URL_DECODE|TRIM_LEFT|TRIM_RIGHT|TRIM] Transformers. An ordered list of transformers (starting from index 0) to be applied to the path before matching
2057
+ <a id="deep-e03a12"></a>Deeply nested **Item** block collapsed for readability.
3260
2058
 
3261
2059
  #### Policy Based Challenge Rule List Rules Spec Asn List
3262
2060
 
3263
- An [`asn_list`](#list-628bd4) block (within [`policy_based_challenge.rule_list.rules.spec`](#spec-fbd0f9)) supports the following:
3264
-
3265
- <a id="numbers-deb154"></a>&#x2022; [`as_numbers`](#numbers-deb154) - Optional List<br>AS Numbers. An 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
2061
+ <a id="deep-8e9207"></a>Deeply nested **List** block collapsed for readability.
3266
2062
 
3267
2063
  #### Policy Based Challenge Rule List Rules Spec Asn Matcher
3268
2064
 
3269
- An [`asn_matcher`](#matcher-6b840c) block (within [`policy_based_challenge.rule_list.rules.spec`](#spec-fbd0f9)) supports the following:
3270
-
3271
- <a id="sets-be0fa6"></a>&#x2022; [`asn_sets`](#sets-be0fa6) - Optional Block<br>BGP ASN Sets. A list of references to bgp_asn_set objects<br>See [Asn Sets](#sets-be0fa6) below.
2065
+ <a id="deep-4e0cfb"></a>Deeply nested **Matcher** block collapsed for readability.
3272
2066
 
3273
2067
  #### Policy Based Challenge Rule List Rules Spec Asn Matcher Asn Sets
3274
2068
 
3275
- An [`asn_sets`](#sets-be0fa6) block (within [`policy_based_challenge.rule_list.rules.spec.asn_matcher`](#matcher-6b840c)) supports the following:
3276
-
3277
- <a id="kind-fe53d2"></a>&#x2022; [`kind`](#kind-fe53d2) - Optional String<br>Kind. When a configuration object(e.g. virtual_host) refers to another(e.g route) then kind will hold the referred object's kind (e.g. 'route')
3278
-
3279
- <a id="name-064ac5"></a>&#x2022; [`name`](#name-064ac5) - Optional String<br>Name. 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
3280
-
3281
- <a id="namespace-b9224d"></a>&#x2022; [`namespace`](#namespace-b9224d) - Optional String<br>Namespace. 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
3282
-
3283
- <a id="tenant-d8d9f8"></a>&#x2022; [`tenant`](#tenant-d8d9f8) - Optional String<br>Tenant. 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
3284
-
3285
- <a id="uid-67bb42"></a>&#x2022; [`uid`](#uid-67bb42) - Optional String<br>UID. When a configuration object(e.g. virtual_host) refers to another(e.g route) then uid will hold the referred object's(e.g. route's) uid
2069
+ <a id="deep-2a5120"></a>Deeply nested **Sets** block collapsed for readability.
3286
2070
 
3287
2071
  #### Policy Based Challenge Rule List Rules Spec Body Matcher
3288
2072
 
3289
- A [`body_matcher`](#matcher-4075fc) block (within [`policy_based_challenge.rule_list.rules.spec`](#spec-fbd0f9)) supports the following:
3290
-
3291
- <a id="values-597ee8"></a>&#x2022; [`exact_values`](#values-597ee8) - Optional List<br>Exact Values. A list of exact values to match the input against
3292
-
3293
- <a id="values-4179b7"></a>&#x2022; [`regex_values`](#values-4179b7) - Optional List<br>Regex Values. A list of regular expressions to match the input against
3294
-
3295
- <a id="transformers-71023a"></a>&#x2022; [`transformers`](#transformers-71023a) - Optional List Defaults to `TRANSFORMER_NONE`<br>Possible values are `LOWER_CASE`, `UPPER_CASE`, `BASE64_DECODE`, `NORMALIZE_PATH`, `REMOVE_WHITESPACE`, `URL_DECODE`, `TRIM_LEFT`, `TRIM_RIGHT`, `TRIM`<br>[Enum: LOWER_CASE|UPPER_CASE|BASE64_DECODE|NORMALIZE_PATH|REMOVE_WHITESPACE|URL_DECODE|TRIM_LEFT|TRIM_RIGHT|TRIM] Transformers. An ordered list of transformers (starting from index 0) to be applied to the path before matching
2073
+ <a id="deep-43ae26"></a>Deeply nested **Matcher** block collapsed for readability.
3296
2074
 
3297
2075
  #### Policy Based Challenge Rule List Rules Spec Client Selector
3298
2076
 
3299
- A [`client_selector`](#selector-ca44f5) block (within [`policy_based_challenge.rule_list.rules.spec`](#spec-fbd0f9)) supports the following:
3300
-
3301
- <a id="expressions-4e019d"></a>&#x2022; [`expressions`](#expressions-4e019d) - Optional List<br>Selector Expression. expressions contains the kubernetes style label expression for selections
2077
+ <a id="deep-73214b"></a>Deeply nested **Selector** block collapsed for readability.
3302
2078
 
3303
2079
  #### Policy Based Challenge Rule List Rules Spec Cookie Matchers
3304
2080
 
3305
- A [`cookie_matchers`](#matchers-cb349b) block (within [`policy_based_challenge.rule_list.rules.spec`](#spec-fbd0f9)) supports the following:
3306
-
3307
- <a id="present-00c6c9"></a>&#x2022; [`check_not_present`](#present-00c6c9) - Optional Block<br>Enable this option
3308
-
3309
- <a id="present-df779f"></a>&#x2022; [`check_present`](#present-df779f) - Optional Block<br>Enable this option
3310
-
3311
- <a id="matcher-aec0f9"></a>&#x2022; [`invert_matcher`](#matcher-aec0f9) - Optional Bool<br>Invert Matcher. Invert Match of the expression defined
3312
-
3313
- <a id="item-951d5f"></a>&#x2022; [`item`](#item-951d5f) - Optional Block<br>Matcher. A 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-951d5f) below.
3314
-
3315
- <a id="name-9bddbc"></a>&#x2022; [`name`](#name-9bddbc) - Optional String<br>Cookie Name. A case-sensitive cookie name
2081
+ <a id="deep-946f25"></a>Deeply nested **Matchers** block collapsed for readability.
3316
2082
 
3317
2083
  #### Policy Based Challenge Rule List Rules Spec Cookie Matchers Item
3318
2084
 
3319
- An [`item`](#item-951d5f) block (within [`policy_based_challenge.rule_list.rules.spec.cookie_matchers`](#matchers-cb349b)) supports the following:
3320
-
3321
- <a id="values-093591"></a>&#x2022; [`exact_values`](#values-093591) - Optional List<br>Exact Values. A list of exact values to match the input against
3322
-
3323
- <a id="values-447dbd"></a>&#x2022; [`regex_values`](#values-447dbd) - Optional List<br>Regex Values. A list of regular expressions to match the input against
3324
-
3325
- <a id="transformers-d98df1"></a>&#x2022; [`transformers`](#transformers-d98df1) - Optional List Defaults to `TRANSFORMER_NONE`<br>Possible values are `LOWER_CASE`, `UPPER_CASE`, `BASE64_DECODE`, `NORMALIZE_PATH`, `REMOVE_WHITESPACE`, `URL_DECODE`, `TRIM_LEFT`, `TRIM_RIGHT`, `TRIM`<br>[Enum: LOWER_CASE|UPPER_CASE|BASE64_DECODE|NORMALIZE_PATH|REMOVE_WHITESPACE|URL_DECODE|TRIM_LEFT|TRIM_RIGHT|TRIM] Transformers. An ordered list of transformers (starting from index 0) to be applied to the path before matching
2085
+ <a id="deep-939b70"></a>Deeply nested **Item** block collapsed for readability.
3326
2086
 
3327
2087
  #### Policy Based Challenge Rule List Rules Spec Domain Matcher
3328
2088
 
3329
- A [`domain_matcher`](#matcher-888f5a) block (within [`policy_based_challenge.rule_list.rules.spec`](#spec-fbd0f9)) supports the following:
3330
-
3331
- <a id="values-3f5560"></a>&#x2022; [`exact_values`](#values-3f5560) - Optional List<br>Exact Values. A list of exact values to match the input against
3332
-
3333
- <a id="values-f1499c"></a>&#x2022; [`regex_values`](#values-f1499c) - Optional List<br>Regex Values. A list of regular expressions to match the input against
2089
+ <a id="deep-c2c201"></a>Deeply nested **Matcher** block collapsed for readability.
3334
2090
 
3335
2091
  #### Policy Based Challenge Rule List Rules Spec Headers
3336
2092
 
3337
- A [`headers`](#headers-1bea3b) block (within [`policy_based_challenge.rule_list.rules.spec`](#spec-fbd0f9)) supports the following:
3338
-
3339
- <a id="present-55942e"></a>&#x2022; [`check_not_present`](#present-55942e) - Optional Block<br>Enable this option
3340
-
3341
- <a id="present-4db691"></a>&#x2022; [`check_present`](#present-4db691) - Optional Block<br>Enable this option
3342
-
3343
- <a id="matcher-1277ca"></a>&#x2022; [`invert_matcher`](#matcher-1277ca) - Optional Bool<br>Invert Header Matcher. Invert the match result
3344
-
3345
- <a id="item-f6ed80"></a>&#x2022; [`item`](#item-f6ed80) - Optional Block<br>Matcher. A 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-f6ed80) below.
3346
-
3347
- <a id="name-c77daf"></a>&#x2022; [`name`](#name-c77daf) - Optional String<br>Header Name. A case-insensitive HTTP header name
2093
+ <a id="deep-c62b4f"></a>Deeply nested **Headers** block collapsed for readability.
3348
2094
 
3349
2095
  #### Policy Based Challenge Rule List Rules Spec Headers Item
3350
2096
 
3351
- An [`item`](#item-f6ed80) block (within [`policy_based_challenge.rule_list.rules.spec.headers`](#headers-1bea3b)) supports the following:
3352
-
3353
- <a id="values-fc746b"></a>&#x2022; [`exact_values`](#values-fc746b) - Optional List<br>Exact Values. A list of exact values to match the input against
3354
-
3355
- <a id="values-52c029"></a>&#x2022; [`regex_values`](#values-52c029) - Optional List<br>Regex Values. A list of regular expressions to match the input against
3356
-
3357
- <a id="transformers-12bdd9"></a>&#x2022; [`transformers`](#transformers-12bdd9) - Optional List Defaults to `TRANSFORMER_NONE`<br>Possible values are `LOWER_CASE`, `UPPER_CASE`, `BASE64_DECODE`, `NORMALIZE_PATH`, `REMOVE_WHITESPACE`, `URL_DECODE`, `TRIM_LEFT`, `TRIM_RIGHT`, `TRIM`<br>[Enum: LOWER_CASE|UPPER_CASE|BASE64_DECODE|NORMALIZE_PATH|REMOVE_WHITESPACE|URL_DECODE|TRIM_LEFT|TRIM_RIGHT|TRIM] Transformers. An ordered list of transformers (starting from index 0) to be applied to the path before matching
2097
+ <a id="deep-b6374c"></a>Deeply nested **Item** block collapsed for readability.
3358
2098
 
3359
2099
  #### Policy Based Challenge Rule List Rules Spec HTTP Method
3360
2100
 
3361
- A [`http_method`](#method-9ab722) block (within [`policy_based_challenge.rule_list.rules.spec`](#spec-fbd0f9)) supports the following:
3362
-
3363
- <a id="matcher-7f896b"></a>&#x2022; [`invert_matcher`](#matcher-7f896b) - Optional Bool<br>Invert Method Matcher. Invert the match result
3364
-
3365
- <a id="methods-7a62d5"></a>&#x2022; [`methods`](#methods-7a62d5) - Optional List Defaults to `ANY`<br>Possible values are `ANY`, `GET`, `HEAD`, `POST`, `PUT`, `DELETE`, `CONNECT`, `OPTIONS`, `TRACE`, `PATCH`, `COPY`<br>[Enum: ANY|GET|HEAD|POST|PUT|DELETE|CONNECT|OPTIONS|TRACE|PATCH|COPY] Method List. List of methods values to match against
2101
+ <a id="deep-dba95f"></a>Deeply nested **Method** block collapsed for readability.
3366
2102
 
3367
2103
  #### Policy Based Challenge Rule List Rules Spec IP Matcher
3368
2104
 
3369
- An [`ip_matcher`](#matcher-82616b) block (within [`policy_based_challenge.rule_list.rules.spec`](#spec-fbd0f9)) supports the following:
3370
-
3371
- <a id="matcher-82cd23"></a>&#x2022; [`invert_matcher`](#matcher-82cd23) - Optional Bool<br>Invert IP Matcher. Invert the match result
3372
-
3373
- <a id="sets-9dc015"></a>&#x2022; [`prefix_sets`](#sets-9dc015) - Optional Block<br>IP Prefix Sets. A list of references to ip_prefix_set objects<br>See [Prefix Sets](#sets-9dc015) below.
2105
+ <a id="deep-b37ae0"></a>Deeply nested **Matcher** block collapsed for readability.
3374
2106
 
3375
2107
  #### Policy Based Challenge Rule List Rules Spec IP Matcher Prefix Sets
3376
2108
 
3377
- A [`prefix_sets`](#sets-9dc015) block (within [`policy_based_challenge.rule_list.rules.spec.ip_matcher`](#matcher-82616b)) supports the following:
3378
-
3379
- <a id="kind-190f46"></a>&#x2022; [`kind`](#kind-190f46) - Optional String<br>Kind. When a configuration object(e.g. virtual_host) refers to another(e.g route) then kind will hold the referred object's kind (e.g. 'route')
3380
-
3381
- <a id="name-434336"></a>&#x2022; [`name`](#name-434336) - Optional String<br>Name. 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
3382
-
3383
- <a id="namespace-2b573f"></a>&#x2022; [`namespace`](#namespace-2b573f) - Optional String<br>Namespace. 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
3384
-
3385
- <a id="tenant-86f089"></a>&#x2022; [`tenant`](#tenant-86f089) - Optional String<br>Tenant. 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
3386
-
3387
- <a id="uid-2efcf4"></a>&#x2022; [`uid`](#uid-2efcf4) - Optional String<br>UID. When a configuration object(e.g. virtual_host) refers to another(e.g route) then uid will hold the referred object's(e.g. route's) uid
2109
+ <a id="deep-73bd32"></a>Deeply nested **Sets** block collapsed for readability.
3388
2110
 
3389
2111
  #### Policy Based Challenge Rule List Rules Spec IP Prefix List
3390
2112
 
3391
- An [`ip_prefix_list`](#list-537143) block (within [`policy_based_challenge.rule_list.rules.spec`](#spec-fbd0f9)) supports the following:
3392
-
3393
- <a id="match-c9ff32"></a>&#x2022; [`invert_match`](#match-c9ff32) - Optional Bool<br>Invert Match Result. Invert the match result
3394
-
3395
- <a id="prefixes-607b2d"></a>&#x2022; [`ip_prefixes`](#prefixes-607b2d) - Optional List<br>IPv4 Prefix List. List of IPv4 prefix strings
2113
+ <a id="deep-fb570d"></a>Deeply nested **List** block collapsed for readability.
3396
2114
 
3397
2115
  #### Policy Based Challenge Rule List Rules Spec Path
3398
2116
 
3399
- A [`path`](#path-acb3cc) block (within [`policy_based_challenge.rule_list.rules.spec`](#spec-fbd0f9)) supports the following:
3400
-
3401
- <a id="values-485c76"></a>&#x2022; [`exact_values`](#values-485c76) - Optional List<br>Exact Values. A list of exact path values to match the input HTTP path against
3402
-
3403
- <a id="matcher-003880"></a>&#x2022; [`invert_matcher`](#matcher-003880) - Optional Bool<br>Invert Path Matcher. Invert the match result
3404
-
3405
- <a id="values-083d9f"></a>&#x2022; [`prefix_values`](#values-083d9f) - Optional List<br>Prefix Values. A list of path prefix values to match the input HTTP path against
3406
-
3407
- <a id="values-4b2fb8"></a>&#x2022; [`regex_values`](#values-4b2fb8) - Optional List<br>Regex Values. A list of regular expressions to match the input HTTP path against
3408
-
3409
- <a id="values-401ec9"></a>&#x2022; [`suffix_values`](#values-401ec9) - Optional List<br>Suffix Values. A list of path suffix values to match the input HTTP path against
3410
-
3411
- <a id="transformers-c5ad13"></a>&#x2022; [`transformers`](#transformers-c5ad13) - Optional List Defaults to `TRANSFORMER_NONE`<br>Possible values are `LOWER_CASE`, `UPPER_CASE`, `BASE64_DECODE`, `NORMALIZE_PATH`, `REMOVE_WHITESPACE`, `URL_DECODE`, `TRIM_LEFT`, `TRIM_RIGHT`, `TRIM`<br>[Enum: LOWER_CASE|UPPER_CASE|BASE64_DECODE|NORMALIZE_PATH|REMOVE_WHITESPACE|URL_DECODE|TRIM_LEFT|TRIM_RIGHT|TRIM] Transformers. An ordered list of transformers (starting from index 0) to be applied to the path before matching
2117
+ <a id="deep-2ed6cf"></a>Deeply nested **Path** block collapsed for readability.
3412
2118
 
3413
2119
  #### Policy Based Challenge Rule List Rules Spec Query Params
3414
2120
 
3415
- A [`query_params`](#params-04b1ad) block (within [`policy_based_challenge.rule_list.rules.spec`](#spec-fbd0f9)) supports the following:
3416
-
3417
- <a id="present-3df5a5"></a>&#x2022; [`check_not_present`](#present-3df5a5) - Optional Block<br>Enable this option
3418
-
3419
- <a id="present-aa54e6"></a>&#x2022; [`check_present`](#present-aa54e6) - Optional Block<br>Enable this option
3420
-
3421
- <a id="matcher-c30f88"></a>&#x2022; [`invert_matcher`](#matcher-c30f88) - Optional Bool<br>Invert Query Parameter Matcher. Invert the match result
3422
-
3423
- <a id="item-51a3bb"></a>&#x2022; [`item`](#item-51a3bb) - Optional Block<br>Matcher. A 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-51a3bb) below.
3424
-
3425
- <a id="key-3709d7"></a>&#x2022; [`key`](#key-3709d7) - Optional String<br>Query Parameter Name. A case-sensitive HTTP query parameter name
2121
+ <a id="deep-39ee89"></a>Deeply nested **Params** block collapsed for readability.
3426
2122
 
3427
2123
  #### Policy Based Challenge Rule List Rules Spec Query Params Item
3428
2124
 
3429
- An [`item`](#item-51a3bb) block (within [`policy_based_challenge.rule_list.rules.spec.query_params`](#params-04b1ad)) supports the following:
3430
-
3431
- <a id="values-f4b36f"></a>&#x2022; [`exact_values`](#values-f4b36f) - Optional List<br>Exact Values. A list of exact values to match the input against
3432
-
3433
- <a id="values-1b7a32"></a>&#x2022; [`regex_values`](#values-1b7a32) - Optional List<br>Regex Values. A list of regular expressions to match the input against
3434
-
3435
- <a id="transformers-f4e714"></a>&#x2022; [`transformers`](#transformers-f4e714) - Optional List Defaults to `TRANSFORMER_NONE`<br>Possible values are `LOWER_CASE`, `UPPER_CASE`, `BASE64_DECODE`, `NORMALIZE_PATH`, `REMOVE_WHITESPACE`, `URL_DECODE`, `TRIM_LEFT`, `TRIM_RIGHT`, `TRIM`<br>[Enum: LOWER_CASE|UPPER_CASE|BASE64_DECODE|NORMALIZE_PATH|REMOVE_WHITESPACE|URL_DECODE|TRIM_LEFT|TRIM_RIGHT|TRIM] Transformers. An ordered list of transformers (starting from index 0) to be applied to the path before matching
2125
+ <a id="deep-f76120"></a>Deeply nested **Item** block collapsed for readability.
3436
2126
 
3437
2127
  #### Policy Based Challenge Rule List Rules Spec TLS Fingerprint Matcher
3438
2128
 
3439
- A [`tls_fingerprint_matcher`](#matcher-3cbc4b) block (within [`policy_based_challenge.rule_list.rules.spec`](#spec-fbd0f9)) supports the following:
3440
-
3441
- <a id="classes-e328f3"></a>&#x2022; [`classes`](#classes-e328f3) - Optional List Defaults to `TLS_FINGERPRINT_NONE`<br>Possible values are `TLS_FINGERPRINT_NONE`, `ANY_MALICIOUS_FINGERPRINT`, `ADWARE`, `ADWIND`, `DRIDEX`, `GOOTKIT`, `GOZI`, `JBIFROST`, `QUAKBOT`, `RANSOMWARE`, `TROLDESH`, `TOFSEE`, `TORRENTLOCKER`, `TRICKBOT`<br>[Enum: TLS_FINGERPRINT_NONE|ANY_MALICIOUS_FINGERPRINT|ADWARE|ADWIND|DRIDEX|GOOTKIT|GOZI|JBIFROST|QUAKBOT|RANSOMWARE|TROLDESH|TOFSEE|TORRENTLOCKER|TRICKBOT] TLS fingerprint classes. A list of known classes of TLS fingerprints to match the input TLS JA3 fingerprint against
3442
-
3443
- <a id="values-02374f"></a>&#x2022; [`exact_values`](#values-02374f) - Optional List<br>Exact Values. A list of exact TLS JA3 fingerprints to match the input TLS JA3 fingerprint against
3444
-
3445
- <a id="values-2fc745"></a>&#x2022; [`excluded_values`](#values-2fc745) - Optional List<br>Excluded Values. A list of TLS JA3 fingerprints to be excluded when matching the input TLS JA3 fingerprint. This can be used to skip known false positives when using one or more known TLS fingerprint classes in the enclosing matcher
2129
+ <a id="deep-2cb28a"></a>Deeply nested **Matcher** block collapsed for readability.
3446
2130
 
3447
2131
  #### Policy Based Challenge Temporary User Blocking
3448
2132
 
@@ -3504,13 +2188,7 @@ A [`custom_ip_allowed_list`](#rate-limit-custom-ip-allowed-list) block (within [
3504
2188
 
3505
2189
  #### Rate Limit Custom IP Allowed List Rate Limiter Allowed Prefixes
3506
2190
 
3507
- A [`rate_limiter_allowed_prefixes`](#prefixes-266335) block (within [`rate_limit.custom_ip_allowed_list`](#rate-limit-custom-ip-allowed-list)) supports the following:
3508
-
3509
- <a id="name-2e45f5"></a>&#x2022; [`name`](#name-2e45f5) - Optional String<br>Name. 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
3510
-
3511
- <a id="namespace-cab019"></a>&#x2022; [`namespace`](#namespace-cab019) - Optional String<br>Namespace. 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
3512
-
3513
- <a id="tenant-d99ce2"></a>&#x2022; [`tenant`](#tenant-d99ce2) - Optional String<br>Tenant. 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
2191
+ <a id="deep-e048af"></a>Deeply nested **Prefixes** block collapsed for readability.
3514
2192
 
3515
2193
  #### Rate Limit IP Allowed List
3516
2194
 
@@ -3526,13 +2204,7 @@ A [`policies`](#rate-limit-policies) block (within [`rate_limit`](#rate-limit))
3526
2204
 
3527
2205
  #### Rate Limit Policies Policies
3528
2206
 
3529
- A [`policies`](#rate-limit-policies-policies) block (within [`rate_limit.policies`](#rate-limit-policies)) supports the following:
3530
-
3531
- <a id="rate-limit-policies-policies-name"></a>&#x2022; [`name`](#rate-limit-policies-policies-name) - Optional String<br>Name. 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
3532
-
3533
- <a id="rate-limit-policies-policies-namespace"></a>&#x2022; [`namespace`](#rate-limit-policies-policies-namespace) - Optional String<br>Namespace. 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
3534
-
3535
- <a id="rate-limit-policies-policies-tenant"></a>&#x2022; [`tenant`](#rate-limit-policies-policies-tenant) - Optional String<br>Tenant. 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
2207
+ <a id="objref-15469f"></a>Uses standard [Object Reference](#common-object-reference) fields (name, namespace, tenant).
3536
2208
 
3537
2209
  #### Rate Limit Rate Limiter
3538
2210
 
@@ -3590,13 +2262,7 @@ A [`sensitive_data_policy`](#sensitive-data-policy) block supports the following
3590
2262
 
3591
2263
  #### Sensitive Data Policy Sensitive Data Policy Ref
3592
2264
 
3593
- A [`sensitive_data_policy_ref`](#ref-55b260) block (within [`sensitive_data_policy`](#sensitive-data-policy)) supports the following:
3594
-
3595
- <a id="name-d254a7"></a>&#x2022; [`name`](#name-d254a7) - Optional String<br>Name. 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
3596
-
3597
- <a id="namespace-401387"></a>&#x2022; [`namespace`](#namespace-401387) - Optional String<br>Namespace. 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
3598
-
3599
- <a id="tenant-d10cc7"></a>&#x2022; [`tenant`](#tenant-d10cc7) - Optional String<br>Tenant. 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
2265
+ <a id="objref-55b260"></a>Uses standard [Object Reference](#common-object-reference) fields (name, namespace, tenant).
3600
2266
 
3601
2267
  #### Slow DDOS Mitigation
3602
2268
 
@@ -3676,13 +2342,7 @@ A [`metadata`](#trusted-clients-metadata) block (within [`trusted_clients`](#tru
3676
2342
 
3677
2343
  #### User Identification
3678
2344
 
3679
- An [`user_identification`](#user-identification) block supports the following:
3680
-
3681
- <a id="user-identification-name"></a>&#x2022; [`name`](#user-identification-name) - Optional String<br>Name. 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
3682
-
3683
- <a id="user-identification-namespace"></a>&#x2022; [`namespace`](#user-identification-namespace) - Optional String<br>Namespace. 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
3684
-
3685
- <a id="user-identification-tenant"></a>&#x2022; [`tenant`](#user-identification-tenant) - Optional String<br>Tenant. 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
2345
+ <a id="objref-91da1c"></a>Uses standard [Object Reference](#common-object-reference) fields (name, namespace, tenant).
3686
2346
 
3687
2347
  #### WAF Exclusion
3688
2348
 
@@ -3714,7 +2374,7 @@ A [`rules`](#rules-28cf34) block (within [`waf_exclusion.waf_exclusion_inline_ru
3714
2374
 
3715
2375
  <a id="metadata-09584f"></a>&#x2022; [`metadata`](#metadata-09584f) - Optional Block<br>Message Metadata. 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 and replace APIs<br>See [Metadata](#metadata-09584f) below.
3716
2376
 
3717
- <a id="methods-19f73d"></a>&#x2022; [`methods`](#methods-19f73d) - Optional List Defaults to `ANY`<br>Possible values are `ANY`, `GET`, `HEAD`, `POST`, `PUT`, `DELETE`, `CONNECT`, `OPTIONS`, `TRACE`, `PATCH`, `COPY`<br>[Enum: ANY|GET|HEAD|POST|PUT|DELETE|CONNECT|OPTIONS|TRACE|PATCH|COPY] Methods. methods to be matched
2377
+ <a id="methods-19f73d"></a>&#x2022; [`methods`](#methods-19f73d) - Optional List Defaults to `ANY`<br>See [HTTP Methods](#common-http-methods)<br> Methods. methods to be matched
3718
2378
 
3719
2379
  <a id="prefix-a857dd"></a>&#x2022; [`path_prefix`](#prefix-a857dd) - Optional String<br>Prefix. Path prefix to match (e.g. the value / will match on all paths)
3720
2380
 
@@ -3726,69 +2386,114 @@ A [`rules`](#rules-28cf34) block (within [`waf_exclusion.waf_exclusion_inline_ru
3726
2386
 
3727
2387
  #### WAF Exclusion WAF Exclusion Inline Rules Rules App Firewall Detection Control
3728
2388
 
3729
- An [`app_firewall_detection_control`](#control-0cb52d) block (within [`waf_exclusion.waf_exclusion_inline_rules.rules`](#rules-28cf34)) supports the following:
3730
-
3731
- <a id="contexts-6197b1"></a>&#x2022; [`exclude_attack_type_contexts`](#contexts-6197b1) - Optional Block<br>Attack Types. Attack Types to be excluded for the defined match criteria<br>See [Exclude Attack Type Contexts](#contexts-6197b1) below.
3732
-
3733
- <a id="contexts-e832e4"></a>&#x2022; [`exclude_bot_name_contexts`](#contexts-e832e4) - Optional Block<br>Bot Names. Bot Names to be excluded for the defined match criteria<br>See [Exclude Bot Name Contexts](#contexts-e832e4) below.
3734
-
3735
- <a id="contexts-0794ff"></a>&#x2022; [`exclude_signature_contexts`](#contexts-0794ff) - Optional Block<br>Signature IDs. Signature IDs to be excluded for the defined match criteria<br>See [Exclude Signature Contexts](#contexts-0794ff) below.
3736
-
3737
- <a id="contexts-29dd68"></a>&#x2022; [`exclude_violation_contexts`](#contexts-29dd68) - Optional Block<br>Violations. Violations to be excluded for the defined match criteria<br>See [Exclude Violation Contexts](#contexts-29dd68) below.
2389
+ <a id="deep-832ffb"></a>Deeply nested **Control** block collapsed for readability.
3738
2390
 
3739
2391
  #### WAF Exclusion WAF Exclusion Inline Rules Rules App Firewall Detection Control Exclude Attack Type Contexts
3740
2392
 
3741
- An [`exclude_attack_type_contexts`](#contexts-6197b1) block (within [`waf_exclusion.waf_exclusion_inline_rules.rules.app_firewall_detection_control`](#control-0cb52d)) supports the following:
3742
-
3743
- <a id="context-b0f79f"></a>&#x2022; [`context`](#context-b0f79f) - Optional String Defaults to `CONTEXT_ANY`<br>Possible values are `CONTEXT_ANY`, `CONTEXT_BODY`, `CONTEXT_REQUEST`, `CONTEXT_RESPONSE`, `CONTEXT_PARAMETER`, `CONTEXT_HEADER`, `CONTEXT_COOKIE`, `CONTEXT_URL`, `CONTEXT_URI`<br>[Enum: CONTEXT_ANY|CONTEXT_BODY|CONTEXT_REQUEST|CONTEXT_RESPONSE|CONTEXT_PARAMETER|CONTEXT_HEADER|CONTEXT_COOKIE|CONTEXT_URL|CONTEXT_URI] WAF Exclusion Context Options. The available contexts for Exclusion rules. - CONTEXT_ANY: CONTEXT_ANY Detection will be excluded for all contexts. - CONTEXT_BODY: CONTEXT_BODY Detection will be excluded for the request body. - CONTEXT_REQUEST: CONTEXT_REQUEST Detection will be excluded for the request. - CONTEXT_RESPONSE: CONTEXT_RESPONSE - CONTEXT_PARAMETER: CONTEXT_PARAMETER Detection will be excluded for the parameters. The parameter name is required in the Context name field. If the field is left empty, the detection will be excluded for all parameters. - CONTEXT_HEADER: CONTEXT_HEADER Detection will be excluded for the headers. The header name is required in the Context name field. If the field is left empty, the detection will be excluded for all headers. - CONTEXT_COOKIE: CONTEXT_COOKIE Detection will be excluded for the cookies. The cookie name is required in the Context name field. If the field is left empty, the detection will be excluded for all cookies. - CONTEXT_URL: CONTEXT_URL Detection will be excluded for the request URL. - CONTEXT_URI: CONTEXT_URI
3744
-
3745
- <a id="name-114c4e"></a>&#x2022; [`context_name`](#name-114c4e) - Optional String<br>Context Name. Relevant only for contexts: Header, Cookie and Parameter. Name of the Context that the WAF Exclusion Rules will check. Wildcard matching can be used by prefixing or suffixing the context name with an wildcard asterisk (*)
3746
-
3747
- <a id="type-541ccc"></a>&#x2022; [`exclude_attack_type`](#type-541ccc) - Optional String Defaults to `ATTACK_TYPE_NONE`<br>Possible values are `ATTACK_TYPE_NONE`, `ATTACK_TYPE_NON_BROWSER_CLIENT`, `ATTACK_TYPE_OTHER_APPLICATION_ATTACKS`, `ATTACK_TYPE_TROJAN_BACKDOOR_SPYWARE`, `ATTACK_TYPE_DETECTION_EVASION`, `ATTACK_TYPE_VULNERABILITY_SCAN`, `ATTACK_TYPE_ABUSE_OF_FUNCTIONALITY`, `ATTACK_TYPE_AUTHENTICATION_AUTHORIZATION_ATTACKS`, `ATTACK_TYPE_BUFFER_OVERFLOW`, `ATTACK_TYPE_PREDICTABLE_RESOURCE_LOCATION`, `ATTACK_TYPE_INFORMATION_LEAKAGE`, `ATTACK_TYPE_DIRECTORY_INDEXING`, `ATTACK_TYPE_PATH_TRAVERSAL`, `ATTACK_TYPE_XPATH_INJECTION`, `ATTACK_TYPE_LDAP_INJECTION`, `ATTACK_TYPE_SERVER_SIDE_CODE_INJECTION`, `ATTACK_TYPE_COMMAND_EXECUTION`, `ATTACK_TYPE_SQL_INJECTION`, `ATTACK_TYPE_CROSS_SITE_SCRIPTING`, `ATTACK_TYPE_DENIAL_OF_SERVICE`, `ATTACK_TYPE_HTTP_PARSER_ATTACK`, `ATTACK_TYPE_SESSION_HIJACKING`, `ATTACK_TYPE_HTTP_RESPONSE_SPLITTING`, `ATTACK_TYPE_FORCEFUL_BROWSING`, `ATTACK_TYPE_REMOTE_FILE_INCLUDE`, `ATTACK_TYPE_MALICIOUS_FILE_UPLOAD`, `ATTACK_TYPE_GRAPHQL_PARSER_ATTACK`<br>[Enum: ATTACK_TYPE_NONE|ATTACK_TYPE_NON_BROWSER_CLIENT|ATTACK_TYPE_OTHER_APPLICATION_ATTACKS|ATTACK_TYPE_TROJAN_BACKDOOR_SPYWARE|ATTACK_TYPE_DETECTION_EVASION|ATTACK_TYPE_VULNERABILITY_SCAN|ATTACK_TYPE_ABUSE_OF_FUNCTIONALITY|ATTACK_TYPE_AUTHENTICATION_AUTHORIZATION_ATTACKS|ATTACK_TYPE_BUFFER_OVERFLOW|ATTACK_TYPE_PREDICTABLE_RESOURCE_LOCATION|ATTACK_TYPE_INFORMATION_LEAKAGE|ATTACK_TYPE_DIRECTORY_INDEXING|ATTACK_TYPE_PATH_TRAVERSAL|ATTACK_TYPE_XPATH_INJECTION|ATTACK_TYPE_LDAP_INJECTION|ATTACK_TYPE_SERVER_SIDE_CODE_INJECTION|ATTACK_TYPE_COMMAND_EXECUTION|ATTACK_TYPE_SQL_INJECTION|ATTACK_TYPE_CROSS_SITE_SCRIPTING|ATTACK_TYPE_DENIAL_OF_SERVICE|ATTACK_TYPE_HTTP_PARSER_ATTACK|ATTACK_TYPE_SESSION_HIJACKING|ATTACK_TYPE_HTTP_RESPONSE_SPLITTING|ATTACK_TYPE_FORCEFUL_BROWSING|ATTACK_TYPE_REMOTE_FILE_INCLUDE|ATTACK_TYPE_MALICIOUS_FILE_UPLOAD|ATTACK_TYPE_GRAPHQL_PARSER_ATTACK] Attack Types. List of all Attack Types ATTACK_TYPE_NONE ATTACK_TYPE_NON_BROWSER_CLIENT ATTACK_TYPE_OTHER_APPLICATION_ATTACKS ATTACK_TYPE_TROJAN_BACKDOOR_SPYWARE ATTACK_TYPE_DETECTION_EVASION ATTACK_TYPE_VULNERABILITY_SCAN ATTACK_TYPE_ABUSE_OF_FUNCTIONALITY ATTACK_TYPE_AUTHENTICATION_AUTHORIZATION_ATTACKS ATTACK_TYPE_BUFFER_OVERFLOW ATTACK_TYPE_PREDICTABLE_RESOURCE_LOCATION ATTACK_TYPE_INFORMATION_LEAKAGE ATTACK_TYPE_DIRECTORY_INDEXING ATTACK_TYPE_PATH_TRAVERSAL ATTACK_TYPE_XPATH_INJECTION ATTACK_TYPE_LDAP_INJECTION ATTACK_TYPE_SERVER_SIDE_CODE_INJECTION ATTACK_TYPE_COMMAND_EXECUTION ATTACK_TYPE_SQL_INJECTION ATTACK_TYPE_CROSS_SITE_SCRIPTING ATTACK_TYPE_DENIAL_OF_SERVICE ATTACK_TYPE_HTTP_PARSER_ATTACK ATTACK_TYPE_SESSION_HIJACKING ATTACK_TYPE_HTTP_RESPONSE_SPLITTING ATTACK_TYPE_FORCEFUL_BROWSING ATTACK_TYPE_REMOTE_FILE_INCLUDE ATTACK_TYPE_MALICIOUS_FILE_UPLOAD ATTACK_TYPE_GRAPHQL_PARSER_ATTACK
2393
+ <a id="deep-0e5af0"></a>Deeply nested **Contexts** block collapsed for readability.
3748
2394
 
3749
2395
  #### WAF Exclusion WAF Exclusion Inline Rules Rules App Firewall Detection Control Exclude Bot Name Contexts
3750
2396
 
3751
- An [`exclude_bot_name_contexts`](#contexts-e832e4) block (within [`waf_exclusion.waf_exclusion_inline_rules.rules.app_firewall_detection_control`](#control-0cb52d)) supports the following:
3752
-
3753
- <a id="name-1d3dba"></a>&#x2022; [`bot_name`](#name-1d3dba) - Optional String<br>Bot Name
2397
+ <a id="deep-22f5f8"></a>Deeply nested **Contexts** block collapsed for readability.
3754
2398
 
3755
2399
  #### WAF Exclusion WAF Exclusion Inline Rules Rules App Firewall Detection Control Exclude Signature Contexts
3756
2400
 
3757
- An [`exclude_signature_contexts`](#contexts-0794ff) block (within [`waf_exclusion.waf_exclusion_inline_rules.rules.app_firewall_detection_control`](#control-0cb52d)) supports the following:
3758
-
3759
- <a id="context-e1f5a0"></a>&#x2022; [`context`](#context-e1f5a0) - Optional String Defaults to `CONTEXT_ANY`<br>Possible values are `CONTEXT_ANY`, `CONTEXT_BODY`, `CONTEXT_REQUEST`, `CONTEXT_RESPONSE`, `CONTEXT_PARAMETER`, `CONTEXT_HEADER`, `CONTEXT_COOKIE`, `CONTEXT_URL`, `CONTEXT_URI`<br>[Enum: CONTEXT_ANY|CONTEXT_BODY|CONTEXT_REQUEST|CONTEXT_RESPONSE|CONTEXT_PARAMETER|CONTEXT_HEADER|CONTEXT_COOKIE|CONTEXT_URL|CONTEXT_URI] WAF Exclusion Context Options. The available contexts for Exclusion rules. - CONTEXT_ANY: CONTEXT_ANY Detection will be excluded for all contexts. - CONTEXT_BODY: CONTEXT_BODY Detection will be excluded for the request body. - CONTEXT_REQUEST: CONTEXT_REQUEST Detection will be excluded for the request. - CONTEXT_RESPONSE: CONTEXT_RESPONSE - CONTEXT_PARAMETER: CONTEXT_PARAMETER Detection will be excluded for the parameters. The parameter name is required in the Context name field. If the field is left empty, the detection will be excluded for all parameters. - CONTEXT_HEADER: CONTEXT_HEADER Detection will be excluded for the headers. The header name is required in the Context name field. If the field is left empty, the detection will be excluded for all headers. - CONTEXT_COOKIE: CONTEXT_COOKIE Detection will be excluded for the cookies. The cookie name is required in the Context name field. If the field is left empty, the detection will be excluded for all cookies. - CONTEXT_URL: CONTEXT_URL Detection will be excluded for the request URL. - CONTEXT_URI: CONTEXT_URI
3760
-
3761
- <a id="name-efd12c"></a>&#x2022; [`context_name`](#name-efd12c) - Optional String<br>Context Name. Relevant only for contexts: Header, Cookie and Parameter. Name of the Context that the WAF Exclusion Rules will check. Wildcard matching can be used by prefixing or suffixing the context name with an wildcard asterisk (*)
3762
-
3763
- <a id="signature-id-f725d3"></a>&#x2022; [`signature_id`](#signature-id-f725d3) - Optional Number<br>SignatureID. The allowed values for signature ID are 0 and in the range of 200000001-299999999. 0 implies that all signatures will be excluded for the specified context
2401
+ <a id="deep-30cc06"></a>Deeply nested **Contexts** block collapsed for readability.
3764
2402
 
3765
2403
  #### WAF Exclusion WAF Exclusion Inline Rules Rules App Firewall Detection Control Exclude Violation Contexts
3766
2404
 
3767
- An [`exclude_violation_contexts`](#contexts-29dd68) block (within [`waf_exclusion.waf_exclusion_inline_rules.rules.app_firewall_detection_control`](#control-0cb52d)) supports the following:
3768
-
3769
- <a id="context-5543b9"></a>&#x2022; [`context`](#context-5543b9) - Optional String Defaults to `CONTEXT_ANY`<br>Possible values are `CONTEXT_ANY`, `CONTEXT_BODY`, `CONTEXT_REQUEST`, `CONTEXT_RESPONSE`, `CONTEXT_PARAMETER`, `CONTEXT_HEADER`, `CONTEXT_COOKIE`, `CONTEXT_URL`, `CONTEXT_URI`<br>[Enum: CONTEXT_ANY|CONTEXT_BODY|CONTEXT_REQUEST|CONTEXT_RESPONSE|CONTEXT_PARAMETER|CONTEXT_HEADER|CONTEXT_COOKIE|CONTEXT_URL|CONTEXT_URI] WAF Exclusion Context Options. The available contexts for Exclusion rules. - CONTEXT_ANY: CONTEXT_ANY Detection will be excluded for all contexts. - CONTEXT_BODY: CONTEXT_BODY Detection will be excluded for the request body. - CONTEXT_REQUEST: CONTEXT_REQUEST Detection will be excluded for the request. - CONTEXT_RESPONSE: CONTEXT_RESPONSE - CONTEXT_PARAMETER: CONTEXT_PARAMETER Detection will be excluded for the parameters. The parameter name is required in the Context name field. If the field is left empty, the detection will be excluded for all parameters. - CONTEXT_HEADER: CONTEXT_HEADER Detection will be excluded for the headers. The header name is required in the Context name field. If the field is left empty, the detection will be excluded for all headers. - CONTEXT_COOKIE: CONTEXT_COOKIE Detection will be excluded for the cookies. The cookie name is required in the Context name field. If the field is left empty, the detection will be excluded for all cookies. - CONTEXT_URL: CONTEXT_URL Detection will be excluded for the request URL. - CONTEXT_URI: CONTEXT_URI
3770
-
3771
- <a id="name-b96b20"></a>&#x2022; [`context_name`](#name-b96b20) - Optional String<br>Context Name. Relevant only for contexts: Header, Cookie and Parameter. Name of the Context that the WAF Exclusion Rules will check. Wildcard matching can be used by prefixing or suffixing the context name with an wildcard asterisk (*)
3772
-
3773
- <a id="violation-53384e"></a>&#x2022; [`exclude_violation`](#violation-53384e) - Optional String Defaults to `VIOL_NONE`<br>Possible values are `VIOL_NONE`, `VIOL_FILETYPE`, `VIOL_METHOD`, `VIOL_MANDATORY_HEADER`, `VIOL_HTTP_RESPONSE_STATUS`, `VIOL_REQUEST_MAX_LENGTH`, `VIOL_FILE_UPLOAD`, `VIOL_FILE_UPLOAD_IN_BODY`, `VIOL_XML_MALFORMED`, `VIOL_JSON_MALFORMED`, `VIOL_ASM_COOKIE_MODIFIED`, `VIOL_HTTP_PROTOCOL_MULTIPLE_HOST_HEADERS`, `VIOL_HTTP_PROTOCOL_BAD_HOST_HEADER_VALUE`, `VIOL_HTTP_PROTOCOL_UNPARSABLE_REQUEST_CONTENT`, `VIOL_HTTP_PROTOCOL_NULL_IN_REQUEST`, `VIOL_HTTP_PROTOCOL_BAD_HTTP_VERSION`, `VIOL_HTTP_PROTOCOL_SEVERAL_CONTENT_LENGTH_HEADERS`, `VIOL_EVASION_DIRECTORY_TRAVERSALS`, `VIOL_MALFORMED_REQUEST`, `VIOL_EVASION_MULTIPLE_DECODING`, `VIOL_DATA_GUARD`, `VIOL_EVASION_APACHE_WHITESPACE`, `VIOL_COOKIE_MODIFIED`, `VIOL_EVASION_IIS_UNICODE_CODEPOINTS`, `VIOL_EVASION_IIS_BACKSLASHES`, `VIOL_EVASION_PERCENT_U_DECODING`, `VIOL_EVASION_BARE_BYTE_DECODING`, `VIOL_EVASION_BAD_UNESCAPE`, `VIOL_HTTP_PROTOCOL_BODY_IN_GET_OR_HEAD_REQUEST`, `VIOL_ENCODING`, `VIOL_COOKIE_MALFORMED`, `VIOL_GRAPHQL_FORMAT`, `VIOL_GRAPHQL_MALFORMED`, `VIOL_GRAPHQL_INTROSPECTION_QUERY`<br>[Enum: VIOL_NONE|VIOL_FILETYPE|VIOL_METHOD|VIOL_MANDATORY_HEADER|VIOL_HTTP_RESPONSE_STATUS|VIOL_REQUEST_MAX_LENGTH|VIOL_FILE_UPLOAD|VIOL_FILE_UPLOAD_IN_BODY|VIOL_XML_MALFORMED|VIOL_JSON_MALFORMED|VIOL_ASM_COOKIE_MODIFIED|VIOL_HTTP_PROTOCOL_MULTIPLE_HOST_HEADERS|VIOL_HTTP_PROTOCOL_BAD_HOST_HEADER_VALUE|VIOL_HTTP_PROTOCOL_UNPARSABLE_REQUEST_CONTENT|VIOL_HTTP_PROTOCOL_NULL_IN_REQUEST|VIOL_HTTP_PROTOCOL_BAD_HTTP_VERSION|VIOL_HTTP_PROTOCOL_SEVERAL_CONTENT_LENGTH_HEADERS|VIOL_EVASION_DIRECTORY_TRAVERSALS|VIOL_MALFORMED_REQUEST|VIOL_EVASION_MULTIPLE_DECODING|VIOL_DATA_GUARD|VIOL_EVASION_APACHE_WHITESPACE|VIOL_COOKIE_MODIFIED|VIOL_EVASION_IIS_UNICODE_CODEPOINTS|VIOL_EVASION_IIS_BACKSLASHES|VIOL_EVASION_PERCENT_U_DECODING|VIOL_EVASION_BARE_BYTE_DECODING|VIOL_EVASION_BAD_UNESCAPE|VIOL_HTTP_PROTOCOL_BODY_IN_GET_OR_HEAD_REQUEST|VIOL_ENCODING|VIOL_COOKIE_MALFORMED|VIOL_GRAPHQL_FORMAT|VIOL_GRAPHQL_MALFORMED|VIOL_GRAPHQL_INTROSPECTION_QUERY] App Firewall Violation Type. List of all supported Violation Types VIOL_NONE VIOL_FILETYPE VIOL_METHOD VIOL_MANDATORY_HEADER VIOL_HTTP_RESPONSE_STATUS VIOL_REQUEST_MAX_LENGTH VIOL_FILE_UPLOAD VIOL_FILE_UPLOAD_IN_BODY VIOL_XML_MALFORMED VIOL_JSON_MALFORMED VIOL_ASM_COOKIE_MODIFIED VIOL_HTTP_PROTOCOL_MULTIPLE_HOST_HEADERS VIOL_HTTP_PROTOCOL_BAD_HOST_HEADER_VALUE VIOL_HTTP_PROTOCOL_UNPARSABLE_REQUEST_CONTENT VIOL_HTTP_PROTOCOL_NULL_IN_REQUEST VIOL_HTTP_PROTOCOL_BAD_HTTP_VERSION VIOL_HTTP_PROTOCOL_CRLF_CHARACTERS_BEFORE_REQUEST_START VIOL_HTTP_PROTOCOL_NO_HOST_HEADER_IN_HTTP_1_1_REQUEST VIOL_HTTP_PROTOCOL_BAD_MULTIPART_PARAMETERS_PARSING VIOL_HTTP_PROTOCOL_SEVERAL_CONTENT_LENGTH_HEADERS VIOL_HTTP_PROTOCOL_CONTENT_LENGTH_SHOULD_BE_A_POSITIVE_NUMBER VIOL_EVASION_DIRECTORY_TRAVERSALS VIOL_MALFORMED_REQUEST VIOL_EVASION_MULTIPLE_DECODING VIOL_DATA_GUARD VIOL_EVASION_APACHE_WHITESPACE VIOL_COOKIE_MODIFIED VIOL_EVASION_IIS_UNICODE_CODEPOINTS VIOL_EVASION_IIS_BACKSLASHES VIOL_EVASION_PERCENT_U_DECODING VIOL_EVASION_BARE_BYTE_DECODING VIOL_EVASION_BAD_UNESCAPE VIOL_HTTP_PROTOCOL_BAD_MULTIPART_FORMDATA_REQUEST_PARSING VIOL_HTTP_PROTOCOL_BODY_IN_GET_OR_HEAD_REQUEST VIOL_HTTP_PROTOCOL_HIGH_ASCII_CHARACTERS_IN_HEADERS VIOL_ENCODING VIOL_COOKIE_MALFORMED VIOL_GRAPHQL_FORMAT VIOL_GRAPHQL_MALFORMED VIOL_GRAPHQL_INTROSPECTION_QUERY
2405
+ <a id="deep-d6ba53"></a>Deeply nested **Contexts** block collapsed for readability.
3774
2406
 
3775
2407
  #### WAF Exclusion WAF Exclusion Inline Rules Rules Metadata
3776
2408
 
3777
- A [`metadata`](#metadata-09584f) block (within [`waf_exclusion.waf_exclusion_inline_rules.rules`](#rules-28cf34)) supports the following:
3778
-
3779
- <a id="spec-942e33"></a>&#x2022; [`description_spec`](#spec-942e33) - Optional String<br>Description. Human readable description
3780
-
3781
- <a id="name-a43295"></a>&#x2022; [`name`](#name-a43295) - Optional String<br>Name. This is the name of the message. The value of name has to follow DNS-1035 format
2409
+ <a id="deep-68f59c"></a>Deeply nested **Metadata** block collapsed for readability.
3782
2410
 
3783
2411
  #### WAF Exclusion WAF Exclusion Policy
3784
2412
 
3785
- A [`waf_exclusion_policy`](#waf-exclusion-waf-exclusion-policy) block (within [`waf_exclusion`](#waf-exclusion)) supports the following:
2413
+ <a id="objref-689a0e"></a>Uses standard [Object Reference](#common-object-reference) fields (name, namespace, tenant).
3786
2414
 
3787
- <a id="waf-exclusion-waf-exclusion-policy-name"></a>&#x2022; [`name`](#waf-exclusion-waf-exclusion-policy-name) - Optional String<br>Name. 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
3788
-
3789
- <a id="namespace-d8f030"></a>&#x2022; [`namespace`](#namespace-d8f030) - Optional String<br>Namespace. 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
2415
+ ---
3790
2416
 
3791
- <a id="tenant-d841f0"></a>&#x2022; [`tenant`](#tenant-d841f0) - Optional String<br>Tenant. 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
2417
+ ## Common Types
2418
+
2419
+ The following type definitions are used throughout this resource. See the full definition here rather than repeated inline.
2420
+
2421
+ ### Object Reference {#common-object-reference}
2422
+
2423
+ Object references establish a direct reference from one configuration object to another in F5 Distributed Cloud. References use the format `tenant/namespace/name`.
2424
+
2425
+ | Field | Type | Description |
2426
+ | ----- | ---- | ----------- |
2427
+ | `name` | String | Name of the referenced object |
2428
+ | `namespace` | String | Namespace containing the referenced object |
2429
+ | `tenant` | String | Tenant of the referenced object (system-managed) |
2430
+
2431
+ ### Transformers {#common-transformers}
2432
+
2433
+ Transformers apply transformations to input values before matching. Multiple transformers can be applied in order.
2434
+
2435
+ | Value | Description |
2436
+ | ----- | ----------- |
2437
+ | `LOWER_CASE` | Convert to lowercase |
2438
+ | `UPPER_CASE` | Convert to uppercase |
2439
+ | `BASE64_DECODE` | Decode base64 content |
2440
+ | `NORMALIZE_PATH` | Normalize URL path |
2441
+ | `REMOVE_WHITESPACE` | Remove whitespace characters |
2442
+ | `URL_DECODE` | Decode URL-encoded characters |
2443
+ | `TRIM_LEFT` | Trim leading whitespace |
2444
+ | `TRIM_RIGHT` | Trim trailing whitespace |
2445
+ | `TRIM` | Trim both leading and trailing whitespace |
2446
+
2447
+ ### HTTP Methods {#common-http-methods}
2448
+
2449
+ HTTP methods used for request matching.
2450
+
2451
+ | Value | Description |
2452
+ | ----- | ----------- |
2453
+ | `ANY` | Match any HTTP method |
2454
+ | `GET` | HTTP GET request |
2455
+ | `HEAD` | HTTP HEAD request |
2456
+ | `POST` | HTTP POST request |
2457
+ | `PUT` | HTTP PUT request |
2458
+ | `DELETE` | HTTP DELETE request |
2459
+ | `CONNECT` | HTTP CONNECT request |
2460
+ | `OPTIONS` | HTTP OPTIONS request |
2461
+ | `TRACE` | HTTP TRACE request |
2462
+ | `PATCH` | HTTP PATCH request |
2463
+ | `COPY` | HTTP COPY request (WebDAV) |
2464
+
2465
+ ### TLS Fingerprints {#common-tls-fingerprints}
2466
+
2467
+ TLS fingerprint categories for malicious client detection.
2468
+
2469
+ | Value | Description |
2470
+ | ----- | ----------- |
2471
+ | `TLS_FINGERPRINT_NONE` | No fingerprint matching |
2472
+ | `ANY_MALICIOUS_FINGERPRINT` | Match any known malicious fingerprint |
2473
+ | `ADWARE` | Adware-associated fingerprints |
2474
+ | `DRIDEX` | Dridex malware fingerprints |
2475
+ | `GOOTKIT` | Gootkit malware fingerprints |
2476
+ | `RANSOMWARE` | Ransomware-associated fingerprints |
2477
+ | `TRICKBOT` | Trickbot malware fingerprints |
2478
+
2479
+ ### IP Threat Categories {#common-ip-threat-categories}
2480
+
2481
+ IP address threat categories for security filtering.
2482
+
2483
+ | Value | Description |
2484
+ | ----- | ----------- |
2485
+ | `SPAM_SOURCES` | Known spam sources |
2486
+ | `WINDOWS_EXPLOITS` | Windows exploit sources |
2487
+ | `WEB_ATTACKS` | Web attack sources |
2488
+ | `BOTNETS` | Known botnet IPs |
2489
+ | `SCANNERS` | Network scanner IPs |
2490
+ | `REPUTATION` | Poor reputation IPs |
2491
+ | `PHISHING` | Phishing-related IPs |
2492
+ | `PROXY` | Anonymous proxy IPs |
2493
+ | `MOBILE_THREATS` | Mobile threat sources |
2494
+ | `TOR_PROXY` | Tor exit nodes |
2495
+ | `DENIAL_OF_SERVICE` | DoS attack sources |
2496
+ | `NETWORK` | Known bad network ranges |
3792
2497
 
3793
2498
  ## Import
3794
2499