Palo Alto Networks · JSON Structure

Pan Os Rest Api Nat Rule Structure

A NAT policy rule defining source or destination address translation for matching traffic.

Type: object Properties: 12
Cloud SecurityCybersecurityFirewallNetwork SecuritySASESOARThreat IntelligenceXDR

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

Properties

@name from to source destination service source-translation destination-translation nat-type disabled description tag

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/pan-os-rest-api-nat-rule-structure.json",
  "name": "NatRule",
  "description": "A NAT policy rule defining source or destination address translation for matching traffic.",
  "type": "object",
  "properties": {
    "@name": {
      "type": "string",
      "description": "Unique name of the NAT rule."
    },
    "from": {
      "type": "object",
      "properties": {
        "member": {
          "type": "array",
          "description": "Source zones.",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "to": {
      "type": "object",
      "properties": {
        "member": {
          "type": "array",
          "description": "Destination zones.",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "source": {
      "type": "object",
      "properties": {
        "member": {
          "type": "array",
          "description": "Source addresses.",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "destination": {
      "type": "object",
      "properties": {
        "member": {
          "type": "array",
          "description": "Destination addresses.",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "service": {
      "type": "string",
      "description": "Service object or any."
    },
    "source-translation": {
      "type": "object",
      "description": "Source address translation settings.",
      "properties": {
        "dynamic-ip-and-port": {
          "type": "object",
          "properties": {
            "interface-address": {
              "type": "object",
              "properties": {
                "interface": {
                  "type": "string"
                }
              }
            },
            "translated-address": {
              "type": "object",
              "properties": {
                "member": {
                  "type": "array",
                  "items": {
                    "type": "string"
                  }
                }
              }
            }
          }
        },
        "static-ip": {
          "type": "object",
          "properties": {
            "translated-address": {
              "type": "string"
            },
            "bi-directional": {
              "type": "string",
              "enum": [
                "yes",
                "no"
              ]
            }
          }
        }
      }
    },
    "destination-translation": {
      "type": "object",
      "description": "Destination address translation settings.",
      "properties": {
        "translated-address": {
          "type": "string"
        },
        "translated-port": {
          "type": "string"
        }
      }
    },
    "nat-type": {
      "type": "string",
      "enum": [
        "ipv4",
        "nat64",
        "nptv6"
      ]
    },
    "disabled": {
      "type": "string",
      "enum": [
        "yes",
        "no"
      ]
    },
    "description": {
      "type": "string"
    },
    "tag": {
      "type": "object",
      "properties": {
        "member": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    }
  }
}