PathRule

PathRule schema from Palo Alto Networks Prisma SD-WAN API

Cloud SecurityCybersecurityFirewallNetwork SecuritySASESOARThreat IntelligenceXDR

Properties

Name	Type	Description
id	string	Unique identifier for the path rule.
name	string	Name of the path rule.
description	string
app_filters	array	Application identifiers this path rule applies to.
preferred_paths	array	Ordered list of preferred WAN paths for traffic steering.
sla_threshold	object	SLA thresholds that trigger path switching.
enabled	boolean	Whether the rule is active.
priority	integer	Rule evaluation priority. Lower numbers are evaluated first.
created_at	string
updated_at	string

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "PathRule",
  "description": "PathRule schema from Palo Alto Networks Prisma SD-WAN API",
  "$id": "https://raw.githubusercontent.com/api-evangelist/palo-alto-networks/refs/heads/main/json-schema/prisma-sd-wan-api-path-rule-schema.json",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier for the path rule.",
      "readOnly": true
    },
    "name": {
      "type": "string",
      "description": "Name of the path rule."
    },
    "description": {
      "type": "string"
    },
    "app_filters": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Application identifiers this path rule applies to."
    },
    "preferred_paths": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "label": {
            "type": "string",
            "description": "WAN interface label for the preferred path."
          },
          "type": {
            "type": "string",
            "enum": [
              "active",
              "backup"
            ],
            "description": "Whether this path is active or backup."
          }
        }
      },
      "description": "Ordered list of preferred WAN paths for traffic steering."
    },
    "sla_threshold": {
      "type": "object",
      "description": "SLA thresholds that trigger path switching.",
      "properties": {
        "latency_ms": {
          "type": "integer",
          "description": "Maximum acceptable latency in milliseconds."
        },
        "packet_loss_pct": {
          "type": "number",
          "description": "Maximum acceptable packet loss percentage."
        },
        "jitter_ms": {
          "type": "integer",
          "description": "Maximum acceptable jitter in milliseconds."
        }
      }
    },
    "enabled": {
      "type": "boolean",
      "default": true,
      "description": "Whether the rule is active."
    },
    "priority": {
      "type": "integer",
      "description": "Rule evaluation priority. Lower numbers are evaluated first."
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "readOnly": true
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "readOnly": true
    }
  },
  "required": [
    "name"
  ]
}