API7 Docs

IP Restriction Configuration

Parameters

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

  • whitelistarray[string] · optional

    List of IPs to whitelist. Support IPv4, IPv6, and CIDR notations.

    At least one of the whitelist and blacklist should be configured, but they cannot be configured at the same time.

  • blacklistarray[string] · optional

    List of IPs to blacklist. Support IPv4, IPv6, and CIDR notations.

    At least one of the whitelist and blacklist should be configured, but they cannot be configured at the same time.

  • messagestring · optional · default: Your IP address is not allowed

    Message returned when the IP address is denied access.

  • response_codeinteger · optional · default: 403

    Valid values: between 403 and 404 inclusive

    HTTP response code returned when the request is rejected due to IP address restriction. Available in API7 Enterprise from version 3.10.3.