← Back to index

opnsense_nginx_location (Data Source)

Read an OPNsense Nginx location.

Schema

Required

  • id (String) UUID of the location.

Read-Only

  • advanced_acl (Boolean) Whether the advanced ACL definition is enabled.
  • auth_basic (Boolean) Whether HTTP basic authentication is required.
  • auth_basic_user_file (String) Identifier of the user file used for HTTP basic auth.
  • auto_index (Boolean) Whether directory listing is enabled.
  • body_buffer_size (String) Buffer size used for request bodies.
  • cache_background_update (Boolean) Whether cache background updates are enabled.
  • cache_lock (Boolean) Whether cache lock is enabled.
  • cache_methods (String) Request methods that should be cached.
  • cache_min_uses (Number) Minimum number of uses before caching is enabled.
  • cache_path (String) Cache path identifier.
  • cache_revalidate (Boolean) Whether cache revalidation is enabled.
  • cache_use_stale (String) Conditions under which a stale cache may be served.
  • cache_valid (String) Cache validity configuration.
  • custom_policy (Set of String) Custom WAF policy identifiers applied to the location.
  • description (String) Human readable description for the location.
  • enable_learning_mode (Boolean) Whether learning mode is enabled for waf rules.
  • enable_sec_rules (Boolean) Whether the web application firewall is enabled.
  • error_pages (Set of String) Custom error pages for the location.
  • force_https (Boolean) Whether HTTPS redirects are forced.
  • honeypot (Boolean) Whether honeypot mode is enabled.
  • index (Set of String) Index files served for directory requests.
  • ip_acl (String) Identifier of the IP ACL applied.
  • limit_request_connections (Set of String) Limit request connection identifiers applied.
  • match_type (String) Match strategy for the URL pattern.
  • max_body_size (String) Maximum accepted body size for requests.
  • path_prefix (String) Optional path prefix when matching upstream requests.
  • php_enable (Boolean) Whether PHP handling is enabled.
  • php_override_script_name (String) Override script name passed to PHP.
  • proxy_buffer_size (String) Proxy buffer size.
  • proxy_buffering (Boolean) Whether proxy buffering is enabled.
  • proxy_buffers_count (String) Number of proxy buffers.
  • proxy_buffers_size (String) Size of each proxy buffer.
  • proxy_busy_buffers_size (String) Size of busy proxy buffers.
  • proxy_ignore_client_abort (Boolean) Whether client aborts are ignored.
  • proxy_max_temp_file_size (String) Maximum size of proxy temporary files.
  • proxy_read_timeout (String) Proxy read timeout.
  • proxy_request_buffering (Boolean) Whether proxy request buffering is enabled.
  • proxy_send_timeout (String) Proxy send timeout.
  • proxy_ssl_server_name (Boolean) Whether proxy SSL server name is enabled.
  • rewrites (Set of String) Rewrite rules applied within the location.
  • root (String) Root directory for the location.
  • satisfy (String) Satisfy directive for access control.
  • sec_rules_error_page (String) Error page used when a WAF rule blocks a request.
  • sqli_block_score (Number) Threshold score that triggers SQLi blocking.
  • upstream (String) UUID of the upstream servicing this location.
  • upstream_keepalive (Boolean) Whether upstream keepalive connections are enabled.
  • url_pattern (String) URL pattern that the location matches.
  • websocket (Boolean) Whether websocket support is enabled.
  • xss_block_score (Number) Threshold score that triggers XSS blocking.