Skip to main content

Parameters

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

  • source

    string


    required


    A built-in variable, such as http_x_forwarded_for or arg_realip. The variable value should be a valid IP address that represents the client's real IP address, with an optional port.

  • trusted_addresses

    array[string]


    vaild vaule:

    array of IPv4 or IPv6 addresses (CIDR notation acceptable)


    Trusted addresses that are known to send correct replacement addresses. This configuration sets the set_real_ip_from directive.

  • recursive

    boolean


    default: false


    If false, replace the original client address that matches one of the trusted addresses by the last address sent in the configured source.

    If true, replace the original client address that matches one of the trusted addresses by the last non-trusted address sent in the configured source.


API7.ai Logo

API Management for Modern Architectures with Edge, API Gateway, Kubernetes, and Service Mesh.

Product

API7 Cloud

SOC2 Type IIISO 27001HIPAAGDPRRed Herring

Copyright © APISEVEN PTE. LTD 2019 – 2024. Apache, Apache APISIX, APISIX, and associated open source project names are trademarks of the

Apache Software Foundation