BPARequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "BPARequest",
  "description": "BPARequest schema from Palo Alto Networks AIOps for NGFW BPA API",
  "$id": "https://raw.githubusercontent.com/api-evangelist/palo-alto-networks/refs/heads/main/json-schema/aiops-ngfw-bpa-api-bpa-request-schema.json",
  "type": "object",
  "properties": {
    "serial_number": {
      "type": "string",
      "description": "Device serial number of the NGFW to assess."
    },
    "version": {
      "type": "string",
      "description": "PAN-OS software version running on the device (e.g., 11.1.2).",
      "pattern": "^\\d+\\.\\d+(\\.\\d+)?(-h\\d+)?$"
    },
    "device_info": {
      "type": "object",
      "description": "Optional supplementary device information.",
      "properties": {
        "hostname": {
          "type": "string",
          "description": "Device hostname."
        },
        "model": {
          "type": "string",
          "description": "Device model (e.g., PA-5450, PA-440)."
        },
        "deployment_type": {
          "type": "string",
          "enum": [
            "physical",
            "vm",
            "container"
          ],
          "description": "Device deployment type."
        }
      }
    }
  },
  "required": [
    "serial_number",
    "version"
  ]
}