Mist Orgs Network Templates API
A Network Template is a configuration template that allows for the consistent and standardized configuration of switches across an organization's network infrastructure.It includes settings such as RADIUS and ntp servers, shared elements like iot or corporate networks, and port profiles for specific devices.Switch templates can be applied at the site level, and they make the initial setup of switches easy and adaptable to specific site or switch settings.
Mist Orgs Network Templates API is one of 212 APIs that Mist publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Orgs Network Templates. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes 5 operations across 2 paths, and defines 215 schemas. It is described by OpenAPI 3.2.0, at version 2606.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.
5 operations
2 paths
215 schemas
1 DELETE2 GET1 POST1 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
Mist Orgs Network 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](/operations/login) request, Mist returns a csrftoken cookie. Send…
Paths & Operations 5
Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
Orgs Network Templates 5
A Network Template is a configuration template that allows for the consistent and standardized configuration of switches across an organization's network infrastructure. It includ…
GET
/api/v1/orgs/{org_id}/networktemplates
listOrgNetworkTemplates
POST
/api/v1/orgs/{org_id}/networktemplates
createOrgNetworkTemplate
DELETE
/api/v1/orgs/{org_id}/networktemplates/{networktemplate_id}
deleteOrgNetworkTemplate
GET
/api/v1/orgs/{org_id}/networktemplates/{networktemplate_id}
getOrgNetworkTemplate
PUT
/api/v1/orgs/{org_id}/networktemplates/{networktemplate_id}
updateOrgNetworkTemplate
Schemas 215
The contract defines 215 schemas that model the data the API accepts and returns. The most detailed are switch_port_usage (46 properties), network_template (30 properties), junos_port_config (19 properties), switch_mgmt (16 properties). Each schema is shown below with its type and property counts.
radius_acct_port
RADIUS Auth Port, value from 1 to 65535, default is 1813
junos_port_config_duplex
string
enum: auto, full, half
switch_port_usage_dynamic_rule
object
Dynamic port usage rule evaluated against LLDP, RADIUS, or peer MAC attributes
6 properties
1 required
switch_vrf_instances
object
Property key is the network name
switch_mist_nac
object
Mist NAC RadSec settings for a switch
2 properties
snmp_usm
object
SNMPv3 User-based Security Model configuration
3 properties
org_id
string
Unique identifier of a Mist organization
tacacs_auth_server
object
TACACS+ authentication server settings
4 properties
switch_radius_config_auth_server_selection
string
Selection strategy for RADIUS authentication servers. enum: ordered, unordered
sw_routing_policies
object
Switch routing policies keyed by routing policy name
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…
radius_acct_server
object
RADIUS accounting server settings
7 properties
2 required
acl_tag_spec
object
Layer 4 protocol and destination-port match constraint for an ACL tag
2 properties
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
ntp_servers
array
List of NTP servers specific to this device. By default, those in Site Settings will be used
junos_port_config
object
Junos switch port configuration
19 properties
1 required
aggregate_routes
object
Property key is the destination subnet (e.g. "172.16.3.0/24")
vrf_extra_route6
object
Additional IPv6 static route for a VRF instance
1 property
extra_routes6
object
Property key is the destination CIDR (e.g. "2a02:1234:420a:10c9::/64")
snmp_vacm_security_to_group_content
array
VACM security-name to group mapping entries
remote_syslog_server_protocol
string
Transport protocol used for this remote syslog server. enum: tcp, udp
radius_coa_port
RADIUS CoA Port, value from 1 to 65535, default is 3799
snmpv3_config_notify_filter
array
SNMPv3 notification filter profiles
extra_routes
object
Property key is the destination CIDR (e.g. "10.0.0.0/8")
ospf_area
object
Property key is the OSPF Area (Area should be a number (0-255) / IP address)
3 properties
strings
array
Unique string values returned or accepted by this schema
ospf_areas_network
object
Property key is the network name. Networks to participate in an OSPF area
12 properties
switch_port_usage_storm_control
object
Switch storm control. Only if mode!=dynamic
6 properties
sw_routing_policy_term_action
object
Actions applied to routes matched by a switch routing policy term
4 properties
allow_deny
string
Policy action value that either allows or denies matching traffic. enum: allow, deny
switch_bgp_config_hold_time_zero
integer
BGP hold time value of 0
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)
switch_stp_config
object
Switch spanning-tree protocol configuration
1 property
routing_policy_term_matching_prefix
array
zero or more criteria/filter can be specified to match the term, all criteria have to be met
routing_policy_term_matching_community
array
BGP community values used as routing-policy match criteria
extra_route_next_qualified_properties
object
Qualified next-hop attributes for an IPv4 static route
2 properties
wired_port_config
object
Property key is the port name or range (e.g. "ge-0/0/0-10")
switch_radius
object
Switch RADIUS override settings. By default, the switch radiusconfig is used; set usedifferentradius to use alternate RADIUS settings.
3 properties
acl_tag_subnets
array
If - type==subnet - type==resource (optional. default is any) - type==staticgbp if from matching subnet
switch_port_mirroring_property
object
Input and output settings for one switch port mirroring session
6 properties
switch_mgmt
object
Switch management-plane access and proxy settings
16 properties
remote_syslog_users
array
User-specific syslog logging rules
switch_bgp_config_neighbors
object
Switch BGP neighbor settings keyed by neighbor IP address
snmp_vacm_access
array
VACM access rules for SNMPv3
switch_radius_config
object
Switch RADIUS authentication and accounting configuration
12 properties
snmp_config_trap_group
object
SNMP trap group definition
4 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
ospf_area_type
string
OSPF type. enum: default, nssa, stub
remote_syslog
object
Remote syslog forwarding settings
10 properties
acl_tags
object
ACL Tags to identify traffic source or destination. Key name is the tag name
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}})
vrf_extra_routes
object
Property key is the destination CIDR (e.g. "10.0.0.0/8")
snmpv3_config_target_address_item
object
SNMPv3 notification target address entry
6 properties
dns_suffix
array
Global dns settings. To keep compatibility, dns settings in ipconfig and oobipconfig will overwrite this setting
routing_policy_term_matching_as_path
array
BGP AS path values used as routing-policy match criteria
switch_matching_rules
array
Ordered switch matching rules for conditional configuration
config_switch_local_accounts_user_role
string
enum: admin, helpdesk, none, read
switch_bgp_config_neighbor
object
Per-neighbor switch BGP session settings
5 properties
1 required
snmp_config_client_list
object
SNMP client allowlist definition
2 properties
ospf_area_network_interface_type
string
interface type (nbma = non-broadcast multi-access). enum: broadcast, nbma, p2mp, p2p
response_http403
object
Standard HTTP 403 permission error response
1 property
tacacs_auth_servers
array
List of TACACS+ authentication servers
switch_mgmt_mxedge_proxy_port
Mist Edge port used to proxy the switch management traffic to the Mist Cloud. Value in range 1-65535
snmp_vacm_security_model
string
enum: usm, v1, v2c
aggregate_route
object
Aggregate route configuration for a network or routing instance
3 properties
network_templates
array
List of network templates
dhcp_snooping
object
DHCP snooping security settings
5 properties
remote_syslog_server_port
Syslog Service Port, value from 1 to 65535
remote_syslog_servers
array
Remote syslog server destination list
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
sw_routing_policy_term_matching_protocol_enum
string
enum: bgp, direct, evpn, ospf, static
acl_policies
array
List of ACL policy definitions
snmp_vacm
object
SNMPv3 View-based Access Control Model configuration
2 properties
remote_syslog_user
object
User-specific syslog logging rule
3 properties
remote_syslog_server
object
Remote syslog server destination settings
13 properties
switch_port_mirroring_ingress_port_ids
array
At least one of the inputportidsingress, inputportidsegress or inputnetworksingress should be specified
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…
network_template_import_org_networks
array
Org Networks that we'd like to import
snmp_config_engine_id_type
string
Method used to derive the SNMP engine ID. enum: local, usemacaddress
acl_tag_specs
array
If type==resource, type==radiusgroup, type==portusage or type==gbpresource. Empty means unrestricted, i.e. any
config_switch_local_accounts_user
object
Local switch user account credentials and access role
2 properties
sw_routing_policy_term_matching_protocol
array
Routing protocols that can match a switch routing policy term
remote_syslog_severity
string
enum: alert, any, critical, emergency, error, info, notice, warning
sw_routing_policy_term
object
Switch routing policy term with match criteria and actions
3 properties
1 required
ip_type
string
IP address assignment mode, either DHCP or static. enum: dhcp, static
created_time
number
When the object has been created, in epoch
snmp_usm_user
object
SNMPv3 USM user definition
5 properties
remote_syslog_facility
string
enum: any, authorization, change-log, config, conflict-log, daemon, dfc, external, firewall, ftp, interactive-commands, kernel, ntp, pfe, security, user
snmp_usm_user_encryption_type
string
enum: privacy-3des, privacy-aes128, privacy-des, privacy-none
snmp_config_v2c_configs
array
SNMPv2c community configuration entries for this SNMP profile
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
tacacs_acct_server
object
TACACS+ accounting server settings
4 properties
junos_port_config_speed
string
enum: 100m, 10m, 1g, 2.5g, 5g, 10g, 25g, 40g, 100g,auto
switch_port_usage_dynamic_rule_src
string
enum: linkpeermac, lldpchassisid, lldphardwarerevision, lldpmanufacturername, lldpoui, lldpserialnumber, lldpsystemdescription, lldpsystemname, radiusdynamicfi…
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…
snmp_config_trap_groups
array
SNMP trap group definitions
snmp_vacm_access_item_type
string
VACM context matching type for this access rule. enum: contextprefix, defaultcontextprefix
snmpv3_config_notify_items
object
SNMPv3 notification definition for traps or informs
3 properties
protect_re_allowed_services
array
Built-in services explicitly allowed by the Protect RE policy
vrf_extra_routes6
object
Property key is the destination CIDR (e.g. "2a02:1234:420a:10c9::/64")
radius_auth_port
RADIUS Auth Port, value from 1 to 65535, default is 1812
snmpv3_config_target_params
array
SNMPv3 target parameter profiles
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.
switch_bgp_config
object
Switch BGP configuration for a routing instance
9 properties
2 required
aggregate_routes6
object
Property key is the destination subnet (e.g. "2a02:1234:420a:10c9::/64")
acl_policy_action
object
Action applied to traffic that matches a destination ACL tag
2 properties
1 required
vrf_config
object
VRF enablement settings applied when supported on the device
1 property
snmp_vacm_access_item
object
VACM access rule for an SNMP group
2 properties
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
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…
tacacs_acct_servers
array
List of TACACS+ accounting servers
switch_bgp_config_type
string
BGP session type for this switch BGP configuration. enum: external, internal
bgp_as
BGP AS, value in range 1-4294967294. Can be a Variable (e.g. {{bgpas}} )
extra_route
object
IPv4 static route settings for a destination prefix
6 properties
remote_syslog_content
object
Syslog message content selector for remote logging
2 properties
snmp_config_view
object
SNMP MIB view definition
3 properties
snmp_config_client_lists
array
SNMP client allowlists that can be referenced by communities
snmp_config_trap_version
string
enum: all, v1, v2
radius_auth_servers
array
List of RADIUS authentication servers
config_switch_local_accounts
object
Property key is the user name. For Local user authentication
sw_routing_policy_terms
array
Ordered switch routing policy terms; at least one term is required
snmp_config
object
SNMP configuration for managed network devices
13 properties
additional_config_cmds
array
additional CLI commands to append to the generated Junos config. Note: no check is done
snmpv3_config_target_param_security_level
string
enum: authentication, none, privacy
tacacs_default_role
string
enum: admin, helpdesk, none, read
radius_auth_server
object
RADIUS authentication server settings
8 properties
2 required
remote_syslog_console
object
Console log forwarding filters for remote syslog
1 property
snmp_config_client_list_clients
array
SNMP client IP addresses or CIDR ranges allowed by a client list
switch_port_usage_dynamic_rules
array
Only if mode==dynamic. Dynamic matching rules that select the port usage to apply
sw_routing_policy_term_matching
object
Route match criteria for a switch routing policy term; all specified criteria must match
4 properties
network_template
object
Network template configuration applied to sites or site groups
30 properties
snmp_config_v2c_config
object
SNMPv2c community configuration entry
4 properties
vlan_id_with_variable
VLAN ID, either numeric or expressed as a template variable string
protect_re_trusted_hosts
array
Host or subnet entries allowed by the Protect RE policy
vrf_extra_route
object
Additional IPv4 static route for a VRF instance
1 property
acl_tag_macs
array
Required if - type==mac - type==staticgbp if from matching mac
snmp_usm_engine_type
string
SNMP engine type used for this USM configuration. enum: localengine, remoteengine
protect_re_custom_subnet
array
Source subnets matched by a custom Protect RE ACL
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…
snmp_vacm_security_to_group
object
VACM security-name to group mapping configuration
2 properties
remote_syslog_file_config
object
Generated syslog file output settings
7 properties
snmp_vacm_access_item_prefix_list_item_model
string
enum: any, usm, v1, v2c
snmpv3_config_notify
array
SNMPv3 notification definitions used for traps and informs
switch_port_usage_duplex
string
Only if mode!=dynamic. Link connection mode. enum: auto, full, half
remote_syslog_time_format
string
enum: millisecond, year, year millisecond
acl_tag_ether_types
array
ARP / IPv6. Default is any
snmp_config_engine_id
string
SNMP engine ID value used for SNMPv3
response_http429
object
Standard HTTP 429 rate limit error response
1 property
response_http401
object
Standard HTTP 401 authentication error response
1 property
switch_matching
object
Defines custom switch configuration based on different criteria
2 properties
switch_port_usage_dot1x
stringnull
Only if mode!=dynamic. If dot1x is desired, set to dot1x. enum: dot1x
tacacs
object
TACACS+ settings for switch management authentication and accounting
5 properties
id
string
Unique ID of the object instance in the Mist Organization
dns_servers
array
Global dns settings. To keep compatibility, dns settings in ipconfig and oobipconfig will overwrite this setting
snmpv3_config_notify_filter_item_content
object
OID filter rule for an SNMPv3 notification profile
2 properties
ospf_areas
object
Junos OSPF areas. Property key is the OSPF Area (Area should be a number (0-255) / IP address)
switch_matching_rule_ip_config
object
In-Band Management interface configuration
2 properties
remote_syslog_files
array
Generated syslog file output definitions
remote_syslog_archive_files
Number of archived syslog files to retain
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…
switch_networks
object
Property key is network name
snmp_vacm_access_item_prefix_list_item_level
string
enum: authentication, none, privacy
snmp_vacm_access_item_prefix_list
array
Context prefix rules for a VACM access entry
snmp_vacm_access_item_prefix_list_item
object
Context prefix rule for a VACM access entry
7 properties
snmpv3_config_target_param_mess_process_model
string
enum: v1, v2c, v3
sw_routing_policy
object
Switch routing policy made of ordered match-action terms
1 property
switch_port_mirroring_egress_port_ids
array
At least one of the inputportidsingress, inputportidsegress or inputnetworksingress should be specified
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
radius_acct_servers
array
List of RADIUS accounting servers
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.
remote_syslog_cacerts
array
CA certificates used to verify TLS syslog servers
snmpv3_config
object
SNMPv3 notification, target, USM, and VACM configuration
6 properties
switch_matching_rule_oob_ip_config
object
Out-of-Band Management interface configuration
3 properties
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}})
snmpv3_config_target_address
array
SNMPv3 notification target addresses
response_http400
object
Standard HTTP 400 bad request error response
1 property
protect_re_allowed_service
string
Services allowed through protect-RE filters. enum: icmp, ssh
switch_port_mirroring_ingress_networks
array
At least one of the inputportidsingress, inputportidsegress or inputnetworksingress should be specified
ospf_area_network_auth_type
string
auth type. enum: md5, none, password
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
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…
extra_route6_next_qualified_properties
object
Qualified next-hop attributes for an IPv6 static route
2 properties
switch_port_usage_dynamic_rule_equals_any
array
Use equalsany to match any item in a list
extra_route6
object
IPv6 static route settings for a destination prefix
6 properties
snmp_config_trap_group_targets
array
Trap target addresses for an SNMP trap group
snmpv3_config_notify_filter_item_contents
array
OID filter rules in an SNMPv3 notification filter profile
snmpv3_config_notify_filter_item
object
SNMPv3 notification filter profile
2 properties
snmpv3_config_target_param_security_model
string
enum: usm, v1, v2c
snmp_usm_users
array
SNMPv3 USM user definitions
switch_vrf_instance
object
Switch VRF instance routing and network membership settings
7 properties
protect_re_customs
array
Custom Protect RE ACL entries
switch_port_usage_mode
string
mode==dynamic must only be used if the port usage name is dynamic. enum: access, dynamic, inet, trunk
routing_policy_term_action_community
array
When used as export policy, optional
modified_time
number
When the object has been modified for the last time, in epoch
switch_port_usage_networks
array
Only if mode==trunk, the list of network/vlans
radius_keywrap_format
string
Encoding format for RADIUS keywrap KEK and MACK values. enum: ascii, hex
protect_re_custom_protocol
string
enum: any, icmp, tcp, udp
remote_syslog_archive
object
Syslog file archive retention settings
2 properties
remote_syslog_contents
array
List of syslog content selectors
dhcp_snooping_networks
array
If allnetworks==false, list of network with DHCP snooping enabled
switch_bgp_config_hold_time_integer
integer
BGP hold time value from 3 to 65535 seconds
snmpv3_config_notify_type
string
Delivery mode for this SNMPv3 notification, such as trap or inform. enum: inform, trap
response_http404
object
Standard HTTP 404 not found error response
1 property
acl_tag
object
Resource tags (type==resource or type==gbpresource) can only be used in dsttags
9 properties
1 required
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.
switch_port_usage
object
Junos switch port usage template and authentication settings
46 properties
snmp_config_views
array
SNMP MIB view definitions
snmpv3_config_target_param
object
SNMPv3 target parameter profile
6 properties
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_usms
array
SNMPv3 USM engine configurations
protect_re_custom
object
Custom Protect RE ACL entry
3 properties
snmp_config_trap_group_categories
array
Trap categories included in an SNMP trap group
switch_port_usages
object
Property key is the port usage name. Defines the profiles of port configuration configured on the switch
poe_priority
string
PoE priority. enum: low, high
snmp_vacm_security_to_group_content_item
object
VACM security-name to group mapping entry
2 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Mist 12
Other APIs Mist publishes across the network.
Mist Admins API
Mist Admins Login API
Mist Admins Login - OAuth2 API
Mist Admins Logout API
Mist Admins Lookup API
Mist Admins Recover Password API
Mist Constants Definitions API
Mist Constants Events API
Mist Constants Models API
Mist Installer API
Mist MSPs Admins API
Mist MSPs API
#Orgs Network Templates
Where this information came from
This is an independent, third-party profile of Mist Orgs Network 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.