Reference
Plugins and resource kinds, generated from the product itself.
Plugins114
- HTTP plugins109 plugins
- Stream plugins5 plugins
Resource kinds16
- CertificateCertificates let the engine terminate TLS for the names they cover.
- ConsumerConsumers identify the callers of your APIs; their credentials live under each consumer.
- Consumer groupConsumer groups hold plugins that several consumers share.
- Cost decorationA cost decoration weights one field or type of the GraphQL schema this service fronts.
- CredentialCredentials carry the keys and passwords a consumer signs in with.
- Environment-wide settingsEnvironment-wide settings are shared by every use of a plugin in the environment and are edited on the plugin's page.
- Global ruleGlobal rules run their plugins on every request the engine handles.
- Plugin configPlugin configs hold a set of plugins that several routes reference.
- ProtoProtos hold the protobuf definitions the gRPC transcoding plugin reads.
- RouteRoutes match incoming requests and send them to an upstream.
- Secret (AWS)Secrets tell the engine where a secret manager keeps the values plugins reference.
- Secret (GCP)Secrets tell the engine where a secret manager keeps the values plugins reference.
- Secret (Vault)Secrets tell the engine where a secret manager keeps the values plugins reference.
- ServiceServices hold the upstream and plugins that several routes share.
- Stream routeStream routes forward raw TCP and UDP connections to an upstream.
- UpstreamUpstreams are the backends that routes and services send traffic to.
Shared pages2
- Plugin execution settingsThe five settings every plugin carries: Enabled, Priority, Filter, Error response and Pre-function.
- Conditions on request variablesHow a condition on a request variable is written, in a plugin Filter and in a route.
G8 dev · Apache APISIX® 3.19.0
Apache, Apache APISIX and APISIX are trademarks of The Apache Software Foundation.