IP filter

Enterprise only. The IP filtering plugin allows you to restrict the traffic to your API gateway based on the IP address. It works in two different modes (allow or deny) where you define the list of IPs (CIDR blocks) that are authorized to use the API, or that are denied from using the API. See: https://www.krakend.io/docs/enterprise/throttling/ipfilter/

Get JSON SchemaBundle
Identifierhttps://schemas.sourcemeta.com/krakend/v2.2/plugin/ip-filter.json
Base DialectDraft7
Dialecthttp://json-schema.org/draft-07/schema#
Size0.002115 MB
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://schemas.sourcemeta.com/krakend/v2.2/plugin/ip-filter.json",
  "title": "IP filter",
  "description": "Enterprise only. The IP filtering plugin allows you to restrict the traffic to your API gateway based on the IP address. It works in two different modes (allow or deny) where you define the list of IPs (CIDR blocks) that are authorized to use the API, or that are denied from using the API.\n\nSee: https://www.krakend.io/docs/enterprise/throttling/ipfilter/",
  "type": "object",
  "required": [ "CIDR", "allow" ],
  "properties": {
    "CIDR": {
      "title": "CIDR",
      "description": "The CIDR blocks (list of IPs) you want to allow or deny.\n\nSee: https://www.krakend.io/docs/enterprise/throttling/ipfilter/",
      "examples": [
        [ "192.168.0.0/24", "172.17.2.56/32" ]
      ],
      "type": "array"
    },
    "allow": {
      "title": "Allow or deny mode",
      "description": "When true, only the matching IPs are able to access the content. When false, all matching IPs are discarded.\n\nSee: https://www.krakend.io/docs/enterprise/throttling/ipfilter/",
      "default": false,
...
See the full schema