Skip to main content
API7.ai Logo

Parameters​

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

  • status_code

    integer

    vaild vaule:

    between 200 and 598 inclusive

    New HTTP status code in the response.

  • body

    string

    New response body. The Content-Length header would also be reset. Should not be configured with filters.

  • body_base64

    boolean

    default: false

    If true, decode the response body configured in body before sending to client, which is useful for image and protobuf decoding. Note that this configuration cannot be used to decode upstream response.

  • headers

    object

    Actions to be executed in the order of add, remove, and set.

    • add

      array[string]

      Headers to append to responses. If a header is already present in the response, the header value will be appended. Header value could be set to a constant, or one or more built-in variables.

    • set

      object

      Headers to set in responses. If a header is already present in the response, the header value will be overwritten. Header value could be set to a constant, or one or more built-in variables.

    • remove

      array[string]

      Headers to remove from responses.

  • vars

    array[array]

    An array of one or more matching conditions in the form of APISIX expressions to conditionally execute the plugin.

  • filters

    array[object]

    List of filters that modify the response body by replacing one specified string with another. Should not be configured with body.

    • regex

      string

      required

      RegEx pattern to match on the response body.

    • scope

      string

      default: once

      vaild vaule:

      once or global

      Scope of substitution. once substitutes the first matched instance and global substitutes globally.

    • replace

      string

      required

      Content to substitute with.

    • options

      string

      default: jo

      RegEx options to control how the match operation should be performed. See Lua NGINX module for the available options.

  • max_resp_body_size

    integer

    default: 67108864

    Maximum response body size in bytes buffered into memory when filters are applied. Larger responses are truncated. Available in API7 Enterprise from version 3.9.17 on the 3.9 line and from version 3.10.4 on the 3.10 line.