UA Restriction | APISIX & API7 API Gateway Docs

Parameters

See plugin common configurations for configuration options available to all plugins.

bypass_missing
boolean
default: false
If true, bypass the user agent restriction check when the User-Agent header is missing.
allowlist
array[string]
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]
List of user agents to deny. Support regular expressions.
In API7 Enterprise 3.9.19 and 3.10.7, and in APISIX 3.19.0, the plugin evaluates repeated User-Agent headers independently. A request is rejected with HTTP 403 if any value matches the denylist; an allowed value does not override a denied one.
At least one of the allowlist and denylist should be configured, but they cannot be configured at the same time.
message
string
default: Not allowed
Message returned when the user agent is denied access.