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.

    Rules are evaluated in sequential order. If there are multiple rules and the condition of a rule is matched, the associated actions will execute. Subsequent rules will be omitted for evaluations and executions.

    • match

      array[array]


      required


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

    • actions

      array[object]


      required


      An array of one or more actions to be executed when a condition is successfully matched.

      • set_headers

        object


        One or more request headers to apply to requests in the format of {"name": "value", ...}, where value could be a built-in variable. If a header of the same name already exists, it will be overwritten.

      • weight

        integer


        default: 1


        The weight of action distribution.

API7.ai Logo

The digital world is connected by APIs,
API7.ai exists to make APIs more efficient, reliable, and secure.

Sign up for API7 newsletter

Product

API7 Gateway

SOC2 Type IIISO 27001HIPAAGDPRRed Herring

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