In order to give you better service we use cookies. By continuing to use our website, you agree to the use of cookies as described in our Cookie Policy

Are you a Kong Gateway user? We'd love your feedback. Take the Survey

Kong Logo
header icon

IP Restriction

Restrict access to a Service or a Route by either allowing or denying IP addresses. Single IPs, multiple IPs or ranges in CIDR notation like 10.10.10.0/24 can be used. The plugin supports IPv4 and IPv6 addresses.

Configuration Reference

You can configure this plugin using the Kong Admin API or through declarative configuration, which involves directly editing the Kong configuration file.

This plugin is compatible with requests with the following protocols:

  • http
  • https

This plugin is compatible with DB-less mode.

In DB-less mode, Kong does not have an Admin API. If using this mode, configure the plugin using declarative configuration.

Enabling the plugin on a Service

Kong Admin API
Kubernetes
Declarative (YAML)

For example, configure this plugin on a Service by making the following request:

$ curl -X POST http://<admin-hostname>:8001/services/<service>/plugins \
    --data "name=ip-restriction"  \
    --data "config.allow=54.13.21.1" \
    --data "config.allow=143.1.0.0/24"

First, create a KongPlugin resource:

apiVersion: configuration.konghq.com/v1
kind: KongPlugin
metadata:
  name: <ip-restriction-example>
config: 
  allow:
  - 54.13.21.1
  - 143.1.0.0/24
plugin: ip-restriction

Next, apply the KongPlugin resource to a Service by annotating the Service as follows:

apiVersion: v1
kind: Service
metadata:
  name: <service>
  labels:
    app: <service>
  annotations:
    konghq.com/plugins: <ip-restriction-example>
spec:
  ports:
  - port: 80
    targetPort: 80
    protocol: TCP
    name: <service>
  selector:
    app: <service>
Note: The KongPlugin resource only needs to be defined once and can be applied to any Service, Consumer, or Route in the namespace. If you want the plugin to be available cluster-wide, create the resource as a KongClusterPlugin instead of KongPlugin.

For example, configure this plugin on a Service by adding this section to your declarative configuration file:

plugins:
- name: ip-restriction
  service: <service>
  config: 
    allow:
    - 54.13.21.1
    - 143.1.0.0/24

<service> is the id or name of the Service that this plugin configuration will target.

Enabling the plugin on a Route

Kong Admin API
Kubernetes
Declarative (YAML)

For example, configure this plugin on a Route with:

$ curl -X POST http://<admin-hostname>:8001/routes/<route>/plugins \
    --data "name=ip-restriction"  \
    --data "config.allow=54.13.21.1" \
    --data "config.allow=143.1.0.0/24"

First, create a KongPlugin resource:

apiVersion: configuration.konghq.com/v1
kind: KongPlugin
metadata:
  name: <ip-restriction-example>
config: 
  allow:
  - 54.13.21.1
  - 143.1.0.0/24
plugin: ip-restriction

Then, apply it to an ingress (Route or Routes) by annotating the ingress as follows:

apiVersion: networking/v1beta1
kind: Ingress
metadata:
  name: <route>
  annotations:
    kubernetes.io/ingress.class: kong
    konghq.com/plugins: <ip-restriction-example>
spec:
  rules:
  - host: examplehostname.com
    http:
      paths:
      - path: /bar
        backend:
          serviceName: echo
          servicePort: 80
Note: The KongPlugin resource only needs to be defined once and can be applied to any Service, Consumer, or Route in the namespace. If you want the plugin to be available cluster-wide, create the resource as a KongClusterPlugin instead of KongPlugin.

For example, configure this plugin on a Route by adding this section to your declarative configuration file:

plugins:
- name: ip-restriction
  route: <route>
  config: 
    allow:
    - 54.13.21.1
    - 143.1.0.0/24

<route> is the id or name of the Route that this plugin configuration will target.

Enabling the plugin on a Consumer

Kong Admin API
Kubernetes
Declarative (YAML)

For example, configure this plugin on a Consumer with:

$ curl -X POST http://<admin-hostname>:8001/consumers/<consumer>/plugins \
    --data "name=ip-restriction"  \
    --data "config.allow=54.13.21.1" \
    --data "config.allow=143.1.0.0/24"

You can combine consumer.id, service.id, or route.id in the same request, to further narrow the scope of the plugin.

First, create a KongPlugin resource:

apiVersion: configuration.konghq.com/v1
kind: KongPlugin
metadata:
  name: <ip-restriction-example>
config: 
  allow:
  - 54.13.21.1
  - 143.1.0.0/24
plugin: ip-restriction

Then, apply it to a Consumer by annotating the KongConsumer resource as follows:

apiVersion: configuration.konghq.com/v1
kind: KongConsumer
metadata:
  name: <consumer>
  annotations:
    konghq.com/plugins: <ip-restriction-example>
    kubernetes.io/ingress.class: kong
Note: The KongPlugin resource only needs to be defined once and can be applied to any Service, Consumer, or Route in the namespace. If you want the plugin to be available cluster-wide, create the resource as a KongClusterPlugin instead of KongPlugin.

For example, configure this plugin on a Consumer by adding this section to your declarative configuration file:

plugins:
- name: ip-restriction
  consumer: <consumer>
  config: 
    allow:
    - 54.13.21.1
    - 143.1.0.0/24

<consumer> is the id or username of the Consumer that this plugin configuration will target.

Enabling the plugin globally

A plugin which is not associated to any Service, Route, or Consumer is considered global, and will be run on every request. Read the Plugin Reference and the Plugin Precedence sections for more information.

Kong Admin API
Kubernetes
Declarative (YAML)

For example, configure this plugin globally with:

$ curl -X POST http://<admin-hostname>:8001/plugins/ \
    --data "name=ip-restriction"  \
    --data "config.allow=54.13.21.1" \
    --data "config.allow=143.1.0.0/24"

Create a KongClusterPlugin resource and label it as global:

apiVersion: configuration.konghq.com/v1
kind: KongClusterPlugin
metadata:
  name: <global-ip-restriction>
  annotations:
    kubernetes.io/ingress.class: kong
  labels:
    global: \"true\"
config: 
  allow:
  - 54.13.21.1
  - 143.1.0.0/24
plugin: ip-restriction

For example, configure this plugin using the plugins: entry in the declarative configuration file:

plugins:
- name: ip-restriction
  config: 
    allow:
    - 54.13.21.1
    - 143.1.0.0/24

Parameters

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

Form ParameterDescription
name

Type: string		 The name of the plugin to use, in this case ip-restriction.
service.id

Type: string		 The ID of the Service the plugin targets.
route.id

Type: string		 The ID of the Route the plugin targets.
consumer.id

Type: string		 The ID of the Consumer the plugin targets.
enabled

Type: boolean

Default value: true		 Whether this plugin will be applied.
config.allow
semi-optional

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

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

An allow list provides a positive security model, in which the configured CIDR ranges are allowed access to the resource, and all others are inherently rejected. By contrast, a deny list configuration provides a negative security model, in which certain CIDRS are explicitly denied access to the resource (and all others are inherently allowed).

You can configure the plugin with both allow and deny configurations. An interesting use case of this flexibility is to allow a CIDR range, but deny an IP address on that CIDR range:

$ curl -X POST http://kong:8001/services/{service}/plugins \
    --data "name=ip-restriction" \
    --data "config.allow=127.0.0.0/24" \
    --data "config.deny=127.0.0.1"