firewall_filters

APIs.ioEngineeringPlatform

Properties

Name Type Description
configuration.target string The target to search in existing rules.
configuration.value string The target value to search for in existing rules: an IP address, an IP address range, or a country code, depending on the provided `configuration.target`. Notes: You can search for a single IPv4 addre
match string When set to `all`, all the search requirements must match. When set to `any`, only one of the search requirements has to match.
mode object
notes string The string to search for in the notes of existing IP Access rules. Notes: For example, the string 'attack' would match IP Access rules with notes 'Attack 26/02' and 'Attack 27/02'. The search is case
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-firewall-filters-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/firewall_filters",
  "title": "firewall_filters",
  "properties": {
    "configuration.target": {
      "description": "The target to search in existing rules.",
      "enum": [
        "ip",
        "ip_range",
        "asn",
        "country"
      ],
      "example": "ip",
      "type": "string"
    },
    "configuration.value": {
      "description": "The target value to search for in existing rules: an IP address, an IP address range, or a country code, depending on the provided `configuration.target`.\nNotes: You can search for a single IPv4 address, an IP address range with a subnet of '/16' or '/24', or a two-letter ISO-3166-1 alpha-2 country code.",
      "example": "198.51.100.4",
      "type": "string"
    },
    "match": {
      "default": "all",
      "description": "When set to `all`, all the search requirements must match. When set to `any`, only one of the search requirements has to match.",
      "enum": [
        "any",
        "all"
      ],
      "type": "string"
    },
    "mode": {
      "$ref": "#/components/schemas/firewall_schemas-mode"
    },
    "notes": {
      "description": "The string to search for in the notes of existing IP Access rules.\nNotes: For example, the string 'attack' would match IP Access rules with notes 'Attack 26/02' and 'Attack 27/02'. The search is case insensitive.",
      "example": "my note",
      "type": "string"
    }
  },
  "type": "object"
}