Skip to main content

Parameters

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

  • header_schema

    object


    Schema for request header.

    At lease one of the header_schema and body_schema should be configured.

  • body_schema

    object


    Schema for request body.

    At lease one of the header_schema and body_schema should be configured.

  • rejected_code

    integer

    default: 400

    vaild vaule:

    between 200 and 599 inclusive


    Status code to return when rejecting requests.

  • rejected_msg

    string


    Message to return when rejecting requests.

  • max_req_body_size

    integer

    default: 67108864

    vaild vaule:

    greater than or equal to 1


    Maximum request body size in bytes read when body_schema is configured. A larger body is rejected with rejected_code, which defaults to 400. This field has no effect when only header_schema is configured. Introduced in API7 Enterprise 3.9.17 and 3.10.4, and APISIX 3.18.0.