Palo Alto Networks · JSON Structure

Aiops Ngfw Bpa Api Bpa Request Status Structure

BPARequestStatus schema from Palo Alto Networks AIOps for NGFW BPA API

Type: object Properties: 7
Cloud SecurityCybersecurityFirewallNetwork SecuritySASESOARThreat IntelligenceXDR

BPARequestStatus is a JSON Structure definition published by Palo Alto Networks, describing 7 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

request_id serial_number status report_id error_message submitted_at completed_at

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-status-structure.json",
  "name": "BPARequestStatus",
  "description": "BPARequestStatus schema from Palo Alto Networks AIOps for NGFW BPA API",
  "type": "object",
  "properties": {
    "request_id": {
      "type": "string",
      "description": "Unique identifier of the BPA request."
    },
    "serial_number": {
      "type": "string",
      "description": "Device serial number for which the assessment was submitted."
    },
    "status": {
      "type": "string",
      "description": "Current processing status of the request.",
      "enum": [
        "pending",
        "processing",
        "completed",
        "failed"
      ]
    },
    "report_id": {
      "type": "string",
      "description": "Report identifier available when status is completed. Use with GET /reports/{report_id} to retrieve the full report."
    },
    "error_message": {
      "type": "string",
      "description": "Error description when status is failed."
    },
    "submitted_at": {
      "type": "datetime",
      "description": "Timestamp when the request was submitted."
    },
    "completed_at": {
      "type": "datetime",
      "description": "Timestamp when processing completed."
    }
  }
}