StaticJobReportSchema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/palo-alto-networks/main/json-schema/palo-alto-networks-static-job-report-schema-schema.json",
  "title": "StaticJobReportSchema",
  "description": "Complete static job report data structure.",
  "x-generated": "2026-10-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/palo-alto-networks-report-api-openapi.yml#/components/schemas/StaticJobReportSchema",
  "properties": {
    "asr": {
      "anyOf": [
        {
          "type": "number",
          "maximum": 100.0,
          "minimum": 0.0
        },
        {
          "type": "null"
        }
      ],
      "title": "Asr",
      "description": "Attack Success Rate percentage (0-100)"
    },
    "score": {
      "anyOf": [
        {
          "type": "number",
          "maximum": 100.0,
          "minimum": 0.0
        },
        {
          "type": "null"
        }
      ],
      "title": "Score",
      "description": "Overall job performance score (0-100)"
    },
    "security_report": {
      "anyOf": [
        {
          "$ref": "#/$defs/CategoryReportSchema"
        },
        {
          "type": "null"
        }
      ],
      "description": "Security risk overview widget"
    },
    "safety_report": {
      "anyOf": [
        {
          "$ref": "#/$defs/CategoryReportSchema"
        },
        {
          "type": "null"
        }
      ],
      "description": "Safety risk overview widget"
    },
    "brand_report": {
      "anyOf": [
        {
          "$ref": "#/$defs/CategoryReportSchema"
        },
        {
          "type": "null"
        }
      ],
      "description": "Brand reputation risk overview widget"
    },
    "compliance_report": {
      "anyOf": [
        {
          "items": {
            "$ref": "#/$defs/ComplianceReportSchema"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "title": "Compliance Report",
      "description": "Compliance widget with all frameworks"
    },
    "severity_report": {
      "$ref": "#/$defs/SeverityReportSchema",
      "description": "Breakdown of all successful attacks by severity level for the entire job"
    },
    "report_summary": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Report Summary",
      "description": "Report summary from the LLM for the statics job run"
    },
    "recommendations": {
      "anyOf": [
        {
          "$ref": "#/$defs/StaticJobRemediationRecommendationSchema"
        },
        {
          "type": "null"
        }
      ],
      "description": "Remediation recommendations with security profile and actionable fixes"
    }
  },
  "type": "object",
  "required": [
    "severity_report"
  ],
  "$defs": {
    "CategoryReportSchema": {
      "properties": {
        "id": {
          "type": "string",
          "title": "Id",
          "description": "Unique identifier"
        },
        "display_name": {
          "type": "string",
          "title": "Display Name",
          "description": "Frontend display name"
        },
        "description": {
          "type": "string",
          "title": "Description",
          "description": "Description"
        },
        "preselect": {
          "type": "boolean",
          "title": "Preselect",
          "description": "Whether this category should be preselected in UI",
          "default": true
        },
        "sub_categories": {
          "items": {
            "$ref": "#/$defs/SubCategoryStatsSchema"
          },
          "type": "array",
          "title": "Sub Categories",
          "description": "Statistics per subcategory (e.g., ADVERSARIAL_SUFFIX, BIAS)"
        },
        "asr": {
          "type": "number",
          "maximum": 100.0,
          "minimum": 0.0,
          "title": "Asr",
          "description": "Attack success rate percentage"
        },
        "total_prompts": {
          "type": "integer",
          "title": "Total Prompts",
          "description": "Total unique prompts used"
        },
        "total_attacks": {
          "type": "integer",
          "title": "Total Attacks",
          "description": "Total attacks executed"
        },
        "successful": {
          "type": "integer",
          "title": "Successful",
          "description": "Total successful attacks"
        },
        "failed": {
          "type": "integer",
          "title": "Failed",
          "description": "Total failed attacks"
        }
      },
      "type": "object",
      "required": [
        "id",
        "display_name",
        "description",
        "sub_categories",
        "asr",
        "total_prompts",
        "total_attacks",
        "successful",
        "failed"
      ],
      "title": "CategoryReportSchema",
      "description": "Security or Safety risk overview widget data."
    },
    "ComplianceReportSchema": {
      "properties": {
        "id": {
          "type": "string",
          "title": "Id",
          "description": "Compliance framework unique identifier"
        },
        "display_name": {
          "type": "string",
          "title": "Display Name",
          "description": "Compliance framework display name for frontend"
        },
        "description": {
          "type": "string",
          "title": "Description",
          "description": "Compliance framework description"
        },
        "active": {
          "type": "boolean",
          "title": "Active",
          "description": "Whether compliance framework is active"
        },
        "version": {
          "type": "string",
          "title": "Version",
          "description": "Compliance framework version"
        },
        "link": {
          "type": "string",
          "title": "Link",
          "description": "Compliance framework documentation link"
        },
        "techniques": {
          "items": {
            "$ref": "#/$defs/ComplianceTechniqueSchema"
          },
          "type": "array",
          "title": "Techniques"
        },
        "score": {
          "type": "integer",
          "title": "Score",
          "description": "Compliance score: (1 - ASR%) % 5",
          "default": 0
        }
      },
      "type": "object",
      "required": [
        "id",
        "display_name",
        "description",
        "active",
        "version",
        "link",
        "techniques"
      ],
      "title": "ComplianceReportSchema"
    },
    "ComplianceTechniqueSchema": {
      "properties": {
        "id": {
          "type": "string",
          "title": "Id",
          "description": "Technique unique identifier"
        },
        "display_name": {
          "type": "string",
          "title": "Display Name",
          "description": "Technique display name for frontend"
        },
        "compliance_id": {
          "type": "string",
          "title": "Compliance Id",
          "description": "Associated compliance framework ID"
        },
        "description": {
          "type": "string",
          "title": "Description",
          "description": "Technique description"
        },
        "link": {
          "type": "string",
          "title": "Link",
          "description": "Technique documentation link"
        },
        "version": {
          "type": "string",
          "title": "Version",
          "description": "Technique version"
        },
        "active": {
          "type": "boolean",
          "title": "Active",
          "description": "Whether technique is active"
        },
        "successful": {
          "type": "integer",
          "title": "Successful",
          "description": "Number of successful attacks",
          "default": 0
        },
        "failed": {
          "type": "integer",
          "title": "Failed",
          "description": "Number of failed attacks",
          "default": 0
        },
        "total": {
          "type": "integer",
          "title": "Total",
          "description": "Total attacks for this technique",
          "default": 0
        }
      },
      "type": "object",
      "required": [
        "id",
        "display_name",
        "compliance_id",
        "description",
        "link",
        "version",
        "active"
      ],
      "title": "ComplianceTechniqueSchema",
      "description": "Compliance Technique Model"
    },
    "CustomTopicGuardrailsSchema": {
      "properties": {
        "action": {
          "$ref": "#/$defs/GuardrailAction",
          "description": "Action to take: 'allow', 'block'",
          "default": "BLOCK"
        },
        "blocked_topics": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "title": "Blocked Topics",
          "description": "List of blocked topics"
        }
      },
      "type": "object",
      "title": "CustomTopicGuardrailsSchema",
      "description": "Custom topic guardrails with blocked topics."
    },
    "GuardrailAction": {
      "type": "string",
      "enum": [
        "ALLOW",
        "BLOCK"
      ],
      "title": "GuardrailAction",
      "description": "Actions that can be taken by guardrails."
    },
    "MaliciousCodeDetectionSchema": {
      "properties": {
        "action": {
          "$ref": "#/$defs/GuardrailAction",
          "description": "Action to take: 'allow', 'block'",
          "default": "BLOCK"
        }
      },
      "type": "object",
      "title": "MaliciousCodeDetectionSchema",
      "description": "Guardrail configuration for malicious code detection."
    },
    "MaliciousURLDetectionSchema": {
      "properties": {
        "action": {
          "$ref": "#/$defs/GuardrailAction",
          "description": "Action to take: 'allow', 'block'",
          "default": "BLOCK"
        }
      },
      "type": "object",
      "title": "MaliciousURLDetectionSchema",
      "description": "Guardrail configuration for malicious URL detection."
    },
    "PolicyType": {
      "type": "string",
      "enum": [
        "PROMPT_INJECTION",
        "TOXIC_CONTENT",
        "CUSTOM_TOPIC_GUARDRAILS",
        "MALICIOUS_CODE_DETECTION",
        "MALICIOUS_URL_DETECTION",
        "SENSITIVE_DATA_PROTECTION"
      ],
      "title": "PolicyType",
      "description": "Policy types with metadata."
    },
    "PrerequisiteModel": {
      "properties": {
        "id": {
          "type": "string",
          "title": "Id",
          "description": "Prerequisite unique identifier"
        },
        "display_name": {
          "type": "string",
          "title": "Display Name",
          "description": "Prerequisite display name for frontend"
        },
        "description": {
          "type": "string",
          "title": "Description",
          "description": "Prerequisite description"
        }
      },
      "type": "object",
      "required": [
        "id",
        "display_name",
        "description"
      ],
      "title": "PrerequisiteModel",
      "description": "Pydantic model for prerequisite data"
    },
    "PromptInjectionGuardrailSchema": {
      "properties": {
        "action": {
          "$ref": "#/$defs/GuardrailAction",
          "description": "Action to take: 'allow', 'block'",
          "default": "BLOCK"
        }
      },
      "type": "object",
      "title": "PromptInjectionGuardrailSchema",
      "description": "Guardrail configuration for prompt injection."
    },
    "RuntimeSecurityPolicySchema": {
      "properties": {
        "policy_id": {
          "$ref": "#/$defs/PolicyType",
          "description": "Runtime Security Policy type"
        },
        "display_name": {
          "type": "string",
          "title": "Display Name",
          "description": "Runtime Security Policy display name"
        },
        "config": {
          "anyOf": [
            {
              "$ref": "#/$defs/PromptInjectionGuardrailSchema"
            },
            {
              "$ref": "#/$defs/ToxicContentGuardrailSchema"
            },
            {
              "$ref": "#/$defs/CustomTopicGuardrailsSchema"
            },
            {
              "$ref": "#/$defs/MaliciousCodeDetectionSchema"
            },
            {
              "$ref": "#/$defs/MaliciousURLDetectionSchema"
            },
            {
              "$ref": "#/$defs/SensitiveDataProtectionSchema"
            }
          ],
          "title": "Config",
          "description": "Runtime Security Policy configuration"
        }
      },
      "type": "object",
      "required": [
        "policy_id",
        "display_name",
        "config"
      ],
      "title": "RuntimeSecurityPolicySchema",
      "description": "Runtime security policy configuration."
    },
    "SensitiveDataProtectionSchema": {
      "properties": {
        "action": {
          "$ref": "#/$defs/GuardrailAction",
          "description": "Action to take: 'allow', 'block'",
          "default": "BLOCK"
        },
        "masking_sensitive_data": {
          "type": "boolean",
          "title": "Masking Sensitive Data",
          "description": "Whether to mask sensitive data in responses",
          "default": true
        }
      },
      "type": "object",
      "title": "SensitiveDataProtectionSchema",
      "description": "Guardrail configuration for sensitive data protection."
    },
    "SeverityReportSchema": {
      "properties": {
        "stats": {
          "items": {
            "$ref": "#/$defs/SeverityStatsSchema"
          },
          "type": "array",
          "title": "Stats",
          "description": "List of severity statistics"
        },
        "successful": {
          "type": "integer",
          "title": "Successful",
          "description": "Total successful attacks across all severities",
          "default": 0
        },
        "failed": {
          "type": "integer",
          "title": "Failed",
          "description": "Total failed attacks across all severities",
          "default": 0
        },
        "total_attacks": {
          "type": "integer",
          "title": "Total Attacks",
          "description": "Total number of attacks across all severities",
          "default": 0
        }
      },
      "type": "object",
      "required": [
        "stats"
      ],
      "title": "SeverityReportSchema",
      "description": "Attack Severity statistics with breakdown by severity level."
    },
    "SeverityStatsSchema": {
      "properties": {
        "severity": {
          "type": "string",
          "description": "Severity level (LOW, MEDIUM, HIGH, CRITICAL)"
        },
        "successful": {
          "type": "integer",
          "title": "Successful",
          "description": "Number of successful attacks at this severity",
          "default": 0
        },
        "failed": {
          "type": "integer",
          "title": "Failed",
          "description": "Number of failed attacks at this severity",
          "default": 0
        }
      },
      "type": "object",
      "required": [
        "severity"
      ],
      "title": "SeverityStatsSchema",
      "description": "Breakdown for a single severity level."
    },
    "StaticJobRemediationRecommendationSchema": {
      "properties": {
        "runtime_security_policy_configuration": {
          "anyOf": [
            {
              "items": {
                "$ref": "#/$defs/RuntimeSecurityPolicySchema"
              },
              "type": "array"
            },
            {
              "type": "null"
            }
          ],
          "title": "Runtime Security Policy Configuration",
          "description": "Recommended runtime security policy configuration"
        },
        "other_measures": {
          "items": {
            "$ref": "#/$defs/StaticJobRemediationSchema"
          },
          "type": "array",
          "title": "Other Measures",
          "description": "List of applicable remediations for static job"
        }
      },
      "type": "object",
      "title": "StaticJobRemediationRecommendationSchema",
      "description": "Remediation recommendations with security profile and other remediations. To build and store in db"
    },
    "StaticJobRemediationSchema": {
      "properties": {
        "mapping_remediation_id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Mapping Remediation Id",
          "description": "UUID from remediations.csv identifying this remediation"
        },
        "subcategories": {
          "anyOf": [
            {
              "items": {
                "type": "string"
              },
              "type": "array"
            },
            {
              "type": "null"
            }
          ],
          "title": "Subcategories",
          "description": "Subcategories this remediation applies to"
        },
        "effectiveness": {
          "type": "integer",
          "title": "Effectiveness",
          "description": "Effectiveness rating of this remediation (higher is more effective)",
          "default": 0
        },
        "ease_of_implementation": {
          "type": "integer",
          "title": "Ease Of Implementation",
          "description": "Ease of implementation rating (higher is easier to implement)",
          "default": 0
        },
        "priority": {
          "type": "integer",
          "title": "Priority",
          "description": "Priority level for implementing this remediation (LOW, MEDIUM, HIGH)",
          "default": 0
        },
        "remediation": {
          "type": "string",
          "title": "Remediation",
          "description": "Remediation recommendation title"
        },
        "description": {
          "type": "string",
          "title": "Description",
          "description": "Detailed description of the remediation"
        },
        "resource_links": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "title": "Resource Links",
          "description": "URLs for additional resources and documentation"
        },
        "categories": {
          "anyOf": [
            {
              "items": {
                "type": "string"
              },
              "type": "array"
            },
            {
              "type": "null"
            }
          ],
          "title": "Categories",
          "description": "Categories this remediation applies to (e.g., Security, Safety)"
        }
      },
      "type": "object",
      "required": [
        "remediation",
        "description"
      ],
      "title": "StaticJobRemediationSchema",
      "description": "Static Job Individual remediation."
    },
    "SubCategoryStatsSchema": {
      "properties": {
        "id": {
          "type": "string",
          "title": "Id",
          "description": "Unique identifier"
        },
        "display_name": {
          "type": "string",
          "title": "Display Name",
          "description": "Frontend display name"
        },
        "description": {
          "type": "string",
          "title": "Description",
          "description": "Description"
        },
        "preselect": {
          "type": "boolean",
          "title": "Preselect",
          "description": "Whether this subcategory should be preselected in UI",
          "default": true
        },
        "prerequisites": {
          "anyOf": [
            {
              "items": {
                "$ref": "#/$defs/PrerequisiteModel"
              },
              "type": "array"
            },
            {
              "type": "null"
            }
          ],
          "title": "Prerequisites",
          "description": "List of prerequisites for this subcategory"
        },
        "active": {
          "type": "boolean",
          "title": "Active",
          "description": "Whether this subcategory is active",
          "default": true
        },
        "file_supported": {
          "type": "boolean",
          "title": "File Supported",
          "description": "Whether this subcategory has multimodal file (document) attacks in the library — drives the file-upload icon in the scan wizard",
          "default": false
        },
        "successful": {
          "type": "integer",
          "title": "Successful",
          "description": "Number of successful attacks (threat=True)"
        },
        "failed": {
          "type": "integer",
          "title": "Failed",
          "description": "Number of failed attacks (threat=False)"
        },
        "total": {
          "type": "integer",
          "title": "Total",
          "description": "Total attacks for this subcategory (successful + failed)",
          "default": 0
        }
      },
      "type": "object",
      "required": [
        "id",
        "display_name",
        "description",
        "successful",
        "failed"
      ],
      "title": "SubCategoryStatsSchema",
      "description": "Statistics for a specific subcategory."
    },
    "ToxicContentGuardrailSchema": {
      "properties": {
        "moderate": {
          "$ref": "#/$defs/GuardrailAction",
          "description": "Action for moderate toxicity: 'allow', 'block'",
          "default": "BLOCK"
        },
        "high": {
          "$ref": "#/$defs/GuardrailAction",
          "description": "Action for high toxicity: 'allow', 'block'",
          "default": "BLOCK"
        }
      },
      "type": "object",
      "title": "ToxicContentGuardrailSchema",
      "description": "Guardrail configuration for toxic content with severity levels."
    }
  }
}