getOrgNetworkTemplate
Retrieve details for a specific organization network template, including network, port usage, switch management, routing, NAC, and service defaults.
Preferred authentication method for automation and integrations. Send the API token in the HTTP Authorization header.
Format:
Authorization: Token {apitoken}
Notes:
- An API token generated for a specific admin has the same privileges as that admin
- An API token is automatically removed if it is not used for more than 90 days
- SSO admins cannot generate admin API tokens. Use organization API tokens when scoped Org/Site privileges are needed.
In: header
Path Parameters
uuiduuidResponse Body
application/json
curl -X GET "https://example.com/api/v1/orgs/000000ab-00ab-00ab-00ab-0000000000ab/networktemplates/000000ab-00ab-00ab-00ab-0000000000ab"{ "acl_policies": [ { "actions": [ { "action": "allow", "dst_tag": "corp" } ], "disabled": false, "name": "guest access", "src_tags": [ "macs" ] } ], "acl_tags": { "property1": { "ether_types": [ "any" ], "gbp_tag": 0, "macs": [ "string" ], "network": "string", "port_usage": "string", "radius_group": "string", "specs": [ { "port_range": "0", "protocol": "any" } ], "subnets": [ "string" ], "type": "any" }, "property2": { "ether_types": [ "any" ], "gbp_tag": 0, "macs": [ "string" ], "network": "string", "port_usage": "string", "radius_group": "string", "specs": [ { "port_range": "0", "protocol": "any" } ], "subnets": [ "string" ], "type": "any" } }, "additional_config_cmds": [ "set snmp community public" ], "bgp_config": { "property1": { "auth_key": "string", "bfd_minimum_interval": 1, "export_policy": "string", "hold_time": 0, "import_policy": "string", "local_as": 65000, "neighbors": { "property1": { "export_policy": "string", "hold_time": 0, "import_policy": "string", "multihop_ttl": 1, "neighbor_as": 65000 }, "property2": { "export_policy": "string", "hold_time": 0, "import_policy": "string", "multihop_ttl": 1, "neighbor_as": 65000 } }, "networks": [ "string" ], "type": "external" }, "property2": { "auth_key": "string", "bfd_minimum_interval": 1, "export_policy": "string", "hold_time": 0, "import_policy": "string", "local_as": 65000, "neighbors": { "property1": { "export_policy": "string", "hold_time": 0, "import_policy": "string", "multihop_ttl": 1, "neighbor_as": 65000 }, "property2": { "export_policy": "string", "hold_time": 0, "import_policy": "string", "multihop_ttl": 1, "neighbor_as": 65000 } }, "networks": [ "string" ], "type": "external" } }, "created_time": 0.1, "dhcp_snooping": { "all_networks": true, "enable_arp_spoof_check": true, "enable_ip_source_guard": true, "enabled": true, "networks": [ "string" ] }, "dns_servers": [ "string" ], "dns_suffix": [ "string" ], "extra_routes": { "0.0.0.0/0": { "via": "192.168.1.10" } }, "extra_routes6": { "2a02:1234:420a:10c9::/64": { "via": "2a02:1234:200a::100" } }, "id": "53f10664-3ce8-4c27-b382-0ef66432349f", "import_org_networks": [ "ap" ], "mist_nac": { "enabled": true, "network": "string" }, "modified_time": 0.1, "multicast_config": { "anycast_rp": false, "peg_enabled": false, "rp_ip": "10.2.1.10", "rp_mac": "5f263135a66d", "sbd_subnet": "10.99.0.0/24", "sbd_vlan_id": 3900, "sbd_wan_rpf": false }, "name": "string", "networks": { "property1": { "gateway": "string", "gateway6": "string", "isolation": false, "isolation_vlan_id": "3070", "multicast": { "enabled": false, "igmp_version": "2" }, "subnet": "string", "subnet6": "string", "vlan_id": "string" }, "property2": { "gateway": "string", "gateway6": "string", "isolation": false, "isolation_vlan_id": "3070", "multicast": { "enabled": false, "igmp_version": "2" }, "subnet": "string", "subnet6": "string", "vlan_id": "string" } }, "ntp_servers": [ "string" ], "org_id": "a97c1b22-a4e9-411e-9bfd-d8695a0f9e61", "ospf_areas": { "property1": { "include_loopback": false, "networks": { "corp": { "auth_keys": { "1": "auth-key-1" }, "auth_type": "md5", "bfd_minimum_interval": 500, "dead_interval": 40, "hello_interval": 10, "interface_type": "nbma", "metric": 10000 }, "guest": { "passive": true } }, "type": "default" }, "property2": { "include_loopback": false, "networks": { "corp": { "auth_keys": { "1": "auth-key-1" }, "auth_type": "md5", "bfd_minimum_interval": 500, "dead_interval": 40, "hello_interval": 10, "interface_type": "nbma", "metric": 10000 }, "guest": { "passive": true } }, "type": "default" } }, "port_mirroring": { "property1": { "input_networks_ingress": [ "corp" ], "input_port_ids_egress": [ "ge-0/0/3" ], "input_port_ids_ingress": [ "ge-0/0/3" ], "output_ip_address": "1.2.3.4", "output_network": "analyze", "output_port_id": "ge-0/0/5" }, "property2": { "input_networks_ingress": [ "corp" ], "input_port_ids_egress": [ "ge-0/0/3" ], "input_port_ids_ingress": [ "ge-0/0/3" ], "output_ip_address": "1.2.3.4", "output_network": "analyze", "output_port_id": "ge-0/0/5" } }, "port_usages": { "property1": { "all_networks": false, "allow_dhcpd": true, "allow_multiple_supplicants": false, "bypass_auth_when_server_down": false, "bypass_auth_when_server_down_for_unknown_client": false, "bypass_auth_when_server_down_for_voip": false, "community_vlan_id": 0, "description": "string", "disable_autoneg": false, "disabled": false, "duplex": "auto", "dynamic_vlan_networks": [ "corp", "user" ], "enable_mac_auth": false, "enable_qos": false, "guest_network": "string", "inter_isolation_network_link": false, "inter_switch_link": false, "mac_auth_only": true, "mac_auth_preferred": true, "mac_auth_protocol": "eap-md5", "mac_limit": 0, "mode": "access", "mtu": 256, "networks": [ "string" ], "no_local_port_config": false, "persist_mac": false, "poe_disabled": false, "poe_keep_state_when_reboot": false, "poe_priority": "low", "port_auth": "dot1x", "port_network": "string", "reauth_interval": 3600, "reset_default_when": "link_down", "rules": [ { "description": "string", "equals": "string", "equals_any": [ "string" ], "expression": "string", "src": "link_peermac", "usage": "string" } ], "server_fail_network": "string", "server_fail_retry_interval": 120, "server_reject_network": "string", "speed": "10m", "storm_control": { "disable_port": false, "no_broadcast": false, "no_multicast": false, "no_registered_multicast": false, "no_unknown_unicast": false, "percentage": 80 }, "stp_disable": false, "stp_edge": false, "stp_no_root_port": false, "stp_p2p": false, "stp_required": false, "ui_evpntopo_id": "7ba23f8d-2742-4bba-a7de-57e60d3aa15c", "use_vstp": false, "voip_network": "string" }, "property2": { "all_networks": false, "allow_dhcpd": true, "allow_multiple_supplicants": false, "bypass_auth_when_server_down": false, "bypass_auth_when_server_down_for_unknown_client": false, "bypass_auth_when_server_down_for_voip": false, "community_vlan_id": 0, "description": "string", "disable_autoneg": false, "disabled": false, "duplex": "auto", "dynamic_vlan_networks": [ "corp", "user" ], "enable_mac_auth": false, "enable_qos": false, "guest_network": "string", "inter_isolation_network_link": false, "inter_switch_link": false, "mac_auth_only": true, "mac_auth_preferred": true, "mac_auth_protocol": "eap-md5", "mac_limit": 0, "mode": "access", "mtu": 256, "networks": [ "string" ], "no_local_port_config": false, "persist_mac": false, "poe_disabled": false, "poe_keep_state_when_reboot": false, "poe_priority": "low", "port_auth": "dot1x", "port_network": "string", "reauth_interval": 3600, "reset_default_when": "link_down", "rules": [ { "description": "string", "equals": "string", "equals_any": [ "string" ], "expression": "string", "src": "link_peermac", "usage": "string" } ], "server_fail_network": "string", "server_fail_retry_interval": 120, "server_reject_network": "string", "speed": "10m", "storm_control": { "disable_port": false, "no_broadcast": false, "no_multicast": false, "no_registered_multicast": false, "no_unknown_unicast": false, "percentage": 80 }, "stp_disable": false, "stp_edge": false, "stp_no_root_port": false, "stp_p2p": false, "stp_required": false, "ui_evpntopo_id": "7ba23f8d-2742-4bba-a7de-57e60d3aa15c", "use_vstp": false, "voip_network": "string" } }, "radius_config": { "acct_immediate_update": true, "acct_interim_interval": 0, "acct_servers": [ { "host": "1.2.3.4", "keywrap_enabled": true, "keywrap_format": "ascii", "keywrap_kek": "1122334455", "keywrap_mack": "1122334455", "port": 1, "secret": "testing123" } ], "auth_server_selection": "ordered", "auth_servers": [ { "host": "1.2.3.4", "keywrap_enabled": true, "keywrap_format": "ascii", "keywrap_kek": "1122334455", "keywrap_mack": "1122334455", "port": 1, "require_message_authenticator": false, "secret": "testing123" } ], "auth_servers_retries": 3, "auth_servers_timeout": 5, "coa_enabled": false, "coa_port": 1, "fast_dot1x_timers": false, "network": "string", "source_ip": "string" }, "remote_syslog": { "archive": { "files": 20, "size": "5m" }, "cacerts": [ "-----BEGIN CERTIFICATE-----\\nMIIFZjCCA06gAwIBAgIIP61/1qm/uDowDQYJKoZIhvcNAQELBQE\\n-----END CERTIFICATE-----", "-----BEGIN CERTIFICATE-----\\nBhMCRVMxFDASBgNVBAoMC1N0YXJ0Q29tIENBMSwwKgYDVn-----END CERTIFICATE-----" ], "console": { "contents": [ { "facility": "config", "severity": "alert" } ] }, "enabled": false, "files": [ { "archive": { "files": 20, "size": "5m" }, "contents": [ { "facility": "config", "severity": "alert" } ], "enable_tls": true, "explicit_priority": true, "file": "file-name", "match": "!alarm|ntp|errors.crc_error[chan]", "structured_data": true } ], "network": "default", "send_to_all_servers": false, "servers": [ { "facility": "config", "host": "syslogd.internal", "port": 514, "protocol": "udp", "severity": "info", "tag": "" } ], "time_format": "millisecond", "users": [ { "contents": [ { "facility": "config", "severity": "alert" } ], "match": "\"!alarm|ntp|errors.crc_error[chan]\"", "user": "*" } ] }, "remove_existing_configs": false, "routing_policies": { "property1": { "terms": [ { "actions": { "accept": true, "community": [ "3900190" ], "local_preference": "string", "prepend_as_path": [ "65000 400" ] }, "matching": { "as_path": [ 65000 ], "community": [ "3900062" ], "prefix": [ "192.168.0.0/16-30" ], "protocol": [ "bgp" ] }, "name": "string" } ] }, "property2": { "terms": [ { "actions": { "accept": true, "community": [ "3900190" ], "local_preference": "string", "prepend_as_path": [ "65000 400" ] }, "matching": { "as_path": [ 65000 ], "community": [ "3900062" ], "prefix": [ "192.168.0.0/16-30" ], "protocol": [ "bgp" ] }, "name": "string" } ] } }, "snmp_config": { "client_list": [ { "client_list_name": "clist-1", "clients": [ "151.140.101.218/32" ] } ], "contact": "cns@juniper.net", "description": "Juniper QFX Series Switch - 1K_5LA", "enabled": true, "engine_id": "string", "engine_id_type": "local", "location": "Las Vegas, NV", "name": "TGH-1K-QFX10K", "network": "default", "trap_groups": [ { "categories": [ "authentication" ], "group_name": "profiler", "targets": [ "172.29.158.19" ], "version": "all" } ], "v2c_config": [ { "authorization": "read-only", "client_list_name": "clist-1", "community_name": "abc123", "view": "all" } ], "v3_config": { "notify": [ { "name": "string", "tag": "string", "type": "inform" } ], "notify_filter": [ { "categories": [ "link", "authentication" ], "contents": [ { "include": true, "oid": "1.3.6.1.4.1" } ], "profile_name": "string" } ], "target_address": [ { "address": "10.11.0.2", "address_mask": "255.255.255.0", "port": "161", "tag_list": "string", "target_address_name": "target_address_name", "target_parameters": "string" } ], "target_parameters": [ { "message_processing_model": "v1", "name": "string", "notify_filter": "string", "security_level": "authentication", "security_model": "usm", "security_name": "m01620" } ], "usm": [ { "engine_type": "local_engine", "remote_engine_id": "00:00:00:0b:00:00:70:10:6f:08:b6:3f", "users": [ { "authentication_password": "strings", "authentication_type": "authentication-md5", "encryption_password": "stringst", "encryption_type": "privacy-3des", "name": "string" } ] } ], "vacm": { "access": [ { "group_name": "string", "prefix_list": [ { "context_prefix": "iil", "notify_view": "all", "read_view": "all", "security_level": "authentication", "security_model": "any", "type": "context_prefix", "write_view": "all" } ] } ], "security_to_group": { "content": [ { "group": "string", "security_name": "string" } ], "security_model": "usm" } } }, "views": [ { "include": true, "oid": "1.3.6.1", "view_name": "all" } ] }, "switch_matching": { "enable": true, "rules": [ { "match_model": "EX4300", "match_name[0:3]": "abc" } ] }, "switch_mgmt": { "ap_affinity_threshold": 10, "cli_banner": "\\t\\tWELCOME!", "cli_idle_timeout": 1, "config_revert_timer": 10, "dhcp_option_fqdn": false, "disable_oob_down_alarm": true, "fips_enabled": false, "local_accounts": { "property1": { "password": "Juniper123", "role": "admin" }, "property2": { "password": "Juniper123", "role": "admin" } }, "mxedge_proxy_host": "string", "mxedge_proxy_port": 2222, "protect_re": { "allowed_services": [ "icmp", "ssh" ], "custom": [ { "port_range": "80,1035-1040", "protocol": "any", "subnets": [ "10.1.2.0/24" ] } ], "enabled": false, "hit_count": false, "trusted_hosts": [ "10.242.3.0/24" ] }, "radius": { "auth_servers": [ { "host": "1.2.3.4", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "port": 1, "secret": "testing123" } ], "auth_servers_retries": 3, "auth_servers_timeout": 5, "enabled": true, "network": "string", "use_different_radius": true }, "remove_existing_configs": false, "root_password": "pa$$word", "tacacs": { "acct_servers": [ { "host": "string", "port": "string", "secret": "pa$$word", "timeout": 10 } ], "default_role": "admin", "enabled": true, "network": "string", "tacplus_servers": [ { "host": "string", "port": "string", "secret": "pa$$word", "timeout": 10 } ] }, "use_mxedge_proxy": true }, "vrf_config": { "enabled": true }, "vrf_instances": { "guest": { "extra_routes": { "0.0.0.0/0": { "via": "192.168.31.1" } }, "networks": [ "guest" ] } }}createOrgNetworkTemplate POST
Create an organization network template with network, port usage, switch management, routing, NAC, and service configuration at the organization level. Network templates can be applied to multiple sites within the organization to provide consistent network configuration across sites. To assign a network template to a site, use the [Update Site](/api/mist/sites/updateSiteInfo) endpoint and specify the network template ID in the `networktemplate_id` field of the request body.
deleteOrgNetworkTemplate DELETE
Delete an organization network template by template ID so it can no longer be applied to sites or site groups.