BotDetectionPluginConfig

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/BotDetectionPluginConfig",
  "title": "BotDetectionPluginConfig",
  "x-speakeasy-entity": "PluginBotDetection",
  "properties": {
    "config": {
      "type": "object",
      "properties": {
        "allow": {
          "description": "An array of regular expressions that should be allowed. The regular expressions will be checked against the `User-Agent` header.",
          "type": "array",
          "items": {
            "type": "string"
          },
          "default": []
        },
        "deny": {
          "description": "An array of regular expressions that should be denied. The regular expressions will be checked against the `User-Agent` header.",
          "type": "array",
          "items": {
            "type": "string"
          },
          "default": []
        }
      }
    },
    "name": {
      "const": "bot-detection"
    },
    "protocols": {
      "description": "A set of strings representing HTTP protocols.",
      "type": "array",
      "items": {
        "enum": [
          "grpc",
          "grpcs",
          "http",
          "https"
        ],
        "type": "string"
      },
      "format": "set",
      "default": [
        "grpc",
        "grpcs",
        "http",
        "https"
      ]
    },
    "route": {
      "description": "If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        }
      }
    },
    "service": {
      "description": "If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        }
      }
    }
  }
}