Palo Alto Networks · JSON Structure

Cloud Ngfw Api Firewall Structure

A Cloud NGFW firewall instance deployed in an AWS VPC.

Type: object Properties: 3
Cloud SecurityCybersecurityFirewallNetwork SecuritySASESOARThreat IntelligenceXDR

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

Properties

FirewallName FirewallEntry FirewallStatus

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/cloud-ngfw-api-firewall-structure.json",
  "name": "Firewall",
  "description": "A Cloud NGFW firewall instance deployed in an AWS VPC.",
  "type": "object",
  "properties": {
    "FirewallName": {
      "type": "string"
    },
    "FirewallEntry": {
      "type": "object",
      "properties": {
        "Description": {
          "type": "string"
        },
        "VpcId": {
          "type": "string",
          "description": "AWS VPC ID where the firewall is deployed."
        },
        "AssociatedRuleStack": {
          "type": "string",
          "description": "Name of the rule stack associated with this firewall."
        },
        "SubnetMappings": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "SubnetId": {
                "type": "string",
                "description": "AWS subnet ID for the firewall endpoint."
              },
              "AvailabilityZone": {
                "type": "string"
              }
            }
          }
        },
        "Tags": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "Key": {
                "type": "string"
              },
              "Value": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "FirewallStatus": {
      "type": "object",
      "properties": {
        "FirewallStatus": {
          "type": "string",
          "enum": [
            "PROVISIONING",
            "ACTIVE",
            "DELETING",
            "FAILED"
          ]
        },
        "Attachments": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "SubnetId": {
                "type": "string"
              },
              "EndpointId": {
                "type": "string"
              },
              "Status": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}