Skip to main content

Parameters

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

  • request

    array[object]


    An array of actions to mask sensitive information in the request.

    • type

      string

      vaild vaule:

      query, header, or body


      Location where sensitive information should be masked.

    • body_format

      string

      vaild vaule:

      json or urlencoded


      Encoding of the request body. Required when type is body.

    • name

      string


      Name of the information field that contains sensitive data. For JSON body, you can use JSONPath syntax.

    • action

      string

      vaild vaule:

      regex, replace, or remove


      Action to mask the sensitive data.

    • regex

      string


      Regular expressions to match the sensitive data. Required when action is regex.

    • value

      string


      Value to replace the sensitive data with. Required when action is regex or replace.

  • max_body_size

    integer

    default: 1048576


    Maximum body size allowed in bytes. If a request's body size exceeds the configured value, data masking rules will be ignored.

  • max_req_post_args

    integer

    default: 100

    vaild vaule:

    greater than or equal to 0


    Maximum number of URL-encoded form fields to parse when masking request body data with body_format set to urlencoded.