UA Restriction Configuration
Configuration reference for the UA Restriction plugin (`ua-restriction`): the parameters, each attribute with its type, whether it is required, its default and its accepted values.
Parameters
See plugin common configurations (opens in Apache APISIX docs) for configuration options available to all plugins.
bypass_missing — boolean · optional · default: false · since APISIX 2.8 · API7 Gateway 3.2.9.5
If true, bypass the user agent restriction check when the User-Agent header is missing.
allowlist — array[string] · optional · since APISIX 2.8 · API7 Gateway 3.2.9.5
List of user agents to allow. Support regular expressions.
At least one of the allowlist and denylist should be configured, but they cannot be configured at the same time.
denylist — array[string] · optional · since APISIX 2.8 · API7 Gateway 3.2.9.5
List of user agents to deny. Support regular expressions.
At least one of the allowlist and denylist should be configured, but they cannot be configured at the same time.
message — string · optional · default: Not allowed · since APISIX 2.8 · API7 Gateway 3.2.9.5
Message returned when the user agent is denied access.