Project: APISIX (Orchestration & Management / API Gateway)
File: plugin.md

title: Plugin keywords: API Gateway Apache APISIX Plugin Filter Priority description: This article introduces the related information of the APISIX Plugin object and how to use it, and introduces how to customize the plugin priority, customize the error response, and dynamically control the execution status of the plugin. <!-- --> APISIX Plugins extend APISIX's functionalities to meet organization or user-specific requirements in traffic management, observability, security, request/response transformation, serverless computing, and more. A Plugin configuration can be bound directly to a , , or . You can refer to for how to use this resource. If existing APISIX Plugins do not meet your needs, you can also write your own plugins in Lua or other languages such as Java, Python, Go, and Wasm. APISIX comes with a default configuration file called `config-default.yaml` and a user-defined configuration file called `config.yaml`. These files are located in the `conf` directory. If the same key (e.g. `plugins`) exists in both files, the configuration values for the key in `config.yaml` will overwrite those in `config-default.yaml`. The `plugins` block is where you can declare the Plugins loaded to your APISIX instance: ```yaml plugins: real-ip # loaded ai client-control proxy-control request-id zipkin ... ``` An installed plugin is first initialized. The configuration of the plugin is then checked against the defined to make sure the plugins configuration schema is correct. When a request goes through APISIX, the plugin's corresponding methods are executed in one or more of the following phases : `rewrite`, `access`, `beforeproxy`, `headerfilter`, `body_filter`, and `log`. These phases are largely influenced by the . <br /> <div style={{textAlign: 'center'}}> <img src="https://static.apiseven.com/uploads/2023/03/09/ZsH5C8Og_plugins-phases.png" alt="Routes Diagram" width="50%"/> </div> <br /> In general, plugins are executed in the following order: Plugins in plugins in rewrite phase plugins in access phase Plugins bound to other objects plugins in rewrite phase plugins in access phase Within each phase, you can optionally define a new priority number in the `_meta.priority` field of the plugin, which takes precedence over the default plugins priority during execution. Plugins with higher priority numbers are executed first. For example, if you want to have `limit-count` (priority 1002) run before `ip-restriction` (priority 3000) when requests hit a route, you can do so by passing a higher priority number to `_meta.priority` field of `limit-count`: ```json { ..., "plugins": { "limit-count": { ..., "_meta": { "priority": 3010 } } } } ``` To reset the priority of this plugin instance to the default, simply remove the `_meta.priority` field from your plugin configuration. When the same plugin is configured both globally in a global rule and locally in an object (e.g. a route), both plugin instances are executed

However, if the same plugin is configured locally on multiple objects, such as on , , , , or , only one copy of configuration is used as each non-global plugin is only executed once. This is because during execution, plugins configured in these objects are merged with respect to a specific order of precedence: `Consumer` > `Consumer Group` > `Route` > `Plugin Config` > `Service` such that if the same plugin has different configurations in different objects, the plugin configuration with the highest order of precedence during merging will be used. Some common configurations can be applied to plugins through the `_meta` configuration items, the specific configuration items are as follows: | Name | Type | Description | |-| |-| | disable | boolean | When set to `true`, the plugin is disabled. | | error_response | string/object | Custom error response. | | priority | integer | Custom plugin priority. | | filter | array | Depending on the requested parameters, it is decided at runtime whether the plugin should be executed. Something like this: `{{var, operator, val}, {var, operator, val}, ...}}`. For example: `{"arg_version", "==", "v2"}`, indicating that the current request parameter `version` is `v2`. The variables here are consistent with NGINX internal variables. For details on supported operators, please see . | Through the `disable` configuration, you can add a new plugin with disabled status and the request will not go through the plugin. ```json { "proxy-rewrite": { "_meta": { "disable": true } } } ``` Through the `error_response` configuration, you can configure the error response of any plugin to a fixed value to avoid troubles caused by the built-in error response information of the plugin. The configuration below means to customize the error response of the `jwt-auth` plugin to `Missing credential in request`. ```json { "jwt-auth": { "_meta": { "error_response": { "message": "Missing credential in request" } } } } ``` All plugins have default priorities, but through the `priority` configuration item you can customize the plugin priority and change the plugin execution order. ```json { "serverless-post-function": { "_meta": { "priority": 10000 }, "phase": "rewrite", "functions" : ["return function(conf, ctx) ngx.say(\"serverless-post-function\"); end"] }, "serverless-pre-function": { "_meta": { "priority": -2000 }, "phase": "rewrite", "functions": ["return function(conf, ctx) ngx.say(\"serverless-pre-function\"); end"] } } ``` The default priority of serverless-pre-function is 10000, and the default priority of serverless-post-function is -2000. By default, the serverless-pre-function plugin will be executed first, and serverless-post-function plugin will be executed next. The above configuration means setting the priority of the serverless-pre-function plugin to -2000 and the priority of the serverless-post-function plugin to 10000. The serverless-post-function plugin will be executed first, and serverless-pre-function plugin will be executed next. :::note Custom plugin priority only affects the current object(route, service

of the plugin instance binding, not all instances of that plugin. For example, if the above plugin configuration belongs to Route A, the order of execution of the plugins serverless-post-function and serverless-post-function on Route B will not be affected and the default priority will be used. Custom plugin priority does not apply to the rewrite phase of some plugins configured on the consumer. The rewrite phase of plugins configured on the route will be executed first, and then the rewrite phase of plugins (exclude auth plugins) from the consumer will be executed. ::: By default, all plugins specified in the route will be executed. But we can add a filter to the plugin through the `filter` configuration item, and control whether the plugin is executed through the execution result of the filter. The configuration below means that the `proxy-rewrite` plugin will only be executed if the `version` value in the request query parameters is `v2`. ```json { "proxy-rewrite": { "_meta": { "filter": [ ["arg_version", "==", "v2"] ] }, "uri": "/anything" } } ``` Create a complete route with the below configuration: ```json { "uri": "/get", "plugins": { "proxy-rewrite": { "_meta": { "filter": [ ["arg_version", "==", "v2"] ] }, "uri": "/anything" } }, "upstream": { "type": "roundrobin", "nodes": { "httpbin.org:80": 1 } } } ``` When the request does not have any parameters, the `proxy-rewrite` plugin will not be executed, the request will be proxy to the upstream `/get`: ```shell curl -v /dev/null http://127.0.0.1:9080/get -H"host:httpbin.org" ``` ```shell < HTTP/1.1 200 OK ...... < Server: APISIX/2.15.0 < { "args": {}, "headers": { "Accept": "/", "Host": "httpbin.org", "User-Agent": "curl/7.79.1", "X-Amzn-Trace-Id": "Root=1-62eb6eec-46c97e8a5d95141e621e07fe", "X-Forwarded-Host": "httpbin.org" }, "origin": "127.0.0.1, 117.152.66.200", "url": "http://httpbin.org/get" } ``` When the parameter `version=v2` is carried in the request, the `proxy-rewrite` plugin is executed, and the request will be proxy to the upstream `/anything`: ```shell curl -v /dev/null http://127.0.0.1:9080/get?version=v2 -H"host:httpbin.org" ``` ```shell < HTTP/1.1 200 OK ...... < Server: APISIX/2.15.0 < { "args": { "version": "v2" }, "data": "", "files": {}, "form": {}, "headers": { "Accept": "/", "Host": "httpbin.org", "User-Agent": "curl/7.79.1", "X-Amzn-Trace-Id": "Root=1-62eb6f02-24a613b57b6587a076ef18b4", "X-Forwarded-Host": "httpbin.org" }, "json": null, "method": "GET", "origin": "127.0.0.1, 117.152.66.200", "url": "http://httpbin.org/anything?version=v2" } ``` APISIX Plugins are hot-loaded. This means that there is no need to restart the service if you add, delete, modify plugins, or even if you update the plugin code. To hot-reload, you can send an HTTP request through the : :::note You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command: ```bash adminkey=$(yq '.deployment.admin.adminkey[0].key' conf/config.yaml | sed 's/"//g') ``` ::: ```shell curl http://127.0.0.1:9180/apisix/admin/plugins/reload -H "X-API-KEY: $admin_key" -X PUT ``` :::note If a configured Plugin is disabled, then its execution will be skipped. ::: For hot-reloading in standalone mode, see the plugin related section in .