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-Lengthheader would also be reset. Should not be configured withfilters.body_base64
boolean
default:
falseIf true, decode the response body configured in
bodybefore 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 are executed in the order of
add,remove, andset.add
array
Headers to append to requests. If a header already present in the request, 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 to requests. If a header already present in the request, the header value will be overwritten. Header value could be set to a constant, or one or more built-in variables.
remove
array
Headers to remove from requests.
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:
oncevaild vaule:
onceorglobalScope of substitution.
oncesubstitutes the first matched instance andglobalsubstitutes globally.replace
string
required
Content to substitute with.
options
string
required
default:
joRegEx options to control how the match operation should be performed. See Lua NGINX module for the available options.