Palo Alto Networks · JSON Structure

Prisma Access Api Service Connection Structure

ServiceConnection schema from Palo Alto Networks Prisma Access Configuration API

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

ServiceConnection 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 region ipsec_tunnel subnets nat_pool qos_enabled 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-service-connection-structure.json",
  "name": "ServiceConnection",
  "description": "ServiceConnection schema from Palo Alto Networks Prisma Access Configuration API",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier for the service connection."
    },
    "name": {
      "type": "string",
      "description": "Name of the service connection."
    },
    "region": {
      "type": "string",
      "description": "Prisma Access compute region."
    },
    "ipsec_tunnel": {
      "type": "string",
      "description": "Name of the associated IPSec tunnel."
    },
    "subnets": {
      "type": "array",
      "description": "Internal subnets accessible through this connection.",
      "items": {
        "type": "string"
      }
    },
    "nat_pool": {
      "type": "string",
      "description": "NAT pool CIDR for source translation."
    },
    "qos_enabled": {
      "type": "boolean",
      "description": "Whether QoS is enabled on this connection.",
      "default": false
    },
    "folder": {
      "type": "string"
    }
  },
  "required": [
    "name",
    "region",
    "ipsec_tunnel"
  ]
}