Skip to main content
API7.ai Logo

Parameters​

See plugin common configurations for configuration options available to all plugins.

  • rules

    array[object]

    required

    An array of one or more pairs of matching conditions and actions to be executed.

    • case

      array[array]

      An array of one or more matching conditions in the form of APISIX expressions.

    • actions

      array[array]

      required

      An array of actions to be executed when a condition is successfully matched. Currently, the array only supports one action, and it should be either return, limit-count, or limit-conn. If you are using API7 Enterprise, you can also use limit-count-advanced as the action.

      When the action is set to return, you can configure an HTTP status code to return to the client when the condition is matched.

      When the action is set to limit-count, you can configure all options of the limit-count plugin, except for group.

      When the action is set to limit-count-advanced, you can configure all options of the limit-count-advanced plugin, except for group.

      When the action is set to limit-conn, you can configure all options of the limit-conn plugin.