Palo Alto Networks · JSON Structure

Prisma Access Api Security Rule Structure

SecurityRule schema from Palo Alto Networks Prisma Access Configuration API

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

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

Properties

id name description disabled from to source destination source_user application service category action profile_setting log_setting tag folder position

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-access-api-security-rule-structure.json",
  "name": "SecurityRule",
  "description": "SecurityRule schema from Palo Alto Networks Prisma Access Configuration API",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string",
      "description": "Name of the security rule."
    },
    "description": {
      "type": "string"
    },
    "disabled": {
      "type": "boolean",
      "default": false
    },
    "from": {
      "type": "array",
      "description": "Source security zones.",
      "items": {
        "type": "string"
      }
    },
    "to": {
      "type": "array",
      "description": "Destination security zones.",
      "items": {
        "type": "string"
      }
    },
    "source": {
      "type": "array",
      "description": "Source addresses or address groups.",
      "items": {
        "type": "string"
      }
    },
    "destination": {
      "type": "array",
      "description": "Destination addresses or address groups.",
      "items": {
        "type": "string"
      }
    },
    "source_user": {
      "type": "array",
      "description": "Source user or user group names.",
      "items": {
        "type": "string"
      }
    },
    "application": {
      "type": "array",
      "description": "Applications to match.",
      "items": {
        "type": "string"
      }
    },
    "service": {
      "type": "array",
      "description": "Services or service groups to match.",
      "items": {
        "type": "string"
      }
    },
    "category": {
      "type": "array",
      "description": "URL categories to match.",
      "items": {
        "type": "string"
      }
    },
    "action": {
      "type": "string",
      "description": "Action to take when the rule matches.",
      "enum": [
        "allow",
        "deny",
        "drop",
        "reset-client",
        "reset-server",
        "reset-both"
      ]
    },
    "profile_setting": {
      "type": "object",
      "properties": {
        "group": {
          "type": "array",
          "description": "Security profile group names.",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "log_setting": {
      "type": "string",
      "description": "Log forwarding profile name."
    },
    "tag": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "folder": {
      "type": "string"
    },
    "position": {
      "type": "string",
      "enum": [
        "pre",
        "post"
      ]
    }
  },
  "required": [
    "name",
    "from",
    "to",
    "source",
    "destination",
    "application",
    "action"
  ]
}