Palo Alto Networks · JSON Structure

Prisma Airs Api Scan Response Structure

ScanResponse schema from Palo Alto Networks Prisma AIRS API

Type: object Properties: 8
Cloud SecurityCybersecurityFirewallNetwork SecuritySASESOARThreat IntelligenceXDR

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

Properties

scan_id status report_id scan_category results tr_id created_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/prisma-airs-api-scan-response-structure.json",
  "name": "ScanResponse",
  "description": "ScanResponse schema from Palo Alto Networks Prisma AIRS API",
  "type": "object",
  "properties": {
    "scan_id": {
      "type": "string",
      "description": "Unique identifier of the scan."
    },
    "status": {
      "type": "string",
      "description": "Current or final status of the scan.",
      "enum": [
        "pending",
        "processing",
        "completed",
        "error"
      ]
    },
    "report_id": {
      "type": "string",
      "description": "Identifier for the detailed scan report."
    },
    "scan_category": {
      "type": "string",
      "description": "Highest severity threat category detected."
    },
    "results": {
      "type": "array",
      "description": "Per-content scan results corresponding to each submitted content item.",
      "items": {
        "type": "object",
        "properties": {
          "prompt_detected": {
            "type": "object",
            "description": "Threats detected in the prompt field.",
            "properties": {
              "url_cats": {
                "type": "boolean",
                "description": "Malicious URL categories detected in prompt."
              },
              "dlp": {
                "type": "boolean",
                "description": "Data loss prevention triggers in prompt."
              },
              "injection": {
                "type": "boolean",
                "description": "Prompt injection detected."
              }
            }
          },
          "response_detected": {
            "type": "object",
            "description": "Threats detected in the response field.",
            "properties": {
              "url_cats": {
                "type": "boolean",
                "description": "Malicious URL categories detected in response."
              },
              "dlp": {
                "type": "boolean",
                "description": "Data loss prevention triggers in response."
              },
              "toxic_content": {
                "type": "boolean",
                "description": "Toxic or harmful content detected in response."
              }
            }
          },
          "verdict": {
            "type": "string",
            "description": "Overall verdict for this content pair.",
            "enum": [
              "benign",
              "malicious"
            ]
          },
          "action": {
            "type": "string",
            "description": "Action taken based on the security profile configuration.",
            "enum": [
              "allow",
              "block"
            ]
          }
        }
      }
    },
    "tr_id": {
      "type": "string",
      "description": "Transaction ID echoed from the request if provided."
    },
    "created_at": {
      "type": "datetime",
      "description": "Timestamp when the scan was submitted."
    },
    "completed_at": {
      "type": "datetime",
      "description": "Timestamp when the scan completed."
    }
  }
}