Parameters
See plugin common configurations for configuration options available to all plugins.
Credentials
The following are plugin attributes available for configurations on credentials.
key
string
required
A unique key that identifies the credential for a consumer. The key is encrypted with AES before being stored in etcd. You can also store it in an environment variable and reference it using the
env://prefix, or in a secret manager such as HashiCorp Vault's KV secrets engine, and reference it using thesecret://prefix. For more information, see secrets.
Routes or Services
The following are plugin attributes available for configurations on routes or services.
header
string
default:
apikeyThe header to get the key from.
query
string
default:
apikeyThe query string to get the key from. Lower priority than header.
hide_credentials
boolean
default:
falseIf true, do not pass the header or query string with key to upstream services.
anonymous_consumer
string
Anonymous consumer name. If configured, allow anonymous users to bypass the authentication. See Rate Limit with Anonymous Consumer for more details.