Palo Alto Networks · Schema

ScanRequest

ScanRequest schema from Palo Alto Networks Prisma AIRS AI Red Teaming API

Cloud SecurityCybersecurityFirewallNetwork SecuritySASESOARThreat IntelligenceXDR

Properties

Name Type Description
target_id string ID of the scan target to assess.
attack_categories array Attack category identifiers to include in the scan. Use GET /v1/attack-categories to retrieve available category IDs.
custom_prompts array Optional custom adversarial prompts to include alongside the built-in attack library. Useful for testing application-specific threat scenarios.
max_attacks_per_category integer Maximum number of attack probes per category. Limits scan duration for large attack libraries. If omitted, all available attacks for each category are executed.
View JSON Schema on GitHub

JSON Schema

prisma-airs-ai-red-teaming-api-scan-request-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "ScanRequest",
  "description": "ScanRequest schema from Palo Alto Networks Prisma AIRS AI Red Teaming API",
  "$id": "https://raw.githubusercontent.com/api-evangelist/palo-alto-networks/refs/heads/main/json-schema/prisma-airs-ai-red-teaming-api-scan-request-schema.json",
  "type": "object",
  "properties": {
    "target_id": {
      "type": "string",
      "description": "ID of the scan target to assess."
    },
    "attack_categories": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "minItems": 1,
      "description": "Attack category identifiers to include in the scan. Use GET /v1/attack-categories to retrieve available category IDs."
    },
    "custom_prompts": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Optional custom adversarial prompts to include alongside the built-in attack library. Useful for testing application-specific threat scenarios.",
      "maxItems": 100
    },
    "max_attacks_per_category": {
      "type": "integer",
      "description": "Maximum number of attack probes per category. Limits scan duration for large attack libraries. If omitted, all available attacks for each category are executed.",
      "minimum": 1,
      "maximum": 1000
    }
  },
  "required": [
    "target_id",
    "attack_categories"
  ]
}