Palo Alto Networks · JSON Structure

Aiops Ngfw Bpa Api Bpa Request Structure

BPARequest schema from Palo Alto Networks AIOps for NGFW BPA API

Type: object Properties: 3 Required: 2
Cloud SecurityCybersecurityFirewallNetwork SecuritySASESOARThreat IntelligenceXDR

BPARequest is a JSON Structure definition published by Palo Alto Networks, describing 3 properties, of which 2 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

serial_number version device_info

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/palo-alto-networks/refs/heads/main/json-structure/aiops-ngfw-bpa-api-bpa-request-structure.json",
  "name": "BPARequest",
  "description": "BPARequest schema from Palo Alto Networks AIOps for NGFW BPA API",
  "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",
          "description": "Device deployment type.",
          "enum": [
            "physical",
            "vm",
            "container"
          ]
        }
      }
    }
  },
  "required": [
    "serial_number",
    "version"
  ]
}