Palo Alto Networks · JSON Structure

Prisma Sd Wan Api Path Rule Structure

PathRule schema from Palo Alto Networks Prisma SD-WAN API

Type: object Properties: 10 Required: 1
Cloud SecurityCybersecurityFirewallNetwork SecuritySASESOARThreat IntelligenceXDR

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

Properties

id name description app_filters preferred_paths sla_threshold enabled priority created_at updated_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-sd-wan-api-path-rule-structure.json",
  "name": "PathRule",
  "description": "PathRule schema from Palo Alto Networks Prisma SD-WAN API",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier for the path rule."
    },
    "name": {
      "type": "string",
      "description": "Name of the path rule."
    },
    "description": {
      "type": "string"
    },
    "app_filters": {
      "type": "array",
      "description": "Application identifiers this path rule applies to.",
      "items": {
        "type": "string"
      }
    },
    "preferred_paths": {
      "type": "array",
      "description": "Ordered list of preferred WAN paths for traffic steering.",
      "items": {
        "type": "object",
        "properties": {
          "label": {
            "type": "string",
            "description": "WAN interface label for the preferred path."
          },
          "type": {
            "type": "string",
            "description": "Whether this path is active or backup.",
            "enum": [
              "active",
              "backup"
            ]
          }
        }
      }
    },
    "sla_threshold": {
      "type": "object",
      "description": "SLA thresholds that trigger path switching.",
      "properties": {
        "latency_ms": {
          "type": "int32",
          "description": "Maximum acceptable latency in milliseconds."
        },
        "packet_loss_pct": {
          "type": "double",
          "description": "Maximum acceptable packet loss percentage."
        },
        "jitter_ms": {
          "type": "int32",
          "description": "Maximum acceptable jitter in milliseconds."
        }
      }
    },
    "enabled": {
      "type": "boolean",
      "description": "Whether the rule is active.",
      "default": true
    },
    "priority": {
      "type": "int32",
      "description": "Rule evaluation priority. Lower numbers are evaluated first."
    },
    "created_at": {
      "type": "datetime"
    },
    "updated_at": {
      "type": "datetime"
    }
  },
  "required": [
    "name"
  ]
}