DocsICP FilingConsole
Documentation
Home Page API Gateway AI Gateway User Guide Plug-in marketplace Manage plugins

Manage plugins

Updated at:
Copy as MD
Product
My Favorites

AI Gateway provides a plugin marketplace with built-in plugins for authentication, traffic control, and security protection. You can also upload custom plugins to extend gateway capabilities.

Plugin types

The AI Gateway Plug-in includes three plugin types based on their source:

  • Official plugins: Released by Higress to the Plug-in.

  • Community plugins: Contributed by the Higress community to the Plug-in.

  • Custom plugins: Uploaded by you to the plugin marketplace for private use.

Install and enable plugins

You can add plugins from the AI Gateway Plug-in to a gateway instance. To activate a plugin, install it, configure its rules, and enable it.

Plugin rules have three scope levels:

  • MCP/Route Level Plugin Rules: Apply to an Ingress and take effect when a request matches that Ingress.

  • Domain-level plug-in rules: Apply to a domain name. Specific domain rules take priority over wildcard domain rules.

  • Instance-level plug-in rules: Apply globally to the gateway when no routing-level or domain-level rules match.

Two installation methods are available:

Note

  • Only dedicated AI Gateway instances support installing and enabling plugins. Serverless instances do not support this feature.

Method 1: Install from the plugin marketplace

  1. Log on to the AI Gateway console.

  2. In the navigation pane on the left, choose Plug-in. In the top menu bar, select a region.

  3. On the Plug-in page, use the Quick Navigation pane to select a plugin type or search by name. Click Install on the plugin card. In the Install Plug-in dialog box, select the target gateway instance and click OK.

  4. In the Configuration section, find the target gateway instance. In the Actions column, click Rule Configuration and select an Effective Scope.

    • If you select Route-level plug-in rules or Domain-level plug-in rules, click Add Rule. On the Add MCP/Routing Level Rule or Add Domain Level Rule page, ensure that Status is turned on (enabled by default). Select a Target, configure the Plug-in Rules, and click OK.

    • If you select Instance-level plug-in rules, ensure that Status is turned on, configure the Plug-in Rules, and click Save.

Method 2: Install from the gateway instance page

  1. Log on to the AI Gateway console.

  2. In the navigation pane on the left, choose Instance. In the top menu bar, select a region.

  3. On the Instance page, click the target instance ID.

  4. In the navigation pane on the left, choose Plug-in. In the top menu bar, select a region.

  5. Click Install Plug-in. On the Install Plugins page, use the Quick Navigation pane to select a plugin type or search by name. Click the plugin card. In the dialog box, click Install and Configure.

  6. In the Rule Configuration dialog box, configure the rules for the plugin, select an effective scope, and then click OK.

  7. (Optional) On the gateway instance page, choose Plug-in in the left navigation pane. In the plugin list, find the plugin and click Rule Configuration in the Actions column. You can then configure the rules and select an effective scope.

    • If you select MCP/Route Level Plugin Rules or Domain-level plug-in rules, click Add Rule. On the Add MCP/Routing Level Rule or Add Domain Level Rule page, ensure that Status is turned on (enabled by default). Select a Target, configure the Plug-in Rules, and click OK.

    • If you select Instance-level plug-in rules, ensure that Status is turned on, configure the Plug-in Rules, and click Save.

Uninstall plugins

Overview

Uninstalling removes a plugin completely from a gateway. Two methods are available:

Important

Before uninstalling a plugin, disable it if it has any enabled rules. If the plugin is not enabled, uninstalling it deletes all its configured rules.

Method 1: Uninstall from the plugin marketplace

  1. Log on to the AI Gateway console.

  2. In the navigation pane on the left, choose Plug-in. In the top menu bar, select a region.

  3. On the Plug-in page, use the Quick Navigation pane to select a plugin type or search by name. Click the target plugin card.

  4. In the Configuration section, find the target gateway instance. In the Actions column, click Uninstall.

  5. In the dialog box, click OK. A success message appears.

Method 2: Uninstall from the gateway instance page

  1. Log on to the AI Gateway console.

  2. In the navigation pane on the left, choose Instance. In the top menu bar, select a region.

  3. On the Instance page, click the target instance ID.

  4. In the navigation pane on the left, choose Plug-in. In the top menu bar, select a region.

  5. In the plugin list, find the target plugin. In the Actions column, click Uninstall.

  6. In the dialog box, click OK. A success message appears.

Previous：Plug-in marketplaceNext：Develop plug-ins