Palo Alto Networks · Schema
InterconnectRequest
InterconnectRequest schema from SP Interconnect Manage APIs
Cloud SecurityCybersecurityFirewallNetwork SecuritySASESOARThreat IntelligenceXDR
Properties
| Name | Type | Description |
|---|---|---|
| name | string | |
| region | string | |
| partnerName | string | |
| partnerEmail | string | |
| usage | string | |
| tsgId | string | |
| cloudProvider | string | |
| type | string | |
| ipPool | object | |
| physicalConnection | object | |
| vlanAttachment | object |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "InterconnectRequest",
"description": "InterconnectRequest schema from SP Interconnect Manage APIs",
"$id": "https://raw.githubusercontent.com/api-evangelist/palo-alto-networks/refs/heads/main/json-schema/sase-multitenant-interconnect-api-interconnect-request-schema.json",
"type": "object",
"properties": {
"name": {
"type": "string",
"pattern": "^([-0-9a-z]){1,13}$"
},
"region": {
"type": "string",
"pattern": "\\\\S+"
},
"partnerName": {
"type": "string",
"pattern": "^([a-zA-Z0-9\\s\\-]){1,30}$"
},
"partnerEmail": {
"type": "string",
"pattern": "\\\\S"
},
"usage": {
"type": "string",
"enum": [
"SHARED",
"PER_TENANT"
]
},
"tsgId": {
"type": "string",
"pattern": "^[0-9-]+$"
},
"cloudProvider": {
"type": "string",
"enum": [
"GCP",
"AWS"
]
},
"type": {
"type": "string",
"enum": [
"DEDICATED",
"PARTNER"
]
},
"ipPool": {
"type": "object",
"required": [
"ipProvider"
],
"properties": {
"ipBlocks": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "object",
"required": [
"cidr"
],
"properties": {
"edgeLocation": {
"type": "string"
},
"cidr": {
"type": "array",
"minItems": 1,
"uniqueItems": true,
"items": {
"type": "string"
}
},
"type": {
"type": "string",
"enum": [
"PRIMARY",
"SECONDARY"
]
}
}
}
},
"ipProvider": {
"type": "string",
"enum": [
"SP",
"PANW"
]
}
}
},
"physicalConnection": {
"type": "object",
"required": [
"physicalConnectionName",
"linkType",
"coloFacilities",
"partnerName",
"partnerEmail"
],
"properties": {
"physicalConnectionName": {
"type": "string",
"pattern": "\\\\S"
},
"linkType": {
"type": "string",
"enum": [
"LINK_TYPE_ETHERNET_10G_LR",
"LINK_TYPE_ETHERNET_100G_LR"
]
},
"requestedLinkCount": {
"type": "integer",
"format": "int32"
},
"coloFacilities": {
"type": "array",
"minItems": 1,
"items": {
"type": "string"
}
},
"macSecEnabled": {
"type": "boolean"
},
"partnerName": {
"type": "string",
"pattern": "\\\\S"
},
"partnerEmail": {
"type": "string",
"pattern": "\\\\S"
}
}
},
"vlanAttachment": {
"type": "object",
"required": [
"name",
"bgpPeerAsn",
"bgpPeerBfdSessionInitMode"
],
"properties": {
"name": {
"type": "string",
"pattern": "^([-0-9a-z]){1,13}$"
},
"stackType": {
"type": "string",
"enum": [
"IPV4_ONLY",
"IPV4_IPV6"
]
},
"bandwidth": {
"type": "string",
"enum": [
"BPS_50M",
"BPS_100M",
"BPS_200M",
"BPS_300M",
"BPS_400M",
"BPS_500M",
"BPS_1G",
"BPS_2G",
"BPS_5G",
"BPS_10G"
]
},
"bgpPeerAsn": {
"type": "integer",
"format": "int64",
"minimum": 1
},
"bgpPeerBfdSessionInitMode": {
"type": "string",
"enum": [
"ACTIVE",
"PASSIVE",
"DISABLED"
]
},
"bgpPeerBfdMinTransmitInterval": {
"type": "integer",
"format": "int64",
"maximum": 30000,
"minimum": 1000
},
"bgpPeerBfdMinReceiveInterval": {
"type": "integer",
"format": "int64",
"maximum": 30000,
"minimum": 1000
},
"bgpPeerBfdMultiplier": {
"type": "integer",
"format": "int64",
"maximum": 16,
"minimum": 5
},
"dedicatedConnectionDetails": {
"type": "array",
"items": {
"type": "object",
"properties": {
"edgeAvailability": {
"type": "string"
},
"bandwidth": {
"type": "string",
"enum": [
"BPS_50M",
"BPS_100M",
"BPS_200M",
"BPS_300M",
"BPS_400M",
"BPS_500M",
"BPS_1G",
"BPS_2G",
"BPS_5G",
"BPS_10G"
]
}
},
"required": [
"edgeAvailability"
]
}
},
"primaryAttachmentCustomIpAddress": {
"type": "object",
"description": "Custom IP address configuration for VLAN attachment BGP peering. Both Cloud Router and Customer Router IP addresses must be provided together with matching prefix lengths (/29 or /30). IP addresses must not be in reserved ranges (RFC1918 private IPs, loopback, etc.) and must not be network or broadcast addresses.",
"properties": {
"candidateCloudRouterIpAddress": {
"type": "string",
"description": "Cloud Router IP address in CIDR notation (e.g., 169.254.1.1/29). Must have prefix length /29 or /30 and match the prefix length of candidateCustomerRouterIpAddress.",
"pattern": "^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))/(29|30)$"
},
"candidateCustomerRouterIpAddress": {
"type": "string",
"description": "Customer Router IP address in CIDR notation (e.g., 169.254.1.2/29). Must have prefix length /29 or /30 and match the prefix length of candidateCloudRouterIpAddress.",
"pattern": "^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))/(29|30)$"
}
}
},
"redundantAttachmentCustomIpAddress": {
"type": "object",
"description": "Custom IP address configuration for VLAN attachment BGP peering. Both Cloud Router and Customer Router IP addresses must be provided together with matching prefix lengths (/29 or /30). IP addresses must not be in reserved ranges (RFC1918 private IPs, loopback, etc.) and must not be network or broadcast addresses.",
"properties": {
"candidateCloudRouterIpAddress": {
"type": "string",
"description": "Cloud Router IP address in CIDR notation (e.g., 169.254.1.1/29). Must have prefix length /29 or /30 and match the prefix length of candidateCustomerRouterIpAddress.",
"pattern": "^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))/(29|30)$"
},
"candidateCustomerRouterIpAddress": {
"type": "string",
"description": "Customer Router IP address in CIDR notation (e.g., 169.254.1.2/29). Must have prefix length /29 or /30 and match the prefix length of candidateCloudRouterIpAddress.",
"pattern": "^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))/(29|30)$"
}
}
},
"bgpPeerMd5AuthEnabled": {
"type": "boolean"
}
}
}
},
"required": [
"name",
"region",
"partnerName",
"partnerEmail",
"usage",
"cloudProvider",
"type"
]
}