Palo Alto Networks · Schema

BPARequestStatus

BPARequestStatus schema from Palo Alto Networks AIOps for NGFW BPA API

Cloud SecurityCybersecurityFirewallNetwork SecuritySASESOARThreat IntelligenceXDR

Properties

Name Type Description
request_id string Unique identifier of the BPA request.
serial_number string Device serial number for which the assessment was submitted.
status string Current processing status of the request.
report_id string Report identifier available when status is completed. Use with GET /reports/{report_id} to retrieve the full report.
error_message string Error description when status is failed.
submitted_at string Timestamp when the request was submitted.
completed_at string Timestamp when processing completed.
View JSON Schema on GitHub

JSON Schema

aiops-ngfw-bpa-api-bpa-request-status-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "BPARequestStatus",
  "description": "BPARequestStatus 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-status-schema.json",
  "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",
      "enum": [
        "pending",
        "processing",
        "completed",
        "failed"
      ],
      "description": "Current processing status of the request."
    },
    "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": "string",
      "format": "date-time",
      "description": "Timestamp when the request was submitted."
    },
    "completed_at": {
      "type": "string",
      "format": "date-time",
      "description": "Timestamp when processing completed."
    }
  }
}