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 sequentially. For a matching rule, the plugin selects one action by weight. When the selected action contains set_headers, it is applied and evaluation stops. If the selected object contains only weight, evaluation continues to the next rule.

    • 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.