Juniper Mist AI Sites Network Templates API
The API Endpoints for the Network 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 Mist AI Sites Network Templates API is one of 211 APIs that Juniper Mist AI publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Sites Network Templates. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 1 operation across 1 path, and defines 214 schemas. It is described by OpenAPI 3.1.0, at version 2604.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
214 schemas
1 GET
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 3
Juniper Mist AI Sites Network Templates API declares
3 security schemes
for authenticating requests.
An API key is passed in the header as Authorization (apiToken).
It accepts HTTP basic authentication (basicAuth).
An API key is passed in the header as X-CSRFToken (csrfToken).
By default, every request must be authenticated.
apiToken— Like many other API providers, it’s also possible to generate API Tokens to be used (in HTTP Header) for authentication. An API token ties to a Admin with equa…basicAuth— While our current UI uses Session / Cookie-based authentication, it’s also possible to do Basic Auth.csrfToken— This protects the website against [Cross Site Request Forgery](https://en.wikipedia.org/wiki/Cross-siterequestforgery), all the POST / PUT / DELETE APIs needs…
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 Network Templates 1
The API Endpoints for the Network 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}/networktemplates/derived
listSiteNetworkTemplatesDerived
Schemas 214
The contract defines 214 schemas that model the data the API accepts and returns. The most detailed are switch_port_usage (45 properties), network_template (30 properties), junos_port_config (18 properties), switch_mgmt (16 properties). Each schema is shown below with its type and property counts.
tacacs_auth_servers
array
protect_re_custom_protocol
string
enum: any, icmp, tcp, udp
switch_vrf_instance
object
7 properties
switch_port_usage_reauth_interval
Only if mode!=dynamic and portauth=dot1x reauthentication interval range (min: 10, max: 65535, default: 3600). Set to 0 to disable reauthentication (no-reauthe…
acl_tag_macs
array
Required if - type==mac - type==staticgbp if from matching mac
strings
array
remote_syslog_server
object
13 properties
snmp_vacm_access_item_type
string
enum: contextprefix, defaultcontextprefix
remote_syslog_archive
object
2 properties
junos_port_config_duplex
string
enum: auto, full, half
routing_policy_term_matching_community
array
switch_bgp_config_neighbor
object
5 properties
1 required
snmpv3_config_notify_type
string
enum: inform, trap
switch_port_usage_mtu
Only if mode!=dynamic media maximum transmission unit (MTU) is the largest data unit that can be forwarded without fragmentation. The default value is 1514.
radius_acct_port
Radius Auth Port, value from 1 to 65535, default is 1813
switch_bgp_config_networks
array
List of network names for BGP configuration. When a network is specified, a BGP group will be added to the VRF that network is part of.
tacacs_acct_server
object
4 properties
remote_syslog_severity
string
enum: alert, any, critical, emergency, error, info, notice, warning
radius_coa_port
Radius CoA Port, value from 1 to 65535, default is 3799
switch_port_usage_networks
array
Only if mode==trunk, the list of network/vlans
protect_re_custom_subnet
array
switch_bgp_config_hold_time
Hold time is three times the interval at which keepalive messages are sent. It indicates to the peer the length of time that it should consider the sender vali…
sw_routing_policy_term_matching
object
zero or more criteria/filter can be specified to match the term, all criteria have to be met
4 properties
acl_policy_src_tags
array
ACL Policy Source Tags: - for GBP-based policy, all srctags and dsttags have to be gbp-based - for ACL-based policy, network is required in either the source o…
switch_port_mirroring_egress_port_ids
array
At least one of the inputportidsingress, inputportidsegress or inputnetworksingress should be specified
snmpv3_config_target_address
array
acl_tags
object
ACL Tags to identify traffic source or destination. Key name is the tag name
routing_policy_local_preference
Optional, for an import policy, localpreference can be changed, value in range 1-4294967294. Can be a Variable (e.g. {{bgpas}})
acl_tag
object
Resource tags (type==resource or type==gbpresource) can only be used in dsttags
9 properties
1 required
snmp_usm_engine_type
string
enum: localengine, remoteengine
tacacs_default_role
string
enum: admin, helpdesk, none, read
switch_port_usage_mac_auth_protocol
string
Only if mode!=dynamic and enablemacauth ==true. This type is ignored if mistnac is enabled. enum: eap-md5, eap-peap, pap
snmp_config_trap_version
string
enum: all, v1, v2
snmp_config_client_list_clients
array
snmp_vacm_access_item_prefix_list_item_level
string
enum: authentication, none, privacy
acl_policy_action
object
2 properties
1 required
extra_route
object
6 properties
snmp_vacm_security_to_group_content_item
object
2 properties
switch_mist_nac
object
Enable mistnac to use RadSec
2 properties
snmp_usm_user
object
5 properties
response_http401
object
1 property
routing_policy_term_matching_as_path
array
snmpv3_config_target_param_security_model
string
enum: usm, v1, v2c
snmp_usm_user_authentication_type
string
sha224, sha256, sha384, sha512 are supported in 21.1 and newer release. enum: authentication-md5, authentication-none, authentication-sha, authentication-sha22…
snmpv3_config_notify_items
object
3 properties
switch_matching_rule_ip_config
object
In-Band Management interface configuration
2 properties
routing_policy_term_action_prepend_as_path
array
When used as export policy, optional. By default, the local AS will be prepended, to change it. Can be a Variable (e.g. {{aspath}})
radius_acct_server
object
7 properties
2 required
acl_tag_subnets
array
If - type==subnet - type==resource (optional. default is any) - type==staticgbp if from matching subnet
radius_auth_port
Radius Auth Port, value from 1 to 65535, default is 1812
additional_config_cmds
array
additional CLI commands to append to the generated Junos config. Note: no check is done
remote_syslog
object
10 properties
switch_port_usage_dynamic_rule_equals_any
array
Use equalsany to match any item in a list
snmp_config_trap_group_targets
array
snmp_config
object
13 properties
remote_syslog_archive_files
switch_radius
object
By default, radiusconfig will be used. if a different one has to be used set usedifferentradius
3 properties
acl_tag_type
string
enum: any: matching anything not identified dynamicgbp: from the gbptag received from RADIUS gbpresource: can only be used in dsttags mac network portusage rad…
snmpv3_config_target_param
object
6 properties
switch_radius_config
object
Junos Radius config
12 properties
snmp_vacm_access_item_prefix_list
array
snmpv3_config_target_address_item
object
6 properties
radius_auth_server
object
Authentication Server
8 properties
2 required
extra_routes6
object
Property key is the destination CIDR (e.g. "2a02:1234:420a:10c9::/64")
snmp_config_engine_id
string
junos_port_config
object
Switch port config
18 properties
1 required
ospf_area_type
string
OSPF type. enum: default, nssa, stub
dns_suffix
array
Global dns settings. To keep compatibility, dns settings in ipconfig and oobipconfig will overwrite this setting
dns_servers
array
Global dns settings. To keep compatibility, dns settings in ipconfig and oobipconfig will overwrite this setting
config_switch_local_accounts_user
object
2 properties
radius_auth_servers
array
ospf_areas
object
Junos OSPF areas. Property key is the OSPF Area (Area should be a number (0-255) / IP address)
snmp_vacm_security_to_group_content
array
snmp_usm
object
3 properties
sw_routing_policy_term
object
3 properties
1 required
vlan_id_with_variable
snmpv3_config
object
6 properties
allow_deny
string
enum: allow, deny
switch_matching_rules
array
acl_tag_spec
object
2 properties
sw_routing_policy_terms
array
at least criteria/filter must be specified to match the term, all criteria have to be met
vrf_extra_routes6
object
Property key is the destination CIDR (e.g. "2a02:1234:420a:10c9::/64")
vrf_extra_route
object
1 property
switch_port_mirroring_ingress_port_ids
array
At least one of the inputportidsingress, inputportidsegress or inputnetworksingress should be specified
switch_stp_config
object
1 property
snmp_usm_users
array
switch_port_usage_dynamic_rules
array
Only if mode==dynamic
snmp_config_views
array
junos_port_config_speed
string
enum: 100m, 10m, 1g, 2.5g, 5g, 10g, 25g, 40g, 100g,auto
snmp_config_client_list
object
2 properties
switch_port_usage_mac_limit
Only if mode!=dynamic, max number of mac addresses, default is 0 for unlimited, otherwise range is 1 to 16383 (upper bound constrained by platform)
remote_syslog_cacerts
array
switch_port_usage_speed
string
Only if mode!=dynamic, Port speed, default is auto to automatically negotiate speed enum: 100m, 10m, 1g, 2.5g, 5g, 10g, 25g, 40g, 100g,auto
protect_re_allowed_service
string
enum: icmp, ssh
ospf_area_network_auth_type
string
auth type. enum: md5, none, password
switch_port_usage_dynamic_rule
object
6 properties
1 required
remote_syslog_users
array
created_time
number
When the object has been created, in epoch
network_template
object
Network Template
30 properties
snmp_vacm_security_to_group
object
2 properties
switch_port_usage
object
Junos port usages
45 properties
aggregate_routes
object
Property key is the destination subnet (e.g. "172.16.3.0/24")
snmp_usm_user_encryption_type
string
enum: privacy-3des, privacy-aes128, privacy-des, privacy-none
tacacs_acct_servers
array
switch_bgp_config_hold_time_zero
integer
sw_routing_policies
object
Property key is the routing policy name
remote_syslog_content
object
2 properties
protect_re_allowed_services
array
Optionally, services we'll allow
switch_matching_rule_oob_ip_config
object
Out-of-Band Management interface configuration
3 properties
switch_radius_config_auth_server_selection
string
enum: ordered, unordered
snmp_usms
array
acl_tag_ether_types
array
ARP / IPv6. Default is any
network_template_import_org_networks
array
Org Networks that we'd like to import
ospf_area
object
Property key is the OSPF Area (Area should be a number (0-255) / IP address)
3 properties
snmp_config_v2c_configs
array
switch_port_usage_dynamic_rule_src
string
enum: linkpeermac, lldpchassisid, lldphardwarerevision, lldpmanufacturername, lldpoui, lldpserialnumber, lldpsystemdescription, lldpsystemname, radiusdynamicfi…
snmp_vacm_access_item_prefix_list_item
object
7 properties
vrf_config
object
1 property
switch_port_usage_dynamic_vlan_networks
array
Only if mode!=dynamic and portauth==dot1x, if dynamic vlan is used, specify the possible networks/vlans RADIUS can return
switch_matching_rule
object
Property key defines the type of matching, value is the string to match. e.g: matchname[0:3]: switch name must match the first 3 letters of the property value…
9 properties
snmpv3_config_notify
array
radius_keywrap_format
string
enum: ascii, hex
wired_port_config
object
Property key is the port name or range (e.g. "ge-0/0/0-10")
next_hop_via
Next-hop IP Address. Can be a single IP address or an array of IP addresses for ECMP (Equal-Cost Multi-Path) load balancing across multiple next-hops.
bgp_as
BGP AS, value in range 1-4294967294. Can be a Variable (e.g. {{bgpas}} )
protect_re_custom
object
Custom acls
3 properties
remote_syslog_console
object
1 property
switch_mgmt_mxedge_proxy_port
Mist Edge port used to proxy the switch management traffic to the Mist Cloud. Value in range 1-65535
switch_matching
object
Defines custom switch configuration based on different criteria
2 properties
remote_syslog_files
array
snmp_config_view
object
3 properties
acl_tag_specs
array
If type==resource, type==radiusgroup, type==portusage or type==gbpresource. Empty means unrestricted, i.e. any
config_switch_local_accounts
object
Property key is the user name. For Local user authentication
switch_port_usages
object
Property key is the port usage name. Defines the profiles of port configuration configured on the switch
snmpv3_config_notify_filter_item_content
object
2 properties
sw_routing_policy_term_matching_protocol
array
extra_route6
object
6 properties
response_http429
object
1 property
snmp_config_trap_group
object
4 properties
snmpv3_config_target_params
array
switch_bgp_config
object
9 properties
2 required
dhcp_snooping
object
5 properties
sw_routing_policy_term_matching_protocol_enum
string
enum: bgp, direct, evpn, ospf, static
acl_policy
object
ACL Policy: - for GBP-based policy, all srctags and dsttags have to be gbp-based - for ACL-based policy, network is required in either the source or destinatio…
3 properties
snmp_config_trap_group_categories
array
remote_syslog_contents
array
remote_syslog_user
object
3 properties
protect_re
object
Restrict inbound-traffic to host when enabled, all traffic that is not essential to our operation will be dropped e.g. ntp / dns / traffic to mist will be allo…
5 properties
remote_syslog_server_protocol
string
enum: tcp, udp
switch_mgmt
object
Switch Management settings
16 properties
org_id
string
acl_policies
array
snmp_config_v2c_config
object
4 properties
routing_policy_term_matching_prefix
array
zero or more criteria/filter can be specified to match the term, all criteria have to be met
protect_re_trusted_hosts
array
host/subnets we'll allow traffic to/from
switch_bgp_config_type
string
enum: external, internal
snmpv3_config_target_param_security_level
string
enum: authentication, none, privacy
sw_routing_policy_term_action
object
When used as import policy
4 properties
aggregate_route
object
3 properties
id
string
Unique ID of the object instance in the Mist Organization
switch_port_usage_dynamic_reset_default_when
string
Only if mode==dynamic Control when the DPC port should be changed to the default port usage. enum: linkdown, none (let the DPC port keep at the current port us…
snmp_config_engine_id_type
string
enum: local, usemacaddress
tacacs
object
5 properties
snmpv3_config_notify_filter_item_contents
array
remote_syslog_servers
array
snmp_config_client_lists
array
switch_bgp_config_hold_time_integer
integer
response_http403
object
1 property
remote_syslog_file_config
object
7 properties
switch_port_usage_mode
string
mode==dynamic must only be used if the port usage name is dynamic. enum: access, dynamic, inet, trunk
aggregate_routes6
object
Property key is the destination subnet (e.g. "2a02:1234:420a:10c9::/64")
ip_type
string
enum: dhcp, static
dhcp_snooping_networks
array
If allnetworks==false, list of network with DHCP snooping enabled
snmp_vacm_security_model
string
enum: usm, v1, v2c
switch_port_mirroring_property
object
6 properties
snmp_vacm_access_item_prefix_list_item_model
string
enum: any, usm, v1, v2c
vrf_extra_route6
object
1 property
switch_port_usage_duplex
string
Only if mode!=dynamic. Link connection mode. enum: auto, full, half
snmp_vacm_access_item
object
2 properties
ntp_servers
array
List of NTP servers specific to this device. By default, those in Site Settings will be used
switch_bgp_config_neighbors
object
Property key is the BGP Neighbor IP Address.
response_http404
object
1 property
switch_networks
object
Property key is network name
snmp_config_trap_groups
array
ospf_area_network_interface_type
string
interface type (nbma = non-broadcast multi-access). enum: broadcast, nbma, p2mp, p2p
ospf_areas_network
object
Property key is the network name. Networks to participate in an OSPF area
12 properties
switch_network
object
A network represents a network segment. It can either represent a VLAN (then usually ties to a L3 subnet), optionally associate it with a subnet which can late…
7 properties
1 required
switch_port_mirroring
object
Property key is the port mirroring instance name. portmirroring can be added under device/site settings. It takes interface and ports as input for ingress, int…
snmpv3_config_target_param_mess_process_model
string
enum: v1, v2c, v3
response_http400
object
1 property
snmp_vacm_access
array
radius_acct_servers
array
switch_port_usage_storm_control
object
Switch storm control. Only if mode!=dynamic
6 properties
extra_routes
object
Property key is the destination CIDR (e.g. "10.0.0.0/8")
config_switch_local_accounts_user_role
string
enum: admin, helpdesk, none, read
vrf_extra_routes
object
Property key is the destination CIDR (e.g. "10.0.0.0/8")
extra_route_next_qualified_properties
object
2 properties
poe_priority
string
PoE priority. enum: low, high
switch_vrf_instances
object
Property key is the network name
snmp_vacm
object
2 properties
snmpv3_config_notify_filter_item
object
2 properties
extra_route6_next_qualified_properties
object
2 properties
sw_routing_policy
object
1 property
switch_port_usage_dot1x
stringnull
Only if mode!=dynamic. If dot1x is desired, set to dot1x. enum: dot1x
remote_syslog_time_format
string
enum: millisecond, year, year millisecond
tacacs_auth_server
object
4 properties
snmpv3_config_notify_filter
array
remote_syslog_facility
string
enum: any, authorization, change-log, config, conflict-log, daemon, dfc, external, firewall, ftp, interactive-commands, kernel, ntp, pfe, security, user
remote_syslog_server_port
Syslog Service Port, value from 1 to 65535
switch_port_mirroring_ingress_networks
array
At least one of the inputportidsingress, inputportidsegress or inputnetworksingress should be specified
protect_re_customs
array
modified_time
number
When the object has been modified for the last time, in epoch
routing_policy_term_action_community
array
When used as export policy, optional
acl_policy_actions
array
ACL Policy Actions: - for GBP-based policy, all srctags and dsttags have to be gbp-based - for ACL-based policy, network is required in either the source or de…
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Juniper Mist AI 12
Other APIs Juniper Mist AI publishes across the network.
Juniper Mist WebSocket Streaming API
Juniper Mist Webhooks API
Juniper Mist AI Admins API
Juniper Mist AI Admins Login API
Juniper Mist AI Admins Login - OAuth2 API
Juniper Mist AI Admins Logout API
Juniper Mist AI Admins Lookup API
Juniper Mist AI Admins Recover Password API
Juniper Mist AI Constants Definitions API
Juniper Mist AI Constants Events API
Juniper Mist AI Constants Models API
Juniper Mist AI Installer API
#Sites Network Templates