Palo Alto Networks · JSON Structure

Prisma Airs Ai Red Teaming Api Scan Target Request Structure

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

Type: object Properties: 7 Required: 3
Cloud SecurityCybersecurityFirewallNetwork SecuritySASESOARThreat IntelligenceXDR

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

Properties

name description type endpoint_url model auth_config system_prompt

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-ai-red-teaming-api-scan-target-request-structure.json",
  "name": "ScanTargetRequest",
  "description": "ScanTargetRequest schema from Palo Alto Networks Prisma AIRS AI Red Teaming API",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "Display name for the scan target.",
      "maxLength": 256
    },
    "description": {
      "type": "string",
      "description": "Optional description of the target application."
    },
    "type": {
      "type": "string",
      "description": "AI interface type of the target endpoint.",
      "enum": [
        "openai_chat",
        "anthropic_messages",
        "custom_http",
        "huggingface"
      ]
    },
    "endpoint_url": {
      "type": "uri",
      "description": "URL of the AI application endpoint to scan."
    },
    "model": {
      "type": "string",
      "description": "AI model name to include in requests (e.g., gpt-4o, claude-3-5-sonnet-20241022)."
    },
    "auth_config": {
      "type": "object",
      "description": "Authentication configuration for the target endpoint.",
      "properties": {
        "type": {
          "type": "string",
          "description": "Authentication method.",
          "enum": [
            "bearer_token",
            "api_key_header",
            "basic",
            "none"
          ]
        },
        "header_name": {
          "type": "string",
          "description": "Header name for API key authentication."
        },
        "credential": {
          "type": "string",
          "description": "Authentication credential value (API key or token)."
        }
      }
    },
    "system_prompt": {
      "type": "string",
      "description": "System prompt to include in requests to the target. Used to scope red teaming attacks to the intended application context.",
      "maxLength": 8192
    }
  },
  "required": [
    "name",
    "type",
    "endpoint_url"
  ]
}