ext-plugin-pre-req.md

title	keywords	description
ext-plugin-pre-req	APISIX Plugin ext-plugin-pre-req	This document contains information about the Apache APISIX ext-plugin-pre-req Plugin.

Description

The ext-plugin-pre-req Plugin is for running specific external Plugins in the Plugin Runner before executing the built-in Lua Plugins.

See External Plugin to learn more.

:::note

Execution of External Plugins will affect the behavior of the current request.

:::

Attributes

Name	Type	Required	Default	Valid values	Description
conf	array	False		[{"name": "ext-plugin-A", "value": "{"enable":"feature"}"}]	List of Plugins and their configurations to be executed on the Plugin Runner.
allow_degradation	boolean	False	false		Sets Plugin degradation when the Plugin Runner is not available. When set to true, requests are allowed to continue.

Enabling the Plugin

The example below enables the ext-plugin-pre-req Plugin on a specific Route:

curl -i http://127.0.0.1:9180/apisix/admin/routes/1  -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
{
    "uri": "/index.html",
    "plugins": {
        "ext-plugin-pre-req": {
            "conf" : [
                {"name": "ext-plugin-A", "value": "{\"enable\":\"feature\"}"}
            ]
        }
    },
    "upstream": {
        "type": "roundrobin",
        "nodes": {
            "127.0.0.1:1980": 1
        }
    }
}'

Example usage

Once you have configured the External Plugin as shown above, you can make a request to execute the Plugin:

curl -i http://127.0.0.1:9080/index.html

This will reach the configured Plugin Runner and the ext-plugin-A will be executed.

Disable Plugin

To disable the ext-plugin-pre-req Plugin, you can delete the corresponding JSON configuration from the Plugin configuration. APISIX will automatically reload and you do not have to restart for this to take effect.

curl http://127.0.0.1:9180/apisix/admin/routes/1  -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
{
    "uri": "/index.html",
    "upstream": {
        "type": "roundrobin",
        "nodes": {
            "127.0.0.1:1980": 1
        }
    }
}'