firewall_rule

APIs.ioEngineeringPlatform

Properties

Name Type Description
allowed_modes array The available actions that a rule can apply to a matched request.
configuration object
created_on string The timestamp of when the rule was created.
id object
mode object
modified_on string The timestamp of when the rule was last modified.
notes object
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-firewall-rule-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/firewall_rule",
  "title": "firewall_rule",
  "properties": {
    "allowed_modes": {
      "description": "The available actions that a rule can apply to a matched request.",
      "example": [
        "whitelist",
        "block",
        "challenge",
        "js_challenge",
        "managed_challenge"
      ],
      "items": {
        "$ref": "#/components/schemas/firewall_schemas-mode"
      },
      "readOnly": true,
      "type": "array"
    },
    "configuration": {
      "$ref": "#/components/schemas/firewall_configuration"
    },
    "created_on": {
      "description": "The timestamp of when the rule was created.",
      "example": "2014-01-01T05:20:00.12345Z",
      "format": "date-time",
      "readOnly": true,
      "type": "string"
    },
    "id": {
      "$ref": "#/components/schemas/firewall_schemas-identifier"
    },
    "mode": {
      "$ref": "#/components/schemas/firewall_schemas-mode"
    },
    "modified_on": {
      "description": "The timestamp of when the rule was last modified.",
      "example": "2014-01-01T05:20:00.12345Z",
      "format": "date-time",
      "readOnly": true,
      "type": "string"
    },
    "notes": {
      "$ref": "#/components/schemas/firewall_notes"
    }
  },
  "required": [
    "id",
    "mode",
    "allowed_modes",
    "configuration"
  ],
  "type": "object"
}