IP Restriction Configuration

Configuration

This plugin is compatible with DB-less mode.

Compatible protocols

The IP Restriction plugin is compatible with the following protocols:

grpc, grpcs, http, https, tcp, tls, tls_passthrough, udp, ws, wss

Parameters

Here's a list of all the parameters which can be used in this plugin's configuration:

• name

  string required

  The name of the plugin, in this case ip-restriction.

• instance_name

  string

  An optional custom name to identify an instance of the plugin, for example ip-restriction_my-service. Useful when running the same plugin in multiple contexts, for example, on multiple services.

• service.name or service.id

  string

  The name or ID of the service the plugin targets. Set one of these parameters if adding the plugin to a service through the top-level /plugins endpoint. Not required if using /services/SERVICE_NAME|ID/plugins.

• route.name or route.id

  string

  The name or ID of the route the plugin targets. Set one of these parameters if adding the plugin to a route through the top-level /plugins endpoint. Not required if using /routes/ROUTE_NAME|ID/plugins.

• consumer.name or consumer.id

  string

  The name or ID of the consumer the plugin targets. Set one of these parameters if adding the plugin to a consumer through the top-level /plugins endpoint. Not required if using /consumers/CONSUMER_NAME|ID/plugins.

• enabled

  boolean default: true

  Whether this plugin will be applied.

• config

  record required
  • allow

    array of type string

    List of IPs or CIDR ranges to allow. One of config.allow or config.deny must be specified.

  • deny

    array of type string

    List of IPs or CIDR ranges to deny. One of config.allow or config.deny must be specified.

  • status

    number

    The HTTP status of the requests that will be rejected by the plugin.

  • message

    string

    The message to send as a response body to rejected requests.