Juniper Networks 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..
Juniper Networks Sites Gateway Templates API is one of 263 APIs that Juniper Networks publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Sites Gateway Templates. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, API documentation, a getting-started guide, and rate-limit docs.
This API exposes 1 operation across 1 path, and defines 146 schemas. It is described by OpenAPI 3.2.0, at version 2607.1.1.
Requests are made against 12 base URLs: https://api.mist.com, https://api.gc1.mist.com, https://api.ac2.mist.com, https://api.gc2.mist.com, https://api.gc4.mist.com, https://api.eu.mist.com, https://api.gc3.mist.com, https://api.ac6.mist.com, https://api.gc6.mist.com, https://api.ac5.mist.com, https://api.gc5.mist.com, https://api.gc7.mist.com.
1 operations
1 paths
146 schemas
1 GET
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
Juniper Networks Sites Gateway Templates API declares
2 security schemes
for authenticating requests.
An API key is passed in the header as Authorization (apiToken).
An API key is passed in the header as X-CSRFToken (csrfToken).
By default, every request must be authenticated.
apiToken— Preferred authentication method for automation and integrations. Send the API token in the HTTP Authorization header. Format: Authorization: Token {apitoken} N…csrfToken— Session-based authentication for browser or login/password flows. After a successful [Login]($e/Admins%20Login/login) request, Mist returns a csrftoken cookie.…
Paths & Operations 1
Across 1 path, the API surfaces 1 operation — 1 GET. Each is listed below with its method, path, parameters, and response codes.
Sites Gateway Templates 1
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..
GET
/api/v1/sites/{site_id}/gatewaytemplates/derived
listSiteGatewayTemplatesDerived
Schemas 146
The contract defines 146 schemas that model the data the API accepts and returns. The most detailed are gateway_port_config (48 properties), gateway_template (32 properties), bgp_config (22 properties), network (18 properties). Each schema is shown below with its type and property counts.
service_policy_skyatp_dns_dga_detection_profile2
string
Sky ATP DNS DGA detection profile to apply. enum: default, standard, strict.
tunnel_config_auto_provision2
object
Provider auto-provisioning settings for tunnel endpoints
7 properties
1 required
allow_deny2
string
Allow or deny action for traffic matched by this service policy
gateway_mgmt_auto_signature_update2
object
Schedule for automatic security signature updates
3 properties
idp_profile_matching2
object
Criteria that select signatures for this overwrite rule
3 properties
tunnel_config_version2
string
Only if provider==custom-gre or provider==custom-ipsec. Tunnel version value for custom tunnel configuration. enum: 1, 2.
service_policy_skyatp_dns_tunnel_detection_profile2
string
Sky ATP DNS tunneling detection profile to apply. enum: default, standard, strict.
tunnel_config_auto_provision_provider2
string
Tunnel provider used for automatic endpoint provisioning. enum: jse-ipsec, zscaler-ipsec.
tunnel_config_probe_type2
string
Protocol used by the custom IPsec tunnel health probe. enum: http, icmp.
app_probing_custom_app
object
User-defined application probe definition
10 properties
network_multicast_group
object
Multicast group rendezvous point mapping
1 property
tunnel_config_node1
object
Backup remote tunnel endpoint settings
9 properties
2 required
wan_extra_routes6
object
Additional IPv6 route for a WAN interface
1 property
dhcpd_config_vendor_option_type2
string
Data type used to encode this vendor option value. enum: boolean, hex, int16, int32, ip, string, uint16, uint32.
network_vpn_access_destination_nat_property
object
VPN access destination NAT rule target settings
3 properties
gw_routing_policy_term_matching_protocol_enum
string
enum: aggregate, bgp, direct, ospf, static (SRX Only)
response_http403
object
Standard HTTP 403 permission error response
1 property
gateway_port_vpn_path
object
VPN path settings for traffic that uses a gateway port
5 properties
tunnel_config_enc_algo3
string
Cipher algorithm used by this IKE proposal. enum: 3des, aes128, aes256, aesgcm128, aesgcm256.
bgp_config
object
BGP session configuration. BFD is enabled when either bfdminimuminterval or bfdmultiplier is configured
22 properties
1 required
gateway_path_preferences
object
Gateway path preference that selects among one or more local, WAN, VPN, or tunnel paths
2 properties
gateway_port_wan_type2
string
Only if usage==wan. WAN uplink type configured on the port. enum: broadband, dsl, lte.
protect_re_allowed_service
string
Services allowed through protect-RE filters. enum: icmp, ssh
gateway_wan_type62
string
IPv6 assignment mode for this gateway port interface. enum: autoconf, dhcp, static.
network_vpn_access_config
object
VPN access settings for a network and VPN pair
14 properties
service_policy_secintel_profile2
string
Protection level applied by SecIntel inspection. enum: default, standard, strict.
gateway_matching_rule
object
Gateway matching rule that applies settings when its match keys select a gateway
3 properties
service_policy_antivirus1
object
Malware and virus inspection settings applied by this service policy
3 properties
gw_routing_policy_term_matching_route_exists2
object
Existing route condition that must be satisfied before this term matches
2 properties
tunnel_config_auto_provision_node3
object
Main auto-provisioned tunnel endpoint settings
2 properties
tunnel_provider_options2
object
Provider-specific tunnel options defined by this gateway template
3 properties
protect_re_custom
object
Custom Protect RE ACL entry
3 properties
gateway_mgmt2
object
Management-plane defaults provided by this gateway template
16 properties
tunnel_provider_options_jse2
object
Juniper Secure Edge provisioning options for tunnel endpoints
2 properties
protect_re1
object
Control-plane protection settings for the gateway
5 properties
bgp_config_via2
string
Transport used for this BGP session, such as LAN, tunnel, VPN, or WAN
tunnel_config_protocol2
string
Only if provider==custom-ipsec. Tunnel protocol for custom tunnel negotiation. enum: gre, ipsec.
gateway_matching2
object
Matching rules that select gateways for this template
2 properties
tunnel_config_auto_provision_lat_lng2
object
Geographic coordinate override used for tunnel POP selection
2 properties
2 required
ip_type4
string
IPv4 address assignment mode for this gateway network interface. enum: dhcp, static.
idp_profile_base_profile2
string
Built-in IDP baseline profile inherited before applying overwrites. enum: critical, standard, strict.
gw_routing_policy
object
Gateway routing policy made of ordered match-action terms
1 property
idp_profile
object
Organization IDP profile with a base profile and targeted overwrite rules
7 properties
gw_routing_policy_term_matching_vpn_path_sla2
object
SLA thresholds used when matching a VPN path
3 properties
gateway_port_usage2
string
Logical usage assigned to the port. enum: hacontrol, hadata, lan, wan.
service_policy
object
Site-level service policy that allows or denies traffic for tenants and services
15 properties
gateway_path_type2
string
Gateway path source type, such as local network, WAN interface, VPN path, or tunnel
dhcpd_config3
object
DHCP server defaults provided by this gateway template
1 property
idp_config2
object
Intrusion detection and prevention settings applied by this service policy
4 properties
bgp_config_type2
string
Required if via==lan, via==tunnel or via==wan; BGP session type, internal or external
tunnel_config_node3
object
Main remote tunnel endpoint settings
9 properties
2 required
gateway_wan_type2
string
IPv4 assignment mode for this gateway port interface. enum: dhcp, pppoe, static.
tunnel_provider_options_prisma2
object
Palo Alto Prisma Access provisioning options for tunnel endpoints
1 property
idp_profile_overwrite
object
Override rule that changes the IDP action for matching signatures
3 properties
response_http400
object
Standard HTTP 400 bad request error response
1 property
network_multicast2
object
Settings for multicast routing on this network
3 properties
dhcpd_config_type2
string
IPv4 DHCP mode for this network. enum: local, none, relay.
gateway_wan_ppoe_auth2
string
Authentication protocol used for PPPoE when type==pppoe. enum: chap, none, pap.
dhcpd_config_fixed_binding
object
Static DHCP binding for a client MAC address
3 properties
tunnel_config_ipsec_proposal
object
IPsec proposal settings for custom IPsec tunnels
3 properties
service_policy_skyatp2
object
Threat inspection settings provided by Sky ATP for this service policy
4 properties
ssl_proxy_ciphers_category2
string
Allowed cipher strength category for SSL proxy inspection. enum: medium, strong, weak.
response_http401
object
Standard HTTP 401 authentication error response
1 property
tunnel_provider_options_zscaler2
object
Provider settings for Zscaler tunnel endpoints
15 properties
tunnel_config_node_probe_http2
object
HTTP probe settings for this tunnel node; success from any ICMP or HTTP probe indicates the tunnel is up
2 properties
network_internet_access_static_nat_property
object
Direct-internet static NAT rule target settings
3 properties
gateway_port_config
object
Gateway port configuration for LAN, WAN, tunnel, and HA interfaces
48 properties
1 required
gateway_port_wan_source_nat2
object
Source NAT settings applied to traffic leaving this WAN port
3 properties
dhcpd_config_type62
string
IPv6 DHCP mode for this network. enum: local, none, relay.
gateway_template_type2
string
Gateway template deployment type. enum: spoke, standalone.
service_policy_appqoe1
object
Application QoE settings applied by this service policy
1 property
idp_profile_action2
string
Enforcement action applied when this overwrite rule matches. enum: alert, close, drop.
service_policy_skyatp_dns_tunnel_detection2
object
Detection settings for DNS tunneling threats provided by Sky ATP
2 properties
ip_type2
string
IP assignment mode for the out-of-band management interface. enum: dhcp, static.
gateway_port_dsl_type2
string
If wantype==dsl. DSL technology used by the WAN port. enum: adsl, vdsl.
service_policy_secintel3
object
Threat intelligence settings applied by this service policy
3 properties
service_policy_skyatp_dns_dga_detection2
object
Detection settings for DNS DGA threats provided by Sky ATP
2 properties
dhcpd_config_option_type2
string
Data type used to encode this DHCP option value. enum: boolean, hex, int16, int32, ip, string, uint16, uint32.
idp_profile_matching_severity_value
string
enum: critical, info, major, minor
dhcpd_config_property
object
DHCP server or relay configuration for one network
16 properties
network
object
Organization-level Layer 3 network definition that can be merged into site settings and used for service routes. Networks are used to define the service routes…
18 properties
1 required
bgp_as
BGP AS, value in range 1-4294967294. Can be a Variable (e.g. {{bgpas}} )
gateway_wan_probe_override_probe_profile2
string
WAN probe profile used for health checks on this port. enum: broadband, lte.
response_http404
object
Standard HTTP 404 not found error response
1 property
network_internet_access_destination_nat_property
object
Direct-internet destination NAT rule target settings
4 properties
gateway_path_strategy2
string
Selection strategy used to evaluate the candidate paths. enum: ecmp, ordered, weighted.
network_tenant
object
Tenant address entry for a network
1 property
tunnel_config_auth_algo1
string
Integrity algorithm used by this IPsec proposal. enum: md5, sha1, sha2.
gateway_traffic_shaping3
object
Traffic shaping settings applied to the port
3 properties
service_policy_syslog2
object
Remote logging settings applied by this service policy
2 properties
gateway_path_preferences_path
object
Candidate path within a gateway path preference
9 properties
1 required
service_policy_ssl_proxy3
object
TLS inspection settings applied by this service policy
2 properties
tunnel_config
object
Gateway tunnel configuration for provider-managed or custom tunnels
18 properties
day_of_week1
string
Scheduled weekday for automatic signature updates. enum: any, fri, mon, sat, sun, thu, tue, wed.
tunnel_config_ike_dh_group2
string
Diffie-Hellman group used by this IKE proposal. enum: 1, 14, 15, 16, 19, 2, 20, 21, 24, 5.
tunnel_config_tunnel_mode2
string
Tunnel failover mode used for primary and secondary endpoints. enum: active-active, active-standby.
tunnel_config_enc_algo1
string
Cipher algorithm used by this IPsec proposal. enum: 3des, aes128, aes256, aesgcm128, aesgcm256.
tunnel_via2
string
If via==tunnel, primary or secondary tunnel associated with this BGP neighbor
bgp_config_neighbors
object
Per-neighbor BGP session settings
7 properties
1 required
tunnel_config_auth_algo3
string
Integrity algorithm used by this IKE proposal. enum: md5, sha1, sha2.
gateway_port_config_ip_config2
object
Layer 3 IP configuration for the port
14 properties
network_internal_access2
object
Internal access settings for this network
1 property
gateway_wan_probe_override2
object
Optional WAN health probe override settings for this port
5 properties
gateway_ip_config_property
object
Gateway network interface IP configuration
7 properties
gateway_wan_probe_override_http2
object
HTTP probe settings; success from any ICMP or HTTP probe indicates the WAN is up
2 properties
network_source_nat2
object
Source NAT settings used when non-routed spoke hosts must be reachable from the hub
1 property
gateway_oob_ip_config3
object
Out-of-band management IP defaults in this gateway template
8 properties
gateway_port_vpn_path_bfd_profile2
string
BFD profile used for this VPN path when the VPN type==hubspoke. enum: broadband, lte.
service_policy_skyatp_iot_device_policy2
object
Device threat policy settings provided by Sky ATP for IoT clients
1 property
gateway_port_lte_auth2
string
If wantype==lte. Authentication method used by the LTE uplink. enum: chap, none, pap.
tunnel_config_dh_group2
string
Diffie-Hellman group used by this IPsec proposal. enum: 1, 14, 15, 16, 19, 2, 20, 21, 24, 5.
service_policy_ewf_rule_profile2
string
Enhanced web filtering profile applied by this rule. enum: critical, standard, strict.
ip_type62
string
IPv6 address assignment mode for this gateway network interface. enum: autoconf, dhcp, disabled, static.
gateway_extra_route
object
Gateway IPv4 extra route next-hop settings
1 property
service_policy_ewf_rule
object
Enhanced web filtering rule applied by a service policy
4 properties
gateway_template
object
Gateway Template is applied to a site for gateway(s) in a site.
32 properties
1 required
gateway_port_vpn_path_role2
string
Gateway role for this VPN path; valid values depend on the VPN type. enum: hub, mesh, spoke.
service_policy_skyatp_http_inspection2
object
Web traffic inspection settings provided by Sky ATP
2 properties
gw_routing_policy_term_action2
object
Policy actions applied when this routing policy term matches
11 properties
vrf_config4
object
VRF defaults applied by this gateway template
1 property
gateway_port_wan_arp_policer2
string
Only when wantype==broadband. ARP policer profile applied to the WAN port. enum: default, max, recommended.
network_vpn_access_static_nat_property
object
VPN access static NAT rule target settings
2 properties
app_probing1
object
Application probing configuration for gateway monitoring
3 properties
gateway_vrf_instance
object
Gateway VRF instance and its member networks
1 property
ip_type5
string
IP assignment mode for the node1 out-of-band management interface. enum: dhcp, static.
gateway_extra_route6
object
Gateway IPv6 extra route next-hop settings
1 property
gw_routing_policy_term_matching2
object
Route match criteria that must be satisfied before actions are applied
9 properties
tunnel_config_provider2
string
Tunnel provider used when auto provisioning is disabled. enum: custom-ipsec, custom-gre, jse-ipsec, prisma-ipsec, zscaler-gre, zscaler-ipsec.
gateway_port_config_wan_speedtest_mode2
string
Controls whether Marvis or the scheduler can run speed tests on this WAN port. enum: auto, enabled, disabled.
network_internet_access2
object
Direct internet access and NAT settings for this network
5 properties
tunnel_config_probe
object
Tunnel health probe settings
4 properties
tunnel_config_ike_proposal
object
IKE proposal settings for custom IPsec tunnels
3 properties
gw_routing_policy_term
object
Gateway routing policy term with match criteria and actions
2 properties
service_policy_skyatp_http_inspection_profile2
string
Sky ATP HTTP inspection profile to apply. enum: standard, strict.
response_http429
object
Standard HTTP 429 rate limit error response
1 property
dhcpd_config_vendor_option
object
Vendor-encapsulated DHCP option value
2 properties
app_probing_custom_app_protocol2
string
Probe protocol used by this custom application definition. enum: http, icmp.
protect_re_custom_protocol2
string
Transport protocol matched by this custom Protect RE ACL. enum: any, icmp, tcp, udp.
tunnel_config_ike_mode2
string
Only if provider==custom-ipsec. IKE negotiation mode for the tunnel. enum: aggressive, main.
dhcpd_config_option
object
Custom DHCP option value
2 properties
gateway_oob_ip_config_node12
object
Out-of-band management IP configuration override for node1 in an HA cluster
7 properties
gateway_traffic_shaping1
object
Traffic shaping settings applied to this VPN path
3 properties
tunnel_config_auto_provision_node1
object
Backup auto-provisioned tunnel endpoint settings
2 properties
tunnel_provider_options_zscaler_sub_location
object
Zscaler sub-location settings for a specific network
14 properties
gateway_port_duplex2
string
Ethernet duplex mode configured on the port. enum: auto, full, half.
wan_extra_routes
object
Additional IPv4 route for a WAN interface
1 property
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Juniper Networks 12
Other APIs Juniper Networks publishes across the network.
Junos PyEZ (Python API)
JSNAPy API
Juniper Networks Allowlists and Blocklists API
Juniper Networks Analytics API
Juniper Networks Audit Logs API
Juniper Networks Authentication API
Juniper Networks BGP Routers API
Juniper Networks Blueprints API
Juniper Networks Clients API
Juniper Networks Configlets API
Juniper Networks Configuration API
Juniper Networks Connectivity Templates API
#Sites Gateway Templates
Where this information came from
This is an independent, third-party profile of Juniper Networks Sites Gateway Templates API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.