Skip to main content

AdvancedSettings Schema

Data structure for Advanced Settings objects.

Fields​

FieldTypeRequiredDescriptionNotes
auth_bypass_appsstringCollectionNo-API field: auth_bypass_apps
auth_bypass_url_categoriesstringCollectionNo-API field: auth_bypass_url_categories
auth_bypass_urlsstringCollectionNo-API field: auth_bypass_urls
basic_bypass_appsstringCollectionNo-API field: basic_bypass_apps
basic_bypass_url_categoriesstringCollectionNo-API field: basic_bypass_url_categories
best_effort_policybooleanNo-API field: best_effort_policy
block_connect_host_sni_mismatchbooleanNo-API field: block_connect_host_sni_mismatch
block_domain_fronting_appsstringCollectionNo-API field: block_domain_fronting_apps
block_domain_fronting_on_host_headerbooleanNo-API field: block_domain_fronting_on_host_header
block_http_tunnel_on_non_http_portsbooleanNo-API field: block_http_tunnel_on_non_http_ports
block_non_compliant_http_request_on_http_portsbooleanNo-API field: block_non_compliant_http_request_on_http_ports
block_non_http_on_http_port_enabledbooleanNo-API field: block_non_http_on_http_port_enabled
cascade_url_filteringbooleanNo-API field: cascade_url_filtering
comp_default_location_usedbooleanNo-API field: comp_default_location_used
digest_auth_bypass_appsstringCollectionNo-API field: digest_auth_bypass_apps
digest_auth_bypass_url_categoriesstringCollectionNo-API field: digest_auth_bypass_url_categories
digest_auth_bypass_urlsstringCollectionNo-API field: digest_auth_bypass_urls
dns_resolution_on_transparent_proxy_appsstringCollectionNo-API field: dns_resolution_on_transparent_proxy_apps
dns_resolution_on_transparent_proxy_exempt_appsstringCollectionNo-API field: dns_resolution_on_transparent_proxy_exempt_apps
dns_resolution_on_transparent_proxy_exempt_url_categoriesstringCollectionNo-API field: dns_resolution_on_transparent_proxy_exempt_url_categories
dns_resolution_on_transparent_proxy_exempt_urlsstringCollectionNo-API field: dns_resolution_on_transparent_proxy_exempt_urls
dns_resolution_on_transparent_proxy_IPv6_appsstringCollectionNo-API field: dns_resolution_on_transparent_proxy_IPv6_apps
dns_resolution_on_transparent_proxy_IPv6_exempt_appsstringCollectionNo-API field: dns_resolution_on_transparent_proxy_IPv6_exempt_apps
dns_resolution_on_transparent_proxy_IPv6_exempt_url_categoriesstringCollectionNo-API field: dns_resolution_on_transparent_proxy_IPv6_exempt_url_categories
dns_resolution_on_transparent_proxy_IPv6_url_categoriesstringCollectionNo-API field: dns_resolution_on_transparent_proxy_IPv6_url_categories
dns_resolution_on_transparent_proxy_url_categoriesstringCollectionNo-API field: dns_resolution_on_transparent_proxy_url_categories
dns_resolution_on_transparent_proxy_urlsstringCollectionNo-API field: dns_resolution_on_transparent_proxy_urls
domain_fronting_bypass_url_categoriesstringCollectionNo-API field: domain_fronting_bypass_url_categories
dynamic_user_risk_enabledbooleanNo-API field: dynamic_user_risk_enabled
ecs_for_all_enabledbooleanNo-API field: ecs_for_all_enabled
ecs_objectEntityReferenceNo-API field: ecs_object
enable_admin_rank_accessbooleanYes-API field: enable_admin_rank_access
enable_dns_resolution_on_transparent_proxybooleanNo-API field: enable_dns_resolution_on_transparent_proxy
enable_evaluate_policy_on_global_SSL_bypassbooleanNo-API field: enable_evaluate_policy_on_global_SSL_bypass
enable_IPv6_dns_optimization_on_all_transparent_proxybooleanNo-API field: enable_IPv6_dns_optimization_on_all_transparent_proxy
enable_IPv6_dns_resolution_on_transparent_proxybooleanNo-API field: enable_IPv6_dns_resolution_on_transparent_proxy
enable_office365booleanNo-API field: enable_office365
enable_policy_for_unauthenticated_trafficbooleanNo-API field: enable_policy_for_unauthenticated_traffic
enforce_surrogate_ip_for_windows_appbooleanNo-API field: enforce_surrogate_ip_for_windows_app
fail_closebooleanNo-API field: fail_close
http2_nonbrowser_traffic_enabledbooleanNo-API field: http2_nonbrowser_traffic_enabled
http_range_header_remove_url_categoriesstringCollectionNo-API field: http_range_header_remove_url_categories
jwt_auth_bypass_appsstringCollectionNo-API field: jwt_auth_bypass_apps
jwt_auth_bypass_url_categoriesstringCollectionNo-API field: jwt_auth_bypass_url_categories
kerberos_bypass_appsstringCollectionNo-API field: kerberos_bypass_apps
kerberos_bypass_url_categoriesstringCollectionNo-API field: kerberos_bypass_url_categories
kerberos_bypass_urlsstringCollectionNo-API field: kerberos_bypass_urls
log_internal_ipbooleanNo-API field: log_internal_ip
prefer_sni_over_conn_hostbooleanNo-API field: prefer_sni_over_conn_host
prefer_sni_over_conn_host_appsstringCollectionNo-API field: prefer_sni_over_conn_host_apps
sipa_xff_header_enabledbooleanNo-API field: sipa_xff_header_enabled
sni_dns_optimization_bypass_url_categoriesstringCollectionNo-API field: sni_dns_optimization_bypass_url_categories
track_http_tunnel_on_http_portsbooleanNo-API field: track_http_tunnel_on_http_ports
ui_session_timeoutintegerYes-API field: ui_session_timeout
zscaler_client_connector1_and_pac_road_warrior_in_firewallbooleanNo-API field: zscaler_client_connector1_and_pac_road_warrior_in_firewall

Example​

{
"auth_bypass_apps": [
"value"
],
"auth_bypass_url_categories": [
"value"
],
"auth_bypass_urls": [
"value"
],
"basic_bypass_apps": [
"value"
],
"basic_bypass_url_categories": [
"value"
],
"best_effort_policy": true,
"block_connect_host_sni_mismatch": true,
"block_domain_fronting_apps": [
"value"
]
}
// ... more fields