Request Validation Configuration
The request-validation plugin checks requests for compliance before forwarding them to upstream services, enhancing security in API operations. Configuration covers static settings and plugin parameters.
Static Configurations
The apisix.max_request_headers_readable setting controls how many request headers are available when request-validation evaluates header_schema. It is available in APISIX 3.20.0 and API7 Enterprise 3.10.10; earlier versions use a fixed limit of 100 headers.
The configuration source depends on how the gateway is deployed:
- Host or Docker
- API7 Gateway Helm
Set the limit in the persistent gateway configuration:
apisix:
max_request_headers_readable: 200 # Default: 100; 0 reads all request headers.
Reload or restart every gateway instance after updating config.yaml.
With API7 Gateway Helm chart 3.10.19 or later, set the corresponding chart value:
apisix:
maxRequestHeadersReadable: 200 # Default: 100; 0 reads all request headers.
Apply the values file through the gateway release's normal Helm upgrade workflow.
The setting only changes the header table visible to plugins. It does not change NGINX parsing limits; headers beyond the plugin-visible limit can still reach the upstream.
Parameters
See plugin common configurations for configuration options available to all plugins.
header_schema
Schema for request header.
At least one of
header_schemaandbody_schemashould be configured.body_schema
Schema for request body.
At least one of
header_schemaandbody_schemashould be configured.rejected_code
valid value:
between 200 and 599 inclusiveStatus code to return when rejecting requests.
rejected_msg
Message to return when rejecting requests.
max_req_body_size
valid value:
greater than or equal to 1Maximum request body size in bytes read when
body_schemais configured. A larger body is rejected withrejected_code, which defaults to400. This field has no effect when onlyheader_schemais configured. Introduced in API7 Enterprise 3.9.17 and 3.10.4, and APISIX 3.18.0.