@robinmordasiewicz/f5xc-terraform-mcp 2.3.0 → 2.4.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +98 -15
- package/dist/docs/data-sources/addon_subscription.md +51 -0
- package/dist/docs/data-sources/address_allocator.md +51 -0
- package/dist/docs/data-sources/advertise_policy.md +51 -0
- package/dist/docs/data-sources/alert_policy.md +51 -0
- package/dist/docs/data-sources/alert_receiver.md +62 -0
- package/dist/docs/data-sources/allowed_tenant.md +51 -0
- package/dist/docs/data-sources/api_crawler.md +51 -0
- package/dist/docs/data-sources/api_credential.md +51 -0
- package/dist/docs/data-sources/api_definition.md +51 -0
- package/dist/docs/data-sources/api_discovery.md +51 -0
- package/dist/docs/data-sources/api_testing.md +51 -0
- package/dist/docs/data-sources/apm.md +51 -0
- package/dist/docs/data-sources/app_api_group.md +51 -0
- package/dist/docs/data-sources/app_firewall.md +62 -0
- package/dist/docs/data-sources/app_setting.md +51 -0
- package/dist/docs/data-sources/app_type.md +51 -0
- package/dist/docs/data-sources/authentication.md +51 -0
- package/dist/docs/data-sources/aws_tgw_site.md +51 -0
- package/dist/docs/data-sources/aws_vpc_site.md +68 -0
- package/dist/docs/data-sources/azure_vnet_site.md +68 -0
- package/dist/docs/data-sources/bgp.md +51 -0
- package/dist/docs/data-sources/bgp_asn_set.md +51 -0
- package/dist/docs/data-sources/bgp_routing_policy.md +51 -0
- package/dist/docs/data-sources/bigip_irule.md +51 -0
- package/dist/docs/data-sources/bot_defense_app_infrastructure.md +51 -0
- package/dist/docs/data-sources/cdn_cache_rule.md +51 -0
- package/dist/docs/data-sources/cdn_loadbalancer.md +51 -0
- package/dist/docs/data-sources/certificate.md +66 -0
- package/dist/docs/data-sources/certificate_chain.md +51 -0
- package/dist/docs/data-sources/child_tenant.md +51 -0
- package/dist/docs/data-sources/child_tenant_manager.md +51 -0
- package/dist/docs/data-sources/cloud_connect.md +51 -0
- package/dist/docs/data-sources/cloud_credentials.md +62 -0
- package/dist/docs/data-sources/cloud_elastic_ip.md +51 -0
- package/dist/docs/data-sources/cloud_link.md +51 -0
- package/dist/docs/data-sources/cluster.md +51 -0
- package/dist/docs/data-sources/cminstance.md +51 -0
- package/dist/docs/data-sources/code_base_integration.md +51 -0
- package/dist/docs/data-sources/contact.md +51 -0
- package/dist/docs/data-sources/container_registry.md +51 -0
- package/dist/docs/data-sources/crl.md +51 -0
- package/dist/docs/data-sources/customer_support.md +51 -0
- package/dist/docs/data-sources/data_group.md +51 -0
- package/dist/docs/data-sources/data_type.md +51 -0
- package/dist/docs/data-sources/dc_cluster_group.md +51 -0
- package/dist/docs/data-sources/discovery.md +51 -0
- package/dist/docs/data-sources/dns_compliance_checks.md +51 -0
- package/dist/docs/data-sources/dns_domain.md +51 -0
- package/dist/docs/data-sources/dns_lb_health_check.md +51 -0
- package/dist/docs/data-sources/dns_lb_pool.md +51 -0
- package/dist/docs/data-sources/dns_load_balancer.md +51 -0
- package/dist/docs/data-sources/dns_zone.md +62 -0
- package/dist/docs/data-sources/endpoint.md +51 -0
- package/dist/docs/data-sources/enhanced_firewall_policy.md +51 -0
- package/dist/docs/data-sources/external_connector.md +51 -0
- package/dist/docs/data-sources/fast_acl.md +51 -0
- package/dist/docs/data-sources/fast_acl_rule.md +51 -0
- package/dist/docs/data-sources/filter_set.md +51 -0
- package/dist/docs/data-sources/fleet.md +51 -0
- package/dist/docs/data-sources/forward_proxy_policy.md +51 -0
- package/dist/docs/data-sources/forwarding_class.md +51 -0
- package/dist/docs/data-sources/gcp_vpc_site.md +68 -0
- package/dist/docs/data-sources/geo_location_set.md +51 -0
- package/dist/docs/data-sources/global_log_receiver.md +51 -0
- package/dist/docs/data-sources/healthcheck.md +62 -0
- package/dist/docs/data-sources/http_loadbalancer.md +60 -0
- package/dist/docs/data-sources/ike1.md +51 -0
- package/dist/docs/data-sources/ike2.md +51 -0
- package/dist/docs/data-sources/ike_phase1_profile.md +51 -0
- package/dist/docs/data-sources/ike_phase2_profile.md +51 -0
- package/dist/docs/data-sources/infraprotect_asn.md +51 -0
- package/dist/docs/data-sources/infraprotect_asn_prefix.md +51 -0
- package/dist/docs/data-sources/infraprotect_deny_list_rule.md +51 -0
- package/dist/docs/data-sources/infraprotect_firewall_rule.md +51 -0
- package/dist/docs/data-sources/infraprotect_firewall_rule_group.md +51 -0
- package/dist/docs/data-sources/infraprotect_internet_prefix_advertisement.md +51 -0
- package/dist/docs/data-sources/infraprotect_tunnel.md +51 -0
- package/dist/docs/data-sources/ip_prefix_set.md +51 -0
- package/dist/docs/data-sources/irule.md +51 -0
- package/dist/docs/data-sources/k8s_cluster.md +51 -0
- package/dist/docs/data-sources/k8s_cluster_role.md +51 -0
- package/dist/docs/data-sources/k8s_cluster_role_binding.md +51 -0
- package/dist/docs/data-sources/k8s_pod_security_admission.md +51 -0
- package/dist/docs/data-sources/k8s_pod_security_policy.md +51 -0
- package/dist/docs/data-sources/log_receiver.md +62 -0
- package/dist/docs/data-sources/malicious_user_mitigation.md +51 -0
- package/dist/docs/data-sources/managed_tenant.md +51 -0
- package/dist/docs/data-sources/namespace.md +58 -0
- package/dist/docs/data-sources/nat_policy.md +51 -0
- package/dist/docs/data-sources/network_connector.md +51 -0
- package/dist/docs/data-sources/network_firewall.md +51 -0
- package/dist/docs/data-sources/network_interface.md +51 -0
- package/dist/docs/data-sources/network_policy.md +51 -0
- package/dist/docs/data-sources/network_policy_rule.md +51 -0
- package/dist/docs/data-sources/network_policy_view.md +51 -0
- package/dist/docs/data-sources/nfv_service.md +51 -0
- package/dist/docs/data-sources/oidc_provider.md +51 -0
- package/dist/docs/data-sources/origin_pool.md +65 -0
- package/dist/docs/data-sources/policer.md +51 -0
- package/dist/docs/data-sources/policy_based_routing.md +51 -0
- package/dist/docs/data-sources/protocol_inspection.md +51 -0
- package/dist/docs/data-sources/protocol_policer.md +51 -0
- package/dist/docs/data-sources/proxy.md +51 -0
- package/dist/docs/data-sources/quota.md +51 -0
- package/dist/docs/data-sources/rate_limiter.md +64 -0
- package/dist/docs/data-sources/rate_limiter_policy.md +51 -0
- package/dist/docs/data-sources/registration.md +51 -0
- package/dist/docs/data-sources/report_config.md +51 -0
- package/dist/docs/data-sources/role.md +51 -0
- package/dist/docs/data-sources/route.md +51 -0
- package/dist/docs/data-sources/secret_management_access.md +51 -0
- package/dist/docs/data-sources/secret_policy.md +51 -0
- package/dist/docs/data-sources/secret_policy_rule.md +51 -0
- package/dist/docs/data-sources/securemesh_site.md +51 -0
- package/dist/docs/data-sources/securemesh_site_v2.md +51 -0
- package/dist/docs/data-sources/segment.md +51 -0
- package/dist/docs/data-sources/sensitive_data_policy.md +51 -0
- package/dist/docs/data-sources/service_policy.md +64 -0
- package/dist/docs/data-sources/service_policy_rule.md +51 -0
- package/dist/docs/data-sources/site_mesh_group.md +51 -0
- package/dist/docs/data-sources/srv6_network_slice.md +51 -0
- package/dist/docs/data-sources/subnet.md +51 -0
- package/dist/docs/data-sources/tcp_loadbalancer.md +51 -0
- package/dist/docs/data-sources/tenant_configuration.md +51 -0
- package/dist/docs/data-sources/tenant_profile.md +51 -0
- package/dist/docs/data-sources/ticket_tracking_system.md +51 -0
- package/dist/docs/data-sources/token.md +51 -0
- package/dist/docs/data-sources/tpm_api_key.md +51 -0
- package/dist/docs/data-sources/tpm_category.md +51 -0
- package/dist/docs/data-sources/tpm_manager.md +51 -0
- package/dist/docs/data-sources/trusted_ca_list.md +51 -0
- package/dist/docs/data-sources/tunnel.md +51 -0
- package/dist/docs/data-sources/udp_loadbalancer.md +51 -0
- package/dist/docs/data-sources/usb_policy.md +51 -0
- package/dist/docs/data-sources/user_identification.md +51 -0
- package/dist/docs/data-sources/virtual_host.md +51 -0
- package/dist/docs/data-sources/virtual_k8s.md +51 -0
- package/dist/docs/data-sources/virtual_network.md +51 -0
- package/dist/docs/data-sources/virtual_site.md +68 -0
- package/dist/docs/data-sources/voltshare_admin_policy.md +51 -0
- package/dist/docs/data-sources/voltstack_site.md +51 -0
- package/dist/docs/data-sources/waf_exclusion_policy.md +51 -0
- package/dist/docs/data-sources/workload.md +51 -0
- package/dist/docs/data-sources/workload_flavor.md +51 -0
- package/dist/docs/functions/blindfold.md +133 -0
- package/dist/docs/functions/blindfold_file.md +154 -0
- package/dist/docs/guides/authentication.md +389 -0
- package/dist/docs/guides/blindfold.md +509 -0
- package/dist/docs/guides/http-loadbalancer.md +274 -0
- package/dist/docs/resources/addon_subscription.md +136 -0
- package/dist/docs/resources/address_allocator.md +106 -0
- package/dist/docs/resources/advertise_policy.md +318 -0
- package/dist/docs/resources/alert_policy.md +242 -0
- package/dist/docs/resources/alert_receiver.md +394 -0
- package/dist/docs/resources/allowed_tenant.md +104 -0
- package/dist/docs/resources/api_crawler.md +142 -0
- package/dist/docs/resources/api_credential.md +101 -0
- package/dist/docs/resources/api_definition.md +127 -0
- package/dist/docs/resources/api_discovery.md +100 -0
- package/dist/docs/resources/api_testing.md +273 -0
- package/dist/docs/resources/apm.md +946 -0
- package/dist/docs/resources/app_api_group.md +161 -0
- package/dist/docs/resources/app_firewall.md +282 -0
- package/dist/docs/resources/app_setting.md +228 -0
- package/dist/docs/resources/app_type.md +124 -0
- package/dist/docs/resources/authentication.md +228 -0
- package/dist/docs/resources/aws_tgw_site.md +948 -0
- package/dist/docs/resources/aws_vpc_site.md +1262 -0
- package/dist/docs/resources/azure_vnet_site.md +2316 -0
- package/dist/docs/resources/bgp.md +341 -0
- package/dist/docs/resources/bgp_asn_set.md +86 -0
- package/dist/docs/resources/bgp_routing_policy.md +166 -0
- package/dist/docs/resources/bigip_irule.md +90 -0
- package/dist/docs/resources/bot_defense_app_infrastructure.md +166 -0
- package/dist/docs/resources/cdn_cache_rule.md +278 -0
- package/dist/docs/resources/cdn_loadbalancer.md +3800 -0
- package/dist/docs/resources/certificate.md +146 -0
- package/dist/docs/resources/certificate_chain.md +86 -0
- package/dist/docs/resources/child_tenant.md +166 -0
- package/dist/docs/resources/child_tenant_manager.md +130 -0
- package/dist/docs/resources/cloud_connect.md +260 -0
- package/dist/docs/resources/cloud_credentials.md +264 -0
- package/dist/docs/resources/cloud_elastic_ip.md +108 -0
- package/dist/docs/resources/cloud_link.md +252 -0
- package/dist/docs/resources/cluster.md +408 -0
- package/dist/docs/resources/cminstance.md +166 -0
- package/dist/docs/resources/code_base_integration.md +360 -0
- package/dist/docs/resources/contact.md +104 -0
- package/dist/docs/resources/container_registry.md +132 -0
- package/dist/docs/resources/crl.md +106 -0
- package/dist/docs/resources/customer_support.md +170 -0
- package/dist/docs/resources/data_group.md +121 -0
- package/dist/docs/resources/data_type.md +188 -0
- package/dist/docs/resources/dc_cluster_group.md +108 -0
- package/dist/docs/resources/discovery.md +443 -0
- package/dist/docs/resources/dns_compliance_checks.md +90 -0
- package/dist/docs/resources/dns_domain.md +94 -0
- package/dist/docs/resources/dns_lb_health_check.md +166 -0
- package/dist/docs/resources/dns_lb_pool.md +233 -0
- package/dist/docs/resources/dns_load_balancer.md +254 -0
- package/dist/docs/resources/dns_zone.md +988 -0
- package/dist/docs/resources/endpoint.md +234 -0
- package/dist/docs/resources/enhanced_firewall_policy.md +327 -0
- package/dist/docs/resources/external_connector.md +246 -0
- package/dist/docs/resources/fast_acl.md +376 -0
- package/dist/docs/resources/fast_acl_rule.md +192 -0
- package/dist/docs/resources/filter_set.md +142 -0
- package/dist/docs/resources/fleet.md +1267 -0
- package/dist/docs/resources/forward_proxy_policy.md +408 -0
- package/dist/docs/resources/forwarding_class.md +133 -0
- package/dist/docs/resources/gcp_vpc_site.md +1170 -0
- package/dist/docs/resources/geo_location_set.md +97 -0
- package/dist/docs/resources/global_log_receiver.md +1085 -0
- package/dist/docs/resources/healthcheck.md +148 -0
- package/dist/docs/resources/http_loadbalancer.md +7118 -0
- package/dist/docs/resources/ike1.md +133 -0
- package/dist/docs/resources/ike2.md +127 -0
- package/dist/docs/resources/ike_phase1_profile.md +141 -0
- package/dist/docs/resources/ike_phase2_profile.md +131 -0
- package/dist/docs/resources/infraprotect_asn.md +100 -0
- package/dist/docs/resources/infraprotect_asn_prefix.md +104 -0
- package/dist/docs/resources/infraprotect_deny_list_rule.md +108 -0
- package/dist/docs/resources/infraprotect_firewall_rule.md +205 -0
- package/dist/docs/resources/infraprotect_firewall_rule_group.md +86 -0
- package/dist/docs/resources/infraprotect_internet_prefix_advertisement.md +108 -0
- package/dist/docs/resources/infraprotect_tunnel.md +228 -0
- package/dist/docs/resources/ip_prefix_set.md +97 -0
- package/dist/docs/resources/irule.md +88 -0
- package/dist/docs/resources/k8s_cluster.md +291 -0
- package/dist/docs/resources/k8s_cluster_role.md +143 -0
- package/dist/docs/resources/k8s_cluster_role_binding.md +130 -0
- package/dist/docs/resources/k8s_pod_security_admission.md +116 -0
- package/dist/docs/resources/k8s_pod_security_policy.md +258 -0
- package/dist/docs/resources/log_receiver.md +183 -0
- package/dist/docs/resources/malicious_user_mitigation.md +132 -0
- package/dist/docs/resources/managed_tenant.md +116 -0
- package/dist/docs/resources/namespace.md +87 -0
- package/dist/docs/resources/nat_policy.md +408 -0
- package/dist/docs/resources/network_connector.md +252 -0
- package/dist/docs/resources/network_firewall.md +178 -0
- package/dist/docs/resources/network_interface.md +439 -0
- package/dist/docs/resources/network_policy.md +347 -0
- package/dist/docs/resources/network_policy_rule.md +157 -0
- package/dist/docs/resources/network_policy_view.md +330 -0
- package/dist/docs/resources/nfv_service.md +992 -0
- package/dist/docs/resources/oidc_provider.md +208 -0
- package/dist/docs/resources/origin_pool.md +801 -0
- package/dist/docs/resources/policer.md +97 -0
- package/dist/docs/resources/policy_based_routing.md +330 -0
- package/dist/docs/resources/protocol_inspection.md +130 -0
- package/dist/docs/resources/protocol_policer.md +146 -0
- package/dist/docs/resources/proxy.md +1181 -0
- package/dist/docs/resources/quota.md +104 -0
- package/dist/docs/resources/rate_limiter.md +155 -0
- package/dist/docs/resources/rate_limiter_policy.md +296 -0
- package/dist/docs/resources/registration.md +406 -0
- package/dist/docs/resources/report_config.md +160 -0
- package/dist/docs/resources/role.md +100 -0
- package/dist/docs/resources/route.md +724 -0
- package/dist/docs/resources/secret_management_access.md +498 -0
- package/dist/docs/resources/secret_policy.md +157 -0
- package/dist/docs/resources/secret_policy_rule.md +115 -0
- package/dist/docs/resources/securemesh_site.md +940 -0
- package/dist/docs/resources/securemesh_site_v2.md +2942 -0
- package/dist/docs/resources/segment.md +97 -0
- package/dist/docs/resources/sensitive_data_policy.md +116 -0
- package/dist/docs/resources/service_policy.md +795 -0
- package/dist/docs/resources/service_policy_rule.md +609 -0
- package/dist/docs/resources/site_mesh_group.md +163 -0
- package/dist/docs/resources/srv6_network_slice.md +92 -0
- package/dist/docs/resources/subnet.md +155 -0
- package/dist/docs/resources/tcp_loadbalancer.md +671 -0
- package/dist/docs/resources/tenant_configuration.md +136 -0
- package/dist/docs/resources/tenant_profile.md +156 -0
- package/dist/docs/resources/ticket_tracking_system.md +112 -0
- package/dist/docs/resources/token.md +87 -0
- package/dist/docs/resources/tpm_api_key.md +108 -0
- package/dist/docs/resources/tpm_category.md +108 -0
- package/dist/docs/resources/tpm_manager.md +84 -0
- package/dist/docs/resources/trusted_ca_list.md +89 -0
- package/dist/docs/resources/tunnel.md +250 -0
- package/dist/docs/resources/udp_loadbalancer.md +336 -0
- package/dist/docs/resources/usb_policy.md +108 -0
- package/dist/docs/resources/user_identification.md +126 -0
- package/dist/docs/resources/virtual_host.md +934 -0
- package/dist/docs/resources/virtual_k8s.md +132 -0
- package/dist/docs/resources/virtual_network.md +149 -0
- package/dist/docs/resources/virtual_site.md +102 -0
- package/dist/docs/resources/voltshare_admin_policy.md +196 -0
- package/dist/docs/resources/voltstack_site.md +2259 -0
- package/dist/docs/resources/waf_exclusion_policy.md +182 -0
- package/dist/docs/resources/workload.md +6021 -0
- package/dist/docs/resources/workload_flavor.md +90 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0000.public.ves.io.schema.ai_assistant.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0001.public.ves.io.schema.api_sec.api_crawler.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0002.public.ves.io.schema.views.api_definition.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0003.public.ves.io.schema.api_sec.api_discovery.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0004.public.ves.io.schema.api_group.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0005.public.ves.io.schema.api_group_element.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0006.public.ves.io.schema.api_sec.api_testing.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0007.public.ves.io.schema.api_credential.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0008.public.ves.io.schema.pbac.addon_service.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0009.public.ves.io.schema.pbac.addon_subscription.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0010.public.ves.io.schema.address_allocator.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0011.public.ves.io.schema.advertise_policy.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0012.public.ves.io.schema.alert_policy.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0013.public.ves.io.schema.alert_receiver.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0014.public.ves.io.schema.alert.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0015.public.ves.io.schema.tenant_management.allowed_tenant.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0016.public.ves.io.schema.views.app_api_group.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0017.public.ves.io.schema.app_setting.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0018.public.ves.io.schema.app_type.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0019.public.ves.io.schema.app_firewall.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0020.public.ves.io.schema.app_security.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0021.public.ves.io.schema.api_sec.rule_suggestion.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0022.public.ves.io.schema.shape.device_id.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0023.public.ves.io.schema.authentication.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0024.public.ves.io.schema.ai_data.bfdp.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0025.public.ves.io.schema.ai_data.bfdp.subscription.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0026.public.ves.io.schema.bgp.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0027.public.ves.io.schema.bgp_asn_set.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0028.public.ves.io.schema.operate.bgp.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0029.public.ves.io.schema.bgp_routing_policy.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0030.public.ves.io.schema.bigip.apm.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0031.public.ves.io.schema.bigip_irule.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0032.public.ves.io.schema.views.bigip_virtual_server.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0033.public.ves.io.schema.shape.brmalerts.alert_gen_policy.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0034.public.ves.io.schema.shape.brmalerts.alert_template.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0035.public.ves.io.schema.views.bot_defense_app_infrastructure.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0036.public.ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_rule.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0037.public.ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_update.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0038.public.ves.io.schema.shape.bot_defense.bot_endpoint_policy.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0039.public.ves.io.schema.shape.bot_defense.bot_infrastructure.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0040.public.ves.io.schema.shape.bot_defense.bot_allowlist_policy.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0041.public.ves.io.schema.shape.bot_defense.bot_network_policy.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0042.public.ves.io.schema.views.cdn_loadbalancer.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0043.public.ves.io.schema.cdn_cache_rule.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0044.public.ves.io.schema.crl.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0045.public.ves.io.schema.operate.crl.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0046.public.ves.io.schema.pbac.catalog.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0047.public.ves.io.schema.cminstance.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0048.public.ves.io.schema.certificate.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0049.public.ves.io.schema.certificate_chain.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0050.public.ves.io.schema.certified_hardware.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0051.public.ves.io.schema.tenant_management.child_tenant.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0052.public.ves.io.schema.tenant_management.child_tenant_manager.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0053.public.ves.io.schema.shape.client_side_defense.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0054.public.ves.io.schema.shape.client_side_defense.allowed_domain.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0055.public.ves.io.schema.shape.client_side_defense.protected_domain.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0056.public.ves.io.schema.shape.client_side_defense.mitigated_domain.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0057.public.ves.io.schema.shape.client_side_defense.subscription.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0058.public.ves.io.schema.cloud_connect.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0059.public.ves.io.schema.cloud_credentials.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0060.public.ves.io.schema.cloud_elastic_ip.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0061.public.ves.io.schema.cloud_region.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0062.public.ves.io.schema.cloud_link.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0063.public.ves.io.schema.cluster.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0064.public.ves.io.schema.api_sec.code_base_integration.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0065.public.ves.io.schema.views.aws_tgw_site.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0066.public.ves.io.schema.views.aws_vpc_site.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0067.public.ves.io.schema.views.voltstack_site.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0068.public.ves.io.schema.views.azure_vnet_site.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0069.public.ves.io.schema.dns_compliance_checks.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0071.public.ves.io.schema.views.forward_proxy_policy.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0072.public.ves.io.schema.views.gcp_vpc_site.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0073.public.ves.io.schema.views.http_loadbalancer.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0074.public.ves.io.schema.views.network_policy_view.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0075.public.ves.io.schema.protocol_inspection.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0076.public.ves.io.schema.views.securemesh_site.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0077.public.ves.io.schema.views.securemesh_site_v2.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0078.public.ves.io.schema.views.tcp_loadbalancer.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0079.public.ves.io.schema.views.udp_loadbalancer.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0080.public.ves.io.schema.bigcne.irule.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0081.public.ves.io.schema.graph.connectivity.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0082.public.ves.io.schema.contact.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0083.public.ves.io.schema.container_registry.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0084.public.ves.io.schema.customer_support.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0085.public.ves.io.schema.dc_cluster_group.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0086.public.ves.io.schema.dns_domain.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0087.public.ves.io.schema.dns_load_balancer.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0088.public.ves.io.schema.dns_lb_health_check.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0089.public.ves.io.schema.dns_lb_pool.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0090.public.ves.io.schema.observability.synthetic_monitor.v1_dns_monitor.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0091.public.ves.io.schema.dns_zone.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0092.public.ves.io.schema.shape.data_delivery.receiver.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0093.public.ves.io.schema.shape.data_delivery.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0094.public.ves.io.schema.bigcne.data_group.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0095.public.ves.io.schema.shape.data_delivery.subscription.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0096.public.ves.io.schema.data_type.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0097.public.ves.io.schema.operate.debug.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0098.public.ves.io.schema.operate.dhcp.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0100.public.ves.io.schema.discovered_service.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0101.public.ves.io.schema.discovery.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0102.public.ves.io.schema.endpoint.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0103.public.ves.io.schema.enhanced_firewall_policy.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0104.public.ves.io.schema.views.external_connector.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0105.public.ves.io.schema.dns_zone.rrset.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0106.public.ves.io.schema.dns_zone.subscription.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0107.public.ves.io.schema.malware_protection.subscription.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0108.public.ves.io.schema.secret_management.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0109.public.ves.io.schema.voltshare.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0110.public.ves.io.schema.maintenance_status.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0111.public.ves.io.schema.fast_acl.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0112.public.ves.io.schema.fast_acl_rule.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0113.public.ves.io.schema.filter_set.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0114.public.ves.io.schema.fleet.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0115.public.ves.io.schema.flow_anomaly.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0116.public.ves.io.schema.operate.flow.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0117.public.ves.io.schema.flow.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0118.public.ves.io.schema.forwarding_class.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0119.public.ves.io.schema.data_privacy.geo_config.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0120.public.ves.io.schema.geo_location_set.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0121.public.ves.io.schema.gia.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0122.public.ves.io.schema.global_log_receiver.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0123.public.ves.io.schema.observability.synthetic_monitor.v1_http_monitor.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0124.public.ves.io.schema.healthcheck.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0125.public.ves.io.schema.ike1.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0126.public.ves.io.schema.views.ike_phase1_profile.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0127.public.ves.io.schema.ike2.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0128.public.ves.io.schema.views.ike_phase2_profile.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0129.public.ves.io.schema.ip_prefix_set.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0130.public.ves.io.schema.implicit_label.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0131.public.ves.io.schema.infraprotect.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0132.public.ves.io.schema.infraprotect_asn.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0133.public.ves.io.schema.infraprotect_asn_prefix.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0134.public.ves.io.schema.infraprotect_deny_list_rule.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0135.public.ves.io.schema.infraprotect_firewall_rule.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0136.public.ves.io.schema.infraprotect_firewall_rule_group.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0137.public.ves.io.schema.infraprotect_firewall_ruleset.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0138.public.ves.io.schema.infraprotect_information.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0139.public.ves.io.schema.infraprotect_internet_prefix_advertisement.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0140.public.ves.io.schema.usage.invoice.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0141.public.ves.io.schema.k8s_cluster.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0142.public.ves.io.schema.k8s_cluster_role.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0143.public.ves.io.schema.k8s_cluster_role_binding.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0144.public.ves.io.schema.k8s_pod_security_admission.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0145.public.ves.io.schema.k8s_pod_security_policy.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0146.public.ves.io.schema.known_label.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0147.public.ves.io.schema.known_label_key.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0148.public.ves.io.schema.data_privacy.lma_region.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0149.public.ves.io.schema.operate.lte.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0150.public.ves.io.schema.log_receiver.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0151.public.ves.io.schema.log.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0152.public.ves.io.schema.malicious_user_mitigation.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0153.public.ves.io.schema.tenant_management.managed_tenant.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0154.public.ves.io.schema.shape.mobile_app_shield.subscription.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0155.public.ves.io.schema.shape.mobile_integrator.subscription.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0156.public.ves.io.schema.shape.bot_defense.mobile_sdk.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0157.public.ves.io.schema.shape.bot_defense.mobile_base_config.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0158.public.ves.io.schema.module_management.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0159.public.ves.io.schema.nat_policy.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0160.public.ves.io.schema.nfv_service.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0161.public.ves.io.schema.nginx.one.nginx_csg.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0162.public.ves.io.schema.nginx.one.nginx_instance.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0163.public.ves.io.schema.nginx.one.nginx_server.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0164.public.ves.io.schema.nginx.one.subscription.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0165.public.ves.io.schema.nginx.one.nginx_service_discovery.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0166.public.ves.io.schema.namespace.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0167.public.ves.io.schema.namespace_role.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0168.public.ves.io.schema.pbac.navigation_tile.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0169.public.ves.io.schema.network_connector.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0170.public.ves.io.schema.network_firewall.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0171.public.ves.io.schema.network_interface.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0172.public.ves.io.schema.network_policy.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0173.public.ves.io.schema.network_policy_rule.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0174.public.ves.io.schema.network_policy_set.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0175.public.ves.io.schema.observability.subscription.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0176.public.ves.io.schema.marketplace.aws_account.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0177.public.ves.io.schema.views.origin_pool.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0178.public.ves.io.schema.billing.payment_method.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0179.public.ves.io.schema.operate.ping.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0180.public.ves.io.schema.pbac.plan.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0181.public.ves.io.schema.billing.plan_transition.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0182.public.ves.io.schema.policer.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0183.public.ves.io.schema.views.policy_based_routing.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0184.public.ves.io.schema.shape.bot_defense.protected_application.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0185.public.ves.io.schema.protocol_policer.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0186.public.ves.io.schema.views.proxy.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0187.public.ves.io.schema.public_ip.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0188.public.ves.io.schema.quota.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0189.public.ves.io.schema.rbac_policy.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0190.public.ves.io.schema.rate_limiter.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0191.public.ves.io.schema.views.rate_limiter_policy.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0192.public.ves.io.schema.registration.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0193.public.ves.io.schema.report.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0194.public.ves.io.schema.report_config.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0195.public.ves.io.schema.role.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0196.public.ves.io.schema.trusted_ca_list.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0197.public.ves.io.schema.route.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0198.public.ves.io.schema.operate.route.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0199.public.ves.io.schema.srv6_network_slice.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0200.public.ves.io.schema.oidc_provider.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0201.public.ves.io.schema.secret_management_access.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0202.public.ves.io.schema.secret_policy.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0203.public.ves.io.schema.secret_policy_rule.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0204.public.ves.io.schema.segment.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0205.public.ves.io.schema.segment_connection.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0206.public.ves.io.schema.sensitive_data_policy.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0207.public.ves.io.schema.graph.service.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0208.public.ves.io.schema.service_policy.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0209.public.ves.io.schema.service_policy_rule.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0210.public.ves.io.schema.service_policy_set.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0211.public.ves.io.schema.shape_bot_defense_instance.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0212.public.ves.io.schema.shape.bot_defense.reporting.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0213.public.ves.io.schema.shape.bot_defense.subscription.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0214.public.ves.io.schema.shape.recognize.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0215.public.ves.io.schema.shape.safeap.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0216.public.ves.io.schema.shape.safe.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0217.public.ves.io.schema.signup.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0218.public.ves.io.schema.site.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0219.public.ves.io.schema.graph.site.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0220.public.ves.io.schema.site_mesh_group.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0221.public.ves.io.schema.status_at_site.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0222.public.ves.io.schema.stored_object.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0223.public.ves.io.schema.subnet.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0224.public.ves.io.schema.usage.subscription.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0225.public.ves.io.schema.subscription.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0226.public.ves.io.schema.observability.synthetic_monitor.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0227.public.ves.io.schema.scim.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0228.public.ves.io.schema.tpm_api_key.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0229.public.ves.io.schema.tpm_category.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0230.public.ves.io.schema.tpm_manager.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0231.public.ves.io.schema.tpm_provision.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0232.public.ves.io.schema.operate.tcpdump.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0233.public.ves.io.schema.tenant.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0234.public.ves.io.schema.views.tenant_configuration.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0235.public.ves.io.schema.tenant_management.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0236.public.ves.io.schema.tenant_management.tenant_profile.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0237.public.ves.io.schema.views.third_party_application.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0238.public.ves.io.schema.ticket_management.ticket_tracking_system.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0239.public.ves.io.schema.token.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0240.public.ves.io.schema.topology.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0241.public.ves.io.schema.operate.traceroute.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0242.public.ves.io.schema.tunnel.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0243.public.ves.io.schema.infraprotect_tunnel.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0244.public.ves.io.schema.operate.usb.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0245.public.ves.io.schema.usb_policy.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0246.public.ves.io.schema.ui.static_component.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0247.public.ves.io.schema.upgrade_status.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0248.public.ves.io.schema.virtual_appliance.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0249.public.ves.io.schema.usage.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0250.public.ves.io.schema.usage.plan.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0251.public.ves.io.schema.user.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0252.public.ves.io.schema.user_group.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0253.public.ves.io.schema.user_identification.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0254.public.ves.io.schema.user.setting.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0255.public.ves.io.schema.views.view_internal.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0256.public.ves.io.schema.views.terraform_parameters.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0257.public.ves.io.schema.virtual_host.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0258.public.ves.io.schema.virtual_k8s.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0259.public.ves.io.schema.virtual_network.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0260.public.ves.io.schema.virtual_site.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0261.public.ves.io.schema.voltshare_admin_policy.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0262.public.ves.io.schema.waf.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0263.public.ves.io.schema.waf_exclusion_policy.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0264.public.ves.io.schema.waf_signatures_changelog.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0265.public.ves.io.schema.operate.wifi.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0266.public.ves.io.schema.was.user_token.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0267.public.ves.io.schema.views.workload.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0268.public.ves.io.schema.workload_flavor.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0269.public.ves.io.schema.marketplace.xc_saas.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0270.public.ves.io.schema.graph.l3l4.ves-swagger.json +1 -0
- package/dist/index.d.ts +5 -1
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +26 -22
- package/dist/index.js.map +1 -1
- package/dist/services/api-specs.d.ts.map +1 -1
- package/dist/services/api-specs.js +15 -3
- package/dist/services/api-specs.js.map +1 -1
- package/dist/services/documentation.d.ts.map +1 -1
- package/dist/services/documentation.js +25 -9
- package/dist/services/documentation.js.map +1 -1
- package/package.json +6 -3
|
@@ -0,0 +1,3800 @@
|
|
|
1
|
+
---
|
|
2
|
+
page_title: "f5xc_cdn_loadbalancer Resource - terraform-provider-f5xc"
|
|
3
|
+
subcategory: "Load Balancing"
|
|
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.
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
# f5xc_cdn_loadbalancer (Resource)
|
|
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.
|
|
11
|
+
|
|
12
|
+
~> **Note** Please refer to [CDN Loadbalancer API docs](https://docs.cloud.f5.com/docs-v2/api/views-cdn-loadbalancer) to learn more.
|
|
13
|
+
|
|
14
|
+
## Example Usage
|
|
15
|
+
|
|
16
|
+
```terraform
|
|
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.
|
|
19
|
+
|
|
20
|
+
# Basic CDN Loadbalancer configuration
|
|
21
|
+
resource "f5xc_cdn_loadbalancer" "example" {
|
|
22
|
+
name = "example-cdn-loadbalancer"
|
|
23
|
+
namespace = "staging"
|
|
24
|
+
|
|
25
|
+
labels = {
|
|
26
|
+
environment = "production"
|
|
27
|
+
managed_by = "terraform"
|
|
28
|
+
}
|
|
29
|
+
|
|
30
|
+
annotations = {
|
|
31
|
+
"owner" = "platform-team"
|
|
32
|
+
}
|
|
33
|
+
|
|
34
|
+
# CDN Load Balancer configuration
|
|
35
|
+
domains = ["cdn.example.com"]
|
|
36
|
+
|
|
37
|
+
# Origin pool
|
|
38
|
+
origin_pool {
|
|
39
|
+
public_name {
|
|
40
|
+
dns_name = "origin.example.com"
|
|
41
|
+
}
|
|
42
|
+
follow_origin_redirect = true
|
|
43
|
+
no_tls {}
|
|
44
|
+
}
|
|
45
|
+
|
|
46
|
+
# Cache TTL settings
|
|
47
|
+
cache_ttl_options {
|
|
48
|
+
cache_ttl_default = "1h"
|
|
49
|
+
}
|
|
50
|
+
|
|
51
|
+
# HTTP protocol
|
|
52
|
+
https_auto_cert {
|
|
53
|
+
http_redirect = true
|
|
54
|
+
}
|
|
55
|
+
|
|
56
|
+
# Add location header
|
|
57
|
+
add_location = true
|
|
58
|
+
}
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
<!-- schema generated by tfplugindocs -->
|
|
62
|
+
## Argument Reference
|
|
63
|
+
|
|
64
|
+
### Metadata Argument Reference
|
|
65
|
+
|
|
66
|
+
<a id="name"></a>• [`name`](#name) - Required String<br>Name of the CDN Load Balancer. Must be unique within the namespace
|
|
67
|
+
|
|
68
|
+
<a id="namespace"></a>• [`namespace`](#namespace) - Required String<br>Namespace where the CDN Load Balancer will be created
|
|
69
|
+
|
|
70
|
+
<a id="annotations"></a>• [`annotations`](#annotations) - Optional Map<br>Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata
|
|
71
|
+
|
|
72
|
+
<a id="description"></a>• [`description`](#description) - Optional String<br>Human readable description for the object
|
|
73
|
+
|
|
74
|
+
<a id="disable"></a>• [`disable`](#disable) - Optional Bool<br>A value of true will administratively disable the object
|
|
75
|
+
|
|
76
|
+
<a id="labels"></a>• [`labels`](#labels) - Optional Map<br>Labels is a user defined key value map that can be attached to resources for organization and filtering
|
|
77
|
+
|
|
78
|
+
### Spec Argument Reference
|
|
79
|
+
|
|
80
|
+
-> **One of the following:**
|
|
81
|
+
• <a id="active-service-policies"></a>[`active_service_policies`](#active-service-policies) - Optional Block<br>Service Policy List. List of service policies<br>See [Active Service Policies](#active-service-policies) below for details.
|
|
82
|
+
<br><br>• <a id="no-service-policies"></a>[`no_service_policies`](#no-service-policies) - Optional Block<br>Enable this option
|
|
83
|
+
|
|
84
|
+
-> **One of the following:**
|
|
85
|
+
• <a id="api-rate-limit"></a>[`api_rate_limit`](#api-rate-limit) - Optional Block<br>APIRateLimit<br>See [API Rate Limit](#api-rate-limit) below for details.
|
|
86
|
+
<br><br>• <a id="disable-rate-limit"></a>[`disable_rate_limit`](#disable-rate-limit) - Optional Block<br>Enable this option
|
|
87
|
+
|
|
88
|
+
-> **One of the following:**
|
|
89
|
+
• <a id="api-specification"></a>[`api_specification`](#api-specification) - Optional Block<br>API Specification and Validation. Settings for API specification (API definition, OpenAPI validation, etc.)
|
|
90
|
+
|
|
91
|
+
-> **One of the following:**
|
|
92
|
+
• <a id="app-firewall"></a>[`app_firewall`](#app-firewall) - 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
|
|
93
|
+
|
|
94
|
+
<a id="blocked-clients"></a>• [`blocked_clients`](#blocked-clients) - Optional Block<br>Client Blocking Rules. Define rules to block IP Prefixes or AS numbers
|
|
95
|
+
|
|
96
|
+
<a id="bot-defense"></a>• [`bot_defense`](#bot-defense) - Optional Block<br>Bot Defense. This defines various configuration options for Bot Defense Policy
|
|
97
|
+
|
|
98
|
+
-> **One of the following:**
|
|
99
|
+
• <a id="captcha-challenge"></a>[`captcha_challenge`](#captcha-challenge) - Optional Block<br>Captcha Challenge Parameters. Enables loadbalancer to perform captcha challenge Captcha challenge will be based on Google Recaptcha. With this feature enabled, only clients that pass the captcha challenge will be allowed to complete the HTTP request. When loadbalancer is configured to do Captcha Challenge, it will redirect the browser to an HTML page on every new HTTP request. This HTML page will have captcha challenge embedded in it. Client will be allowed to make the request only if the captcha challenge is successful. Loadbalancer will tag response header with a cookie to avoid Captcha challenge for subsequent requests. CAPTCHA is mainly used as a security check to ensure only human users can pass through. Generally, computers or bots are not capable of solving a captcha. You can enable either Javascript challenge or Captcha challenge on a virtual host
|
|
100
|
+
<br><br>• <a id="enable-challenge"></a>[`enable_challenge`](#enable-challenge) - Optional Block<br>Enable Malicious User Challenge. Configure auto mitigation i.e risk based challenges for malicious users
|
|
101
|
+
<br><br>• <a id="js-challenge"></a>[`js_challenge`](#js-challenge) - Optional Block<br>Javascript Challenge Parameters. Enables loadbalancer to perform client browser compatibility test by redirecting to a page with Javascript. With this feature enabled, only clients that are capable of executing Javascript(mostly browsers) will be allowed to complete the HTTP request. When loadbalancer is configured to do Javascript Challenge, it will redirect the browser to an HTML page on every new HTTP request. This HTML page will have Javascript embedded in it. Loadbalancer chooses a set of random numbers for every new client and sends these numbers along with an encrypted answer with the request such that it embed these numbers as input in the Javascript. Javascript will run on the requestor browser and perform a complex Math operation. Script will submit the answer to loadbalancer. Loadbalancer will validate the answer by comparing the calculated answer with the decrypted answer (which was encrypted when it was sent back as reply) and allow the request to the upstream server only if the answer is correct. Loadbalancer will tag response header with a cookie to avoid Javascript challenge for subsequent requests. Javascript challenge serves following purposes \* Validate that the request is coming via a browser that is capable for running Javascript \* Force the browser to run a complex operation, f(X), that requires it to spend a large number of CPU cycles. This is to slow down a potential DOS attacker by making it difficult to launch a large request flood without having to spend even larger CPU cost at their end. You can enable either Javascript challenge or Captcha challenge on a virtual host
|
|
102
|
+
<br><br>• <a id="no-challenge"></a>[`no_challenge`](#no-challenge) - Optional Block<br>Enable this option
|
|
103
|
+
|
|
104
|
+
-> **One of the following:**
|
|
105
|
+
• <a id="client-side-defense"></a>[`client_side_defense`](#client-side-defense) - Optional Block<br>Client-Side Defense. This defines various configuration options for Client-Side Defense Policy
|
|
106
|
+
|
|
107
|
+
<a id="cors-policy"></a>• [`cors_policy`](#cors-policy) - Optional Block<br>CORS Policy. Cross-Origin Resource Sharing requests configuration specified at Virtual-host or Route level. Route level configuration takes precedence. An example of an Cross origin HTTP request GET /resources/public-data/ HTTP/1.1 Host: bar.other User-Agent: Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10.5; en-US; rv:1.9.1b3pre) Gecko/20081130 Minefield/3.1b3pre Accept: text/HTML,application/xhtml+XML,application/XML;q=0.9,*/*;q=0.8 Accept-Language: en-us,en;q=0.5 Accept-Encoding: gzip,deflate Accept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7 Connection: keep-alive Referrer: `HTTP://foo.example/examples/access-control/simpleXSInvocation.HTML` Origin: `HTTP://foo.example` HTTP/1.1 200 OK Date: Mon, 01 Dec 2008 00:23:53 GMT Server: Apache/2.0.61 Access-Control-Allow-Origin: \* Keep-Alive: timeout=2, max=100 Connection: Keep-Alive Transfer-Encoding: chunked Content-Type: application/XML An example for cross origin HTTP OPTIONS request with Access-Control-Request-* header OPTIONS /resources/post-here/ HTTP/1.1 Host: bar.other User-Agent: Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10.5; en-US; rv:1.9.1b3pre) Gecko/20081130 Minefield/3.1b3pre Accept: text/HTML,application/xhtml+XML,application/XML;q=0.9,*/*;q=0.8 Accept-Language: en-us,en;q=0.5 Accept-Encoding: gzip,deflate Accept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7 Connection: keep-alive Origin: `HTTP://foo.example` Access-Control-Request-Method: POST Access-Control-Request-Headers: X-PINGOTHER, Content-Type HTTP/1.1 204 No Content Date: Mon, 01 Dec 2008 01:15:39 GMT Server: Apache/2.0.61 (Unix) Access-Control-Allow-Origin: `HTTP://foo.example` Access-Control-Allow-Methods: POST, GET, OPTIONS Access-Control-Allow-Headers: X-PINGOTHER, Content-Type Access-Control-Max-Age: 86400 Vary: Accept-Encoding, Origin Keep-Alive: timeout=2, max=100 Connection: Keep-Alive
|
|
108
|
+
|
|
109
|
+
<a id="csrf-policy"></a>• [`csrf_policy`](#csrf-policy) - Optional Block<br>CSRF Policy. To mitigate CSRF attack , the policy checks where a request is coming from to determine if the request's origin is the same as its detination.The policy relies on two pieces of information used in determining if a request originated from the same host. 1. The origin that caused the user agent to issue the request (source origin). 2. The origin that the request is going to (target origin). When the policy evaluating a request, it ensures both pieces of information are present and compare their values. If the source origin is missing or origins do not match the request is rejected. The exception to this being if the source-origin has been added to they policy as valid. Because CSRF attacks specifically target state-changing requests, the policy only acts on the HTTP requests that have state-changing method (PUT,POST, etc.)
|
|
110
|
+
|
|
111
|
+
<a id="custom-cache-rule"></a>• [`custom_cache_rule`](#custom-cache-rule) - Optional Block<br>Custom Cache Rules. Caching policies for CDN
|
|
112
|
+
|
|
113
|
+
<a id="data-guard-rules"></a>• [`data_guard_rules`](#data-guard-rules) - Optional Block<br>Data Guard Rules. Data Guard prevents responses from exposing sensitive information by masking the data. The system masks credit card numbers and social security numbers leaked from the application from within the HTTP response with a string of asterisks (*). Note: App Firewall should be enabled, to use Data Guard feature
|
|
114
|
+
|
|
115
|
+
<a id="ddos-mitigation-rules"></a>• [`ddos_mitigation_rules`](#ddos-mitigation-rules) - Optional Block<br>DDOS Mitigation Rules. Define manual mitigation rules to block L7 DDOS attacks
|
|
116
|
+
|
|
117
|
+
<a id="default-cache-action"></a>• [`default_cache_action`](#default-cache-action) - Optional Block<br>Default Cache Behaviour. This defines a Default Cache Action
|
|
118
|
+
|
|
119
|
+
-> **One of the following:**
|
|
120
|
+
• <a id="default-sensitive-data-policy"></a>[`default_sensitive_data_policy`](#default-sensitive-data-policy) - Optional Block<br>Enable this option
|
|
121
|
+
|
|
122
|
+
<a id="disable-api-definition"></a>• [`disable_api_definition`](#disable-api-definition) - Optional Block<br>Enable this option
|
|
123
|
+
|
|
124
|
+
-> **One of the following:**
|
|
125
|
+
• <a id="disable-api-discovery"></a>[`disable_api_discovery`](#disable-api-discovery) - Optional Block<br>Enable this option
|
|
126
|
+
|
|
127
|
+
<a id="disable-client-side-defense"></a>• [`disable_client_side_defense`](#disable-client-side-defense) - Optional Block<br>Enable this option
|
|
128
|
+
|
|
129
|
+
-> **One of the following:**
|
|
130
|
+
• <a id="disable-ip-reputation"></a>[`disable_ip_reputation`](#disable-ip-reputation) - Optional Block<br>Enable this option
|
|
131
|
+
|
|
132
|
+
-> **One of the following:**
|
|
133
|
+
• <a id="disable-malicious-user-detection"></a>[`disable_malicious_user_detection`](#disable-malicious-user-detection) - Optional Block<br>Enable this option
|
|
134
|
+
|
|
135
|
+
-> **One of the following:**
|
|
136
|
+
• <a id="disable-threat-mesh"></a>[`disable_threat_mesh`](#disable-threat-mesh) - Optional Block<br>Enable this option
|
|
137
|
+
|
|
138
|
+
<a id="disable-waf"></a>• [`disable_waf`](#disable-waf) - Optional Block<br>Enable this option
|
|
139
|
+
|
|
140
|
+
<a id="domains"></a>• [`domains`](#domains) - Optional List<br>Domains. A list of fully qualified domain names. The CDN Distribution will be setup for these FQDN name(s). [This can be a domain or a sub-domain]
|
|
141
|
+
|
|
142
|
+
<a id="enable-api-discovery"></a>• [`enable_api_discovery`](#enable-api-discovery) - Optional Block<br>API Discovery Setting. Specifies the settings used for API discovery
|
|
143
|
+
|
|
144
|
+
<a id="enable-ip-reputation"></a>• [`enable_ip_reputation`](#enable-ip-reputation) - Optional Block<br>IP Threat Category List. List of IP threat categories
|
|
145
|
+
|
|
146
|
+
<a id="enable-malicious-user-detection"></a>• [`enable_malicious_user_detection`](#enable-malicious-user-detection) - Optional Block<br>Enable this option
|
|
147
|
+
|
|
148
|
+
<a id="enable-threat-mesh"></a>• [`enable_threat_mesh`](#enable-threat-mesh) - Optional Block<br>Enable this option
|
|
149
|
+
|
|
150
|
+
<a id="graphql-rules"></a>• [`graphql_rules`](#graphql-rules) - Optional Block<br>GraphQL Inspection. GraphQL is a query language and server-side runtime for APIs which provides a complete and understandable description of the data in API. GraphQL gives clients the power to ask for exactly what they need, makes it easier to evolve APIs over time, and enables powerful developer tools. Policy configuration to analyze GraphQL queries and prevent GraphQL tailored attacks
|
|
151
|
+
|
|
152
|
+
-> **One of the following:**
|
|
153
|
+
• <a id="http"></a>[`http`](#http) - Optional Block<br>HTTP Choice. Choice for selecting HTTP proxy
|
|
154
|
+
<br><br>• <a id="https"></a>[`https`](#https) - Optional Block<br>BYOC HTTPS Choice. Choice for selecting CDN Distribution with bring your own certificates
|
|
155
|
+
|
|
156
|
+
<a id="https-auto-cert"></a>• [`https_auto_cert`](#https-auto-cert) - Optional Block<br>HTTPS with Automatic Certificate. Choice for selecting HTTPS CDN distribution with bring your own certificates
|
|
157
|
+
|
|
158
|
+
<a id="jwt-validation"></a>• [`jwt_validation`](#jwt-validation) - Optional Block<br>JWT Validation. JWT Validation stops JWT replay attacks and JWT tampering by cryptographically verifying incoming JWTs before they are passed to your API origin. JWT Validation will also stop requests with expired tokens or tokens that are not yet valid
|
|
159
|
+
|
|
160
|
+
-> **One of the following:**
|
|
161
|
+
• <a id="l7-ddos-action-block"></a>[`l7_ddos_action_block`](#l7-ddos-action-block) - Optional Block<br>Enable this option
|
|
162
|
+
<br><br>• <a id="l7-ddos-action-default"></a>[`l7_ddos_action_default`](#l7-ddos-action-default) - Optional Block<br>Enable this option
|
|
163
|
+
|
|
164
|
+
<a id="l7-ddos-action-js-challenge"></a>• [`l7_ddos_action_js_challenge`](#l7-ddos-action-js-challenge) - Optional Block<br>Javascript Challenge Parameters. Enables loadbalancer to perform client browser compatibility test by redirecting to a page with Javascript. With this feature enabled, only clients that are capable of executing Javascript(mostly browsers) will be allowed to complete the HTTP request. When loadbalancer is configured to do Javascript Challenge, it will redirect the browser to an HTML page on every new HTTP request. This HTML page will have Javascript embedded in it. Loadbalancer chooses a set of random numbers for every new client and sends these numbers along with an encrypted answer with the request such that it embed these numbers as input in the Javascript. Javascript will run on the requestor browser and perform a complex Math operation. Script will submit the answer to loadbalancer. Loadbalancer will validate the answer by comparing the calculated answer with the decrypted answer (which was encrypted when it was sent back as reply) and allow the request to the upstream server only if the answer is correct. Loadbalancer will tag response header with a cookie to avoid Javascript challenge for subsequent requests. Javascript challenge serves following purposes \* Validate that the request is coming via a browser that is capable for running Javascript \* Force the browser to run a complex operation, f(X), that requires it to spend a large number of CPU cycles. This is to slow down a potential DOS attacker by making it difficult to launch a large request flood without having to spend even larger CPU cost at their end. You can enable either Javascript challenge or Captcha challenge on a virtual host
|
|
165
|
+
|
|
166
|
+
<a id="origin-pool"></a>• [`origin_pool`](#origin-pool) - Optional Block<br>CDN Origin Pool. Origin Pool for the CDN distribution
|
|
167
|
+
|
|
168
|
+
<a id="other-settings"></a>• [`other_settings`](#other-settings) - Optional Block<br>Other Settings. Other Settings
|
|
169
|
+
|
|
170
|
+
<a id="policy-based-challenge"></a>• [`policy_based_challenge`](#policy-based-challenge) - Optional Block<br>Policy Based Challenge. Specifies the settings for policy rule based challenge
|
|
171
|
+
|
|
172
|
+
<a id="protected-cookies"></a>• [`protected_cookies`](#protected-cookies) - Optional Block<br>Cookie Protection. Allows setting attributes (SameSite, Secure, and HttpOnly) on cookies in responses. Cookie Tampering Protection prevents attackers from modifying the value of session cookies. For Cookie Tampering Protection, enabling a web app firewall (WAF) is a prerequisite. The configured mode of WAF (monitoring or blocking) will be enforced on the request when cookie tampering is identified. Note: We recommend enabling Secure and HttpOnly attributes along with cookie tampering protection
|
|
173
|
+
|
|
174
|
+
<a id="rate-limit"></a>• [`rate_limit`](#rate-limit) - Optional Block<br>RateLimitConfigType
|
|
175
|
+
|
|
176
|
+
<a id="sensitive-data-policy"></a>• [`sensitive_data_policy`](#sensitive-data-policy) - Optional Block<br>Sensitive Data Discovery. Settings for data type policy
|
|
177
|
+
|
|
178
|
+
<a id="service-policies-from-namespace"></a>• [`service_policies_from_namespace`](#service-policies-from-namespace) - Optional Block<br>Enable this option
|
|
179
|
+
|
|
180
|
+
-> **One of the following:**
|
|
181
|
+
• <a id="slow-ddos-mitigation"></a>[`slow_ddos_mitigation`](#slow-ddos-mitigation) - Optional Block<br>Slow DDOS Mitigation. 'Slow and low' attacks tie up server resources, leaving none available for servicing requests from actual users
|
|
182
|
+
|
|
183
|
+
<a id="system-default-timeouts"></a>• [`system_default_timeouts`](#system-default-timeouts) - Optional Block<br>Enable this option
|
|
184
|
+
|
|
185
|
+
<a id="timeouts"></a>• [`timeouts`](#timeouts) - Optional Block
|
|
186
|
+
|
|
187
|
+
<a id="trusted-clients"></a>• [`trusted_clients`](#trusted-clients) - Optional Block<br>Trusted Client Rules. Define rules to skip processing of one or more features such as WAF, Bot Defense etc. for clients
|
|
188
|
+
|
|
189
|
+
-> **One of the following:**
|
|
190
|
+
• <a id="user-id-client-ip"></a>[`user_id_client_ip`](#user-id-client-ip) - Optional Block<br>Enable this option
|
|
191
|
+
<br><br>• <a id="user-identification"></a>[`user_identification`](#user-identification) - 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
|
|
192
|
+
|
|
193
|
+
<a id="waf-exclusion"></a>• [`waf_exclusion`](#waf-exclusion) - Optional Block<br>WAF Exclusion
|
|
194
|
+
|
|
195
|
+
### Attributes Reference
|
|
196
|
+
|
|
197
|
+
In addition to all arguments above, the following attributes are exported:
|
|
198
|
+
|
|
199
|
+
<a id="id"></a>• [`id`](#id) - Optional String<br>Unique identifier for the resource
|
|
200
|
+
|
|
201
|
+
---
|
|
202
|
+
|
|
203
|
+
#### Active Service Policies
|
|
204
|
+
|
|
205
|
+
An [`active_service_policies`](#active-service-policies) block supports the following:
|
|
206
|
+
|
|
207
|
+
<a id="active-service-policies-policies"></a>• [`policies`](#active-service-policies-policies) - Optional Block<br>Policies. Service Policies is a sequential engine where policies (and rules within the policy) are evaluated one after the other. It's important to define the correct order (policies evaluated from top to bottom in the list) for service policies, to get the intended result. For each request, its characteristics are evaluated based on the match criteria in each service policy starting at the top. If there is a match in the current policy, then the policy takes effect, and no more policies are evaluated. Otherwise, the next policy is evaluated. If all policies are evaluated and none match, then the request will be denied by default<br>See [Policies](#active-service-policies-policies) below.
|
|
208
|
+
|
|
209
|
+
#### Active Service Policies Policies
|
|
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>• [`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="active-service-policies-policies-namespace"></a>• [`namespace`](#active-service-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
|
|
216
|
+
|
|
217
|
+
<a id="active-service-policies-policies-tenant"></a>• [`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
|
|
218
|
+
|
|
219
|
+
#### API Rate Limit
|
|
220
|
+
|
|
221
|
+
An [`api_rate_limit`](#api-rate-limit) block supports the following:
|
|
222
|
+
|
|
223
|
+
<a id="api-rate-limit-api-endpoint-rules"></a>• [`api_endpoint_rules`](#api-rate-limit-api-endpoint-rules) - Optional Block<br>API Endpoints. Sets of rules for a specific endpoints. Order is matter as it uses first match policy. For creating rule that contain a whole domain or group of endpoints, please use the server URL rules above<br>See [API Endpoint Rules](#api-rate-limit-api-endpoint-rules) below.
|
|
224
|
+
|
|
225
|
+
<a id="api-rate-limit-bypass-rate-limiting-rules"></a>• [`bypass_rate_limiting_rules`](#api-rate-limit-bypass-rate-limiting-rules) - Optional Block<br>Bypass Rate Limiting. This category defines rules per URL or API group. If request matches any of these rules, skip Rate Limiting<br>See [Bypass Rate Limiting Rules](#api-rate-limit-bypass-rate-limiting-rules) below.
|
|
226
|
+
|
|
227
|
+
<a id="api-rate-limit-custom-ip-allowed-list"></a>• [`custom_ip_allowed_list`](#api-rate-limit-custom-ip-allowed-list) - Optional Block<br>Custom IP Allowed List. IP Allowed list using existing ip_prefix_set objects<br>See [Custom IP Allowed List](#api-rate-limit-custom-ip-allowed-list) below.
|
|
228
|
+
|
|
229
|
+
<a id="api-rate-limit-ip-allowed-list"></a>• [`ip_allowed_list`](#api-rate-limit-ip-allowed-list) - Optional Block<br>IPv4 Prefix List. List of IPv4 prefixes that represent an endpoint<br>See [IP Allowed List](#api-rate-limit-ip-allowed-list) below.
|
|
230
|
+
|
|
231
|
+
<a id="api-rate-limit-no-ip-allowed-list"></a>• [`no_ip_allowed_list`](#api-rate-limit-no-ip-allowed-list) - Optional Block<br>Enable this option
|
|
232
|
+
|
|
233
|
+
<a id="api-rate-limit-server-url-rules"></a>• [`server_url_rules`](#api-rate-limit-server-url-rules) - Optional Block<br>Server URLs. Set of rules for entire domain or base path that contain multiple endpoints. Order is matter as it uses first match policy. For matching also specific endpoints you can use the API endpoint rules set bellow<br>See [Server URL Rules](#api-rate-limit-server-url-rules) below.
|
|
234
|
+
|
|
235
|
+
#### API Rate Limit API Endpoint Rules
|
|
236
|
+
|
|
237
|
+
An [`api_endpoint_rules`](#api-rate-limit-api-endpoint-rules) block (within [`api_rate_limit`](#api-rate-limit)) supports the following:
|
|
238
|
+
|
|
239
|
+
<a id="api-rate-limit-api-endpoint-rules-any-domain"></a>• [`any_domain`](#api-rate-limit-api-endpoint-rules-any-domain) - Optional Block<br>Enable this option
|
|
240
|
+
|
|
241
|
+
<a id="api-rate-limit-api-endpoint-rules-api-endpoint-method"></a>• [`api_endpoint_method`](#api-rate-limit-api-endpoint-rules-api-endpoint-method) - Optional Block<br>HTTP Method Matcher. A HTTP method matcher specifies a list of methods to match an input HTTP method. The match is considered successful if the input method is a member of the list. The result of the match based on the method list is inverted if invert_matcher is true<br>See [API Endpoint Method](#api-rate-limit-api-endpoint-rules-api-endpoint-method) below.
|
|
242
|
+
|
|
243
|
+
<a id="api-rate-limit-api-endpoint-rules-api-endpoint-path"></a>• [`api_endpoint_path`](#api-rate-limit-api-endpoint-rules-api-endpoint-path) - Optional String<br>API Endpoint. The endpoint (path) of the request
|
|
244
|
+
|
|
245
|
+
<a id="api-rate-limit-api-endpoint-rules-client-matcher"></a>• [`client_matcher`](#api-rate-limit-api-endpoint-rules-client-matcher) - Optional Block<br>Client Matcher. Client conditions for matching a rule<br>See [Client Matcher](#api-rate-limit-api-endpoint-rules-client-matcher) below.
|
|
246
|
+
|
|
247
|
+
<a id="api-rate-limit-api-endpoint-rules-inline-rate-limiter"></a>• [`inline_rate_limiter`](#api-rate-limit-api-endpoint-rules-inline-rate-limiter) - Optional Block<br>InlineRateLimiter<br>See [Inline Rate Limiter](#api-rate-limit-api-endpoint-rules-inline-rate-limiter) below.
|
|
248
|
+
|
|
249
|
+
<a id="api-rate-limit-api-endpoint-rules-ref-rate-limiter"></a>• [`ref_rate_limiter`](#api-rate-limit-api-endpoint-rules-ref-rate-limiter) - 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 Rate Limiter](#api-rate-limit-api-endpoint-rules-ref-rate-limiter) below.
|
|
250
|
+
|
|
251
|
+
<a id="api-rate-limit-api-endpoint-rules-request-matcher"></a>• [`request_matcher`](#api-rate-limit-api-endpoint-rules-request-matcher) - Optional Block<br>Request Matcher. Request conditions for matching a rule<br>See [Request Matcher](#api-rate-limit-api-endpoint-rules-request-matcher) below.
|
|
252
|
+
|
|
253
|
+
<a id="api-rate-limit-api-endpoint-rules-specific-domain"></a>• [`specific_domain`](#api-rate-limit-api-endpoint-rules-specific-domain) - Optional String<br>Specific Domain. The rule will apply for a specific domain
|
|
254
|
+
|
|
255
|
+
#### API Rate Limit API Endpoint Rules API Endpoint Method
|
|
256
|
+
|
|
257
|
+
An [`api_endpoint_method`](#api-rate-limit-api-endpoint-rules-api-endpoint-method) block (within [`api_rate_limit.api_endpoint_rules`](#api-rate-limit-api-endpoint-rules)) supports the following:
|
|
258
|
+
|
|
259
|
+
<a id="api-rate-limit-api-endpoint-rules-api-endpoint-method-invert-matcher"></a>• [`invert_matcher`](#api-rate-limit-api-endpoint-rules-api-endpoint-method-invert-matcher) - Optional Bool<br>Invert Method Matcher. Invert the match result
|
|
260
|
+
|
|
261
|
+
<a id="api-rate-limit-api-endpoint-rules-api-endpoint-method-methods"></a>• [`methods`](#api-rate-limit-api-endpoint-rules-api-endpoint-method-methods) - 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
|
|
262
|
+
|
|
263
|
+
#### API Rate Limit API Endpoint Rules Client Matcher
|
|
264
|
+
|
|
265
|
+
A [`client_matcher`](#api-rate-limit-api-endpoint-rules-client-matcher) block (within [`api_rate_limit.api_endpoint_rules`](#api-rate-limit-api-endpoint-rules)) supports the following:
|
|
266
|
+
|
|
267
|
+
<a id="api-rate-limit-api-endpoint-rules-client-matcher-any-client"></a>• [`any_client`](#api-rate-limit-api-endpoint-rules-client-matcher-any-client) - Optional Block<br>Enable this option
|
|
268
|
+
|
|
269
|
+
<a id="api-rate-limit-api-endpoint-rules-client-matcher-any-ip"></a>• [`any_ip`](#api-rate-limit-api-endpoint-rules-client-matcher-any-ip) - Optional Block<br>Enable this option
|
|
270
|
+
|
|
271
|
+
<a id="api-rate-limit-api-endpoint-rules-client-matcher-asn-list"></a>• [`asn_list`](#api-rate-limit-api-endpoint-rules-client-matcher-asn-list) - 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](#api-rate-limit-api-endpoint-rules-client-matcher-asn-list) below.
|
|
272
|
+
|
|
273
|
+
<a id="api-rate-limit-api-endpoint-rules-client-matcher-asn-matcher"></a>• [`asn_matcher`](#api-rate-limit-api-endpoint-rules-client-matcher-asn-matcher) - Optional Block<br>ASN Matcher. Match any AS number contained in the list of bgp_asn_sets<br>See [Asn Matcher](#api-rate-limit-api-endpoint-rules-client-matcher-asn-matcher) below.
|
|
274
|
+
|
|
275
|
+
<a id="api-rate-limit-api-endpoint-rules-client-matcher-client-selector"></a>• [`client_selector`](#api-rate-limit-api-endpoint-rules-client-matcher-client-selector) - 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](#api-rate-limit-api-endpoint-rules-client-matcher-client-selector) below.
|
|
276
|
+
|
|
277
|
+
<a id="api-rate-limit-api-endpoint-rules-client-matcher-ip-matcher"></a>• [`ip_matcher`](#api-rate-limit-api-endpoint-rules-client-matcher-ip-matcher) - 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](#api-rate-limit-api-endpoint-rules-client-matcher-ip-matcher) below.
|
|
278
|
+
|
|
279
|
+
<a id="api-rate-limit-api-endpoint-rules-client-matcher-ip-prefix-list"></a>• [`ip_prefix_list`](#api-rate-limit-api-endpoint-rules-client-matcher-ip-prefix-list) - Optional Block<br>IP Prefix Match List. List of IP Prefix strings to match against<br>See [IP Prefix List](#api-rate-limit-api-endpoint-rules-client-matcher-ip-prefix-list) below.
|
|
280
|
+
|
|
281
|
+
<a id="api-rate-limit-api-endpoint-rules-client-matcher-ip-threat-category-list"></a>• [`ip_threat_category_list`](#api-rate-limit-api-endpoint-rules-client-matcher-ip-threat-category-list) - Optional Block<br>IP Threat Category List Type. List of IP threat categories<br>See [IP Threat Category List](#api-rate-limit-api-endpoint-rules-client-matcher-ip-threat-category-list) below.
|
|
282
|
+
|
|
283
|
+
<a id="api-rate-limit-api-endpoint-rules-client-matcher-tls-fingerprint-matcher"></a>• [`tls_fingerprint_matcher`](#api-rate-limit-api-endpoint-rules-client-matcher-tls-fingerprint-matcher) - 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](#api-rate-limit-api-endpoint-rules-client-matcher-tls-fingerprint-matcher) below.
|
|
284
|
+
|
|
285
|
+
#### API Rate Limit API Endpoint Rules Client Matcher Asn List
|
|
286
|
+
|
|
287
|
+
An [`asn_list`](#api-rate-limit-api-endpoint-rules-client-matcher-asn-list) block (within [`api_rate_limit.api_endpoint_rules.client_matcher`](#api-rate-limit-api-endpoint-rules-client-matcher)) supports the following:
|
|
288
|
+
|
|
289
|
+
<a id="api-rate-limit-api-endpoint-rules-client-matcher-asn-list-as-numbers"></a>• [`as_numbers`](#api-rate-limit-api-endpoint-rules-client-matcher-asn-list-as-numbers) - 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
|
|
290
|
+
|
|
291
|
+
#### API Rate Limit API Endpoint Rules Client Matcher Asn Matcher
|
|
292
|
+
|
|
293
|
+
An [`asn_matcher`](#api-rate-limit-api-endpoint-rules-client-matcher-asn-matcher) block (within [`api_rate_limit.api_endpoint_rules.client_matcher`](#api-rate-limit-api-endpoint-rules-client-matcher)) supports the following:
|
|
294
|
+
|
|
295
|
+
<a id="api-rate-limit-api-endpoint-rules-client-matcher-asn-matcher-asn-sets"></a>• [`asn_sets`](#api-rate-limit-api-endpoint-rules-client-matcher-asn-matcher-asn-sets) - Optional Block<br>BGP ASN Sets. A list of references to bgp_asn_set objects<br>See [Asn Sets](#api-rate-limit-api-endpoint-rules-client-matcher-asn-matcher-asn-sets) below.
|
|
296
|
+
|
|
297
|
+
#### API Rate Limit API Endpoint Rules Client Matcher Asn Matcher Asn Sets
|
|
298
|
+
|
|
299
|
+
An [`asn_sets`](#api-rate-limit-api-endpoint-rules-client-matcher-asn-matcher-asn-sets) block (within [`api_rate_limit.api_endpoint_rules.client_matcher.asn_matcher`](#api-rate-limit-api-endpoint-rules-client-matcher-asn-matcher)) supports the following:
|
|
300
|
+
|
|
301
|
+
<a id="api-rate-limit-api-endpoint-rules-client-matcher-asn-matcher-asn-sets-kind"></a>• [`kind`](#api-rate-limit-api-endpoint-rules-client-matcher-asn-matcher-asn-sets-kind) - 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="api-rate-limit-api-endpoint-rules-client-matcher-asn-matcher-asn-sets-name"></a>• [`name`](#api-rate-limit-api-endpoint-rules-client-matcher-asn-matcher-asn-sets-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
|
|
304
|
+
|
|
305
|
+
<a id="api-rate-limit-api-endpoint-rules-client-matcher-asn-matcher-asn-sets-namespace"></a>• [`namespace`](#api-rate-limit-api-endpoint-rules-client-matcher-asn-matcher-asn-sets-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
|
|
306
|
+
|
|
307
|
+
<a id="api-rate-limit-api-endpoint-rules-client-matcher-asn-matcher-asn-sets-tenant"></a>• [`tenant`](#api-rate-limit-api-endpoint-rules-client-matcher-asn-matcher-asn-sets-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
|
|
308
|
+
|
|
309
|
+
<a id="api-rate-limit-api-endpoint-rules-client-matcher-asn-matcher-asn-sets-uid"></a>• [`uid`](#api-rate-limit-api-endpoint-rules-client-matcher-asn-matcher-asn-sets-uid) - 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
|
|
310
|
+
|
|
311
|
+
#### API Rate Limit API Endpoint Rules Client Matcher Client Selector
|
|
312
|
+
|
|
313
|
+
A [`client_selector`](#api-rate-limit-api-endpoint-rules-client-matcher-client-selector) block (within [`api_rate_limit.api_endpoint_rules.client_matcher`](#api-rate-limit-api-endpoint-rules-client-matcher)) supports the following:
|
|
314
|
+
|
|
315
|
+
<a id="api-rate-limit-api-endpoint-rules-client-matcher-client-selector-expressions"></a>• [`expressions`](#api-rate-limit-api-endpoint-rules-client-matcher-client-selector-expressions) - Optional List<br>Selector Expression. expressions contains the kubernetes style label expression for selections
|
|
316
|
+
|
|
317
|
+
#### API Rate Limit API Endpoint Rules Client Matcher IP Matcher
|
|
318
|
+
|
|
319
|
+
An [`ip_matcher`](#api-rate-limit-api-endpoint-rules-client-matcher-ip-matcher) block (within [`api_rate_limit.api_endpoint_rules.client_matcher`](#api-rate-limit-api-endpoint-rules-client-matcher)) supports the following:
|
|
320
|
+
|
|
321
|
+
<a id="api-rate-limit-api-endpoint-rules-client-matcher-ip-matcher-invert-matcher"></a>• [`invert_matcher`](#api-rate-limit-api-endpoint-rules-client-matcher-ip-matcher-invert-matcher) - Optional Bool<br>Invert IP Matcher. Invert the match result
|
|
322
|
+
|
|
323
|
+
<a id="api-rate-limit-api-endpoint-rules-client-matcher-ip-matcher-prefix-sets"></a>• [`prefix_sets`](#api-rate-limit-api-endpoint-rules-client-matcher-ip-matcher-prefix-sets) - Optional Block<br>IP Prefix Sets. A list of references to ip_prefix_set objects<br>See [Prefix Sets](#api-rate-limit-api-endpoint-rules-client-matcher-ip-matcher-prefix-sets) below.
|
|
324
|
+
|
|
325
|
+
#### API Rate Limit API Endpoint Rules Client Matcher IP Matcher Prefix Sets
|
|
326
|
+
|
|
327
|
+
A [`prefix_sets`](#api-rate-limit-api-endpoint-rules-client-matcher-ip-matcher-prefix-sets) block (within [`api_rate_limit.api_endpoint_rules.client_matcher.ip_matcher`](#api-rate-limit-api-endpoint-rules-client-matcher-ip-matcher)) supports the following:
|
|
328
|
+
|
|
329
|
+
<a id="api-rate-limit-api-endpoint-rules-client-matcher-ip-matcher-prefix-sets-kind"></a>• [`kind`](#api-rate-limit-api-endpoint-rules-client-matcher-ip-matcher-prefix-sets-kind) - 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="api-rate-limit-api-endpoint-rules-client-matcher-ip-matcher-prefix-sets-name"></a>• [`name`](#api-rate-limit-api-endpoint-rules-client-matcher-ip-matcher-prefix-sets-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
|
|
332
|
+
|
|
333
|
+
<a id="api-rate-limit-api-endpoint-rules-client-matcher-ip-matcher-prefix-sets-namespace"></a>• [`namespace`](#api-rate-limit-api-endpoint-rules-client-matcher-ip-matcher-prefix-sets-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
|
|
334
|
+
|
|
335
|
+
<a id="api-rate-limit-api-endpoint-rules-client-matcher-ip-matcher-prefix-sets-tenant"></a>• [`tenant`](#api-rate-limit-api-endpoint-rules-client-matcher-ip-matcher-prefix-sets-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
|
|
336
|
+
|
|
337
|
+
<a id="api-rate-limit-api-endpoint-rules-client-matcher-ip-matcher-prefix-sets-uid"></a>• [`uid`](#api-rate-limit-api-endpoint-rules-client-matcher-ip-matcher-prefix-sets-uid) - 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
|
|
338
|
+
|
|
339
|
+
#### API Rate Limit API Endpoint Rules Client Matcher IP Prefix List
|
|
340
|
+
|
|
341
|
+
An [`ip_prefix_list`](#api-rate-limit-api-endpoint-rules-client-matcher-ip-prefix-list) block (within [`api_rate_limit.api_endpoint_rules.client_matcher`](#api-rate-limit-api-endpoint-rules-client-matcher)) supports the following:
|
|
342
|
+
|
|
343
|
+
<a id="api-rate-limit-api-endpoint-rules-client-matcher-ip-prefix-list-invert-match"></a>• [`invert_match`](#api-rate-limit-api-endpoint-rules-client-matcher-ip-prefix-list-invert-match) - Optional Bool<br>Invert Match Result. Invert the match result
|
|
344
|
+
|
|
345
|
+
<a id="api-rate-limit-api-endpoint-rules-client-matcher-ip-prefix-list-ip-prefixes"></a>• [`ip_prefixes`](#api-rate-limit-api-endpoint-rules-client-matcher-ip-prefix-list-ip-prefixes) - Optional List<br>IPv4 Prefix List. List of IPv4 prefix strings
|
|
346
|
+
|
|
347
|
+
#### API Rate Limit API Endpoint Rules Client Matcher IP Threat Category List
|
|
348
|
+
|
|
349
|
+
An [`ip_threat_category_list`](#api-rate-limit-api-endpoint-rules-client-matcher-ip-threat-category-list) block (within [`api_rate_limit.api_endpoint_rules.client_matcher`](#api-rate-limit-api-endpoint-rules-client-matcher)) supports the following:
|
|
350
|
+
|
|
351
|
+
<a id="api-rate-limit-api-endpoint-rules-client-matcher-ip-threat-category-list-ip-threat-categories"></a>• [`ip_threat_categories`](#api-rate-limit-api-endpoint-rules-client-matcher-ip-threat-category-list-ip-threat-categories) - 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
|
|
352
|
+
|
|
353
|
+
#### API Rate Limit API Endpoint Rules Client Matcher TLS Fingerprint Matcher
|
|
354
|
+
|
|
355
|
+
A [`tls_fingerprint_matcher`](#api-rate-limit-api-endpoint-rules-client-matcher-tls-fingerprint-matcher) block (within [`api_rate_limit.api_endpoint_rules.client_matcher`](#api-rate-limit-api-endpoint-rules-client-matcher)) supports the following:
|
|
356
|
+
|
|
357
|
+
<a id="api-rate-limit-api-endpoint-rules-client-matcher-tls-fingerprint-matcher-classes"></a>• [`classes`](#api-rate-limit-api-endpoint-rules-client-matcher-tls-fingerprint-matcher-classes) - 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="api-rate-limit-api-endpoint-rules-client-matcher-tls-fingerprint-matcher-exact-values"></a>• [`exact_values`](#api-rate-limit-api-endpoint-rules-client-matcher-tls-fingerprint-matcher-exact-values) - Optional List<br>Exact Values. A list of exact TLS JA3 fingerprints to match the input TLS JA3 fingerprint against
|
|
360
|
+
|
|
361
|
+
<a id="api-rate-limit-api-endpoint-rules-client-matcher-tls-fingerprint-matcher-excluded-values"></a>• [`excluded_values`](#api-rate-limit-api-endpoint-rules-client-matcher-tls-fingerprint-matcher-excluded-values) - 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
|
|
362
|
+
|
|
363
|
+
#### API Rate Limit API Endpoint Rules Inline Rate Limiter
|
|
364
|
+
|
|
365
|
+
An [`inline_rate_limiter`](#api-rate-limit-api-endpoint-rules-inline-rate-limiter) block (within [`api_rate_limit.api_endpoint_rules`](#api-rate-limit-api-endpoint-rules)) supports the following:
|
|
366
|
+
|
|
367
|
+
<a id="api-rate-limit-api-endpoint-rules-inline-rate-limiter-ref-user-id"></a>• [`ref_user_id`](#api-rate-limit-api-endpoint-rules-inline-rate-limiter-ref-user-id) - 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](#api-rate-limit-api-endpoint-rules-inline-rate-limiter-ref-user-id) below.
|
|
368
|
+
|
|
369
|
+
<a id="api-rate-limit-api-endpoint-rules-inline-rate-limiter-threshold"></a>• [`threshold`](#api-rate-limit-api-endpoint-rules-inline-rate-limiter-threshold) - 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="api-rate-limit-api-endpoint-rules-inline-rate-limiter-unit"></a>• [`unit`](#api-rate-limit-api-endpoint-rules-inline-rate-limiter-unit) - 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="api-rate-limit-api-endpoint-rules-inline-rate-limiter-use-http-lb-user-id"></a>• [`use_http_lb_user_id`](#api-rate-limit-api-endpoint-rules-inline-rate-limiter-use-http-lb-user-id) - Optional Block<br>Enable this option
|
|
374
|
+
|
|
375
|
+
#### API Rate Limit API Endpoint Rules Inline Rate Limiter Ref User ID
|
|
376
|
+
|
|
377
|
+
A [`ref_user_id`](#api-rate-limit-api-endpoint-rules-inline-rate-limiter-ref-user-id) block (within [`api_rate_limit.api_endpoint_rules.inline_rate_limiter`](#api-rate-limit-api-endpoint-rules-inline-rate-limiter)) supports the following:
|
|
378
|
+
|
|
379
|
+
<a id="api-rate-limit-api-endpoint-rules-inline-rate-limiter-ref-user-id-name"></a>• [`name`](#api-rate-limit-api-endpoint-rules-inline-rate-limiter-ref-user-id-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
|
|
380
|
+
|
|
381
|
+
<a id="api-rate-limit-api-endpoint-rules-inline-rate-limiter-ref-user-id-namespace"></a>• [`namespace`](#api-rate-limit-api-endpoint-rules-inline-rate-limiter-ref-user-id-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
|
|
382
|
+
|
|
383
|
+
<a id="api-rate-limit-api-endpoint-rules-inline-rate-limiter-ref-user-id-tenant"></a>• [`tenant`](#api-rate-limit-api-endpoint-rules-inline-rate-limiter-ref-user-id-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
|
|
384
|
+
|
|
385
|
+
#### API Rate Limit API Endpoint Rules Ref Rate Limiter
|
|
386
|
+
|
|
387
|
+
A [`ref_rate_limiter`](#api-rate-limit-api-endpoint-rules-ref-rate-limiter) block (within [`api_rate_limit.api_endpoint_rules`](#api-rate-limit-api-endpoint-rules)) supports the following:
|
|
388
|
+
|
|
389
|
+
<a id="api-rate-limit-api-endpoint-rules-ref-rate-limiter-name"></a>• [`name`](#api-rate-limit-api-endpoint-rules-ref-rate-limiter-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
|
|
390
|
+
|
|
391
|
+
<a id="api-rate-limit-api-endpoint-rules-ref-rate-limiter-namespace"></a>• [`namespace`](#api-rate-limit-api-endpoint-rules-ref-rate-limiter-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
|
|
392
|
+
|
|
393
|
+
<a id="api-rate-limit-api-endpoint-rules-ref-rate-limiter-tenant"></a>• [`tenant`](#api-rate-limit-api-endpoint-rules-ref-rate-limiter-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
|
|
394
|
+
|
|
395
|
+
#### API Rate Limit API Endpoint Rules Request Matcher
|
|
396
|
+
|
|
397
|
+
A [`request_matcher`](#api-rate-limit-api-endpoint-rules-request-matcher) block (within [`api_rate_limit.api_endpoint_rules`](#api-rate-limit-api-endpoint-rules)) supports the following:
|
|
398
|
+
|
|
399
|
+
<a id="api-rate-limit-api-endpoint-rules-request-matcher-cookie-matchers"></a>• [`cookie_matchers`](#api-rate-limit-api-endpoint-rules-request-matcher-cookie-matchers) - 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](#api-rate-limit-api-endpoint-rules-request-matcher-cookie-matchers) below.
|
|
400
|
+
|
|
401
|
+
<a id="api-rate-limit-api-endpoint-rules-request-matcher-headers"></a>• [`headers`](#api-rate-limit-api-endpoint-rules-request-matcher-headers) - 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](#api-rate-limit-api-endpoint-rules-request-matcher-headers) below.
|
|
402
|
+
|
|
403
|
+
<a id="api-rate-limit-api-endpoint-rules-request-matcher-jwt-claims"></a>• [`jwt_claims`](#api-rate-limit-api-endpoint-rules-request-matcher-jwt-claims) - 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](#api-rate-limit-api-endpoint-rules-request-matcher-jwt-claims) below.
|
|
404
|
+
|
|
405
|
+
<a id="api-rate-limit-api-endpoint-rules-request-matcher-query-params"></a>• [`query_params`](#api-rate-limit-api-endpoint-rules-request-matcher-query-params) - 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](#api-rate-limit-api-endpoint-rules-request-matcher-query-params) below.
|
|
406
|
+
|
|
407
|
+
#### API Rate Limit API Endpoint Rules Request Matcher Cookie Matchers
|
|
408
|
+
|
|
409
|
+
A [`cookie_matchers`](#api-rate-limit-api-endpoint-rules-request-matcher-cookie-matchers) block (within [`api_rate_limit.api_endpoint_rules.request_matcher`](#api-rate-limit-api-endpoint-rules-request-matcher)) supports the following:
|
|
410
|
+
|
|
411
|
+
<a id="api-rate-limit-api-endpoint-rules-request-matcher-cookie-matchers-check-not-present"></a>• [`check_not_present`](#api-rate-limit-api-endpoint-rules-request-matcher-cookie-matchers-check-not-present) - Optional Block<br>Enable this option
|
|
412
|
+
|
|
413
|
+
<a id="api-rate-limit-api-endpoint-rules-request-matcher-cookie-matchers-check-present"></a>• [`check_present`](#api-rate-limit-api-endpoint-rules-request-matcher-cookie-matchers-check-present) - Optional Block<br>Enable this option
|
|
414
|
+
|
|
415
|
+
<a id="api-rate-limit-api-endpoint-rules-request-matcher-cookie-matchers-invert-matcher"></a>• [`invert_matcher`](#api-rate-limit-api-endpoint-rules-request-matcher-cookie-matchers-invert-matcher) - Optional Bool<br>Invert Matcher. Invert Match of the expression defined
|
|
416
|
+
|
|
417
|
+
<a id="api-rate-limit-api-endpoint-rules-request-matcher-cookie-matchers-item"></a>• [`item`](#api-rate-limit-api-endpoint-rules-request-matcher-cookie-matchers-item) - 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](#api-rate-limit-api-endpoint-rules-request-matcher-cookie-matchers-item) below.
|
|
418
|
+
|
|
419
|
+
<a id="api-rate-limit-api-endpoint-rules-request-matcher-cookie-matchers-name"></a>• [`name`](#api-rate-limit-api-endpoint-rules-request-matcher-cookie-matchers-name) - Optional String<br>Cookie Name. A case-sensitive cookie name
|
|
420
|
+
|
|
421
|
+
#### API Rate Limit API Endpoint Rules Request Matcher Cookie Matchers Item
|
|
422
|
+
|
|
423
|
+
An [`item`](#api-rate-limit-api-endpoint-rules-request-matcher-cookie-matchers-item) block (within [`api_rate_limit.api_endpoint_rules.request_matcher.cookie_matchers`](#api-rate-limit-api-endpoint-rules-request-matcher-cookie-matchers)) supports the following:
|
|
424
|
+
|
|
425
|
+
<a id="api-rate-limit-api-endpoint-rules-request-matcher-cookie-matchers-item-exact-values"></a>• [`exact_values`](#api-rate-limit-api-endpoint-rules-request-matcher-cookie-matchers-item-exact-values) - Optional List<br>Exact Values. A list of exact values to match the input against
|
|
426
|
+
|
|
427
|
+
<a id="api-rate-limit-api-endpoint-rules-request-matcher-cookie-matchers-item-regex-values"></a>• [`regex_values`](#api-rate-limit-api-endpoint-rules-request-matcher-cookie-matchers-item-regex-values) - Optional List<br>Regex Values. A list of regular expressions to match the input against
|
|
428
|
+
|
|
429
|
+
<a id="api-rate-limit-api-endpoint-rules-request-matcher-cookie-matchers-item-transformers"></a>• [`transformers`](#api-rate-limit-api-endpoint-rules-request-matcher-cookie-matchers-item-transformers) - 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
|
|
430
|
+
|
|
431
|
+
#### API Rate Limit API Endpoint Rules Request Matcher Headers
|
|
432
|
+
|
|
433
|
+
A [`headers`](#api-rate-limit-api-endpoint-rules-request-matcher-headers) block (within [`api_rate_limit.api_endpoint_rules.request_matcher`](#api-rate-limit-api-endpoint-rules-request-matcher)) supports the following:
|
|
434
|
+
|
|
435
|
+
<a id="api-rate-limit-api-endpoint-rules-request-matcher-headers-check-not-present"></a>• [`check_not_present`](#api-rate-limit-api-endpoint-rules-request-matcher-headers-check-not-present) - Optional Block<br>Enable this option
|
|
436
|
+
|
|
437
|
+
<a id="api-rate-limit-api-endpoint-rules-request-matcher-headers-check-present"></a>• [`check_present`](#api-rate-limit-api-endpoint-rules-request-matcher-headers-check-present) - Optional Block<br>Enable this option
|
|
438
|
+
|
|
439
|
+
<a id="api-rate-limit-api-endpoint-rules-request-matcher-headers-invert-matcher"></a>• [`invert_matcher`](#api-rate-limit-api-endpoint-rules-request-matcher-headers-invert-matcher) - Optional Bool<br>Invert Header Matcher. Invert the match result
|
|
440
|
+
|
|
441
|
+
<a id="api-rate-limit-api-endpoint-rules-request-matcher-headers-item"></a>• [`item`](#api-rate-limit-api-endpoint-rules-request-matcher-headers-item) - 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](#api-rate-limit-api-endpoint-rules-request-matcher-headers-item) below.
|
|
442
|
+
|
|
443
|
+
<a id="api-rate-limit-api-endpoint-rules-request-matcher-headers-name"></a>• [`name`](#api-rate-limit-api-endpoint-rules-request-matcher-headers-name) - Optional String<br>Header Name. A case-insensitive HTTP header name
|
|
444
|
+
|
|
445
|
+
#### API Rate Limit API Endpoint Rules Request Matcher Headers Item
|
|
446
|
+
|
|
447
|
+
An [`item`](#api-rate-limit-api-endpoint-rules-request-matcher-headers-item) block (within [`api_rate_limit.api_endpoint_rules.request_matcher.headers`](#api-rate-limit-api-endpoint-rules-request-matcher-headers)) supports the following:
|
|
448
|
+
|
|
449
|
+
<a id="api-rate-limit-api-endpoint-rules-request-matcher-headers-item-exact-values"></a>• [`exact_values`](#api-rate-limit-api-endpoint-rules-request-matcher-headers-item-exact-values) - Optional List<br>Exact Values. A list of exact values to match the input against
|
|
450
|
+
|
|
451
|
+
<a id="api-rate-limit-api-endpoint-rules-request-matcher-headers-item-regex-values"></a>• [`regex_values`](#api-rate-limit-api-endpoint-rules-request-matcher-headers-item-regex-values) - Optional List<br>Regex Values. A list of regular expressions to match the input against
|
|
452
|
+
|
|
453
|
+
<a id="api-rate-limit-api-endpoint-rules-request-matcher-headers-item-transformers"></a>• [`transformers`](#api-rate-limit-api-endpoint-rules-request-matcher-headers-item-transformers) - 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
|
|
454
|
+
|
|
455
|
+
#### API Rate Limit API Endpoint Rules Request Matcher JWT Claims
|
|
456
|
+
|
|
457
|
+
A [`jwt_claims`](#api-rate-limit-api-endpoint-rules-request-matcher-jwt-claims) block (within [`api_rate_limit.api_endpoint_rules.request_matcher`](#api-rate-limit-api-endpoint-rules-request-matcher)) supports the following:
|
|
458
|
+
|
|
459
|
+
<a id="api-rate-limit-api-endpoint-rules-request-matcher-jwt-claims-check-not-present"></a>• [`check_not_present`](#api-rate-limit-api-endpoint-rules-request-matcher-jwt-claims-check-not-present) - Optional Block<br>Enable this option
|
|
460
|
+
|
|
461
|
+
<a id="api-rate-limit-api-endpoint-rules-request-matcher-jwt-claims-check-present"></a>• [`check_present`](#api-rate-limit-api-endpoint-rules-request-matcher-jwt-claims-check-present) - Optional Block<br>Enable this option
|
|
462
|
+
|
|
463
|
+
<a id="api-rate-limit-api-endpoint-rules-request-matcher-jwt-claims-invert-matcher"></a>• [`invert_matcher`](#api-rate-limit-api-endpoint-rules-request-matcher-jwt-claims-invert-matcher) - Optional Bool<br>Invert Matcher. Invert the match result
|
|
464
|
+
|
|
465
|
+
<a id="api-rate-limit-api-endpoint-rules-request-matcher-jwt-claims-item"></a>• [`item`](#api-rate-limit-api-endpoint-rules-request-matcher-jwt-claims-item) - 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](#api-rate-limit-api-endpoint-rules-request-matcher-jwt-claims-item) below.
|
|
466
|
+
|
|
467
|
+
<a id="api-rate-limit-api-endpoint-rules-request-matcher-jwt-claims-name"></a>• [`name`](#api-rate-limit-api-endpoint-rules-request-matcher-jwt-claims-name) - Optional String<br>JWT Claim Name. JWT claim name
|
|
468
|
+
|
|
469
|
+
#### API Rate Limit API Endpoint Rules Request Matcher JWT Claims Item
|
|
470
|
+
|
|
471
|
+
An [`item`](#api-rate-limit-api-endpoint-rules-request-matcher-jwt-claims-item) block (within [`api_rate_limit.api_endpoint_rules.request_matcher.jwt_claims`](#api-rate-limit-api-endpoint-rules-request-matcher-jwt-claims)) supports the following:
|
|
472
|
+
|
|
473
|
+
<a id="api-rate-limit-api-endpoint-rules-request-matcher-jwt-claims-item-exact-values"></a>• [`exact_values`](#api-rate-limit-api-endpoint-rules-request-matcher-jwt-claims-item-exact-values) - Optional List<br>Exact Values. A list of exact values to match the input against
|
|
474
|
+
|
|
475
|
+
<a id="api-rate-limit-api-endpoint-rules-request-matcher-jwt-claims-item-regex-values"></a>• [`regex_values`](#api-rate-limit-api-endpoint-rules-request-matcher-jwt-claims-item-regex-values) - Optional List<br>Regex Values. A list of regular expressions to match the input against
|
|
476
|
+
|
|
477
|
+
<a id="api-rate-limit-api-endpoint-rules-request-matcher-jwt-claims-item-transformers"></a>• [`transformers`](#api-rate-limit-api-endpoint-rules-request-matcher-jwt-claims-item-transformers) - 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
|
|
478
|
+
|
|
479
|
+
#### API Rate Limit API Endpoint Rules Request Matcher Query Params
|
|
480
|
+
|
|
481
|
+
A [`query_params`](#api-rate-limit-api-endpoint-rules-request-matcher-query-params) block (within [`api_rate_limit.api_endpoint_rules.request_matcher`](#api-rate-limit-api-endpoint-rules-request-matcher)) supports the following:
|
|
482
|
+
|
|
483
|
+
<a id="api-rate-limit-api-endpoint-rules-request-matcher-query-params-check-not-present"></a>• [`check_not_present`](#api-rate-limit-api-endpoint-rules-request-matcher-query-params-check-not-present) - Optional Block<br>Enable this option
|
|
484
|
+
|
|
485
|
+
<a id="api-rate-limit-api-endpoint-rules-request-matcher-query-params-check-present"></a>• [`check_present`](#api-rate-limit-api-endpoint-rules-request-matcher-query-params-check-present) - Optional Block<br>Enable this option
|
|
486
|
+
|
|
487
|
+
<a id="api-rate-limit-api-endpoint-rules-request-matcher-query-params-invert-matcher"></a>• [`invert_matcher`](#api-rate-limit-api-endpoint-rules-request-matcher-query-params-invert-matcher) - Optional Bool<br>Invert Query Parameter Matcher. Invert the match result
|
|
488
|
+
|
|
489
|
+
<a id="api-rate-limit-api-endpoint-rules-request-matcher-query-params-item"></a>• [`item`](#api-rate-limit-api-endpoint-rules-request-matcher-query-params-item) - 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](#api-rate-limit-api-endpoint-rules-request-matcher-query-params-item) below.
|
|
490
|
+
|
|
491
|
+
<a id="api-rate-limit-api-endpoint-rules-request-matcher-query-params-key"></a>• [`key`](#api-rate-limit-api-endpoint-rules-request-matcher-query-params-key) - Optional String<br>Query Parameter Name. A case-sensitive HTTP query parameter name
|
|
492
|
+
|
|
493
|
+
#### API Rate Limit API Endpoint Rules Request Matcher Query Params Item
|
|
494
|
+
|
|
495
|
+
An [`item`](#api-rate-limit-api-endpoint-rules-request-matcher-query-params-item) block (within [`api_rate_limit.api_endpoint_rules.request_matcher.query_params`](#api-rate-limit-api-endpoint-rules-request-matcher-query-params)) supports the following:
|
|
496
|
+
|
|
497
|
+
<a id="api-rate-limit-api-endpoint-rules-request-matcher-query-params-item-exact-values"></a>• [`exact_values`](#api-rate-limit-api-endpoint-rules-request-matcher-query-params-item-exact-values) - Optional List<br>Exact Values. A list of exact values to match the input against
|
|
498
|
+
|
|
499
|
+
<a id="api-rate-limit-api-endpoint-rules-request-matcher-query-params-item-regex-values"></a>• [`regex_values`](#api-rate-limit-api-endpoint-rules-request-matcher-query-params-item-regex-values) - Optional List<br>Regex Values. A list of regular expressions to match the input against
|
|
500
|
+
|
|
501
|
+
<a id="api-rate-limit-api-endpoint-rules-request-matcher-query-params-item-transformers"></a>• [`transformers`](#api-rate-limit-api-endpoint-rules-request-matcher-query-params-item-transformers) - 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
|
|
502
|
+
|
|
503
|
+
#### API Rate Limit Bypass Rate Limiting Rules
|
|
504
|
+
|
|
505
|
+
A [`bypass_rate_limiting_rules`](#api-rate-limit-bypass-rate-limiting-rules) block (within [`api_rate_limit`](#api-rate-limit)) supports the following:
|
|
506
|
+
|
|
507
|
+
<a id="api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules"></a>• [`bypass_rate_limiting_rules`](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules) - Optional Block<br>Bypass Rate Limiting. This category defines rules per URL or API group. If request matches any of these rules, skip Rate Limiting<br>See [Bypass Rate Limiting Rules](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules) below.
|
|
508
|
+
|
|
509
|
+
#### API Rate Limit Bypass Rate Limiting Rules Bypass Rate Limiting Rules
|
|
510
|
+
|
|
511
|
+
A [`bypass_rate_limiting_rules`](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules) block (within [`api_rate_limit.bypass_rate_limiting_rules`](#api-rate-limit-bypass-rate-limiting-rules)) supports the following:
|
|
512
|
+
|
|
513
|
+
<a id="api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-any-domain"></a>• [`any_domain`](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-any-domain) - Optional Block<br>Enable this option
|
|
514
|
+
|
|
515
|
+
<a id="api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-any-url"></a>• [`any_url`](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-any-url) - Optional Block<br>Enable this option
|
|
516
|
+
|
|
517
|
+
<a id="api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-api-endpoint"></a>• [`api_endpoint`](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-api-endpoint) - Optional Block<br>API Endpoint. This defines API endpoint<br>See [API Endpoint](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-api-endpoint) below.
|
|
518
|
+
|
|
519
|
+
<a id="api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-api-groups"></a>• [`api_groups`](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-api-groups) - Optional Block<br>API Groups<br>See [API Groups](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-api-groups) below.
|
|
520
|
+
|
|
521
|
+
<a id="api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-base-path"></a>• [`base_path`](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-base-path) - Optional String<br>Base Path. The base path which this validation applies to
|
|
522
|
+
|
|
523
|
+
<a id="api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-client-matcher"></a>• [`client_matcher`](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-client-matcher) - Optional Block<br>Client Matcher. Client conditions for matching a rule<br>See [Client Matcher](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-client-matcher) below.
|
|
524
|
+
|
|
525
|
+
<a id="api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-request-matcher"></a>• [`request_matcher`](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-request-matcher) - Optional Block<br>Request Matcher. Request conditions for matching a rule<br>See [Request Matcher](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-request-matcher) below.
|
|
526
|
+
|
|
527
|
+
<a id="api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-specific-domain"></a>• [`specific_domain`](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-specific-domain) - Optional String<br>Specific Domain. The rule will apply for a specific domain. For example: API.example.com
|
|
528
|
+
|
|
529
|
+
#### API Rate Limit Bypass Rate Limiting Rules Bypass Rate Limiting Rules API Endpoint
|
|
530
|
+
|
|
531
|
+
An [`api_endpoint`](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-api-endpoint) block (within [`api_rate_limit.bypass_rate_limiting_rules.bypass_rate_limiting_rules`](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules)) supports the following:
|
|
532
|
+
|
|
533
|
+
<a id="api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-api-endpoint-methods"></a>• [`methods`](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-api-endpoint-methods) - 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="api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-api-endpoint-path"></a>• [`path`](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-api-endpoint-path) - Optional String<br>Path. Path to be matched
|
|
536
|
+
|
|
537
|
+
#### API Rate Limit Bypass Rate Limiting Rules Bypass Rate Limiting Rules API Groups
|
|
538
|
+
|
|
539
|
+
An [`api_groups`](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-api-groups) block (within [`api_rate_limit.bypass_rate_limiting_rules.bypass_rate_limiting_rules`](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules)) supports the following:
|
|
540
|
+
|
|
541
|
+
<a id="api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-api-groups-api-groups"></a>• [`api_groups`](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-api-groups-api-groups) - Optional List<br>API Groups
|
|
542
|
+
|
|
543
|
+
#### API Rate Limit Bypass Rate Limiting Rules Bypass Rate Limiting Rules Client Matcher
|
|
544
|
+
|
|
545
|
+
A [`client_matcher`](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-client-matcher) block (within [`api_rate_limit.bypass_rate_limiting_rules.bypass_rate_limiting_rules`](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules)) supports the following:
|
|
546
|
+
|
|
547
|
+
<a id="api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-client-matcher-any-client"></a>• [`any_client`](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-client-matcher-any-client) - Optional Block<br>Enable this option
|
|
548
|
+
|
|
549
|
+
<a id="api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-client-matcher-any-ip"></a>• [`any_ip`](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-client-matcher-any-ip) - Optional Block<br>Enable this option
|
|
550
|
+
|
|
551
|
+
<a id="api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-client-matcher-asn-list"></a>• [`asn_list`](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-client-matcher-asn-list) - 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](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-client-matcher-asn-list) below.
|
|
552
|
+
|
|
553
|
+
<a id="api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-client-matcher-asn-matcher"></a>• [`asn_matcher`](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-client-matcher-asn-matcher) - Optional Block<br>ASN Matcher. Match any AS number contained in the list of bgp_asn_sets<br>See [Asn Matcher](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-client-matcher-asn-matcher) below.
|
|
554
|
+
|
|
555
|
+
<a id="api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-client-matcher-client-selector"></a>• [`client_selector`](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-client-matcher-client-selector) - 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](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-client-matcher-client-selector) below.
|
|
556
|
+
|
|
557
|
+
<a id="api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-client-matcher-ip-matcher"></a>• [`ip_matcher`](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-client-matcher-ip-matcher) - 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](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-client-matcher-ip-matcher) below.
|
|
558
|
+
|
|
559
|
+
<a id="api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-client-matcher-ip-prefix-list"></a>• [`ip_prefix_list`](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-client-matcher-ip-prefix-list) - Optional Block<br>IP Prefix Match List. List of IP Prefix strings to match against<br>See [IP Prefix List](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-client-matcher-ip-prefix-list) below.
|
|
560
|
+
|
|
561
|
+
<a id="api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-client-matcher-ip-threat-category-list"></a>• [`ip_threat_category_list`](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-client-matcher-ip-threat-category-list) - Optional Block<br>IP Threat Category List Type. List of IP threat categories<br>See [IP Threat Category List](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-client-matcher-ip-threat-category-list) below.
|
|
562
|
+
|
|
563
|
+
<a id="api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-client-matcher-tls-fingerprint-matcher"></a>• [`tls_fingerprint_matcher`](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-client-matcher-tls-fingerprint-matcher) - 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](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-client-matcher-tls-fingerprint-matcher) below.
|
|
564
|
+
|
|
565
|
+
#### API Rate Limit Bypass Rate Limiting Rules Bypass Rate Limiting Rules Client Matcher Asn List
|
|
566
|
+
|
|
567
|
+
An [`asn_list`](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-client-matcher-asn-list) block (within [`api_rate_limit.bypass_rate_limiting_rules.bypass_rate_limiting_rules.client_matcher`](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-client-matcher)) supports the following:
|
|
568
|
+
|
|
569
|
+
<a id="api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-client-matcher-asn-list-as-numbers"></a>• [`as_numbers`](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-client-matcher-asn-list-as-numbers) - 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
|
|
570
|
+
|
|
571
|
+
#### API Rate Limit Bypass Rate Limiting Rules Bypass Rate Limiting Rules Client Matcher Asn Matcher
|
|
572
|
+
|
|
573
|
+
An [`asn_matcher`](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-client-matcher-asn-matcher) block (within [`api_rate_limit.bypass_rate_limiting_rules.bypass_rate_limiting_rules.client_matcher`](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-client-matcher)) supports the following:
|
|
574
|
+
|
|
575
|
+
<a id="api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-client-matcher-asn-matcher-asn-sets"></a>• [`asn_sets`](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-client-matcher-asn-matcher-asn-sets) - Optional Block<br>BGP ASN Sets. A list of references to bgp_asn_set objects<br>See [Asn Sets](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-client-matcher-asn-matcher-asn-sets) below.
|
|
576
|
+
|
|
577
|
+
#### API Rate Limit Bypass Rate Limiting Rules Bypass Rate Limiting Rules Client Matcher Asn Matcher Asn Sets
|
|
578
|
+
|
|
579
|
+
An [`asn_sets`](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-client-matcher-asn-matcher-asn-sets) block (within [`api_rate_limit.bypass_rate_limiting_rules.bypass_rate_limiting_rules.client_matcher.asn_matcher`](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-client-matcher-asn-matcher)) supports the following:
|
|
580
|
+
|
|
581
|
+
<a id="api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-client-matcher-asn-matcher-asn-sets-kind"></a>• [`kind`](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-client-matcher-asn-matcher-asn-sets-kind) - 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="api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-client-matcher-asn-matcher-asn-sets-name"></a>• [`name`](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-client-matcher-asn-matcher-asn-sets-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
|
|
584
|
+
|
|
585
|
+
<a id="api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-client-matcher-asn-matcher-asn-sets-namespace"></a>• [`namespace`](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-client-matcher-asn-matcher-asn-sets-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
|
|
586
|
+
|
|
587
|
+
<a id="api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-client-matcher-asn-matcher-asn-sets-tenant"></a>• [`tenant`](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-client-matcher-asn-matcher-asn-sets-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
|
|
588
|
+
|
|
589
|
+
<a id="api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-client-matcher-asn-matcher-asn-sets-uid"></a>• [`uid`](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-client-matcher-asn-matcher-asn-sets-uid) - 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
|
|
590
|
+
|
|
591
|
+
#### API Rate Limit Bypass Rate Limiting Rules Bypass Rate Limiting Rules Client Matcher Client Selector
|
|
592
|
+
|
|
593
|
+
A [`client_selector`](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-client-matcher-client-selector) block (within [`api_rate_limit.bypass_rate_limiting_rules.bypass_rate_limiting_rules.client_matcher`](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-client-matcher)) supports the following:
|
|
594
|
+
|
|
595
|
+
<a id="api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-client-matcher-client-selector-expressions"></a>• [`expressions`](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-client-matcher-client-selector-expressions) - Optional List<br>Selector Expression. expressions contains the kubernetes style label expression for selections
|
|
596
|
+
|
|
597
|
+
#### API Rate Limit Bypass Rate Limiting Rules Bypass Rate Limiting Rules Client Matcher IP Matcher
|
|
598
|
+
|
|
599
|
+
An [`ip_matcher`](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-client-matcher-ip-matcher) block (within [`api_rate_limit.bypass_rate_limiting_rules.bypass_rate_limiting_rules.client_matcher`](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-client-matcher)) supports the following:
|
|
600
|
+
|
|
601
|
+
<a id="api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-client-matcher-ip-matcher-invert-matcher"></a>• [`invert_matcher`](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-client-matcher-ip-matcher-invert-matcher) - Optional Bool<br>Invert IP Matcher. Invert the match result
|
|
602
|
+
|
|
603
|
+
<a id="api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-client-matcher-ip-matcher-prefix-sets"></a>• [`prefix_sets`](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-client-matcher-ip-matcher-prefix-sets) - Optional Block<br>IP Prefix Sets. A list of references to ip_prefix_set objects<br>See [Prefix Sets](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-client-matcher-ip-matcher-prefix-sets) below.
|
|
604
|
+
|
|
605
|
+
#### API Rate Limit Bypass Rate Limiting Rules Bypass Rate Limiting Rules Client Matcher IP Matcher Prefix Sets
|
|
606
|
+
|
|
607
|
+
A [`prefix_sets`](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-client-matcher-ip-matcher-prefix-sets) block (within [`api_rate_limit.bypass_rate_limiting_rules.bypass_rate_limiting_rules.client_matcher.ip_matcher`](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-client-matcher-ip-matcher)) supports the following:
|
|
608
|
+
|
|
609
|
+
<a id="api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-client-matcher-ip-matcher-prefix-sets-kind"></a>• [`kind`](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-client-matcher-ip-matcher-prefix-sets-kind) - 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="api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-client-matcher-ip-matcher-prefix-sets-name"></a>• [`name`](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-client-matcher-ip-matcher-prefix-sets-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
|
|
612
|
+
|
|
613
|
+
<a id="api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-client-matcher-ip-matcher-prefix-sets-namespace"></a>• [`namespace`](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-client-matcher-ip-matcher-prefix-sets-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
|
|
614
|
+
|
|
615
|
+
<a id="api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-client-matcher-ip-matcher-prefix-sets-tenant"></a>• [`tenant`](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-client-matcher-ip-matcher-prefix-sets-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
|
|
616
|
+
|
|
617
|
+
<a id="api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-client-matcher-ip-matcher-prefix-sets-uid"></a>• [`uid`](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-client-matcher-ip-matcher-prefix-sets-uid) - 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
|
|
618
|
+
|
|
619
|
+
#### API Rate Limit Bypass Rate Limiting Rules Bypass Rate Limiting Rules Client Matcher IP Prefix List
|
|
620
|
+
|
|
621
|
+
An [`ip_prefix_list`](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-client-matcher-ip-prefix-list) block (within [`api_rate_limit.bypass_rate_limiting_rules.bypass_rate_limiting_rules.client_matcher`](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-client-matcher)) supports the following:
|
|
622
|
+
|
|
623
|
+
<a id="api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-client-matcher-ip-prefix-list-invert-match"></a>• [`invert_match`](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-client-matcher-ip-prefix-list-invert-match) - Optional Bool<br>Invert Match Result. Invert the match result
|
|
624
|
+
|
|
625
|
+
<a id="api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-client-matcher-ip-prefix-list-ip-prefixes"></a>• [`ip_prefixes`](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-client-matcher-ip-prefix-list-ip-prefixes) - Optional List<br>IPv4 Prefix List. List of IPv4 prefix strings
|
|
626
|
+
|
|
627
|
+
#### API Rate Limit Bypass Rate Limiting Rules Bypass Rate Limiting Rules Client Matcher IP Threat Category List
|
|
628
|
+
|
|
629
|
+
An [`ip_threat_category_list`](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-client-matcher-ip-threat-category-list) block (within [`api_rate_limit.bypass_rate_limiting_rules.bypass_rate_limiting_rules.client_matcher`](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-client-matcher)) supports the following:
|
|
630
|
+
|
|
631
|
+
<a id="api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-client-matcher-ip-threat-category-list-ip-threat-categories"></a>• [`ip_threat_categories`](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-client-matcher-ip-threat-category-list-ip-threat-categories) - 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
|
|
632
|
+
|
|
633
|
+
#### API Rate Limit Bypass Rate Limiting Rules Bypass Rate Limiting Rules Client Matcher TLS Fingerprint Matcher
|
|
634
|
+
|
|
635
|
+
A [`tls_fingerprint_matcher`](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-client-matcher-tls-fingerprint-matcher) block (within [`api_rate_limit.bypass_rate_limiting_rules.bypass_rate_limiting_rules.client_matcher`](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-client-matcher)) supports the following:
|
|
636
|
+
|
|
637
|
+
<a id="api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-client-matcher-tls-fingerprint-matcher-classes"></a>• [`classes`](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-client-matcher-tls-fingerprint-matcher-classes) - 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="api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-client-matcher-tls-fingerprint-matcher-exact-values"></a>• [`exact_values`](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-client-matcher-tls-fingerprint-matcher-exact-values) - Optional List<br>Exact Values. A list of exact TLS JA3 fingerprints to match the input TLS JA3 fingerprint against
|
|
640
|
+
|
|
641
|
+
<a id="api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-client-matcher-tls-fingerprint-matcher-excluded-values"></a>• [`excluded_values`](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-client-matcher-tls-fingerprint-matcher-excluded-values) - 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
|
|
642
|
+
|
|
643
|
+
#### API Rate Limit Bypass Rate Limiting Rules Bypass Rate Limiting Rules Request Matcher
|
|
644
|
+
|
|
645
|
+
A [`request_matcher`](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-request-matcher) block (within [`api_rate_limit.bypass_rate_limiting_rules.bypass_rate_limiting_rules`](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules)) supports the following:
|
|
646
|
+
|
|
647
|
+
<a id="api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-request-matcher-cookie-matchers"></a>• [`cookie_matchers`](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-request-matcher-cookie-matchers) - 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](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-request-matcher-cookie-matchers) below.
|
|
648
|
+
|
|
649
|
+
<a id="api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-request-matcher-headers"></a>• [`headers`](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-request-matcher-headers) - 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](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-request-matcher-headers) below.
|
|
650
|
+
|
|
651
|
+
<a id="api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-request-matcher-jwt-claims"></a>• [`jwt_claims`](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-request-matcher-jwt-claims) - 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](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-request-matcher-jwt-claims) below.
|
|
652
|
+
|
|
653
|
+
<a id="api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-request-matcher-query-params"></a>• [`query_params`](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-request-matcher-query-params) - 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](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-request-matcher-query-params) below.
|
|
654
|
+
|
|
655
|
+
#### API Rate Limit Bypass Rate Limiting Rules Bypass Rate Limiting Rules Request Matcher Cookie Matchers
|
|
656
|
+
|
|
657
|
+
A [`cookie_matchers`](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-request-matcher-cookie-matchers) block (within [`api_rate_limit.bypass_rate_limiting_rules.bypass_rate_limiting_rules.request_matcher`](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-request-matcher)) supports the following:
|
|
658
|
+
|
|
659
|
+
<a id="api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-request-matcher-cookie-matchers-check-not-present"></a>• [`check_not_present`](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-request-matcher-cookie-matchers-check-not-present) - Optional Block<br>Enable this option
|
|
660
|
+
|
|
661
|
+
<a id="api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-request-matcher-cookie-matchers-check-present"></a>• [`check_present`](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-request-matcher-cookie-matchers-check-present) - Optional Block<br>Enable this option
|
|
662
|
+
|
|
663
|
+
<a id="api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-request-matcher-cookie-matchers-invert-matcher"></a>• [`invert_matcher`](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-request-matcher-cookie-matchers-invert-matcher) - Optional Bool<br>Invert Matcher. Invert Match of the expression defined
|
|
664
|
+
|
|
665
|
+
<a id="api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-request-matcher-cookie-matchers-item"></a>• [`item`](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-request-matcher-cookie-matchers-item) - 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](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-request-matcher-cookie-matchers-item) below.
|
|
666
|
+
|
|
667
|
+
<a id="api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-request-matcher-cookie-matchers-name"></a>• [`name`](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-request-matcher-cookie-matchers-name) - Optional String<br>Cookie Name. A case-sensitive cookie name
|
|
668
|
+
|
|
669
|
+
#### API Rate Limit Bypass Rate Limiting Rules Bypass Rate Limiting Rules Request Matcher Cookie Matchers Item
|
|
670
|
+
|
|
671
|
+
An [`item`](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-request-matcher-cookie-matchers-item) block (within [`api_rate_limit.bypass_rate_limiting_rules.bypass_rate_limiting_rules.request_matcher.cookie_matchers`](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-request-matcher-cookie-matchers)) supports the following:
|
|
672
|
+
|
|
673
|
+
<a id="api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-request-matcher-cookie-matchers-item-exact-values"></a>• [`exact_values`](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-request-matcher-cookie-matchers-item-exact-values) - Optional List<br>Exact Values. A list of exact values to match the input against
|
|
674
|
+
|
|
675
|
+
<a id="api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-request-matcher-cookie-matchers-item-regex-values"></a>• [`regex_values`](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-request-matcher-cookie-matchers-item-regex-values) - Optional List<br>Regex Values. A list of regular expressions to match the input against
|
|
676
|
+
|
|
677
|
+
<a id="api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-request-matcher-cookie-matchers-item-transformers"></a>• [`transformers`](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-request-matcher-cookie-matchers-item-transformers) - 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
|
|
678
|
+
|
|
679
|
+
#### API Rate Limit Bypass Rate Limiting Rules Bypass Rate Limiting Rules Request Matcher Headers
|
|
680
|
+
|
|
681
|
+
A [`headers`](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-request-matcher-headers) block (within [`api_rate_limit.bypass_rate_limiting_rules.bypass_rate_limiting_rules.request_matcher`](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-request-matcher)) supports the following:
|
|
682
|
+
|
|
683
|
+
<a id="api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-request-matcher-headers-check-not-present"></a>• [`check_not_present`](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-request-matcher-headers-check-not-present) - Optional Block<br>Enable this option
|
|
684
|
+
|
|
685
|
+
<a id="api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-request-matcher-headers-check-present"></a>• [`check_present`](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-request-matcher-headers-check-present) - Optional Block<br>Enable this option
|
|
686
|
+
|
|
687
|
+
<a id="api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-request-matcher-headers-invert-matcher"></a>• [`invert_matcher`](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-request-matcher-headers-invert-matcher) - Optional Bool<br>Invert Header Matcher. Invert the match result
|
|
688
|
+
|
|
689
|
+
<a id="api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-request-matcher-headers-item"></a>• [`item`](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-request-matcher-headers-item) - 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](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-request-matcher-headers-item) below.
|
|
690
|
+
|
|
691
|
+
<a id="api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-request-matcher-headers-name"></a>• [`name`](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-request-matcher-headers-name) - Optional String<br>Header Name. A case-insensitive HTTP header name
|
|
692
|
+
|
|
693
|
+
#### API Rate Limit Bypass Rate Limiting Rules Bypass Rate Limiting Rules Request Matcher Headers Item
|
|
694
|
+
|
|
695
|
+
An [`item`](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-request-matcher-headers-item) block (within [`api_rate_limit.bypass_rate_limiting_rules.bypass_rate_limiting_rules.request_matcher.headers`](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-request-matcher-headers)) supports the following:
|
|
696
|
+
|
|
697
|
+
<a id="api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-request-matcher-headers-item-exact-values"></a>• [`exact_values`](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-request-matcher-headers-item-exact-values) - Optional List<br>Exact Values. A list of exact values to match the input against
|
|
698
|
+
|
|
699
|
+
<a id="api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-request-matcher-headers-item-regex-values"></a>• [`regex_values`](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-request-matcher-headers-item-regex-values) - Optional List<br>Regex Values. A list of regular expressions to match the input against
|
|
700
|
+
|
|
701
|
+
<a id="api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-request-matcher-headers-item-transformers"></a>• [`transformers`](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-request-matcher-headers-item-transformers) - 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
|
|
702
|
+
|
|
703
|
+
#### API Rate Limit Bypass Rate Limiting Rules Bypass Rate Limiting Rules Request Matcher JWT Claims
|
|
704
|
+
|
|
705
|
+
A [`jwt_claims`](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-request-matcher-jwt-claims) block (within [`api_rate_limit.bypass_rate_limiting_rules.bypass_rate_limiting_rules.request_matcher`](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-request-matcher)) supports the following:
|
|
706
|
+
|
|
707
|
+
<a id="api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-request-matcher-jwt-claims-check-not-present"></a>• [`check_not_present`](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-request-matcher-jwt-claims-check-not-present) - Optional Block<br>Enable this option
|
|
708
|
+
|
|
709
|
+
<a id="api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-request-matcher-jwt-claims-check-present"></a>• [`check_present`](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-request-matcher-jwt-claims-check-present) - Optional Block<br>Enable this option
|
|
710
|
+
|
|
711
|
+
<a id="api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-request-matcher-jwt-claims-invert-matcher"></a>• [`invert_matcher`](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-request-matcher-jwt-claims-invert-matcher) - Optional Bool<br>Invert Matcher. Invert the match result
|
|
712
|
+
|
|
713
|
+
<a id="api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-request-matcher-jwt-claims-item"></a>• [`item`](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-request-matcher-jwt-claims-item) - 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](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-request-matcher-jwt-claims-item) below.
|
|
714
|
+
|
|
715
|
+
<a id="api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-request-matcher-jwt-claims-name"></a>• [`name`](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-request-matcher-jwt-claims-name) - Optional String<br>JWT Claim Name. JWT claim name
|
|
716
|
+
|
|
717
|
+
#### API Rate Limit Bypass Rate Limiting Rules Bypass Rate Limiting Rules Request Matcher JWT Claims Item
|
|
718
|
+
|
|
719
|
+
An [`item`](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-request-matcher-jwt-claims-item) block (within [`api_rate_limit.bypass_rate_limiting_rules.bypass_rate_limiting_rules.request_matcher.jwt_claims`](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-request-matcher-jwt-claims)) supports the following:
|
|
720
|
+
|
|
721
|
+
<a id="api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-request-matcher-jwt-claims-item-exact-values"></a>• [`exact_values`](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-request-matcher-jwt-claims-item-exact-values) - Optional List<br>Exact Values. A list of exact values to match the input against
|
|
722
|
+
|
|
723
|
+
<a id="api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-request-matcher-jwt-claims-item-regex-values"></a>• [`regex_values`](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-request-matcher-jwt-claims-item-regex-values) - Optional List<br>Regex Values. A list of regular expressions to match the input against
|
|
724
|
+
|
|
725
|
+
<a id="api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-request-matcher-jwt-claims-item-transformers"></a>• [`transformers`](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-request-matcher-jwt-claims-item-transformers) - 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
|
|
726
|
+
|
|
727
|
+
#### API Rate Limit Bypass Rate Limiting Rules Bypass Rate Limiting Rules Request Matcher Query Params
|
|
728
|
+
|
|
729
|
+
A [`query_params`](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-request-matcher-query-params) block (within [`api_rate_limit.bypass_rate_limiting_rules.bypass_rate_limiting_rules.request_matcher`](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-request-matcher)) supports the following:
|
|
730
|
+
|
|
731
|
+
<a id="api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-request-matcher-query-params-check-not-present"></a>• [`check_not_present`](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-request-matcher-query-params-check-not-present) - Optional Block<br>Enable this option
|
|
732
|
+
|
|
733
|
+
<a id="api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-request-matcher-query-params-check-present"></a>• [`check_present`](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-request-matcher-query-params-check-present) - Optional Block<br>Enable this option
|
|
734
|
+
|
|
735
|
+
<a id="api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-request-matcher-query-params-invert-matcher"></a>• [`invert_matcher`](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-request-matcher-query-params-invert-matcher) - Optional Bool<br>Invert Query Parameter Matcher. Invert the match result
|
|
736
|
+
|
|
737
|
+
<a id="api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-request-matcher-query-params-item"></a>• [`item`](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-request-matcher-query-params-item) - 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](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-request-matcher-query-params-item) below.
|
|
738
|
+
|
|
739
|
+
<a id="api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-request-matcher-query-params-key"></a>• [`key`](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-request-matcher-query-params-key) - Optional String<br>Query Parameter Name. A case-sensitive HTTP query parameter name
|
|
740
|
+
|
|
741
|
+
#### API Rate Limit Bypass Rate Limiting Rules Bypass Rate Limiting Rules Request Matcher Query Params Item
|
|
742
|
+
|
|
743
|
+
An [`item`](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-request-matcher-query-params-item) block (within [`api_rate_limit.bypass_rate_limiting_rules.bypass_rate_limiting_rules.request_matcher.query_params`](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-request-matcher-query-params)) supports the following:
|
|
744
|
+
|
|
745
|
+
<a id="api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-request-matcher-query-params-item-exact-values"></a>• [`exact_values`](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-request-matcher-query-params-item-exact-values) - Optional List<br>Exact Values. A list of exact values to match the input against
|
|
746
|
+
|
|
747
|
+
<a id="api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-request-matcher-query-params-item-regex-values"></a>• [`regex_values`](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-request-matcher-query-params-item-regex-values) - Optional List<br>Regex Values. A list of regular expressions to match the input against
|
|
748
|
+
|
|
749
|
+
<a id="api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-request-matcher-query-params-item-transformers"></a>• [`transformers`](#api-rate-limit-bypass-rate-limiting-rules-bypass-rate-limiting-rules-request-matcher-query-params-item-transformers) - 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
|
|
750
|
+
|
|
751
|
+
#### API Rate Limit Custom IP Allowed List
|
|
752
|
+
|
|
753
|
+
A [`custom_ip_allowed_list`](#api-rate-limit-custom-ip-allowed-list) block (within [`api_rate_limit`](#api-rate-limit)) supports the following:
|
|
754
|
+
|
|
755
|
+
<a id="api-rate-limit-custom-ip-allowed-list-rate-limiter-allowed-prefixes"></a>• [`rate_limiter_allowed_prefixes`](#api-rate-limit-custom-ip-allowed-list-rate-limiter-allowed-prefixes) - Optional Block<br>List of IP Prefix Sets. References to ip_prefix_set objects. Requests from source IP addresses that are covered by one of the allowed IP Prefixes are not subjected to rate limiting<br>See [Rate Limiter Allowed Prefixes](#api-rate-limit-custom-ip-allowed-list-rate-limiter-allowed-prefixes) below.
|
|
756
|
+
|
|
757
|
+
#### API Rate Limit Custom IP Allowed List Rate Limiter Allowed Prefixes
|
|
758
|
+
|
|
759
|
+
A [`rate_limiter_allowed_prefixes`](#api-rate-limit-custom-ip-allowed-list-rate-limiter-allowed-prefixes) block (within [`api_rate_limit.custom_ip_allowed_list`](#api-rate-limit-custom-ip-allowed-list)) supports the following:
|
|
760
|
+
|
|
761
|
+
<a id="api-rate-limit-custom-ip-allowed-list-rate-limiter-allowed-prefixes-name"></a>• [`name`](#api-rate-limit-custom-ip-allowed-list-rate-limiter-allowed-prefixes-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
|
|
762
|
+
|
|
763
|
+
<a id="api-rate-limit-custom-ip-allowed-list-rate-limiter-allowed-prefixes-namespace"></a>• [`namespace`](#api-rate-limit-custom-ip-allowed-list-rate-limiter-allowed-prefixes-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
|
|
764
|
+
|
|
765
|
+
<a id="api-rate-limit-custom-ip-allowed-list-rate-limiter-allowed-prefixes-tenant"></a>• [`tenant`](#api-rate-limit-custom-ip-allowed-list-rate-limiter-allowed-prefixes-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
|
|
766
|
+
|
|
767
|
+
#### API Rate Limit IP Allowed List
|
|
768
|
+
|
|
769
|
+
An [`ip_allowed_list`](#api-rate-limit-ip-allowed-list) block (within [`api_rate_limit`](#api-rate-limit)) supports the following:
|
|
770
|
+
|
|
771
|
+
<a id="api-rate-limit-ip-allowed-list-prefixes"></a>• [`prefixes`](#api-rate-limit-ip-allowed-list-prefixes) - Optional List<br>IPv4 Prefix List. List of IPv4 prefixes that represent an endpoint
|
|
772
|
+
|
|
773
|
+
#### API Rate Limit Server URL Rules
|
|
774
|
+
|
|
775
|
+
A [`server_url_rules`](#api-rate-limit-server-url-rules) block (within [`api_rate_limit`](#api-rate-limit)) supports the following:
|
|
776
|
+
|
|
777
|
+
<a id="api-rate-limit-server-url-rules-any-domain"></a>• [`any_domain`](#api-rate-limit-server-url-rules-any-domain) - Optional Block<br>Enable this option
|
|
778
|
+
|
|
779
|
+
<a id="api-rate-limit-server-url-rules-api-group"></a>• [`api_group`](#api-rate-limit-server-url-rules-api-group) - Optional String<br>API Group. API groups derived from API Definition swaggers. For example oas-all-operations including all paths and methods from the swaggers, oas-base-urls covering all requests under base-paths from the swaggers. Custom groups can be created if user tags paths or operations with 'x-volterra-API-group' extensions inside swaggers
|
|
780
|
+
|
|
781
|
+
<a id="api-rate-limit-server-url-rules-base-path"></a>• [`base_path`](#api-rate-limit-server-url-rules-base-path) - Optional String<br>Base Path. Prefix of the request path
|
|
782
|
+
|
|
783
|
+
<a id="api-rate-limit-server-url-rules-client-matcher"></a>• [`client_matcher`](#api-rate-limit-server-url-rules-client-matcher) - Optional Block<br>Client Matcher. Client conditions for matching a rule<br>See [Client Matcher](#api-rate-limit-server-url-rules-client-matcher) below.
|
|
784
|
+
|
|
785
|
+
<a id="api-rate-limit-server-url-rules-inline-rate-limiter"></a>• [`inline_rate_limiter`](#api-rate-limit-server-url-rules-inline-rate-limiter) - Optional Block<br>InlineRateLimiter<br>See [Inline Rate Limiter](#api-rate-limit-server-url-rules-inline-rate-limiter) below.
|
|
786
|
+
|
|
787
|
+
<a id="api-rate-limit-server-url-rules-ref-rate-limiter"></a>• [`ref_rate_limiter`](#api-rate-limit-server-url-rules-ref-rate-limiter) - 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 Rate Limiter](#api-rate-limit-server-url-rules-ref-rate-limiter) below.
|
|
788
|
+
|
|
789
|
+
<a id="api-rate-limit-server-url-rules-request-matcher"></a>• [`request_matcher`](#api-rate-limit-server-url-rules-request-matcher) - Optional Block<br>Request Matcher. Request conditions for matching a rule<br>See [Request Matcher](#api-rate-limit-server-url-rules-request-matcher) below.
|
|
790
|
+
|
|
791
|
+
<a id="api-rate-limit-server-url-rules-specific-domain"></a>• [`specific_domain`](#api-rate-limit-server-url-rules-specific-domain) - Optional String<br>Specific Domain. The rule will apply for a specific domain
|
|
792
|
+
|
|
793
|
+
#### API Rate Limit Server URL Rules Client Matcher
|
|
794
|
+
|
|
795
|
+
A [`client_matcher`](#api-rate-limit-server-url-rules-client-matcher) block (within [`api_rate_limit.server_url_rules`](#api-rate-limit-server-url-rules)) supports the following:
|
|
796
|
+
|
|
797
|
+
<a id="api-rate-limit-server-url-rules-client-matcher-any-client"></a>• [`any_client`](#api-rate-limit-server-url-rules-client-matcher-any-client) - Optional Block<br>Enable this option
|
|
798
|
+
|
|
799
|
+
<a id="api-rate-limit-server-url-rules-client-matcher-any-ip"></a>• [`any_ip`](#api-rate-limit-server-url-rules-client-matcher-any-ip) - Optional Block<br>Enable this option
|
|
800
|
+
|
|
801
|
+
<a id="api-rate-limit-server-url-rules-client-matcher-asn-list"></a>• [`asn_list`](#api-rate-limit-server-url-rules-client-matcher-asn-list) - 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](#api-rate-limit-server-url-rules-client-matcher-asn-list) below.
|
|
802
|
+
|
|
803
|
+
<a id="api-rate-limit-server-url-rules-client-matcher-asn-matcher"></a>• [`asn_matcher`](#api-rate-limit-server-url-rules-client-matcher-asn-matcher) - Optional Block<br>ASN Matcher. Match any AS number contained in the list of bgp_asn_sets<br>See [Asn Matcher](#api-rate-limit-server-url-rules-client-matcher-asn-matcher) below.
|
|
804
|
+
|
|
805
|
+
<a id="api-rate-limit-server-url-rules-client-matcher-client-selector"></a>• [`client_selector`](#api-rate-limit-server-url-rules-client-matcher-client-selector) - 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](#api-rate-limit-server-url-rules-client-matcher-client-selector) below.
|
|
806
|
+
|
|
807
|
+
<a id="api-rate-limit-server-url-rules-client-matcher-ip-matcher"></a>• [`ip_matcher`](#api-rate-limit-server-url-rules-client-matcher-ip-matcher) - 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](#api-rate-limit-server-url-rules-client-matcher-ip-matcher) below.
|
|
808
|
+
|
|
809
|
+
<a id="api-rate-limit-server-url-rules-client-matcher-ip-prefix-list"></a>• [`ip_prefix_list`](#api-rate-limit-server-url-rules-client-matcher-ip-prefix-list) - Optional Block<br>IP Prefix Match List. List of IP Prefix strings to match against<br>See [IP Prefix List](#api-rate-limit-server-url-rules-client-matcher-ip-prefix-list) below.
|
|
810
|
+
|
|
811
|
+
<a id="api-rate-limit-server-url-rules-client-matcher-ip-threat-category-list"></a>• [`ip_threat_category_list`](#api-rate-limit-server-url-rules-client-matcher-ip-threat-category-list) - Optional Block<br>IP Threat Category List Type. List of IP threat categories<br>See [IP Threat Category List](#api-rate-limit-server-url-rules-client-matcher-ip-threat-category-list) below.
|
|
812
|
+
|
|
813
|
+
<a id="api-rate-limit-server-url-rules-client-matcher-tls-fingerprint-matcher"></a>• [`tls_fingerprint_matcher`](#api-rate-limit-server-url-rules-client-matcher-tls-fingerprint-matcher) - 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](#api-rate-limit-server-url-rules-client-matcher-tls-fingerprint-matcher) below.
|
|
814
|
+
|
|
815
|
+
#### API Rate Limit Server URL Rules Client Matcher Asn List
|
|
816
|
+
|
|
817
|
+
An [`asn_list`](#api-rate-limit-server-url-rules-client-matcher-asn-list) block (within [`api_rate_limit.server_url_rules.client_matcher`](#api-rate-limit-server-url-rules-client-matcher)) supports the following:
|
|
818
|
+
|
|
819
|
+
<a id="api-rate-limit-server-url-rules-client-matcher-asn-list-as-numbers"></a>• [`as_numbers`](#api-rate-limit-server-url-rules-client-matcher-asn-list-as-numbers) - 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
|
|
820
|
+
|
|
821
|
+
#### API Rate Limit Server URL Rules Client Matcher Asn Matcher
|
|
822
|
+
|
|
823
|
+
An [`asn_matcher`](#api-rate-limit-server-url-rules-client-matcher-asn-matcher) block (within [`api_rate_limit.server_url_rules.client_matcher`](#api-rate-limit-server-url-rules-client-matcher)) supports the following:
|
|
824
|
+
|
|
825
|
+
<a id="api-rate-limit-server-url-rules-client-matcher-asn-matcher-asn-sets"></a>• [`asn_sets`](#api-rate-limit-server-url-rules-client-matcher-asn-matcher-asn-sets) - Optional Block<br>BGP ASN Sets. A list of references to bgp_asn_set objects<br>See [Asn Sets](#api-rate-limit-server-url-rules-client-matcher-asn-matcher-asn-sets) below.
|
|
826
|
+
|
|
827
|
+
#### API Rate Limit Server URL Rules Client Matcher Asn Matcher Asn Sets
|
|
828
|
+
|
|
829
|
+
An [`asn_sets`](#api-rate-limit-server-url-rules-client-matcher-asn-matcher-asn-sets) block (within [`api_rate_limit.server_url_rules.client_matcher.asn_matcher`](#api-rate-limit-server-url-rules-client-matcher-asn-matcher)) supports the following:
|
|
830
|
+
|
|
831
|
+
<a id="api-rate-limit-server-url-rules-client-matcher-asn-matcher-asn-sets-kind"></a>• [`kind`](#api-rate-limit-server-url-rules-client-matcher-asn-matcher-asn-sets-kind) - 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="api-rate-limit-server-url-rules-client-matcher-asn-matcher-asn-sets-name"></a>• [`name`](#api-rate-limit-server-url-rules-client-matcher-asn-matcher-asn-sets-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
|
|
834
|
+
|
|
835
|
+
<a id="api-rate-limit-server-url-rules-client-matcher-asn-matcher-asn-sets-namespace"></a>• [`namespace`](#api-rate-limit-server-url-rules-client-matcher-asn-matcher-asn-sets-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
|
|
836
|
+
|
|
837
|
+
<a id="api-rate-limit-server-url-rules-client-matcher-asn-matcher-asn-sets-tenant"></a>• [`tenant`](#api-rate-limit-server-url-rules-client-matcher-asn-matcher-asn-sets-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
|
|
838
|
+
|
|
839
|
+
<a id="api-rate-limit-server-url-rules-client-matcher-asn-matcher-asn-sets-uid"></a>• [`uid`](#api-rate-limit-server-url-rules-client-matcher-asn-matcher-asn-sets-uid) - 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
|
|
840
|
+
|
|
841
|
+
#### API Rate Limit Server URL Rules Client Matcher Client Selector
|
|
842
|
+
|
|
843
|
+
A [`client_selector`](#api-rate-limit-server-url-rules-client-matcher-client-selector) block (within [`api_rate_limit.server_url_rules.client_matcher`](#api-rate-limit-server-url-rules-client-matcher)) supports the following:
|
|
844
|
+
|
|
845
|
+
<a id="api-rate-limit-server-url-rules-client-matcher-client-selector-expressions"></a>• [`expressions`](#api-rate-limit-server-url-rules-client-matcher-client-selector-expressions) - Optional List<br>Selector Expression. expressions contains the kubernetes style label expression for selections
|
|
846
|
+
|
|
847
|
+
#### API Rate Limit Server URL Rules Client Matcher IP Matcher
|
|
848
|
+
|
|
849
|
+
An [`ip_matcher`](#api-rate-limit-server-url-rules-client-matcher-ip-matcher) block (within [`api_rate_limit.server_url_rules.client_matcher`](#api-rate-limit-server-url-rules-client-matcher)) supports the following:
|
|
850
|
+
|
|
851
|
+
<a id="api-rate-limit-server-url-rules-client-matcher-ip-matcher-invert-matcher"></a>• [`invert_matcher`](#api-rate-limit-server-url-rules-client-matcher-ip-matcher-invert-matcher) - Optional Bool<br>Invert IP Matcher. Invert the match result
|
|
852
|
+
|
|
853
|
+
<a id="api-rate-limit-server-url-rules-client-matcher-ip-matcher-prefix-sets"></a>• [`prefix_sets`](#api-rate-limit-server-url-rules-client-matcher-ip-matcher-prefix-sets) - Optional Block<br>IP Prefix Sets. A list of references to ip_prefix_set objects<br>See [Prefix Sets](#api-rate-limit-server-url-rules-client-matcher-ip-matcher-prefix-sets) below.
|
|
854
|
+
|
|
855
|
+
#### API Rate Limit Server URL Rules Client Matcher IP Matcher Prefix Sets
|
|
856
|
+
|
|
857
|
+
A [`prefix_sets`](#api-rate-limit-server-url-rules-client-matcher-ip-matcher-prefix-sets) block (within [`api_rate_limit.server_url_rules.client_matcher.ip_matcher`](#api-rate-limit-server-url-rules-client-matcher-ip-matcher)) supports the following:
|
|
858
|
+
|
|
859
|
+
<a id="api-rate-limit-server-url-rules-client-matcher-ip-matcher-prefix-sets-kind"></a>• [`kind`](#api-rate-limit-server-url-rules-client-matcher-ip-matcher-prefix-sets-kind) - 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="api-rate-limit-server-url-rules-client-matcher-ip-matcher-prefix-sets-name"></a>• [`name`](#api-rate-limit-server-url-rules-client-matcher-ip-matcher-prefix-sets-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
|
|
862
|
+
|
|
863
|
+
<a id="api-rate-limit-server-url-rules-client-matcher-ip-matcher-prefix-sets-namespace"></a>• [`namespace`](#api-rate-limit-server-url-rules-client-matcher-ip-matcher-prefix-sets-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
|
|
864
|
+
|
|
865
|
+
<a id="api-rate-limit-server-url-rules-client-matcher-ip-matcher-prefix-sets-tenant"></a>• [`tenant`](#api-rate-limit-server-url-rules-client-matcher-ip-matcher-prefix-sets-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
|
|
866
|
+
|
|
867
|
+
<a id="api-rate-limit-server-url-rules-client-matcher-ip-matcher-prefix-sets-uid"></a>• [`uid`](#api-rate-limit-server-url-rules-client-matcher-ip-matcher-prefix-sets-uid) - 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
|
|
868
|
+
|
|
869
|
+
#### API Rate Limit Server URL Rules Client Matcher IP Prefix List
|
|
870
|
+
|
|
871
|
+
An [`ip_prefix_list`](#api-rate-limit-server-url-rules-client-matcher-ip-prefix-list) block (within [`api_rate_limit.server_url_rules.client_matcher`](#api-rate-limit-server-url-rules-client-matcher)) supports the following:
|
|
872
|
+
|
|
873
|
+
<a id="api-rate-limit-server-url-rules-client-matcher-ip-prefix-list-invert-match"></a>• [`invert_match`](#api-rate-limit-server-url-rules-client-matcher-ip-prefix-list-invert-match) - Optional Bool<br>Invert Match Result. Invert the match result
|
|
874
|
+
|
|
875
|
+
<a id="api-rate-limit-server-url-rules-client-matcher-ip-prefix-list-ip-prefixes"></a>• [`ip_prefixes`](#api-rate-limit-server-url-rules-client-matcher-ip-prefix-list-ip-prefixes) - Optional List<br>IPv4 Prefix List. List of IPv4 prefix strings
|
|
876
|
+
|
|
877
|
+
#### API Rate Limit Server URL Rules Client Matcher IP Threat Category List
|
|
878
|
+
|
|
879
|
+
An [`ip_threat_category_list`](#api-rate-limit-server-url-rules-client-matcher-ip-threat-category-list) block (within [`api_rate_limit.server_url_rules.client_matcher`](#api-rate-limit-server-url-rules-client-matcher)) supports the following:
|
|
880
|
+
|
|
881
|
+
<a id="api-rate-limit-server-url-rules-client-matcher-ip-threat-category-list-ip-threat-categories"></a>• [`ip_threat_categories`](#api-rate-limit-server-url-rules-client-matcher-ip-threat-category-list-ip-threat-categories) - 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
|
|
882
|
+
|
|
883
|
+
#### API Rate Limit Server URL Rules Client Matcher TLS Fingerprint Matcher
|
|
884
|
+
|
|
885
|
+
A [`tls_fingerprint_matcher`](#api-rate-limit-server-url-rules-client-matcher-tls-fingerprint-matcher) block (within [`api_rate_limit.server_url_rules.client_matcher`](#api-rate-limit-server-url-rules-client-matcher)) supports the following:
|
|
886
|
+
|
|
887
|
+
<a id="api-rate-limit-server-url-rules-client-matcher-tls-fingerprint-matcher-classes"></a>• [`classes`](#api-rate-limit-server-url-rules-client-matcher-tls-fingerprint-matcher-classes) - 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="api-rate-limit-server-url-rules-client-matcher-tls-fingerprint-matcher-exact-values"></a>• [`exact_values`](#api-rate-limit-server-url-rules-client-matcher-tls-fingerprint-matcher-exact-values) - Optional List<br>Exact Values. A list of exact TLS JA3 fingerprints to match the input TLS JA3 fingerprint against
|
|
890
|
+
|
|
891
|
+
<a id="api-rate-limit-server-url-rules-client-matcher-tls-fingerprint-matcher-excluded-values"></a>• [`excluded_values`](#api-rate-limit-server-url-rules-client-matcher-tls-fingerprint-matcher-excluded-values) - 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
|
|
892
|
+
|
|
893
|
+
#### API Rate Limit Server URL Rules Inline Rate Limiter
|
|
894
|
+
|
|
895
|
+
An [`inline_rate_limiter`](#api-rate-limit-server-url-rules-inline-rate-limiter) block (within [`api_rate_limit.server_url_rules`](#api-rate-limit-server-url-rules)) supports the following:
|
|
896
|
+
|
|
897
|
+
<a id="api-rate-limit-server-url-rules-inline-rate-limiter-ref-user-id"></a>• [`ref_user_id`](#api-rate-limit-server-url-rules-inline-rate-limiter-ref-user-id) - 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](#api-rate-limit-server-url-rules-inline-rate-limiter-ref-user-id) below.
|
|
898
|
+
|
|
899
|
+
<a id="api-rate-limit-server-url-rules-inline-rate-limiter-threshold"></a>• [`threshold`](#api-rate-limit-server-url-rules-inline-rate-limiter-threshold) - 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="api-rate-limit-server-url-rules-inline-rate-limiter-unit"></a>• [`unit`](#api-rate-limit-server-url-rules-inline-rate-limiter-unit) - 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="api-rate-limit-server-url-rules-inline-rate-limiter-use-http-lb-user-id"></a>• [`use_http_lb_user_id`](#api-rate-limit-server-url-rules-inline-rate-limiter-use-http-lb-user-id) - Optional Block<br>Enable this option
|
|
904
|
+
|
|
905
|
+
#### API Rate Limit Server URL Rules Inline Rate Limiter Ref User ID
|
|
906
|
+
|
|
907
|
+
A [`ref_user_id`](#api-rate-limit-server-url-rules-inline-rate-limiter-ref-user-id) block (within [`api_rate_limit.server_url_rules.inline_rate_limiter`](#api-rate-limit-server-url-rules-inline-rate-limiter)) supports the following:
|
|
908
|
+
|
|
909
|
+
<a id="api-rate-limit-server-url-rules-inline-rate-limiter-ref-user-id-name"></a>• [`name`](#api-rate-limit-server-url-rules-inline-rate-limiter-ref-user-id-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
|
|
910
|
+
|
|
911
|
+
<a id="api-rate-limit-server-url-rules-inline-rate-limiter-ref-user-id-namespace"></a>• [`namespace`](#api-rate-limit-server-url-rules-inline-rate-limiter-ref-user-id-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
|
|
912
|
+
|
|
913
|
+
<a id="api-rate-limit-server-url-rules-inline-rate-limiter-ref-user-id-tenant"></a>• [`tenant`](#api-rate-limit-server-url-rules-inline-rate-limiter-ref-user-id-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
|
|
914
|
+
|
|
915
|
+
#### API Rate Limit Server URL Rules Ref Rate Limiter
|
|
916
|
+
|
|
917
|
+
A [`ref_rate_limiter`](#api-rate-limit-server-url-rules-ref-rate-limiter) block (within [`api_rate_limit.server_url_rules`](#api-rate-limit-server-url-rules)) supports the following:
|
|
918
|
+
|
|
919
|
+
<a id="api-rate-limit-server-url-rules-ref-rate-limiter-name"></a>• [`name`](#api-rate-limit-server-url-rules-ref-rate-limiter-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
|
|
920
|
+
|
|
921
|
+
<a id="api-rate-limit-server-url-rules-ref-rate-limiter-namespace"></a>• [`namespace`](#api-rate-limit-server-url-rules-ref-rate-limiter-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
|
|
922
|
+
|
|
923
|
+
<a id="api-rate-limit-server-url-rules-ref-rate-limiter-tenant"></a>• [`tenant`](#api-rate-limit-server-url-rules-ref-rate-limiter-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
|
|
924
|
+
|
|
925
|
+
#### API Rate Limit Server URL Rules Request Matcher
|
|
926
|
+
|
|
927
|
+
A [`request_matcher`](#api-rate-limit-server-url-rules-request-matcher) block (within [`api_rate_limit.server_url_rules`](#api-rate-limit-server-url-rules)) supports the following:
|
|
928
|
+
|
|
929
|
+
<a id="api-rate-limit-server-url-rules-request-matcher-cookie-matchers"></a>• [`cookie_matchers`](#api-rate-limit-server-url-rules-request-matcher-cookie-matchers) - 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](#api-rate-limit-server-url-rules-request-matcher-cookie-matchers) below.
|
|
930
|
+
|
|
931
|
+
<a id="api-rate-limit-server-url-rules-request-matcher-headers"></a>• [`headers`](#api-rate-limit-server-url-rules-request-matcher-headers) - 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](#api-rate-limit-server-url-rules-request-matcher-headers) below.
|
|
932
|
+
|
|
933
|
+
<a id="api-rate-limit-server-url-rules-request-matcher-jwt-claims"></a>• [`jwt_claims`](#api-rate-limit-server-url-rules-request-matcher-jwt-claims) - 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](#api-rate-limit-server-url-rules-request-matcher-jwt-claims) below.
|
|
934
|
+
|
|
935
|
+
<a id="api-rate-limit-server-url-rules-request-matcher-query-params"></a>• [`query_params`](#api-rate-limit-server-url-rules-request-matcher-query-params) - 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](#api-rate-limit-server-url-rules-request-matcher-query-params) below.
|
|
936
|
+
|
|
937
|
+
#### API Rate Limit Server URL Rules Request Matcher Cookie Matchers
|
|
938
|
+
|
|
939
|
+
A [`cookie_matchers`](#api-rate-limit-server-url-rules-request-matcher-cookie-matchers) block (within [`api_rate_limit.server_url_rules.request_matcher`](#api-rate-limit-server-url-rules-request-matcher)) supports the following:
|
|
940
|
+
|
|
941
|
+
<a id="api-rate-limit-server-url-rules-request-matcher-cookie-matchers-check-not-present"></a>• [`check_not_present`](#api-rate-limit-server-url-rules-request-matcher-cookie-matchers-check-not-present) - Optional Block<br>Enable this option
|
|
942
|
+
|
|
943
|
+
<a id="api-rate-limit-server-url-rules-request-matcher-cookie-matchers-check-present"></a>• [`check_present`](#api-rate-limit-server-url-rules-request-matcher-cookie-matchers-check-present) - Optional Block<br>Enable this option
|
|
944
|
+
|
|
945
|
+
<a id="api-rate-limit-server-url-rules-request-matcher-cookie-matchers-invert-matcher"></a>• [`invert_matcher`](#api-rate-limit-server-url-rules-request-matcher-cookie-matchers-invert-matcher) - Optional Bool<br>Invert Matcher. Invert Match of the expression defined
|
|
946
|
+
|
|
947
|
+
<a id="api-rate-limit-server-url-rules-request-matcher-cookie-matchers-item"></a>• [`item`](#api-rate-limit-server-url-rules-request-matcher-cookie-matchers-item) - 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](#api-rate-limit-server-url-rules-request-matcher-cookie-matchers-item) below.
|
|
948
|
+
|
|
949
|
+
<a id="api-rate-limit-server-url-rules-request-matcher-cookie-matchers-name"></a>• [`name`](#api-rate-limit-server-url-rules-request-matcher-cookie-matchers-name) - Optional String<br>Cookie Name. A case-sensitive cookie name
|
|
950
|
+
|
|
951
|
+
#### API Rate Limit Server URL Rules Request Matcher Cookie Matchers Item
|
|
952
|
+
|
|
953
|
+
An [`item`](#api-rate-limit-server-url-rules-request-matcher-cookie-matchers-item) block (within [`api_rate_limit.server_url_rules.request_matcher.cookie_matchers`](#api-rate-limit-server-url-rules-request-matcher-cookie-matchers)) supports the following:
|
|
954
|
+
|
|
955
|
+
<a id="api-rate-limit-server-url-rules-request-matcher-cookie-matchers-item-exact-values"></a>• [`exact_values`](#api-rate-limit-server-url-rules-request-matcher-cookie-matchers-item-exact-values) - Optional List<br>Exact Values. A list of exact values to match the input against
|
|
956
|
+
|
|
957
|
+
<a id="api-rate-limit-server-url-rules-request-matcher-cookie-matchers-item-regex-values"></a>• [`regex_values`](#api-rate-limit-server-url-rules-request-matcher-cookie-matchers-item-regex-values) - Optional List<br>Regex Values. A list of regular expressions to match the input against
|
|
958
|
+
|
|
959
|
+
<a id="api-rate-limit-server-url-rules-request-matcher-cookie-matchers-item-transformers"></a>• [`transformers`](#api-rate-limit-server-url-rules-request-matcher-cookie-matchers-item-transformers) - 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
|
|
960
|
+
|
|
961
|
+
#### API Rate Limit Server URL Rules Request Matcher Headers
|
|
962
|
+
|
|
963
|
+
A [`headers`](#api-rate-limit-server-url-rules-request-matcher-headers) block (within [`api_rate_limit.server_url_rules.request_matcher`](#api-rate-limit-server-url-rules-request-matcher)) supports the following:
|
|
964
|
+
|
|
965
|
+
<a id="api-rate-limit-server-url-rules-request-matcher-headers-check-not-present"></a>• [`check_not_present`](#api-rate-limit-server-url-rules-request-matcher-headers-check-not-present) - Optional Block<br>Enable this option
|
|
966
|
+
|
|
967
|
+
<a id="api-rate-limit-server-url-rules-request-matcher-headers-check-present"></a>• [`check_present`](#api-rate-limit-server-url-rules-request-matcher-headers-check-present) - Optional Block<br>Enable this option
|
|
968
|
+
|
|
969
|
+
<a id="api-rate-limit-server-url-rules-request-matcher-headers-invert-matcher"></a>• [`invert_matcher`](#api-rate-limit-server-url-rules-request-matcher-headers-invert-matcher) - Optional Bool<br>Invert Header Matcher. Invert the match result
|
|
970
|
+
|
|
971
|
+
<a id="api-rate-limit-server-url-rules-request-matcher-headers-item"></a>• [`item`](#api-rate-limit-server-url-rules-request-matcher-headers-item) - 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](#api-rate-limit-server-url-rules-request-matcher-headers-item) below.
|
|
972
|
+
|
|
973
|
+
<a id="api-rate-limit-server-url-rules-request-matcher-headers-name"></a>• [`name`](#api-rate-limit-server-url-rules-request-matcher-headers-name) - Optional String<br>Header Name. A case-insensitive HTTP header name
|
|
974
|
+
|
|
975
|
+
#### API Rate Limit Server URL Rules Request Matcher Headers Item
|
|
976
|
+
|
|
977
|
+
An [`item`](#api-rate-limit-server-url-rules-request-matcher-headers-item) block (within [`api_rate_limit.server_url_rules.request_matcher.headers`](#api-rate-limit-server-url-rules-request-matcher-headers)) supports the following:
|
|
978
|
+
|
|
979
|
+
<a id="api-rate-limit-server-url-rules-request-matcher-headers-item-exact-values"></a>• [`exact_values`](#api-rate-limit-server-url-rules-request-matcher-headers-item-exact-values) - Optional List<br>Exact Values. A list of exact values to match the input against
|
|
980
|
+
|
|
981
|
+
<a id="api-rate-limit-server-url-rules-request-matcher-headers-item-regex-values"></a>• [`regex_values`](#api-rate-limit-server-url-rules-request-matcher-headers-item-regex-values) - Optional List<br>Regex Values. A list of regular expressions to match the input against
|
|
982
|
+
|
|
983
|
+
<a id="api-rate-limit-server-url-rules-request-matcher-headers-item-transformers"></a>• [`transformers`](#api-rate-limit-server-url-rules-request-matcher-headers-item-transformers) - 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
|
|
984
|
+
|
|
985
|
+
#### API Rate Limit Server URL Rules Request Matcher JWT Claims
|
|
986
|
+
|
|
987
|
+
A [`jwt_claims`](#api-rate-limit-server-url-rules-request-matcher-jwt-claims) block (within [`api_rate_limit.server_url_rules.request_matcher`](#api-rate-limit-server-url-rules-request-matcher)) supports the following:
|
|
988
|
+
|
|
989
|
+
<a id="api-rate-limit-server-url-rules-request-matcher-jwt-claims-check-not-present"></a>• [`check_not_present`](#api-rate-limit-server-url-rules-request-matcher-jwt-claims-check-not-present) - Optional Block<br>Enable this option
|
|
990
|
+
|
|
991
|
+
<a id="api-rate-limit-server-url-rules-request-matcher-jwt-claims-check-present"></a>• [`check_present`](#api-rate-limit-server-url-rules-request-matcher-jwt-claims-check-present) - Optional Block<br>Enable this option
|
|
992
|
+
|
|
993
|
+
<a id="api-rate-limit-server-url-rules-request-matcher-jwt-claims-invert-matcher"></a>• [`invert_matcher`](#api-rate-limit-server-url-rules-request-matcher-jwt-claims-invert-matcher) - Optional Bool<br>Invert Matcher. Invert the match result
|
|
994
|
+
|
|
995
|
+
<a id="api-rate-limit-server-url-rules-request-matcher-jwt-claims-item"></a>• [`item`](#api-rate-limit-server-url-rules-request-matcher-jwt-claims-item) - 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](#api-rate-limit-server-url-rules-request-matcher-jwt-claims-item) below.
|
|
996
|
+
|
|
997
|
+
<a id="api-rate-limit-server-url-rules-request-matcher-jwt-claims-name"></a>• [`name`](#api-rate-limit-server-url-rules-request-matcher-jwt-claims-name) - Optional String<br>JWT Claim Name. JWT claim name
|
|
998
|
+
|
|
999
|
+
#### API Rate Limit Server URL Rules Request Matcher JWT Claims Item
|
|
1000
|
+
|
|
1001
|
+
An [`item`](#api-rate-limit-server-url-rules-request-matcher-jwt-claims-item) block (within [`api_rate_limit.server_url_rules.request_matcher.jwt_claims`](#api-rate-limit-server-url-rules-request-matcher-jwt-claims)) supports the following:
|
|
1002
|
+
|
|
1003
|
+
<a id="api-rate-limit-server-url-rules-request-matcher-jwt-claims-item-exact-values"></a>• [`exact_values`](#api-rate-limit-server-url-rules-request-matcher-jwt-claims-item-exact-values) - Optional List<br>Exact Values. A list of exact values to match the input against
|
|
1004
|
+
|
|
1005
|
+
<a id="api-rate-limit-server-url-rules-request-matcher-jwt-claims-item-regex-values"></a>• [`regex_values`](#api-rate-limit-server-url-rules-request-matcher-jwt-claims-item-regex-values) - Optional List<br>Regex Values. A list of regular expressions to match the input against
|
|
1006
|
+
|
|
1007
|
+
<a id="api-rate-limit-server-url-rules-request-matcher-jwt-claims-item-transformers"></a>• [`transformers`](#api-rate-limit-server-url-rules-request-matcher-jwt-claims-item-transformers) - 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
|
|
1008
|
+
|
|
1009
|
+
#### API Rate Limit Server URL Rules Request Matcher Query Params
|
|
1010
|
+
|
|
1011
|
+
A [`query_params`](#api-rate-limit-server-url-rules-request-matcher-query-params) block (within [`api_rate_limit.server_url_rules.request_matcher`](#api-rate-limit-server-url-rules-request-matcher)) supports the following:
|
|
1012
|
+
|
|
1013
|
+
<a id="api-rate-limit-server-url-rules-request-matcher-query-params-check-not-present"></a>• [`check_not_present`](#api-rate-limit-server-url-rules-request-matcher-query-params-check-not-present) - Optional Block<br>Enable this option
|
|
1014
|
+
|
|
1015
|
+
<a id="api-rate-limit-server-url-rules-request-matcher-query-params-check-present"></a>• [`check_present`](#api-rate-limit-server-url-rules-request-matcher-query-params-check-present) - Optional Block<br>Enable this option
|
|
1016
|
+
|
|
1017
|
+
<a id="api-rate-limit-server-url-rules-request-matcher-query-params-invert-matcher"></a>• [`invert_matcher`](#api-rate-limit-server-url-rules-request-matcher-query-params-invert-matcher) - Optional Bool<br>Invert Query Parameter Matcher. Invert the match result
|
|
1018
|
+
|
|
1019
|
+
<a id="api-rate-limit-server-url-rules-request-matcher-query-params-item"></a>• [`item`](#api-rate-limit-server-url-rules-request-matcher-query-params-item) - 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](#api-rate-limit-server-url-rules-request-matcher-query-params-item) below.
|
|
1020
|
+
|
|
1021
|
+
<a id="api-rate-limit-server-url-rules-request-matcher-query-params-key"></a>• [`key`](#api-rate-limit-server-url-rules-request-matcher-query-params-key) - Optional String<br>Query Parameter Name. A case-sensitive HTTP query parameter name
|
|
1022
|
+
|
|
1023
|
+
#### API Rate Limit Server URL Rules Request Matcher Query Params Item
|
|
1024
|
+
|
|
1025
|
+
An [`item`](#api-rate-limit-server-url-rules-request-matcher-query-params-item) block (within [`api_rate_limit.server_url_rules.request_matcher.query_params`](#api-rate-limit-server-url-rules-request-matcher-query-params)) supports the following:
|
|
1026
|
+
|
|
1027
|
+
<a id="api-rate-limit-server-url-rules-request-matcher-query-params-item-exact-values"></a>• [`exact_values`](#api-rate-limit-server-url-rules-request-matcher-query-params-item-exact-values) - Optional List<br>Exact Values. A list of exact values to match the input against
|
|
1028
|
+
|
|
1029
|
+
<a id="api-rate-limit-server-url-rules-request-matcher-query-params-item-regex-values"></a>• [`regex_values`](#api-rate-limit-server-url-rules-request-matcher-query-params-item-regex-values) - Optional List<br>Regex Values. A list of regular expressions to match the input against
|
|
1030
|
+
|
|
1031
|
+
<a id="api-rate-limit-server-url-rules-request-matcher-query-params-item-transformers"></a>• [`transformers`](#api-rate-limit-server-url-rules-request-matcher-query-params-item-transformers) - 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
|
|
1032
|
+
|
|
1033
|
+
#### API Specification
|
|
1034
|
+
|
|
1035
|
+
An [`api_specification`](#api-specification) block supports the following:
|
|
1036
|
+
|
|
1037
|
+
<a id="api-specification-api-definition"></a>• [`api_definition`](#api-specification-api-definition) - 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 [API Definition](#api-specification-api-definition) below.
|
|
1038
|
+
|
|
1039
|
+
<a id="api-specification-validation-all-spec-endpoints"></a>• [`validation_all_spec_endpoints`](#api-specification-validation-all-spec-endpoints) - Optional Block<br>API Inventory. Settings for API Inventory validation<br>See [Validation All Spec Endpoints](#api-specification-validation-all-spec-endpoints) below.
|
|
1040
|
+
|
|
1041
|
+
<a id="api-specification-validation-custom-list"></a>• [`validation_custom_list`](#api-specification-validation-custom-list) - Optional Block<br>Custom List. Define API groups, base paths, or API endpoints and their OpenAPI validation modes. Any other API-endpoint not listed will act according to 'Fall Through Mode'<br>See [Validation Custom List](#api-specification-validation-custom-list) below.
|
|
1042
|
+
|
|
1043
|
+
<a id="api-specification-validation-disabled"></a>• [`validation_disabled`](#api-specification-validation-disabled) - Optional Block<br>Enable this option
|
|
1044
|
+
|
|
1045
|
+
#### API Specification API Definition
|
|
1046
|
+
|
|
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>• [`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="api-specification-api-definition-namespace"></a>• [`namespace`](#api-specification-api-definition-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
|
|
1052
|
+
|
|
1053
|
+
<a id="api-specification-api-definition-tenant"></a>• [`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
|
|
1054
|
+
|
|
1055
|
+
#### API Specification Validation All Spec Endpoints
|
|
1056
|
+
|
|
1057
|
+
A [`validation_all_spec_endpoints`](#api-specification-validation-all-spec-endpoints) block (within [`api_specification`](#api-specification)) supports the following:
|
|
1058
|
+
|
|
1059
|
+
<a id="api-specification-validation-all-spec-endpoints-fall-through-mode"></a>• [`fall_through_mode`](#api-specification-validation-all-spec-endpoints-fall-through-mode) - Optional Block<br>Fall Through Mode.Determine what to do with unprotected endpoints (not in the OpenAPI specification file (a.k.a. swagger) or doesn't have a specific rule in custom rules)<br>See [Fall Through Mode](#api-specification-validation-all-spec-endpoints-fall-through-mode) below.
|
|
1060
|
+
|
|
1061
|
+
<a id="api-specification-validation-all-spec-endpoints-settings"></a>• [`settings`](#api-specification-validation-all-spec-endpoints-settings) - Optional Block<br>Common Settings. OpenAPI specification validation settings relevant for 'API Inventory' enforcement and for 'Custom list' enforcement<br>See [Settings](#api-specification-validation-all-spec-endpoints-settings) below.
|
|
1062
|
+
|
|
1063
|
+
<a id="api-specification-validation-all-spec-endpoints-validation-mode"></a>• [`validation_mode`](#api-specification-validation-all-spec-endpoints-validation-mode) - 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](#api-specification-validation-all-spec-endpoints-validation-mode) below.
|
|
1064
|
+
|
|
1065
|
+
#### API Specification Validation All Spec Endpoints Fall Through Mode
|
|
1066
|
+
|
|
1067
|
+
A [`fall_through_mode`](#api-specification-validation-all-spec-endpoints-fall-through-mode) block (within [`api_specification.validation_all_spec_endpoints`](#api-specification-validation-all-spec-endpoints)) supports the following:
|
|
1068
|
+
|
|
1069
|
+
<a id="api-specification-validation-all-spec-endpoints-fall-through-mode-fall-through-mode-allow"></a>• [`fall_through_mode_allow`](#api-specification-validation-all-spec-endpoints-fall-through-mode-fall-through-mode-allow) - Optional Block<br>Enable this option
|
|
1070
|
+
|
|
1071
|
+
<a id="api-specification-validation-all-spec-endpoints-fall-through-mode-fall-through-mode-custom"></a>• [`fall_through_mode_custom`](#api-specification-validation-all-spec-endpoints-fall-through-mode-fall-through-mode-custom) - Optional Block<br>Custom Fall Through Mode. Define the fall through settings<br>See [Fall Through Mode Custom](#api-specification-validation-all-spec-endpoints-fall-through-mode-fall-through-mode-custom) below.
|
|
1072
|
+
|
|
1073
|
+
#### API Specification Validation All Spec Endpoints Fall Through Mode Fall Through Mode Custom
|
|
1074
|
+
|
|
1075
|
+
A [`fall_through_mode_custom`](#api-specification-validation-all-spec-endpoints-fall-through-mode-fall-through-mode-custom) block (within [`api_specification.validation_all_spec_endpoints.fall_through_mode`](#api-specification-validation-all-spec-endpoints-fall-through-mode)) supports the following:
|
|
1076
|
+
|
|
1077
|
+
<a id="api-specification-validation-all-spec-endpoints-fall-through-mode-fall-through-mode-custom-open-api-validation-rules"></a>• [`open_api_validation_rules`](#api-specification-validation-all-spec-endpoints-fall-through-mode-fall-through-mode-custom-open-api-validation-rules) - Optional Block<br>Custom Fall Through Rule List<br>See [Open API Validation Rules](#api-specification-validation-all-spec-endpoints-fall-through-mode-fall-through-mode-custom-open-api-validation-rules) below.
|
|
1078
|
+
|
|
1079
|
+
#### API Specification Validation All Spec Endpoints Fall Through Mode Fall Through Mode Custom Open API Validation Rules
|
|
1080
|
+
|
|
1081
|
+
An [`open_api_validation_rules`](#api-specification-validation-all-spec-endpoints-fall-through-mode-fall-through-mode-custom-open-api-validation-rules) block (within [`api_specification.validation_all_spec_endpoints.fall_through_mode.fall_through_mode_custom`](#api-specification-validation-all-spec-endpoints-fall-through-mode-fall-through-mode-custom)) supports the following:
|
|
1082
|
+
|
|
1083
|
+
<a id="api-specification-validation-all-spec-endpoints-fall-through-mode-fall-through-mode-custom-open-api-validation-rules-action-block"></a>• [`action_block`](#api-specification-validation-all-spec-endpoints-fall-through-mode-fall-through-mode-custom-open-api-validation-rules-action-block) - Optional Block<br>Enable this option
|
|
1084
|
+
|
|
1085
|
+
<a id="api-specification-validation-all-spec-endpoints-fall-through-mode-fall-through-mode-custom-open-api-validation-rules-action-report"></a>• [`action_report`](#api-specification-validation-all-spec-endpoints-fall-through-mode-fall-through-mode-custom-open-api-validation-rules-action-report) - Optional Block<br>Enable this option
|
|
1086
|
+
|
|
1087
|
+
<a id="api-specification-validation-all-spec-endpoints-fall-through-mode-fall-through-mode-custom-open-api-validation-rules-action-skip"></a>• [`action_skip`](#api-specification-validation-all-spec-endpoints-fall-through-mode-fall-through-mode-custom-open-api-validation-rules-action-skip) - Optional Block<br>Enable this option
|
|
1088
|
+
|
|
1089
|
+
<a id="api-specification-validation-all-spec-endpoints-fall-through-mode-fall-through-mode-custom-open-api-validation-rules-api-endpoint"></a>• [`api_endpoint`](#api-specification-validation-all-spec-endpoints-fall-through-mode-fall-through-mode-custom-open-api-validation-rules-api-endpoint) - Optional Block<br>API Endpoint. This defines API endpoint<br>See [API Endpoint](#api-specification-validation-all-spec-endpoints-fall-through-mode-fall-through-mode-custom-open-api-validation-rules-api-endpoint) below.
|
|
1090
|
+
|
|
1091
|
+
<a id="api-specification-validation-all-spec-endpoints-fall-through-mode-fall-through-mode-custom-open-api-validation-rules-api-group"></a>• [`api_group`](#api-specification-validation-all-spec-endpoints-fall-through-mode-fall-through-mode-custom-open-api-validation-rules-api-group) - Optional String<br>API Group. The API group which this validation applies to
|
|
1092
|
+
|
|
1093
|
+
<a id="api-specification-validation-all-spec-endpoints-fall-through-mode-fall-through-mode-custom-open-api-validation-rules-base-path"></a>• [`base_path`](#api-specification-validation-all-spec-endpoints-fall-through-mode-fall-through-mode-custom-open-api-validation-rules-base-path) - Optional String<br>Base Path. The base path which this validation applies to
|
|
1094
|
+
|
|
1095
|
+
<a id="api-specification-validation-all-spec-endpoints-fall-through-mode-fall-through-mode-custom-open-api-validation-rules-metadata"></a>• [`metadata`](#api-specification-validation-all-spec-endpoints-fall-through-mode-fall-through-mode-custom-open-api-validation-rules-metadata) - 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](#api-specification-validation-all-spec-endpoints-fall-through-mode-fall-through-mode-custom-open-api-validation-rules-metadata) below.
|
|
1096
|
+
|
|
1097
|
+
#### API Specification Validation All Spec Endpoints Fall Through Mode Fall Through Mode Custom Open API Validation Rules API Endpoint
|
|
1098
|
+
|
|
1099
|
+
An [`api_endpoint`](#api-specification-validation-all-spec-endpoints-fall-through-mode-fall-through-mode-custom-open-api-validation-rules-api-endpoint) block (within [`api_specification.validation_all_spec_endpoints.fall_through_mode.fall_through_mode_custom.open_api_validation_rules`](#api-specification-validation-all-spec-endpoints-fall-through-mode-fall-through-mode-custom-open-api-validation-rules)) supports the following:
|
|
1100
|
+
|
|
1101
|
+
<a id="api-specification-validation-all-spec-endpoints-fall-through-mode-fall-through-mode-custom-open-api-validation-rules-api-endpoint-methods"></a>• [`methods`](#api-specification-validation-all-spec-endpoints-fall-through-mode-fall-through-mode-custom-open-api-validation-rules-api-endpoint-methods) - 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="api-specification-validation-all-spec-endpoints-fall-through-mode-fall-through-mode-custom-open-api-validation-rules-api-endpoint-path"></a>• [`path`](#api-specification-validation-all-spec-endpoints-fall-through-mode-fall-through-mode-custom-open-api-validation-rules-api-endpoint-path) - Optional String<br>Path. Path to be matched
|
|
1104
|
+
|
|
1105
|
+
#### API Specification Validation All Spec Endpoints Fall Through Mode Fall Through Mode Custom Open API Validation Rules Metadata
|
|
1106
|
+
|
|
1107
|
+
A [`metadata`](#api-specification-validation-all-spec-endpoints-fall-through-mode-fall-through-mode-custom-open-api-validation-rules-metadata) block (within [`api_specification.validation_all_spec_endpoints.fall_through_mode.fall_through_mode_custom.open_api_validation_rules`](#api-specification-validation-all-spec-endpoints-fall-through-mode-fall-through-mode-custom-open-api-validation-rules)) supports the following:
|
|
1108
|
+
|
|
1109
|
+
<a id="api-specification-validation-all-spec-endpoints-fall-through-mode-fall-through-mode-custom-open-api-validation-rules-metadata-description-spec"></a>• [`description_spec`](#api-specification-validation-all-spec-endpoints-fall-through-mode-fall-through-mode-custom-open-api-validation-rules-metadata-description-spec) - Optional String<br>Description. Human readable description
|
|
1110
|
+
|
|
1111
|
+
<a id="api-specification-validation-all-spec-endpoints-fall-through-mode-fall-through-mode-custom-open-api-validation-rules-metadata-name"></a>• [`name`](#api-specification-validation-all-spec-endpoints-fall-through-mode-fall-through-mode-custom-open-api-validation-rules-metadata-name) - Optional String<br>Name. This is the name of the message. The value of name has to follow DNS-1035 format
|
|
1112
|
+
|
|
1113
|
+
#### API Specification Validation All Spec Endpoints Settings
|
|
1114
|
+
|
|
1115
|
+
A [`settings`](#api-specification-validation-all-spec-endpoints-settings) block (within [`api_specification.validation_all_spec_endpoints`](#api-specification-validation-all-spec-endpoints)) supports the following:
|
|
1116
|
+
|
|
1117
|
+
<a id="api-specification-validation-all-spec-endpoints-settings-oversized-body-fail-validation"></a>• [`oversized_body_fail_validation`](#api-specification-validation-all-spec-endpoints-settings-oversized-body-fail-validation) - Optional Block<br>Enable this option
|
|
1118
|
+
|
|
1119
|
+
<a id="api-specification-validation-all-spec-endpoints-settings-oversized-body-skip-validation"></a>• [`oversized_body_skip_validation`](#api-specification-validation-all-spec-endpoints-settings-oversized-body-skip-validation) - Optional Block<br>Enable this option
|
|
1120
|
+
|
|
1121
|
+
<a id="api-specification-validation-all-spec-endpoints-settings-property-validation-settings-custom"></a>• [`property_validation_settings_custom`](#api-specification-validation-all-spec-endpoints-settings-property-validation-settings-custom) - Optional Block<br>Validation Property Settings. Custom property validation settings<br>See [Property Validation Settings Custom](#api-specification-validation-all-spec-endpoints-settings-property-validation-settings-custom) below.
|
|
1122
|
+
|
|
1123
|
+
<a id="api-specification-validation-all-spec-endpoints-settings-property-validation-settings-default"></a>• [`property_validation_settings_default`](#api-specification-validation-all-spec-endpoints-settings-property-validation-settings-default) - Optional Block<br>Enable this option
|
|
1124
|
+
|
|
1125
|
+
#### API Specification Validation All Spec Endpoints Settings Property Validation Settings Custom
|
|
1126
|
+
|
|
1127
|
+
A [`property_validation_settings_custom`](#api-specification-validation-all-spec-endpoints-settings-property-validation-settings-custom) block (within [`api_specification.validation_all_spec_endpoints.settings`](#api-specification-validation-all-spec-endpoints-settings)) supports the following:
|
|
1128
|
+
|
|
1129
|
+
<a id="api-specification-validation-all-spec-endpoints-settings-property-validation-settings-custom-query-parameters"></a>• [`query_parameters`](#api-specification-validation-all-spec-endpoints-settings-property-validation-settings-custom-query-parameters) - Optional Block<br>Validation Settings For Query Parameters. Custom settings for query parameters validation<br>See [Query Parameters](#api-specification-validation-all-spec-endpoints-settings-property-validation-settings-custom-query-parameters) below.
|
|
1130
|
+
|
|
1131
|
+
#### API Specification Validation All Spec Endpoints Settings Property Validation Settings Custom Query Parameters
|
|
1132
|
+
|
|
1133
|
+
A [`query_parameters`](#api-specification-validation-all-spec-endpoints-settings-property-validation-settings-custom-query-parameters) block (within [`api_specification.validation_all_spec_endpoints.settings.property_validation_settings_custom`](#api-specification-validation-all-spec-endpoints-settings-property-validation-settings-custom)) supports the following:
|
|
1134
|
+
|
|
1135
|
+
<a id="api-specification-validation-all-spec-endpoints-settings-property-validation-settings-custom-query-parameters-allow-additional-parameters"></a>• [`allow_additional_parameters`](#api-specification-validation-all-spec-endpoints-settings-property-validation-settings-custom-query-parameters-allow-additional-parameters) - Optional Block<br>Enable this option
|
|
1136
|
+
|
|
1137
|
+
<a id="api-specification-validation-all-spec-endpoints-settings-property-validation-settings-custom-query-parameters-disallow-additional-parameters"></a>• [`disallow_additional_parameters`](#api-specification-validation-all-spec-endpoints-settings-property-validation-settings-custom-query-parameters-disallow-additional-parameters) - Optional Block<br>Enable this option
|
|
1138
|
+
|
|
1139
|
+
#### API Specification Validation All Spec Endpoints Validation Mode
|
|
1140
|
+
|
|
1141
|
+
A [`validation_mode`](#api-specification-validation-all-spec-endpoints-validation-mode) block (within [`api_specification.validation_all_spec_endpoints`](#api-specification-validation-all-spec-endpoints)) supports the following:
|
|
1142
|
+
|
|
1143
|
+
<a id="api-specification-validation-all-spec-endpoints-validation-mode-response-validation-mode-active"></a>• [`response_validation_mode_active`](#api-specification-validation-all-spec-endpoints-validation-mode-response-validation-mode-active) - Optional Block<br>Open API Validation Mode Active. Validation mode properties of response<br>See [Response Validation Mode Active](#api-specification-validation-all-spec-endpoints-validation-mode-response-validation-mode-active) below.
|
|
1144
|
+
|
|
1145
|
+
<a id="api-specification-validation-all-spec-endpoints-validation-mode-skip-response-validation"></a>• [`skip_response_validation`](#api-specification-validation-all-spec-endpoints-validation-mode-skip-response-validation) - Optional Block<br>Enable this option
|
|
1146
|
+
|
|
1147
|
+
<a id="api-specification-validation-all-spec-endpoints-validation-mode-skip-validation"></a>• [`skip_validation`](#api-specification-validation-all-spec-endpoints-validation-mode-skip-validation) - Optional Block<br>Enable this option
|
|
1148
|
+
|
|
1149
|
+
<a id="api-specification-validation-all-spec-endpoints-validation-mode-validation-mode-active"></a>• [`validation_mode_active`](#api-specification-validation-all-spec-endpoints-validation-mode-validation-mode-active) - Optional Block<br>Open API Validation Mode Active. Validation mode properties of request<br>See [Validation Mode Active](#api-specification-validation-all-spec-endpoints-validation-mode-validation-mode-active) below.
|
|
1150
|
+
|
|
1151
|
+
#### API Specification Validation All Spec Endpoints Validation Mode Response Validation Mode Active
|
|
1152
|
+
|
|
1153
|
+
A [`response_validation_mode_active`](#api-specification-validation-all-spec-endpoints-validation-mode-response-validation-mode-active) block (within [`api_specification.validation_all_spec_endpoints.validation_mode`](#api-specification-validation-all-spec-endpoints-validation-mode)) supports the following:
|
|
1154
|
+
|
|
1155
|
+
<a id="api-specification-validation-all-spec-endpoints-validation-mode-response-validation-mode-active-enforcement-block"></a>• [`enforcement_block`](#api-specification-validation-all-spec-endpoints-validation-mode-response-validation-mode-active-enforcement-block) - Optional Block<br>Enable this option
|
|
1156
|
+
|
|
1157
|
+
<a id="api-specification-validation-all-spec-endpoints-validation-mode-response-validation-mode-active-enforcement-report"></a>• [`enforcement_report`](#api-specification-validation-all-spec-endpoints-validation-mode-response-validation-mode-active-enforcement-report) - Optional Block<br>Enable this option
|
|
1158
|
+
|
|
1159
|
+
<a id="api-specification-validation-all-spec-endpoints-validation-mode-response-validation-mode-active-response-validation-properties"></a>• [`response_validation_properties`](#api-specification-validation-all-spec-endpoints-validation-mode-response-validation-mode-active-response-validation-properties) - 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)
|
|
1160
|
+
|
|
1161
|
+
#### API Specification Validation All Spec Endpoints Validation Mode Validation Mode Active
|
|
1162
|
+
|
|
1163
|
+
A [`validation_mode_active`](#api-specification-validation-all-spec-endpoints-validation-mode-validation-mode-active) block (within [`api_specification.validation_all_spec_endpoints.validation_mode`](#api-specification-validation-all-spec-endpoints-validation-mode)) supports the following:
|
|
1164
|
+
|
|
1165
|
+
<a id="api-specification-validation-all-spec-endpoints-validation-mode-validation-mode-active-enforcement-block"></a>• [`enforcement_block`](#api-specification-validation-all-spec-endpoints-validation-mode-validation-mode-active-enforcement-block) - Optional Block<br>Enable this option
|
|
1166
|
+
|
|
1167
|
+
<a id="api-specification-validation-all-spec-endpoints-validation-mode-validation-mode-active-enforcement-report"></a>• [`enforcement_report`](#api-specification-validation-all-spec-endpoints-validation-mode-validation-mode-active-enforcement-report) - Optional Block<br>Enable this option
|
|
1168
|
+
|
|
1169
|
+
<a id="api-specification-validation-all-spec-endpoints-validation-mode-validation-mode-active-request-validation-properties"></a>• [`request_validation_properties`](#api-specification-validation-all-spec-endpoints-validation-mode-validation-mode-active-request-validation-properties) - 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)
|
|
1170
|
+
|
|
1171
|
+
#### API Specification Validation Custom List
|
|
1172
|
+
|
|
1173
|
+
A [`validation_custom_list`](#api-specification-validation-custom-list) block (within [`api_specification`](#api-specification)) supports the following:
|
|
1174
|
+
|
|
1175
|
+
<a id="api-specification-validation-custom-list-fall-through-mode"></a>• [`fall_through_mode`](#api-specification-validation-custom-list-fall-through-mode) - Optional Block<br>Fall Through Mode.Determine what to do with unprotected endpoints (not in the OpenAPI specification file (a.k.a. swagger) or doesn't have a specific rule in custom rules)<br>See [Fall Through Mode](#api-specification-validation-custom-list-fall-through-mode) below.
|
|
1176
|
+
|
|
1177
|
+
<a id="api-specification-validation-custom-list-open-api-validation-rules"></a>• [`open_api_validation_rules`](#api-specification-validation-custom-list-open-api-validation-rules) - Optional Block<br>Validation List<br>See [Open API Validation Rules](#api-specification-validation-custom-list-open-api-validation-rules) below.
|
|
1178
|
+
|
|
1179
|
+
<a id="api-specification-validation-custom-list-settings"></a>• [`settings`](#api-specification-validation-custom-list-settings) - Optional Block<br>Common Settings. OpenAPI specification validation settings relevant for 'API Inventory' enforcement and for 'Custom list' enforcement<br>See [Settings](#api-specification-validation-custom-list-settings) below.
|
|
1180
|
+
|
|
1181
|
+
#### API Specification Validation Custom List Fall Through Mode
|
|
1182
|
+
|
|
1183
|
+
A [`fall_through_mode`](#api-specification-validation-custom-list-fall-through-mode) block (within [`api_specification.validation_custom_list`](#api-specification-validation-custom-list)) supports the following:
|
|
1184
|
+
|
|
1185
|
+
<a id="api-specification-validation-custom-list-fall-through-mode-fall-through-mode-allow"></a>• [`fall_through_mode_allow`](#api-specification-validation-custom-list-fall-through-mode-fall-through-mode-allow) - Optional Block<br>Enable this option
|
|
1186
|
+
|
|
1187
|
+
<a id="api-specification-validation-custom-list-fall-through-mode-fall-through-mode-custom"></a>• [`fall_through_mode_custom`](#api-specification-validation-custom-list-fall-through-mode-fall-through-mode-custom) - Optional Block<br>Custom Fall Through Mode. Define the fall through settings<br>See [Fall Through Mode Custom](#api-specification-validation-custom-list-fall-through-mode-fall-through-mode-custom) below.
|
|
1188
|
+
|
|
1189
|
+
#### API Specification Validation Custom List Fall Through Mode Fall Through Mode Custom
|
|
1190
|
+
|
|
1191
|
+
A [`fall_through_mode_custom`](#api-specification-validation-custom-list-fall-through-mode-fall-through-mode-custom) block (within [`api_specification.validation_custom_list.fall_through_mode`](#api-specification-validation-custom-list-fall-through-mode)) supports the following:
|
|
1192
|
+
|
|
1193
|
+
<a id="api-specification-validation-custom-list-fall-through-mode-fall-through-mode-custom-open-api-validation-rules"></a>• [`open_api_validation_rules`](#api-specification-validation-custom-list-fall-through-mode-fall-through-mode-custom-open-api-validation-rules) - Optional Block<br>Custom Fall Through Rule List<br>See [Open API Validation Rules](#api-specification-validation-custom-list-fall-through-mode-fall-through-mode-custom-open-api-validation-rules) below.
|
|
1194
|
+
|
|
1195
|
+
#### API Specification Validation Custom List Fall Through Mode Fall Through Mode Custom Open API Validation Rules
|
|
1196
|
+
|
|
1197
|
+
An [`open_api_validation_rules`](#api-specification-validation-custom-list-fall-through-mode-fall-through-mode-custom-open-api-validation-rules) block (within [`api_specification.validation_custom_list.fall_through_mode.fall_through_mode_custom`](#api-specification-validation-custom-list-fall-through-mode-fall-through-mode-custom)) supports the following:
|
|
1198
|
+
|
|
1199
|
+
<a id="api-specification-validation-custom-list-fall-through-mode-fall-through-mode-custom-open-api-validation-rules-action-block"></a>• [`action_block`](#api-specification-validation-custom-list-fall-through-mode-fall-through-mode-custom-open-api-validation-rules-action-block) - Optional Block<br>Enable this option
|
|
1200
|
+
|
|
1201
|
+
<a id="api-specification-validation-custom-list-fall-through-mode-fall-through-mode-custom-open-api-validation-rules-action-report"></a>• [`action_report`](#api-specification-validation-custom-list-fall-through-mode-fall-through-mode-custom-open-api-validation-rules-action-report) - Optional Block<br>Enable this option
|
|
1202
|
+
|
|
1203
|
+
<a id="api-specification-validation-custom-list-fall-through-mode-fall-through-mode-custom-open-api-validation-rules-action-skip"></a>• [`action_skip`](#api-specification-validation-custom-list-fall-through-mode-fall-through-mode-custom-open-api-validation-rules-action-skip) - Optional Block<br>Enable this option
|
|
1204
|
+
|
|
1205
|
+
<a id="api-specification-validation-custom-list-fall-through-mode-fall-through-mode-custom-open-api-validation-rules-api-endpoint"></a>• [`api_endpoint`](#api-specification-validation-custom-list-fall-through-mode-fall-through-mode-custom-open-api-validation-rules-api-endpoint) - Optional Block<br>API Endpoint. This defines API endpoint<br>See [API Endpoint](#api-specification-validation-custom-list-fall-through-mode-fall-through-mode-custom-open-api-validation-rules-api-endpoint) below.
|
|
1206
|
+
|
|
1207
|
+
<a id="api-specification-validation-custom-list-fall-through-mode-fall-through-mode-custom-open-api-validation-rules-api-group"></a>• [`api_group`](#api-specification-validation-custom-list-fall-through-mode-fall-through-mode-custom-open-api-validation-rules-api-group) - Optional String<br>API Group. The API group which this validation applies to
|
|
1208
|
+
|
|
1209
|
+
<a id="api-specification-validation-custom-list-fall-through-mode-fall-through-mode-custom-open-api-validation-rules-base-path"></a>• [`base_path`](#api-specification-validation-custom-list-fall-through-mode-fall-through-mode-custom-open-api-validation-rules-base-path) - Optional String<br>Base Path. The base path which this validation applies to
|
|
1210
|
+
|
|
1211
|
+
<a id="api-specification-validation-custom-list-fall-through-mode-fall-through-mode-custom-open-api-validation-rules-metadata"></a>• [`metadata`](#api-specification-validation-custom-list-fall-through-mode-fall-through-mode-custom-open-api-validation-rules-metadata) - 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](#api-specification-validation-custom-list-fall-through-mode-fall-through-mode-custom-open-api-validation-rules-metadata) below.
|
|
1212
|
+
|
|
1213
|
+
#### API Specification Validation Custom List Fall Through Mode Fall Through Mode Custom Open API Validation Rules API Endpoint
|
|
1214
|
+
|
|
1215
|
+
An [`api_endpoint`](#api-specification-validation-custom-list-fall-through-mode-fall-through-mode-custom-open-api-validation-rules-api-endpoint) block (within [`api_specification.validation_custom_list.fall_through_mode.fall_through_mode_custom.open_api_validation_rules`](#api-specification-validation-custom-list-fall-through-mode-fall-through-mode-custom-open-api-validation-rules)) supports the following:
|
|
1216
|
+
|
|
1217
|
+
<a id="api-specification-validation-custom-list-fall-through-mode-fall-through-mode-custom-open-api-validation-rules-api-endpoint-methods"></a>• [`methods`](#api-specification-validation-custom-list-fall-through-mode-fall-through-mode-custom-open-api-validation-rules-api-endpoint-methods) - 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="api-specification-validation-custom-list-fall-through-mode-fall-through-mode-custom-open-api-validation-rules-api-endpoint-path"></a>• [`path`](#api-specification-validation-custom-list-fall-through-mode-fall-through-mode-custom-open-api-validation-rules-api-endpoint-path) - Optional String<br>Path. Path to be matched
|
|
1220
|
+
|
|
1221
|
+
#### API Specification Validation Custom List Fall Through Mode Fall Through Mode Custom Open API Validation Rules Metadata
|
|
1222
|
+
|
|
1223
|
+
A [`metadata`](#api-specification-validation-custom-list-fall-through-mode-fall-through-mode-custom-open-api-validation-rules-metadata) block (within [`api_specification.validation_custom_list.fall_through_mode.fall_through_mode_custom.open_api_validation_rules`](#api-specification-validation-custom-list-fall-through-mode-fall-through-mode-custom-open-api-validation-rules)) supports the following:
|
|
1224
|
+
|
|
1225
|
+
<a id="api-specification-validation-custom-list-fall-through-mode-fall-through-mode-custom-open-api-validation-rules-metadata-description-spec"></a>• [`description_spec`](#api-specification-validation-custom-list-fall-through-mode-fall-through-mode-custom-open-api-validation-rules-metadata-description-spec) - Optional String<br>Description. Human readable description
|
|
1226
|
+
|
|
1227
|
+
<a id="api-specification-validation-custom-list-fall-through-mode-fall-through-mode-custom-open-api-validation-rules-metadata-name"></a>• [`name`](#api-specification-validation-custom-list-fall-through-mode-fall-through-mode-custom-open-api-validation-rules-metadata-name) - Optional String<br>Name. This is the name of the message. The value of name has to follow DNS-1035 format
|
|
1228
|
+
|
|
1229
|
+
#### API Specification Validation Custom List Open API Validation Rules
|
|
1230
|
+
|
|
1231
|
+
An [`open_api_validation_rules`](#api-specification-validation-custom-list-open-api-validation-rules) block (within [`api_specification.validation_custom_list`](#api-specification-validation-custom-list)) supports the following:
|
|
1232
|
+
|
|
1233
|
+
<a id="api-specification-validation-custom-list-open-api-validation-rules-any-domain"></a>• [`any_domain`](#api-specification-validation-custom-list-open-api-validation-rules-any-domain) - Optional Block<br>Enable this option
|
|
1234
|
+
|
|
1235
|
+
<a id="api-specification-validation-custom-list-open-api-validation-rules-api-endpoint"></a>• [`api_endpoint`](#api-specification-validation-custom-list-open-api-validation-rules-api-endpoint) - Optional Block<br>API Endpoint. This defines API endpoint<br>See [API Endpoint](#api-specification-validation-custom-list-open-api-validation-rules-api-endpoint) below.
|
|
1236
|
+
|
|
1237
|
+
<a id="api-specification-validation-custom-list-open-api-validation-rules-api-group"></a>• [`api_group`](#api-specification-validation-custom-list-open-api-validation-rules-api-group) - Optional String<br>API Group. The API group which this validation applies to
|
|
1238
|
+
|
|
1239
|
+
<a id="api-specification-validation-custom-list-open-api-validation-rules-base-path"></a>• [`base_path`](#api-specification-validation-custom-list-open-api-validation-rules-base-path) - Optional String<br>Base Path. The base path which this validation applies to
|
|
1240
|
+
|
|
1241
|
+
<a id="api-specification-validation-custom-list-open-api-validation-rules-metadata"></a>• [`metadata`](#api-specification-validation-custom-list-open-api-validation-rules-metadata) - 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](#api-specification-validation-custom-list-open-api-validation-rules-metadata) below.
|
|
1242
|
+
|
|
1243
|
+
<a id="api-specification-validation-custom-list-open-api-validation-rules-specific-domain"></a>• [`specific_domain`](#api-specification-validation-custom-list-open-api-validation-rules-specific-domain) - Optional String<br>Specific Domain. The rule will apply for a specific domain
|
|
1244
|
+
|
|
1245
|
+
<a id="api-specification-validation-custom-list-open-api-validation-rules-validation-mode"></a>• [`validation_mode`](#api-specification-validation-custom-list-open-api-validation-rules-validation-mode) - 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](#api-specification-validation-custom-list-open-api-validation-rules-validation-mode) below.
|
|
1246
|
+
|
|
1247
|
+
#### API Specification Validation Custom List Open API Validation Rules API Endpoint
|
|
1248
|
+
|
|
1249
|
+
An [`api_endpoint`](#api-specification-validation-custom-list-open-api-validation-rules-api-endpoint) block (within [`api_specification.validation_custom_list.open_api_validation_rules`](#api-specification-validation-custom-list-open-api-validation-rules)) supports the following:
|
|
1250
|
+
|
|
1251
|
+
<a id="api-specification-validation-custom-list-open-api-validation-rules-api-endpoint-methods"></a>• [`methods`](#api-specification-validation-custom-list-open-api-validation-rules-api-endpoint-methods) - 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="api-specification-validation-custom-list-open-api-validation-rules-api-endpoint-path"></a>• [`path`](#api-specification-validation-custom-list-open-api-validation-rules-api-endpoint-path) - Optional String<br>Path. Path to be matched
|
|
1254
|
+
|
|
1255
|
+
#### API Specification Validation Custom List Open API Validation Rules Metadata
|
|
1256
|
+
|
|
1257
|
+
A [`metadata`](#api-specification-validation-custom-list-open-api-validation-rules-metadata) block (within [`api_specification.validation_custom_list.open_api_validation_rules`](#api-specification-validation-custom-list-open-api-validation-rules)) supports the following:
|
|
1258
|
+
|
|
1259
|
+
<a id="api-specification-validation-custom-list-open-api-validation-rules-metadata-description-spec"></a>• [`description_spec`](#api-specification-validation-custom-list-open-api-validation-rules-metadata-description-spec) - Optional String<br>Description. Human readable description
|
|
1260
|
+
|
|
1261
|
+
<a id="api-specification-validation-custom-list-open-api-validation-rules-metadata-name"></a>• [`name`](#api-specification-validation-custom-list-open-api-validation-rules-metadata-name) - Optional String<br>Name. This is the name of the message. The value of name has to follow DNS-1035 format
|
|
1262
|
+
|
|
1263
|
+
#### API Specification Validation Custom List Open API Validation Rules Validation Mode
|
|
1264
|
+
|
|
1265
|
+
A [`validation_mode`](#api-specification-validation-custom-list-open-api-validation-rules-validation-mode) block (within [`api_specification.validation_custom_list.open_api_validation_rules`](#api-specification-validation-custom-list-open-api-validation-rules)) supports the following:
|
|
1266
|
+
|
|
1267
|
+
<a id="api-specification-validation-custom-list-open-api-validation-rules-validation-mode-response-validation-mode-active"></a>• [`response_validation_mode_active`](#api-specification-validation-custom-list-open-api-validation-rules-validation-mode-response-validation-mode-active) - Optional Block<br>Open API Validation Mode Active. Validation mode properties of response<br>See [Response Validation Mode Active](#api-specification-validation-custom-list-open-api-validation-rules-validation-mode-response-validation-mode-active) below.
|
|
1268
|
+
|
|
1269
|
+
<a id="api-specification-validation-custom-list-open-api-validation-rules-validation-mode-skip-response-validation"></a>• [`skip_response_validation`](#api-specification-validation-custom-list-open-api-validation-rules-validation-mode-skip-response-validation) - Optional Block<br>Enable this option
|
|
1270
|
+
|
|
1271
|
+
<a id="api-specification-validation-custom-list-open-api-validation-rules-validation-mode-skip-validation"></a>• [`skip_validation`](#api-specification-validation-custom-list-open-api-validation-rules-validation-mode-skip-validation) - Optional Block<br>Enable this option
|
|
1272
|
+
|
|
1273
|
+
<a id="api-specification-validation-custom-list-open-api-validation-rules-validation-mode-validation-mode-active"></a>• [`validation_mode_active`](#api-specification-validation-custom-list-open-api-validation-rules-validation-mode-validation-mode-active) - Optional Block<br>Open API Validation Mode Active. Validation mode properties of request<br>See [Validation Mode Active](#api-specification-validation-custom-list-open-api-validation-rules-validation-mode-validation-mode-active) below.
|
|
1274
|
+
|
|
1275
|
+
#### API Specification Validation Custom List Open API Validation Rules Validation Mode Response Validation Mode Active
|
|
1276
|
+
|
|
1277
|
+
A [`response_validation_mode_active`](#api-specification-validation-custom-list-open-api-validation-rules-validation-mode-response-validation-mode-active) block (within [`api_specification.validation_custom_list.open_api_validation_rules.validation_mode`](#api-specification-validation-custom-list-open-api-validation-rules-validation-mode)) supports the following:
|
|
1278
|
+
|
|
1279
|
+
<a id="api-specification-validation-custom-list-open-api-validation-rules-validation-mode-response-validation-mode-active-enforcement-block"></a>• [`enforcement_block`](#api-specification-validation-custom-list-open-api-validation-rules-validation-mode-response-validation-mode-active-enforcement-block) - Optional Block<br>Enable this option
|
|
1280
|
+
|
|
1281
|
+
<a id="api-specification-validation-custom-list-open-api-validation-rules-validation-mode-response-validation-mode-active-enforcement-report"></a>• [`enforcement_report`](#api-specification-validation-custom-list-open-api-validation-rules-validation-mode-response-validation-mode-active-enforcement-report) - Optional Block<br>Enable this option
|
|
1282
|
+
|
|
1283
|
+
<a id="api-specification-validation-custom-list-open-api-validation-rules-validation-mode-response-validation-mode-active-response-validation-properties"></a>• [`response_validation_properties`](#api-specification-validation-custom-list-open-api-validation-rules-validation-mode-response-validation-mode-active-response-validation-properties) - 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)
|
|
1284
|
+
|
|
1285
|
+
#### API Specification Validation Custom List Open API Validation Rules Validation Mode Validation Mode Active
|
|
1286
|
+
|
|
1287
|
+
A [`validation_mode_active`](#api-specification-validation-custom-list-open-api-validation-rules-validation-mode-validation-mode-active) block (within [`api_specification.validation_custom_list.open_api_validation_rules.validation_mode`](#api-specification-validation-custom-list-open-api-validation-rules-validation-mode)) supports the following:
|
|
1288
|
+
|
|
1289
|
+
<a id="api-specification-validation-custom-list-open-api-validation-rules-validation-mode-validation-mode-active-enforcement-block"></a>• [`enforcement_block`](#api-specification-validation-custom-list-open-api-validation-rules-validation-mode-validation-mode-active-enforcement-block) - Optional Block<br>Enable this option
|
|
1290
|
+
|
|
1291
|
+
<a id="api-specification-validation-custom-list-open-api-validation-rules-validation-mode-validation-mode-active-enforcement-report"></a>• [`enforcement_report`](#api-specification-validation-custom-list-open-api-validation-rules-validation-mode-validation-mode-active-enforcement-report) - Optional Block<br>Enable this option
|
|
1292
|
+
|
|
1293
|
+
<a id="api-specification-validation-custom-list-open-api-validation-rules-validation-mode-validation-mode-active-request-validation-properties"></a>• [`request_validation_properties`](#api-specification-validation-custom-list-open-api-validation-rules-validation-mode-validation-mode-active-request-validation-properties) - 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)
|
|
1294
|
+
|
|
1295
|
+
#### API Specification Validation Custom List Settings
|
|
1296
|
+
|
|
1297
|
+
A [`settings`](#api-specification-validation-custom-list-settings) block (within [`api_specification.validation_custom_list`](#api-specification-validation-custom-list)) supports the following:
|
|
1298
|
+
|
|
1299
|
+
<a id="api-specification-validation-custom-list-settings-oversized-body-fail-validation"></a>• [`oversized_body_fail_validation`](#api-specification-validation-custom-list-settings-oversized-body-fail-validation) - Optional Block<br>Enable this option
|
|
1300
|
+
|
|
1301
|
+
<a id="api-specification-validation-custom-list-settings-oversized-body-skip-validation"></a>• [`oversized_body_skip_validation`](#api-specification-validation-custom-list-settings-oversized-body-skip-validation) - Optional Block<br>Enable this option
|
|
1302
|
+
|
|
1303
|
+
<a id="api-specification-validation-custom-list-settings-property-validation-settings-custom"></a>• [`property_validation_settings_custom`](#api-specification-validation-custom-list-settings-property-validation-settings-custom) - Optional Block<br>Validation Property Settings. Custom property validation settings<br>See [Property Validation Settings Custom](#api-specification-validation-custom-list-settings-property-validation-settings-custom) below.
|
|
1304
|
+
|
|
1305
|
+
<a id="api-specification-validation-custom-list-settings-property-validation-settings-default"></a>• [`property_validation_settings_default`](#api-specification-validation-custom-list-settings-property-validation-settings-default) - Optional Block<br>Enable this option
|
|
1306
|
+
|
|
1307
|
+
#### API Specification Validation Custom List Settings Property Validation Settings Custom
|
|
1308
|
+
|
|
1309
|
+
A [`property_validation_settings_custom`](#api-specification-validation-custom-list-settings-property-validation-settings-custom) block (within [`api_specification.validation_custom_list.settings`](#api-specification-validation-custom-list-settings)) supports the following:
|
|
1310
|
+
|
|
1311
|
+
<a id="api-specification-validation-custom-list-settings-property-validation-settings-custom-query-parameters"></a>• [`query_parameters`](#api-specification-validation-custom-list-settings-property-validation-settings-custom-query-parameters) - Optional Block<br>Validation Settings For Query Parameters. Custom settings for query parameters validation<br>See [Query Parameters](#api-specification-validation-custom-list-settings-property-validation-settings-custom-query-parameters) below.
|
|
1312
|
+
|
|
1313
|
+
#### API Specification Validation Custom List Settings Property Validation Settings Custom Query Parameters
|
|
1314
|
+
|
|
1315
|
+
A [`query_parameters`](#api-specification-validation-custom-list-settings-property-validation-settings-custom-query-parameters) block (within [`api_specification.validation_custom_list.settings.property_validation_settings_custom`](#api-specification-validation-custom-list-settings-property-validation-settings-custom)) supports the following:
|
|
1316
|
+
|
|
1317
|
+
<a id="api-specification-validation-custom-list-settings-property-validation-settings-custom-query-parameters-allow-additional-parameters"></a>• [`allow_additional_parameters`](#api-specification-validation-custom-list-settings-property-validation-settings-custom-query-parameters-allow-additional-parameters) - Optional Block<br>Enable this option
|
|
1318
|
+
|
|
1319
|
+
<a id="api-specification-validation-custom-list-settings-property-validation-settings-custom-query-parameters-disallow-additional-parameters"></a>• [`disallow_additional_parameters`](#api-specification-validation-custom-list-settings-property-validation-settings-custom-query-parameters-disallow-additional-parameters) - Optional Block<br>Enable this option
|
|
1320
|
+
|
|
1321
|
+
#### App Firewall
|
|
1322
|
+
|
|
1323
|
+
An [`app_firewall`](#app-firewall) block supports the following:
|
|
1324
|
+
|
|
1325
|
+
<a id="app-firewall-name"></a>• [`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>• [`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>• [`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
|
|
1330
|
+
|
|
1331
|
+
#### Blocked Clients
|
|
1332
|
+
|
|
1333
|
+
A [`blocked_clients`](#blocked-clients) block supports the following:
|
|
1334
|
+
|
|
1335
|
+
<a id="blocked-clients-actions"></a>• [`actions`](#blocked-clients-actions) - Optional List Defaults to `SKIP_PROCESSING_WAF`<br>Possible values are `SKIP_PROCESSING_WAF`, `SKIP_PROCESSING_BOT`, `SKIP_PROCESSING_MUM`, `SKIP_PROCESSING_IP_REPUTATION`, `SKIP_PROCESSING_API_PROTECTION`, `SKIP_PROCESSING_OAS_VALIDATION`, `SKIP_PROCESSING_DDOS_PROTECTION`, `SKIP_PROCESSING_THREAT_MESH`, `SKIP_PROCESSING_MALWARE_PROTECTION`<br>[Enum: SKIP_PROCESSING_WAF|SKIP_PROCESSING_BOT|SKIP_PROCESSING_MUM|SKIP_PROCESSING_IP_REPUTATION|SKIP_PROCESSING_API_PROTECTION|SKIP_PROCESSING_OAS_VALIDATION|SKIP_PROCESSING_DDOS_PROTECTION|SKIP_PROCESSING_THREAT_MESH|SKIP_PROCESSING_MALWARE_PROTECTION] Actions. Actions that should be taken when client identifier matches the rule
|
|
1336
|
+
|
|
1337
|
+
<a id="blocked-clients-as-number"></a>• [`as_number`](#blocked-clients-as-number) - Optional Number<br>AS Number. RFC 6793 defined 4-byte AS number
|
|
1338
|
+
|
|
1339
|
+
<a id="blocked-clients-bot-skip-processing"></a>• [`bot_skip_processing`](#blocked-clients-bot-skip-processing) - Optional Block<br>Enable this option
|
|
1340
|
+
|
|
1341
|
+
<a id="blocked-clients-expiration-timestamp"></a>• [`expiration_timestamp`](#blocked-clients-expiration-timestamp) - Optional String<br>Expiration Timestamp. The expiration_timestamp is the RFC 3339 format timestamp at which the containing rule is considered to be logically expired. The rule continues to exist in the configuration but is not applied anymore
|
|
1342
|
+
|
|
1343
|
+
<a id="blocked-clients-http-header"></a>• [`http_header`](#blocked-clients-http-header) - Optional Block<br>HTTP Header. Request header name and value pairs<br>See [HTTP Header](#blocked-clients-http-header) below.
|
|
1344
|
+
|
|
1345
|
+
<a id="blocked-clients-ip-prefix"></a>• [`ip_prefix`](#blocked-clients-ip-prefix) - Optional String<br>IPv4 Prefix. IPv4 prefix string
|
|
1346
|
+
|
|
1347
|
+
<a id="blocked-clients-ipv6-prefix"></a>• [`ipv6_prefix`](#blocked-clients-ipv6-prefix) - Optional String<br>IPv6 Prefix. IPv6 prefix string
|
|
1348
|
+
|
|
1349
|
+
<a id="blocked-clients-metadata"></a>• [`metadata`](#blocked-clients-metadata) - 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](#blocked-clients-metadata) below.
|
|
1350
|
+
|
|
1351
|
+
<a id="blocked-clients-skip-processing"></a>• [`skip_processing`](#blocked-clients-skip-processing) - Optional Block<br>Enable this option
|
|
1352
|
+
|
|
1353
|
+
<a id="blocked-clients-user-identifier"></a>• [`user_identifier`](#blocked-clients-user-identifier) - Optional String<br>User Identifier. Identify user based on user identifier. User identifier value needs to be copied from security event
|
|
1354
|
+
|
|
1355
|
+
<a id="blocked-clients-waf-skip-processing"></a>• [`waf_skip_processing`](#blocked-clients-waf-skip-processing) - Optional Block<br>Enable this option
|
|
1356
|
+
|
|
1357
|
+
#### Blocked Clients HTTP Header
|
|
1358
|
+
|
|
1359
|
+
A [`http_header`](#blocked-clients-http-header) block (within [`blocked_clients`](#blocked-clients)) supports the following:
|
|
1360
|
+
|
|
1361
|
+
<a id="blocked-clients-http-header-headers"></a>• [`headers`](#blocked-clients-http-header-headers) - Optional Block<br>HTTP Headers. List of HTTP header name and value pairs<br>See [Headers](#blocked-clients-http-header-headers) below.
|
|
1362
|
+
|
|
1363
|
+
#### Blocked Clients HTTP Header Headers
|
|
1364
|
+
|
|
1365
|
+
A [`headers`](#blocked-clients-http-header-headers) block (within [`blocked_clients.http_header`](#blocked-clients-http-header)) supports the following:
|
|
1366
|
+
|
|
1367
|
+
<a id="blocked-clients-http-header-headers-exact"></a>• [`exact`](#blocked-clients-http-header-headers-exact) - Optional String<br>Exact. Header value to match exactly
|
|
1368
|
+
|
|
1369
|
+
<a id="blocked-clients-http-header-headers-invert-match"></a>• [`invert_match`](#blocked-clients-http-header-headers-invert-match) - Optional Bool<br>NOT of match. Invert the result of the match to detect missing header or non-matching value
|
|
1370
|
+
|
|
1371
|
+
<a id="blocked-clients-http-header-headers-name"></a>• [`name`](#blocked-clients-http-header-headers-name) - Optional String<br>Name. Name of the header
|
|
1372
|
+
|
|
1373
|
+
<a id="blocked-clients-http-header-headers-presence"></a>• [`presence`](#blocked-clients-http-header-headers-presence) - Optional Bool<br>Presence. If true, check for presence of header
|
|
1374
|
+
|
|
1375
|
+
<a id="blocked-clients-http-header-headers-regex"></a>• [`regex`](#blocked-clients-http-header-headers-regex) - Optional String<br>Regex. Regex match of the header value in re2 format
|
|
1376
|
+
|
|
1377
|
+
#### Blocked Clients Metadata
|
|
1378
|
+
|
|
1379
|
+
A [`metadata`](#blocked-clients-metadata) block (within [`blocked_clients`](#blocked-clients)) supports the following:
|
|
1380
|
+
|
|
1381
|
+
<a id="blocked-clients-metadata-description-spec"></a>• [`description_spec`](#blocked-clients-metadata-description-spec) - Optional String<br>Description. Human readable description
|
|
1382
|
+
|
|
1383
|
+
<a id="blocked-clients-metadata-name"></a>• [`name`](#blocked-clients-metadata-name) - Optional String<br>Name. This is the name of the message. The value of name has to follow DNS-1035 format
|
|
1384
|
+
|
|
1385
|
+
#### Bot Defense
|
|
1386
|
+
|
|
1387
|
+
A [`bot_defense`](#bot-defense) block supports the following:
|
|
1388
|
+
|
|
1389
|
+
<a id="bot-defense-disable-cors-support"></a>• [`disable_cors_support`](#bot-defense-disable-cors-support) - Optional Block<br>Enable this option
|
|
1390
|
+
|
|
1391
|
+
<a id="bot-defense-enable-cors-support"></a>• [`enable_cors_support`](#bot-defense-enable-cors-support) - Optional Block<br>Enable this option
|
|
1392
|
+
|
|
1393
|
+
<a id="bot-defense-policy"></a>• [`policy`](#bot-defense-policy) - Optional Block<br>Bot Defense Policy. This defines various configuration options for Bot Defense policy<br>See [Policy](#bot-defense-policy) below.
|
|
1394
|
+
|
|
1395
|
+
<a id="bot-defense-regional-endpoint"></a>• [`regional_endpoint`](#bot-defense-regional-endpoint) - Optional String Defaults to `AUTO`<br>Possible values are `AUTO`, `US`, `EU`, `ASIA`<br>[Enum: AUTO|US|EU|ASIA] Bot Defense Region. Defines a selection for Bot Defense region - AUTO: AUTO Automatic selection based on client IP address - US: US US region - EU: EU European Union region - ASIA: ASIA Asia region
|
|
1396
|
+
|
|
1397
|
+
<a id="bot-defense-timeout"></a>• [`timeout`](#bot-defense-timeout) - Optional Number<br>Timeout. The timeout for the inference check, in milliseconds
|
|
1398
|
+
|
|
1399
|
+
#### Bot Defense Policy
|
|
1400
|
+
|
|
1401
|
+
A [`policy`](#bot-defense-policy) block (within [`bot_defense`](#bot-defense)) supports the following:
|
|
1402
|
+
|
|
1403
|
+
<a id="bot-defense-policy-disable-js-insert"></a>• [`disable_js_insert`](#bot-defense-policy-disable-js-insert) - Optional Block<br>Enable this option
|
|
1404
|
+
|
|
1405
|
+
<a id="bot-defense-policy-disable-mobile-sdk"></a>• [`disable_mobile_sdk`](#bot-defense-policy-disable-mobile-sdk) - Optional Block<br>Enable this option
|
|
1406
|
+
|
|
1407
|
+
<a id="bot-defense-policy-javascript-mode"></a>• [`javascript_mode`](#bot-defense-policy-javascript-mode) - Optional String Defaults to `ASYNC_JS_NO_CACHING`<br>Possible values are `ASYNC_JS_NO_CACHING`, `ASYNC_JS_CACHING`, `SYNC_JS_NO_CACHING`, `SYNC_JS_CACHING`<br>[Enum: ASYNC_JS_NO_CACHING|ASYNC_JS_CACHING|SYNC_JS_NO_CACHING|SYNC_JS_CACHING] Web Client JavaScript Mode. Web Client JavaScript Mode. Bot Defense JavaScript for telemetry collection is requested asynchronously, and it is non-cacheable Bot Defense JavaScript for telemetry collection is requested asynchronously, and it is cacheable Bot Defense JavaScript for telemetry collection is requested synchronously, and it is non-cacheable Bot Defense JavaScript for telemetry collection is requested synchronously, and it is cacheable
|
|
1408
|
+
|
|
1409
|
+
<a id="bot-defense-policy-js-download-path"></a>• [`js_download_path`](#bot-defense-policy-js-download-path) - Optional String<br>JavaScript Download Path. Customize Bot Defense Client JavaScript path. If not specified, default `/common.js`
|
|
1410
|
+
|
|
1411
|
+
<a id="bot-defense-policy-js-insert-all-pages"></a>• [`js_insert_all_pages`](#bot-defense-policy-js-insert-all-pages) - Optional Block<br>Insert Bot Defense JavaScript in All Pages. Insert Bot Defense JavaScript in all pages<br>See [Js Insert All Pages](#bot-defense-policy-js-insert-all-pages) below.
|
|
1412
|
+
|
|
1413
|
+
<a id="bot-defense-policy-js-insert-all-pages-except"></a>• [`js_insert_all_pages_except`](#bot-defense-policy-js-insert-all-pages-except) - Optional Block<br>Insert JavaScript in All Pages with the Exceptions. Insert Bot Defense JavaScript in all pages with the exceptions<br>See [Js Insert All Pages Except](#bot-defense-policy-js-insert-all-pages-except) below.
|
|
1414
|
+
|
|
1415
|
+
<a id="bot-defense-policy-js-insertion-rules"></a>• [`js_insertion_rules`](#bot-defense-policy-js-insertion-rules) - Optional Block<br>JavaScript Custom Insertion Rules. This defines custom JavaScript insertion rules for Bot Defense Policy<br>See [Js Insertion Rules](#bot-defense-policy-js-insertion-rules) below.
|
|
1416
|
+
|
|
1417
|
+
<a id="bot-defense-policy-mobile-sdk-config"></a>• [`mobile_sdk_config`](#bot-defense-policy-mobile-sdk-config) - Optional Block<br>Mobile SDK Configuration. Mobile SDK configuration<br>See [Mobile Sdk Config](#bot-defense-policy-mobile-sdk-config) below.
|
|
1418
|
+
|
|
1419
|
+
<a id="bot-defense-policy-protected-app-endpoints"></a>• [`protected_app_endpoints`](#bot-defense-policy-protected-app-endpoints) - Optional Block<br>App Endpoint Type. List of protected endpoints. Limit: Approx '128 endpoints per Load Balancer (LB)' upto 4 LBs, '32 endpoints per LB' after 4 LBs<br>See [Protected App Endpoints](#bot-defense-policy-protected-app-endpoints) below.
|
|
1420
|
+
|
|
1421
|
+
#### Bot Defense Policy Js Insert All Pages
|
|
1422
|
+
|
|
1423
|
+
A [`js_insert_all_pages`](#bot-defense-policy-js-insert-all-pages) block (within [`bot_defense.policy`](#bot-defense-policy)) supports the following:
|
|
1424
|
+
|
|
1425
|
+
<a id="bot-defense-policy-js-insert-all-pages-javascript-location"></a>• [`javascript_location`](#bot-defense-policy-js-insert-all-pages-javascript-location) - 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
|
|
1426
|
+
|
|
1427
|
+
#### Bot Defense Policy Js Insert All Pages Except
|
|
1428
|
+
|
|
1429
|
+
A [`js_insert_all_pages_except`](#bot-defense-policy-js-insert-all-pages-except) block (within [`bot_defense.policy`](#bot-defense-policy)) supports the following:
|
|
1430
|
+
|
|
1431
|
+
<a id="bot-defense-policy-js-insert-all-pages-except-exclude-list"></a>• [`exclude_list`](#bot-defense-policy-js-insert-all-pages-except-exclude-list) - Optional Block<br>Exclude Pages. Optional JavaScript insertions exclude list of domain and path matchers<br>See [Exclude List](#bot-defense-policy-js-insert-all-pages-except-exclude-list) below.
|
|
1432
|
+
|
|
1433
|
+
<a id="bot-defense-policy-js-insert-all-pages-except-javascript-location"></a>• [`javascript_location`](#bot-defense-policy-js-insert-all-pages-except-javascript-location) - 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
|
|
1434
|
+
|
|
1435
|
+
#### Bot Defense Policy Js Insert All Pages Except Exclude List
|
|
1436
|
+
|
|
1437
|
+
An [`exclude_list`](#bot-defense-policy-js-insert-all-pages-except-exclude-list) block (within [`bot_defense.policy.js_insert_all_pages_except`](#bot-defense-policy-js-insert-all-pages-except)) supports the following:
|
|
1438
|
+
|
|
1439
|
+
<a id="bot-defense-policy-js-insert-all-pages-except-exclude-list-any-domain"></a>• [`any_domain`](#bot-defense-policy-js-insert-all-pages-except-exclude-list-any-domain) - Optional Block<br>Enable this option
|
|
1440
|
+
|
|
1441
|
+
<a id="bot-defense-policy-js-insert-all-pages-except-exclude-list-domain"></a>• [`domain`](#bot-defense-policy-js-insert-all-pages-except-exclude-list-domain) - Optional Block<br>Domains. Domains names<br>See [Domain](#bot-defense-policy-js-insert-all-pages-except-exclude-list-domain) below.
|
|
1442
|
+
|
|
1443
|
+
<a id="bot-defense-policy-js-insert-all-pages-except-exclude-list-metadata"></a>• [`metadata`](#bot-defense-policy-js-insert-all-pages-except-exclude-list-metadata) - 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](#bot-defense-policy-js-insert-all-pages-except-exclude-list-metadata) below.
|
|
1444
|
+
|
|
1445
|
+
<a id="bot-defense-policy-js-insert-all-pages-except-exclude-list-path"></a>• [`path`](#bot-defense-policy-js-insert-all-pages-except-exclude-list-path) - 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](#bot-defense-policy-js-insert-all-pages-except-exclude-list-path) below.
|
|
1446
|
+
|
|
1447
|
+
#### Bot Defense Policy Js Insert All Pages Except Exclude List Domain
|
|
1448
|
+
|
|
1449
|
+
A [`domain`](#bot-defense-policy-js-insert-all-pages-except-exclude-list-domain) block (within [`bot_defense.policy.js_insert_all_pages_except.exclude_list`](#bot-defense-policy-js-insert-all-pages-except-exclude-list)) supports the following:
|
|
1450
|
+
|
|
1451
|
+
<a id="bot-defense-policy-js-insert-all-pages-except-exclude-list-domain-exact-value"></a>• [`exact_value`](#bot-defense-policy-js-insert-all-pages-except-exclude-list-domain-exact-value) - Optional String<br>Exact Value. Exact domain name
|
|
1452
|
+
|
|
1453
|
+
<a id="bot-defense-policy-js-insert-all-pages-except-exclude-list-domain-regex-value"></a>• [`regex_value`](#bot-defense-policy-js-insert-all-pages-except-exclude-list-domain-regex-value) - Optional String<br>Regex Values of Domains. Regular Expression value for the domain name
|
|
1454
|
+
|
|
1455
|
+
<a id="bot-defense-policy-js-insert-all-pages-except-exclude-list-domain-suffix-value"></a>• [`suffix_value`](#bot-defense-policy-js-insert-all-pages-except-exclude-list-domain-suffix-value) - Optional String<br>Suffix Value. Suffix of domain name e.g 'xyz.com' will match '*.xyz.com' and 'xyz.com'
|
|
1456
|
+
|
|
1457
|
+
#### Bot Defense Policy Js Insert All Pages Except Exclude List Metadata
|
|
1458
|
+
|
|
1459
|
+
A [`metadata`](#bot-defense-policy-js-insert-all-pages-except-exclude-list-metadata) block (within [`bot_defense.policy.js_insert_all_pages_except.exclude_list`](#bot-defense-policy-js-insert-all-pages-except-exclude-list)) supports the following:
|
|
1460
|
+
|
|
1461
|
+
<a id="bot-defense-policy-js-insert-all-pages-except-exclude-list-metadata-description-spec"></a>• [`description_spec`](#bot-defense-policy-js-insert-all-pages-except-exclude-list-metadata-description-spec) - Optional String<br>Description. Human readable description
|
|
1462
|
+
|
|
1463
|
+
<a id="bot-defense-policy-js-insert-all-pages-except-exclude-list-metadata-name"></a>• [`name`](#bot-defense-policy-js-insert-all-pages-except-exclude-list-metadata-name) - Optional String<br>Name. This is the name of the message. The value of name has to follow DNS-1035 format
|
|
1464
|
+
|
|
1465
|
+
#### Bot Defense Policy Js Insert All Pages Except Exclude List Path
|
|
1466
|
+
|
|
1467
|
+
A [`path`](#bot-defense-policy-js-insert-all-pages-except-exclude-list-path) block (within [`bot_defense.policy.js_insert_all_pages_except.exclude_list`](#bot-defense-policy-js-insert-all-pages-except-exclude-list)) supports the following:
|
|
1468
|
+
|
|
1469
|
+
<a id="bot-defense-policy-js-insert-all-pages-except-exclude-list-path-path"></a>• [`path`](#bot-defense-policy-js-insert-all-pages-except-exclude-list-path-path) - Optional String<br>Exact. Exact path value to match
|
|
1470
|
+
|
|
1471
|
+
<a id="bot-defense-policy-js-insert-all-pages-except-exclude-list-path-prefix"></a>• [`prefix`](#bot-defense-policy-js-insert-all-pages-except-exclude-list-path-prefix) - Optional String<br>Prefix. Path prefix to match (e.g. the value / will match on all paths)
|
|
1472
|
+
|
|
1473
|
+
<a id="bot-defense-policy-js-insert-all-pages-except-exclude-list-path-regex"></a>• [`regex`](#bot-defense-policy-js-insert-all-pages-except-exclude-list-path-regex) - Optional String<br>Regex. Regular expression of path match (e.g. the value .* will match on all paths)
|
|
1474
|
+
|
|
1475
|
+
#### Bot Defense Policy Js Insertion Rules
|
|
1476
|
+
|
|
1477
|
+
A [`js_insertion_rules`](#bot-defense-policy-js-insertion-rules) block (within [`bot_defense.policy`](#bot-defense-policy)) supports the following:
|
|
1478
|
+
|
|
1479
|
+
<a id="bot-defense-policy-js-insertion-rules-exclude-list"></a>• [`exclude_list`](#bot-defense-policy-js-insertion-rules-exclude-list) - Optional Block<br>Exclude Paths. Optional JavaScript insertions exclude list of domain and path matchers<br>See [Exclude List](#bot-defense-policy-js-insertion-rules-exclude-list) below.
|
|
1480
|
+
|
|
1481
|
+
<a id="bot-defense-policy-js-insertion-rules-rules"></a>• [`rules`](#bot-defense-policy-js-insertion-rules-rules) - Optional Block<br>JavaScript Insertions. Required list of pages to insert Bot Defense client JavaScript<br>See [Rules](#bot-defense-policy-js-insertion-rules-rules) below.
|
|
1482
|
+
|
|
1483
|
+
#### Bot Defense Policy Js Insertion Rules Exclude List
|
|
1484
|
+
|
|
1485
|
+
An [`exclude_list`](#bot-defense-policy-js-insertion-rules-exclude-list) block (within [`bot_defense.policy.js_insertion_rules`](#bot-defense-policy-js-insertion-rules)) supports the following:
|
|
1486
|
+
|
|
1487
|
+
<a id="bot-defense-policy-js-insertion-rules-exclude-list-any-domain"></a>• [`any_domain`](#bot-defense-policy-js-insertion-rules-exclude-list-any-domain) - Optional Block<br>Enable this option
|
|
1488
|
+
|
|
1489
|
+
<a id="bot-defense-policy-js-insertion-rules-exclude-list-domain"></a>• [`domain`](#bot-defense-policy-js-insertion-rules-exclude-list-domain) - Optional Block<br>Domains. Domains names<br>See [Domain](#bot-defense-policy-js-insertion-rules-exclude-list-domain) below.
|
|
1490
|
+
|
|
1491
|
+
<a id="bot-defense-policy-js-insertion-rules-exclude-list-metadata"></a>• [`metadata`](#bot-defense-policy-js-insertion-rules-exclude-list-metadata) - 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](#bot-defense-policy-js-insertion-rules-exclude-list-metadata) below.
|
|
1492
|
+
|
|
1493
|
+
<a id="bot-defense-policy-js-insertion-rules-exclude-list-path"></a>• [`path`](#bot-defense-policy-js-insertion-rules-exclude-list-path) - 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](#bot-defense-policy-js-insertion-rules-exclude-list-path) below.
|
|
1494
|
+
|
|
1495
|
+
#### Bot Defense Policy Js Insertion Rules Exclude List Domain
|
|
1496
|
+
|
|
1497
|
+
A [`domain`](#bot-defense-policy-js-insertion-rules-exclude-list-domain) block (within [`bot_defense.policy.js_insertion_rules.exclude_list`](#bot-defense-policy-js-insertion-rules-exclude-list)) supports the following:
|
|
1498
|
+
|
|
1499
|
+
<a id="bot-defense-policy-js-insertion-rules-exclude-list-domain-exact-value"></a>• [`exact_value`](#bot-defense-policy-js-insertion-rules-exclude-list-domain-exact-value) - Optional String<br>Exact Value. Exact domain name
|
|
1500
|
+
|
|
1501
|
+
<a id="bot-defense-policy-js-insertion-rules-exclude-list-domain-regex-value"></a>• [`regex_value`](#bot-defense-policy-js-insertion-rules-exclude-list-domain-regex-value) - Optional String<br>Regex Values of Domains. Regular Expression value for the domain name
|
|
1502
|
+
|
|
1503
|
+
<a id="bot-defense-policy-js-insertion-rules-exclude-list-domain-suffix-value"></a>• [`suffix_value`](#bot-defense-policy-js-insertion-rules-exclude-list-domain-suffix-value) - Optional String<br>Suffix Value. Suffix of domain name e.g 'xyz.com' will match '*.xyz.com' and 'xyz.com'
|
|
1504
|
+
|
|
1505
|
+
#### Bot Defense Policy Js Insertion Rules Exclude List Metadata
|
|
1506
|
+
|
|
1507
|
+
A [`metadata`](#bot-defense-policy-js-insertion-rules-exclude-list-metadata) block (within [`bot_defense.policy.js_insertion_rules.exclude_list`](#bot-defense-policy-js-insertion-rules-exclude-list)) supports the following:
|
|
1508
|
+
|
|
1509
|
+
<a id="bot-defense-policy-js-insertion-rules-exclude-list-metadata-description-spec"></a>• [`description_spec`](#bot-defense-policy-js-insertion-rules-exclude-list-metadata-description-spec) - Optional String<br>Description. Human readable description
|
|
1510
|
+
|
|
1511
|
+
<a id="bot-defense-policy-js-insertion-rules-exclude-list-metadata-name"></a>• [`name`](#bot-defense-policy-js-insertion-rules-exclude-list-metadata-name) - Optional String<br>Name. This is the name of the message. The value of name has to follow DNS-1035 format
|
|
1512
|
+
|
|
1513
|
+
#### Bot Defense Policy Js Insertion Rules Exclude List Path
|
|
1514
|
+
|
|
1515
|
+
A [`path`](#bot-defense-policy-js-insertion-rules-exclude-list-path) block (within [`bot_defense.policy.js_insertion_rules.exclude_list`](#bot-defense-policy-js-insertion-rules-exclude-list)) supports the following:
|
|
1516
|
+
|
|
1517
|
+
<a id="bot-defense-policy-js-insertion-rules-exclude-list-path-path"></a>• [`path`](#bot-defense-policy-js-insertion-rules-exclude-list-path-path) - Optional String<br>Exact. Exact path value to match
|
|
1518
|
+
|
|
1519
|
+
<a id="bot-defense-policy-js-insertion-rules-exclude-list-path-prefix"></a>• [`prefix`](#bot-defense-policy-js-insertion-rules-exclude-list-path-prefix) - Optional String<br>Prefix. Path prefix to match (e.g. the value / will match on all paths)
|
|
1520
|
+
|
|
1521
|
+
<a id="bot-defense-policy-js-insertion-rules-exclude-list-path-regex"></a>• [`regex`](#bot-defense-policy-js-insertion-rules-exclude-list-path-regex) - Optional String<br>Regex. Regular expression of path match (e.g. the value .* will match on all paths)
|
|
1522
|
+
|
|
1523
|
+
#### Bot Defense Policy Js Insertion Rules Rules
|
|
1524
|
+
|
|
1525
|
+
A [`rules`](#bot-defense-policy-js-insertion-rules-rules) block (within [`bot_defense.policy.js_insertion_rules`](#bot-defense-policy-js-insertion-rules)) supports the following:
|
|
1526
|
+
|
|
1527
|
+
<a id="bot-defense-policy-js-insertion-rules-rules-any-domain"></a>• [`any_domain`](#bot-defense-policy-js-insertion-rules-rules-any-domain) - Optional Block<br>Enable this option
|
|
1528
|
+
|
|
1529
|
+
<a id="bot-defense-policy-js-insertion-rules-rules-domain"></a>• [`domain`](#bot-defense-policy-js-insertion-rules-rules-domain) - Optional Block<br>Domains. Domains names<br>See [Domain](#bot-defense-policy-js-insertion-rules-rules-domain) below.
|
|
1530
|
+
|
|
1531
|
+
<a id="bot-defense-policy-js-insertion-rules-rules-javascript-location"></a>• [`javascript_location`](#bot-defense-policy-js-insertion-rules-rules-javascript-location) - 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
|
|
1532
|
+
|
|
1533
|
+
<a id="bot-defense-policy-js-insertion-rules-rules-metadata"></a>• [`metadata`](#bot-defense-policy-js-insertion-rules-rules-metadata) - 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](#bot-defense-policy-js-insertion-rules-rules-metadata) below.
|
|
1534
|
+
|
|
1535
|
+
<a id="bot-defense-policy-js-insertion-rules-rules-path"></a>• [`path`](#bot-defense-policy-js-insertion-rules-rules-path) - 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](#bot-defense-policy-js-insertion-rules-rules-path) below.
|
|
1536
|
+
|
|
1537
|
+
#### Bot Defense Policy Js Insertion Rules Rules Domain
|
|
1538
|
+
|
|
1539
|
+
A [`domain`](#bot-defense-policy-js-insertion-rules-rules-domain) block (within [`bot_defense.policy.js_insertion_rules.rules`](#bot-defense-policy-js-insertion-rules-rules)) supports the following:
|
|
1540
|
+
|
|
1541
|
+
<a id="bot-defense-policy-js-insertion-rules-rules-domain-exact-value"></a>• [`exact_value`](#bot-defense-policy-js-insertion-rules-rules-domain-exact-value) - Optional String<br>Exact Value. Exact domain name
|
|
1542
|
+
|
|
1543
|
+
<a id="bot-defense-policy-js-insertion-rules-rules-domain-regex-value"></a>• [`regex_value`](#bot-defense-policy-js-insertion-rules-rules-domain-regex-value) - Optional String<br>Regex Values of Domains. Regular Expression value for the domain name
|
|
1544
|
+
|
|
1545
|
+
<a id="bot-defense-policy-js-insertion-rules-rules-domain-suffix-value"></a>• [`suffix_value`](#bot-defense-policy-js-insertion-rules-rules-domain-suffix-value) - Optional String<br>Suffix Value. Suffix of domain name e.g 'xyz.com' will match '*.xyz.com' and 'xyz.com'
|
|
1546
|
+
|
|
1547
|
+
#### Bot Defense Policy Js Insertion Rules Rules Metadata
|
|
1548
|
+
|
|
1549
|
+
A [`metadata`](#bot-defense-policy-js-insertion-rules-rules-metadata) block (within [`bot_defense.policy.js_insertion_rules.rules`](#bot-defense-policy-js-insertion-rules-rules)) supports the following:
|
|
1550
|
+
|
|
1551
|
+
<a id="bot-defense-policy-js-insertion-rules-rules-metadata-description-spec"></a>• [`description_spec`](#bot-defense-policy-js-insertion-rules-rules-metadata-description-spec) - Optional String<br>Description. Human readable description
|
|
1552
|
+
|
|
1553
|
+
<a id="bot-defense-policy-js-insertion-rules-rules-metadata-name"></a>• [`name`](#bot-defense-policy-js-insertion-rules-rules-metadata-name) - Optional String<br>Name. This is the name of the message. The value of name has to follow DNS-1035 format
|
|
1554
|
+
|
|
1555
|
+
#### Bot Defense Policy Js Insertion Rules Rules Path
|
|
1556
|
+
|
|
1557
|
+
A [`path`](#bot-defense-policy-js-insertion-rules-rules-path) block (within [`bot_defense.policy.js_insertion_rules.rules`](#bot-defense-policy-js-insertion-rules-rules)) supports the following:
|
|
1558
|
+
|
|
1559
|
+
<a id="bot-defense-policy-js-insertion-rules-rules-path-path"></a>• [`path`](#bot-defense-policy-js-insertion-rules-rules-path-path) - Optional String<br>Exact. Exact path value to match
|
|
1560
|
+
|
|
1561
|
+
<a id="bot-defense-policy-js-insertion-rules-rules-path-prefix"></a>• [`prefix`](#bot-defense-policy-js-insertion-rules-rules-path-prefix) - Optional String<br>Prefix. Path prefix to match (e.g. the value / will match on all paths)
|
|
1562
|
+
|
|
1563
|
+
<a id="bot-defense-policy-js-insertion-rules-rules-path-regex"></a>• [`regex`](#bot-defense-policy-js-insertion-rules-rules-path-regex) - Optional String<br>Regex. Regular expression of path match (e.g. the value .* will match on all paths)
|
|
1564
|
+
|
|
1565
|
+
#### Bot Defense Policy Mobile Sdk Config
|
|
1566
|
+
|
|
1567
|
+
A [`mobile_sdk_config`](#bot-defense-policy-mobile-sdk-config) block (within [`bot_defense.policy`](#bot-defense-policy)) supports the following:
|
|
1568
|
+
|
|
1569
|
+
<a id="bot-defense-policy-mobile-sdk-config-mobile-identifier"></a>• [`mobile_identifier`](#bot-defense-policy-mobile-sdk-config-mobile-identifier) - Optional Block<br>Mobile Traffic Identifier. Mobile traffic identifier type<br>See [Mobile Identifier](#bot-defense-policy-mobile-sdk-config-mobile-identifier) below.
|
|
1570
|
+
|
|
1571
|
+
#### Bot Defense Policy Mobile Sdk Config Mobile Identifier
|
|
1572
|
+
|
|
1573
|
+
A [`mobile_identifier`](#bot-defense-policy-mobile-sdk-config-mobile-identifier) block (within [`bot_defense.policy.mobile_sdk_config`](#bot-defense-policy-mobile-sdk-config)) supports the following:
|
|
1574
|
+
|
|
1575
|
+
<a id="bot-defense-policy-mobile-sdk-config-mobile-identifier-headers"></a>• [`headers`](#bot-defense-policy-mobile-sdk-config-mobile-identifier-headers) - Optional Block<br>Headers. Headers that can be used to identify mobile traffic<br>See [Headers](#bot-defense-policy-mobile-sdk-config-mobile-identifier-headers) below.
|
|
1576
|
+
|
|
1577
|
+
#### Bot Defense Policy Mobile Sdk Config Mobile Identifier Headers
|
|
1578
|
+
|
|
1579
|
+
A [`headers`](#bot-defense-policy-mobile-sdk-config-mobile-identifier-headers) block (within [`bot_defense.policy.mobile_sdk_config.mobile_identifier`](#bot-defense-policy-mobile-sdk-config-mobile-identifier)) supports the following:
|
|
1580
|
+
|
|
1581
|
+
<a id="bot-defense-policy-mobile-sdk-config-mobile-identifier-headers-check-not-present"></a>• [`check_not_present`](#bot-defense-policy-mobile-sdk-config-mobile-identifier-headers-check-not-present) - Optional Block<br>Enable this option
|
|
1582
|
+
|
|
1583
|
+
<a id="bot-defense-policy-mobile-sdk-config-mobile-identifier-headers-check-present"></a>• [`check_present`](#bot-defense-policy-mobile-sdk-config-mobile-identifier-headers-check-present) - Optional Block<br>Enable this option
|
|
1584
|
+
|
|
1585
|
+
<a id="bot-defense-policy-mobile-sdk-config-mobile-identifier-headers-item"></a>• [`item`](#bot-defense-policy-mobile-sdk-config-mobile-identifier-headers-item) - 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](#bot-defense-policy-mobile-sdk-config-mobile-identifier-headers-item) below.
|
|
1586
|
+
|
|
1587
|
+
<a id="bot-defense-policy-mobile-sdk-config-mobile-identifier-headers-name"></a>• [`name`](#bot-defense-policy-mobile-sdk-config-mobile-identifier-headers-name) - Optional String<br>Header Name. A case-insensitive HTTP header name
|
|
1588
|
+
|
|
1589
|
+
#### Bot Defense Policy Mobile Sdk Config Mobile Identifier Headers Item
|
|
1590
|
+
|
|
1591
|
+
An [`item`](#bot-defense-policy-mobile-sdk-config-mobile-identifier-headers-item) block (within [`bot_defense.policy.mobile_sdk_config.mobile_identifier.headers`](#bot-defense-policy-mobile-sdk-config-mobile-identifier-headers)) supports the following:
|
|
1592
|
+
|
|
1593
|
+
<a id="bot-defense-policy-mobile-sdk-config-mobile-identifier-headers-item-exact-values"></a>• [`exact_values`](#bot-defense-policy-mobile-sdk-config-mobile-identifier-headers-item-exact-values) - Optional List<br>Exact Values. A list of exact values to match the input against
|
|
1594
|
+
|
|
1595
|
+
<a id="bot-defense-policy-mobile-sdk-config-mobile-identifier-headers-item-regex-values"></a>• [`regex_values`](#bot-defense-policy-mobile-sdk-config-mobile-identifier-headers-item-regex-values) - Optional List<br>Regex Values. A list of regular expressions to match the input against
|
|
1596
|
+
|
|
1597
|
+
<a id="bot-defense-policy-mobile-sdk-config-mobile-identifier-headers-item-transformers"></a>• [`transformers`](#bot-defense-policy-mobile-sdk-config-mobile-identifier-headers-item-transformers) - 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
|
|
1598
|
+
|
|
1599
|
+
#### Bot Defense Policy Protected App Endpoints
|
|
1600
|
+
|
|
1601
|
+
A [`protected_app_endpoints`](#bot-defense-policy-protected-app-endpoints) block (within [`bot_defense.policy`](#bot-defense-policy)) supports the following:
|
|
1602
|
+
|
|
1603
|
+
<a id="bot-defense-policy-protected-app-endpoints-allow-good-bots"></a>• [`allow_good_bots`](#bot-defense-policy-protected-app-endpoints-allow-good-bots) - Optional Block<br>Enable this option
|
|
1604
|
+
|
|
1605
|
+
<a id="bot-defense-policy-protected-app-endpoints-any-domain"></a>• [`any_domain`](#bot-defense-policy-protected-app-endpoints-any-domain) - Optional Block<br>Enable this option
|
|
1606
|
+
|
|
1607
|
+
<a id="bot-defense-policy-protected-app-endpoints-domain"></a>• [`domain`](#bot-defense-policy-protected-app-endpoints-domain) - Optional Block<br>Domains. Domains names<br>See [Domain](#bot-defense-policy-protected-app-endpoints-domain) below.
|
|
1608
|
+
|
|
1609
|
+
<a id="bot-defense-policy-protected-app-endpoints-flow-label"></a>• [`flow_label`](#bot-defense-policy-protected-app-endpoints-flow-label) - Optional Block<br>Bot Defense Flow Label Category. Bot Defense Flow Label Category allows to associate traffic with selected category<br>See [Flow Label](#bot-defense-policy-protected-app-endpoints-flow-label) below.
|
|
1610
|
+
|
|
1611
|
+
<a id="bot-defense-policy-protected-app-endpoints-headers"></a>• [`headers`](#bot-defense-policy-protected-app-endpoints-headers) - 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](#bot-defense-policy-protected-app-endpoints-headers) below.
|
|
1612
|
+
|
|
1613
|
+
<a id="bot-defense-policy-protected-app-endpoints-http-methods"></a>• [`http_methods`](#bot-defense-policy-protected-app-endpoints-http-methods) - Optional List Defaults to `METHOD_ANY`<br>Possible values are `METHOD_ANY`, `METHOD_GET`, `METHOD_POST`, `METHOD_PUT`, `METHOD_PATCH`, `METHOD_DELETE`, `METHOD_GET_DOCUMENT`<br>[Enum: METHOD_ANY|METHOD_GET|METHOD_POST|METHOD_PUT|METHOD_PATCH|METHOD_DELETE|METHOD_GET_DOCUMENT] HTTP Methods. List of HTTP methods
|
|
1614
|
+
|
|
1615
|
+
<a id="bot-defense-policy-protected-app-endpoints-metadata"></a>• [`metadata`](#bot-defense-policy-protected-app-endpoints-metadata) - 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](#bot-defense-policy-protected-app-endpoints-metadata) below.
|
|
1616
|
+
|
|
1617
|
+
<a id="bot-defense-policy-protected-app-endpoints-mitigate-good-bots"></a>• [`mitigate_good_bots`](#bot-defense-policy-protected-app-endpoints-mitigate-good-bots) - Optional Block<br>Enable this option
|
|
1618
|
+
|
|
1619
|
+
<a id="bot-defense-policy-protected-app-endpoints-mitigation"></a>• [`mitigation`](#bot-defense-policy-protected-app-endpoints-mitigation) - Optional Block<br>Bot Mitigation Action. Modify Bot Defense behavior for a matching request<br>See [Mitigation](#bot-defense-policy-protected-app-endpoints-mitigation) below.
|
|
1620
|
+
|
|
1621
|
+
<a id="bot-defense-policy-protected-app-endpoints-mobile"></a>• [`mobile`](#bot-defense-policy-protected-app-endpoints-mobile) - Optional Block<br>Enable this option
|
|
1622
|
+
|
|
1623
|
+
<a id="bot-defense-policy-protected-app-endpoints-path"></a>• [`path`](#bot-defense-policy-protected-app-endpoints-path) - 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](#bot-defense-policy-protected-app-endpoints-path) below.
|
|
1624
|
+
|
|
1625
|
+
<a id="bot-defense-policy-protected-app-endpoints-protocol"></a>• [`protocol`](#bot-defense-policy-protected-app-endpoints-protocol) - Optional String Defaults to `BOTH`<br>Possible values are `BOTH`, `HTTP`, `HTTPS`<br>[Enum: BOTH|HTTP|HTTPS] URL Scheme. SchemeType is used to indicate URL scheme. - BOTH: BOTH URL scheme for HTTPS:// or `HTTP://.` - HTTP: HTTP URL scheme HTTP:// only. - HTTPS: HTTPS URL scheme HTTPS:// only
|
|
1626
|
+
|
|
1627
|
+
<a id="bot-defense-policy-protected-app-endpoints-query-params"></a>• [`query_params`](#bot-defense-policy-protected-app-endpoints-query-params) - 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](#bot-defense-policy-protected-app-endpoints-query-params) below.
|
|
1628
|
+
|
|
1629
|
+
<a id="bot-defense-policy-protected-app-endpoints-undefined-flow-label"></a>• [`undefined_flow_label`](#bot-defense-policy-protected-app-endpoints-undefined-flow-label) - Optional Block<br>Enable this option
|
|
1630
|
+
|
|
1631
|
+
<a id="bot-defense-policy-protected-app-endpoints-web"></a>• [`web`](#bot-defense-policy-protected-app-endpoints-web) - Optional Block<br>Enable this option
|
|
1632
|
+
|
|
1633
|
+
<a id="bot-defense-policy-protected-app-endpoints-web-mobile"></a>• [`web_mobile`](#bot-defense-policy-protected-app-endpoints-web-mobile) - Optional Block<br>Web and Mobile traffic type. Web and Mobile traffic type<br>See [Web Mobile](#bot-defense-policy-protected-app-endpoints-web-mobile) below.
|
|
1634
|
+
|
|
1635
|
+
#### Bot Defense Policy Protected App Endpoints Domain
|
|
1636
|
+
|
|
1637
|
+
A [`domain`](#bot-defense-policy-protected-app-endpoints-domain) block (within [`bot_defense.policy.protected_app_endpoints`](#bot-defense-policy-protected-app-endpoints)) supports the following:
|
|
1638
|
+
|
|
1639
|
+
<a id="bot-defense-policy-protected-app-endpoints-domain-exact-value"></a>• [`exact_value`](#bot-defense-policy-protected-app-endpoints-domain-exact-value) - Optional String<br>Exact Value. Exact domain name
|
|
1640
|
+
|
|
1641
|
+
<a id="bot-defense-policy-protected-app-endpoints-domain-regex-value"></a>• [`regex_value`](#bot-defense-policy-protected-app-endpoints-domain-regex-value) - Optional String<br>Regex Values of Domains. Regular Expression value for the domain name
|
|
1642
|
+
|
|
1643
|
+
<a id="bot-defense-policy-protected-app-endpoints-domain-suffix-value"></a>• [`suffix_value`](#bot-defense-policy-protected-app-endpoints-domain-suffix-value) - Optional String<br>Suffix Value. Suffix of domain name e.g 'xyz.com' will match '*.xyz.com' and 'xyz.com'
|
|
1644
|
+
|
|
1645
|
+
#### Bot Defense Policy Protected App Endpoints Flow Label
|
|
1646
|
+
|
|
1647
|
+
A [`flow_label`](#bot-defense-policy-protected-app-endpoints-flow-label) block (within [`bot_defense.policy.protected_app_endpoints`](#bot-defense-policy-protected-app-endpoints)) supports the following:
|
|
1648
|
+
|
|
1649
|
+
<a id="bot-defense-policy-protected-app-endpoints-flow-label-account-management"></a>• [`account_management`](#bot-defense-policy-protected-app-endpoints-flow-label-account-management) - Optional Block<br>Bot Defense Flow Label Account Management Category. Bot Defense Flow Label Account Management Category<br>See [Account Management](#bot-defense-policy-protected-app-endpoints-flow-label-account-management) below.
|
|
1650
|
+
|
|
1651
|
+
<a id="bot-defense-policy-protected-app-endpoints-flow-label-authentication"></a>• [`authentication`](#bot-defense-policy-protected-app-endpoints-flow-label-authentication) - Optional Block<br>Bot Defense Flow Label Authentication Category. Bot Defense Flow Label Authentication Category<br>See [Authentication](#bot-defense-policy-protected-app-endpoints-flow-label-authentication) below.
|
|
1652
|
+
|
|
1653
|
+
<a id="bot-defense-policy-protected-app-endpoints-flow-label-financial-services"></a>• [`financial_services`](#bot-defense-policy-protected-app-endpoints-flow-label-financial-services) - Optional Block<br>Bot Defense Flow Label Financial Services Category. Bot Defense Flow Label Financial Services Category<br>See [Financial Services](#bot-defense-policy-protected-app-endpoints-flow-label-financial-services) below.
|
|
1654
|
+
|
|
1655
|
+
<a id="bot-defense-policy-protected-app-endpoints-flow-label-flight"></a>• [`flight`](#bot-defense-policy-protected-app-endpoints-flow-label-flight) - Optional Block<br>Bot Defense Flow Label Flight Category. Bot Defense Flow Label Flight Category<br>See [Flight](#bot-defense-policy-protected-app-endpoints-flow-label-flight) below.
|
|
1656
|
+
|
|
1657
|
+
<a id="bot-defense-policy-protected-app-endpoints-flow-label-profile-management"></a>• [`profile_management`](#bot-defense-policy-protected-app-endpoints-flow-label-profile-management) - Optional Block<br>Bot Defense Flow Label Profile Management Category. Bot Defense Flow Label Profile Management Category<br>See [Profile Management](#bot-defense-policy-protected-app-endpoints-flow-label-profile-management) below.
|
|
1658
|
+
|
|
1659
|
+
<a id="bot-defense-policy-protected-app-endpoints-flow-label-search"></a>• [`search`](#bot-defense-policy-protected-app-endpoints-flow-label-search) - Optional Block<br>Bot Defense Flow Label Search Category. Bot Defense Flow Label Search Category<br>See [Search](#bot-defense-policy-protected-app-endpoints-flow-label-search) below.
|
|
1660
|
+
|
|
1661
|
+
<a id="bot-defense-policy-protected-app-endpoints-flow-label-shopping-gift-cards"></a>• [`shopping_gift_cards`](#bot-defense-policy-protected-app-endpoints-flow-label-shopping-gift-cards) - Optional Block<br>Bot Defense Flow Label Shopping & Gift Cards Category. Bot Defense Flow Label Shopping & Gift Cards Category<br>See [Shopping Gift Cards](#bot-defense-policy-protected-app-endpoints-flow-label-shopping-gift-cards) below.
|
|
1662
|
+
|
|
1663
|
+
#### Bot Defense Policy Protected App Endpoints Flow Label Account Management
|
|
1664
|
+
|
|
1665
|
+
An [`account_management`](#bot-defense-policy-protected-app-endpoints-flow-label-account-management) block (within [`bot_defense.policy.protected_app_endpoints.flow_label`](#bot-defense-policy-protected-app-endpoints-flow-label)) supports the following:
|
|
1666
|
+
|
|
1667
|
+
<a id="bot-defense-policy-protected-app-endpoints-flow-label-account-management-create"></a>• [`create`](#bot-defense-policy-protected-app-endpoints-flow-label-account-management-create) - Optional Block<br>Enable this option
|
|
1668
|
+
|
|
1669
|
+
<a id="bot-defense-policy-protected-app-endpoints-flow-label-account-management-password-reset"></a>• [`password_reset`](#bot-defense-policy-protected-app-endpoints-flow-label-account-management-password-reset) - Optional Block<br>Enable this option
|
|
1670
|
+
|
|
1671
|
+
#### Bot Defense Policy Protected App Endpoints Flow Label Authentication
|
|
1672
|
+
|
|
1673
|
+
An [`authentication`](#bot-defense-policy-protected-app-endpoints-flow-label-authentication) block (within [`bot_defense.policy.protected_app_endpoints.flow_label`](#bot-defense-policy-protected-app-endpoints-flow-label)) supports the following:
|
|
1674
|
+
|
|
1675
|
+
<a id="bot-defense-policy-protected-app-endpoints-flow-label-authentication-login"></a>• [`login`](#bot-defense-policy-protected-app-endpoints-flow-label-authentication-login) - Optional Block<br>Bot Defense Transaction Result. Bot Defense Transaction Result<br>See [Login](#bot-defense-policy-protected-app-endpoints-flow-label-authentication-login) below.
|
|
1676
|
+
|
|
1677
|
+
<a id="bot-defense-policy-protected-app-endpoints-flow-label-authentication-login-mfa"></a>• [`login_mfa`](#bot-defense-policy-protected-app-endpoints-flow-label-authentication-login-mfa) - Optional Block<br>Enable this option
|
|
1678
|
+
|
|
1679
|
+
<a id="bot-defense-policy-protected-app-endpoints-flow-label-authentication-login-partner"></a>• [`login_partner`](#bot-defense-policy-protected-app-endpoints-flow-label-authentication-login-partner) - Optional Block<br>Enable this option
|
|
1680
|
+
|
|
1681
|
+
<a id="bot-defense-policy-protected-app-endpoints-flow-label-authentication-logout"></a>• [`logout`](#bot-defense-policy-protected-app-endpoints-flow-label-authentication-logout) - Optional Block<br>Enable this option
|
|
1682
|
+
|
|
1683
|
+
<a id="bot-defense-policy-protected-app-endpoints-flow-label-authentication-token-refresh"></a>• [`token_refresh`](#bot-defense-policy-protected-app-endpoints-flow-label-authentication-token-refresh) - Optional Block<br>Enable this option
|
|
1684
|
+
|
|
1685
|
+
#### Bot Defense Policy Protected App Endpoints Flow Label Authentication Login
|
|
1686
|
+
|
|
1687
|
+
A [`login`](#bot-defense-policy-protected-app-endpoints-flow-label-authentication-login) block (within [`bot_defense.policy.protected_app_endpoints.flow_label.authentication`](#bot-defense-policy-protected-app-endpoints-flow-label-authentication)) supports the following:
|
|
1688
|
+
|
|
1689
|
+
<a id="bot-defense-policy-protected-app-endpoints-flow-label-authentication-login-disable-transaction-result"></a>• [`disable_transaction_result`](#bot-defense-policy-protected-app-endpoints-flow-label-authentication-login-disable-transaction-result) - Optional Block<br>Enable this option
|
|
1690
|
+
|
|
1691
|
+
<a id="bot-defense-policy-protected-app-endpoints-flow-label-authentication-login-transaction-result"></a>• [`transaction_result`](#bot-defense-policy-protected-app-endpoints-flow-label-authentication-login-transaction-result) - Optional Block<br>Bot Defense Transaction Result Type. Bot Defense Transaction ResultType<br>See [Transaction Result](#bot-defense-policy-protected-app-endpoints-flow-label-authentication-login-transaction-result) below.
|
|
1692
|
+
|
|
1693
|
+
#### Bot Defense Policy Protected App Endpoints Flow Label Authentication Login Transaction Result
|
|
1694
|
+
|
|
1695
|
+
A [`transaction_result`](#bot-defense-policy-protected-app-endpoints-flow-label-authentication-login-transaction-result) block (within [`bot_defense.policy.protected_app_endpoints.flow_label.authentication.login`](#bot-defense-policy-protected-app-endpoints-flow-label-authentication-login)) supports the following:
|
|
1696
|
+
|
|
1697
|
+
<a id="bot-defense-policy-protected-app-endpoints-flow-label-authentication-login-transaction-result-failure-conditions"></a>• [`failure_conditions`](#bot-defense-policy-protected-app-endpoints-flow-label-authentication-login-transaction-result-failure-conditions) - Optional Block<br>Failure Conditions. Failure Conditions<br>See [Failure Conditions](#bot-defense-policy-protected-app-endpoints-flow-label-authentication-login-transaction-result-failure-conditions) below.
|
|
1698
|
+
|
|
1699
|
+
<a id="bot-defense-policy-protected-app-endpoints-flow-label-authentication-login-transaction-result-success-conditions"></a>• [`success_conditions`](#bot-defense-policy-protected-app-endpoints-flow-label-authentication-login-transaction-result-success-conditions) - Optional Block<br>Success Conditions. Success Conditions<br>See [Success Conditions](#bot-defense-policy-protected-app-endpoints-flow-label-authentication-login-transaction-result-success-conditions) below.
|
|
1700
|
+
|
|
1701
|
+
#### Bot Defense Policy Protected App Endpoints Flow Label Authentication Login Transaction Result Failure Conditions
|
|
1702
|
+
|
|
1703
|
+
A [`failure_conditions`](#bot-defense-policy-protected-app-endpoints-flow-label-authentication-login-transaction-result-failure-conditions) block (within [`bot_defense.policy.protected_app_endpoints.flow_label.authentication.login.transaction_result`](#bot-defense-policy-protected-app-endpoints-flow-label-authentication-login-transaction-result)) supports the following:
|
|
1704
|
+
|
|
1705
|
+
<a id="bot-defense-policy-protected-app-endpoints-flow-label-authentication-login-transaction-result-failure-conditions-name"></a>• [`name`](#bot-defense-policy-protected-app-endpoints-flow-label-authentication-login-transaction-result-failure-conditions-name) - Optional String<br>Header Name. A case-insensitive HTTP header name
|
|
1706
|
+
|
|
1707
|
+
<a id="bot-defense-policy-protected-app-endpoints-flow-label-authentication-login-transaction-result-failure-conditions-regex-values"></a>• [`regex_values`](#bot-defense-policy-protected-app-endpoints-flow-label-authentication-login-transaction-result-failure-conditions-regex-values) - Optional List<br>Regex Values. A list of regular expressions to match the input against
|
|
1708
|
+
|
|
1709
|
+
<a id="bot-defense-policy-protected-app-endpoints-flow-label-authentication-login-transaction-result-failure-conditions-status"></a>• [`status`](#bot-defense-policy-protected-app-endpoints-flow-label-authentication-login-transaction-result-failure-conditions-status) - 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
|
|
1710
|
+
|
|
1711
|
+
#### Bot Defense Policy Protected App Endpoints Flow Label Authentication Login Transaction Result Success Conditions
|
|
1712
|
+
|
|
1713
|
+
A [`success_conditions`](#bot-defense-policy-protected-app-endpoints-flow-label-authentication-login-transaction-result-success-conditions) block (within [`bot_defense.policy.protected_app_endpoints.flow_label.authentication.login.transaction_result`](#bot-defense-policy-protected-app-endpoints-flow-label-authentication-login-transaction-result)) supports the following:
|
|
1714
|
+
|
|
1715
|
+
<a id="bot-defense-policy-protected-app-endpoints-flow-label-authentication-login-transaction-result-success-conditions-name"></a>• [`name`](#bot-defense-policy-protected-app-endpoints-flow-label-authentication-login-transaction-result-success-conditions-name) - Optional String<br>Header Name. A case-insensitive HTTP header name
|
|
1716
|
+
|
|
1717
|
+
<a id="bot-defense-policy-protected-app-endpoints-flow-label-authentication-login-transaction-result-success-conditions-regex-values"></a>• [`regex_values`](#bot-defense-policy-protected-app-endpoints-flow-label-authentication-login-transaction-result-success-conditions-regex-values) - Optional List<br>Regex Values. A list of regular expressions to match the input against
|
|
1718
|
+
|
|
1719
|
+
<a id="bot-defense-policy-protected-app-endpoints-flow-label-authentication-login-transaction-result-success-conditions-status"></a>• [`status`](#bot-defense-policy-protected-app-endpoints-flow-label-authentication-login-transaction-result-success-conditions-status) - 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
|
|
1720
|
+
|
|
1721
|
+
#### Bot Defense Policy Protected App Endpoints Flow Label Financial Services
|
|
1722
|
+
|
|
1723
|
+
A [`financial_services`](#bot-defense-policy-protected-app-endpoints-flow-label-financial-services) block (within [`bot_defense.policy.protected_app_endpoints.flow_label`](#bot-defense-policy-protected-app-endpoints-flow-label)) supports the following:
|
|
1724
|
+
|
|
1725
|
+
<a id="bot-defense-policy-protected-app-endpoints-flow-label-financial-services-apply"></a>• [`apply`](#bot-defense-policy-protected-app-endpoints-flow-label-financial-services-apply) - Optional Block<br>Enable this option
|
|
1726
|
+
|
|
1727
|
+
<a id="bot-defense-policy-protected-app-endpoints-flow-label-financial-services-money-transfer"></a>• [`money_transfer`](#bot-defense-policy-protected-app-endpoints-flow-label-financial-services-money-transfer) - Optional Block<br>Enable this option
|
|
1728
|
+
|
|
1729
|
+
#### Bot Defense Policy Protected App Endpoints Flow Label Flight
|
|
1730
|
+
|
|
1731
|
+
A [`flight`](#bot-defense-policy-protected-app-endpoints-flow-label-flight) block (within [`bot_defense.policy.protected_app_endpoints.flow_label`](#bot-defense-policy-protected-app-endpoints-flow-label)) supports the following:
|
|
1732
|
+
|
|
1733
|
+
<a id="bot-defense-policy-protected-app-endpoints-flow-label-flight-checkin"></a>• [`checkin`](#bot-defense-policy-protected-app-endpoints-flow-label-flight-checkin) - Optional Block<br>Enable this option
|
|
1734
|
+
|
|
1735
|
+
#### Bot Defense Policy Protected App Endpoints Flow Label Profile Management
|
|
1736
|
+
|
|
1737
|
+
A [`profile_management`](#bot-defense-policy-protected-app-endpoints-flow-label-profile-management) block (within [`bot_defense.policy.protected_app_endpoints.flow_label`](#bot-defense-policy-protected-app-endpoints-flow-label)) supports the following:
|
|
1738
|
+
|
|
1739
|
+
<a id="bot-defense-policy-protected-app-endpoints-flow-label-profile-management-create"></a>• [`create`](#bot-defense-policy-protected-app-endpoints-flow-label-profile-management-create) - Optional Block<br>Enable this option
|
|
1740
|
+
|
|
1741
|
+
<a id="bot-defense-policy-protected-app-endpoints-flow-label-profile-management-update"></a>• [`update`](#bot-defense-policy-protected-app-endpoints-flow-label-profile-management-update) - Optional Block<br>Enable this option
|
|
1742
|
+
|
|
1743
|
+
<a id="bot-defense-policy-protected-app-endpoints-flow-label-profile-management-view"></a>• [`view`](#bot-defense-policy-protected-app-endpoints-flow-label-profile-management-view) - Optional Block<br>Enable this option
|
|
1744
|
+
|
|
1745
|
+
#### Bot Defense Policy Protected App Endpoints Flow Label Search
|
|
1746
|
+
|
|
1747
|
+
A [`search`](#bot-defense-policy-protected-app-endpoints-flow-label-search) block (within [`bot_defense.policy.protected_app_endpoints.flow_label`](#bot-defense-policy-protected-app-endpoints-flow-label)) supports the following:
|
|
1748
|
+
|
|
1749
|
+
<a id="bot-defense-policy-protected-app-endpoints-flow-label-search-flight-search"></a>• [`flight_search`](#bot-defense-policy-protected-app-endpoints-flow-label-search-flight-search) - Optional Block<br>Enable this option
|
|
1750
|
+
|
|
1751
|
+
<a id="bot-defense-policy-protected-app-endpoints-flow-label-search-product-search"></a>• [`product_search`](#bot-defense-policy-protected-app-endpoints-flow-label-search-product-search) - Optional Block<br>Enable this option
|
|
1752
|
+
|
|
1753
|
+
<a id="bot-defense-policy-protected-app-endpoints-flow-label-search-reservation-search"></a>• [`reservation_search`](#bot-defense-policy-protected-app-endpoints-flow-label-search-reservation-search) - Optional Block<br>Enable this option
|
|
1754
|
+
|
|
1755
|
+
<a id="bot-defense-policy-protected-app-endpoints-flow-label-search-room-search"></a>• [`room_search`](#bot-defense-policy-protected-app-endpoints-flow-label-search-room-search) - Optional Block<br>Enable this option
|
|
1756
|
+
|
|
1757
|
+
#### Bot Defense Policy Protected App Endpoints Flow Label Shopping Gift Cards
|
|
1758
|
+
|
|
1759
|
+
A [`shopping_gift_cards`](#bot-defense-policy-protected-app-endpoints-flow-label-shopping-gift-cards) block (within [`bot_defense.policy.protected_app_endpoints.flow_label`](#bot-defense-policy-protected-app-endpoints-flow-label)) supports the following:
|
|
1760
|
+
|
|
1761
|
+
<a id="bot-defense-policy-protected-app-endpoints-flow-label-shopping-gift-cards-gift-card-make-purchase-with-gift-card"></a>• [`gift_card_make_purchase_with_gift_card`](#bot-defense-policy-protected-app-endpoints-flow-label-shopping-gift-cards-gift-card-make-purchase-with-gift-card) - Optional Block<br>Enable this option
|
|
1762
|
+
|
|
1763
|
+
<a id="bot-defense-policy-protected-app-endpoints-flow-label-shopping-gift-cards-gift-card-validation"></a>• [`gift_card_validation`](#bot-defense-policy-protected-app-endpoints-flow-label-shopping-gift-cards-gift-card-validation) - Optional Block<br>Enable this option
|
|
1764
|
+
|
|
1765
|
+
<a id="bot-defense-policy-protected-app-endpoints-flow-label-shopping-gift-cards-shop-add-to-cart"></a>• [`shop_add_to_cart`](#bot-defense-policy-protected-app-endpoints-flow-label-shopping-gift-cards-shop-add-to-cart) - Optional Block<br>Enable this option
|
|
1766
|
+
|
|
1767
|
+
<a id="bot-defense-policy-protected-app-endpoints-flow-label-shopping-gift-cards-shop-checkout"></a>• [`shop_checkout`](#bot-defense-policy-protected-app-endpoints-flow-label-shopping-gift-cards-shop-checkout) - Optional Block<br>Enable this option
|
|
1768
|
+
|
|
1769
|
+
<a id="bot-defense-policy-protected-app-endpoints-flow-label-shopping-gift-cards-shop-choose-seat"></a>• [`shop_choose_seat`](#bot-defense-policy-protected-app-endpoints-flow-label-shopping-gift-cards-shop-choose-seat) - Optional Block<br>Enable this option
|
|
1770
|
+
|
|
1771
|
+
<a id="bot-defense-policy-protected-app-endpoints-flow-label-shopping-gift-cards-shop-enter-drawing-submission"></a>• [`shop_enter_drawing_submission`](#bot-defense-policy-protected-app-endpoints-flow-label-shopping-gift-cards-shop-enter-drawing-submission) - Optional Block<br>Enable this option
|
|
1772
|
+
|
|
1773
|
+
<a id="bot-defense-policy-protected-app-endpoints-flow-label-shopping-gift-cards-shop-make-payment"></a>• [`shop_make_payment`](#bot-defense-policy-protected-app-endpoints-flow-label-shopping-gift-cards-shop-make-payment) - Optional Block<br>Enable this option
|
|
1774
|
+
|
|
1775
|
+
<a id="bot-defense-policy-protected-app-endpoints-flow-label-shopping-gift-cards-shop-order"></a>• [`shop_order`](#bot-defense-policy-protected-app-endpoints-flow-label-shopping-gift-cards-shop-order) - Optional Block<br>Enable this option
|
|
1776
|
+
|
|
1777
|
+
<a id="bot-defense-policy-protected-app-endpoints-flow-label-shopping-gift-cards-shop-price-inquiry"></a>• [`shop_price_inquiry`](#bot-defense-policy-protected-app-endpoints-flow-label-shopping-gift-cards-shop-price-inquiry) - Optional Block<br>Enable this option
|
|
1778
|
+
|
|
1779
|
+
<a id="bot-defense-policy-protected-app-endpoints-flow-label-shopping-gift-cards-shop-promo-code-validation"></a>• [`shop_promo_code_validation`](#bot-defense-policy-protected-app-endpoints-flow-label-shopping-gift-cards-shop-promo-code-validation) - Optional Block<br>Enable this option
|
|
1780
|
+
|
|
1781
|
+
<a id="bot-defense-policy-protected-app-endpoints-flow-label-shopping-gift-cards-shop-purchase-gift-card"></a>• [`shop_purchase_gift_card`](#bot-defense-policy-protected-app-endpoints-flow-label-shopping-gift-cards-shop-purchase-gift-card) - Optional Block<br>Enable this option
|
|
1782
|
+
|
|
1783
|
+
<a id="bot-defense-policy-protected-app-endpoints-flow-label-shopping-gift-cards-shop-update-quantity"></a>• [`shop_update_quantity`](#bot-defense-policy-protected-app-endpoints-flow-label-shopping-gift-cards-shop-update-quantity) - Optional Block<br>Enable this option
|
|
1784
|
+
|
|
1785
|
+
#### Bot Defense Policy Protected App Endpoints Headers
|
|
1786
|
+
|
|
1787
|
+
A [`headers`](#bot-defense-policy-protected-app-endpoints-headers) block (within [`bot_defense.policy.protected_app_endpoints`](#bot-defense-policy-protected-app-endpoints)) supports the following:
|
|
1788
|
+
|
|
1789
|
+
<a id="bot-defense-policy-protected-app-endpoints-headers-check-not-present"></a>• [`check_not_present`](#bot-defense-policy-protected-app-endpoints-headers-check-not-present) - Optional Block<br>Enable this option
|
|
1790
|
+
|
|
1791
|
+
<a id="bot-defense-policy-protected-app-endpoints-headers-check-present"></a>• [`check_present`](#bot-defense-policy-protected-app-endpoints-headers-check-present) - Optional Block<br>Enable this option
|
|
1792
|
+
|
|
1793
|
+
<a id="bot-defense-policy-protected-app-endpoints-headers-invert-matcher"></a>• [`invert_matcher`](#bot-defense-policy-protected-app-endpoints-headers-invert-matcher) - Optional Bool<br>Invert Header Matcher. Invert the match result
|
|
1794
|
+
|
|
1795
|
+
<a id="bot-defense-policy-protected-app-endpoints-headers-item"></a>• [`item`](#bot-defense-policy-protected-app-endpoints-headers-item) - 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](#bot-defense-policy-protected-app-endpoints-headers-item) below.
|
|
1796
|
+
|
|
1797
|
+
<a id="bot-defense-policy-protected-app-endpoints-headers-name"></a>• [`name`](#bot-defense-policy-protected-app-endpoints-headers-name) - Optional String<br>Header Name. A case-insensitive HTTP header name
|
|
1798
|
+
|
|
1799
|
+
#### Bot Defense Policy Protected App Endpoints Headers Item
|
|
1800
|
+
|
|
1801
|
+
An [`item`](#bot-defense-policy-protected-app-endpoints-headers-item) block (within [`bot_defense.policy.protected_app_endpoints.headers`](#bot-defense-policy-protected-app-endpoints-headers)) supports the following:
|
|
1802
|
+
|
|
1803
|
+
<a id="bot-defense-policy-protected-app-endpoints-headers-item-exact-values"></a>• [`exact_values`](#bot-defense-policy-protected-app-endpoints-headers-item-exact-values) - Optional List<br>Exact Values. A list of exact values to match the input against
|
|
1804
|
+
|
|
1805
|
+
<a id="bot-defense-policy-protected-app-endpoints-headers-item-regex-values"></a>• [`regex_values`](#bot-defense-policy-protected-app-endpoints-headers-item-regex-values) - Optional List<br>Regex Values. A list of regular expressions to match the input against
|
|
1806
|
+
|
|
1807
|
+
<a id="bot-defense-policy-protected-app-endpoints-headers-item-transformers"></a>• [`transformers`](#bot-defense-policy-protected-app-endpoints-headers-item-transformers) - 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
|
|
1808
|
+
|
|
1809
|
+
#### Bot Defense Policy Protected App Endpoints Metadata
|
|
1810
|
+
|
|
1811
|
+
A [`metadata`](#bot-defense-policy-protected-app-endpoints-metadata) block (within [`bot_defense.policy.protected_app_endpoints`](#bot-defense-policy-protected-app-endpoints)) supports the following:
|
|
1812
|
+
|
|
1813
|
+
<a id="bot-defense-policy-protected-app-endpoints-metadata-description-spec"></a>• [`description_spec`](#bot-defense-policy-protected-app-endpoints-metadata-description-spec) - Optional String<br>Description. Human readable description
|
|
1814
|
+
|
|
1815
|
+
<a id="bot-defense-policy-protected-app-endpoints-metadata-name"></a>• [`name`](#bot-defense-policy-protected-app-endpoints-metadata-name) - Optional String<br>Name. This is the name of the message. The value of name has to follow DNS-1035 format
|
|
1816
|
+
|
|
1817
|
+
#### Bot Defense Policy Protected App Endpoints Mitigation
|
|
1818
|
+
|
|
1819
|
+
A [`mitigation`](#bot-defense-policy-protected-app-endpoints-mitigation) block (within [`bot_defense.policy.protected_app_endpoints`](#bot-defense-policy-protected-app-endpoints)) supports the following:
|
|
1820
|
+
|
|
1821
|
+
<a id="bot-defense-policy-protected-app-endpoints-mitigation-block"></a>• [`block`](#bot-defense-policy-protected-app-endpoints-mitigation-block) - Optional Block<br>Block bot mitigation. Block request and respond with custom content<br>See [Block](#bot-defense-policy-protected-app-endpoints-mitigation-block) below.
|
|
1822
|
+
|
|
1823
|
+
<a id="bot-defense-policy-protected-app-endpoints-mitigation-flag"></a>• [`flag`](#bot-defense-policy-protected-app-endpoints-mitigation-flag) - Optional Block<br>Select Flag Bot Mitigation Action. Flag mitigation action<br>See [Flag](#bot-defense-policy-protected-app-endpoints-mitigation-flag) below.
|
|
1824
|
+
|
|
1825
|
+
<a id="bot-defense-policy-protected-app-endpoints-mitigation-redirect"></a>• [`redirect`](#bot-defense-policy-protected-app-endpoints-mitigation-redirect) - Optional Block<br>Redirect bot mitigation. Redirect request to a custom URI<br>See [Redirect](#bot-defense-policy-protected-app-endpoints-mitigation-redirect) below.
|
|
1826
|
+
|
|
1827
|
+
#### Bot Defense Policy Protected App Endpoints Mitigation Block
|
|
1828
|
+
|
|
1829
|
+
A [`block`](#bot-defense-policy-protected-app-endpoints-mitigation-block) block (within [`bot_defense.policy.protected_app_endpoints.mitigation`](#bot-defense-policy-protected-app-endpoints-mitigation)) supports the following:
|
|
1830
|
+
|
|
1831
|
+
<a id="bot-defense-policy-protected-app-endpoints-mitigation-block-body"></a>• [`body`](#bot-defense-policy-protected-app-endpoints-mitigation-block-body) - 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="bot-defense-policy-protected-app-endpoints-mitigation-block-status"></a>• [`status`](#bot-defense-policy-protected-app-endpoints-mitigation-block-status) - 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
|
|
1834
|
+
|
|
1835
|
+
#### Bot Defense Policy Protected App Endpoints Mitigation Flag
|
|
1836
|
+
|
|
1837
|
+
A [`flag`](#bot-defense-policy-protected-app-endpoints-mitigation-flag) block (within [`bot_defense.policy.protected_app_endpoints.mitigation`](#bot-defense-policy-protected-app-endpoints-mitigation)) supports the following:
|
|
1838
|
+
|
|
1839
|
+
<a id="bot-defense-policy-protected-app-endpoints-mitigation-flag-append-headers"></a>• [`append_headers`](#bot-defense-policy-protected-app-endpoints-mitigation-flag-append-headers) - Optional Block<br>Append Flag Mitigation Headers. Append flag mitigation headers to forwarded request<br>See [Append Headers](#bot-defense-policy-protected-app-endpoints-mitigation-flag-append-headers) below.
|
|
1840
|
+
|
|
1841
|
+
<a id="bot-defense-policy-protected-app-endpoints-mitigation-flag-no-headers"></a>• [`no_headers`](#bot-defense-policy-protected-app-endpoints-mitigation-flag-no-headers) - Optional Block<br>Enable this option
|
|
1842
|
+
|
|
1843
|
+
#### Bot Defense Policy Protected App Endpoints Mitigation Flag Append Headers
|
|
1844
|
+
|
|
1845
|
+
An [`append_headers`](#bot-defense-policy-protected-app-endpoints-mitigation-flag-append-headers) block (within [`bot_defense.policy.protected_app_endpoints.mitigation.flag`](#bot-defense-policy-protected-app-endpoints-mitigation-flag)) supports the following:
|
|
1846
|
+
|
|
1847
|
+
<a id="bot-defense-policy-protected-app-endpoints-mitigation-flag-append-headers-auto-type-header-name"></a>• [`auto_type_header_name`](#bot-defense-policy-protected-app-endpoints-mitigation-flag-append-headers-auto-type-header-name) - Optional String<br>Automation Type Header Name. A case-insensitive HTTP header name
|
|
1848
|
+
|
|
1849
|
+
<a id="bot-defense-policy-protected-app-endpoints-mitigation-flag-append-headers-inference-header-name"></a>• [`inference_header_name`](#bot-defense-policy-protected-app-endpoints-mitigation-flag-append-headers-inference-header-name) - Optional String<br>Inference Header Name. A case-insensitive HTTP header name
|
|
1850
|
+
|
|
1851
|
+
#### Bot Defense Policy Protected App Endpoints Mitigation Redirect
|
|
1852
|
+
|
|
1853
|
+
A [`redirect`](#bot-defense-policy-protected-app-endpoints-mitigation-redirect) block (within [`bot_defense.policy.protected_app_endpoints.mitigation`](#bot-defense-policy-protected-app-endpoints-mitigation)) supports the following:
|
|
1854
|
+
|
|
1855
|
+
<a id="bot-defense-policy-protected-app-endpoints-mitigation-redirect-uri"></a>• [`uri`](#bot-defense-policy-protected-app-endpoints-mitigation-redirect-uri) - Optional String<br>URI. URI location for redirect may be relative or absolute
|
|
1856
|
+
|
|
1857
|
+
#### Bot Defense Policy Protected App Endpoints Path
|
|
1858
|
+
|
|
1859
|
+
A [`path`](#bot-defense-policy-protected-app-endpoints-path) block (within [`bot_defense.policy.protected_app_endpoints`](#bot-defense-policy-protected-app-endpoints)) supports the following:
|
|
1860
|
+
|
|
1861
|
+
<a id="bot-defense-policy-protected-app-endpoints-path-path"></a>• [`path`](#bot-defense-policy-protected-app-endpoints-path-path) - Optional String<br>Exact. Exact path value to match
|
|
1862
|
+
|
|
1863
|
+
<a id="bot-defense-policy-protected-app-endpoints-path-prefix"></a>• [`prefix`](#bot-defense-policy-protected-app-endpoints-path-prefix) - Optional String<br>Prefix. Path prefix to match (e.g. the value / will match on all paths)
|
|
1864
|
+
|
|
1865
|
+
<a id="bot-defense-policy-protected-app-endpoints-path-regex"></a>• [`regex`](#bot-defense-policy-protected-app-endpoints-path-regex) - Optional String<br>Regex. Regular expression of path match (e.g. the value .* will match on all paths)
|
|
1866
|
+
|
|
1867
|
+
#### Bot Defense Policy Protected App Endpoints Query Params
|
|
1868
|
+
|
|
1869
|
+
A [`query_params`](#bot-defense-policy-protected-app-endpoints-query-params) block (within [`bot_defense.policy.protected_app_endpoints`](#bot-defense-policy-protected-app-endpoints)) supports the following:
|
|
1870
|
+
|
|
1871
|
+
<a id="bot-defense-policy-protected-app-endpoints-query-params-check-not-present"></a>• [`check_not_present`](#bot-defense-policy-protected-app-endpoints-query-params-check-not-present) - Optional Block<br>Enable this option
|
|
1872
|
+
|
|
1873
|
+
<a id="bot-defense-policy-protected-app-endpoints-query-params-check-present"></a>• [`check_present`](#bot-defense-policy-protected-app-endpoints-query-params-check-present) - Optional Block<br>Enable this option
|
|
1874
|
+
|
|
1875
|
+
<a id="bot-defense-policy-protected-app-endpoints-query-params-invert-matcher"></a>• [`invert_matcher`](#bot-defense-policy-protected-app-endpoints-query-params-invert-matcher) - Optional Bool<br>Invert Query Parameter Matcher. Invert the match result
|
|
1876
|
+
|
|
1877
|
+
<a id="bot-defense-policy-protected-app-endpoints-query-params-item"></a>• [`item`](#bot-defense-policy-protected-app-endpoints-query-params-item) - 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](#bot-defense-policy-protected-app-endpoints-query-params-item) below.
|
|
1878
|
+
|
|
1879
|
+
<a id="bot-defense-policy-protected-app-endpoints-query-params-key"></a>• [`key`](#bot-defense-policy-protected-app-endpoints-query-params-key) - Optional String<br>Query Parameter Name. A case-sensitive HTTP query parameter name
|
|
1880
|
+
|
|
1881
|
+
#### Bot Defense Policy Protected App Endpoints Query Params Item
|
|
1882
|
+
|
|
1883
|
+
An [`item`](#bot-defense-policy-protected-app-endpoints-query-params-item) block (within [`bot_defense.policy.protected_app_endpoints.query_params`](#bot-defense-policy-protected-app-endpoints-query-params)) supports the following:
|
|
1884
|
+
|
|
1885
|
+
<a id="bot-defense-policy-protected-app-endpoints-query-params-item-exact-values"></a>• [`exact_values`](#bot-defense-policy-protected-app-endpoints-query-params-item-exact-values) - Optional List<br>Exact Values. A list of exact values to match the input against
|
|
1886
|
+
|
|
1887
|
+
<a id="bot-defense-policy-protected-app-endpoints-query-params-item-regex-values"></a>• [`regex_values`](#bot-defense-policy-protected-app-endpoints-query-params-item-regex-values) - Optional List<br>Regex Values. A list of regular expressions to match the input against
|
|
1888
|
+
|
|
1889
|
+
<a id="bot-defense-policy-protected-app-endpoints-query-params-item-transformers"></a>• [`transformers`](#bot-defense-policy-protected-app-endpoints-query-params-item-transformers) - 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
|
|
1890
|
+
|
|
1891
|
+
#### Bot Defense Policy Protected App Endpoints Web Mobile
|
|
1892
|
+
|
|
1893
|
+
A [`web_mobile`](#bot-defense-policy-protected-app-endpoints-web-mobile) block (within [`bot_defense.policy.protected_app_endpoints`](#bot-defense-policy-protected-app-endpoints)) supports the following:
|
|
1894
|
+
|
|
1895
|
+
<a id="bot-defense-policy-protected-app-endpoints-web-mobile-mobile-identifier"></a>• [`mobile_identifier`](#bot-defense-policy-protected-app-endpoints-web-mobile-mobile-identifier) - Optional String Defaults to `HEADERS`<br>[Enum: HEADERS] Mobile Identifier. Mobile identifier type - HEADERS: Headers Headers. The only possible value is `HEADERS`
|
|
1896
|
+
|
|
1897
|
+
#### Captcha Challenge
|
|
1898
|
+
|
|
1899
|
+
A [`captcha_challenge`](#captcha-challenge) block supports the following:
|
|
1900
|
+
|
|
1901
|
+
<a id="captcha-challenge-cookie-expiry"></a>• [`cookie_expiry`](#captcha-challenge-cookie-expiry) - Optional Number<br>Cookie Expiration Period. Cookie expiration period, in seconds. An expired cookie causes the loadbalancer to issue a new challenge
|
|
1902
|
+
|
|
1903
|
+
<a id="captcha-challenge-custom-page"></a>• [`custom_page`](#captcha-challenge-custom-page) - Optional String<br>Custom message for Captcha Challenge. Custom 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. 'Please Wait.' or it can be HTML paragraph or a body string encoded as base64 string E.g. '`<p>` Please Wait `</p>`'. Base64 encoded string for this HTML is 'PHA+IFBsZWFzZSBXYWl0IDwvcD4='
|
|
1904
|
+
|
|
1905
|
+
#### Client Side Defense
|
|
1906
|
+
|
|
1907
|
+
A [`client_side_defense`](#client-side-defense) block supports the following:
|
|
1908
|
+
|
|
1909
|
+
<a id="client-side-defense-policy"></a>• [`policy`](#client-side-defense-policy) - Optional Block<br>Client-Side Defense Policy. This defines various configuration options for Client-Side Defense policy<br>See [Policy](#client-side-defense-policy) below.
|
|
1910
|
+
|
|
1911
|
+
#### Client Side Defense Policy
|
|
1912
|
+
|
|
1913
|
+
A [`policy`](#client-side-defense-policy) block (within [`client_side_defense`](#client-side-defense)) supports the following:
|
|
1914
|
+
|
|
1915
|
+
<a id="client-side-defense-policy-disable-js-insert"></a>• [`disable_js_insert`](#client-side-defense-policy-disable-js-insert) - Optional Block<br>Enable this option
|
|
1916
|
+
|
|
1917
|
+
<a id="client-side-defense-policy-js-insert-all-pages"></a>• [`js_insert_all_pages`](#client-side-defense-policy-js-insert-all-pages) - Optional Block<br>Enable this option
|
|
1918
|
+
|
|
1919
|
+
<a id="client-side-defense-policy-js-insert-all-pages-except"></a>• [`js_insert_all_pages_except`](#client-side-defense-policy-js-insert-all-pages-except) - Optional Block<br>Insert JavaScript in All Pages with the Exceptions. Insert Client-Side Defense JavaScript in all pages with the exceptions<br>See [Js Insert All Pages Except](#client-side-defense-policy-js-insert-all-pages-except) below.
|
|
1920
|
+
|
|
1921
|
+
<a id="client-side-defense-policy-js-insertion-rules"></a>• [`js_insertion_rules`](#client-side-defense-policy-js-insertion-rules) - Optional Block<br>JavaScript Custom Insertion Rules. This defines custom JavaScript insertion rules for Client-Side Defense Policy<br>See [Js Insertion Rules](#client-side-defense-policy-js-insertion-rules) below.
|
|
1922
|
+
|
|
1923
|
+
#### Client Side Defense Policy Js Insert All Pages Except
|
|
1924
|
+
|
|
1925
|
+
A [`js_insert_all_pages_except`](#client-side-defense-policy-js-insert-all-pages-except) block (within [`client_side_defense.policy`](#client-side-defense-policy)) supports the following:
|
|
1926
|
+
|
|
1927
|
+
<a id="client-side-defense-policy-js-insert-all-pages-except-exclude-list"></a>• [`exclude_list`](#client-side-defense-policy-js-insert-all-pages-except-exclude-list) - Optional Block<br>Exclude Pages. Optional JavaScript insertions exclude list of domain and path matchers<br>See [Exclude List](#client-side-defense-policy-js-insert-all-pages-except-exclude-list) below.
|
|
1928
|
+
|
|
1929
|
+
#### Client Side Defense Policy Js Insert All Pages Except Exclude List
|
|
1930
|
+
|
|
1931
|
+
An [`exclude_list`](#client-side-defense-policy-js-insert-all-pages-except-exclude-list) block (within [`client_side_defense.policy.js_insert_all_pages_except`](#client-side-defense-policy-js-insert-all-pages-except)) supports the following:
|
|
1932
|
+
|
|
1933
|
+
<a id="client-side-defense-policy-js-insert-all-pages-except-exclude-list-any-domain"></a>• [`any_domain`](#client-side-defense-policy-js-insert-all-pages-except-exclude-list-any-domain) - Optional Block<br>Enable this option
|
|
1934
|
+
|
|
1935
|
+
<a id="client-side-defense-policy-js-insert-all-pages-except-exclude-list-domain"></a>• [`domain`](#client-side-defense-policy-js-insert-all-pages-except-exclude-list-domain) - Optional Block<br>Domains. Domains names<br>See [Domain](#client-side-defense-policy-js-insert-all-pages-except-exclude-list-domain) below.
|
|
1936
|
+
|
|
1937
|
+
<a id="client-side-defense-policy-js-insert-all-pages-except-exclude-list-metadata"></a>• [`metadata`](#client-side-defense-policy-js-insert-all-pages-except-exclude-list-metadata) - 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](#client-side-defense-policy-js-insert-all-pages-except-exclude-list-metadata) below.
|
|
1938
|
+
|
|
1939
|
+
<a id="client-side-defense-policy-js-insert-all-pages-except-exclude-list-path"></a>• [`path`](#client-side-defense-policy-js-insert-all-pages-except-exclude-list-path) - 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](#client-side-defense-policy-js-insert-all-pages-except-exclude-list-path) below.
|
|
1940
|
+
|
|
1941
|
+
#### Client Side Defense Policy Js Insert All Pages Except Exclude List Domain
|
|
1942
|
+
|
|
1943
|
+
A [`domain`](#client-side-defense-policy-js-insert-all-pages-except-exclude-list-domain) block (within [`client_side_defense.policy.js_insert_all_pages_except.exclude_list`](#client-side-defense-policy-js-insert-all-pages-except-exclude-list)) supports the following:
|
|
1944
|
+
|
|
1945
|
+
<a id="client-side-defense-policy-js-insert-all-pages-except-exclude-list-domain-exact-value"></a>• [`exact_value`](#client-side-defense-policy-js-insert-all-pages-except-exclude-list-domain-exact-value) - Optional String<br>Exact Value. Exact domain name
|
|
1946
|
+
|
|
1947
|
+
<a id="client-side-defense-policy-js-insert-all-pages-except-exclude-list-domain-regex-value"></a>• [`regex_value`](#client-side-defense-policy-js-insert-all-pages-except-exclude-list-domain-regex-value) - Optional String<br>Regex Values of Domains. Regular Expression value for the domain name
|
|
1948
|
+
|
|
1949
|
+
<a id="client-side-defense-policy-js-insert-all-pages-except-exclude-list-domain-suffix-value"></a>• [`suffix_value`](#client-side-defense-policy-js-insert-all-pages-except-exclude-list-domain-suffix-value) - 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`](#client-side-defense-policy-js-insert-all-pages-except-exclude-list-metadata) block (within [`client_side_defense.policy.js_insert_all_pages_except.exclude_list`](#client-side-defense-policy-js-insert-all-pages-except-exclude-list)) supports the following:
|
|
1954
|
+
|
|
1955
|
+
<a id="client-side-defense-policy-js-insert-all-pages-except-exclude-list-metadata-description-spec"></a>• [`description_spec`](#client-side-defense-policy-js-insert-all-pages-except-exclude-list-metadata-description-spec) - Optional String<br>Description. Human readable description
|
|
1956
|
+
|
|
1957
|
+
<a id="client-side-defense-policy-js-insert-all-pages-except-exclude-list-metadata-name"></a>• [`name`](#client-side-defense-policy-js-insert-all-pages-except-exclude-list-metadata-name) - 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`](#client-side-defense-policy-js-insert-all-pages-except-exclude-list-path) block (within [`client_side_defense.policy.js_insert_all_pages_except.exclude_list`](#client-side-defense-policy-js-insert-all-pages-except-exclude-list)) supports the following:
|
|
1962
|
+
|
|
1963
|
+
<a id="client-side-defense-policy-js-insert-all-pages-except-exclude-list-path-path"></a>• [`path`](#client-side-defense-policy-js-insert-all-pages-except-exclude-list-path-path) - Optional String<br>Exact. Exact path value to match
|
|
1964
|
+
|
|
1965
|
+
<a id="client-side-defense-policy-js-insert-all-pages-except-exclude-list-path-prefix"></a>• [`prefix`](#client-side-defense-policy-js-insert-all-pages-except-exclude-list-path-prefix) - Optional String<br>Prefix. Path prefix to match (e.g. the value / will match on all paths)
|
|
1966
|
+
|
|
1967
|
+
<a id="client-side-defense-policy-js-insert-all-pages-except-exclude-list-path-regex"></a>• [`regex`](#client-side-defense-policy-js-insert-all-pages-except-exclude-list-path-regex) - 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`](#client-side-defense-policy-js-insertion-rules) block (within [`client_side_defense.policy`](#client-side-defense-policy)) supports the following:
|
|
1972
|
+
|
|
1973
|
+
<a id="client-side-defense-policy-js-insertion-rules-exclude-list"></a>• [`exclude_list`](#client-side-defense-policy-js-insertion-rules-exclude-list) - Optional Block<br>Exclude Paths. Optional JavaScript insertions exclude list of domain and path matchers<br>See [Exclude List](#client-side-defense-policy-js-insertion-rules-exclude-list) below.
|
|
1974
|
+
|
|
1975
|
+
<a id="client-side-defense-policy-js-insertion-rules-rules"></a>• [`rules`](#client-side-defense-policy-js-insertion-rules-rules) - Optional Block<br>JavaScript Insertions. Required list of pages to insert Client-Side Defense client JavaScript<br>See [Rules](#client-side-defense-policy-js-insertion-rules-rules) below.
|
|
1976
|
+
|
|
1977
|
+
#### Client Side Defense Policy Js Insertion Rules Exclude List
|
|
1978
|
+
|
|
1979
|
+
An [`exclude_list`](#client-side-defense-policy-js-insertion-rules-exclude-list) block (within [`client_side_defense.policy.js_insertion_rules`](#client-side-defense-policy-js-insertion-rules)) supports the following:
|
|
1980
|
+
|
|
1981
|
+
<a id="client-side-defense-policy-js-insertion-rules-exclude-list-any-domain"></a>• [`any_domain`](#client-side-defense-policy-js-insertion-rules-exclude-list-any-domain) - Optional Block<br>Enable this option
|
|
1982
|
+
|
|
1983
|
+
<a id="client-side-defense-policy-js-insertion-rules-exclude-list-domain"></a>• [`domain`](#client-side-defense-policy-js-insertion-rules-exclude-list-domain) - Optional Block<br>Domains. Domains names<br>See [Domain](#client-side-defense-policy-js-insertion-rules-exclude-list-domain) below.
|
|
1984
|
+
|
|
1985
|
+
<a id="client-side-defense-policy-js-insertion-rules-exclude-list-metadata"></a>• [`metadata`](#client-side-defense-policy-js-insertion-rules-exclude-list-metadata) - 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](#client-side-defense-policy-js-insertion-rules-exclude-list-metadata) below.
|
|
1986
|
+
|
|
1987
|
+
<a id="client-side-defense-policy-js-insertion-rules-exclude-list-path"></a>• [`path`](#client-side-defense-policy-js-insertion-rules-exclude-list-path) - 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](#client-side-defense-policy-js-insertion-rules-exclude-list-path) below.
|
|
1988
|
+
|
|
1989
|
+
#### Client Side Defense Policy Js Insertion Rules Exclude List Domain
|
|
1990
|
+
|
|
1991
|
+
A [`domain`](#client-side-defense-policy-js-insertion-rules-exclude-list-domain) block (within [`client_side_defense.policy.js_insertion_rules.exclude_list`](#client-side-defense-policy-js-insertion-rules-exclude-list)) supports the following:
|
|
1992
|
+
|
|
1993
|
+
<a id="client-side-defense-policy-js-insertion-rules-exclude-list-domain-exact-value"></a>• [`exact_value`](#client-side-defense-policy-js-insertion-rules-exclude-list-domain-exact-value) - Optional String<br>Exact Value. Exact domain name
|
|
1994
|
+
|
|
1995
|
+
<a id="client-side-defense-policy-js-insertion-rules-exclude-list-domain-regex-value"></a>• [`regex_value`](#client-side-defense-policy-js-insertion-rules-exclude-list-domain-regex-value) - Optional String<br>Regex Values of Domains. Regular Expression value for the domain name
|
|
1996
|
+
|
|
1997
|
+
<a id="client-side-defense-policy-js-insertion-rules-exclude-list-domain-suffix-value"></a>• [`suffix_value`](#client-side-defense-policy-js-insertion-rules-exclude-list-domain-suffix-value) - 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`](#client-side-defense-policy-js-insertion-rules-exclude-list-metadata) block (within [`client_side_defense.policy.js_insertion_rules.exclude_list`](#client-side-defense-policy-js-insertion-rules-exclude-list)) supports the following:
|
|
2002
|
+
|
|
2003
|
+
<a id="client-side-defense-policy-js-insertion-rules-exclude-list-metadata-description-spec"></a>• [`description_spec`](#client-side-defense-policy-js-insertion-rules-exclude-list-metadata-description-spec) - Optional String<br>Description. Human readable description
|
|
2004
|
+
|
|
2005
|
+
<a id="client-side-defense-policy-js-insertion-rules-exclude-list-metadata-name"></a>• [`name`](#client-side-defense-policy-js-insertion-rules-exclude-list-metadata-name) - Optional String<br>Name. This is the name of the message. The value of name has to follow DNS-1035 format
|
|
2006
|
+
|
|
2007
|
+
#### Client Side Defense Policy Js Insertion Rules Exclude List Path
|
|
2008
|
+
|
|
2009
|
+
A [`path`](#client-side-defense-policy-js-insertion-rules-exclude-list-path) block (within [`client_side_defense.policy.js_insertion_rules.exclude_list`](#client-side-defense-policy-js-insertion-rules-exclude-list)) supports the following:
|
|
2010
|
+
|
|
2011
|
+
<a id="client-side-defense-policy-js-insertion-rules-exclude-list-path-path"></a>• [`path`](#client-side-defense-policy-js-insertion-rules-exclude-list-path-path) - Optional String<br>Exact. Exact path value to match
|
|
2012
|
+
|
|
2013
|
+
<a id="client-side-defense-policy-js-insertion-rules-exclude-list-path-prefix"></a>• [`prefix`](#client-side-defense-policy-js-insertion-rules-exclude-list-path-prefix) - Optional String<br>Prefix. Path prefix to match (e.g. the value / will match on all paths)
|
|
2014
|
+
|
|
2015
|
+
<a id="client-side-defense-policy-js-insertion-rules-exclude-list-path-regex"></a>• [`regex`](#client-side-defense-policy-js-insertion-rules-exclude-list-path-regex) - Optional String<br>Regex. Regular expression of path match (e.g. the value .* will match on all paths)
|
|
2016
|
+
|
|
2017
|
+
#### Client Side Defense Policy Js Insertion Rules Rules
|
|
2018
|
+
|
|
2019
|
+
A [`rules`](#client-side-defense-policy-js-insertion-rules-rules) block (within [`client_side_defense.policy.js_insertion_rules`](#client-side-defense-policy-js-insertion-rules)) supports the following:
|
|
2020
|
+
|
|
2021
|
+
<a id="client-side-defense-policy-js-insertion-rules-rules-any-domain"></a>• [`any_domain`](#client-side-defense-policy-js-insertion-rules-rules-any-domain) - Optional Block<br>Enable this option
|
|
2022
|
+
|
|
2023
|
+
<a id="client-side-defense-policy-js-insertion-rules-rules-domain"></a>• [`domain`](#client-side-defense-policy-js-insertion-rules-rules-domain) - Optional Block<br>Domains. Domains names<br>See [Domain](#client-side-defense-policy-js-insertion-rules-rules-domain) below.
|
|
2024
|
+
|
|
2025
|
+
<a id="client-side-defense-policy-js-insertion-rules-rules-metadata"></a>• [`metadata`](#client-side-defense-policy-js-insertion-rules-rules-metadata) - 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](#client-side-defense-policy-js-insertion-rules-rules-metadata) below.
|
|
2026
|
+
|
|
2027
|
+
<a id="client-side-defense-policy-js-insertion-rules-rules-path"></a>• [`path`](#client-side-defense-policy-js-insertion-rules-rules-path) - 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](#client-side-defense-policy-js-insertion-rules-rules-path) below.
|
|
2028
|
+
|
|
2029
|
+
#### Client Side Defense Policy Js Insertion Rules Rules Domain
|
|
2030
|
+
|
|
2031
|
+
A [`domain`](#client-side-defense-policy-js-insertion-rules-rules-domain) block (within [`client_side_defense.policy.js_insertion_rules.rules`](#client-side-defense-policy-js-insertion-rules-rules)) supports the following:
|
|
2032
|
+
|
|
2033
|
+
<a id="client-side-defense-policy-js-insertion-rules-rules-domain-exact-value"></a>• [`exact_value`](#client-side-defense-policy-js-insertion-rules-rules-domain-exact-value) - Optional String<br>Exact Value. Exact domain name
|
|
2034
|
+
|
|
2035
|
+
<a id="client-side-defense-policy-js-insertion-rules-rules-domain-regex-value"></a>• [`regex_value`](#client-side-defense-policy-js-insertion-rules-rules-domain-regex-value) - Optional String<br>Regex Values of Domains. Regular Expression value for the domain name
|
|
2036
|
+
|
|
2037
|
+
<a id="client-side-defense-policy-js-insertion-rules-rules-domain-suffix-value"></a>• [`suffix_value`](#client-side-defense-policy-js-insertion-rules-rules-domain-suffix-value) - Optional String<br>Suffix Value. Suffix of domain name e.g 'xyz.com' will match '*.xyz.com' and 'xyz.com'
|
|
2038
|
+
|
|
2039
|
+
#### Client Side Defense Policy Js Insertion Rules Rules Metadata
|
|
2040
|
+
|
|
2041
|
+
A [`metadata`](#client-side-defense-policy-js-insertion-rules-rules-metadata) block (within [`client_side_defense.policy.js_insertion_rules.rules`](#client-side-defense-policy-js-insertion-rules-rules)) supports the following:
|
|
2042
|
+
|
|
2043
|
+
<a id="client-side-defense-policy-js-insertion-rules-rules-metadata-description-spec"></a>• [`description_spec`](#client-side-defense-policy-js-insertion-rules-rules-metadata-description-spec) - Optional String<br>Description. Human readable description
|
|
2044
|
+
|
|
2045
|
+
<a id="client-side-defense-policy-js-insertion-rules-rules-metadata-name"></a>• [`name`](#client-side-defense-policy-js-insertion-rules-rules-metadata-name) - Optional String<br>Name. This is the name of the message. The value of name has to follow DNS-1035 format
|
|
2046
|
+
|
|
2047
|
+
#### Client Side Defense Policy Js Insertion Rules Rules Path
|
|
2048
|
+
|
|
2049
|
+
A [`path`](#client-side-defense-policy-js-insertion-rules-rules-path) block (within [`client_side_defense.policy.js_insertion_rules.rules`](#client-side-defense-policy-js-insertion-rules-rules)) supports the following:
|
|
2050
|
+
|
|
2051
|
+
<a id="client-side-defense-policy-js-insertion-rules-rules-path-path"></a>• [`path`](#client-side-defense-policy-js-insertion-rules-rules-path-path) - Optional String<br>Exact. Exact path value to match
|
|
2052
|
+
|
|
2053
|
+
<a id="client-side-defense-policy-js-insertion-rules-rules-path-prefix"></a>• [`prefix`](#client-side-defense-policy-js-insertion-rules-rules-path-prefix) - Optional String<br>Prefix. Path prefix to match (e.g. the value / will match on all paths)
|
|
2054
|
+
|
|
2055
|
+
<a id="client-side-defense-policy-js-insertion-rules-rules-path-regex"></a>• [`regex`](#client-side-defense-policy-js-insertion-rules-rules-path-regex) - Optional String<br>Regex. Regular expression of path match (e.g. the value .* will match on all paths)
|
|
2056
|
+
|
|
2057
|
+
#### CORS Policy
|
|
2058
|
+
|
|
2059
|
+
A [`cors_policy`](#cors-policy) block supports the following:
|
|
2060
|
+
|
|
2061
|
+
<a id="cors-policy-allow-credentials"></a>• [`allow_credentials`](#cors-policy-allow-credentials) - Optional Bool<br>Allow Credentials. Specifies whether the resource allows credentials
|
|
2062
|
+
|
|
2063
|
+
<a id="cors-policy-allow-headers"></a>• [`allow_headers`](#cors-policy-allow-headers) - Optional String<br>Allow Headers. Specifies the content for the access-control-allow-headers header
|
|
2064
|
+
|
|
2065
|
+
<a id="cors-policy-allow-methods"></a>• [`allow_methods`](#cors-policy-allow-methods) - Optional String<br>Allow Methods. Specifies the content for the access-control-allow-methods header
|
|
2066
|
+
|
|
2067
|
+
<a id="cors-policy-allow-origin"></a>• [`allow_origin`](#cors-policy-allow-origin) - Optional List<br>Allow Origin. Specifies the origins that will be allowed to do CORS requests. An origin is allowed if either allow_origin or allow_origin_regex match
|
|
2068
|
+
|
|
2069
|
+
<a id="cors-policy-allow-origin-regex"></a>• [`allow_origin_regex`](#cors-policy-allow-origin-regex) - Optional List<br>Allow Origin Regex. Specifies regex patterns that match allowed origins. An origin is allowed if either allow_origin or allow_origin_regex match
|
|
2070
|
+
|
|
2071
|
+
<a id="cors-policy-disabled"></a>• [`disabled`](#cors-policy-disabled) - Optional Bool<br>Disabled. Disable the CorsPolicy for a particular route. This is useful when virtual-host has CorsPolicy, but we need to disable it on a specific route. The value of this field is ignored for virtual-host
|
|
2072
|
+
|
|
2073
|
+
<a id="cors-policy-expose-headers"></a>• [`expose_headers`](#cors-policy-expose-headers) - Optional String<br>Expose Headers. Specifies the content for the access-control-expose-headers header
|
|
2074
|
+
|
|
2075
|
+
<a id="cors-policy-maximum-age"></a>• [`maximum_age`](#cors-policy-maximum-age) - Optional Number<br>Maximum Age. Specifies the content for the access-control-max-age header in seconds. This indicates the maximum number of seconds the results can be cached A value of -1 will disable caching. Maximum permitted value is 86400 seconds (24 hours)
|
|
2076
|
+
|
|
2077
|
+
#### CSRF Policy
|
|
2078
|
+
|
|
2079
|
+
A [`csrf_policy`](#csrf-policy) block supports the following:
|
|
2080
|
+
|
|
2081
|
+
<a id="csrf-policy-all-load-balancer-domains"></a>• [`all_load_balancer_domains`](#csrf-policy-all-load-balancer-domains) - Optional Block<br>Enable this option
|
|
2082
|
+
|
|
2083
|
+
<a id="csrf-policy-custom-domain-list"></a>• [`custom_domain_list`](#csrf-policy-custom-domain-list) - Optional Block<br>Domain name list. List of domain names used for Host header matching<br>See [Custom Domain List](#csrf-policy-custom-domain-list) below.
|
|
2084
|
+
|
|
2085
|
+
<a id="csrf-policy-disabled"></a>• [`disabled`](#csrf-policy-disabled) - Optional Block<br>Enable this option
|
|
2086
|
+
|
|
2087
|
+
#### CSRF Policy Custom Domain List
|
|
2088
|
+
|
|
2089
|
+
A [`custom_domain_list`](#csrf-policy-custom-domain-list) block (within [`csrf_policy`](#csrf-policy)) supports the following:
|
|
2090
|
+
|
|
2091
|
+
<a id="csrf-policy-custom-domain-list-domains"></a>• [`domains`](#csrf-policy-custom-domain-list-domains) - Optional List<br>Domain names. A list of domain names that will be matched to loadbalancer. These domains are not used for SNI match. Wildcard names are supported in the suffix or prefix form
|
|
2092
|
+
|
|
2093
|
+
#### Custom Cache Rule
|
|
2094
|
+
|
|
2095
|
+
A [`custom_cache_rule`](#custom-cache-rule) block supports the following:
|
|
2096
|
+
|
|
2097
|
+
<a id="custom-cache-rule-cdn-cache-rules"></a>• [`cdn_cache_rules`](#custom-cache-rule-cdn-cache-rules) - Optional Block<br>CDN Cache Rule. Reference to CDN Cache Rule configuration object<br>See [CDN Cache Rules](#custom-cache-rule-cdn-cache-rules) below.
|
|
2098
|
+
|
|
2099
|
+
#### Custom Cache Rule CDN Cache Rules
|
|
2100
|
+
|
|
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>• [`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="custom-cache-rule-cdn-cache-rules-namespace"></a>• [`namespace`](#custom-cache-rule-cdn-cache-rules-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
|
|
2106
|
+
|
|
2107
|
+
<a id="custom-cache-rule-cdn-cache-rules-tenant"></a>• [`tenant`](#custom-cache-rule-cdn-cache-rules-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
|
|
2108
|
+
|
|
2109
|
+
#### Data Guard Rules
|
|
2110
|
+
|
|
2111
|
+
A [`data_guard_rules`](#data-guard-rules) block supports the following:
|
|
2112
|
+
|
|
2113
|
+
<a id="data-guard-rules-any-domain"></a>• [`any_domain`](#data-guard-rules-any-domain) - Optional Block<br>Enable this option
|
|
2114
|
+
|
|
2115
|
+
<a id="data-guard-rules-apply-data-guard"></a>• [`apply_data_guard`](#data-guard-rules-apply-data-guard) - Optional Block<br>Enable this option
|
|
2116
|
+
|
|
2117
|
+
<a id="data-guard-rules-exact-value"></a>• [`exact_value`](#data-guard-rules-exact-value) - Optional String<br>Exact Value. Exact domain name
|
|
2118
|
+
|
|
2119
|
+
<a id="data-guard-rules-metadata"></a>• [`metadata`](#data-guard-rules-metadata) - 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](#data-guard-rules-metadata) below.
|
|
2120
|
+
|
|
2121
|
+
<a id="data-guard-rules-path"></a>• [`path`](#data-guard-rules-path) - 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](#data-guard-rules-path) below.
|
|
2122
|
+
|
|
2123
|
+
<a id="data-guard-rules-skip-data-guard"></a>• [`skip_data_guard`](#data-guard-rules-skip-data-guard) - Optional Block<br>Enable this option
|
|
2124
|
+
|
|
2125
|
+
<a id="data-guard-rules-suffix-value"></a>• [`suffix_value`](#data-guard-rules-suffix-value) - Optional String<br>Suffix Value. Suffix of domain name e.g 'xyz.com' will match '*.xyz.com' and 'xyz.com'
|
|
2126
|
+
|
|
2127
|
+
#### Data Guard Rules Metadata
|
|
2128
|
+
|
|
2129
|
+
A [`metadata`](#data-guard-rules-metadata) block (within [`data_guard_rules`](#data-guard-rules)) supports the following:
|
|
2130
|
+
|
|
2131
|
+
<a id="data-guard-rules-metadata-description-spec"></a>• [`description_spec`](#data-guard-rules-metadata-description-spec) - Optional String<br>Description. Human readable description
|
|
2132
|
+
|
|
2133
|
+
<a id="data-guard-rules-metadata-name"></a>• [`name`](#data-guard-rules-metadata-name) - Optional String<br>Name. This is the name of the message. The value of name has to follow DNS-1035 format
|
|
2134
|
+
|
|
2135
|
+
#### Data Guard Rules Path
|
|
2136
|
+
|
|
2137
|
+
A [`path`](#data-guard-rules-path) block (within [`data_guard_rules`](#data-guard-rules)) supports the following:
|
|
2138
|
+
|
|
2139
|
+
<a id="data-guard-rules-path-path"></a>• [`path`](#data-guard-rules-path-path) - Optional String<br>Exact. Exact path value to match
|
|
2140
|
+
|
|
2141
|
+
<a id="data-guard-rules-path-prefix"></a>• [`prefix`](#data-guard-rules-path-prefix) - Optional String<br>Prefix. Path prefix to match (e.g. the value / will match on all paths)
|
|
2142
|
+
|
|
2143
|
+
<a id="data-guard-rules-path-regex"></a>• [`regex`](#data-guard-rules-path-regex) - Optional String<br>Regex. Regular expression of path match (e.g. the value .* will match on all paths)
|
|
2144
|
+
|
|
2145
|
+
#### DDOS Mitigation Rules
|
|
2146
|
+
|
|
2147
|
+
A [`ddos_mitigation_rules`](#ddos-mitigation-rules) block supports the following:
|
|
2148
|
+
|
|
2149
|
+
<a id="ddos-mitigation-rules-block"></a>• [`block`](#ddos-mitigation-rules-block) - Optional Block<br>Enable this option
|
|
2150
|
+
|
|
2151
|
+
<a id="ddos-mitigation-rules-ddos-client-source"></a>• [`ddos_client_source`](#ddos-mitigation-rules-ddos-client-source) - Optional Block<br>DDOS Client Source Choice. DDOS Mitigation sources to be blocked<br>See [DDOS Client Source](#ddos-mitigation-rules-ddos-client-source) below.
|
|
2152
|
+
|
|
2153
|
+
<a id="ddos-mitigation-rules-expiration-timestamp"></a>• [`expiration_timestamp`](#ddos-mitigation-rules-expiration-timestamp) - Optional String<br>Expiration Timestamp. The expiration_timestamp is the RFC 3339 format timestamp at which the containing rule is considered to be logically expired. The rule continues to exist in the configuration but is not applied anymore
|
|
2154
|
+
|
|
2155
|
+
<a id="ddos-mitigation-rules-ip-prefix-list"></a>• [`ip_prefix_list`](#ddos-mitigation-rules-ip-prefix-list) - Optional Block<br>IP Prefix Match List. List of IP Prefix strings to match against<br>See [IP Prefix List](#ddos-mitigation-rules-ip-prefix-list) below.
|
|
2156
|
+
|
|
2157
|
+
<a id="ddos-mitigation-rules-metadata"></a>• [`metadata`](#ddos-mitigation-rules-metadata) - 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](#ddos-mitigation-rules-metadata) below.
|
|
2158
|
+
|
|
2159
|
+
#### DDOS Mitigation Rules DDOS Client Source
|
|
2160
|
+
|
|
2161
|
+
A [`ddos_client_source`](#ddos-mitigation-rules-ddos-client-source) block (within [`ddos_mitigation_rules`](#ddos-mitigation-rules)) supports the following:
|
|
2162
|
+
|
|
2163
|
+
<a id="ddos-mitigation-rules-ddos-client-source-asn-list"></a>• [`asn_list`](#ddos-mitigation-rules-ddos-client-source-asn-list) - 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](#ddos-mitigation-rules-ddos-client-source-asn-list) below.
|
|
2164
|
+
|
|
2165
|
+
<a id="ddos-mitigation-rules-ddos-client-source-country-list"></a>• [`country_list`](#ddos-mitigation-rules-ddos-client-source-country-list) - Optional List Defaults to `COUNTRY_NONE`<br>Possible values are `COUNTRY_NONE`, `COUNTRY_AD`, `COUNTRY_AE`, `COUNTRY_AF`, `COUNTRY_AG`, `COUNTRY_AI`, `COUNTRY_AL`, `COUNTRY_AM`, `COUNTRY_AN`, `COUNTRY_AO`, `COUNTRY_AQ`, `COUNTRY_AR`, `COUNTRY_AS`, `COUNTRY_AT`, `COUNTRY_AU`, `COUNTRY_AW`, `COUNTRY_AX`, `COUNTRY_AZ`, `COUNTRY_BA`, `COUNTRY_BB`, `COUNTRY_BD`, `COUNTRY_BE`, `COUNTRY_BF`, `COUNTRY_BG`, `COUNTRY_BH`, `COUNTRY_BI`, `COUNTRY_BJ`, `COUNTRY_BL`, `COUNTRY_BM`, `COUNTRY_BN`, `COUNTRY_BO`, `COUNTRY_BQ`, `COUNTRY_BR`, `COUNTRY_BS`, `COUNTRY_BT`, `COUNTRY_BV`, `COUNTRY_BW`, `COUNTRY_BY`, `COUNTRY_BZ`, `COUNTRY_CA`, `COUNTRY_CC`, `COUNTRY_CD`, `COUNTRY_CF`, `COUNTRY_CG`, `COUNTRY_CH`, `COUNTRY_CI`, `COUNTRY_CK`, `COUNTRY_CL`, `COUNTRY_CM`, `COUNTRY_CN`, `COUNTRY_CO`, `COUNTRY_CR`, `COUNTRY_CS`, `COUNTRY_CU`, `COUNTRY_CV`, `COUNTRY_CW`, `COUNTRY_CX`, `COUNTRY_CY`, `COUNTRY_CZ`, `COUNTRY_DE`, `COUNTRY_DJ`, `COUNTRY_DK`, `COUNTRY_DM`, `COUNTRY_DO`, `COUNTRY_DZ`, `COUNTRY_EC`, `COUNTRY_EE`, `COUNTRY_EG`, `COUNTRY_EH`, `COUNTRY_ER`, `COUNTRY_ES`, `COUNTRY_ET`, `COUNTRY_FI`, `COUNTRY_FJ`, `COUNTRY_FK`, `COUNTRY_FM`, `COUNTRY_FO`, `COUNTRY_FR`, `COUNTRY_GA`, `COUNTRY_GB`, `COUNTRY_GD`, `COUNTRY_GE`, `COUNTRY_GF`, `COUNTRY_GG`, `COUNTRY_GH`, `COUNTRY_GI`, `COUNTRY_GL`, `COUNTRY_GM`, `COUNTRY_GN`, `COUNTRY_GP`, `COUNTRY_GQ`, `COUNTRY_GR`, `COUNTRY_GS`, `COUNTRY_GT`, `COUNTRY_GU`, `COUNTRY_GW`, `COUNTRY_GY`, `COUNTRY_HK`, `COUNTRY_HM`, `COUNTRY_HN`, `COUNTRY_HR`, `COUNTRY_HT`, `COUNTRY_HU`, `COUNTRY_ID`, `COUNTRY_IE`, `COUNTRY_IL`, `COUNTRY_IM`, `COUNTRY_IN`, `COUNTRY_IO`, `COUNTRY_IQ`, `COUNTRY_IR`, `COUNTRY_IS`, `COUNTRY_IT`, `COUNTRY_JE`, `COUNTRY_JM`, `COUNTRY_JO`, `COUNTRY_JP`, `COUNTRY_KE`, `COUNTRY_KG`, `COUNTRY_KH`, `COUNTRY_KI`, `COUNTRY_KM`, `COUNTRY_KN`, `COUNTRY_KP`, `COUNTRY_KR`, `COUNTRY_KW`, `COUNTRY_KY`, `COUNTRY_KZ`, `COUNTRY_LA`, `COUNTRY_LB`, `COUNTRY_LC`, `COUNTRY_LI`, `COUNTRY_LK`, `COUNTRY_LR`, `COUNTRY_LS`, `COUNTRY_LT`, `COUNTRY_LU`, `COUNTRY_LV`, `COUNTRY_LY`, `COUNTRY_MA`, `COUNTRY_MC`, `COUNTRY_MD`, `COUNTRY_ME`, `COUNTRY_MF`, `COUNTRY_MG`, `COUNTRY_MH`, `COUNTRY_MK`, `COUNTRY_ML`, `COUNTRY_MM`, `COUNTRY_MN`, `COUNTRY_MO`, `COUNTRY_MP`, `COUNTRY_MQ`, `COUNTRY_MR`, `COUNTRY_MS`, `COUNTRY_MT`, `COUNTRY_MU`, `COUNTRY_MV`, `COUNTRY_MW`, `COUNTRY_MX`, `COUNTRY_MY`, `COUNTRY_MZ`, `COUNTRY_NA`, `COUNTRY_NC`, `COUNTRY_NE`, `COUNTRY_NF`, `COUNTRY_NG`, `COUNTRY_NI`, `COUNTRY_NL`, `COUNTRY_NO`, `COUNTRY_NP`, `COUNTRY_NR`, `COUNTRY_NU`, `COUNTRY_NZ`, `COUNTRY_OM`, `COUNTRY_PA`, `COUNTRY_PE`, `COUNTRY_PF`, `COUNTRY_PG`, `COUNTRY_PH`, `COUNTRY_PK`, `COUNTRY_PL`, `COUNTRY_PM`, `COUNTRY_PN`, `COUNTRY_PR`, `COUNTRY_PS`, `COUNTRY_PT`, `COUNTRY_PW`, `COUNTRY_PY`, `COUNTRY_QA`, `COUNTRY_RE`, `COUNTRY_RO`, `COUNTRY_RS`, `COUNTRY_RU`, `COUNTRY_RW`, `COUNTRY_SA`, `COUNTRY_SB`, `COUNTRY_SC`, `COUNTRY_SD`, `COUNTRY_SE`, `COUNTRY_SG`, `COUNTRY_SH`, `COUNTRY_SI`, `COUNTRY_SJ`, `COUNTRY_SK`, `COUNTRY_SL`, `COUNTRY_SM`, `COUNTRY_SN`, `COUNTRY_SO`, `COUNTRY_SR`, `COUNTRY_SS`, `COUNTRY_ST`, `COUNTRY_SV`, `COUNTRY_SX`, `COUNTRY_SY`, `COUNTRY_SZ`, `COUNTRY_TC`, `COUNTRY_TD`, `COUNTRY_TF`, `COUNTRY_TG`, `COUNTRY_TH`, `COUNTRY_TJ`, `COUNTRY_TK`, `COUNTRY_TL`, `COUNTRY_TM`, `COUNTRY_TN`, `COUNTRY_TO`, `COUNTRY_TR`, `COUNTRY_TT`, `COUNTRY_TV`, `COUNTRY_TW`, `COUNTRY_TZ`, `COUNTRY_UA`, `COUNTRY_UG`, `COUNTRY_UM`, `COUNTRY_US`, `COUNTRY_UY`, `COUNTRY_UZ`, `COUNTRY_VA`, `COUNTRY_VC`, `COUNTRY_VE`, `COUNTRY_VG`, `COUNTRY_VI`, `COUNTRY_VN`, `COUNTRY_VU`, `COUNTRY_WF`, `COUNTRY_WS`, `COUNTRY_XK`, `COUNTRY_XT`, `COUNTRY_YE`, `COUNTRY_YT`, `COUNTRY_ZA`, `COUNTRY_ZM`, `COUNTRY_ZW`<br>[Enum: COUNTRY_NONE|COUNTRY_AD|COUNTRY_AE|COUNTRY_AF|COUNTRY_AG|COUNTRY_AI|COUNTRY_AL|COUNTRY_AM|COUNTRY_AN|COUNTRY_AO|COUNTRY_AQ|COUNTRY_AR|COUNTRY_AS|COUNTRY_AT|COUNTRY_AU|COUNTRY_AW|COUNTRY_AX|COUNTRY_AZ|COUNTRY_BA|COUNTRY_BB|COUNTRY_BD|COUNTRY_BE|COUNTRY_BF|COUNTRY_BG|COUNTRY_BH|COUNTRY_BI|COUNTRY_BJ|COUNTRY_BL|COUNTRY_BM|COUNTRY_BN|COUNTRY_BO|COUNTRY_BQ|COUNTRY_BR|COUNTRY_BS|COUNTRY_BT|COUNTRY_BV|COUNTRY_BW|COUNTRY_BY|COUNTRY_BZ|COUNTRY_CA|COUNTRY_CC|COUNTRY_CD|COUNTRY_CF|COUNTRY_CG|COUNTRY_CH|COUNTRY_CI|COUNTRY_CK|COUNTRY_CL|COUNTRY_CM|COUNTRY_CN|COUNTRY_CO|COUNTRY_CR|COUNTRY_CS|COUNTRY_CU|COUNTRY_CV|COUNTRY_CW|COUNTRY_CX|COUNTRY_CY|COUNTRY_CZ|COUNTRY_DE|COUNTRY_DJ|COUNTRY_DK|COUNTRY_DM|COUNTRY_DO|COUNTRY_DZ|COUNTRY_EC|COUNTRY_EE|COUNTRY_EG|COUNTRY_EH|COUNTRY_ER|COUNTRY_ES|COUNTRY_ET|COUNTRY_FI|COUNTRY_FJ|COUNTRY_FK|COUNTRY_FM|COUNTRY_FO|COUNTRY_FR|COUNTRY_GA|COUNTRY_GB|COUNTRY_GD|COUNTRY_GE|COUNTRY_GF|COUNTRY_GG|COUNTRY_GH|COUNTRY_GI|COUNTRY_GL|COUNTRY_GM|COUNTRY_GN|COUNTRY_GP|COUNTRY_GQ|COUNTRY_GR|COUNTRY_GS|COUNTRY_GT|COUNTRY_GU|COUNTRY_GW|COUNTRY_GY|COUNTRY_HK|COUNTRY_HM|COUNTRY_HN|COUNTRY_HR|COUNTRY_HT|COUNTRY_HU|COUNTRY_ID|COUNTRY_IE|COUNTRY_IL|COUNTRY_IM|COUNTRY_IN|COUNTRY_IO|COUNTRY_IQ|COUNTRY_IR|COUNTRY_IS|COUNTRY_IT|COUNTRY_JE|COUNTRY_JM|COUNTRY_JO|COUNTRY_JP|COUNTRY_KE|COUNTRY_KG|COUNTRY_KH|COUNTRY_KI|COUNTRY_KM|COUNTRY_KN|COUNTRY_KP|COUNTRY_KR|COUNTRY_KW|COUNTRY_KY|COUNTRY_KZ|COUNTRY_LA|COUNTRY_LB|COUNTRY_LC|COUNTRY_LI|COUNTRY_LK|COUNTRY_LR|COUNTRY_LS|COUNTRY_LT|COUNTRY_LU|COUNTRY_LV|COUNTRY_LY|COUNTRY_MA|COUNTRY_MC|COUNTRY_MD|COUNTRY_ME|COUNTRY_MF|COUNTRY_MG|COUNTRY_MH|COUNTRY_MK|COUNTRY_ML|COUNTRY_MM|COUNTRY_MN|COUNTRY_MO|COUNTRY_MP|COUNTRY_MQ|COUNTRY_MR|COUNTRY_MS|COUNTRY_MT|COUNTRY_MU|COUNTRY_MV|COUNTRY_MW|COUNTRY_MX|COUNTRY_MY|COUNTRY_MZ|COUNTRY_NA|COUNTRY_NC|COUNTRY_NE|COUNTRY_NF|COUNTRY_NG|COUNTRY_NI|COUNTRY_NL|COUNTRY_NO|COUNTRY_NP|COUNTRY_NR|COUNTRY_NU|COUNTRY_NZ|COUNTRY_OM|COUNTRY_PA|COUNTRY_PE|COUNTRY_PF|COUNTRY_PG|COUNTRY_PH|COUNTRY_PK|COUNTRY_PL|COUNTRY_PM|COUNTRY_PN|COUNTRY_PR|COUNTRY_PS|COUNTRY_PT|COUNTRY_PW|COUNTRY_PY|COUNTRY_QA|COUNTRY_RE|COUNTRY_RO|COUNTRY_RS|COUNTRY_RU|COUNTRY_RW|COUNTRY_SA|COUNTRY_SB|COUNTRY_SC|COUNTRY_SD|COUNTRY_SE|COUNTRY_SG|COUNTRY_SH|COUNTRY_SI|COUNTRY_SJ|COUNTRY_SK|COUNTRY_SL|COUNTRY_SM|COUNTRY_SN|COUNTRY_SO|COUNTRY_SR|COUNTRY_SS|COUNTRY_ST|COUNTRY_SV|COUNTRY_SX|COUNTRY_SY|COUNTRY_SZ|COUNTRY_TC|COUNTRY_TD|COUNTRY_TF|COUNTRY_TG|COUNTRY_TH|COUNTRY_TJ|COUNTRY_TK|COUNTRY_TL|COUNTRY_TM|COUNTRY_TN|COUNTRY_TO|COUNTRY_TR|COUNTRY_TT|COUNTRY_TV|COUNTRY_TW|COUNTRY_TZ|COUNTRY_UA|COUNTRY_UG|COUNTRY_UM|COUNTRY_US|COUNTRY_UY|COUNTRY_UZ|COUNTRY_VA|COUNTRY_VC|COUNTRY_VE|COUNTRY_VG|COUNTRY_VI|COUNTRY_VN|COUNTRY_VU|COUNTRY_WF|COUNTRY_WS|COUNTRY_XK|COUNTRY_XT|COUNTRY_YE|COUNTRY_YT|COUNTRY_ZA|COUNTRY_ZM|COUNTRY_ZW] Country List. Sources that are located in one of the countries in the given list
|
|
2166
|
+
|
|
2167
|
+
<a id="ddos-mitigation-rules-ddos-client-source-ja4-tls-fingerprint-matcher"></a>• [`ja4_tls_fingerprint_matcher`](#ddos-mitigation-rules-ddos-client-source-ja4-tls-fingerprint-matcher) - Optional Block<br>JA4 TLS Fingerprint Matcher. An extended version of JA3 that includes additional fields for more comprehensive fingerprinting of SSL/TLS clients and potentially has a different structure and length<br>See [Ja4 TLS Fingerprint Matcher](#ddos-mitigation-rules-ddos-client-source-ja4-tls-fingerprint-matcher) below.
|
|
2168
|
+
|
|
2169
|
+
<a id="ddos-mitigation-rules-ddos-client-source-tls-fingerprint-matcher"></a>• [`tls_fingerprint_matcher`](#ddos-mitigation-rules-ddos-client-source-tls-fingerprint-matcher) - 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](#ddos-mitigation-rules-ddos-client-source-tls-fingerprint-matcher) below.
|
|
2170
|
+
|
|
2171
|
+
#### DDOS Mitigation Rules DDOS Client Source Asn List
|
|
2172
|
+
|
|
2173
|
+
An [`asn_list`](#ddos-mitigation-rules-ddos-client-source-asn-list) block (within [`ddos_mitigation_rules.ddos_client_source`](#ddos-mitigation-rules-ddos-client-source)) supports the following:
|
|
2174
|
+
|
|
2175
|
+
<a id="ddos-mitigation-rules-ddos-client-source-asn-list-as-numbers"></a>• [`as_numbers`](#ddos-mitigation-rules-ddos-client-source-asn-list-as-numbers) - 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
|
|
2176
|
+
|
|
2177
|
+
#### DDOS Mitigation Rules DDOS Client Source Ja4 TLS Fingerprint Matcher
|
|
2178
|
+
|
|
2179
|
+
A [`ja4_tls_fingerprint_matcher`](#ddos-mitigation-rules-ddos-client-source-ja4-tls-fingerprint-matcher) block (within [`ddos_mitigation_rules.ddos_client_source`](#ddos-mitigation-rules-ddos-client-source)) supports the following:
|
|
2180
|
+
|
|
2181
|
+
<a id="ddos-mitigation-rules-ddos-client-source-ja4-tls-fingerprint-matcher-exact-values"></a>• [`exact_values`](#ddos-mitigation-rules-ddos-client-source-ja4-tls-fingerprint-matcher-exact-values) - Optional List<br>Exact Values. A list of exact JA4 TLS fingerprint to match the input JA4 TLS fingerprint against
|
|
2182
|
+
|
|
2183
|
+
#### DDOS Mitigation Rules DDOS Client Source TLS Fingerprint Matcher
|
|
2184
|
+
|
|
2185
|
+
A [`tls_fingerprint_matcher`](#ddos-mitigation-rules-ddos-client-source-tls-fingerprint-matcher) block (within [`ddos_mitigation_rules.ddos_client_source`](#ddos-mitigation-rules-ddos-client-source)) supports the following:
|
|
2186
|
+
|
|
2187
|
+
<a id="ddos-mitigation-rules-ddos-client-source-tls-fingerprint-matcher-classes"></a>• [`classes`](#ddos-mitigation-rules-ddos-client-source-tls-fingerprint-matcher-classes) - 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="ddos-mitigation-rules-ddos-client-source-tls-fingerprint-matcher-exact-values"></a>• [`exact_values`](#ddos-mitigation-rules-ddos-client-source-tls-fingerprint-matcher-exact-values) - Optional List<br>Exact Values. A list of exact TLS JA3 fingerprints to match the input TLS JA3 fingerprint against
|
|
2190
|
+
|
|
2191
|
+
<a id="ddos-mitigation-rules-ddos-client-source-tls-fingerprint-matcher-excluded-values"></a>• [`excluded_values`](#ddos-mitigation-rules-ddos-client-source-tls-fingerprint-matcher-excluded-values) - 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
|
|
2192
|
+
|
|
2193
|
+
#### DDOS Mitigation Rules IP Prefix List
|
|
2194
|
+
|
|
2195
|
+
An [`ip_prefix_list`](#ddos-mitigation-rules-ip-prefix-list) block (within [`ddos_mitigation_rules`](#ddos-mitigation-rules)) supports the following:
|
|
2196
|
+
|
|
2197
|
+
<a id="ddos-mitigation-rules-ip-prefix-list-invert-match"></a>• [`invert_match`](#ddos-mitigation-rules-ip-prefix-list-invert-match) - Optional Bool<br>Invert Match Result. Invert the match result
|
|
2198
|
+
|
|
2199
|
+
<a id="ddos-mitigation-rules-ip-prefix-list-ip-prefixes"></a>• [`ip_prefixes`](#ddos-mitigation-rules-ip-prefix-list-ip-prefixes) - Optional List<br>IPv4 Prefix List. List of IPv4 prefix strings
|
|
2200
|
+
|
|
2201
|
+
#### DDOS Mitigation Rules Metadata
|
|
2202
|
+
|
|
2203
|
+
A [`metadata`](#ddos-mitigation-rules-metadata) block (within [`ddos_mitigation_rules`](#ddos-mitigation-rules)) supports the following:
|
|
2204
|
+
|
|
2205
|
+
<a id="ddos-mitigation-rules-metadata-description-spec"></a>• [`description_spec`](#ddos-mitigation-rules-metadata-description-spec) - Optional String<br>Description. Human readable description
|
|
2206
|
+
|
|
2207
|
+
<a id="ddos-mitigation-rules-metadata-name"></a>• [`name`](#ddos-mitigation-rules-metadata-name) - Optional String<br>Name. This is the name of the message. The value of name has to follow DNS-1035 format
|
|
2208
|
+
|
|
2209
|
+
#### Default Cache Action
|
|
2210
|
+
|
|
2211
|
+
A [`default_cache_action`](#default-cache-action) block supports the following:
|
|
2212
|
+
|
|
2213
|
+
<a id="default-cache-action-cache-disabled"></a>• [`cache_disabled`](#default-cache-action-cache-disabled) - Optional Block<br>Enable this option
|
|
2214
|
+
|
|
2215
|
+
<a id="default-cache-action-cache-ttl-default"></a>• [`cache_ttl_default`](#default-cache-action-cache-ttl-default) - Optional String<br>Fallback Cache TTL (d/ h/ m). Use Cache TTL Provided by Origin, and set a contigency TTL value in case one is not provided
|
|
2216
|
+
|
|
2217
|
+
<a id="default-cache-action-cache-ttl-override"></a>• [`cache_ttl_override`](#default-cache-action-cache-ttl-override) - Optional String<br>Override Cache TTL (d/ h/ m/ s). Always override the Cahce TTL provided by Origin
|
|
2218
|
+
|
|
2219
|
+
#### Enable API Discovery
|
|
2220
|
+
|
|
2221
|
+
An [`enable_api_discovery`](#enable-api-discovery) block supports the following:
|
|
2222
|
+
|
|
2223
|
+
<a id="enable-api-discovery-api-crawler"></a>• [`api_crawler`](#enable-api-discovery-api-crawler) - Optional Block<br>API Crawling. API Crawler message<br>See [API Crawler](#enable-api-discovery-api-crawler) below.
|
|
2224
|
+
|
|
2225
|
+
<a id="enable-api-discovery-api-discovery-from-code-scan"></a>• [`api_discovery_from_code_scan`](#enable-api-discovery-api-discovery-from-code-scan) - Optional Block<br>Select Code Base and Repositories<br>See [API Discovery From Code Scan](#enable-api-discovery-api-discovery-from-code-scan) below.
|
|
2226
|
+
|
|
2227
|
+
<a id="enable-api-discovery-custom-api-auth-discovery"></a>• [`custom_api_auth_discovery`](#enable-api-discovery-custom-api-auth-discovery) - Optional Block<br>API Discovery Advanced Settings. API Discovery Advanced settings<br>See [Custom API Auth Discovery](#enable-api-discovery-custom-api-auth-discovery) below.
|
|
2228
|
+
|
|
2229
|
+
<a id="enable-api-discovery-default-api-auth-discovery"></a>• [`default_api_auth_discovery`](#enable-api-discovery-default-api-auth-discovery) - Optional Block<br>Enable this option
|
|
2230
|
+
|
|
2231
|
+
<a id="enable-api-discovery-disable-learn-from-redirect-traffic"></a>• [`disable_learn_from_redirect_traffic`](#enable-api-discovery-disable-learn-from-redirect-traffic) - Optional Block<br>Enable this option
|
|
2232
|
+
|
|
2233
|
+
<a id="enable-api-discovery-discovered-api-settings"></a>• [`discovered_api_settings`](#enable-api-discovery-discovered-api-settings) - Optional Block<br>Discovered API Settings. Configure Discovered API Settings<br>See [Discovered API Settings](#enable-api-discovery-discovered-api-settings) below.
|
|
2234
|
+
|
|
2235
|
+
<a id="enable-api-discovery-enable-learn-from-redirect-traffic"></a>• [`enable_learn_from_redirect_traffic`](#enable-api-discovery-enable-learn-from-redirect-traffic) - Optional Block<br>Enable this option
|
|
2236
|
+
|
|
2237
|
+
#### Enable API Discovery API Crawler
|
|
2238
|
+
|
|
2239
|
+
An [`api_crawler`](#enable-api-discovery-api-crawler) block (within [`enable_api_discovery`](#enable-api-discovery)) supports the following:
|
|
2240
|
+
|
|
2241
|
+
<a id="enable-api-discovery-api-crawler-api-crawler-config"></a>• [`api_crawler_config`](#enable-api-discovery-api-crawler-api-crawler-config) - Optional Block<br>Crawler Configure<br>See [API Crawler Config](#enable-api-discovery-api-crawler-api-crawler-config) below.
|
|
2242
|
+
|
|
2243
|
+
<a id="enable-api-discovery-api-crawler-disable-api-crawler"></a>• [`disable_api_crawler`](#enable-api-discovery-api-crawler-disable-api-crawler) - Optional Block<br>Enable this option
|
|
2244
|
+
|
|
2245
|
+
#### Enable API Discovery API Crawler API Crawler Config
|
|
2246
|
+
|
|
2247
|
+
An [`api_crawler_config`](#enable-api-discovery-api-crawler-api-crawler-config) block (within [`enable_api_discovery.api_crawler`](#enable-api-discovery-api-crawler)) supports the following:
|
|
2248
|
+
|
|
2249
|
+
<a id="enable-api-discovery-api-crawler-api-crawler-config-domains"></a>• [`domains`](#enable-api-discovery-api-crawler-api-crawler-config-domains) - 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](#enable-api-discovery-api-crawler-api-crawler-config-domains) below.
|
|
2250
|
+
|
|
2251
|
+
#### Enable API Discovery API Crawler API Crawler Config Domains
|
|
2252
|
+
|
|
2253
|
+
A [`domains`](#enable-api-discovery-api-crawler-api-crawler-config-domains) block (within [`enable_api_discovery.api_crawler.api_crawler_config`](#enable-api-discovery-api-crawler-api-crawler-config)) supports the following:
|
|
2254
|
+
|
|
2255
|
+
<a id="enable-api-discovery-api-crawler-api-crawler-config-domains-domain"></a>• [`domain`](#enable-api-discovery-api-crawler-api-crawler-config-domains-domain) - Optional String<br>Domain. Select the domain to execute API Crawling with given credentials
|
|
2256
|
+
|
|
2257
|
+
<a id="enable-api-discovery-api-crawler-api-crawler-config-domains-simple-login"></a>• [`simple_login`](#enable-api-discovery-api-crawler-api-crawler-config-domains-simple-login) - Optional Block<br>Simple Login<br>See [Simple Login](#enable-api-discovery-api-crawler-api-crawler-config-domains-simple-login) below.
|
|
2258
|
+
|
|
2259
|
+
#### Enable API Discovery API Crawler API Crawler Config Domains Simple Login
|
|
2260
|
+
|
|
2261
|
+
A [`simple_login`](#enable-api-discovery-api-crawler-api-crawler-config-domains-simple-login) block (within [`enable_api_discovery.api_crawler.api_crawler_config.domains`](#enable-api-discovery-api-crawler-api-crawler-config-domains)) supports the following:
|
|
2262
|
+
|
|
2263
|
+
<a id="enable-api-discovery-api-crawler-api-crawler-config-domains-simple-login-password"></a>• [`password`](#enable-api-discovery-api-crawler-api-crawler-config-domains-simple-login-password) - Optional Block<br>Secret. SecretType is used in an object to indicate a sensitive/confidential field<br>See [Password](#enable-api-discovery-api-crawler-api-crawler-config-domains-simple-login-password) below.
|
|
2264
|
+
|
|
2265
|
+
<a id="enable-api-discovery-api-crawler-api-crawler-config-domains-simple-login-user"></a>• [`user`](#enable-api-discovery-api-crawler-api-crawler-config-domains-simple-login-user) - Optional String<br>User. Enter the username to assign credentials for the selected domain to crawl
|
|
2266
|
+
|
|
2267
|
+
#### Enable API Discovery API Crawler API Crawler Config Domains Simple Login Password
|
|
2268
|
+
|
|
2269
|
+
A [`password`](#enable-api-discovery-api-crawler-api-crawler-config-domains-simple-login-password) block (within [`enable_api_discovery.api_crawler.api_crawler_config.domains.simple_login`](#enable-api-discovery-api-crawler-api-crawler-config-domains-simple-login)) supports the following:
|
|
2270
|
+
|
|
2271
|
+
<a id="enable-api-discovery-api-crawler-api-crawler-config-domains-simple-login-password-blindfold-secret-info"></a>• [`blindfold_secret_info`](#enable-api-discovery-api-crawler-api-crawler-config-domains-simple-login-password-blindfold-secret-info) - Optional Block<br>Blindfold Secret. BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management<br>See [Blindfold Secret Info](#enable-api-discovery-api-crawler-api-crawler-config-domains-simple-login-password-blindfold-secret-info) below.
|
|
2272
|
+
|
|
2273
|
+
<a id="enable-api-discovery-api-crawler-api-crawler-config-domains-simple-login-password-clear-secret-info"></a>• [`clear_secret_info`](#enable-api-discovery-api-crawler-api-crawler-config-domains-simple-login-password-clear-secret-info) - Optional Block<br>In-Clear Secret. ClearSecretInfoType specifies information about the Secret that is not encrypted<br>See [Clear Secret Info](#enable-api-discovery-api-crawler-api-crawler-config-domains-simple-login-password-clear-secret-info) below.
|
|
2274
|
+
|
|
2275
|
+
#### Enable API Discovery API Crawler API Crawler Config Domains Simple Login Password Blindfold Secret Info
|
|
2276
|
+
|
|
2277
|
+
A [`blindfold_secret_info`](#enable-api-discovery-api-crawler-api-crawler-config-domains-simple-login-password-blindfold-secret-info) block (within [`enable_api_discovery.api_crawler.api_crawler_config.domains.simple_login.password`](#enable-api-discovery-api-crawler-api-crawler-config-domains-simple-login-password)) supports the following:
|
|
2278
|
+
|
|
2279
|
+
<a id="enable-api-discovery-api-crawler-api-crawler-config-domains-simple-login-password-blindfold-secret-info-decryption-provider"></a>• [`decryption_provider`](#enable-api-discovery-api-crawler-api-crawler-config-domains-simple-login-password-blindfold-secret-info-decryption-provider) - 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="enable-api-discovery-api-crawler-api-crawler-config-domains-simple-login-password-blindfold-secret-info-location"></a>• [`location`](#enable-api-discovery-api-crawler-api-crawler-config-domains-simple-login-password-blindfold-secret-info-location) - 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="enable-api-discovery-api-crawler-api-crawler-config-domains-simple-login-password-blindfold-secret-info-store-provider"></a>• [`store_provider`](#enable-api-discovery-api-crawler-api-crawler-config-domains-simple-login-password-blindfold-secret-info-store-provider) - 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:///
|
|
2284
|
+
|
|
2285
|
+
#### Enable API Discovery API Crawler API Crawler Config Domains Simple Login Password Clear Secret Info
|
|
2286
|
+
|
|
2287
|
+
A [`clear_secret_info`](#enable-api-discovery-api-crawler-api-crawler-config-domains-simple-login-password-clear-secret-info) block (within [`enable_api_discovery.api_crawler.api_crawler_config.domains.simple_login.password`](#enable-api-discovery-api-crawler-api-crawler-config-domains-simple-login-password)) supports the following:
|
|
2288
|
+
|
|
2289
|
+
<a id="enable-api-discovery-api-crawler-api-crawler-config-domains-simple-login-password-clear-secret-info-provider-ref"></a>• [`provider_ref`](#enable-api-discovery-api-crawler-api-crawler-config-domains-simple-login-password-clear-secret-info-provider-ref) - 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="enable-api-discovery-api-crawler-api-crawler-config-domains-simple-login-password-clear-secret-info-url"></a>• [`url`](#enable-api-discovery-api-crawler-api-crawler-config-domains-simple-login-password-clear-secret-info-url) - 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
|
|
2292
|
+
|
|
2293
|
+
#### Enable API Discovery API Discovery From Code Scan
|
|
2294
|
+
|
|
2295
|
+
An [`api_discovery_from_code_scan`](#enable-api-discovery-api-discovery-from-code-scan) block (within [`enable_api_discovery`](#enable-api-discovery)) supports the following:
|
|
2296
|
+
|
|
2297
|
+
<a id="enable-api-discovery-api-discovery-from-code-scan-code-base-integrations"></a>• [`code_base_integrations`](#enable-api-discovery-api-discovery-from-code-scan-code-base-integrations) - Optional Block<br>Select Code Base Integrations<br>See [Code Base Integrations](#enable-api-discovery-api-discovery-from-code-scan-code-base-integrations) below.
|
|
2298
|
+
|
|
2299
|
+
#### Enable API Discovery API Discovery From Code Scan Code Base Integrations
|
|
2300
|
+
|
|
2301
|
+
A [`code_base_integrations`](#enable-api-discovery-api-discovery-from-code-scan-code-base-integrations) block (within [`enable_api_discovery.api_discovery_from_code_scan`](#enable-api-discovery-api-discovery-from-code-scan)) supports the following:
|
|
2302
|
+
|
|
2303
|
+
<a id="enable-api-discovery-api-discovery-from-code-scan-code-base-integrations-all-repos"></a>• [`all_repos`](#enable-api-discovery-api-discovery-from-code-scan-code-base-integrations-all-repos) - Optional Block<br>Enable this option
|
|
2304
|
+
|
|
2305
|
+
<a id="enable-api-discovery-api-discovery-from-code-scan-code-base-integrations-code-base-integration"></a>• [`code_base_integration`](#enable-api-discovery-api-discovery-from-code-scan-code-base-integrations-code-base-integration) - 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](#enable-api-discovery-api-discovery-from-code-scan-code-base-integrations-code-base-integration) below.
|
|
2306
|
+
|
|
2307
|
+
<a id="enable-api-discovery-api-discovery-from-code-scan-code-base-integrations-selected-repos"></a>• [`selected_repos`](#enable-api-discovery-api-discovery-from-code-scan-code-base-integrations-selected-repos) - Optional Block<br>API Code Repositories. Select which API repositories represent the LB applications<br>See [Selected Repos](#enable-api-discovery-api-discovery-from-code-scan-code-base-integrations-selected-repos) below.
|
|
2308
|
+
|
|
2309
|
+
#### Enable API Discovery API Discovery From Code Scan Code Base Integrations Code Base Integration
|
|
2310
|
+
|
|
2311
|
+
A [`code_base_integration`](#enable-api-discovery-api-discovery-from-code-scan-code-base-integrations-code-base-integration) block (within [`enable_api_discovery.api_discovery_from_code_scan.code_base_integrations`](#enable-api-discovery-api-discovery-from-code-scan-code-base-integrations)) supports the following:
|
|
2312
|
+
|
|
2313
|
+
<a id="enable-api-discovery-api-discovery-from-code-scan-code-base-integrations-code-base-integration-name"></a>• [`name`](#enable-api-discovery-api-discovery-from-code-scan-code-base-integrations-code-base-integration-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
|
|
2314
|
+
|
|
2315
|
+
<a id="enable-api-discovery-api-discovery-from-code-scan-code-base-integrations-code-base-integration-namespace"></a>• [`namespace`](#enable-api-discovery-api-discovery-from-code-scan-code-base-integrations-code-base-integration-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
|
|
2316
|
+
|
|
2317
|
+
<a id="enable-api-discovery-api-discovery-from-code-scan-code-base-integrations-code-base-integration-tenant"></a>• [`tenant`](#enable-api-discovery-api-discovery-from-code-scan-code-base-integrations-code-base-integration-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
|
|
2318
|
+
|
|
2319
|
+
#### Enable API Discovery API Discovery From Code Scan Code Base Integrations Selected Repos
|
|
2320
|
+
|
|
2321
|
+
A [`selected_repos`](#enable-api-discovery-api-discovery-from-code-scan-code-base-integrations-selected-repos) block (within [`enable_api_discovery.api_discovery_from_code_scan.code_base_integrations`](#enable-api-discovery-api-discovery-from-code-scan-code-base-integrations)) supports the following:
|
|
2322
|
+
|
|
2323
|
+
<a id="enable-api-discovery-api-discovery-from-code-scan-code-base-integrations-selected-repos-api-code-repo"></a>• [`api_code_repo`](#enable-api-discovery-api-discovery-from-code-scan-code-base-integrations-selected-repos-api-code-repo) - Optional List<br>API Code Repository. Code repository which contain API endpoints
|
|
2324
|
+
|
|
2325
|
+
#### Enable API Discovery Custom API Auth Discovery
|
|
2326
|
+
|
|
2327
|
+
A [`custom_api_auth_discovery`](#enable-api-discovery-custom-api-auth-discovery) block (within [`enable_api_discovery`](#enable-api-discovery)) supports the following:
|
|
2328
|
+
|
|
2329
|
+
<a id="enable-api-discovery-custom-api-auth-discovery-api-discovery-ref"></a>• [`api_discovery_ref`](#enable-api-discovery-custom-api-auth-discovery-api-discovery-ref) - 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 [API Discovery Ref](#enable-api-discovery-custom-api-auth-discovery-api-discovery-ref) below.
|
|
2330
|
+
|
|
2331
|
+
#### Enable API Discovery Custom API Auth Discovery API Discovery Ref
|
|
2332
|
+
|
|
2333
|
+
An [`api_discovery_ref`](#enable-api-discovery-custom-api-auth-discovery-api-discovery-ref) block (within [`enable_api_discovery.custom_api_auth_discovery`](#enable-api-discovery-custom-api-auth-discovery)) supports the following:
|
|
2334
|
+
|
|
2335
|
+
<a id="enable-api-discovery-custom-api-auth-discovery-api-discovery-ref-name"></a>• [`name`](#enable-api-discovery-custom-api-auth-discovery-api-discovery-ref-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
|
|
2336
|
+
|
|
2337
|
+
<a id="enable-api-discovery-custom-api-auth-discovery-api-discovery-ref-namespace"></a>• [`namespace`](#enable-api-discovery-custom-api-auth-discovery-api-discovery-ref-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
|
|
2338
|
+
|
|
2339
|
+
<a id="enable-api-discovery-custom-api-auth-discovery-api-discovery-ref-tenant"></a>• [`tenant`](#enable-api-discovery-custom-api-auth-discovery-api-discovery-ref-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
|
|
2340
|
+
|
|
2341
|
+
#### Enable API Discovery Discovered API Settings
|
|
2342
|
+
|
|
2343
|
+
A [`discovered_api_settings`](#enable-api-discovery-discovered-api-settings) block (within [`enable_api_discovery`](#enable-api-discovery)) supports the following:
|
|
2344
|
+
|
|
2345
|
+
<a id="enable-api-discovery-discovered-api-settings-purge-duration-for-inactive-discovered-apis"></a>• [`purge_duration_for_inactive_discovered_apis`](#enable-api-discovery-discovered-api-settings-purge-duration-for-inactive-discovered-apis) - Optional Number<br>Purge Duration for Inactive Discovered APIs from Traffic. Inactive discovered API will be deleted after configured duration
|
|
2346
|
+
|
|
2347
|
+
#### Enable Challenge
|
|
2348
|
+
|
|
2349
|
+
An [`enable_challenge`](#enable-challenge) block supports the following:
|
|
2350
|
+
|
|
2351
|
+
<a id="enable-challenge-captcha-challenge-parameters"></a>• [`captcha_challenge_parameters`](#enable-challenge-captcha-challenge-parameters) - Optional Block<br>Captcha Challenge Parameters. Enables loadbalancer to perform captcha challenge Captcha challenge will be based on Google Recaptcha. With this feature enabled, only clients that pass the captcha challenge will be allowed to complete the HTTP request. When loadbalancer is configured to do Captcha Challenge, it will redirect the browser to an HTML page on every new HTTP request. This HTML page will have captcha challenge embedded in it. Client will be allowed to make the request only if the captcha challenge is successful. Loadbalancer will tag response header with a cookie to avoid Captcha challenge for subsequent requests. CAPTCHA is mainly used as a security check to ensure only human users can pass through. Generally, computers or bots are not capable of solving a captcha. You can enable either Javascript challenge or Captcha challenge on a virtual host<br>See [Captcha Challenge Parameters](#enable-challenge-captcha-challenge-parameters) below.
|
|
2352
|
+
|
|
2353
|
+
<a id="enable-challenge-default-captcha-challenge-parameters"></a>• [`default_captcha_challenge_parameters`](#enable-challenge-default-captcha-challenge-parameters) - Optional Block<br>Enable this option
|
|
2354
|
+
|
|
2355
|
+
<a id="enable-challenge-default-js-challenge-parameters"></a>• [`default_js_challenge_parameters`](#enable-challenge-default-js-challenge-parameters) - Optional Block<br>Enable this option
|
|
2356
|
+
|
|
2357
|
+
<a id="enable-challenge-default-mitigation-settings"></a>• [`default_mitigation_settings`](#enable-challenge-default-mitigation-settings) - Optional Block<br>Enable this option
|
|
2358
|
+
|
|
2359
|
+
<a id="enable-challenge-js-challenge-parameters"></a>• [`js_challenge_parameters`](#enable-challenge-js-challenge-parameters) - Optional Block<br>Javascript Challenge Parameters. Enables loadbalancer to perform client browser compatibility test by redirecting to a page with Javascript. With this feature enabled, only clients that are capable of executing Javascript(mostly browsers) will be allowed to complete the HTTP request. When loadbalancer is configured to do Javascript Challenge, it will redirect the browser to an HTML page on every new HTTP request. This HTML page will have Javascript embedded in it. Loadbalancer chooses a set of random numbers for every new client and sends these numbers along with an encrypted answer with the request such that it embed these numbers as input in the Javascript. Javascript will run on the requestor browser and perform a complex Math operation. Script will submit the answer to loadbalancer. Loadbalancer will validate the answer by comparing the calculated answer with the decrypted answer (which was encrypted when it was sent back as reply) and allow the request to the upstream server only if the answer is correct. Loadbalancer will tag response header with a cookie to avoid Javascript challenge for subsequent requests. Javascript challenge serves following purposes \* Validate that the request is coming via a browser that is capable for running Javascript \* Force the browser to run a complex operation, f(X), that requires it to spend a large number of CPU cycles. This is to slow down a potential DOS attacker by making it difficult to launch a large request flood without having to spend even larger CPU cost at their end. You can enable either Javascript challenge or Captcha challenge on a virtual host<br>See [Js Challenge Parameters](#enable-challenge-js-challenge-parameters) below.
|
|
2360
|
+
|
|
2361
|
+
<a id="enable-challenge-malicious-user-mitigation"></a>• [`malicious_user_mitigation`](#enable-challenge-malicious-user-mitigation) - 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 [Malicious User Mitigation](#enable-challenge-malicious-user-mitigation) below.
|
|
2362
|
+
|
|
2363
|
+
#### Enable Challenge Captcha Challenge Parameters
|
|
2364
|
+
|
|
2365
|
+
A [`captcha_challenge_parameters`](#enable-challenge-captcha-challenge-parameters) block (within [`enable_challenge`](#enable-challenge)) supports the following:
|
|
2366
|
+
|
|
2367
|
+
<a id="enable-challenge-captcha-challenge-parameters-cookie-expiry"></a>• [`cookie_expiry`](#enable-challenge-captcha-challenge-parameters-cookie-expiry) - Optional Number<br>Cookie Expiration Period. Cookie expiration period, in seconds. An expired cookie causes the loadbalancer to issue a new challenge
|
|
2368
|
+
|
|
2369
|
+
<a id="enable-challenge-captcha-challenge-parameters-custom-page"></a>• [`custom_page`](#enable-challenge-captcha-challenge-parameters-custom-page) - Optional String<br>Custom message for Captcha Challenge. Custom 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. 'Please Wait.' or it can be HTML paragraph or a body string encoded as base64 string E.g. '`<p>` Please Wait `</p>`'. Base64 encoded string for this HTML is 'PHA+IFBsZWFzZSBXYWl0IDwvcD4='
|
|
2370
|
+
|
|
2371
|
+
#### Enable Challenge Js Challenge Parameters
|
|
2372
|
+
|
|
2373
|
+
A [`js_challenge_parameters`](#enable-challenge-js-challenge-parameters) block (within [`enable_challenge`](#enable-challenge)) supports the following:
|
|
2374
|
+
|
|
2375
|
+
<a id="enable-challenge-js-challenge-parameters-cookie-expiry"></a>• [`cookie_expiry`](#enable-challenge-js-challenge-parameters-cookie-expiry) - Optional Number<br>Cookie Expiration Period. Cookie expiration period, in seconds. An expired cookie causes the loadbalancer to issue a new challenge
|
|
2376
|
+
|
|
2377
|
+
<a id="enable-challenge-js-challenge-parameters-custom-page"></a>• [`custom_page`](#enable-challenge-js-challenge-parameters-custom-page) - Optional String<br>Custom Message for Javascript Challenge. Custom 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. 'Please Wait.' or it can be HTML paragraph or a body string encoded as base64 string E.g. '`<p>` Please Wait `</p>`'. Base64 encoded string for this HTML is 'PHA+IFBsZWFzZSBXYWl0IDwvcD4='
|
|
2378
|
+
|
|
2379
|
+
<a id="enable-challenge-js-challenge-parameters-js-script-delay"></a>• [`js_script_delay`](#enable-challenge-js-challenge-parameters-js-script-delay) - Optional Number<br>Javascript Delay. Delay introduced by Javascript, in milliseconds
|
|
2380
|
+
|
|
2381
|
+
#### Enable Challenge Malicious User Mitigation
|
|
2382
|
+
|
|
2383
|
+
A [`malicious_user_mitigation`](#enable-challenge-malicious-user-mitigation) block (within [`enable_challenge`](#enable-challenge)) supports the following:
|
|
2384
|
+
|
|
2385
|
+
<a id="enable-challenge-malicious-user-mitigation-name"></a>• [`name`](#enable-challenge-malicious-user-mitigation-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
|
|
2386
|
+
|
|
2387
|
+
<a id="enable-challenge-malicious-user-mitigation-namespace"></a>• [`namespace`](#enable-challenge-malicious-user-mitigation-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
|
|
2388
|
+
|
|
2389
|
+
<a id="enable-challenge-malicious-user-mitigation-tenant"></a>• [`tenant`](#enable-challenge-malicious-user-mitigation-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
|
|
2390
|
+
|
|
2391
|
+
#### Enable IP Reputation
|
|
2392
|
+
|
|
2393
|
+
An [`enable_ip_reputation`](#enable-ip-reputation) block supports the following:
|
|
2394
|
+
|
|
2395
|
+
<a id="enable-ip-reputation-ip-threat-categories"></a>• [`ip_threat_categories`](#enable-ip-reputation-ip-threat-categories) - 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
|
|
2396
|
+
|
|
2397
|
+
#### GraphQL Rules
|
|
2398
|
+
|
|
2399
|
+
A [`graphql_rules`](#graphql-rules) block supports the following:
|
|
2400
|
+
|
|
2401
|
+
<a id="graphql-rules-any-domain"></a>• [`any_domain`](#graphql-rules-any-domain) - Optional Block<br>Enable this option
|
|
2402
|
+
|
|
2403
|
+
<a id="graphql-rules-exact-path"></a>• [`exact_path`](#graphql-rules-exact-path) - Optional String Defaults to `/GraphQL`<br>Path. Specifies the exact path to GraphQL endpoint
|
|
2404
|
+
|
|
2405
|
+
<a id="graphql-rules-exact-value"></a>• [`exact_value`](#graphql-rules-exact-value) - Optional String<br>Exact Value. Exact domain name
|
|
2406
|
+
|
|
2407
|
+
<a id="graphql-rules-graphql-settings"></a>• [`graphql_settings`](#graphql-rules-graphql-settings) - Optional Block<br>GraphQL Settings. GraphQL configuration<br>See [GraphQL Settings](#graphql-rules-graphql-settings) below.
|
|
2408
|
+
|
|
2409
|
+
<a id="graphql-rules-metadata"></a>• [`metadata`](#graphql-rules-metadata) - 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](#graphql-rules-metadata) below.
|
|
2410
|
+
|
|
2411
|
+
<a id="graphql-rules-method-get"></a>• [`method_get`](#graphql-rules-method-get) - Optional Block<br>Enable this option
|
|
2412
|
+
|
|
2413
|
+
<a id="graphql-rules-method-post"></a>• [`method_post`](#graphql-rules-method-post) - Optional Block<br>Enable this option
|
|
2414
|
+
|
|
2415
|
+
<a id="graphql-rules-suffix-value"></a>• [`suffix_value`](#graphql-rules-suffix-value) - Optional String<br>Suffix Value. Suffix of domain name e.g 'xyz.com' will match '*.xyz.com' and 'xyz.com'
|
|
2416
|
+
|
|
2417
|
+
#### GraphQL Rules GraphQL Settings
|
|
2418
|
+
|
|
2419
|
+
A [`graphql_settings`](#graphql-rules-graphql-settings) block (within [`graphql_rules`](#graphql-rules)) supports the following:
|
|
2420
|
+
|
|
2421
|
+
<a id="graphql-rules-graphql-settings-disable-introspection"></a>• [`disable_introspection`](#graphql-rules-graphql-settings-disable-introspection) - Optional Block<br>Enable this option
|
|
2422
|
+
|
|
2423
|
+
<a id="graphql-rules-graphql-settings-enable-introspection"></a>• [`enable_introspection`](#graphql-rules-graphql-settings-enable-introspection) - Optional Block<br>Enable this option
|
|
2424
|
+
|
|
2425
|
+
<a id="graphql-rules-graphql-settings-max-batched-queries"></a>• [`max_batched_queries`](#graphql-rules-graphql-settings-max-batched-queries) - Optional Number<br>Maximum Batched Queries. Specify maximum number of queries in a single batched request
|
|
2426
|
+
|
|
2427
|
+
<a id="graphql-rules-graphql-settings-max-depth"></a>• [`max_depth`](#graphql-rules-graphql-settings-max-depth) - Optional Number<br>Maximum Structure Depth. Specify maximum depth for the GraphQL query
|
|
2428
|
+
|
|
2429
|
+
<a id="graphql-rules-graphql-settings-max-total-length"></a>• [`max_total_length`](#graphql-rules-graphql-settings-max-total-length) - Optional Number<br>Maximum Total Length. Specify maximum length in bytes for the GraphQL query
|
|
2430
|
+
|
|
2431
|
+
#### GraphQL Rules Metadata
|
|
2432
|
+
|
|
2433
|
+
A [`metadata`](#graphql-rules-metadata) block (within [`graphql_rules`](#graphql-rules)) supports the following:
|
|
2434
|
+
|
|
2435
|
+
<a id="graphql-rules-metadata-description-spec"></a>• [`description_spec`](#graphql-rules-metadata-description-spec) - Optional String<br>Description. Human readable description
|
|
2436
|
+
|
|
2437
|
+
<a id="graphql-rules-metadata-name"></a>• [`name`](#graphql-rules-metadata-name) - Optional String<br>Name. This is the name of the message. The value of name has to follow DNS-1035 format
|
|
2438
|
+
|
|
2439
|
+
#### HTTP
|
|
2440
|
+
|
|
2441
|
+
A [`http`](#http) block supports the following:
|
|
2442
|
+
|
|
2443
|
+
<a id="http-dns-volterra-managed"></a>• [`dns_volterra_managed`](#http-dns-volterra-managed) - Optional Bool<br>Automatically Manage DNS Records. DNS records for domains will be managed automatically by F5 Distributed Cloud. As a prerequisite, the domain must be delegated to F5 Distributed Cloud using Delegated domain feature or a DNS CNAME record should be created in your DNS provider's portal
|
|
2444
|
+
|
|
2445
|
+
<a id="http-port"></a>• [`port`](#http-port) - Optional Number<br>HTTP Listen Port. HTTP port to Listen
|
|
2446
|
+
|
|
2447
|
+
<a id="http-port-ranges"></a>• [`port_ranges`](#http-port-ranges) - Optional String<br>Port Ranges. A string containing a comma separated list of port ranges. Each port range consists of a single port or two ports separated by '-'
|
|
2448
|
+
|
|
2449
|
+
#### HTTPS
|
|
2450
|
+
|
|
2451
|
+
A [`https`](#https) block supports the following:
|
|
2452
|
+
|
|
2453
|
+
<a id="https-add-hsts"></a>• [`add_hsts`](#https-add-hsts) - Optional Bool<br>Add HSTS Header. Add HTTP Strict-Transport-Security response header
|
|
2454
|
+
|
|
2455
|
+
<a id="https-http-redirect"></a>• [`http_redirect`](#https-http-redirect) - Optional Bool<br>HTTP Redirect to HTTPS. Redirect HTTP traffic to HTTPS
|
|
2456
|
+
|
|
2457
|
+
<a id="https-tls-cert-options"></a>• [`tls_cert_options`](#https-tls-cert-options) - Optional Block<br>TLS Options. TLS Certificate Options<br>See [TLS Cert Options](#https-tls-cert-options) below.
|
|
2458
|
+
|
|
2459
|
+
#### HTTPS TLS Cert Options
|
|
2460
|
+
|
|
2461
|
+
A [`tls_cert_options`](#https-tls-cert-options) block (within [`https`](#https)) supports the following:
|
|
2462
|
+
|
|
2463
|
+
<a id="https-tls-cert-options-tls-cert-params"></a>• [`tls_cert_params`](#https-tls-cert-options-tls-cert-params) - Optional Block<br>TLS Parameters. Select TLS Parameters and Certificates<br>See [TLS Cert Params](#https-tls-cert-options-tls-cert-params) below.
|
|
2464
|
+
|
|
2465
|
+
<a id="https-tls-cert-options-tls-inline-params"></a>• [`tls_inline_params`](#https-tls-cert-options-tls-inline-params) - Optional Block<br>Inline TLS Parameters. Inline TLS parameters<br>See [TLS Inline Params](#https-tls-cert-options-tls-inline-params) below.
|
|
2466
|
+
|
|
2467
|
+
#### HTTPS TLS Cert Options TLS Cert Params
|
|
2468
|
+
|
|
2469
|
+
A [`tls_cert_params`](#https-tls-cert-options-tls-cert-params) block (within [`https.tls_cert_options`](#https-tls-cert-options)) supports the following:
|
|
2470
|
+
|
|
2471
|
+
<a id="https-tls-cert-options-tls-cert-params-certificates"></a>• [`certificates`](#https-tls-cert-options-tls-cert-params-certificates) - Optional Block<br>Certificates. Select one or more certificates with any domain names<br>See [Certificates](#https-tls-cert-options-tls-cert-params-certificates) below.
|
|
2472
|
+
|
|
2473
|
+
<a id="https-tls-cert-options-tls-cert-params-no-mtls"></a>• [`no_mtls`](#https-tls-cert-options-tls-cert-params-no-mtls) - Optional Block<br>Enable this option
|
|
2474
|
+
|
|
2475
|
+
<a id="https-tls-cert-options-tls-cert-params-tls-config"></a>• [`tls_config`](#https-tls-cert-options-tls-cert-params-tls-config) - Optional Block<br>TLS Config. This defines various options to configure TLS configuration parameters<br>See [TLS Config](#https-tls-cert-options-tls-cert-params-tls-config) below.
|
|
2476
|
+
|
|
2477
|
+
<a id="https-tls-cert-options-tls-cert-params-use-mtls"></a>• [`use_mtls`](#https-tls-cert-options-tls-cert-params-use-mtls) - Optional Block<br>Clients TLS validation context. Validation context for downstream client TLS connections<br>See [Use mTLS](#https-tls-cert-options-tls-cert-params-use-mtls) below.
|
|
2478
|
+
|
|
2479
|
+
#### HTTPS TLS Cert Options TLS Cert Params Certificates
|
|
2480
|
+
|
|
2481
|
+
A [`certificates`](#https-tls-cert-options-tls-cert-params-certificates) block (within [`https.tls_cert_options.tls_cert_params`](#https-tls-cert-options-tls-cert-params)) supports the following:
|
|
2482
|
+
|
|
2483
|
+
<a id="https-tls-cert-options-tls-cert-params-certificates-name"></a>• [`name`](#https-tls-cert-options-tls-cert-params-certificates-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
|
|
2484
|
+
|
|
2485
|
+
<a id="https-tls-cert-options-tls-cert-params-certificates-namespace"></a>• [`namespace`](#https-tls-cert-options-tls-cert-params-certificates-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
|
|
2486
|
+
|
|
2487
|
+
<a id="https-tls-cert-options-tls-cert-params-certificates-tenant"></a>• [`tenant`](#https-tls-cert-options-tls-cert-params-certificates-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
|
|
2488
|
+
|
|
2489
|
+
#### HTTPS TLS Cert Options TLS Cert Params TLS Config
|
|
2490
|
+
|
|
2491
|
+
A [`tls_config`](#https-tls-cert-options-tls-cert-params-tls-config) block (within [`https.tls_cert_options.tls_cert_params`](#https-tls-cert-options-tls-cert-params)) supports the following:
|
|
2492
|
+
|
|
2493
|
+
<a id="https-tls-cert-options-tls-cert-params-tls-config-custom-security"></a>• [`custom_security`](#https-tls-cert-options-tls-cert-params-tls-config-custom-security) - Optional Block<br>Custom Ciphers. This defines TLS protocol config including min/max versions and allowed ciphers<br>See [Custom Security](#https-tls-cert-options-tls-cert-params-tls-config-custom-security) below.
|
|
2494
|
+
|
|
2495
|
+
<a id="https-tls-cert-options-tls-cert-params-tls-config-default-security"></a>• [`default_security`](#https-tls-cert-options-tls-cert-params-tls-config-default-security) - Optional Block<br>Enable this option
|
|
2496
|
+
|
|
2497
|
+
<a id="https-tls-cert-options-tls-cert-params-tls-config-low-security"></a>• [`low_security`](#https-tls-cert-options-tls-cert-params-tls-config-low-security) - Optional Block<br>Enable this option
|
|
2498
|
+
|
|
2499
|
+
<a id="https-tls-cert-options-tls-cert-params-tls-config-medium-security"></a>• [`medium_security`](#https-tls-cert-options-tls-cert-params-tls-config-medium-security) - Optional Block<br>Enable this option
|
|
2500
|
+
|
|
2501
|
+
#### HTTPS TLS Cert Options TLS Cert Params TLS Config Custom Security
|
|
2502
|
+
|
|
2503
|
+
A [`custom_security`](#https-tls-cert-options-tls-cert-params-tls-config-custom-security) block (within [`https.tls_cert_options.tls_cert_params.tls_config`](#https-tls-cert-options-tls-cert-params-tls-config)) supports the following:
|
|
2504
|
+
|
|
2505
|
+
<a id="https-tls-cert-options-tls-cert-params-tls-config-custom-security-cipher-suites"></a>• [`cipher_suites`](#https-tls-cert-options-tls-cert-params-tls-config-custom-security-cipher-suites) - Optional List<br>Cipher Suites. The TLS listener will only support the specified cipher list
|
|
2506
|
+
|
|
2507
|
+
<a id="https-tls-cert-options-tls-cert-params-tls-config-custom-security-max-version"></a>• [`max_version`](#https-tls-cert-options-tls-cert-params-tls-config-custom-security-max-version) - 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="https-tls-cert-options-tls-cert-params-tls-config-custom-security-min-version"></a>• [`min_version`](#https-tls-cert-options-tls-cert-params-tls-config-custom-security-min-version) - 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
|
|
2510
|
+
|
|
2511
|
+
#### HTTPS TLS Cert Options TLS Cert Params Use mTLS
|
|
2512
|
+
|
|
2513
|
+
An [`use_mtls`](#https-tls-cert-options-tls-cert-params-use-mtls) block (within [`https.tls_cert_options.tls_cert_params`](#https-tls-cert-options-tls-cert-params)) supports the following:
|
|
2514
|
+
|
|
2515
|
+
<a id="https-tls-cert-options-tls-cert-params-use-mtls-client-certificate-optional"></a>• [`client_certificate_optional`](#https-tls-cert-options-tls-cert-params-use-mtls-client-certificate-optional) - 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="https-tls-cert-options-tls-cert-params-use-mtls-crl"></a>• [`crl`](#https-tls-cert-options-tls-cert-params-use-mtls-crl) - 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](#https-tls-cert-options-tls-cert-params-use-mtls-crl) below.
|
|
2518
|
+
|
|
2519
|
+
<a id="https-tls-cert-options-tls-cert-params-use-mtls-no-crl"></a>• [`no_crl`](#https-tls-cert-options-tls-cert-params-use-mtls-no-crl) - Optional Block<br>Enable this option
|
|
2520
|
+
|
|
2521
|
+
<a id="https-tls-cert-options-tls-cert-params-use-mtls-trusted-ca"></a>• [`trusted_ca`](#https-tls-cert-options-tls-cert-params-use-mtls-trusted-ca) - 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](#https-tls-cert-options-tls-cert-params-use-mtls-trusted-ca) below.
|
|
2522
|
+
|
|
2523
|
+
<a id="https-tls-cert-options-tls-cert-params-use-mtls-trusted-ca-url"></a>• [`trusted_ca_url`](#https-tls-cert-options-tls-cert-params-use-mtls-trusted-ca-url) - Optional String<br>Inline Root CA Certificate (legacy). Upload a Root CA Certificate specifically for this Load Balancer
|
|
2524
|
+
|
|
2525
|
+
<a id="https-tls-cert-options-tls-cert-params-use-mtls-xfcc-disabled"></a>• [`xfcc_disabled`](#https-tls-cert-options-tls-cert-params-use-mtls-xfcc-disabled) - Optional Block<br>Enable this option
|
|
2526
|
+
|
|
2527
|
+
<a id="https-tls-cert-options-tls-cert-params-use-mtls-xfcc-options"></a>• [`xfcc_options`](#https-tls-cert-options-tls-cert-params-use-mtls-xfcc-options) - Optional Block<br>XFCC Header Elements. X-Forwarded-Client-Cert header elements to be added to requests<br>See [Xfcc Options](#https-tls-cert-options-tls-cert-params-use-mtls-xfcc-options) below.
|
|
2528
|
+
|
|
2529
|
+
#### HTTPS TLS Cert Options TLS Cert Params Use mTLS CRL
|
|
2530
|
+
|
|
2531
|
+
A [`crl`](#https-tls-cert-options-tls-cert-params-use-mtls-crl) block (within [`https.tls_cert_options.tls_cert_params.use_mtls`](#https-tls-cert-options-tls-cert-params-use-mtls)) supports the following:
|
|
2532
|
+
|
|
2533
|
+
<a id="https-tls-cert-options-tls-cert-params-use-mtls-crl-name"></a>• [`name`](#https-tls-cert-options-tls-cert-params-use-mtls-crl-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
|
|
2534
|
+
|
|
2535
|
+
<a id="https-tls-cert-options-tls-cert-params-use-mtls-crl-namespace"></a>• [`namespace`](#https-tls-cert-options-tls-cert-params-use-mtls-crl-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
|
|
2536
|
+
|
|
2537
|
+
<a id="https-tls-cert-options-tls-cert-params-use-mtls-crl-tenant"></a>• [`tenant`](#https-tls-cert-options-tls-cert-params-use-mtls-crl-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
|
|
2538
|
+
|
|
2539
|
+
#### HTTPS TLS Cert Options TLS Cert Params Use mTLS Trusted CA
|
|
2540
|
+
|
|
2541
|
+
A [`trusted_ca`](#https-tls-cert-options-tls-cert-params-use-mtls-trusted-ca) block (within [`https.tls_cert_options.tls_cert_params.use_mtls`](#https-tls-cert-options-tls-cert-params-use-mtls)) supports the following:
|
|
2542
|
+
|
|
2543
|
+
<a id="https-tls-cert-options-tls-cert-params-use-mtls-trusted-ca-name"></a>• [`name`](#https-tls-cert-options-tls-cert-params-use-mtls-trusted-ca-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
|
|
2544
|
+
|
|
2545
|
+
<a id="https-tls-cert-options-tls-cert-params-use-mtls-trusted-ca-namespace"></a>• [`namespace`](#https-tls-cert-options-tls-cert-params-use-mtls-trusted-ca-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
|
|
2546
|
+
|
|
2547
|
+
<a id="https-tls-cert-options-tls-cert-params-use-mtls-trusted-ca-tenant"></a>• [`tenant`](#https-tls-cert-options-tls-cert-params-use-mtls-trusted-ca-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
|
|
2548
|
+
|
|
2549
|
+
#### HTTPS TLS Cert Options TLS Cert Params Use mTLS Xfcc Options
|
|
2550
|
+
|
|
2551
|
+
A [`xfcc_options`](#https-tls-cert-options-tls-cert-params-use-mtls-xfcc-options) block (within [`https.tls_cert_options.tls_cert_params.use_mtls`](#https-tls-cert-options-tls-cert-params-use-mtls)) supports the following:
|
|
2552
|
+
|
|
2553
|
+
<a id="https-tls-cert-options-tls-cert-params-use-mtls-xfcc-options-xfcc-header-elements"></a>• [`xfcc_header_elements`](#https-tls-cert-options-tls-cert-params-use-mtls-xfcc-options-xfcc-header-elements) - 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
|
|
2554
|
+
|
|
2555
|
+
#### HTTPS TLS Cert Options TLS Inline Params
|
|
2556
|
+
|
|
2557
|
+
A [`tls_inline_params`](#https-tls-cert-options-tls-inline-params) block (within [`https.tls_cert_options`](#https-tls-cert-options)) supports the following:
|
|
2558
|
+
|
|
2559
|
+
<a id="https-tls-cert-options-tls-inline-params-no-mtls"></a>• [`no_mtls`](#https-tls-cert-options-tls-inline-params-no-mtls) - Optional Block<br>Enable this option
|
|
2560
|
+
|
|
2561
|
+
<a id="https-tls-cert-options-tls-inline-params-tls-certificates"></a>• [`tls_certificates`](#https-tls-cert-options-tls-inline-params-tls-certificates) - Optional Block<br>TLS Certificates. Users can add one or more certificates that share the same set of domains. for example, domain.com and \*.domain.com - but use different signature algorithms<br>See [TLS Certificates](#https-tls-cert-options-tls-inline-params-tls-certificates) below.
|
|
2562
|
+
|
|
2563
|
+
<a id="https-tls-cert-options-tls-inline-params-tls-config"></a>• [`tls_config`](#https-tls-cert-options-tls-inline-params-tls-config) - Optional Block<br>TLS Config. This defines various options to configure TLS configuration parameters<br>See [TLS Config](#https-tls-cert-options-tls-inline-params-tls-config) below.
|
|
2564
|
+
|
|
2565
|
+
<a id="https-tls-cert-options-tls-inline-params-use-mtls"></a>• [`use_mtls`](#https-tls-cert-options-tls-inline-params-use-mtls) - Optional Block<br>Clients TLS validation context. Validation context for downstream client TLS connections<br>See [Use mTLS](#https-tls-cert-options-tls-inline-params-use-mtls) below.
|
|
2566
|
+
|
|
2567
|
+
#### HTTPS TLS Cert Options TLS Inline Params TLS Certificates
|
|
2568
|
+
|
|
2569
|
+
A [`tls_certificates`](#https-tls-cert-options-tls-inline-params-tls-certificates) block (within [`https.tls_cert_options.tls_inline_params`](#https-tls-cert-options-tls-inline-params)) supports the following:
|
|
2570
|
+
|
|
2571
|
+
<a id="https-tls-cert-options-tls-inline-params-tls-certificates-certificate-url"></a>• [`certificate_url`](#https-tls-cert-options-tls-inline-params-tls-certificates-certificate-url) - Optional String<br>Certificate. TLS certificate. Certificate or certificate chain in PEM format including the PEM headers
|
|
2572
|
+
|
|
2573
|
+
<a id="https-tls-cert-options-tls-inline-params-tls-certificates-custom-hash-algorithms"></a>• [`custom_hash_algorithms`](#https-tls-cert-options-tls-inline-params-tls-certificates-custom-hash-algorithms) - Optional Block<br>Hash Algorithms. Specifies the hash algorithms to be used<br>See [Custom Hash Algorithms](#https-tls-cert-options-tls-inline-params-tls-certificates-custom-hash-algorithms) below.
|
|
2574
|
+
|
|
2575
|
+
<a id="https-tls-cert-options-tls-inline-params-tls-certificates-description-spec"></a>• [`description_spec`](#https-tls-cert-options-tls-inline-params-tls-certificates-description-spec) - Optional String<br>Description. Description for the certificate
|
|
2576
|
+
|
|
2577
|
+
<a id="https-tls-cert-options-tls-inline-params-tls-certificates-disable-ocsp-stapling"></a>• [`disable_ocsp_stapling`](#https-tls-cert-options-tls-inline-params-tls-certificates-disable-ocsp-stapling) - Optional Block<br>Enable this option
|
|
2578
|
+
|
|
2579
|
+
<a id="https-tls-cert-options-tls-inline-params-tls-certificates-private-key"></a>• [`private_key`](#https-tls-cert-options-tls-inline-params-tls-certificates-private-key) - Optional Block<br>Secret. SecretType is used in an object to indicate a sensitive/confidential field<br>See [Private Key](#https-tls-cert-options-tls-inline-params-tls-certificates-private-key) below.
|
|
2580
|
+
|
|
2581
|
+
<a id="https-tls-cert-options-tls-inline-params-tls-certificates-use-system-defaults"></a>• [`use_system_defaults`](#https-tls-cert-options-tls-inline-params-tls-certificates-use-system-defaults) - Optional Block<br>Enable this option
|
|
2582
|
+
|
|
2583
|
+
#### HTTPS TLS Cert Options TLS Inline Params TLS Certificates Custom Hash Algorithms
|
|
2584
|
+
|
|
2585
|
+
A [`custom_hash_algorithms`](#https-tls-cert-options-tls-inline-params-tls-certificates-custom-hash-algorithms) block (within [`https.tls_cert_options.tls_inline_params.tls_certificates`](#https-tls-cert-options-tls-inline-params-tls-certificates)) supports the following:
|
|
2586
|
+
|
|
2587
|
+
<a id="https-tls-cert-options-tls-inline-params-tls-certificates-custom-hash-algorithms-hash-algorithms"></a>• [`hash_algorithms`](#https-tls-cert-options-tls-inline-params-tls-certificates-custom-hash-algorithms-hash-algorithms) - 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
|
|
2588
|
+
|
|
2589
|
+
#### HTTPS TLS Cert Options TLS Inline Params TLS Certificates Private Key
|
|
2590
|
+
|
|
2591
|
+
A [`private_key`](#https-tls-cert-options-tls-inline-params-tls-certificates-private-key) block (within [`https.tls_cert_options.tls_inline_params.tls_certificates`](#https-tls-cert-options-tls-inline-params-tls-certificates)) supports the following:
|
|
2592
|
+
|
|
2593
|
+
<a id="https-tls-cert-options-tls-inline-params-tls-certificates-private-key-blindfold-secret-info"></a>• [`blindfold_secret_info`](#https-tls-cert-options-tls-inline-params-tls-certificates-private-key-blindfold-secret-info) - Optional Block<br>Blindfold Secret. BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management<br>See [Blindfold Secret Info](#https-tls-cert-options-tls-inline-params-tls-certificates-private-key-blindfold-secret-info) below.
|
|
2594
|
+
|
|
2595
|
+
<a id="https-tls-cert-options-tls-inline-params-tls-certificates-private-key-clear-secret-info"></a>• [`clear_secret_info`](#https-tls-cert-options-tls-inline-params-tls-certificates-private-key-clear-secret-info) - Optional Block<br>In-Clear Secret. ClearSecretInfoType specifies information about the Secret that is not encrypted<br>See [Clear Secret Info](#https-tls-cert-options-tls-inline-params-tls-certificates-private-key-clear-secret-info) below.
|
|
2596
|
+
|
|
2597
|
+
#### HTTPS TLS Cert Options TLS Inline Params TLS Certificates Private Key Blindfold Secret Info
|
|
2598
|
+
|
|
2599
|
+
A [`blindfold_secret_info`](#https-tls-cert-options-tls-inline-params-tls-certificates-private-key-blindfold-secret-info) block (within [`https.tls_cert_options.tls_inline_params.tls_certificates.private_key`](#https-tls-cert-options-tls-inline-params-tls-certificates-private-key)) supports the following:
|
|
2600
|
+
|
|
2601
|
+
<a id="https-tls-cert-options-tls-inline-params-tls-certificates-private-key-blindfold-secret-info-decryption-provider"></a>• [`decryption_provider`](#https-tls-cert-options-tls-inline-params-tls-certificates-private-key-blindfold-secret-info-decryption-provider) - 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="https-tls-cert-options-tls-inline-params-tls-certificates-private-key-blindfold-secret-info-location"></a>• [`location`](#https-tls-cert-options-tls-inline-params-tls-certificates-private-key-blindfold-secret-info-location) - 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="https-tls-cert-options-tls-inline-params-tls-certificates-private-key-blindfold-secret-info-store-provider"></a>• [`store_provider`](#https-tls-cert-options-tls-inline-params-tls-certificates-private-key-blindfold-secret-info-store-provider) - 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:///
|
|
2606
|
+
|
|
2607
|
+
#### HTTPS TLS Cert Options TLS Inline Params TLS Certificates Private Key Clear Secret Info
|
|
2608
|
+
|
|
2609
|
+
A [`clear_secret_info`](#https-tls-cert-options-tls-inline-params-tls-certificates-private-key-clear-secret-info) block (within [`https.tls_cert_options.tls_inline_params.tls_certificates.private_key`](#https-tls-cert-options-tls-inline-params-tls-certificates-private-key)) supports the following:
|
|
2610
|
+
|
|
2611
|
+
<a id="https-tls-cert-options-tls-inline-params-tls-certificates-private-key-clear-secret-info-provider-ref"></a>• [`provider_ref`](#https-tls-cert-options-tls-inline-params-tls-certificates-private-key-clear-secret-info-provider-ref) - 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="https-tls-cert-options-tls-inline-params-tls-certificates-private-key-clear-secret-info-url"></a>• [`url`](#https-tls-cert-options-tls-inline-params-tls-certificates-private-key-clear-secret-info-url) - 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
|
|
2614
|
+
|
|
2615
|
+
#### HTTPS TLS Cert Options TLS Inline Params TLS Config
|
|
2616
|
+
|
|
2617
|
+
A [`tls_config`](#https-tls-cert-options-tls-inline-params-tls-config) block (within [`https.tls_cert_options.tls_inline_params`](#https-tls-cert-options-tls-inline-params)) supports the following:
|
|
2618
|
+
|
|
2619
|
+
<a id="https-tls-cert-options-tls-inline-params-tls-config-custom-security"></a>• [`custom_security`](#https-tls-cert-options-tls-inline-params-tls-config-custom-security) - Optional Block<br>Custom Ciphers. This defines TLS protocol config including min/max versions and allowed ciphers<br>See [Custom Security](#https-tls-cert-options-tls-inline-params-tls-config-custom-security) below.
|
|
2620
|
+
|
|
2621
|
+
<a id="https-tls-cert-options-tls-inline-params-tls-config-default-security"></a>• [`default_security`](#https-tls-cert-options-tls-inline-params-tls-config-default-security) - Optional Block<br>Enable this option
|
|
2622
|
+
|
|
2623
|
+
<a id="https-tls-cert-options-tls-inline-params-tls-config-low-security"></a>• [`low_security`](#https-tls-cert-options-tls-inline-params-tls-config-low-security) - Optional Block<br>Enable this option
|
|
2624
|
+
|
|
2625
|
+
<a id="https-tls-cert-options-tls-inline-params-tls-config-medium-security"></a>• [`medium_security`](#https-tls-cert-options-tls-inline-params-tls-config-medium-security) - Optional Block<br>Enable this option
|
|
2626
|
+
|
|
2627
|
+
#### HTTPS TLS Cert Options TLS Inline Params TLS Config Custom Security
|
|
2628
|
+
|
|
2629
|
+
A [`custom_security`](#https-tls-cert-options-tls-inline-params-tls-config-custom-security) block (within [`https.tls_cert_options.tls_inline_params.tls_config`](#https-tls-cert-options-tls-inline-params-tls-config)) supports the following:
|
|
2630
|
+
|
|
2631
|
+
<a id="https-tls-cert-options-tls-inline-params-tls-config-custom-security-cipher-suites"></a>• [`cipher_suites`](#https-tls-cert-options-tls-inline-params-tls-config-custom-security-cipher-suites) - Optional List<br>Cipher Suites. The TLS listener will only support the specified cipher list
|
|
2632
|
+
|
|
2633
|
+
<a id="https-tls-cert-options-tls-inline-params-tls-config-custom-security-max-version"></a>• [`max_version`](#https-tls-cert-options-tls-inline-params-tls-config-custom-security-max-version) - 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="https-tls-cert-options-tls-inline-params-tls-config-custom-security-min-version"></a>• [`min_version`](#https-tls-cert-options-tls-inline-params-tls-config-custom-security-min-version) - 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
|
|
2636
|
+
|
|
2637
|
+
#### HTTPS TLS Cert Options TLS Inline Params Use mTLS
|
|
2638
|
+
|
|
2639
|
+
An [`use_mtls`](#https-tls-cert-options-tls-inline-params-use-mtls) block (within [`https.tls_cert_options.tls_inline_params`](#https-tls-cert-options-tls-inline-params)) supports the following:
|
|
2640
|
+
|
|
2641
|
+
<a id="https-tls-cert-options-tls-inline-params-use-mtls-client-certificate-optional"></a>• [`client_certificate_optional`](#https-tls-cert-options-tls-inline-params-use-mtls-client-certificate-optional) - 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="https-tls-cert-options-tls-inline-params-use-mtls-crl"></a>• [`crl`](#https-tls-cert-options-tls-inline-params-use-mtls-crl) - 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](#https-tls-cert-options-tls-inline-params-use-mtls-crl) below.
|
|
2644
|
+
|
|
2645
|
+
<a id="https-tls-cert-options-tls-inline-params-use-mtls-no-crl"></a>• [`no_crl`](#https-tls-cert-options-tls-inline-params-use-mtls-no-crl) - Optional Block<br>Enable this option
|
|
2646
|
+
|
|
2647
|
+
<a id="https-tls-cert-options-tls-inline-params-use-mtls-trusted-ca"></a>• [`trusted_ca`](#https-tls-cert-options-tls-inline-params-use-mtls-trusted-ca) - 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](#https-tls-cert-options-tls-inline-params-use-mtls-trusted-ca) below.
|
|
2648
|
+
|
|
2649
|
+
<a id="https-tls-cert-options-tls-inline-params-use-mtls-trusted-ca-url"></a>• [`trusted_ca_url`](#https-tls-cert-options-tls-inline-params-use-mtls-trusted-ca-url) - Optional String<br>Inline Root CA Certificate (legacy). Upload a Root CA Certificate specifically for this Load Balancer
|
|
2650
|
+
|
|
2651
|
+
<a id="https-tls-cert-options-tls-inline-params-use-mtls-xfcc-disabled"></a>• [`xfcc_disabled`](#https-tls-cert-options-tls-inline-params-use-mtls-xfcc-disabled) - Optional Block<br>Enable this option
|
|
2652
|
+
|
|
2653
|
+
<a id="https-tls-cert-options-tls-inline-params-use-mtls-xfcc-options"></a>• [`xfcc_options`](#https-tls-cert-options-tls-inline-params-use-mtls-xfcc-options) - Optional Block<br>XFCC Header Elements. X-Forwarded-Client-Cert header elements to be added to requests<br>See [Xfcc Options](#https-tls-cert-options-tls-inline-params-use-mtls-xfcc-options) below.
|
|
2654
|
+
|
|
2655
|
+
#### HTTPS TLS Cert Options TLS Inline Params Use mTLS CRL
|
|
2656
|
+
|
|
2657
|
+
A [`crl`](#https-tls-cert-options-tls-inline-params-use-mtls-crl) block (within [`https.tls_cert_options.tls_inline_params.use_mtls`](#https-tls-cert-options-tls-inline-params-use-mtls)) supports the following:
|
|
2658
|
+
|
|
2659
|
+
<a id="https-tls-cert-options-tls-inline-params-use-mtls-crl-name"></a>• [`name`](#https-tls-cert-options-tls-inline-params-use-mtls-crl-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
|
|
2660
|
+
|
|
2661
|
+
<a id="https-tls-cert-options-tls-inline-params-use-mtls-crl-namespace"></a>• [`namespace`](#https-tls-cert-options-tls-inline-params-use-mtls-crl-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
|
|
2662
|
+
|
|
2663
|
+
<a id="https-tls-cert-options-tls-inline-params-use-mtls-crl-tenant"></a>• [`tenant`](#https-tls-cert-options-tls-inline-params-use-mtls-crl-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
|
|
2664
|
+
|
|
2665
|
+
#### HTTPS TLS Cert Options TLS Inline Params Use mTLS Trusted CA
|
|
2666
|
+
|
|
2667
|
+
A [`trusted_ca`](#https-tls-cert-options-tls-inline-params-use-mtls-trusted-ca) block (within [`https.tls_cert_options.tls_inline_params.use_mtls`](#https-tls-cert-options-tls-inline-params-use-mtls)) supports the following:
|
|
2668
|
+
|
|
2669
|
+
<a id="https-tls-cert-options-tls-inline-params-use-mtls-trusted-ca-name"></a>• [`name`](#https-tls-cert-options-tls-inline-params-use-mtls-trusted-ca-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
|
|
2670
|
+
|
|
2671
|
+
<a id="https-tls-cert-options-tls-inline-params-use-mtls-trusted-ca-namespace"></a>• [`namespace`](#https-tls-cert-options-tls-inline-params-use-mtls-trusted-ca-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
|
|
2672
|
+
|
|
2673
|
+
<a id="https-tls-cert-options-tls-inline-params-use-mtls-trusted-ca-tenant"></a>• [`tenant`](#https-tls-cert-options-tls-inline-params-use-mtls-trusted-ca-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
|
|
2674
|
+
|
|
2675
|
+
#### HTTPS TLS Cert Options TLS Inline Params Use mTLS Xfcc Options
|
|
2676
|
+
|
|
2677
|
+
A [`xfcc_options`](#https-tls-cert-options-tls-inline-params-use-mtls-xfcc-options) block (within [`https.tls_cert_options.tls_inline_params.use_mtls`](#https-tls-cert-options-tls-inline-params-use-mtls)) supports the following:
|
|
2678
|
+
|
|
2679
|
+
<a id="https-tls-cert-options-tls-inline-params-use-mtls-xfcc-options-xfcc-header-elements"></a>• [`xfcc_header_elements`](#https-tls-cert-options-tls-inline-params-use-mtls-xfcc-options-xfcc-header-elements) - 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
|
|
2680
|
+
|
|
2681
|
+
#### HTTPS Auto Cert
|
|
2682
|
+
|
|
2683
|
+
A [`https_auto_cert`](#https-auto-cert) block supports the following:
|
|
2684
|
+
|
|
2685
|
+
<a id="https-auto-cert-add-hsts"></a>• [`add_hsts`](#https-auto-cert-add-hsts) - Optional Bool<br>Add HSTS Header. Add HTTP Strict-Transport-Security response header
|
|
2686
|
+
|
|
2687
|
+
<a id="https-auto-cert-http-redirect"></a>• [`http_redirect`](#https-auto-cert-http-redirect) - Optional Bool<br>HTTP Redirect to HTTPS. Redirect HTTP traffic to HTTPS
|
|
2688
|
+
|
|
2689
|
+
<a id="https-auto-cert-tls-config"></a>• [`tls_config`](#https-auto-cert-tls-config) - Optional Block<br>TLS Config. This defines various options to configure TLS configuration parameters<br>See [TLS Config](#https-auto-cert-tls-config) below.
|
|
2690
|
+
|
|
2691
|
+
#### HTTPS Auto Cert TLS Config
|
|
2692
|
+
|
|
2693
|
+
A [`tls_config`](#https-auto-cert-tls-config) block (within [`https_auto_cert`](#https-auto-cert)) supports the following:
|
|
2694
|
+
|
|
2695
|
+
<a id="https-auto-cert-tls-config-tls-11-plus"></a>• [`tls_11_plus`](#https-auto-cert-tls-config-tls-11-plus) - Optional Block<br>Enable this option
|
|
2696
|
+
|
|
2697
|
+
<a id="https-auto-cert-tls-config-tls-12-plus"></a>• [`tls_12_plus`](#https-auto-cert-tls-config-tls-12-plus) - Optional Block<br>Enable this option
|
|
2698
|
+
|
|
2699
|
+
#### Js Challenge
|
|
2700
|
+
|
|
2701
|
+
A [`js_challenge`](#js-challenge) block supports the following:
|
|
2702
|
+
|
|
2703
|
+
<a id="js-challenge-cookie-expiry"></a>• [`cookie_expiry`](#js-challenge-cookie-expiry) - Optional Number<br>Cookie Expiration Period. Cookie expiration period, in seconds. An expired cookie causes the loadbalancer to issue a new challenge
|
|
2704
|
+
|
|
2705
|
+
<a id="js-challenge-custom-page"></a>• [`custom_page`](#js-challenge-custom-page) - Optional String<br>Custom Message for Javascript Challenge. Custom 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. 'Please Wait.' or it can be HTML paragraph or a body string encoded as base64 string E.g. '`<p>` Please Wait `</p>`'. Base64 encoded string for this HTML is 'PHA+IFBsZWFzZSBXYWl0IDwvcD4='
|
|
2706
|
+
|
|
2707
|
+
<a id="js-challenge-js-script-delay"></a>• [`js_script_delay`](#js-challenge-js-script-delay) - Optional Number<br>Javascript Delay. Delay introduced by Javascript, in milliseconds
|
|
2708
|
+
|
|
2709
|
+
#### JWT Validation
|
|
2710
|
+
|
|
2711
|
+
A [`jwt_validation`](#jwt-validation) block supports the following:
|
|
2712
|
+
|
|
2713
|
+
<a id="jwt-validation-action"></a>• [`action`](#jwt-validation-action) - Optional Block<br>Action<br>See [Action](#jwt-validation-action) below.
|
|
2714
|
+
|
|
2715
|
+
<a id="jwt-validation-jwks-config"></a>• [`jwks_config`](#jwt-validation-jwks-config) - Optional Block<br>JSON Web Key Set (JWKS). The JSON Web Key Set (JWKS) is a set of keys used to verify JSON Web Token (JWT) issued by the Authorization Server. See RFC 7517 for more details<br>See [Jwks Config](#jwt-validation-jwks-config) below.
|
|
2716
|
+
|
|
2717
|
+
<a id="jwt-validation-mandatory-claims"></a>• [`mandatory_claims`](#jwt-validation-mandatory-claims) - Optional Block<br>Mandatory Claims. Configurable Validation of mandatory Claims<br>See [Mandatory Claims](#jwt-validation-mandatory-claims) below.
|
|
2718
|
+
|
|
2719
|
+
<a id="jwt-validation-reserved-claims"></a>• [`reserved_claims`](#jwt-validation-reserved-claims) - Optional Block<br>Reserved claims configuration. Configurable Validation of reserved Claims<br>See [Reserved Claims](#jwt-validation-reserved-claims) below.
|
|
2720
|
+
|
|
2721
|
+
<a id="jwt-validation-target"></a>• [`target`](#jwt-validation-target) - Optional Block<br>Target. Define endpoints for which JWT token validation will be performed<br>See [Target](#jwt-validation-target) below.
|
|
2722
|
+
|
|
2723
|
+
<a id="jwt-validation-token-location"></a>• [`token_location`](#jwt-validation-token-location) - Optional Block<br>Token Location. Location of JWT in HTTP request<br>See [Token Location](#jwt-validation-token-location) below.
|
|
2724
|
+
|
|
2725
|
+
#### JWT Validation Action
|
|
2726
|
+
|
|
2727
|
+
An [`action`](#jwt-validation-action) block (within [`jwt_validation`](#jwt-validation)) supports the following:
|
|
2728
|
+
|
|
2729
|
+
<a id="jwt-validation-action-block"></a>• [`block`](#jwt-validation-action-block) - Optional Block<br>Enable this option
|
|
2730
|
+
|
|
2731
|
+
<a id="jwt-validation-action-report"></a>• [`report`](#jwt-validation-action-report) - Optional Block<br>Enable this option
|
|
2732
|
+
|
|
2733
|
+
#### JWT Validation Jwks Config
|
|
2734
|
+
|
|
2735
|
+
A [`jwks_config`](#jwt-validation-jwks-config) block (within [`jwt_validation`](#jwt-validation)) supports the following:
|
|
2736
|
+
|
|
2737
|
+
<a id="jwt-validation-jwks-config-cleartext"></a>• [`cleartext`](#jwt-validation-jwks-config-cleartext) - Optional String<br>JSON Web Key Set (JWKS). The JSON Web Key Set (JWKS) is a set of keys used to verify JSON Web Token (JWT) issued by the Authorization Server. See RFC 7517 for more details
|
|
2738
|
+
|
|
2739
|
+
#### JWT Validation Mandatory Claims
|
|
2740
|
+
|
|
2741
|
+
A [`mandatory_claims`](#jwt-validation-mandatory-claims) block (within [`jwt_validation`](#jwt-validation)) supports the following:
|
|
2742
|
+
|
|
2743
|
+
<a id="jwt-validation-mandatory-claims-claim-names"></a>• [`claim_names`](#jwt-validation-mandatory-claims-claim-names) - Optional List<br>Claim Names
|
|
2744
|
+
|
|
2745
|
+
#### JWT Validation Reserved Claims
|
|
2746
|
+
|
|
2747
|
+
A [`reserved_claims`](#jwt-validation-reserved-claims) block (within [`jwt_validation`](#jwt-validation)) supports the following:
|
|
2748
|
+
|
|
2749
|
+
<a id="jwt-validation-reserved-claims-audience"></a>• [`audience`](#jwt-validation-reserved-claims-audience) - Optional Block<br>Audiences<br>See [Audience](#jwt-validation-reserved-claims-audience) below.
|
|
2750
|
+
|
|
2751
|
+
<a id="jwt-validation-reserved-claims-audience-disable"></a>• [`audience_disable`](#jwt-validation-reserved-claims-audience-disable) - Optional Block<br>Enable this option
|
|
2752
|
+
|
|
2753
|
+
<a id="jwt-validation-reserved-claims-issuer"></a>• [`issuer`](#jwt-validation-reserved-claims-issuer) - Optional String<br>Exact Match
|
|
2754
|
+
|
|
2755
|
+
<a id="jwt-validation-reserved-claims-issuer-disable"></a>• [`issuer_disable`](#jwt-validation-reserved-claims-issuer-disable) - Optional Block<br>Enable this option
|
|
2756
|
+
|
|
2757
|
+
<a id="jwt-validation-reserved-claims-validate-period-disable"></a>• [`validate_period_disable`](#jwt-validation-reserved-claims-validate-period-disable) - Optional Block<br>Enable this option
|
|
2758
|
+
|
|
2759
|
+
<a id="jwt-validation-reserved-claims-validate-period-enable"></a>• [`validate_period_enable`](#jwt-validation-reserved-claims-validate-period-enable) - Optional Block<br>Enable this option
|
|
2760
|
+
|
|
2761
|
+
#### JWT Validation Reserved Claims Audience
|
|
2762
|
+
|
|
2763
|
+
An [`audience`](#jwt-validation-reserved-claims-audience) block (within [`jwt_validation.reserved_claims`](#jwt-validation-reserved-claims)) supports the following:
|
|
2764
|
+
|
|
2765
|
+
<a id="jwt-validation-reserved-claims-audience-audiences"></a>• [`audiences`](#jwt-validation-reserved-claims-audience-audiences) - Optional List<br>Values
|
|
2766
|
+
|
|
2767
|
+
#### JWT Validation Target
|
|
2768
|
+
|
|
2769
|
+
A [`target`](#jwt-validation-target) block (within [`jwt_validation`](#jwt-validation)) supports the following:
|
|
2770
|
+
|
|
2771
|
+
<a id="jwt-validation-target-all-endpoint"></a>• [`all_endpoint`](#jwt-validation-target-all-endpoint) - Optional Block<br>Enable this option
|
|
2772
|
+
|
|
2773
|
+
<a id="jwt-validation-target-api-groups"></a>• [`api_groups`](#jwt-validation-target-api-groups) - Optional Block<br>API Groups<br>See [API Groups](#jwt-validation-target-api-groups) below.
|
|
2774
|
+
|
|
2775
|
+
<a id="jwt-validation-target-base-paths"></a>• [`base_paths`](#jwt-validation-target-base-paths) - Optional Block<br>Base Paths<br>See [Base Paths](#jwt-validation-target-base-paths) below.
|
|
2776
|
+
|
|
2777
|
+
#### JWT Validation Target API Groups
|
|
2778
|
+
|
|
2779
|
+
An [`api_groups`](#jwt-validation-target-api-groups) block (within [`jwt_validation.target`](#jwt-validation-target)) supports the following:
|
|
2780
|
+
|
|
2781
|
+
<a id="jwt-validation-target-api-groups-api-groups"></a>• [`api_groups`](#jwt-validation-target-api-groups-api-groups) - Optional List<br>API Groups
|
|
2782
|
+
|
|
2783
|
+
#### JWT Validation Target Base Paths
|
|
2784
|
+
|
|
2785
|
+
A [`base_paths`](#jwt-validation-target-base-paths) block (within [`jwt_validation.target`](#jwt-validation-target)) supports the following:
|
|
2786
|
+
|
|
2787
|
+
<a id="jwt-validation-target-base-paths-base-paths"></a>• [`base_paths`](#jwt-validation-target-base-paths-base-paths) - Optional List<br>Prefix Values
|
|
2788
|
+
|
|
2789
|
+
#### JWT Validation Token Location
|
|
2790
|
+
|
|
2791
|
+
A [`token_location`](#jwt-validation-token-location) block (within [`jwt_validation`](#jwt-validation)) supports the following:
|
|
2792
|
+
|
|
2793
|
+
<a id="jwt-validation-token-location-bearer-token"></a>• [`bearer_token`](#jwt-validation-token-location-bearer-token) - Optional Block<br>Enable this option
|
|
2794
|
+
|
|
2795
|
+
#### L7 DDOS Action Js Challenge
|
|
2796
|
+
|
|
2797
|
+
A [`l7_ddos_action_js_challenge`](#l7-ddos-action-js-challenge) block supports the following:
|
|
2798
|
+
|
|
2799
|
+
<a id="l7-ddos-action-js-challenge-cookie-expiry"></a>• [`cookie_expiry`](#l7-ddos-action-js-challenge-cookie-expiry) - Optional Number<br>Cookie Expiration Period. Cookie expiration period, in seconds. An expired cookie causes the loadbalancer to issue a new challenge
|
|
2800
|
+
|
|
2801
|
+
<a id="l7-ddos-action-js-challenge-custom-page"></a>• [`custom_page`](#l7-ddos-action-js-challenge-custom-page) - Optional String<br>Custom Message for Javascript Challenge. Custom 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. 'Please Wait.' or it can be HTML paragraph or a body string encoded as base64 string E.g. '`<p>` Please Wait `</p>`'. Base64 encoded string for this HTML is 'PHA+IFBsZWFzZSBXYWl0IDwvcD4='
|
|
2802
|
+
|
|
2803
|
+
<a id="l7-ddos-action-js-challenge-js-script-delay"></a>• [`js_script_delay`](#l7-ddos-action-js-challenge-js-script-delay) - Optional Number<br>Javascript Delay. Delay introduced by Javascript, in milliseconds
|
|
2804
|
+
|
|
2805
|
+
#### Origin Pool
|
|
2806
|
+
|
|
2807
|
+
An [`origin_pool`](#origin-pool) block supports the following:
|
|
2808
|
+
|
|
2809
|
+
<a id="origin-pool-more-origin-options"></a>• [`more_origin_options`](#origin-pool-more-origin-options) - Optional Block<br>Origin Byte Range Request Config<br>See [More Origin Options](#origin-pool-more-origin-options) below.
|
|
2810
|
+
|
|
2811
|
+
<a id="origin-pool-no-tls"></a>• [`no_tls`](#origin-pool-no-tls) - Optional Block<br>Enable this option
|
|
2812
|
+
|
|
2813
|
+
<a id="origin-pool-origin-request-timeout"></a>• [`origin_request_timeout`](#origin-pool-origin-request-timeout) - Optional String<br>Origin Request Timeout Duration. Configures the time after which a request to the origin will time out waiting for a response
|
|
2814
|
+
|
|
2815
|
+
<a id="origin-pool-origin-servers"></a>• [`origin_servers`](#origin-pool-origin-servers) - Optional Block<br>List Of Origin Servers. List of original servers<br>See [Origin Servers](#origin-pool-origin-servers) below.
|
|
2816
|
+
|
|
2817
|
+
<a id="origin-pool-public-name"></a>• [`public_name`](#origin-pool-public-name) - Optional Block<br>Public DNS Name. Specify origin server with public DNS name<br>See [Public Name](#origin-pool-public-name) below.
|
|
2818
|
+
|
|
2819
|
+
<a id="origin-pool-use-tls"></a>• [`use_tls`](#origin-pool-use-tls) - Optional Block<br>TLS Parameters for Origin Servers. Upstream TLS Parameters<br>See [Use TLS](#origin-pool-use-tls) below.
|
|
2820
|
+
|
|
2821
|
+
#### Origin Pool More Origin Options
|
|
2822
|
+
|
|
2823
|
+
A [`more_origin_options`](#origin-pool-more-origin-options) block (within [`origin_pool`](#origin-pool)) supports the following:
|
|
2824
|
+
|
|
2825
|
+
<a id="origin-pool-more-origin-options-enable-byte-range-request"></a>• [`enable_byte_range_request`](#origin-pool-more-origin-options-enable-byte-range-request) - Optional Bool<br>Enable Origin Byte Range Requests. Choice to enable/disable byte range requests towards origin
|
|
2826
|
+
|
|
2827
|
+
<a id="origin-pool-more-origin-options-websocket-proxy"></a>• [`websocket_proxy`](#origin-pool-more-origin-options-websocket-proxy) - Optional Bool<br>Enable WebSocket proxy to the origin. Option to enable proxying of WebSocket connections to the origin server
|
|
2828
|
+
|
|
2829
|
+
#### Origin Pool Origin Servers
|
|
2830
|
+
|
|
2831
|
+
An [`origin_servers`](#origin-pool-origin-servers) block (within [`origin_pool`](#origin-pool)) supports the following:
|
|
2832
|
+
|
|
2833
|
+
<a id="origin-pool-origin-servers-port"></a>• [`port`](#origin-pool-origin-servers-port) - Optional Number<br>Origin Server Port. Port the workload can be reached on
|
|
2834
|
+
|
|
2835
|
+
<a id="origin-pool-origin-servers-public-ip"></a>• [`public_ip`](#origin-pool-origin-servers-public-ip) - Optional Block<br>Public IP. Specify origin server with public IP address<br>See [Public IP](#origin-pool-origin-servers-public-ip) below.
|
|
2836
|
+
|
|
2837
|
+
<a id="origin-pool-origin-servers-public-name"></a>• [`public_name`](#origin-pool-origin-servers-public-name) - Optional Block<br>Public DNS Name. Specify origin server with public DNS name<br>See [Public Name](#origin-pool-origin-servers-public-name) below.
|
|
2838
|
+
|
|
2839
|
+
#### Origin Pool Origin Servers Public IP
|
|
2840
|
+
|
|
2841
|
+
A [`public_ip`](#origin-pool-origin-servers-public-ip) block (within [`origin_pool.origin_servers`](#origin-pool-origin-servers)) supports the following:
|
|
2842
|
+
|
|
2843
|
+
<a id="origin-pool-origin-servers-public-ip-ip"></a>• [`ip`](#origin-pool-origin-servers-public-ip-ip) - Optional String<br>Public IPv4. Public IPv4 address
|
|
2844
|
+
|
|
2845
|
+
#### Origin Pool Origin Servers Public Name
|
|
2846
|
+
|
|
2847
|
+
A [`public_name`](#origin-pool-origin-servers-public-name) block (within [`origin_pool.origin_servers`](#origin-pool-origin-servers)) supports the following:
|
|
2848
|
+
|
|
2849
|
+
<a id="origin-pool-origin-servers-public-name-dns-name"></a>• [`dns_name`](#origin-pool-origin-servers-public-name-dns-name) - Optional String<br>DNS Name. DNS Name
|
|
2850
|
+
|
|
2851
|
+
<a id="origin-pool-origin-servers-public-name-refresh-interval"></a>• [`refresh_interval`](#origin-pool-origin-servers-public-name-refresh-interval) - Optional Number<br>DNS Refresh Interval. Interval for DNS refresh in seconds. Max value is 7 days as per `HTTPS://datatracker.ietf.org/doc/HTML/rfc8767`
|
|
2852
|
+
|
|
2853
|
+
#### Origin Pool Public Name
|
|
2854
|
+
|
|
2855
|
+
A [`public_name`](#origin-pool-public-name) block (within [`origin_pool`](#origin-pool)) supports the following:
|
|
2856
|
+
|
|
2857
|
+
<a id="origin-pool-public-name-dns-name"></a>• [`dns_name`](#origin-pool-public-name-dns-name) - Optional String<br>DNS Name. DNS Name
|
|
2858
|
+
|
|
2859
|
+
<a id="origin-pool-public-name-refresh-interval"></a>• [`refresh_interval`](#origin-pool-public-name-refresh-interval) - Optional Number<br>DNS Refresh Interval. Interval for DNS refresh in seconds. Max value is 7 days as per `HTTPS://datatracker.ietf.org/doc/HTML/rfc8767`
|
|
2860
|
+
|
|
2861
|
+
#### Origin Pool Use TLS
|
|
2862
|
+
|
|
2863
|
+
An [`use_tls`](#origin-pool-use-tls) block (within [`origin_pool`](#origin-pool)) supports the following:
|
|
2864
|
+
|
|
2865
|
+
<a id="origin-pool-use-tls-default-session-key-caching"></a>• [`default_session_key_caching`](#origin-pool-use-tls-default-session-key-caching) - Optional Block<br>Enable this option
|
|
2866
|
+
|
|
2867
|
+
<a id="origin-pool-use-tls-disable-session-key-caching"></a>• [`disable_session_key_caching`](#origin-pool-use-tls-disable-session-key-caching) - Optional Block<br>Enable this option
|
|
2868
|
+
|
|
2869
|
+
<a id="origin-pool-use-tls-disable-sni"></a>• [`disable_sni`](#origin-pool-use-tls-disable-sni) - Optional Block<br>Enable this option
|
|
2870
|
+
|
|
2871
|
+
<a id="origin-pool-use-tls-max-session-keys"></a>• [`max_session_keys`](#origin-pool-use-tls-max-session-keys) - Optional Number<br>Max Session Keys Cached. Number of session keys that are cached
|
|
2872
|
+
|
|
2873
|
+
<a id="origin-pool-use-tls-no-mtls"></a>• [`no_mtls`](#origin-pool-use-tls-no-mtls) - Optional Block<br>Enable this option
|
|
2874
|
+
|
|
2875
|
+
<a id="origin-pool-use-tls-skip-server-verification"></a>• [`skip_server_verification`](#origin-pool-use-tls-skip-server-verification) - Optional Block<br>Enable this option
|
|
2876
|
+
|
|
2877
|
+
<a id="origin-pool-use-tls-sni"></a>• [`sni`](#origin-pool-use-tls-sni) - Optional String<br>SNI Value. SNI value to be used
|
|
2878
|
+
|
|
2879
|
+
<a id="origin-pool-use-tls-tls-config"></a>• [`tls_config`](#origin-pool-use-tls-tls-config) - Optional Block<br>TLS Config. This defines various options to configure TLS configuration parameters<br>See [TLS Config](#origin-pool-use-tls-tls-config) below.
|
|
2880
|
+
|
|
2881
|
+
<a id="origin-pool-use-tls-use-host-header-as-sni"></a>• [`use_host_header_as_sni`](#origin-pool-use-tls-use-host-header-as-sni) - Optional Block<br>Enable this option
|
|
2882
|
+
|
|
2883
|
+
<a id="origin-pool-use-tls-use-mtls"></a>• [`use_mtls`](#origin-pool-use-tls-use-mtls) - Optional Block<br>mTLS Certificate. mTLS Client Certificate<br>See [Use mTLS](#origin-pool-use-tls-use-mtls) below.
|
|
2884
|
+
|
|
2885
|
+
<a id="origin-pool-use-tls-use-mtls-obj"></a>• [`use_mtls_obj`](#origin-pool-use-tls-use-mtls-obj) - 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 [Use mTLS Obj](#origin-pool-use-tls-use-mtls-obj) below.
|
|
2886
|
+
|
|
2887
|
+
<a id="origin-pool-use-tls-use-server-verification"></a>• [`use_server_verification`](#origin-pool-use-tls-use-server-verification) - Optional Block<br>TLS Validation Context for Origin Servers. Upstream TLS Validation Context<br>See [Use Server Verification](#origin-pool-use-tls-use-server-verification) below.
|
|
2888
|
+
|
|
2889
|
+
<a id="origin-pool-use-tls-volterra-trusted-ca"></a>• [`volterra_trusted_ca`](#origin-pool-use-tls-volterra-trusted-ca) - Optional Block<br>Enable this option
|
|
2890
|
+
|
|
2891
|
+
#### Origin Pool Use TLS TLS Config
|
|
2892
|
+
|
|
2893
|
+
A [`tls_config`](#origin-pool-use-tls-tls-config) block (within [`origin_pool.use_tls`](#origin-pool-use-tls)) supports the following:
|
|
2894
|
+
|
|
2895
|
+
<a id="origin-pool-use-tls-tls-config-custom-security"></a>• [`custom_security`](#origin-pool-use-tls-tls-config-custom-security) - Optional Block<br>Custom Ciphers. This defines TLS protocol config including min/max versions and allowed ciphers<br>See [Custom Security](#origin-pool-use-tls-tls-config-custom-security) below.
|
|
2896
|
+
|
|
2897
|
+
<a id="origin-pool-use-tls-tls-config-default-security"></a>• [`default_security`](#origin-pool-use-tls-tls-config-default-security) - Optional Block<br>Enable this option
|
|
2898
|
+
|
|
2899
|
+
<a id="origin-pool-use-tls-tls-config-low-security"></a>• [`low_security`](#origin-pool-use-tls-tls-config-low-security) - Optional Block<br>Enable this option
|
|
2900
|
+
|
|
2901
|
+
<a id="origin-pool-use-tls-tls-config-medium-security"></a>• [`medium_security`](#origin-pool-use-tls-tls-config-medium-security) - Optional Block<br>Enable this option
|
|
2902
|
+
|
|
2903
|
+
#### Origin Pool Use TLS TLS Config Custom Security
|
|
2904
|
+
|
|
2905
|
+
A [`custom_security`](#origin-pool-use-tls-tls-config-custom-security) block (within [`origin_pool.use_tls.tls_config`](#origin-pool-use-tls-tls-config)) supports the following:
|
|
2906
|
+
|
|
2907
|
+
<a id="origin-pool-use-tls-tls-config-custom-security-cipher-suites"></a>• [`cipher_suites`](#origin-pool-use-tls-tls-config-custom-security-cipher-suites) - Optional List<br>Cipher Suites. The TLS listener will only support the specified cipher list
|
|
2908
|
+
|
|
2909
|
+
<a id="origin-pool-use-tls-tls-config-custom-security-max-version"></a>• [`max_version`](#origin-pool-use-tls-tls-config-custom-security-max-version) - 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="origin-pool-use-tls-tls-config-custom-security-min-version"></a>• [`min_version`](#origin-pool-use-tls-tls-config-custom-security-min-version) - 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
|
|
2912
|
+
|
|
2913
|
+
#### Origin Pool Use TLS Use mTLS
|
|
2914
|
+
|
|
2915
|
+
An [`use_mtls`](#origin-pool-use-tls-use-mtls) block (within [`origin_pool.use_tls`](#origin-pool-use-tls)) supports the following:
|
|
2916
|
+
|
|
2917
|
+
<a id="origin-pool-use-tls-use-mtls-tls-certificates"></a>• [`tls_certificates`](#origin-pool-use-tls-use-mtls-tls-certificates) - Optional Block<br>mTLS Client Certificate. mTLS Client Certificate<br>See [TLS Certificates](#origin-pool-use-tls-use-mtls-tls-certificates) below.
|
|
2918
|
+
|
|
2919
|
+
#### Origin Pool Use TLS Use mTLS TLS Certificates
|
|
2920
|
+
|
|
2921
|
+
A [`tls_certificates`](#origin-pool-use-tls-use-mtls-tls-certificates) block (within [`origin_pool.use_tls.use_mtls`](#origin-pool-use-tls-use-mtls)) supports the following:
|
|
2922
|
+
|
|
2923
|
+
<a id="origin-pool-use-tls-use-mtls-tls-certificates-certificate-url"></a>• [`certificate_url`](#origin-pool-use-tls-use-mtls-tls-certificates-certificate-url) - Optional String<br>Certificate. TLS certificate. Certificate or certificate chain in PEM format including the PEM headers
|
|
2924
|
+
|
|
2925
|
+
<a id="origin-pool-use-tls-use-mtls-tls-certificates-custom-hash-algorithms"></a>• [`custom_hash_algorithms`](#origin-pool-use-tls-use-mtls-tls-certificates-custom-hash-algorithms) - Optional Block<br>Hash Algorithms. Specifies the hash algorithms to be used<br>See [Custom Hash Algorithms](#origin-pool-use-tls-use-mtls-tls-certificates-custom-hash-algorithms) below.
|
|
2926
|
+
|
|
2927
|
+
<a id="origin-pool-use-tls-use-mtls-tls-certificates-description-spec"></a>• [`description_spec`](#origin-pool-use-tls-use-mtls-tls-certificates-description-spec) - Optional String<br>Description. Description for the certificate
|
|
2928
|
+
|
|
2929
|
+
<a id="origin-pool-use-tls-use-mtls-tls-certificates-disable-ocsp-stapling"></a>• [`disable_ocsp_stapling`](#origin-pool-use-tls-use-mtls-tls-certificates-disable-ocsp-stapling) - Optional Block<br>Enable this option
|
|
2930
|
+
|
|
2931
|
+
<a id="origin-pool-use-tls-use-mtls-tls-certificates-private-key"></a>• [`private_key`](#origin-pool-use-tls-use-mtls-tls-certificates-private-key) - Optional Block<br>Secret. SecretType is used in an object to indicate a sensitive/confidential field<br>See [Private Key](#origin-pool-use-tls-use-mtls-tls-certificates-private-key) below.
|
|
2932
|
+
|
|
2933
|
+
<a id="origin-pool-use-tls-use-mtls-tls-certificates-use-system-defaults"></a>• [`use_system_defaults`](#origin-pool-use-tls-use-mtls-tls-certificates-use-system-defaults) - Optional Block<br>Enable this option
|
|
2934
|
+
|
|
2935
|
+
#### Origin Pool Use TLS Use mTLS TLS Certificates Custom Hash Algorithms
|
|
2936
|
+
|
|
2937
|
+
A [`custom_hash_algorithms`](#origin-pool-use-tls-use-mtls-tls-certificates-custom-hash-algorithms) block (within [`origin_pool.use_tls.use_mtls.tls_certificates`](#origin-pool-use-tls-use-mtls-tls-certificates)) supports the following:
|
|
2938
|
+
|
|
2939
|
+
<a id="origin-pool-use-tls-use-mtls-tls-certificates-custom-hash-algorithms-hash-algorithms"></a>• [`hash_algorithms`](#origin-pool-use-tls-use-mtls-tls-certificates-custom-hash-algorithms-hash-algorithms) - 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
|
|
2940
|
+
|
|
2941
|
+
#### Origin Pool Use TLS Use mTLS TLS Certificates Private Key
|
|
2942
|
+
|
|
2943
|
+
A [`private_key`](#origin-pool-use-tls-use-mtls-tls-certificates-private-key) block (within [`origin_pool.use_tls.use_mtls.tls_certificates`](#origin-pool-use-tls-use-mtls-tls-certificates)) supports the following:
|
|
2944
|
+
|
|
2945
|
+
<a id="origin-pool-use-tls-use-mtls-tls-certificates-private-key-blindfold-secret-info"></a>• [`blindfold_secret_info`](#origin-pool-use-tls-use-mtls-tls-certificates-private-key-blindfold-secret-info) - Optional Block<br>Blindfold Secret. BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management<br>See [Blindfold Secret Info](#origin-pool-use-tls-use-mtls-tls-certificates-private-key-blindfold-secret-info) below.
|
|
2946
|
+
|
|
2947
|
+
<a id="origin-pool-use-tls-use-mtls-tls-certificates-private-key-clear-secret-info"></a>• [`clear_secret_info`](#origin-pool-use-tls-use-mtls-tls-certificates-private-key-clear-secret-info) - Optional Block<br>In-Clear Secret. ClearSecretInfoType specifies information about the Secret that is not encrypted<br>See [Clear Secret Info](#origin-pool-use-tls-use-mtls-tls-certificates-private-key-clear-secret-info) below.
|
|
2948
|
+
|
|
2949
|
+
#### Origin Pool Use TLS Use mTLS TLS Certificates Private Key Blindfold Secret Info
|
|
2950
|
+
|
|
2951
|
+
A [`blindfold_secret_info`](#origin-pool-use-tls-use-mtls-tls-certificates-private-key-blindfold-secret-info) block (within [`origin_pool.use_tls.use_mtls.tls_certificates.private_key`](#origin-pool-use-tls-use-mtls-tls-certificates-private-key)) supports the following:
|
|
2952
|
+
|
|
2953
|
+
<a id="origin-pool-use-tls-use-mtls-tls-certificates-private-key-blindfold-secret-info-decryption-provider"></a>• [`decryption_provider`](#origin-pool-use-tls-use-mtls-tls-certificates-private-key-blindfold-secret-info-decryption-provider) - 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="origin-pool-use-tls-use-mtls-tls-certificates-private-key-blindfold-secret-info-location"></a>• [`location`](#origin-pool-use-tls-use-mtls-tls-certificates-private-key-blindfold-secret-info-location) - 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="origin-pool-use-tls-use-mtls-tls-certificates-private-key-blindfold-secret-info-store-provider"></a>• [`store_provider`](#origin-pool-use-tls-use-mtls-tls-certificates-private-key-blindfold-secret-info-store-provider) - 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:///
|
|
2958
|
+
|
|
2959
|
+
#### Origin Pool Use TLS Use mTLS TLS Certificates Private Key Clear Secret Info
|
|
2960
|
+
|
|
2961
|
+
A [`clear_secret_info`](#origin-pool-use-tls-use-mtls-tls-certificates-private-key-clear-secret-info) block (within [`origin_pool.use_tls.use_mtls.tls_certificates.private_key`](#origin-pool-use-tls-use-mtls-tls-certificates-private-key)) supports the following:
|
|
2962
|
+
|
|
2963
|
+
<a id="origin-pool-use-tls-use-mtls-tls-certificates-private-key-clear-secret-info-provider-ref"></a>• [`provider_ref`](#origin-pool-use-tls-use-mtls-tls-certificates-private-key-clear-secret-info-provider-ref) - 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="origin-pool-use-tls-use-mtls-tls-certificates-private-key-clear-secret-info-url"></a>• [`url`](#origin-pool-use-tls-use-mtls-tls-certificates-private-key-clear-secret-info-url) - 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
|
|
2966
|
+
|
|
2967
|
+
#### Origin Pool Use TLS Use mTLS Obj
|
|
2968
|
+
|
|
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>• [`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="origin-pool-use-tls-use-mtls-obj-namespace"></a>• [`namespace`](#origin-pool-use-tls-use-mtls-obj-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
|
|
2974
|
+
|
|
2975
|
+
<a id="origin-pool-use-tls-use-mtls-obj-tenant"></a>• [`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
|
|
2976
|
+
|
|
2977
|
+
#### Origin Pool Use TLS Use Server Verification
|
|
2978
|
+
|
|
2979
|
+
An [`use_server_verification`](#origin-pool-use-tls-use-server-verification) block (within [`origin_pool.use_tls`](#origin-pool-use-tls)) supports the following:
|
|
2980
|
+
|
|
2981
|
+
<a id="origin-pool-use-tls-use-server-verification-trusted-ca"></a>• [`trusted_ca`](#origin-pool-use-tls-use-server-verification-trusted-ca) - 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](#origin-pool-use-tls-use-server-verification-trusted-ca) below.
|
|
2982
|
+
|
|
2983
|
+
<a id="origin-pool-use-tls-use-server-verification-trusted-ca-url"></a>• [`trusted_ca_url`](#origin-pool-use-tls-use-server-verification-trusted-ca-url) - Optional String<br>Inline Root CA Certificate (legacy). Upload a Root CA Certificate specifically for this Origin Pool for verification of server's certificate
|
|
2984
|
+
|
|
2985
|
+
#### Origin Pool Use TLS Use Server Verification Trusted CA
|
|
2986
|
+
|
|
2987
|
+
A [`trusted_ca`](#origin-pool-use-tls-use-server-verification-trusted-ca) block (within [`origin_pool.use_tls.use_server_verification`](#origin-pool-use-tls-use-server-verification)) supports the following:
|
|
2988
|
+
|
|
2989
|
+
<a id="origin-pool-use-tls-use-server-verification-trusted-ca-name"></a>• [`name`](#origin-pool-use-tls-use-server-verification-trusted-ca-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
|
|
2990
|
+
|
|
2991
|
+
<a id="origin-pool-use-tls-use-server-verification-trusted-ca-namespace"></a>• [`namespace`](#origin-pool-use-tls-use-server-verification-trusted-ca-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
|
|
2992
|
+
|
|
2993
|
+
<a id="origin-pool-use-tls-use-server-verification-trusted-ca-tenant"></a>• [`tenant`](#origin-pool-use-tls-use-server-verification-trusted-ca-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
|
|
2994
|
+
|
|
2995
|
+
#### Other Settings
|
|
2996
|
+
|
|
2997
|
+
An [`other_settings`](#other-settings) block supports the following:
|
|
2998
|
+
|
|
2999
|
+
<a id="other-settings-add-location"></a>• [`add_location`](#other-settings-add-location) - Optional Bool<br>Add Location. Appends header x-volterra-location = `<RE-site-name>` in responses
|
|
3000
|
+
|
|
3001
|
+
<a id="other-settings-header-options"></a>• [`header_options`](#other-settings-header-options) - Optional Block<br>Header Control. This defines various options related to request/response headers<br>See [Header Options](#other-settings-header-options) below.
|
|
3002
|
+
|
|
3003
|
+
<a id="other-settings-logging-options"></a>• [`logging_options`](#other-settings-logging-options) - Optional Block<br>Logging Options. This defines various options related to logging<br>See [Logging Options](#other-settings-logging-options) below.
|
|
3004
|
+
|
|
3005
|
+
#### Other Settings Header Options
|
|
3006
|
+
|
|
3007
|
+
A [`header_options`](#other-settings-header-options) block (within [`other_settings`](#other-settings)) supports the following:
|
|
3008
|
+
|
|
3009
|
+
<a id="other-settings-header-options-request-headers-to-add"></a>• [`request_headers_to_add`](#other-settings-header-options-request-headers-to-add) - Optional Block<br>Add Origin Request Headers. Headers are key-value pairs to be added to HTTP request being routed towards upstream. Headers specified at this level are applied after headers from matched Route are applied<br>See [Request Headers To Add](#other-settings-header-options-request-headers-to-add) below.
|
|
3010
|
+
|
|
3011
|
+
<a id="other-settings-header-options-request-headers-to-remove"></a>• [`request_headers_to_remove`](#other-settings-header-options-request-headers-to-remove) - Optional List<br>Remove Origin Request Headers. List of keys of Headers to be removed from the HTTP request being sent towards upstream
|
|
3012
|
+
|
|
3013
|
+
<a id="other-settings-header-options-response-headers-to-add"></a>• [`response_headers_to_add`](#other-settings-header-options-response-headers-to-add) - Optional Block<br>Add Response Headers. Headers are key-value pairs to be added to HTTP response being sent towards downstream. Headers specified at this level are applied after headers from matched Route are applied<br>See [Response Headers To Add](#other-settings-header-options-response-headers-to-add) below.
|
|
3014
|
+
|
|
3015
|
+
<a id="other-settings-header-options-response-headers-to-remove"></a>• [`response_headers_to_remove`](#other-settings-header-options-response-headers-to-remove) - Optional List<br>Remove Response Headers. List of keys of Headers to be removed from the HTTP response being sent towards downstream
|
|
3016
|
+
|
|
3017
|
+
#### Other Settings Header Options Request Headers To Add
|
|
3018
|
+
|
|
3019
|
+
A [`request_headers_to_add`](#other-settings-header-options-request-headers-to-add) block (within [`other_settings.header_options`](#other-settings-header-options)) supports the following:
|
|
3020
|
+
|
|
3021
|
+
<a id="other-settings-header-options-request-headers-to-add-append"></a>• [`append`](#other-settings-header-options-request-headers-to-add-append) - 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="other-settings-header-options-request-headers-to-add-name"></a>• [`name`](#other-settings-header-options-request-headers-to-add-name) - Optional String<br>Name. Name of the HTTP header
|
|
3024
|
+
|
|
3025
|
+
<a id="other-settings-header-options-request-headers-to-add-secret-value"></a>• [`secret_value`](#other-settings-header-options-request-headers-to-add-secret-value) - Optional Block<br>Secret. SecretType is used in an object to indicate a sensitive/confidential field<br>See [Secret Value](#other-settings-header-options-request-headers-to-add-secret-value) below.
|
|
3026
|
+
|
|
3027
|
+
<a id="other-settings-header-options-request-headers-to-add-value"></a>• [`value`](#other-settings-header-options-request-headers-to-add-value) - Optional String<br>Value. Value of the HTTP header
|
|
3028
|
+
|
|
3029
|
+
#### Other Settings Header Options Request Headers To Add Secret Value
|
|
3030
|
+
|
|
3031
|
+
A [`secret_value`](#other-settings-header-options-request-headers-to-add-secret-value) block (within [`other_settings.header_options.request_headers_to_add`](#other-settings-header-options-request-headers-to-add)) supports the following:
|
|
3032
|
+
|
|
3033
|
+
<a id="other-settings-header-options-request-headers-to-add-secret-value-blindfold-secret-info"></a>• [`blindfold_secret_info`](#other-settings-header-options-request-headers-to-add-secret-value-blindfold-secret-info) - Optional Block<br>Blindfold Secret. BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management<br>See [Blindfold Secret Info](#other-settings-header-options-request-headers-to-add-secret-value-blindfold-secret-info) below.
|
|
3034
|
+
|
|
3035
|
+
<a id="other-settings-header-options-request-headers-to-add-secret-value-clear-secret-info"></a>• [`clear_secret_info`](#other-settings-header-options-request-headers-to-add-secret-value-clear-secret-info) - Optional Block<br>In-Clear Secret. ClearSecretInfoType specifies information about the Secret that is not encrypted<br>See [Clear Secret Info](#other-settings-header-options-request-headers-to-add-secret-value-clear-secret-info) below.
|
|
3036
|
+
|
|
3037
|
+
#### Other Settings Header Options Request Headers To Add Secret Value Blindfold Secret Info
|
|
3038
|
+
|
|
3039
|
+
A [`blindfold_secret_info`](#other-settings-header-options-request-headers-to-add-secret-value-blindfold-secret-info) block (within [`other_settings.header_options.request_headers_to_add.secret_value`](#other-settings-header-options-request-headers-to-add-secret-value)) supports the following:
|
|
3040
|
+
|
|
3041
|
+
<a id="other-settings-header-options-request-headers-to-add-secret-value-blindfold-secret-info-decryption-provider"></a>• [`decryption_provider`](#other-settings-header-options-request-headers-to-add-secret-value-blindfold-secret-info-decryption-provider) - 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="other-settings-header-options-request-headers-to-add-secret-value-blindfold-secret-info-location"></a>• [`location`](#other-settings-header-options-request-headers-to-add-secret-value-blindfold-secret-info-location) - 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="other-settings-header-options-request-headers-to-add-secret-value-blindfold-secret-info-store-provider"></a>• [`store_provider`](#other-settings-header-options-request-headers-to-add-secret-value-blindfold-secret-info-store-provider) - 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:///
|
|
3046
|
+
|
|
3047
|
+
#### Other Settings Header Options Request Headers To Add Secret Value Clear Secret Info
|
|
3048
|
+
|
|
3049
|
+
A [`clear_secret_info`](#other-settings-header-options-request-headers-to-add-secret-value-clear-secret-info) block (within [`other_settings.header_options.request_headers_to_add.secret_value`](#other-settings-header-options-request-headers-to-add-secret-value)) supports the following:
|
|
3050
|
+
|
|
3051
|
+
<a id="other-settings-header-options-request-headers-to-add-secret-value-clear-secret-info-provider-ref"></a>• [`provider_ref`](#other-settings-header-options-request-headers-to-add-secret-value-clear-secret-info-provider-ref) - 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="other-settings-header-options-request-headers-to-add-secret-value-clear-secret-info-url"></a>• [`url`](#other-settings-header-options-request-headers-to-add-secret-value-clear-secret-info-url) - 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
|
|
3054
|
+
|
|
3055
|
+
#### Other Settings Header Options Response Headers To Add
|
|
3056
|
+
|
|
3057
|
+
A [`response_headers_to_add`](#other-settings-header-options-response-headers-to-add) block (within [`other_settings.header_options`](#other-settings-header-options)) supports the following:
|
|
3058
|
+
|
|
3059
|
+
<a id="other-settings-header-options-response-headers-to-add-append"></a>• [`append`](#other-settings-header-options-response-headers-to-add-append) - 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="other-settings-header-options-response-headers-to-add-name"></a>• [`name`](#other-settings-header-options-response-headers-to-add-name) - Optional String<br>Name. Name of the HTTP header
|
|
3062
|
+
|
|
3063
|
+
<a id="other-settings-header-options-response-headers-to-add-secret-value"></a>• [`secret_value`](#other-settings-header-options-response-headers-to-add-secret-value) - Optional Block<br>Secret. SecretType is used in an object to indicate a sensitive/confidential field<br>See [Secret Value](#other-settings-header-options-response-headers-to-add-secret-value) below.
|
|
3064
|
+
|
|
3065
|
+
<a id="other-settings-header-options-response-headers-to-add-value"></a>• [`value`](#other-settings-header-options-response-headers-to-add-value) - Optional String<br>Value. Value of the HTTP header
|
|
3066
|
+
|
|
3067
|
+
#### Other Settings Header Options Response Headers To Add Secret Value
|
|
3068
|
+
|
|
3069
|
+
A [`secret_value`](#other-settings-header-options-response-headers-to-add-secret-value) block (within [`other_settings.header_options.response_headers_to_add`](#other-settings-header-options-response-headers-to-add)) supports the following:
|
|
3070
|
+
|
|
3071
|
+
<a id="other-settings-header-options-response-headers-to-add-secret-value-blindfold-secret-info"></a>• [`blindfold_secret_info`](#other-settings-header-options-response-headers-to-add-secret-value-blindfold-secret-info) - Optional Block<br>Blindfold Secret. BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management<br>See [Blindfold Secret Info](#other-settings-header-options-response-headers-to-add-secret-value-blindfold-secret-info) below.
|
|
3072
|
+
|
|
3073
|
+
<a id="other-settings-header-options-response-headers-to-add-secret-value-clear-secret-info"></a>• [`clear_secret_info`](#other-settings-header-options-response-headers-to-add-secret-value-clear-secret-info) - Optional Block<br>In-Clear Secret. ClearSecretInfoType specifies information about the Secret that is not encrypted<br>See [Clear Secret Info](#other-settings-header-options-response-headers-to-add-secret-value-clear-secret-info) below.
|
|
3074
|
+
|
|
3075
|
+
#### Other Settings Header Options Response Headers To Add Secret Value Blindfold Secret Info
|
|
3076
|
+
|
|
3077
|
+
A [`blindfold_secret_info`](#other-settings-header-options-response-headers-to-add-secret-value-blindfold-secret-info) block (within [`other_settings.header_options.response_headers_to_add.secret_value`](#other-settings-header-options-response-headers-to-add-secret-value)) supports the following:
|
|
3078
|
+
|
|
3079
|
+
<a id="other-settings-header-options-response-headers-to-add-secret-value-blindfold-secret-info-decryption-provider"></a>• [`decryption_provider`](#other-settings-header-options-response-headers-to-add-secret-value-blindfold-secret-info-decryption-provider) - 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="other-settings-header-options-response-headers-to-add-secret-value-blindfold-secret-info-location"></a>• [`location`](#other-settings-header-options-response-headers-to-add-secret-value-blindfold-secret-info-location) - 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="other-settings-header-options-response-headers-to-add-secret-value-blindfold-secret-info-store-provider"></a>• [`store_provider`](#other-settings-header-options-response-headers-to-add-secret-value-blindfold-secret-info-store-provider) - 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:///
|
|
3084
|
+
|
|
3085
|
+
#### Other Settings Header Options Response Headers To Add Secret Value Clear Secret Info
|
|
3086
|
+
|
|
3087
|
+
A [`clear_secret_info`](#other-settings-header-options-response-headers-to-add-secret-value-clear-secret-info) block (within [`other_settings.header_options.response_headers_to_add.secret_value`](#other-settings-header-options-response-headers-to-add-secret-value)) supports the following:
|
|
3088
|
+
|
|
3089
|
+
<a id="other-settings-header-options-response-headers-to-add-secret-value-clear-secret-info-provider-ref"></a>• [`provider_ref`](#other-settings-header-options-response-headers-to-add-secret-value-clear-secret-info-provider-ref) - 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="other-settings-header-options-response-headers-to-add-secret-value-clear-secret-info-url"></a>• [`url`](#other-settings-header-options-response-headers-to-add-secret-value-clear-secret-info-url) - 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
|
|
3092
|
+
|
|
3093
|
+
#### Other Settings Logging Options
|
|
3094
|
+
|
|
3095
|
+
A [`logging_options`](#other-settings-logging-options) block (within [`other_settings`](#other-settings)) supports the following:
|
|
3096
|
+
|
|
3097
|
+
<a id="other-settings-logging-options-client-log-options"></a>• [`client_log_options`](#other-settings-logging-options-client-log-options) - Optional Block<br>Headers to Log. List of headers to Log<br>See [Client Log Options](#other-settings-logging-options-client-log-options) below.
|
|
3098
|
+
|
|
3099
|
+
<a id="other-settings-logging-options-origin-log-options"></a>• [`origin_log_options`](#other-settings-logging-options-origin-log-options) - Optional Block<br>Headers to Log. List of headers to Log<br>See [Origin Log Options](#other-settings-logging-options-origin-log-options) below.
|
|
3100
|
+
|
|
3101
|
+
#### Other Settings Logging Options Client Log Options
|
|
3102
|
+
|
|
3103
|
+
A [`client_log_options`](#other-settings-logging-options-client-log-options) block (within [`other_settings.logging_options`](#other-settings-logging-options)) supports the following:
|
|
3104
|
+
|
|
3105
|
+
<a id="other-settings-logging-options-client-log-options-header-list"></a>• [`header_list`](#other-settings-logging-options-client-log-options-header-list) - Optional List<br>Headers. List of headers
|
|
3106
|
+
|
|
3107
|
+
#### Other Settings Logging Options Origin Log Options
|
|
3108
|
+
|
|
3109
|
+
An [`origin_log_options`](#other-settings-logging-options-origin-log-options) block (within [`other_settings.logging_options`](#other-settings-logging-options)) supports the following:
|
|
3110
|
+
|
|
3111
|
+
<a id="other-settings-logging-options-origin-log-options-header-list"></a>• [`header_list`](#other-settings-logging-options-origin-log-options-header-list) - Optional List<br>Headers. List of headers
|
|
3112
|
+
|
|
3113
|
+
#### Policy Based Challenge
|
|
3114
|
+
|
|
3115
|
+
A [`policy_based_challenge`](#policy-based-challenge) block supports the following:
|
|
3116
|
+
|
|
3117
|
+
<a id="policy-based-challenge-always-enable-captcha-challenge"></a>• [`always_enable_captcha_challenge`](#policy-based-challenge-always-enable-captcha-challenge) - Optional Block<br>Enable this option
|
|
3118
|
+
|
|
3119
|
+
<a id="policy-based-challenge-always-enable-js-challenge"></a>• [`always_enable_js_challenge`](#policy-based-challenge-always-enable-js-challenge) - Optional Block<br>Enable this option
|
|
3120
|
+
|
|
3121
|
+
<a id="policy-based-challenge-captcha-challenge-parameters"></a>• [`captcha_challenge_parameters`](#policy-based-challenge-captcha-challenge-parameters) - Optional Block<br>Captcha Challenge Parameters. Enables loadbalancer to perform captcha challenge Captcha challenge will be based on Google Recaptcha. With this feature enabled, only clients that pass the captcha challenge will be allowed to complete the HTTP request. When loadbalancer is configured to do Captcha Challenge, it will redirect the browser to an HTML page on every new HTTP request. This HTML page will have captcha challenge embedded in it. Client will be allowed to make the request only if the captcha challenge is successful. Loadbalancer will tag response header with a cookie to avoid Captcha challenge for subsequent requests. CAPTCHA is mainly used as a security check to ensure only human users can pass through. Generally, computers or bots are not capable of solving a captcha. You can enable either Javascript challenge or Captcha challenge on a virtual host<br>See [Captcha Challenge Parameters](#policy-based-challenge-captcha-challenge-parameters) below.
|
|
3122
|
+
|
|
3123
|
+
<a id="policy-based-challenge-default-captcha-challenge-parameters"></a>• [`default_captcha_challenge_parameters`](#policy-based-challenge-default-captcha-challenge-parameters) - Optional Block<br>Enable this option
|
|
3124
|
+
|
|
3125
|
+
<a id="policy-based-challenge-default-js-challenge-parameters"></a>• [`default_js_challenge_parameters`](#policy-based-challenge-default-js-challenge-parameters) - Optional Block<br>Enable this option
|
|
3126
|
+
|
|
3127
|
+
<a id="policy-based-challenge-default-mitigation-settings"></a>• [`default_mitigation_settings`](#policy-based-challenge-default-mitigation-settings) - Optional Block<br>Enable this option
|
|
3128
|
+
|
|
3129
|
+
<a id="policy-based-challenge-default-temporary-blocking-parameters"></a>• [`default_temporary_blocking_parameters`](#policy-based-challenge-default-temporary-blocking-parameters) - Optional Block<br>Enable this option
|
|
3130
|
+
|
|
3131
|
+
<a id="policy-based-challenge-js-challenge-parameters"></a>• [`js_challenge_parameters`](#policy-based-challenge-js-challenge-parameters) - Optional Block<br>Javascript Challenge Parameters. Enables loadbalancer to perform client browser compatibility test by redirecting to a page with Javascript. With this feature enabled, only clients that are capable of executing Javascript(mostly browsers) will be allowed to complete the HTTP request. When loadbalancer is configured to do Javascript Challenge, it will redirect the browser to an HTML page on every new HTTP request. This HTML page will have Javascript embedded in it. Loadbalancer chooses a set of random numbers for every new client and sends these numbers along with an encrypted answer with the request such that it embed these numbers as input in the Javascript. Javascript will run on the requestor browser and perform a complex Math operation. Script will submit the answer to loadbalancer. Loadbalancer will validate the answer by comparing the calculated answer with the decrypted answer (which was encrypted when it was sent back as reply) and allow the request to the upstream server only if the answer is correct. Loadbalancer will tag response header with a cookie to avoid Javascript challenge for subsequent requests. Javascript challenge serves following purposes \* Validate that the request is coming via a browser that is capable for running Javascript \* Force the browser to run a complex operation, f(X), that requires it to spend a large number of CPU cycles. This is to slow down a potential DOS attacker by making it difficult to launch a large request flood without having to spend even larger CPU cost at their end. You can enable either Javascript challenge or Captcha challenge on a virtual host<br>See [Js Challenge Parameters](#policy-based-challenge-js-challenge-parameters) below.
|
|
3132
|
+
|
|
3133
|
+
<a id="policy-based-challenge-malicious-user-mitigation"></a>• [`malicious_user_mitigation`](#policy-based-challenge-malicious-user-mitigation) - 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 [Malicious User Mitigation](#policy-based-challenge-malicious-user-mitigation) below.
|
|
3134
|
+
|
|
3135
|
+
<a id="policy-based-challenge-no-challenge"></a>• [`no_challenge`](#policy-based-challenge-no-challenge) - Optional Block<br>Enable this option
|
|
3136
|
+
|
|
3137
|
+
<a id="policy-based-challenge-rule-list"></a>• [`rule_list`](#policy-based-challenge-rule-list) - Optional Block<br>Challenge Rule List. List of challenge rules to be used in policy based challenge<br>See [Rule List](#policy-based-challenge-rule-list) below.
|
|
3138
|
+
|
|
3139
|
+
<a id="policy-based-challenge-temporary-user-blocking"></a>• [`temporary_user_blocking`](#policy-based-challenge-temporary-user-blocking) - Optional Block<br>Temporary User Blocking. Specifies configuration for temporary user blocking resulting from user behavior analysis. When Malicious User Mitigation is enabled from service policy rules, users' accessing the application will be analyzed for malicious activity and the configured mitigation actions will be taken on identified malicious users. These mitigation actions include setting up temporary blocking on that user. This configuration specifies settings on how that blocking should be done by the loadbalancer<br>See [Temporary User Blocking](#policy-based-challenge-temporary-user-blocking) below.
|
|
3140
|
+
|
|
3141
|
+
#### Policy Based Challenge Captcha Challenge Parameters
|
|
3142
|
+
|
|
3143
|
+
A [`captcha_challenge_parameters`](#policy-based-challenge-captcha-challenge-parameters) block (within [`policy_based_challenge`](#policy-based-challenge)) supports the following:
|
|
3144
|
+
|
|
3145
|
+
<a id="policy-based-challenge-captcha-challenge-parameters-cookie-expiry"></a>• [`cookie_expiry`](#policy-based-challenge-captcha-challenge-parameters-cookie-expiry) - Optional Number<br>Cookie Expiration Period. Cookie expiration period, in seconds. An expired cookie causes the loadbalancer to issue a new challenge
|
|
3146
|
+
|
|
3147
|
+
<a id="policy-based-challenge-captcha-challenge-parameters-custom-page"></a>• [`custom_page`](#policy-based-challenge-captcha-challenge-parameters-custom-page) - Optional String<br>Custom message for Captcha Challenge. Custom 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. 'Please Wait.' or it can be HTML paragraph or a body string encoded as base64 string E.g. '`<p>` Please Wait `</p>`'. Base64 encoded string for this HTML is 'PHA+IFBsZWFzZSBXYWl0IDwvcD4='
|
|
3148
|
+
|
|
3149
|
+
#### Policy Based Challenge Js Challenge Parameters
|
|
3150
|
+
|
|
3151
|
+
A [`js_challenge_parameters`](#policy-based-challenge-js-challenge-parameters) block (within [`policy_based_challenge`](#policy-based-challenge)) supports the following:
|
|
3152
|
+
|
|
3153
|
+
<a id="policy-based-challenge-js-challenge-parameters-cookie-expiry"></a>• [`cookie_expiry`](#policy-based-challenge-js-challenge-parameters-cookie-expiry) - Optional Number<br>Cookie Expiration Period. Cookie expiration period, in seconds. An expired cookie causes the loadbalancer to issue a new challenge
|
|
3154
|
+
|
|
3155
|
+
<a id="policy-based-challenge-js-challenge-parameters-custom-page"></a>• [`custom_page`](#policy-based-challenge-js-challenge-parameters-custom-page) - Optional String<br>Custom Message for Javascript Challenge. Custom 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. 'Please Wait.' or it can be HTML paragraph or a body string encoded as base64 string E.g. '`<p>` Please Wait `</p>`'. Base64 encoded string for this HTML is 'PHA+IFBsZWFzZSBXYWl0IDwvcD4='
|
|
3156
|
+
|
|
3157
|
+
<a id="policy-based-challenge-js-challenge-parameters-js-script-delay"></a>• [`js_script_delay`](#policy-based-challenge-js-challenge-parameters-js-script-delay) - Optional Number<br>Javascript Delay. Delay introduced by Javascript, in milliseconds
|
|
3158
|
+
|
|
3159
|
+
#### Policy Based Challenge Malicious User Mitigation
|
|
3160
|
+
|
|
3161
|
+
A [`malicious_user_mitigation`](#policy-based-challenge-malicious-user-mitigation) block (within [`policy_based_challenge`](#policy-based-challenge)) supports the following:
|
|
3162
|
+
|
|
3163
|
+
<a id="policy-based-challenge-malicious-user-mitigation-name"></a>• [`name`](#policy-based-challenge-malicious-user-mitigation-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
|
|
3164
|
+
|
|
3165
|
+
<a id="policy-based-challenge-malicious-user-mitigation-namespace"></a>• [`namespace`](#policy-based-challenge-malicious-user-mitigation-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
|
|
3166
|
+
|
|
3167
|
+
<a id="policy-based-challenge-malicious-user-mitigation-tenant"></a>• [`tenant`](#policy-based-challenge-malicious-user-mitigation-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
|
|
3168
|
+
|
|
3169
|
+
#### Policy Based Challenge Rule List
|
|
3170
|
+
|
|
3171
|
+
A [`rule_list`](#policy-based-challenge-rule-list) block (within [`policy_based_challenge`](#policy-based-challenge)) supports the following:
|
|
3172
|
+
|
|
3173
|
+
<a id="policy-based-challenge-rule-list-rules"></a>• [`rules`](#policy-based-challenge-rule-list-rules) - Optional Block<br>Rules. Rules that specify the match conditions and challenge type to be launched. When a challenge type is selected to be always enabled, these rules can be used to disable challenge or launch a different challenge for requests that match the specified conditions<br>See [Rules](#policy-based-challenge-rule-list-rules) below.
|
|
3174
|
+
|
|
3175
|
+
#### Policy Based Challenge Rule List Rules
|
|
3176
|
+
|
|
3177
|
+
A [`rules`](#policy-based-challenge-rule-list-rules) block (within [`policy_based_challenge.rule_list`](#policy-based-challenge-rule-list)) supports the following:
|
|
3178
|
+
|
|
3179
|
+
<a id="policy-based-challenge-rule-list-rules-metadata"></a>• [`metadata`](#policy-based-challenge-rule-list-rules-metadata) - 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](#policy-based-challenge-rule-list-rules-metadata) below.
|
|
3180
|
+
|
|
3181
|
+
<a id="policy-based-challenge-rule-list-rules-spec"></a>• [`spec`](#policy-based-challenge-rule-list-rules-spec) - Optional Block<br>Challenge Rule Specification. A Challenge Rule consists of an unordered list of predicates and an action. The predicates are evaluated against a set of input fields that are extracted from or derived from an L7 request API. A request API is considered to match the rule if all predicates in the rule evaluate to true for that request. Any predicates that are not specified in a rule are implicitly considered to be true. If a request API matches a challenge rule, the configured challenge is enforced<br>See [Spec](#policy-based-challenge-rule-list-rules-spec) below.
|
|
3182
|
+
|
|
3183
|
+
#### Policy Based Challenge Rule List Rules Metadata
|
|
3184
|
+
|
|
3185
|
+
A [`metadata`](#policy-based-challenge-rule-list-rules-metadata) block (within [`policy_based_challenge.rule_list.rules`](#policy-based-challenge-rule-list-rules)) supports the following:
|
|
3186
|
+
|
|
3187
|
+
<a id="policy-based-challenge-rule-list-rules-metadata-description-spec"></a>• [`description_spec`](#policy-based-challenge-rule-list-rules-metadata-description-spec) - Optional String<br>Description. Human readable description
|
|
3188
|
+
|
|
3189
|
+
<a id="policy-based-challenge-rule-list-rules-metadata-name"></a>• [`name`](#policy-based-challenge-rule-list-rules-metadata-name) - Optional String<br>Name. This is the name of the message. The value of name has to follow DNS-1035 format
|
|
3190
|
+
|
|
3191
|
+
#### Policy Based Challenge Rule List Rules Spec
|
|
3192
|
+
|
|
3193
|
+
A [`spec`](#policy-based-challenge-rule-list-rules-spec) block (within [`policy_based_challenge.rule_list.rules`](#policy-based-challenge-rule-list-rules)) supports the following:
|
|
3194
|
+
|
|
3195
|
+
<a id="policy-based-challenge-rule-list-rules-spec-any-asn"></a>• [`any_asn`](#policy-based-challenge-rule-list-rules-spec-any-asn) - Optional Block<br>Enable this option
|
|
3196
|
+
|
|
3197
|
+
<a id="policy-based-challenge-rule-list-rules-spec-any-client"></a>• [`any_client`](#policy-based-challenge-rule-list-rules-spec-any-client) - Optional Block<br>Enable this option
|
|
3198
|
+
|
|
3199
|
+
<a id="policy-based-challenge-rule-list-rules-spec-any-ip"></a>• [`any_ip`](#policy-based-challenge-rule-list-rules-spec-any-ip) - Optional Block<br>Enable this option
|
|
3200
|
+
|
|
3201
|
+
<a id="policy-based-challenge-rule-list-rules-spec-arg-matchers"></a>• [`arg_matchers`](#policy-based-challenge-rule-list-rules-spec-arg-matchers) - Optional Block<br>A list of predicates for all POST args that need to be matched. The criteria for matching each arg are described in individual instances of ArgMatcherType. The actual arg values are extracted from the request API as a list of strings for each arg selector name. Note that all specified arg matcher predicates must evaluate to true<br>See [Arg Matchers](#policy-based-challenge-rule-list-rules-spec-arg-matchers) below.
|
|
3202
|
+
|
|
3203
|
+
<a id="policy-based-challenge-rule-list-rules-spec-asn-list"></a>• [`asn_list`](#policy-based-challenge-rule-list-rules-spec-asn-list) - 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](#policy-based-challenge-rule-list-rules-spec-asn-list) below.
|
|
3204
|
+
|
|
3205
|
+
<a id="policy-based-challenge-rule-list-rules-spec-asn-matcher"></a>• [`asn_matcher`](#policy-based-challenge-rule-list-rules-spec-asn-matcher) - Optional Block<br>ASN Matcher. Match any AS number contained in the list of bgp_asn_sets<br>See [Asn Matcher](#policy-based-challenge-rule-list-rules-spec-asn-matcher) below.
|
|
3206
|
+
|
|
3207
|
+
<a id="policy-based-challenge-rule-list-rules-spec-body-matcher"></a>• [`body_matcher`](#policy-based-challenge-rule-list-rules-spec-body-matcher) - 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 [Body Matcher](#policy-based-challenge-rule-list-rules-spec-body-matcher) below.
|
|
3208
|
+
|
|
3209
|
+
<a id="policy-based-challenge-rule-list-rules-spec-client-selector"></a>• [`client_selector`](#policy-based-challenge-rule-list-rules-spec-client-selector) - 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](#policy-based-challenge-rule-list-rules-spec-client-selector) below.
|
|
3210
|
+
|
|
3211
|
+
<a id="policy-based-challenge-rule-list-rules-spec-cookie-matchers"></a>• [`cookie_matchers`](#policy-based-challenge-rule-list-rules-spec-cookie-matchers) - Optional Block<br>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](#policy-based-challenge-rule-list-rules-spec-cookie-matchers) below.
|
|
3212
|
+
|
|
3213
|
+
<a id="policy-based-challenge-rule-list-rules-spec-disable-challenge"></a>• [`disable_challenge`](#policy-based-challenge-rule-list-rules-spec-disable-challenge) - Optional Block<br>Enable this option
|
|
3214
|
+
|
|
3215
|
+
<a id="policy-based-challenge-rule-list-rules-spec-domain-matcher"></a>• [`domain_matcher`](#policy-based-challenge-rule-list-rules-spec-domain-matcher) - 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 [Domain Matcher](#policy-based-challenge-rule-list-rules-spec-domain-matcher) below.
|
|
3216
|
+
|
|
3217
|
+
<a id="policy-based-challenge-rule-list-rules-spec-enable-captcha-challenge"></a>• [`enable_captcha_challenge`](#policy-based-challenge-rule-list-rules-spec-enable-captcha-challenge) - Optional Block<br>Enable this option
|
|
3218
|
+
|
|
3219
|
+
<a id="policy-based-challenge-rule-list-rules-spec-enable-javascript-challenge"></a>• [`enable_javascript_challenge`](#policy-based-challenge-rule-list-rules-spec-enable-javascript-challenge) - Optional Block<br>Enable this option
|
|
3220
|
+
|
|
3221
|
+
<a id="policy-based-challenge-rule-list-rules-spec-expiration-timestamp"></a>• [`expiration_timestamp`](#policy-based-challenge-rule-list-rules-spec-expiration-timestamp) - Optional String<br>The expiration_timestamp is the RFC 3339 format timestamp at which the containing rule is considered to be logically expired. The rule continues to exist in the configuration but is not applied anymore
|
|
3222
|
+
|
|
3223
|
+
<a id="policy-based-challenge-rule-list-rules-spec-headers"></a>• [`headers`](#policy-based-challenge-rule-list-rules-spec-headers) - Optional Block<br>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](#policy-based-challenge-rule-list-rules-spec-headers) below.
|
|
3224
|
+
|
|
3225
|
+
<a id="policy-based-challenge-rule-list-rules-spec-http-method"></a>• [`http_method`](#policy-based-challenge-rule-list-rules-spec-http-method) - Optional Block<br>HTTP Method Matcher. A HTTP method matcher specifies a list of methods to match an input HTTP method. The match is considered successful if the input method is a member of the list. The result of the match based on the method list is inverted if invert_matcher is true<br>See [HTTP Method](#policy-based-challenge-rule-list-rules-spec-http-method) below.
|
|
3226
|
+
|
|
3227
|
+
<a id="policy-based-challenge-rule-list-rules-spec-ip-matcher"></a>• [`ip_matcher`](#policy-based-challenge-rule-list-rules-spec-ip-matcher) - 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](#policy-based-challenge-rule-list-rules-spec-ip-matcher) below.
|
|
3228
|
+
|
|
3229
|
+
<a id="policy-based-challenge-rule-list-rules-spec-ip-prefix-list"></a>• [`ip_prefix_list`](#policy-based-challenge-rule-list-rules-spec-ip-prefix-list) - Optional Block<br>IP Prefix Match List. List of IP Prefix strings to match against<br>See [IP Prefix List](#policy-based-challenge-rule-list-rules-spec-ip-prefix-list) below.
|
|
3230
|
+
|
|
3231
|
+
<a id="policy-based-challenge-rule-list-rules-spec-path"></a>• [`path`](#policy-based-challenge-rule-list-rules-spec-path) - Optional Block<br>Path Matcher. A path matcher specifies multiple criteria for matching an HTTP path string. The match is considered successful if any of the criteria are satisfied. The set of supported match criteria includes a list of path prefixes, a list of exact path values and a list of regular expressions<br>See [Path](#policy-based-challenge-rule-list-rules-spec-path) below.
|
|
3232
|
+
|
|
3233
|
+
<a id="policy-based-challenge-rule-list-rules-spec-query-params"></a>• [`query_params`](#policy-based-challenge-rule-list-rules-spec-query-params) - Optional Block<br>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](#policy-based-challenge-rule-list-rules-spec-query-params) below.
|
|
3234
|
+
|
|
3235
|
+
<a id="policy-based-challenge-rule-list-rules-spec-tls-fingerprint-matcher"></a>• [`tls_fingerprint_matcher`](#policy-based-challenge-rule-list-rules-spec-tls-fingerprint-matcher) - 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](#policy-based-challenge-rule-list-rules-spec-tls-fingerprint-matcher) below.
|
|
3236
|
+
|
|
3237
|
+
#### Policy Based Challenge Rule List Rules Spec Arg Matchers
|
|
3238
|
+
|
|
3239
|
+
An [`arg_matchers`](#policy-based-challenge-rule-list-rules-spec-arg-matchers) block (within [`policy_based_challenge.rule_list.rules.spec`](#policy-based-challenge-rule-list-rules-spec)) supports the following:
|
|
3240
|
+
|
|
3241
|
+
<a id="policy-based-challenge-rule-list-rules-spec-arg-matchers-check-not-present"></a>• [`check_not_present`](#policy-based-challenge-rule-list-rules-spec-arg-matchers-check-not-present) - Optional Block<br>Enable this option
|
|
3242
|
+
|
|
3243
|
+
<a id="policy-based-challenge-rule-list-rules-spec-arg-matchers-check-present"></a>• [`check_present`](#policy-based-challenge-rule-list-rules-spec-arg-matchers-check-present) - Optional Block<br>Enable this option
|
|
3244
|
+
|
|
3245
|
+
<a id="policy-based-challenge-rule-list-rules-spec-arg-matchers-invert-matcher"></a>• [`invert_matcher`](#policy-based-challenge-rule-list-rules-spec-arg-matchers-invert-matcher) - Optional Bool<br>Invert Matcher. Invert Match of the expression defined
|
|
3246
|
+
|
|
3247
|
+
<a id="policy-based-challenge-rule-list-rules-spec-arg-matchers-item"></a>• [`item`](#policy-based-challenge-rule-list-rules-spec-arg-matchers-item) - 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](#policy-based-challenge-rule-list-rules-spec-arg-matchers-item) below.
|
|
3248
|
+
|
|
3249
|
+
<a id="policy-based-challenge-rule-list-rules-spec-arg-matchers-name"></a>• [`name`](#policy-based-challenge-rule-list-rules-spec-arg-matchers-name) - Optional String<br>Argument Name. A case-sensitive JSON path in the HTTP request body
|
|
3250
|
+
|
|
3251
|
+
#### Policy Based Challenge Rule List Rules Spec Arg Matchers Item
|
|
3252
|
+
|
|
3253
|
+
An [`item`](#policy-based-challenge-rule-list-rules-spec-arg-matchers-item) block (within [`policy_based_challenge.rule_list.rules.spec.arg_matchers`](#policy-based-challenge-rule-list-rules-spec-arg-matchers)) supports the following:
|
|
3254
|
+
|
|
3255
|
+
<a id="policy-based-challenge-rule-list-rules-spec-arg-matchers-item-exact-values"></a>• [`exact_values`](#policy-based-challenge-rule-list-rules-spec-arg-matchers-item-exact-values) - Optional List<br>Exact Values. A list of exact values to match the input against
|
|
3256
|
+
|
|
3257
|
+
<a id="policy-based-challenge-rule-list-rules-spec-arg-matchers-item-regex-values"></a>• [`regex_values`](#policy-based-challenge-rule-list-rules-spec-arg-matchers-item-regex-values) - Optional List<br>Regex Values. A list of regular expressions to match the input against
|
|
3258
|
+
|
|
3259
|
+
<a id="policy-based-challenge-rule-list-rules-spec-arg-matchers-item-transformers"></a>• [`transformers`](#policy-based-challenge-rule-list-rules-spec-arg-matchers-item-transformers) - 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
|
|
3260
|
+
|
|
3261
|
+
#### Policy Based Challenge Rule List Rules Spec Asn List
|
|
3262
|
+
|
|
3263
|
+
An [`asn_list`](#policy-based-challenge-rule-list-rules-spec-asn-list) block (within [`policy_based_challenge.rule_list.rules.spec`](#policy-based-challenge-rule-list-rules-spec)) supports the following:
|
|
3264
|
+
|
|
3265
|
+
<a id="policy-based-challenge-rule-list-rules-spec-asn-list-as-numbers"></a>• [`as_numbers`](#policy-based-challenge-rule-list-rules-spec-asn-list-as-numbers) - 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
|
|
3266
|
+
|
|
3267
|
+
#### Policy Based Challenge Rule List Rules Spec Asn Matcher
|
|
3268
|
+
|
|
3269
|
+
An [`asn_matcher`](#policy-based-challenge-rule-list-rules-spec-asn-matcher) block (within [`policy_based_challenge.rule_list.rules.spec`](#policy-based-challenge-rule-list-rules-spec)) supports the following:
|
|
3270
|
+
|
|
3271
|
+
<a id="policy-based-challenge-rule-list-rules-spec-asn-matcher-asn-sets"></a>• [`asn_sets`](#policy-based-challenge-rule-list-rules-spec-asn-matcher-asn-sets) - Optional Block<br>BGP ASN Sets. A list of references to bgp_asn_set objects<br>See [Asn Sets](#policy-based-challenge-rule-list-rules-spec-asn-matcher-asn-sets) below.
|
|
3272
|
+
|
|
3273
|
+
#### Policy Based Challenge Rule List Rules Spec Asn Matcher Asn Sets
|
|
3274
|
+
|
|
3275
|
+
An [`asn_sets`](#policy-based-challenge-rule-list-rules-spec-asn-matcher-asn-sets) block (within [`policy_based_challenge.rule_list.rules.spec.asn_matcher`](#policy-based-challenge-rule-list-rules-spec-asn-matcher)) supports the following:
|
|
3276
|
+
|
|
3277
|
+
<a id="policy-based-challenge-rule-list-rules-spec-asn-matcher-asn-sets-kind"></a>• [`kind`](#policy-based-challenge-rule-list-rules-spec-asn-matcher-asn-sets-kind) - 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="policy-based-challenge-rule-list-rules-spec-asn-matcher-asn-sets-name"></a>• [`name`](#policy-based-challenge-rule-list-rules-spec-asn-matcher-asn-sets-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
|
|
3280
|
+
|
|
3281
|
+
<a id="policy-based-challenge-rule-list-rules-spec-asn-matcher-asn-sets-namespace"></a>• [`namespace`](#policy-based-challenge-rule-list-rules-spec-asn-matcher-asn-sets-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
|
|
3282
|
+
|
|
3283
|
+
<a id="policy-based-challenge-rule-list-rules-spec-asn-matcher-asn-sets-tenant"></a>• [`tenant`](#policy-based-challenge-rule-list-rules-spec-asn-matcher-asn-sets-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
|
|
3284
|
+
|
|
3285
|
+
<a id="policy-based-challenge-rule-list-rules-spec-asn-matcher-asn-sets-uid"></a>• [`uid`](#policy-based-challenge-rule-list-rules-spec-asn-matcher-asn-sets-uid) - 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
|
|
3286
|
+
|
|
3287
|
+
#### Policy Based Challenge Rule List Rules Spec Body Matcher
|
|
3288
|
+
|
|
3289
|
+
A [`body_matcher`](#policy-based-challenge-rule-list-rules-spec-body-matcher) block (within [`policy_based_challenge.rule_list.rules.spec`](#policy-based-challenge-rule-list-rules-spec)) supports the following:
|
|
3290
|
+
|
|
3291
|
+
<a id="policy-based-challenge-rule-list-rules-spec-body-matcher-exact-values"></a>• [`exact_values`](#policy-based-challenge-rule-list-rules-spec-body-matcher-exact-values) - Optional List<br>Exact Values. A list of exact values to match the input against
|
|
3292
|
+
|
|
3293
|
+
<a id="policy-based-challenge-rule-list-rules-spec-body-matcher-regex-values"></a>• [`regex_values`](#policy-based-challenge-rule-list-rules-spec-body-matcher-regex-values) - Optional List<br>Regex Values. A list of regular expressions to match the input against
|
|
3294
|
+
|
|
3295
|
+
<a id="policy-based-challenge-rule-list-rules-spec-body-matcher-transformers"></a>• [`transformers`](#policy-based-challenge-rule-list-rules-spec-body-matcher-transformers) - 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
|
|
3296
|
+
|
|
3297
|
+
#### Policy Based Challenge Rule List Rules Spec Client Selector
|
|
3298
|
+
|
|
3299
|
+
A [`client_selector`](#policy-based-challenge-rule-list-rules-spec-client-selector) block (within [`policy_based_challenge.rule_list.rules.spec`](#policy-based-challenge-rule-list-rules-spec)) supports the following:
|
|
3300
|
+
|
|
3301
|
+
<a id="policy-based-challenge-rule-list-rules-spec-client-selector-expressions"></a>• [`expressions`](#policy-based-challenge-rule-list-rules-spec-client-selector-expressions) - Optional List<br>Selector Expression. expressions contains the kubernetes style label expression for selections
|
|
3302
|
+
|
|
3303
|
+
#### Policy Based Challenge Rule List Rules Spec Cookie Matchers
|
|
3304
|
+
|
|
3305
|
+
A [`cookie_matchers`](#policy-based-challenge-rule-list-rules-spec-cookie-matchers) block (within [`policy_based_challenge.rule_list.rules.spec`](#policy-based-challenge-rule-list-rules-spec)) supports the following:
|
|
3306
|
+
|
|
3307
|
+
<a id="policy-based-challenge-rule-list-rules-spec-cookie-matchers-check-not-present"></a>• [`check_not_present`](#policy-based-challenge-rule-list-rules-spec-cookie-matchers-check-not-present) - Optional Block<br>Enable this option
|
|
3308
|
+
|
|
3309
|
+
<a id="policy-based-challenge-rule-list-rules-spec-cookie-matchers-check-present"></a>• [`check_present`](#policy-based-challenge-rule-list-rules-spec-cookie-matchers-check-present) - Optional Block<br>Enable this option
|
|
3310
|
+
|
|
3311
|
+
<a id="policy-based-challenge-rule-list-rules-spec-cookie-matchers-invert-matcher"></a>• [`invert_matcher`](#policy-based-challenge-rule-list-rules-spec-cookie-matchers-invert-matcher) - Optional Bool<br>Invert Matcher. Invert Match of the expression defined
|
|
3312
|
+
|
|
3313
|
+
<a id="policy-based-challenge-rule-list-rules-spec-cookie-matchers-item"></a>• [`item`](#policy-based-challenge-rule-list-rules-spec-cookie-matchers-item) - 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](#policy-based-challenge-rule-list-rules-spec-cookie-matchers-item) below.
|
|
3314
|
+
|
|
3315
|
+
<a id="policy-based-challenge-rule-list-rules-spec-cookie-matchers-name"></a>• [`name`](#policy-based-challenge-rule-list-rules-spec-cookie-matchers-name) - Optional String<br>Cookie Name. A case-sensitive cookie name
|
|
3316
|
+
|
|
3317
|
+
#### Policy Based Challenge Rule List Rules Spec Cookie Matchers Item
|
|
3318
|
+
|
|
3319
|
+
An [`item`](#policy-based-challenge-rule-list-rules-spec-cookie-matchers-item) block (within [`policy_based_challenge.rule_list.rules.spec.cookie_matchers`](#policy-based-challenge-rule-list-rules-spec-cookie-matchers)) supports the following:
|
|
3320
|
+
|
|
3321
|
+
<a id="policy-based-challenge-rule-list-rules-spec-cookie-matchers-item-exact-values"></a>• [`exact_values`](#policy-based-challenge-rule-list-rules-spec-cookie-matchers-item-exact-values) - Optional List<br>Exact Values. A list of exact values to match the input against
|
|
3322
|
+
|
|
3323
|
+
<a id="policy-based-challenge-rule-list-rules-spec-cookie-matchers-item-regex-values"></a>• [`regex_values`](#policy-based-challenge-rule-list-rules-spec-cookie-matchers-item-regex-values) - Optional List<br>Regex Values. A list of regular expressions to match the input against
|
|
3324
|
+
|
|
3325
|
+
<a id="policy-based-challenge-rule-list-rules-spec-cookie-matchers-item-transformers"></a>• [`transformers`](#policy-based-challenge-rule-list-rules-spec-cookie-matchers-item-transformers) - 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
|
|
3326
|
+
|
|
3327
|
+
#### Policy Based Challenge Rule List Rules Spec Domain Matcher
|
|
3328
|
+
|
|
3329
|
+
A [`domain_matcher`](#policy-based-challenge-rule-list-rules-spec-domain-matcher) block (within [`policy_based_challenge.rule_list.rules.spec`](#policy-based-challenge-rule-list-rules-spec)) supports the following:
|
|
3330
|
+
|
|
3331
|
+
<a id="policy-based-challenge-rule-list-rules-spec-domain-matcher-exact-values"></a>• [`exact_values`](#policy-based-challenge-rule-list-rules-spec-domain-matcher-exact-values) - Optional List<br>Exact Values. A list of exact values to match the input against
|
|
3332
|
+
|
|
3333
|
+
<a id="policy-based-challenge-rule-list-rules-spec-domain-matcher-regex-values"></a>• [`regex_values`](#policy-based-challenge-rule-list-rules-spec-domain-matcher-regex-values) - Optional List<br>Regex Values. A list of regular expressions to match the input against
|
|
3334
|
+
|
|
3335
|
+
#### Policy Based Challenge Rule List Rules Spec Headers
|
|
3336
|
+
|
|
3337
|
+
A [`headers`](#policy-based-challenge-rule-list-rules-spec-headers) block (within [`policy_based_challenge.rule_list.rules.spec`](#policy-based-challenge-rule-list-rules-spec)) supports the following:
|
|
3338
|
+
|
|
3339
|
+
<a id="policy-based-challenge-rule-list-rules-spec-headers-check-not-present"></a>• [`check_not_present`](#policy-based-challenge-rule-list-rules-spec-headers-check-not-present) - Optional Block<br>Enable this option
|
|
3340
|
+
|
|
3341
|
+
<a id="policy-based-challenge-rule-list-rules-spec-headers-check-present"></a>• [`check_present`](#policy-based-challenge-rule-list-rules-spec-headers-check-present) - Optional Block<br>Enable this option
|
|
3342
|
+
|
|
3343
|
+
<a id="policy-based-challenge-rule-list-rules-spec-headers-invert-matcher"></a>• [`invert_matcher`](#policy-based-challenge-rule-list-rules-spec-headers-invert-matcher) - Optional Bool<br>Invert Header Matcher. Invert the match result
|
|
3344
|
+
|
|
3345
|
+
<a id="policy-based-challenge-rule-list-rules-spec-headers-item"></a>• [`item`](#policy-based-challenge-rule-list-rules-spec-headers-item) - 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](#policy-based-challenge-rule-list-rules-spec-headers-item) below.
|
|
3346
|
+
|
|
3347
|
+
<a id="policy-based-challenge-rule-list-rules-spec-headers-name"></a>• [`name`](#policy-based-challenge-rule-list-rules-spec-headers-name) - Optional String<br>Header Name. A case-insensitive HTTP header name
|
|
3348
|
+
|
|
3349
|
+
#### Policy Based Challenge Rule List Rules Spec Headers Item
|
|
3350
|
+
|
|
3351
|
+
An [`item`](#policy-based-challenge-rule-list-rules-spec-headers-item) block (within [`policy_based_challenge.rule_list.rules.spec.headers`](#policy-based-challenge-rule-list-rules-spec-headers)) supports the following:
|
|
3352
|
+
|
|
3353
|
+
<a id="policy-based-challenge-rule-list-rules-spec-headers-item-exact-values"></a>• [`exact_values`](#policy-based-challenge-rule-list-rules-spec-headers-item-exact-values) - Optional List<br>Exact Values. A list of exact values to match the input against
|
|
3354
|
+
|
|
3355
|
+
<a id="policy-based-challenge-rule-list-rules-spec-headers-item-regex-values"></a>• [`regex_values`](#policy-based-challenge-rule-list-rules-spec-headers-item-regex-values) - Optional List<br>Regex Values. A list of regular expressions to match the input against
|
|
3356
|
+
|
|
3357
|
+
<a id="policy-based-challenge-rule-list-rules-spec-headers-item-transformers"></a>• [`transformers`](#policy-based-challenge-rule-list-rules-spec-headers-item-transformers) - 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
|
|
3358
|
+
|
|
3359
|
+
#### Policy Based Challenge Rule List Rules Spec HTTP Method
|
|
3360
|
+
|
|
3361
|
+
A [`http_method`](#policy-based-challenge-rule-list-rules-spec-http-method) block (within [`policy_based_challenge.rule_list.rules.spec`](#policy-based-challenge-rule-list-rules-spec)) supports the following:
|
|
3362
|
+
|
|
3363
|
+
<a id="policy-based-challenge-rule-list-rules-spec-http-method-invert-matcher"></a>• [`invert_matcher`](#policy-based-challenge-rule-list-rules-spec-http-method-invert-matcher) - Optional Bool<br>Invert Method Matcher. Invert the match result
|
|
3364
|
+
|
|
3365
|
+
<a id="policy-based-challenge-rule-list-rules-spec-http-method-methods"></a>• [`methods`](#policy-based-challenge-rule-list-rules-spec-http-method-methods) - 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
|
|
3366
|
+
|
|
3367
|
+
#### Policy Based Challenge Rule List Rules Spec IP Matcher
|
|
3368
|
+
|
|
3369
|
+
An [`ip_matcher`](#policy-based-challenge-rule-list-rules-spec-ip-matcher) block (within [`policy_based_challenge.rule_list.rules.spec`](#policy-based-challenge-rule-list-rules-spec)) supports the following:
|
|
3370
|
+
|
|
3371
|
+
<a id="policy-based-challenge-rule-list-rules-spec-ip-matcher-invert-matcher"></a>• [`invert_matcher`](#policy-based-challenge-rule-list-rules-spec-ip-matcher-invert-matcher) - Optional Bool<br>Invert IP Matcher. Invert the match result
|
|
3372
|
+
|
|
3373
|
+
<a id="policy-based-challenge-rule-list-rules-spec-ip-matcher-prefix-sets"></a>• [`prefix_sets`](#policy-based-challenge-rule-list-rules-spec-ip-matcher-prefix-sets) - Optional Block<br>IP Prefix Sets. A list of references to ip_prefix_set objects<br>See [Prefix Sets](#policy-based-challenge-rule-list-rules-spec-ip-matcher-prefix-sets) below.
|
|
3374
|
+
|
|
3375
|
+
#### Policy Based Challenge Rule List Rules Spec IP Matcher Prefix Sets
|
|
3376
|
+
|
|
3377
|
+
A [`prefix_sets`](#policy-based-challenge-rule-list-rules-spec-ip-matcher-prefix-sets) block (within [`policy_based_challenge.rule_list.rules.spec.ip_matcher`](#policy-based-challenge-rule-list-rules-spec-ip-matcher)) supports the following:
|
|
3378
|
+
|
|
3379
|
+
<a id="policy-based-challenge-rule-list-rules-spec-ip-matcher-prefix-sets-kind"></a>• [`kind`](#policy-based-challenge-rule-list-rules-spec-ip-matcher-prefix-sets-kind) - 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="policy-based-challenge-rule-list-rules-spec-ip-matcher-prefix-sets-name"></a>• [`name`](#policy-based-challenge-rule-list-rules-spec-ip-matcher-prefix-sets-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
|
|
3382
|
+
|
|
3383
|
+
<a id="policy-based-challenge-rule-list-rules-spec-ip-matcher-prefix-sets-namespace"></a>• [`namespace`](#policy-based-challenge-rule-list-rules-spec-ip-matcher-prefix-sets-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
|
|
3384
|
+
|
|
3385
|
+
<a id="policy-based-challenge-rule-list-rules-spec-ip-matcher-prefix-sets-tenant"></a>• [`tenant`](#policy-based-challenge-rule-list-rules-spec-ip-matcher-prefix-sets-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
|
|
3386
|
+
|
|
3387
|
+
<a id="policy-based-challenge-rule-list-rules-spec-ip-matcher-prefix-sets-uid"></a>• [`uid`](#policy-based-challenge-rule-list-rules-spec-ip-matcher-prefix-sets-uid) - 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
|
|
3388
|
+
|
|
3389
|
+
#### Policy Based Challenge Rule List Rules Spec IP Prefix List
|
|
3390
|
+
|
|
3391
|
+
An [`ip_prefix_list`](#policy-based-challenge-rule-list-rules-spec-ip-prefix-list) block (within [`policy_based_challenge.rule_list.rules.spec`](#policy-based-challenge-rule-list-rules-spec)) supports the following:
|
|
3392
|
+
|
|
3393
|
+
<a id="policy-based-challenge-rule-list-rules-spec-ip-prefix-list-invert-match"></a>• [`invert_match`](#policy-based-challenge-rule-list-rules-spec-ip-prefix-list-invert-match) - Optional Bool<br>Invert Match Result. Invert the match result
|
|
3394
|
+
|
|
3395
|
+
<a id="policy-based-challenge-rule-list-rules-spec-ip-prefix-list-ip-prefixes"></a>• [`ip_prefixes`](#policy-based-challenge-rule-list-rules-spec-ip-prefix-list-ip-prefixes) - Optional List<br>IPv4 Prefix List. List of IPv4 prefix strings
|
|
3396
|
+
|
|
3397
|
+
#### Policy Based Challenge Rule List Rules Spec Path
|
|
3398
|
+
|
|
3399
|
+
A [`path`](#policy-based-challenge-rule-list-rules-spec-path) block (within [`policy_based_challenge.rule_list.rules.spec`](#policy-based-challenge-rule-list-rules-spec)) supports the following:
|
|
3400
|
+
|
|
3401
|
+
<a id="policy-based-challenge-rule-list-rules-spec-path-exact-values"></a>• [`exact_values`](#policy-based-challenge-rule-list-rules-spec-path-exact-values) - Optional List<br>Exact Values. A list of exact path values to match the input HTTP path against
|
|
3402
|
+
|
|
3403
|
+
<a id="policy-based-challenge-rule-list-rules-spec-path-invert-matcher"></a>• [`invert_matcher`](#policy-based-challenge-rule-list-rules-spec-path-invert-matcher) - Optional Bool<br>Invert Path Matcher. Invert the match result
|
|
3404
|
+
|
|
3405
|
+
<a id="policy-based-challenge-rule-list-rules-spec-path-prefix-values"></a>• [`prefix_values`](#policy-based-challenge-rule-list-rules-spec-path-prefix-values) - Optional List<br>Prefix Values. A list of path prefix values to match the input HTTP path against
|
|
3406
|
+
|
|
3407
|
+
<a id="policy-based-challenge-rule-list-rules-spec-path-regex-values"></a>• [`regex_values`](#policy-based-challenge-rule-list-rules-spec-path-regex-values) - Optional List<br>Regex Values. A list of regular expressions to match the input HTTP path against
|
|
3408
|
+
|
|
3409
|
+
<a id="policy-based-challenge-rule-list-rules-spec-path-suffix-values"></a>• [`suffix_values`](#policy-based-challenge-rule-list-rules-spec-path-suffix-values) - Optional List<br>Suffix Values. A list of path suffix values to match the input HTTP path against
|
|
3410
|
+
|
|
3411
|
+
<a id="policy-based-challenge-rule-list-rules-spec-path-transformers"></a>• [`transformers`](#policy-based-challenge-rule-list-rules-spec-path-transformers) - 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
|
|
3412
|
+
|
|
3413
|
+
#### Policy Based Challenge Rule List Rules Spec Query Params
|
|
3414
|
+
|
|
3415
|
+
A [`query_params`](#policy-based-challenge-rule-list-rules-spec-query-params) block (within [`policy_based_challenge.rule_list.rules.spec`](#policy-based-challenge-rule-list-rules-spec)) supports the following:
|
|
3416
|
+
|
|
3417
|
+
<a id="policy-based-challenge-rule-list-rules-spec-query-params-check-not-present"></a>• [`check_not_present`](#policy-based-challenge-rule-list-rules-spec-query-params-check-not-present) - Optional Block<br>Enable this option
|
|
3418
|
+
|
|
3419
|
+
<a id="policy-based-challenge-rule-list-rules-spec-query-params-check-present"></a>• [`check_present`](#policy-based-challenge-rule-list-rules-spec-query-params-check-present) - Optional Block<br>Enable this option
|
|
3420
|
+
|
|
3421
|
+
<a id="policy-based-challenge-rule-list-rules-spec-query-params-invert-matcher"></a>• [`invert_matcher`](#policy-based-challenge-rule-list-rules-spec-query-params-invert-matcher) - Optional Bool<br>Invert Query Parameter Matcher. Invert the match result
|
|
3422
|
+
|
|
3423
|
+
<a id="policy-based-challenge-rule-list-rules-spec-query-params-item"></a>• [`item`](#policy-based-challenge-rule-list-rules-spec-query-params-item) - 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](#policy-based-challenge-rule-list-rules-spec-query-params-item) below.
|
|
3424
|
+
|
|
3425
|
+
<a id="policy-based-challenge-rule-list-rules-spec-query-params-key"></a>• [`key`](#policy-based-challenge-rule-list-rules-spec-query-params-key) - Optional String<br>Query Parameter Name. A case-sensitive HTTP query parameter name
|
|
3426
|
+
|
|
3427
|
+
#### Policy Based Challenge Rule List Rules Spec Query Params Item
|
|
3428
|
+
|
|
3429
|
+
An [`item`](#policy-based-challenge-rule-list-rules-spec-query-params-item) block (within [`policy_based_challenge.rule_list.rules.spec.query_params`](#policy-based-challenge-rule-list-rules-spec-query-params)) supports the following:
|
|
3430
|
+
|
|
3431
|
+
<a id="policy-based-challenge-rule-list-rules-spec-query-params-item-exact-values"></a>• [`exact_values`](#policy-based-challenge-rule-list-rules-spec-query-params-item-exact-values) - Optional List<br>Exact Values. A list of exact values to match the input against
|
|
3432
|
+
|
|
3433
|
+
<a id="policy-based-challenge-rule-list-rules-spec-query-params-item-regex-values"></a>• [`regex_values`](#policy-based-challenge-rule-list-rules-spec-query-params-item-regex-values) - Optional List<br>Regex Values. A list of regular expressions to match the input against
|
|
3434
|
+
|
|
3435
|
+
<a id="policy-based-challenge-rule-list-rules-spec-query-params-item-transformers"></a>• [`transformers`](#policy-based-challenge-rule-list-rules-spec-query-params-item-transformers) - 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
|
|
3436
|
+
|
|
3437
|
+
#### Policy Based Challenge Rule List Rules Spec TLS Fingerprint Matcher
|
|
3438
|
+
|
|
3439
|
+
A [`tls_fingerprint_matcher`](#policy-based-challenge-rule-list-rules-spec-tls-fingerprint-matcher) block (within [`policy_based_challenge.rule_list.rules.spec`](#policy-based-challenge-rule-list-rules-spec)) supports the following:
|
|
3440
|
+
|
|
3441
|
+
<a id="policy-based-challenge-rule-list-rules-spec-tls-fingerprint-matcher-classes"></a>• [`classes`](#policy-based-challenge-rule-list-rules-spec-tls-fingerprint-matcher-classes) - 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="policy-based-challenge-rule-list-rules-spec-tls-fingerprint-matcher-exact-values"></a>• [`exact_values`](#policy-based-challenge-rule-list-rules-spec-tls-fingerprint-matcher-exact-values) - Optional List<br>Exact Values. A list of exact TLS JA3 fingerprints to match the input TLS JA3 fingerprint against
|
|
3444
|
+
|
|
3445
|
+
<a id="policy-based-challenge-rule-list-rules-spec-tls-fingerprint-matcher-excluded-values"></a>• [`excluded_values`](#policy-based-challenge-rule-list-rules-spec-tls-fingerprint-matcher-excluded-values) - 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
|
|
3446
|
+
|
|
3447
|
+
#### Policy Based Challenge Temporary User Blocking
|
|
3448
|
+
|
|
3449
|
+
A [`temporary_user_blocking`](#policy-based-challenge-temporary-user-blocking) block (within [`policy_based_challenge`](#policy-based-challenge)) supports the following:
|
|
3450
|
+
|
|
3451
|
+
<a id="policy-based-challenge-temporary-user-blocking-custom-page"></a>• [`custom_page`](#policy-based-challenge-temporary-user-blocking-custom-page) - Optional String<br>Custom Message for Temporary Blocking. Custom 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. 'Blocked.' or it can be HTML paragraph or a body string encoded as base64 string E.g. '`<p>` Blocked `</p>`'. Base64 encoded string for this HTML is 'PHA+IFBsZWFzZSBXYWl0IDwvcD4='
|
|
3452
|
+
|
|
3453
|
+
#### Protected Cookies
|
|
3454
|
+
|
|
3455
|
+
A [`protected_cookies`](#protected-cookies) block supports the following:
|
|
3456
|
+
|
|
3457
|
+
<a id="protected-cookies-add-httponly"></a>• [`add_httponly`](#protected-cookies-add-httponly) - Optional Block<br>Enable this option
|
|
3458
|
+
|
|
3459
|
+
<a id="protected-cookies-add-secure"></a>• [`add_secure`](#protected-cookies-add-secure) - Optional Block<br>Enable this option
|
|
3460
|
+
|
|
3461
|
+
<a id="protected-cookies-disable-tampering-protection"></a>• [`disable_tampering_protection`](#protected-cookies-disable-tampering-protection) - Optional Block<br>Enable this option
|
|
3462
|
+
|
|
3463
|
+
<a id="protected-cookies-enable-tampering-protection"></a>• [`enable_tampering_protection`](#protected-cookies-enable-tampering-protection) - Optional Block<br>Enable this option
|
|
3464
|
+
|
|
3465
|
+
<a id="protected-cookies-ignore-httponly"></a>• [`ignore_httponly`](#protected-cookies-ignore-httponly) - Optional Block<br>Enable this option
|
|
3466
|
+
|
|
3467
|
+
<a id="protected-cookies-ignore-max-age"></a>• [`ignore_max_age`](#protected-cookies-ignore-max-age) - Optional Block<br>Enable this option
|
|
3468
|
+
|
|
3469
|
+
<a id="protected-cookies-ignore-samesite"></a>• [`ignore_samesite`](#protected-cookies-ignore-samesite) - Optional Block<br>Enable this option
|
|
3470
|
+
|
|
3471
|
+
<a id="protected-cookies-ignore-secure"></a>• [`ignore_secure`](#protected-cookies-ignore-secure) - Optional Block<br>Enable this option
|
|
3472
|
+
|
|
3473
|
+
<a id="protected-cookies-max-age-value"></a>• [`max_age_value`](#protected-cookies-max-age-value) - Optional Number<br>Add Max Age. Add max age attribute
|
|
3474
|
+
|
|
3475
|
+
<a id="protected-cookies-name"></a>• [`name`](#protected-cookies-name) - Optional String<br>Cookie Name. Name of the Cookie
|
|
3476
|
+
|
|
3477
|
+
<a id="protected-cookies-samesite-lax"></a>• [`samesite_lax`](#protected-cookies-samesite-lax) - Optional Block<br>Enable this option
|
|
3478
|
+
|
|
3479
|
+
<a id="protected-cookies-samesite-none"></a>• [`samesite_none`](#protected-cookies-samesite-none) - Optional Block<br>Enable this option
|
|
3480
|
+
|
|
3481
|
+
<a id="protected-cookies-samesite-strict"></a>• [`samesite_strict`](#protected-cookies-samesite-strict) - Optional Block<br>Enable this option
|
|
3482
|
+
|
|
3483
|
+
#### Rate Limit
|
|
3484
|
+
|
|
3485
|
+
A [`rate_limit`](#rate-limit) block supports the following:
|
|
3486
|
+
|
|
3487
|
+
<a id="rate-limit-custom-ip-allowed-list"></a>• [`custom_ip_allowed_list`](#rate-limit-custom-ip-allowed-list) - Optional Block<br>Custom IP Allowed List. IP Allowed list using existing ip_prefix_set objects<br>See [Custom IP Allowed List](#rate-limit-custom-ip-allowed-list) below.
|
|
3488
|
+
|
|
3489
|
+
<a id="rate-limit-ip-allowed-list"></a>• [`ip_allowed_list`](#rate-limit-ip-allowed-list) - Optional Block<br>IPv4 Prefix List. List of IPv4 prefixes that represent an endpoint<br>See [IP Allowed List](#rate-limit-ip-allowed-list) below.
|
|
3490
|
+
|
|
3491
|
+
<a id="rate-limit-no-ip-allowed-list"></a>• [`no_ip_allowed_list`](#rate-limit-no-ip-allowed-list) - Optional Block<br>Enable this option
|
|
3492
|
+
|
|
3493
|
+
<a id="rate-limit-no-policies"></a>• [`no_policies`](#rate-limit-no-policies) - Optional Block<br>Enable this option
|
|
3494
|
+
|
|
3495
|
+
<a id="rate-limit-policies"></a>• [`policies`](#rate-limit-policies) - Optional Block<br>Rate Limiter Policy List. List of rate limiter policies to be applied<br>See [Policies](#rate-limit-policies) below.
|
|
3496
|
+
|
|
3497
|
+
<a id="rate-limit-rate-limiter"></a>• [`rate_limiter`](#rate-limit-rate-limiter) - Optional Block<br>Rate Limit Value. A tuple consisting of a rate limit period unit and the total number of allowed requests for that period<br>See [Rate Limiter](#rate-limit-rate-limiter) below.
|
|
3498
|
+
|
|
3499
|
+
#### Rate Limit Custom IP Allowed List
|
|
3500
|
+
|
|
3501
|
+
A [`custom_ip_allowed_list`](#rate-limit-custom-ip-allowed-list) block (within [`rate_limit`](#rate-limit)) supports the following:
|
|
3502
|
+
|
|
3503
|
+
<a id="rate-limit-custom-ip-allowed-list-rate-limiter-allowed-prefixes"></a>• [`rate_limiter_allowed_prefixes`](#rate-limit-custom-ip-allowed-list-rate-limiter-allowed-prefixes) - Optional Block<br>List of IP Prefix Sets. References to ip_prefix_set objects. Requests from source IP addresses that are covered by one of the allowed IP Prefixes are not subjected to rate limiting<br>See [Rate Limiter Allowed Prefixes](#rate-limit-custom-ip-allowed-list-rate-limiter-allowed-prefixes) below.
|
|
3504
|
+
|
|
3505
|
+
#### Rate Limit Custom IP Allowed List Rate Limiter Allowed Prefixes
|
|
3506
|
+
|
|
3507
|
+
A [`rate_limiter_allowed_prefixes`](#rate-limit-custom-ip-allowed-list-rate-limiter-allowed-prefixes) block (within [`rate_limit.custom_ip_allowed_list`](#rate-limit-custom-ip-allowed-list)) supports the following:
|
|
3508
|
+
|
|
3509
|
+
<a id="rate-limit-custom-ip-allowed-list-rate-limiter-allowed-prefixes-name"></a>• [`name`](#rate-limit-custom-ip-allowed-list-rate-limiter-allowed-prefixes-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
|
|
3510
|
+
|
|
3511
|
+
<a id="rate-limit-custom-ip-allowed-list-rate-limiter-allowed-prefixes-namespace"></a>• [`namespace`](#rate-limit-custom-ip-allowed-list-rate-limiter-allowed-prefixes-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
|
|
3512
|
+
|
|
3513
|
+
<a id="rate-limit-custom-ip-allowed-list-rate-limiter-allowed-prefixes-tenant"></a>• [`tenant`](#rate-limit-custom-ip-allowed-list-rate-limiter-allowed-prefixes-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
|
|
3514
|
+
|
|
3515
|
+
#### Rate Limit IP Allowed List
|
|
3516
|
+
|
|
3517
|
+
An [`ip_allowed_list`](#rate-limit-ip-allowed-list) block (within [`rate_limit`](#rate-limit)) supports the following:
|
|
3518
|
+
|
|
3519
|
+
<a id="rate-limit-ip-allowed-list-prefixes"></a>• [`prefixes`](#rate-limit-ip-allowed-list-prefixes) - Optional List<br>IPv4 Prefix List. List of IPv4 prefixes that represent an endpoint
|
|
3520
|
+
|
|
3521
|
+
#### Rate Limit Policies
|
|
3522
|
+
|
|
3523
|
+
A [`policies`](#rate-limit-policies) block (within [`rate_limit`](#rate-limit)) supports the following:
|
|
3524
|
+
|
|
3525
|
+
<a id="rate-limit-policies-policies"></a>• [`policies`](#rate-limit-policies-policies) - Optional Block<br>Rate Limiter Policies. Ordered list of rate limiter policies<br>See [Policies](#rate-limit-policies-policies) below.
|
|
3526
|
+
|
|
3527
|
+
#### Rate Limit Policies Policies
|
|
3528
|
+
|
|
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>• [`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>• [`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>• [`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
|
|
3536
|
+
|
|
3537
|
+
#### Rate Limit Rate Limiter
|
|
3538
|
+
|
|
3539
|
+
A [`rate_limiter`](#rate-limit-rate-limiter) block (within [`rate_limit`](#rate-limit)) supports the following:
|
|
3540
|
+
|
|
3541
|
+
<a id="rate-limit-rate-limiter-action-block"></a>• [`action_block`](#rate-limit-rate-limiter-action-block) - Optional Block<br>Rate Limit Block Action. Action where a user is blocked from making further requests after exceeding rate limit threshold<br>See [Action Block](#rate-limit-rate-limiter-action-block) below.
|
|
3542
|
+
|
|
3543
|
+
<a id="rate-limit-rate-limiter-burst-multiplier"></a>• [`burst_multiplier`](#rate-limit-rate-limiter-burst-multiplier) - Optional Number<br>Burst Multiplier. The maximum burst of requests to accommodate, expressed as a multiple of the rate
|
|
3544
|
+
|
|
3545
|
+
<a id="rate-limit-rate-limiter-disabled"></a>• [`disabled`](#rate-limit-rate-limiter-disabled) - Optional Block<br>Enable this option
|
|
3546
|
+
|
|
3547
|
+
<a id="rate-limit-rate-limiter-leaky-bucket"></a>• [`leaky_bucket`](#rate-limit-rate-limiter-leaky-bucket) - Optional Block<br>Leaky Bucket Rate Limiter. Leaky-Bucket is the default rate limiter algorithm for F5
|
|
3548
|
+
|
|
3549
|
+
<a id="rate-limit-rate-limiter-period-multiplier"></a>• [`period_multiplier`](#rate-limit-rate-limiter-period-multiplier) - Optional Number<br>Periods. This setting, combined with Per Period units, provides a duration
|
|
3550
|
+
|
|
3551
|
+
<a id="rate-limit-rate-limiter-token-bucket"></a>• [`token_bucket`](#rate-limit-rate-limiter-token-bucket) - Optional Block<br>Token Bucket Rate Limiter. Token-Bucket is a rate limiter algorithm that is stricter with enforcing limits
|
|
3552
|
+
|
|
3553
|
+
<a id="rate-limit-rate-limiter-total-number"></a>• [`total_number`](#rate-limit-rate-limiter-total-number) - Optional Number<br>Number Of Requests. The total number of allowed requests per rate-limiting period
|
|
3554
|
+
|
|
3555
|
+
<a id="rate-limit-rate-limiter-unit"></a>• [`unit`](#rate-limit-rate-limiter-unit) - Optional String Defaults to `SECOND`<br>Possible values are `SECOND`, `MINUTE`, `HOUR`<br>[Enum: SECOND|MINUTE|HOUR] 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
|
|
3556
|
+
|
|
3557
|
+
#### Rate Limit Rate Limiter Action Block
|
|
3558
|
+
|
|
3559
|
+
An [`action_block`](#rate-limit-rate-limiter-action-block) block (within [`rate_limit.rate_limiter`](#rate-limit-rate-limiter)) supports the following:
|
|
3560
|
+
|
|
3561
|
+
<a id="rate-limit-rate-limiter-action-block-hours"></a>• [`hours`](#rate-limit-rate-limiter-action-block-hours) - Optional Block<br>Hours. Input Duration Hours<br>See [Hours](#rate-limit-rate-limiter-action-block-hours) below.
|
|
3562
|
+
|
|
3563
|
+
<a id="rate-limit-rate-limiter-action-block-minutes"></a>• [`minutes`](#rate-limit-rate-limiter-action-block-minutes) - Optional Block<br>Minutes. Input Duration Minutes<br>See [Minutes](#rate-limit-rate-limiter-action-block-minutes) below.
|
|
3564
|
+
|
|
3565
|
+
<a id="rate-limit-rate-limiter-action-block-seconds"></a>• [`seconds`](#rate-limit-rate-limiter-action-block-seconds) - Optional Block<br>Seconds. Input Duration Seconds<br>See [Seconds](#rate-limit-rate-limiter-action-block-seconds) below.
|
|
3566
|
+
|
|
3567
|
+
#### Rate Limit Rate Limiter Action Block Hours
|
|
3568
|
+
|
|
3569
|
+
A [`hours`](#rate-limit-rate-limiter-action-block-hours) block (within [`rate_limit.rate_limiter.action_block`](#rate-limit-rate-limiter-action-block)) supports the following:
|
|
3570
|
+
|
|
3571
|
+
<a id="rate-limit-rate-limiter-action-block-hours-duration"></a>• [`duration`](#rate-limit-rate-limiter-action-block-hours-duration) - Optional Number<br>Duration
|
|
3572
|
+
|
|
3573
|
+
#### Rate Limit Rate Limiter Action Block Minutes
|
|
3574
|
+
|
|
3575
|
+
A [`minutes`](#rate-limit-rate-limiter-action-block-minutes) block (within [`rate_limit.rate_limiter.action_block`](#rate-limit-rate-limiter-action-block)) supports the following:
|
|
3576
|
+
|
|
3577
|
+
<a id="rate-limit-rate-limiter-action-block-minutes-duration"></a>• [`duration`](#rate-limit-rate-limiter-action-block-minutes-duration) - Optional Number<br>Duration
|
|
3578
|
+
|
|
3579
|
+
#### Rate Limit Rate Limiter Action Block Seconds
|
|
3580
|
+
|
|
3581
|
+
A [`seconds`](#rate-limit-rate-limiter-action-block-seconds) block (within [`rate_limit.rate_limiter.action_block`](#rate-limit-rate-limiter-action-block)) supports the following:
|
|
3582
|
+
|
|
3583
|
+
<a id="rate-limit-rate-limiter-action-block-seconds-duration"></a>• [`duration`](#rate-limit-rate-limiter-action-block-seconds-duration) - Optional Number<br>Duration
|
|
3584
|
+
|
|
3585
|
+
#### Sensitive Data Policy
|
|
3586
|
+
|
|
3587
|
+
A [`sensitive_data_policy`](#sensitive-data-policy) block supports the following:
|
|
3588
|
+
|
|
3589
|
+
<a id="sensitive-data-policy-sensitive-data-policy-ref"></a>• [`sensitive_data_policy_ref`](#sensitive-data-policy-sensitive-data-policy-ref) - 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 [Sensitive Data Policy Ref](#sensitive-data-policy-sensitive-data-policy-ref) below.
|
|
3590
|
+
|
|
3591
|
+
#### Sensitive Data Policy Sensitive Data Policy Ref
|
|
3592
|
+
|
|
3593
|
+
A [`sensitive_data_policy_ref`](#sensitive-data-policy-sensitive-data-policy-ref) block (within [`sensitive_data_policy`](#sensitive-data-policy)) supports the following:
|
|
3594
|
+
|
|
3595
|
+
<a id="sensitive-data-policy-sensitive-data-policy-ref-name"></a>• [`name`](#sensitive-data-policy-sensitive-data-policy-ref-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
|
|
3596
|
+
|
|
3597
|
+
<a id="sensitive-data-policy-sensitive-data-policy-ref-namespace"></a>• [`namespace`](#sensitive-data-policy-sensitive-data-policy-ref-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
|
|
3598
|
+
|
|
3599
|
+
<a id="sensitive-data-policy-sensitive-data-policy-ref-tenant"></a>• [`tenant`](#sensitive-data-policy-sensitive-data-policy-ref-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
|
|
3600
|
+
|
|
3601
|
+
#### Slow DDOS Mitigation
|
|
3602
|
+
|
|
3603
|
+
A [`slow_ddos_mitigation`](#slow-ddos-mitigation) block supports the following:
|
|
3604
|
+
|
|
3605
|
+
<a id="slow-ddos-mitigation-disable-request-timeout"></a>• [`disable_request_timeout`](#slow-ddos-mitigation-disable-request-timeout) - Optional Block<br>Enable this option
|
|
3606
|
+
|
|
3607
|
+
<a id="slow-ddos-mitigation-request-headers-timeout"></a>• [`request_headers_timeout`](#slow-ddos-mitigation-request-headers-timeout) - Optional Number Defaults to `10000`<br>Request Headers Timeout. The amount of time the client has to send only the headers on the request stream before the stream is cancelled. The milliseconds. This setting provides protection against Slowloris attacks
|
|
3608
|
+
|
|
3609
|
+
<a id="slow-ddos-mitigation-request-timeout"></a>• [`request_timeout`](#slow-ddos-mitigation-request-timeout) - Optional Number<br>Custom Timeout
|
|
3610
|
+
|
|
3611
|
+
#### Timeouts
|
|
3612
|
+
|
|
3613
|
+
A [`timeouts`](#timeouts) block supports the following:
|
|
3614
|
+
|
|
3615
|
+
<a id="timeouts-create"></a>• [`create`](#timeouts-create) - Optional String (Defaults to `10 minutes`)<br>Used when creating the resource
|
|
3616
|
+
|
|
3617
|
+
<a id="timeouts-delete"></a>• [`delete`](#timeouts-delete) - Optional String (Defaults to `10 minutes`)<br>Used when deleting the resource
|
|
3618
|
+
|
|
3619
|
+
<a id="timeouts-read"></a>• [`read`](#timeouts-read) - Optional String (Defaults to `5 minutes`)<br>Used when retrieving the resource
|
|
3620
|
+
|
|
3621
|
+
<a id="timeouts-update"></a>• [`update`](#timeouts-update) - Optional String (Defaults to `10 minutes`)<br>Used when updating the resource
|
|
3622
|
+
|
|
3623
|
+
#### Trusted Clients
|
|
3624
|
+
|
|
3625
|
+
A [`trusted_clients`](#trusted-clients) block supports the following:
|
|
3626
|
+
|
|
3627
|
+
<a id="trusted-clients-actions"></a>• [`actions`](#trusted-clients-actions) - Optional List Defaults to `SKIP_PROCESSING_WAF`<br>Possible values are `SKIP_PROCESSING_WAF`, `SKIP_PROCESSING_BOT`, `SKIP_PROCESSING_MUM`, `SKIP_PROCESSING_IP_REPUTATION`, `SKIP_PROCESSING_API_PROTECTION`, `SKIP_PROCESSING_OAS_VALIDATION`, `SKIP_PROCESSING_DDOS_PROTECTION`, `SKIP_PROCESSING_THREAT_MESH`, `SKIP_PROCESSING_MALWARE_PROTECTION`<br>[Enum: SKIP_PROCESSING_WAF|SKIP_PROCESSING_BOT|SKIP_PROCESSING_MUM|SKIP_PROCESSING_IP_REPUTATION|SKIP_PROCESSING_API_PROTECTION|SKIP_PROCESSING_OAS_VALIDATION|SKIP_PROCESSING_DDOS_PROTECTION|SKIP_PROCESSING_THREAT_MESH|SKIP_PROCESSING_MALWARE_PROTECTION] Actions. Actions that should be taken when client identifier matches the rule
|
|
3628
|
+
|
|
3629
|
+
<a id="trusted-clients-as-number"></a>• [`as_number`](#trusted-clients-as-number) - Optional Number<br>AS Number. RFC 6793 defined 4-byte AS number
|
|
3630
|
+
|
|
3631
|
+
<a id="trusted-clients-bot-skip-processing"></a>• [`bot_skip_processing`](#trusted-clients-bot-skip-processing) - Optional Block<br>Enable this option
|
|
3632
|
+
|
|
3633
|
+
<a id="trusted-clients-expiration-timestamp"></a>• [`expiration_timestamp`](#trusted-clients-expiration-timestamp) - Optional String<br>Expiration Timestamp. The expiration_timestamp is the RFC 3339 format timestamp at which the containing rule is considered to be logically expired. The rule continues to exist in the configuration but is not applied anymore
|
|
3634
|
+
|
|
3635
|
+
<a id="trusted-clients-http-header"></a>• [`http_header`](#trusted-clients-http-header) - Optional Block<br>HTTP Header. Request header name and value pairs<br>See [HTTP Header](#trusted-clients-http-header) below.
|
|
3636
|
+
|
|
3637
|
+
<a id="trusted-clients-ip-prefix"></a>• [`ip_prefix`](#trusted-clients-ip-prefix) - Optional String<br>IPv4 Prefix. IPv4 prefix string
|
|
3638
|
+
|
|
3639
|
+
<a id="trusted-clients-ipv6-prefix"></a>• [`ipv6_prefix`](#trusted-clients-ipv6-prefix) - Optional String<br>IPv6 Prefix. IPv6 prefix string
|
|
3640
|
+
|
|
3641
|
+
<a id="trusted-clients-metadata"></a>• [`metadata`](#trusted-clients-metadata) - 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](#trusted-clients-metadata) below.
|
|
3642
|
+
|
|
3643
|
+
<a id="trusted-clients-skip-processing"></a>• [`skip_processing`](#trusted-clients-skip-processing) - Optional Block<br>Enable this option
|
|
3644
|
+
|
|
3645
|
+
<a id="trusted-clients-user-identifier"></a>• [`user_identifier`](#trusted-clients-user-identifier) - Optional String<br>User Identifier. Identify user based on user identifier. User identifier value needs to be copied from security event
|
|
3646
|
+
|
|
3647
|
+
<a id="trusted-clients-waf-skip-processing"></a>• [`waf_skip_processing`](#trusted-clients-waf-skip-processing) - Optional Block<br>Enable this option
|
|
3648
|
+
|
|
3649
|
+
#### Trusted Clients HTTP Header
|
|
3650
|
+
|
|
3651
|
+
A [`http_header`](#trusted-clients-http-header) block (within [`trusted_clients`](#trusted-clients)) supports the following:
|
|
3652
|
+
|
|
3653
|
+
<a id="trusted-clients-http-header-headers"></a>• [`headers`](#trusted-clients-http-header-headers) - Optional Block<br>HTTP Headers. List of HTTP header name and value pairs<br>See [Headers](#trusted-clients-http-header-headers) below.
|
|
3654
|
+
|
|
3655
|
+
#### Trusted Clients HTTP Header Headers
|
|
3656
|
+
|
|
3657
|
+
A [`headers`](#trusted-clients-http-header-headers) block (within [`trusted_clients.http_header`](#trusted-clients-http-header)) supports the following:
|
|
3658
|
+
|
|
3659
|
+
<a id="trusted-clients-http-header-headers-exact"></a>• [`exact`](#trusted-clients-http-header-headers-exact) - Optional String<br>Exact. Header value to match exactly
|
|
3660
|
+
|
|
3661
|
+
<a id="trusted-clients-http-header-headers-invert-match"></a>• [`invert_match`](#trusted-clients-http-header-headers-invert-match) - Optional Bool<br>NOT of match. Invert the result of the match to detect missing header or non-matching value
|
|
3662
|
+
|
|
3663
|
+
<a id="trusted-clients-http-header-headers-name"></a>• [`name`](#trusted-clients-http-header-headers-name) - Optional String<br>Name. Name of the header
|
|
3664
|
+
|
|
3665
|
+
<a id="trusted-clients-http-header-headers-presence"></a>• [`presence`](#trusted-clients-http-header-headers-presence) - Optional Bool<br>Presence. If true, check for presence of header
|
|
3666
|
+
|
|
3667
|
+
<a id="trusted-clients-http-header-headers-regex"></a>• [`regex`](#trusted-clients-http-header-headers-regex) - Optional String<br>Regex. Regex match of the header value in re2 format
|
|
3668
|
+
|
|
3669
|
+
#### Trusted Clients Metadata
|
|
3670
|
+
|
|
3671
|
+
A [`metadata`](#trusted-clients-metadata) block (within [`trusted_clients`](#trusted-clients)) supports the following:
|
|
3672
|
+
|
|
3673
|
+
<a id="trusted-clients-metadata-description-spec"></a>• [`description_spec`](#trusted-clients-metadata-description-spec) - Optional String<br>Description. Human readable description
|
|
3674
|
+
|
|
3675
|
+
<a id="trusted-clients-metadata-name"></a>• [`name`](#trusted-clients-metadata-name) - Optional String<br>Name. This is the name of the message. The value of name has to follow DNS-1035 format
|
|
3676
|
+
|
|
3677
|
+
#### User Identification
|
|
3678
|
+
|
|
3679
|
+
An [`user_identification`](#user-identification) block supports the following:
|
|
3680
|
+
|
|
3681
|
+
<a id="user-identification-name"></a>• [`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>• [`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>• [`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
|
|
3686
|
+
|
|
3687
|
+
#### WAF Exclusion
|
|
3688
|
+
|
|
3689
|
+
A [`waf_exclusion`](#waf-exclusion) block supports the following:
|
|
3690
|
+
|
|
3691
|
+
<a id="waf-exclusion-waf-exclusion-inline-rules"></a>• [`waf_exclusion_inline_rules`](#waf-exclusion-waf-exclusion-inline-rules) - Optional Block<br>WAF Exclusion Inline Rules. A list of WAF exclusion rules that will be applied inline<br>See [WAF Exclusion Inline Rules](#waf-exclusion-waf-exclusion-inline-rules) below.
|
|
3692
|
+
|
|
3693
|
+
<a id="waf-exclusion-waf-exclusion-policy"></a>• [`waf_exclusion_policy`](#waf-exclusion-waf-exclusion-policy) - 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 [WAF Exclusion Policy](#waf-exclusion-waf-exclusion-policy) below.
|
|
3694
|
+
|
|
3695
|
+
#### WAF Exclusion WAF Exclusion Inline Rules
|
|
3696
|
+
|
|
3697
|
+
A [`waf_exclusion_inline_rules`](#waf-exclusion-waf-exclusion-inline-rules) block (within [`waf_exclusion`](#waf-exclusion)) supports the following:
|
|
3698
|
+
|
|
3699
|
+
<a id="waf-exclusion-waf-exclusion-inline-rules-rules"></a>• [`rules`](#waf-exclusion-waf-exclusion-inline-rules-rules) - Optional Block<br>WAF Exclusion Rules. An ordered list of WAF Exclusions specific to this Load Balancer<br>See [Rules](#waf-exclusion-waf-exclusion-inline-rules-rules) below.
|
|
3700
|
+
|
|
3701
|
+
#### WAF Exclusion WAF Exclusion Inline Rules Rules
|
|
3702
|
+
|
|
3703
|
+
A [`rules`](#waf-exclusion-waf-exclusion-inline-rules-rules) block (within [`waf_exclusion.waf_exclusion_inline_rules`](#waf-exclusion-waf-exclusion-inline-rules)) supports the following:
|
|
3704
|
+
|
|
3705
|
+
<a id="waf-exclusion-waf-exclusion-inline-rules-rules-any-domain"></a>• [`any_domain`](#waf-exclusion-waf-exclusion-inline-rules-rules-any-domain) - Optional Block<br>Enable this option
|
|
3706
|
+
|
|
3707
|
+
<a id="waf-exclusion-waf-exclusion-inline-rules-rules-any-path"></a>• [`any_path`](#waf-exclusion-waf-exclusion-inline-rules-rules-any-path) - Optional Block<br>Enable this option
|
|
3708
|
+
|
|
3709
|
+
<a id="waf-exclusion-waf-exclusion-inline-rules-rules-app-firewall-detection-control"></a>• [`app_firewall_detection_control`](#waf-exclusion-waf-exclusion-inline-rules-rules-app-firewall-detection-control) - Optional Block<br>App Firewall Detection Control. Define the list of Signature IDs, Violations, Attack Types and Bot Names that should be excluded from triggering on the defined match criteria<br>See [App Firewall Detection Control](#waf-exclusion-waf-exclusion-inline-rules-rules-app-firewall-detection-control) below.
|
|
3710
|
+
|
|
3711
|
+
<a id="waf-exclusion-waf-exclusion-inline-rules-rules-exact-value"></a>• [`exact_value`](#waf-exclusion-waf-exclusion-inline-rules-rules-exact-value) - Optional String<br>Exact Value. Exact domain name
|
|
3712
|
+
|
|
3713
|
+
<a id="waf-exclusion-waf-exclusion-inline-rules-rules-expiration-timestamp"></a>• [`expiration_timestamp`](#waf-exclusion-waf-exclusion-inline-rules-rules-expiration-timestamp) - Optional String<br>Expiration Timestamp. The expiration_timestamp is the RFC 3339 format timestamp at which the containing rule is considered to be logically expired. The rule continues to exist in the configuration but is not applied anymore
|
|
3714
|
+
|
|
3715
|
+
<a id="waf-exclusion-waf-exclusion-inline-rules-rules-metadata"></a>• [`metadata`](#waf-exclusion-waf-exclusion-inline-rules-rules-metadata) - 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](#waf-exclusion-waf-exclusion-inline-rules-rules-metadata) below.
|
|
3716
|
+
|
|
3717
|
+
<a id="waf-exclusion-waf-exclusion-inline-rules-rules-methods"></a>• [`methods`](#waf-exclusion-waf-exclusion-inline-rules-rules-methods) - 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
|
|
3718
|
+
|
|
3719
|
+
<a id="waf-exclusion-waf-exclusion-inline-rules-rules-path-prefix"></a>• [`path_prefix`](#waf-exclusion-waf-exclusion-inline-rules-rules-path-prefix) - Optional String<br>Prefix. Path prefix to match (e.g. the value / will match on all paths)
|
|
3720
|
+
|
|
3721
|
+
<a id="waf-exclusion-waf-exclusion-inline-rules-rules-path-regex"></a>• [`path_regex`](#waf-exclusion-waf-exclusion-inline-rules-rules-path-regex) - Optional String<br>Path Regex. Define the regex for the path. For example, the regex ^/.*$ will match on all paths
|
|
3722
|
+
|
|
3723
|
+
<a id="waf-exclusion-waf-exclusion-inline-rules-rules-suffix-value"></a>• [`suffix_value`](#waf-exclusion-waf-exclusion-inline-rules-rules-suffix-value) - Optional String<br>Suffix Value. Suffix of domain name e.g 'xyz.com' will match '*.xyz.com' and 'xyz.com'
|
|
3724
|
+
|
|
3725
|
+
<a id="waf-exclusion-waf-exclusion-inline-rules-rules-waf-skip-processing"></a>• [`waf_skip_processing`](#waf-exclusion-waf-exclusion-inline-rules-rules-waf-skip-processing) - Optional Block<br>Enable this option
|
|
3726
|
+
|
|
3727
|
+
#### WAF Exclusion WAF Exclusion Inline Rules Rules App Firewall Detection Control
|
|
3728
|
+
|
|
3729
|
+
An [`app_firewall_detection_control`](#waf-exclusion-waf-exclusion-inline-rules-rules-app-firewall-detection-control) block (within [`waf_exclusion.waf_exclusion_inline_rules.rules`](#waf-exclusion-waf-exclusion-inline-rules-rules)) supports the following:
|
|
3730
|
+
|
|
3731
|
+
<a id="waf-exclusion-waf-exclusion-inline-rules-rules-app-firewall-detection-control-exclude-attack-type-contexts"></a>• [`exclude_attack_type_contexts`](#waf-exclusion-waf-exclusion-inline-rules-rules-app-firewall-detection-control-exclude-attack-type-contexts) - Optional Block<br>Attack Types. Attack Types to be excluded for the defined match criteria<br>See [Exclude Attack Type Contexts](#waf-exclusion-waf-exclusion-inline-rules-rules-app-firewall-detection-control-exclude-attack-type-contexts) below.
|
|
3732
|
+
|
|
3733
|
+
<a id="waf-exclusion-waf-exclusion-inline-rules-rules-app-firewall-detection-control-exclude-bot-name-contexts"></a>• [`exclude_bot_name_contexts`](#waf-exclusion-waf-exclusion-inline-rules-rules-app-firewall-detection-control-exclude-bot-name-contexts) - Optional Block<br>Bot Names. Bot Names to be excluded for the defined match criteria<br>See [Exclude Bot Name Contexts](#waf-exclusion-waf-exclusion-inline-rules-rules-app-firewall-detection-control-exclude-bot-name-contexts) below.
|
|
3734
|
+
|
|
3735
|
+
<a id="waf-exclusion-waf-exclusion-inline-rules-rules-app-firewall-detection-control-exclude-signature-contexts"></a>• [`exclude_signature_contexts`](#waf-exclusion-waf-exclusion-inline-rules-rules-app-firewall-detection-control-exclude-signature-contexts) - Optional Block<br>Signature IDs. Signature IDs to be excluded for the defined match criteria<br>See [Exclude Signature Contexts](#waf-exclusion-waf-exclusion-inline-rules-rules-app-firewall-detection-control-exclude-signature-contexts) below.
|
|
3736
|
+
|
|
3737
|
+
<a id="waf-exclusion-waf-exclusion-inline-rules-rules-app-firewall-detection-control-exclude-violation-contexts"></a>• [`exclude_violation_contexts`](#waf-exclusion-waf-exclusion-inline-rules-rules-app-firewall-detection-control-exclude-violation-contexts) - Optional Block<br>Violations. Violations to be excluded for the defined match criteria<br>See [Exclude Violation Contexts](#waf-exclusion-waf-exclusion-inline-rules-rules-app-firewall-detection-control-exclude-violation-contexts) below.
|
|
3738
|
+
|
|
3739
|
+
#### WAF Exclusion WAF Exclusion Inline Rules Rules App Firewall Detection Control Exclude Attack Type Contexts
|
|
3740
|
+
|
|
3741
|
+
An [`exclude_attack_type_contexts`](#waf-exclusion-waf-exclusion-inline-rules-rules-app-firewall-detection-control-exclude-attack-type-contexts) block (within [`waf_exclusion.waf_exclusion_inline_rules.rules.app_firewall_detection_control`](#waf-exclusion-waf-exclusion-inline-rules-rules-app-firewall-detection-control)) supports the following:
|
|
3742
|
+
|
|
3743
|
+
<a id="waf-exclusion-waf-exclusion-inline-rules-rules-app-firewall-detection-control-exclude-attack-type-contexts-context"></a>• [`context`](#waf-exclusion-waf-exclusion-inline-rules-rules-app-firewall-detection-control-exclude-attack-type-contexts-context) - 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="waf-exclusion-waf-exclusion-inline-rules-rules-app-firewall-detection-control-exclude-attack-type-contexts-context-name"></a>• [`context_name`](#waf-exclusion-waf-exclusion-inline-rules-rules-app-firewall-detection-control-exclude-attack-type-contexts-context-name) - 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="waf-exclusion-waf-exclusion-inline-rules-rules-app-firewall-detection-control-exclude-attack-type-contexts-exclude-attack-type"></a>• [`exclude_attack_type`](#waf-exclusion-waf-exclusion-inline-rules-rules-app-firewall-detection-control-exclude-attack-type-contexts-exclude-attack-type) - 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
|
|
3748
|
+
|
|
3749
|
+
#### WAF Exclusion WAF Exclusion Inline Rules Rules App Firewall Detection Control Exclude Bot Name Contexts
|
|
3750
|
+
|
|
3751
|
+
An [`exclude_bot_name_contexts`](#waf-exclusion-waf-exclusion-inline-rules-rules-app-firewall-detection-control-exclude-bot-name-contexts) block (within [`waf_exclusion.waf_exclusion_inline_rules.rules.app_firewall_detection_control`](#waf-exclusion-waf-exclusion-inline-rules-rules-app-firewall-detection-control)) supports the following:
|
|
3752
|
+
|
|
3753
|
+
<a id="waf-exclusion-waf-exclusion-inline-rules-rules-app-firewall-detection-control-exclude-bot-name-contexts-bot-name"></a>• [`bot_name`](#waf-exclusion-waf-exclusion-inline-rules-rules-app-firewall-detection-control-exclude-bot-name-contexts-bot-name) - Optional String<br>Bot Name
|
|
3754
|
+
|
|
3755
|
+
#### WAF Exclusion WAF Exclusion Inline Rules Rules App Firewall Detection Control Exclude Signature Contexts
|
|
3756
|
+
|
|
3757
|
+
An [`exclude_signature_contexts`](#waf-exclusion-waf-exclusion-inline-rules-rules-app-firewall-detection-control-exclude-signature-contexts) block (within [`waf_exclusion.waf_exclusion_inline_rules.rules.app_firewall_detection_control`](#waf-exclusion-waf-exclusion-inline-rules-rules-app-firewall-detection-control)) supports the following:
|
|
3758
|
+
|
|
3759
|
+
<a id="waf-exclusion-waf-exclusion-inline-rules-rules-app-firewall-detection-control-exclude-signature-contexts-context"></a>• [`context`](#waf-exclusion-waf-exclusion-inline-rules-rules-app-firewall-detection-control-exclude-signature-contexts-context) - 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="waf-exclusion-waf-exclusion-inline-rules-rules-app-firewall-detection-control-exclude-signature-contexts-context-name"></a>• [`context_name`](#waf-exclusion-waf-exclusion-inline-rules-rules-app-firewall-detection-control-exclude-signature-contexts-context-name) - 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="waf-exclusion-waf-exclusion-inline-rules-rules-app-firewall-detection-control-exclude-signature-contexts-signature-id"></a>• [`signature_id`](#waf-exclusion-waf-exclusion-inline-rules-rules-app-firewall-detection-control-exclude-signature-contexts-signature-id) - 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
|
|
3764
|
+
|
|
3765
|
+
#### WAF Exclusion WAF Exclusion Inline Rules Rules App Firewall Detection Control Exclude Violation Contexts
|
|
3766
|
+
|
|
3767
|
+
An [`exclude_violation_contexts`](#waf-exclusion-waf-exclusion-inline-rules-rules-app-firewall-detection-control-exclude-violation-contexts) block (within [`waf_exclusion.waf_exclusion_inline_rules.rules.app_firewall_detection_control`](#waf-exclusion-waf-exclusion-inline-rules-rules-app-firewall-detection-control)) supports the following:
|
|
3768
|
+
|
|
3769
|
+
<a id="waf-exclusion-waf-exclusion-inline-rules-rules-app-firewall-detection-control-exclude-violation-contexts-context"></a>• [`context`](#waf-exclusion-waf-exclusion-inline-rules-rules-app-firewall-detection-control-exclude-violation-contexts-context) - 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="waf-exclusion-waf-exclusion-inline-rules-rules-app-firewall-detection-control-exclude-violation-contexts-context-name"></a>• [`context_name`](#waf-exclusion-waf-exclusion-inline-rules-rules-app-firewall-detection-control-exclude-violation-contexts-context-name) - 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="waf-exclusion-waf-exclusion-inline-rules-rules-app-firewall-detection-control-exclude-violation-contexts-exclude-violation"></a>• [`exclude_violation`](#waf-exclusion-waf-exclusion-inline-rules-rules-app-firewall-detection-control-exclude-violation-contexts-exclude-violation) - 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
|
|
3774
|
+
|
|
3775
|
+
#### WAF Exclusion WAF Exclusion Inline Rules Rules Metadata
|
|
3776
|
+
|
|
3777
|
+
A [`metadata`](#waf-exclusion-waf-exclusion-inline-rules-rules-metadata) block (within [`waf_exclusion.waf_exclusion_inline_rules.rules`](#waf-exclusion-waf-exclusion-inline-rules-rules)) supports the following:
|
|
3778
|
+
|
|
3779
|
+
<a id="waf-exclusion-waf-exclusion-inline-rules-rules-metadata-description-spec"></a>• [`description_spec`](#waf-exclusion-waf-exclusion-inline-rules-rules-metadata-description-spec) - Optional String<br>Description. Human readable description
|
|
3780
|
+
|
|
3781
|
+
<a id="waf-exclusion-waf-exclusion-inline-rules-rules-metadata-name"></a>• [`name`](#waf-exclusion-waf-exclusion-inline-rules-rules-metadata-name) - Optional String<br>Name. This is the name of the message. The value of name has to follow DNS-1035 format
|
|
3782
|
+
|
|
3783
|
+
#### WAF Exclusion WAF Exclusion Policy
|
|
3784
|
+
|
|
3785
|
+
A [`waf_exclusion_policy`](#waf-exclusion-waf-exclusion-policy) block (within [`waf_exclusion`](#waf-exclusion)) supports the following:
|
|
3786
|
+
|
|
3787
|
+
<a id="waf-exclusion-waf-exclusion-policy-name"></a>• [`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="waf-exclusion-waf-exclusion-policy-namespace"></a>• [`namespace`](#waf-exclusion-waf-exclusion-policy-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
|
|
3790
|
+
|
|
3791
|
+
<a id="waf-exclusion-waf-exclusion-policy-tenant"></a>• [`tenant`](#waf-exclusion-waf-exclusion-policy-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
|
|
3792
|
+
|
|
3793
|
+
## Import
|
|
3794
|
+
|
|
3795
|
+
Import is supported using the following syntax:
|
|
3796
|
+
|
|
3797
|
+
```shell
|
|
3798
|
+
# Import using namespace/name format
|
|
3799
|
+
terraform import f5xc_cdn_loadbalancer.example system/example
|
|
3800
|
+
```
|