Palo Alto Networks · JSON Structure

Prisma Access Api Ike Gateway Structure

IKEGateway schema from Palo Alto Networks Prisma Access Configuration API

Type: object Properties: 8 Required: 3
Cloud SecurityCybersecurityFirewallNetwork SecuritySASESOARThreat IntelligenceXDR

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

Properties

id name version peer_address authentication local_id peer_id folder

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-ike-gateway-structure.json",
  "name": "IKEGateway",
  "description": "IKEGateway schema from Palo Alto Networks Prisma Access Configuration API",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier for the IKE gateway."
    },
    "name": {
      "type": "string",
      "description": "Name of the IKE gateway."
    },
    "version": {
      "type": "string",
      "description": "IKE protocol version.",
      "enum": [
        "ikev1",
        "ikev2",
        "ikev2-preferred"
      ],
      "default": "ikev2-preferred"
    },
    "peer_address": {
      "type": "object",
      "description": "Peer IP address configuration.",
      "properties": {
        "ip": {
          "type": "string",
          "description": "Static peer IP address."
        },
        "dynamic": {
          "type": "boolean",
          "description": "Whether the peer address is dynamic."
        }
      }
    },
    "authentication": {
      "type": "object",
      "description": "IKE authentication configuration.",
      "properties": {
        "pre_shared_key": {
          "type": "string",
          "description": "Pre-shared key for IKE authentication."
        },
        "certificate": {
          "type": "object",
          "properties": {
            "local_certificate": {
              "type": "string",
              "description": "Local certificate profile name."
            }
          }
        }
      }
    },
    "local_id": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "ipaddr",
            "keyid",
            "fqdn",
            "ufqdn"
          ]
        },
        "id": {
          "type": "string"
        }
      }
    },
    "peer_id": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "ipaddr",
            "keyid",
            "fqdn",
            "ufqdn"
          ]
        },
        "id": {
          "type": "string"
        }
      }
    },
    "folder": {
      "type": "string"
    }
  },
  "required": [
    "name",
    "peer_address",
    "authentication"
  ]
}