Skip to main content

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]


      required


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

    • actions

      array[object]


      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, or limit-count. If you are using API7 Enterprise, you can also use limit-count-advanced in the action.

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

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

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


API7.ai Logo

API Management for Modern Architectures with Edge, API Gateway, Kubernetes, and Service Mesh.

Product

API7 Cloud

SOC2 Type IIISO 27001HIPAAGDPRRed Herring

Copyright © APISEVEN PTE. LTD 2019 – 2024. Apache, Apache APISIX, APISIX, and associated open source project names are trademarks of the

Apache Software Foundation