Palo Alto Networks · Schema

DataPattern

DataPattern schema from Palo Alto Networks Enterprise DLP API

Cloud SecurityCybersecurityFirewallNetwork SecuritySASESOARThreat IntelligenceXDR

Properties

Name Type Description
id string Unique data pattern identifier.
name string Display name of the data pattern.
description string Human-readable description of what the pattern detects.
type string Whether the pattern is predefined or custom.
category string Pattern category (e.g., PII, PCI, HIPAA, Financial).
confidence string Confidence threshold for the pattern.
detection_rules array Detection rule definitions for the pattern.
enabled boolean Whether the data pattern is active.
incident_count integer Total number of incidents triggered by this pattern.
View JSON Schema on GitHub

JSON Schema

dlp-api-data-pattern-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "DataPattern",
  "description": "DataPattern schema from Palo Alto Networks Enterprise DLP API",
  "$id": "https://raw.githubusercontent.com/api-evangelist/palo-alto-networks/refs/heads/main/json-schema/dlp-api-data-pattern-schema.json",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique data pattern identifier."
    },
    "name": {
      "type": "string",
      "description": "Display name of the data pattern."
    },
    "description": {
      "type": "string",
      "description": "Human-readable description of what the pattern detects."
    },
    "type": {
      "type": "string",
      "enum": [
        "predefined",
        "custom"
      ],
      "description": "Whether the pattern is predefined or custom."
    },
    "category": {
      "type": "string",
      "description": "Pattern category (e.g., PII, PCI, HIPAA, Financial)."
    },
    "confidence": {
      "type": "string",
      "enum": [
        "high",
        "medium",
        "low"
      ],
      "description": "Confidence threshold for the pattern."
    },
    "detection_rules": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "rule_type": {
            "type": "string",
            "enum": [
              "regex",
              "keyword",
              "dictionary",
              "file_property"
            ]
          },
          "value": {
            "type": "string"
          },
          "proximity": {
            "type": "integer"
          }
        }
      },
      "description": "Detection rule definitions for the pattern."
    },
    "enabled": {
      "type": "boolean",
      "description": "Whether the data pattern is active."
    },
    "incident_count": {
      "type": "integer",
      "description": "Total number of incidents triggered by this pattern."
    }
  }
}