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..
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..
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/mist-sites-gateway-templates-api"
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.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 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:
dhcpd_config_servers:
description: If `type`==`relay`, upstream IPv4 DHCP servers
examples:
- - 11.2.3.4
items:
type: string
type: array
wan_extra_routes6:
additionalProperties: false
description: Additional IPv6 route for a WAN interface
properties:
via:
description: IPv6 next-hop address for this WAN extra route
format: ipv6
type: string
type: object
gateway_mgmt:
additionalProperties: false
description: Gateway management-plane and access settings
properties:
admin_sshkeys:
$ref: '#/components/schemas/gateway_mgmt_admin_sshkeys'
description: SSR-only SSH public keys for administrative access
app_probing:
$ref: '#/components/schemas/app_probing'
description: Application probing configuration for gateway monitoring
app_usage:
description: Consumes uplink bandwidth, requires WA license
type: boolean
auto_signature_update:
$ref: '#/components/schemas/gateway_mgmt_auto_signature_update'
description: Schedule for automatic security signature updates
config_revert_timer:
default: 10
description: Rollback timer for commit confirmed
maximum: 30
minimum: 1
type: integer
disable_console:
default: false
description: For SSR and SRX, disable console port
type: boolean
disable_oob:
default: false
description: For SSR and SRX, disable management interface
type: boolean
disable_usb:
default: false
description: For SSR and SRX, disable usb interface
type: boolean
fips_enabled:
default: false
description: Whether FIPS mode is enabled on the gateway
type: boolean
probe_hosts:
$ref: '#/components/schemas/gateway_mgmt_probe_hosts'
description: IPv4 probe targets used for gateway connectivity checks
probe_hostsv6:
$ref: '#/components/schemas/gateway_mgmt_probe_hostsv6'
description: IPv6 probe targets used for gateway connectivity checks
protect_re:
$ref: '#/components/schemas/protect_re'
description: Control-plane protection settings for the gateway
root_password:
description: SRX only. Root password for local gateway access
format: password
type: string
security_log_source_address:
description: IPv4 source address used for gateway security log traffic
examples:
- 192.168.1.1
format: ipv4
type: string
security_log_source_interface:
description: Source interface used for gateway security log traffic
examples:
- ge-0/0/1.0
type: string
type: object
service_policy_skyatp_dns_tunnel_detection_profile:
description: 'enum: `default`, `standard`, `strict`'
enum:
- default
- standard
- strict
type: string
org_id:
description: Unique identifier of a Mist organization
examples:
- a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
format: uuid
readOnly: true
type: string
tunnel_config_node_remote_ids:
description: Only if `provider`==`jse-ipsec` or `provider`==`custom-ipsec`
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
gateway_template_type:
default: standalone
description: 'Gateway template deployment type. enum: `spoke`, `standalone`'
enum:
- spoke
- standalone
examples:
- standalone
type: string
ntp_servers:
description: List of NTP servers specific to this device. By default, those in Site Settings will be used
items:
type: string
type: array
bgp_config:
additionalProperties: false
description: BGP session configuration. BFD is enabled when either bfd_minimum_interval or bfd_multiplier is configured
properties:
auth_key:
description: Optional if `via`==`lan`, `via`==`tunnel` or `via`==`wan`
type: string
bfd_minimum_interval:
default: 350
description: "Optional if `via`==`lan`, `via`==`tunnel` or `via`==`wan`, when bfd_multiplier is configured alone. Default:\n * 1000 if `type`==`external`\n * 350 `type`==`internal`"
maximum: 255000
minimum: 1
type:
- integer
- 'null'
bfd_multiplier:
default: 3
description: Optional if `via`==`lan`, `via`==`tunnel` or `via`==`wan`, when bfd_minimum_interval_is_configured alone
maximum: 255
minimum: 1
type:
- integer
- 'null'
disable_bfd:
default: false
description: Optional if `via`==`lan`, `via`==`tunnel` or `via`==`wan`. BFD provides faster path failure detection and is enabled by default
type: boolean
export:
description: Routing policy applied to routes exported by this BGP session
type: string
export_policy:
description: Default export policies if no per-neighbor policies defined
type: string
extended_v4_nexthop:
description: Optional if `via`==`lan`, `via`==`tunnel` or `via`==`wan`. By default, either inet/net6 unicast depending on neighbor IP family (v4 or v6). For v6 neighbors, to exchange v4 nexthop, which allows dual-stack support, enable this
type: boolean
graceful_restart_time:
default: 0
description: Optional if `via`==`lan`, `via`==`tunnel` or `via`==`wan`. `0` means disable
maximum: 4095
minimum: 0
type: integer
hold_time:
default: 90
description: Optional if `via`==`lan`, `via`==`tunnel` or `via`==`wan`. Default is 90.
maximum: 65535
minimum: 0
type: integer
import:
description: Routing policy applied to routes imported by this BGP session
type: string
import_policy:
description: Optional if `via`==`lan`, `via`==`tunnel` or `via`==`wan`. Default import policies if no per-neighbor policies defined
type: string
local_as:
$ref: '#/components/schemas/bgp_local_as'
description: Required if `via`==`lan`, `via`==`tunnel` or `via`==`wan`; local BGP Autonomous System (AS) number
neighbor_as:
$ref: '#/components/schemas/bgp_as'
description: Default BGP neighbor Autonomous System (AS) number for this session
neighbors:
additionalProperties:
$ref: '#/components/schemas/bgp_config_neighbors'
description: Required if `via`==`lan`, `via`==`tunnel` or `via`==`wan`. If per-neighbor as is desired. Property key is the neighbor address
type: object
networks:
$ref: '#/components/schemas/bgp_config_networks'
description: Optional if `via`==`lan`; networks where BGP neighbors can connect to or from
no_private_as:
default: false
description: Optional if `via`==`lan`, `via`==`tunnel` or `via`==`wan`. If true, we will not advertise private ASNs (AS 64512-65534) to this neighbor
type: boolean
no_readvertise_to_overlay:
default: false
description: Optional if `via`==`lan`, `via`==`tunnel` or `via`==`wan`. By default, we'll re-advertise all learned BGP routers toward overlay
type: boolean
tunnel_name:
description: Optional if `via`==`tunnel`; tunnel name used for this BGP session
type: string
type:
$ref: '#/components/schemas/bgp_config_type'
description: Required if `via`==`lan`, `via`==`tunnel` or `via`==`wan`; BGP session type, internal or external
via:
$ref: '#/components/schemas/bgp_config_via'
description: Transport used for this BGP session, such as LAN, tunnel, VPN, or WAN
vpn_name:
description: Optional if `via`==`vpn`; VPN name used for this BGP session
type: string
wan_name:
description: Optional if `via`==`wan`; WAN interface name used for this BGP session
type: string
required:
- via
type: object
gateway_path_strategy:
default: ordered
description: 'enum: `ecmp`, `ordered`, `weighted`'
enum:
- ecmp
- ordered
- weighted
type: string
gateway_ip_configs:
additionalProperties:
$ref: '#/components/schemas/gateway_ip_config_property'
description: Property key is the network name
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
gw_routing_policy_term_matching_vpn_neighbor_mac:
description: Overlay neighbor MAC addresses used for bgp_config where `via`==`vpn`
items:
type: string
type: array
gateway_vrf_instances:
additionalProperties:
$ref: '#/components/schemas/gateway_vrf_instance'
description: Property key is the VRF instance name
examples:
- CORP_VRF:
networks:
- CORP_NET
- MGMT_NET
type: object
tunnel_config:
additionalProperties: false
description: Gateway tunnel configuration for provider-managed or custom tunnels
properties:
auto_provision:
$ref: '#/components/schemas/tunnel_config_auto_provision'
description: Provider auto-provisioning settings for tunnel endpoints
ike_lifetime:
description: Only if `provider`==`custom-ipsec`. IKE lifetime configured for the custom IPsec tunnel
type: integer
ike_mode:
$ref: '#/components/schemas/tunnel_config_ike_mode'
description: Only if `provider`==`custom-ipsec`. IKE negotiation mode for the tunnel
ike_proposals:
$ref: '#/components/schemas/tunnel_config_ike_proposals'
description: If `provider`==`custom-ipsec`, IKE proposals used for custom IPsec negotiation
ipsec_lifetime:
description: If `provider`==`custom-ipsec`, IPsec lifetime configured for the custom tunnel
type: integer
ipsec_proposals:
$ref: '#/components/schemas/tunnel_config_ipsec_proposals'
description: Only if `provider`==`custom-ipsec`. IPsec proposals used for custom IPsec negotiation
local_id:
description: Required if `provider`==`zscaler-ipsec`, `provider`==`jse-ipsec` or `provider`==`custom-ipsec`
type: string
local_subnets:
$ref: '#/components/schemas/tunnel_config_local_subnets'
description: Local protected subnets advertised by this tunnel
mode:
$ref: '#/components/schemas/tunnel_config_tunnel_mode'
description: Tunnel failover mode used for primary and secondary endpoints
networks:
$ref: '#/components/schemas/tunnel_config_networks'
description: Destination networks reachable through this tunnel
primary:
$ref: '#/components/schemas/tunnel_config_node'
description: Main remote tunnel endpoint settings
probe:
$ref: '#/components/schemas/tunnel_config_probe'
description: Tunnel health probe settings
protocol:
$ref: '#/components/schemas/tunnel_config_protocol'
description: Only if `provider`==`custom-ipsec`. Tunnel protocol for custom tunnel negotiation
provider:
$ref: '#/components/schemas/tunnel_config_provider'
description: Tunnel provider used when auto provisioning is disabled
psk:
description: Required if `provider`==`zscaler-ipsec`, `provider`==`jse-ipsec` or `provider`==`custom-ipsec`
type: string
remote_subnets:
$ref: '#/components/schemas/tunnel_config_remote_subnets'
description: Remote protected subnets reached through policy-based IPsec
secondary:
$ref: '#/components/schemas/tunnel_config_node'
description: Backup remote tunnel endpoint settings
version:
$ref: '#/components/schemas/tunnel_config_version'
description: Only if `provider`==`custom-gre` or `provider`==`custom-ipsec`. Tunnel version value for custom tunnel configuration
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
strings:
description: Unique string values returned or accepted by this schema
items:
type: string
type: array
uniqueItems: true
tunnel_provider_options:
additionalProperties: false
description: Provider-specific options for gateway tunnel auto provisioning
properties:
jse:
$ref: '#/components/schemas/tunnel_provider_options_jse'
description: Juniper Secure Edge provisioning options for tunnel endpoints
prisma:
$ref: '#/components/schemas/tunnel_provider_options_prisma'
description: Palo Alto Prisma Access provisioning options for tunnel endpoints
zscaler:
$ref: '#/components/schemas/tunnel_provider_options_zscaler'
description: Provider settings for Zscaler tunnel endpoints
type: object
network_tenant_addresses:
description: IP addresses or subnets assigned to a network tenant
items:
description: The user/tenant IP address (i.e. "192.168.70.30"), an Subnet (i.e. "192.168.70.0/24") or a Variable (i.e. "{{myvar}}")
examples:
- 192.168.70.30
type: string
type: array
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
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
idp_profile_overwrites:
description: IDP profile overwrite rules applied to the base profile
items:
$ref: '#/components/schemas/idp_profile_overwrite'
type: array
gw_routing_policy_term_matching_protocol_enum:
description: 'enum: `aggregate`, `bgp`, `direct`, `ospf`, `static` (SRX Only)'
enum:
- aggregate
- bgp
- direct
- ospf
- static
type: string
tunnel_config_probe_type:
default: icmp
description: 'Protocol used by the custom IPsec tunnel health probe. enum: `http`, `icmp`'
enum:
- http
- icmp
type: string
allow_deny:
description: 'Policy action value that either allows or denies matching traffic. enum: `allow`, `deny`'
enum:
- allow
- deny
type: string
gateway_port_vpn_path_bfd_profile:
default: broadband
description: 'Only if the VPN `type`==`hub_spoke`. enum: `broadband`, `lte`'
enum:
- broadband
- lte
type: string
gateway_path_preferences_path_networks:
description: Network names used by a local path; required when `type`==`local`
items:
type: string
type: array
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
routing_policy_term_matching_community:
description: BGP community values used as routing-policy match criteria
items:
examples:
- '3900062'
type: string
type: array
gateway_ip_config_property:
additionalProperties: false
description: Gateway network interface IP configuration
properties:
ip:
description: Static IPv4 address for the gateway network interface when `type`==`static`
format: ipv4
type: string
ip6:
description: Static IPv6 address for the gateway network interface when `type6`==`static`
format: ipv6
type: string
netmask:
description: IPv4 netmask or prefix length for the gateway network interface when `type`==`static`
examples:
- /24
type: string
netmask6:
description: IPv6 netmask or prefix length for the gateway network interface when `type6`==`static`
examples:
- 2001:db8:abcd:12::1
type: string
secondary_ips:
$ref: '#/components/schemas/gateway_ip_config_property_second_ips'
description: Additional IPv4 addresses in CIDR notation for this gateway network interface
type:
$ref: '#/components/schemas/ip_type'
description: IPv4 address assignment mode for this gateway network interface
type6:
$ref: '#/components/schemas/ip_type6'
description: IPv6 address assignment mode for this gateway network interface
type: object
gateway_path_type:
description: 'enum: `local`, `tunnel`, `vpn`, `wan`'
enum:
- local
- 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
tunnel_config_ike_proposal:
additionalProperties: false
description: IKE proposal settings for custom IPsec tunnels
properties:
auth_algo:
$ref: '#/components/schemas/tunnel_config_auth_algo'
description: Integrity algorithm used by this IKE proposal
dh_group:
$ref: '#/components/schemas/tunnel_config_ike_dh_group'
description: Diffie-Hellman group used by this IKE proposal
enc_algo:
$ref: '#/components/schemas/tunnel_config_enc_algo'
description: Cipher algorithm used by this IKE proposal
type: object
tunnel_config_protocol:
description: 'Only if `provider`==`custom-ipsec`. enum: `gre`, `ipsec`'
enum:
- gre
- ipsec
type: string
bgp_config_networks:
description: Optional if `via`==`lan`. List of networks where we expect BGP neighbor to connect to/from
items:
type: string
type: array
service_policy_secintel:
additionalProperties: false
description: SRX SecIntel settings for a service policy
properties:
enabled:
default: false
description: Whether SecIntel inspection is enabled for the service policy
type: boolean
profile:
$ref: '#/components/schemas/service_policy_secintel_profile'
description: Protection level applied by SecIntel inspection
secintelprofile_id:
description: Organization-level SecIntel profile ID; takes precedence over inline `profile` settings
type: string
type: object
idp_profile_matching:
additionalProperties: false
description: Criteria that select IDP signatures for an overwrite rule
properties:
attack_name:
$ref: '#/components/schemas/idp_profile_matching_attack_name'
description: Signature names matched by the IDP profile overwrite
dst_subnet:
$ref: '#/components/schemas/idp_profile_matching_dst_subnet'
description: Destination subnets matched by the IDP profile overwrite
severity:
$ref: '#/components/schemas/idp_profile_matching_severity'
description: Threat levels matched by the IDP profile overwrite
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
network_internet_access_destination_nat:
additionalProperties:
$ref: '#/components/schemas/network_internet_access_destination_nat_property'
description: Property key can be an External IP (i.e. "63.16.0.3"), an External IP:Port (i.e. "63.16.0.3:443"), an External Port (i.e. ":443"), an External CIDR (i.e. "63.16.0.0/30"), an External CIDR:Port (i.e. "63.16.0.0/30:443") or a Variable (i.e. "{{myvar}}"). At least one of the `internal_ip` or `port` must be defined
type: object
network_multicast_group:
additionalProperties: false
description: Multicast group rendezvous point mapping
properties:
rp_ip:
description: RP (rendezvous point) IP address
type: string
type: object
gateway_port_lte_auth:
default: none
description: 'if `wan_type`==`lte`. enum: `chap`, `none`, `pap`'
enum:
- chap
- none
- pap
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
service_policy_skyatp_iot_device_policy:
additionalProperties: false
description: Sky ATP IoT device policy settings
properties:
enabled:
description: Whether Sky ATP IoT device policy inspection is enabled
type: boolean
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
gateway_templates:
description: List of gateway device profiles
items:
$ref: '#/components/schemas/gateway_template'
type: array
ip_type6:
default: disabled
description: 'enum: `autoconf`, `dhcp`, `disabled`, `static`'
enum:
- autoconf
- dhcp
- disabled
- static
examples:
- static
type: string
gw_routing_policy_term_matching:
additionalProperties: false
description: Route match criteria for a gateway routing policy term; all specified criteria must match
properties:
as_path:
$ref: '#/components/schemas/routing_policy_term_matching_as_path'
description: AS path values that routes must match
community:
$ref: '#/components/schemas/routing_policy_term_matching_community'
description: BGP communities that routes must match
network:
$ref: '#/components/schemas/strings'
description: Configured network names that routes must match
prefix:
$ref: '#/components/schemas/routing_policy_term_matching_prefix'
description: Route prefixes that routes must match
protocol:
$ref: '#/components/schemas/gw_routing_policy_term_matching_protocol'
description: Routing protocols that routes must match
route_exists:
$ref: '#/components/schemas/gw_routing_policy_term_matching_route_exists'
description: Existing route condition that must be satisfied before this term matches
vpn_neighbor_mac:
$ref: '#/components/schemas/gw_routing_policy_term_matching_vpn_neighbor_mac'
description: Overlay neighbor MAC addresses used as match criteria for BGP sessions with `via`==`vpn`
vpn_path:
$ref: '#/components/schemas/gw_routing_policy_term_matching_vpn_path'
description: Overlay path names used as match criteria for BGP sessions with `via`==`vpn`
vpn_path_sla:
$ref: '#/components/schemas/gw_routing_policy_term_matching_vpn_path_sla'
description: SLA thresholds used when matching a VPN path
type: object
dns_suffix:
description: Global dns settings. To keep compatibility, dns settings in `ip_config` and `oob_ip_config` will overw
# --- 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