Mist Sites Gateway Templates API
The API Endpoints for the Gateway Templates at the site level can be used to get the site derived networks, meaning the org level configuration with the site variables resolved..
OpenAPI Specification
openapi: 3.1.0
info:
contact:
email: tmunzer@juniper.net
name: Thomas Munzer
description: '> Version: **2606.1.1**
>
> Date: **July 10, 2026**
<div class="notification"> NOTE:<br>Some important API changes will be introduced. Please make sure to read the <a href="https://www.juniper.net/documentation/us/en/software/mist/api/http/guides/important-api-changes">announcements</a> </div>
---
## Additional Documentation
* [Mist Automation Guide](https://www.juniper.net/documentation/us/en/software/mist/automation-integration/index.html)
* [Mist Location SDK](https://www.juniper.net/documentation/us/en/software/mist/location-services/topics/concept/mist-how-get-mist-sdk.html)
* [Mist Product Updates](https://www.juniper.net/documentation/us/en/software/mist/product-updates/)
## Helpful Resources
* [API Sandbox and Exercises](https://api-class.mist.com/)
* [Postman Collection, Runners and Webhook Samples](https://www.postman.com/juniper-mist/workspace/mist-systems-s-public-workspace)
* [Python Script Examples](https://github.com/tmunzer/mist_library)
* [API Demo Apps](https://apps.mist-lab.fr/)
* [Juniper Blog](https://blogs.juniper.net/)
## Mist Web Browser Extension:
* Google Chrome, Microsoft Edge and other Chromium-based browser: [Chrome Web Store](https://chromewebstore.google.com/detail/mist-extension/ejhpdcljeamillfhdihkkmoakanpbplh)
* Firefox: [Firefox Add-ons](https://addons.mozilla.org/en-US/firefox/addon/mist-extension/)
---'
license:
name: MIT
url: https://raw.githubusercontent.com/tmunzer/Mist-OAS3.0/main/LICENSE
title: Mist Admins Sites Gateway Templates API
version: 2606.1.1
x-logo:
altText: Juniper-MistAI
backgroundColor: '#FFFFFF'
url: https://www.mist.com/wp-content/uploads/logo.png
servers:
- description: Mist Global 01
url: https://api.mist.com
- description: Mist Global 02
url: https://api.gc1.mist.com
- description: Mist Global 03
url: https://api.ac2.mist.com
- description: Mist Global 04
url: https://api.gc2.mist.com
- description: Mist Global 05
url: https://api.gc4.mist.com
- description: Mist EMEA 01
url: https://api.eu.mist.com
- description: Mist EMEA 02
url: https://api.gc3.mist.com
- description: Mist EMEA 03
url: https://api.ac6.mist.com
- description: Mist EMEA 04
url: https://api.gc6.mist.com
- description: Mist APAC 01
url: https://api.ac5.mist.com
- description: Mist APAC 02
url: https://api.gc5.mist.com
- description: Mist APAC 03
url: https://api.gc7.mist.com
security:
- apiToken: []
- csrfToken: []
tags:
- description: The API Endpoints for the Gateway Templates at the site level can be used to get the site derived networks, meaning the org level configuration with the site variables resolved..
name: Sites Gateway Templates
paths:
/api/v1/sites/{site_id}/gatewaytemplates/derived:
parameters:
- $ref: '#/components/parameters/site_id'
get:
description: Get the list of derived Gateway Templates a Site
operationId: listSiteGatewayTemplatesDerived
parameters:
- description: Whether resolve the site variables
in: query
name: resolve
schema:
type: boolean
responses:
'200':
$ref: '#/components/responses/GatewaytemplatesArray'
'400':
$ref: '#/components/responses/HTTP400'
'401':
$ref: '#/components/responses/HTTP401'
'403':
$ref: '#/components/responses/HTTP403'
'404':
$ref: '#/components/responses/HTTP404'
'429':
$ref: '#/components/responses/HTTP429'
summary: listSiteGatewayTemplatesDerived
tags:
- Sites Gateway Templates
components:
schemas:
network_source_nat:
additionalProperties: false
description: If `routed`==`false` (usually at Spoke), but some hosts needs to be reachable from Hub
properties:
external_ip:
description: External source NAT IP or subnet used when spoke hosts must be reachable from the hub
examples:
- 172.16.0.8/30
type: string
type: object
routing_policy_term_action_prepend_as_path:
description: When used as export policy, optional. By default, the local AS will be prepended, to change it. Can be a Variable (e.g. `{{as_path}}`)
items:
examples:
- 65000 400
type: string
type: array
vlan_id_with_variable:
description: VLAN ID, either numeric or expressed as a template variable string
oneOf:
- type: string
- maximum: 4094
minimum: 1
type: integer
network_tenant:
additionalProperties: false
description: Tenant address entry for a network
properties:
addresses:
$ref: '#/components/schemas/network_tenant_addresses'
description: IP addresses or subnets assigned to this tenant in the network
type: object
gateway_port_reth_nodes:
description: SSR only - supporting vlan-based redundancy (matching the size of `networks`)
examples:
- - node0
- node1
items:
type: string
type: array
network_routed_for_networks:
description: For a Network (usually LAN), it can be routable to other networks (e.g. OSPF)
items:
examples:
- pos
type: string
type: array
service_policy_skyatp_dns_dga_detection_profile:
description: 'enum: `default`, `standard`, `strict`'
enum:
- default
- standard
- strict
type: string
bgp_config_neighbors:
additionalProperties: false
description: Per-neighbor BGP session settings
properties:
disabled:
default: false
description: If true, the BGP session to this neighbor will be administratively disabled/shutdown
type: boolean
export_policy:
description: Export policy applied only to this BGP neighbor
type: string
hold_time:
default: 90
description: BGP hold time for this neighbor, in seconds
maximum: 65535
minimum: 0
type: integer
import_policy:
description: Import policy applied only to this BGP neighbor
type: string
multihop_ttl:
description: Assuming BGP neighbor is directly connected
maximum: 255
minimum: 0
type: integer
neighbor_as:
$ref: '#/components/schemas/bgp_as'
description: Autonomous System (AS) number of this BGP neighbor
tunnel_via:
$ref: '#/components/schemas/tunnel_via'
description: If `via`==`tunnel`, primary or secondary tunnel associated with this BGP neighbor
required:
- neighbor_as
type: object
id:
description: Unique ID of the object instance in the Mist Organization
examples:
- 53f10664-3ce8-4c27-b382-0ef66432349f
format: uuid
readOnly: true
type: string
gateway_mgmt_admin_sshkeys:
description: For SSR only, as direct root access is not allowed
examples:
- - ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAA...Wxa6p6UW0ZbcP john@host
items:
type: string
type: array
tunnel_config_enc_algo:
default: aes256
description: 'enum: `3des`, `aes128`, `aes256`, `aes_gcm128`, `aes_gcm256`'
enum:
- 3des
- aes128
- aes256
- aes_gcm128
- aes_gcm256
type:
- string
- 'null'
service_policy_skyatp_http_inspection:
additionalProperties: false
description: Sky ATP HTTP inspection settings
properties:
enabled:
description: Whether Sky ATP HTTP inspection is enabled
type: boolean
profile:
$ref: '#/components/schemas/service_policy_skyatp_http_inspection_profile'
description: Sky ATP HTTP inspection profile to apply
type: object
dhcpd_config_option_type:
description: 'enum: `boolean`, `hex`, `int16`, `int32`, `ip`, `string`, `uint16`, `uint32`'
enum:
- boolean
- hex
- int16
- int32
- ip
- string
- uint16
- uint32
type: string
dhcpd_config_type:
default: local
description: 'enum: `local` (DHCP Server), `none`, `relay` (DHCP Relay)'
enum:
- local
- none
- relay
type: string
gw_routing_policy_term_action_add_community:
description: BGP communities added to routes matched by a gateway routing policy term
items:
examples:
- '3900190'
type: string
type: array
app_probing_custom_app_protocol:
default: http
description: 'Probe protocol for a custom application. enum: `http`, `icmp`'
enum:
- http
- icmp
type: string
gw_routing_policy_term:
additionalProperties: false
description: Gateway routing policy term with match criteria and actions
properties:
actions:
$ref: '#/components/schemas/gw_routing_policy_term_action'
description: Policy actions applied when this routing policy term matches
matching:
$ref: '#/components/schemas/gw_routing_policy_term_matching'
description: Route match criteria that must be satisfied before actions are applied
type: object
gateway_port_vpn_path_role:
default: spoke
description: 'If the VPN `type`==`hub_spoke`, enum: `hub`, `spoke`. If the VPN `type`==`mesh`, enum: `mesh`'
enum:
- hub
- mesh
- spoke
type: string
gateway_wan_probe_override_probe_profile:
default: broadband
description: 'WAN probe profile used for health checks on this port. enum: `broadband`, `lte`'
enum:
- broadband
- lte
type: string
tunnel_config_auth_algo:
description: 'enum: `md5`, `sha1`, `sha2`'
enum:
- md5
- sha1
- sha2
type: string
gateway_wan_type:
default: dhcp
description: 'enum: `dhcp`, `pppoe`, `static`'
enum:
- dhcp
- pppoe
- static
type: string
response_http400:
additionalProperties: false
description: Standard HTTP 400 bad request error response
properties:
detail:
description: Human-readable explanation of the bad request error
examples:
- 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
type: string
type: object
tunnel_config_auto_provision_node:
description: Auto-provisioned tunnel endpoint settings
properties:
probe_ips:
$ref: '#/components/schemas/strings'
description: Probe IP addresses used to monitor auto-provisioned tunnel reachability
wan_names:
$ref: '#/components/schemas/tunnel_config_auto_provision_node_wan_names'
description: WAN interface names used by the auto-provisioned tunnel endpoint
network_multicast_group:
additionalProperties: false
description: Multicast group rendezvous point mapping
properties:
rp_ip:
description: RP (rendezvous point) IP address
type: string
type: object
bgp_config_via:
default: lan
description: 'enum: `lan`, `tunnel`, `vpn`, `wan`'
enum:
- lan
- tunnel
- vpn
- wan
type: string
tunnel_config_probe:
additionalProperties: false
description: Tunnel health probe settings
properties:
interval:
description: How often to trigger the probe
type: integer
threshold:
description: Number of consecutive misses before declaring the tunnel down
type: integer
timeout:
description: Time within which to complete the connectivity check
type: integer
type:
$ref: '#/components/schemas/tunnel_config_probe_type'
description: Protocol used by the custom IPsec tunnel health probe
type: object
protect_re_allowed_service:
description: 'Services allowed through protect-RE filters. enum: `icmp`, `ssh`'
enum:
- icmp
- ssh
type: string
tunnel_config_node_hosts:
description: Remote gateway host addresses for a tunnel node
items:
description: IP address of the remote host
type: string
type: array
gateway_port_usage:
description: 'port usage name. enum: `ha_control`, `ha_data`, `lan`, `wan`'
enum:
- ha_control
- ha_data
- lan
- wan
type: string
gateway_port_config_ip_config:
additionalProperties: false
description: Junos IP configuration for a gateway port interface
properties:
dns:
$ref: '#/components/schemas/gateway_ip_config_dns_servers'
description: Resolver server IP addresses used by this interface, except on out-of-band interfaces such as vme, em0, or fxp0
dns_suffix:
$ref: '#/components/schemas/gateway_ip_config_dns_suffix'
description: DNS search suffixes used by this interface, except on out-of-band interfaces such as vme, em0, or fxp0
gateway:
description: Except for out-of_band interface (vme/em0/fxp0). Interface Default Gateway IP address (i.e. "192.168.1.1") or a Variable (i.e. "{{myvar}}")
examples:
- 192.168.1.1
type: string
gateway6:
description: Except for out-of_band interface (vme/em0/fxp0). Interface Default Gateway IPv6 Address (i.e. "2001:db8::1") or a Variable (i.e. "{{myvar}}")
examples:
- 2001:db8::1
type: string
ip:
description: Interface IP address (i.e. "192.168.1.8") or a Variable (i.e. "{{myvar}}")
examples:
- 192.168.1.8
format: ipv4
type: string
ip6:
description: Interface IPv6 Address (i.e. "2001:db8::123") or a Variable (i.e. "{{myvar}}")
examples:
- 2001:db8::123
format: ipv6
type: string
netmask:
description: Used only if `subnet` is not specified in `networks`. Interface Netmask (i.e. "/24") or a Variable (i.e. "{{myvar}}")
examples:
- /24
type: string
netmask6:
description: Used only if `subnet` is not specified in `networks`. Interface IPv6 Netmask (i.e. "/64") or a Variable (i.e. "{{myvar}}")
examples:
- /64
type: string
network:
description: Optional, the network to be used for mgmt
type: string
poser_password:
description: Password used for PPPoE when `type`==`pppoe`
format: password
type: string
pppoe_auth:
$ref: '#/components/schemas/gateway_wan_ppoe_auth'
description: Authentication protocol used for PPPoE when `type`==`pppoe`
pppoe_username:
description: Username used for PPPoE when `type`==`pppoe`
type: string
type:
$ref: '#/components/schemas/gateway_wan_type'
description: IPv4 assignment mode for this gateway port interface
type6:
$ref: '#/components/schemas/gateway_wan_type6'
description: IPv6 assignment mode for this gateway port interface
type: object
gateway_vrf_instance:
additionalProperties: false
description: Gateway VRF instance and its member networks
examples:
- networks:
- CORP_NET
- MGMT_NET
properties:
networks:
$ref: '#/components/schemas/strings'
description: Network names included in this gateway VRF instance
type: object
gw_routing_policy_term_action_add_target_vrfs:
description: For SSR, target VRFs used by a hub when leaking VRF routes to spokes
items:
type: string
type: array
routing_policy_term_matching_as_path:
description: BGP AS path values used as routing-policy match criteria
items:
$ref: '#/components/schemas/bgp_as'
type: array
gateway_path_preferences_path:
additionalProperties: false
description: Candidate path within a gateway path preference
properties:
cost:
description: Relative cost assigned to this path for gateway path selection
type: integer
disabled:
description: For SSR Only. `true`, if this specific path is undesired
type: boolean
gateway_ip:
description: Only if `type`==`local`, if a different gateway is desired
type: string
internet_access:
description: Only if `type`==`vpn`, if this vpn path can be used for internet
type: boolean
name:
description: "Required when \n * `type`==`vpn`: the name of the VPN Path to use \n * `type`==`wan`: the name of the WAN interface to use"
type: string
networks:
$ref: '#/components/schemas/gateway_path_preferences_path_networks'
description: List of network names used when `type`==`local`
target_ips:
$ref: '#/components/schemas/gateway_path_preferences_path_target_ips'
description: List of destination IP addresses to replace when `type`==`local`
type:
$ref: '#/components/schemas/gateway_path_type'
description: Gateway path source type, such as local network, WAN interface, VPN path, or tunnel
wan_name:
description: Optional if `type`==`vpn`; WAN interface name associated with the VPN path
examples:
- wan0
type: string
required:
- type
type: object
app_probing:
additionalProperties: false
description: Application reachability probing settings for gateway management
properties:
apps:
$ref: '#/components/schemas/app_probing_apps'
description: Predefined application keys to probe
custom_apps:
$ref: '#/components/schemas/app_probing_custom_apps'
description: User-defined application probe definitions
enabled:
description: Whether gateway application probing is enabled
type: boolean
type: object
service_policy_ssl_proxy:
additionalProperties: false
description: SRX SSL proxy inspection settings for a service policy
properties:
ciphers_category:
$ref: '#/components/schemas/ssl_proxy_ciphers_category'
description: Allowed cipher strength category for SSL proxy inspection
enabled:
default: false
description: Whether SSL proxy inspection is enabled for the service policy
type: boolean
type: object
gateway_path_preferences_path_target_ips:
description: Destination IP addresses to replace when `type`==`local`
items:
type: string
type: array
dhcpd_config_property:
additionalProperties: false
description: DHCP server or relay configuration for one network
properties:
dns_servers:
$ref: '#/components/schemas/dhcpd_config_dns_servers'
description: If `type`==`local` or `type6`==`local`, DNS servers advertised to DHCP clients
dns_suffix:
$ref: '#/components/schemas/dhcpd_config_dns_suffix'
description: If `type`==`local` or `type6`==`local`, DNS search suffixes advertised to DHCP clients
fixed_bindings:
$ref: '#/components/schemas/dhcpd_config_fixed_bindings'
description: If `type`==`local` or `type6`==`local`, fixed client bindings for local DHCP service
gateway:
description: If `type`==`local` - optional, `ip` will be used if not provided
examples:
- 192.168.70.1
type: string
ip6_end:
description: If `type6`==`local`, ending IPv6 address for the DHCP lease pool
examples:
- 2607:f8b0:4005:808::ff
type: string
ip6_start:
description: If `type6`==`local`, starting IPv6 address for the DHCP lease pool
examples:
- 2607:f8b0:4005:808::2
type: string
ip_end:
description: If `type`==`local`, ending IPv4 address for the DHCP lease pool
examples:
- 192.168.70.200
type: string
ip_start:
description: If `type`==`local`, starting IPv4 address for the DHCP lease pool
examples:
- 192.168.70.100
type: string
lease_time:
default: 86400
description: In seconds, lease time has to be between 3600 [1hr] - 604800 [1 week], default is 86400 [1 day]
maximum: 604800
minimum: 3600
type: integer
options:
$ref: '#/components/schemas/dhcpd_config_options'
description: If `type`==`local` or `type6`==`local`, custom DHCP options advertised to clients
server_id_override:
default: false
description: "`server_id_override`==`true` means the device, when acts as DHCP relay and forwards DHCP responses from DHCP server to clients, \nshould overwrite the Sever Identifier option (i.e. DHCP option 54) in DHCP responses with its own IP address."
type: boolean
servers:
$ref: '#/components/schemas/dhcpd_config_servers'
description: If `type`==`relay`, upstream IPv4 DHCP servers
serversv6:
$ref: '#/components/schemas/dhcpd_config_servers6'
description: If `type6`==`relay`, upstream IPv6 DHCP servers
type:
$ref: '#/components/schemas/dhcpd_config_type'
description: IPv4 DHCP mode for this network
type6:
$ref: '#/components/schemas/dhcpd_config_type6'
description: IPv6 DHCP mode for this network
vendor_encapsulated:
$ref: '#/components/schemas/dhcpd_config_vendor_options'
description: If `type`==`local` or `type6`==`local`, vendor-encapsulated DHCP options advertised to clients
type: object
routing_policy_term_matching_prefix:
description: zero or more criteria/filter can be specified to match the term, all criteria have to be met
items:
examples:
- 192.168.0.0/16-30
type: string
type: array
service_policy_antivirus:
additionalProperties: false
description: SRX antivirus inspection settings for a service policy
properties:
avprofile_id:
description: Organization-level antivirus profile ID; takes precedence over inline `profile` settings
format: uuid
type: string
enabled:
default: false
description: Whether antivirus inspection is enabled for the service policy
type: boolean
profile:
description: Antivirus profile name to apply, such as `default`, `noftp`, `httponly`, or an AV profile key
type: string
type: object
tunnel_via:
default: primary
description: 'If `via`==`tunnel`, specifies which tunnel (primary/secondary) this neighbor is associated with. enum: `primary`, `secondary`'
enum:
- primary
- secondary
type: string
idp_profile_matching_dst_subnet:
description: Destination CIDR subnets matched by an IDP profile overwrite
items:
examples:
- 63.1.2.0/24
type: string
type: array
networks:
description: List of organization network definitions
items:
$ref: '#/components/schemas/network'
type: array
dhcpd_config_options:
additionalProperties:
$ref: '#/components/schemas/dhcpd_config_option'
description: If `type`==`local` or `type6`==`local`. Property key is the DHCP option number
type: object
gateway_port_vpn_path:
additionalProperties: false
description: VPN path settings for traffic that uses a gateway port
properties:
bfd_profile:
$ref: '#/components/schemas/gateway_port_vpn_path_bfd_profile'
description: BFD profile used for this VPN path when the VPN `type`==`hub_spoke`
bfd_use_tunnel_mode:
default: false
description: Only if the VPN `type`==`hub_spoke`. Whether to use tunnel mode. SSR only
type: boolean
preference:
description: Only if the VPN `type`==`hub_spoke`. For a given VPN, when `path_selection.strategy`==`simple`, the preference for a path (lower is preferred)
type: integer
role:
$ref: '#/components/schemas/gateway_port_vpn_path_role'
description: Gateway role for this VPN path; valid values depend on the VPN `type`
traffic_shaping:
$ref: '#/components/schemas/gateway_traffic_shaping'
description: Traffic shaping settings applied to this VPN path
type: object
dhcpd_config_vendor_option:
additionalProperties: false
description: Vendor-encapsulated DHCP option value
properties:
type:
$ref: '#/components/schemas/dhcpd_config_vendor_option_type'
description: Data type used to encode this vendor option value
value:
description: Option value to send for this vendor option
type: string
type: object
service_policy_skyatp_dns_tunnel_detection_profile:
description: 'enum: `default`, `standard`, `strict`'
enum:
- default
- standard
- strict
type: string
tunnel_config_ike_dh_group:
default: '14'
description: 'Diffie-Hellman group for IKE phase 1. enum: `1`, `14`, `15`, `16`, `19`, `2`, `20`, `21`, `24`, `5`. `14` is the default 2048-bit group; `19`, `20`, `21`, and `24` are ECP groups'
enum:
- '1'
- '14'
- '15'
- '16'
- '19'
- '2'
- '20'
- '21'
- '24'
- '5'
type: string
gateway_extra_route6:
additionalProperties: false
description: Gateway IPv6 extra route next-hop settings
properties:
via:
description: Next-hop IPv6 address for the gateway extra route
format: ipv6
type: string
type: object
service_policy_ewf:
description: Enhanced web filtering rules applied by a service policy
items:
$ref: '#/components/schemas/service_policy_ewf_rule'
type: array
gateway_port_config_wan_networks:
description: Only if `usage`==`wan`. If some networks are connected to this WAN port, it can be added here so policies can be defined
items:
type: string
type: array
bgp_as:
anyOf:
- type: string
- maximum: 4294967294
minimum: 1
type: integer
description: BGP AS, value in range 1-4294967294. Can be a Variable (e.g. `{{bgp_as}}` )
examples:
- 65000
tunnel_config_node_wan_names:
description: Interface names that source tunnel traffic for a tunnel node
items:
type: string
type: array
gw_routing_policy_term_matching_vpn_path_sla:
additionalProperties: false
description: SLA thresholds used when matching VPN paths
properties:
max_jitter:
description: Maximum jitter threshold allowed for the VPN path
type:
- integer
- 'null'
max_latency:
description: Maximum latency threshold allowed for the VPN path
examples:
- 1500
type:
- integer
- 'null'
max_loss:
description: Maximum packet-loss threshold allowed for the VPN path
examples:
- 30
type:
- integer
- 'null'
type: object
network_multicast_groups:
additionalProperties:
$ref: '#/components/schemas/network_multicast_group'
description: Group address to RP (rendezvous point) mapping. Property Key is the CIDR (example "225.1.0.3/32")
type: object
dhcpd_config_vendor_options:
additionalProperties:
$ref: '#/components/schemas/dhcpd_config_vendor_option'
description: "If `type`==`local` or `type6`==`local`. Property key is <enterprise number>:<sub option code>, with\n * enterprise number: 1-65535 (https://www.iana.org/assignments/enterprise-numbers/enterprise-numbers)\n * sub option code: 1-255, sub-option code"
type: object
gateway_templates:
description: List of gateway device profiles
items:
$ref: '#/components/schemas/gateway_template'
type: array
network_internet_access_static_nat_property:
additionalProperties: false
description: Direct-internet static NAT rule target settings
properties:
internal_ip:
description: The Static NAT destination IP address. Must be an IP address (i.e. "192.168.70.3") or a Variable (i.e. "{{myvar}}")
examples:
- 192.168.70.3
type: string
name:
description: Label for this direct internet static NAT rule
examples:
- pos_station-1
type: string
wan_name:
description: SRX Only. If not set, we configure the nat policies against all WAN ports for simplicity. Can be a Variable (i.e. "{{myvar}}")
examples:
- wan0
type: string
type: object
gateway_port_wan_source_nat:
additionalProperties: false
description: Only if `usage`==`wan`, optional. By default, source-NAT is performed on all WAN Ports using the interface-ip
properties:
disabled:
default: false
description: Or to disable the source-nat
type: boolean
nat6_pool:
description: If alternative nat_pool is desired
examples:
- 2601:1700:43c0:dc0:20c:29ff:fea7:93bc/126
type: string
nat_pool:
description: If alternative nat_pool is desired
examples:
- 64.2.4.0/30
type: string
type: object
tunnel_config_node_internal_ips:
description: Only if `provider`==`zscaler-gre`, `provider`==`jse-ipsec`, `provider`==`custom-ipsec` or `provider`==`custom-gre`
items:
type: string
type: array
gateway_port_vpn_paths:
additionalProperties:
$ref: '#/components/schemas/gateway_port_vpn_path'
description: Property key is the VPN name
type: object
tunnel_config_version:
default: '2'
description: 'Only if `provider`==`custom-gre` or `provider`==`custom-ipsec`. enum: `1`, `2`'
enum:
- '1'
- '2'
type: string
routing_policy_local_preference:
anyOf:
- type: string
- maximum: 4294967295
minimum: 1
type: integer
description: Optional, for an import policy, local_preference can be changed, value in range 1-4294967294. Can be a Variable (e.g. `{{bgp_as}}`)
gateway_path_type:
description: 'enum: `local`, `tunnel`, `vpn`, `wan`'
enum:
- local
- tunnel
- vpn
- wan
type: string
tunnel_provider_options_zscaler:
additionalProperties: false
description: For zscaler-ipsec and zscaler-gre
properties:
aup_block_internet_until_accepted:
default: false
description: Whether Zscaler blocks internet access until the Acceptable Use Policy is accepted
type: boolean
aup_enabled:
default: false
description: Can only be `true` when `auth_required`==`false`, display Acceptable Use Policy (AUP)
type: boolean
aup_force_ssl_inspection:
default: false
description: Proxy HTTPs traffic, requiring Zscaler cert to be installed in browser
type: boolean
aup_timeout_in_days:
description: Required if `aup_enabled`==`true`. Days before AUP is requested again
maximum: 180
minimum: 1
type: integer
auth_required:
default: false
description: Enable this option to enforce user authentication
type: boolean
caution_enabled:
default: false
description: Can only be `true` when `auth_required`==`false`, display caution notification for non-authenticated users
type: boolean
dn_bandwidth:
description: Download bandwidth cap of the link, in Mbps. Disabled if not set
examples:
- 200
format: double
maximum: 99999
minimum: 0.1
# --- truncated at 32 KB (132 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/mist/refs/heads/main/openapi/mist-sites-gateway-templates-api-openapi.yml