Mist API Reference
Mist Automation Guide
HomeSDKsAPI ReferenceContext Plugin
OrgsNetwork Templates

createOrgNetworkTemplate

POST
/api/v1/orgs/{org_id}/networktemplates

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 endpoint and specify the network template ID in the networktemplate_id field of the request body.

Authorization

Authorization<token>

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

org_id*string
Formatuuid

Request Body

application/json

Request Body

Network template configuration applied to sites or site groups

acl_policies?array<>

ACL policy defaults provided by this network template

acl_tags?

ACL tags available to access policies in this network template

additional_config_cmds?array<>

Additional CLI configuration commands provided by this network template

bgp_config?

BGP routing defaults for this network template. Property key is the BGP session name

dhcp_snooping?

DHCP snooping defaults provided by this network template

dns_servers?array<string>

DNS servers provided by this network template

dns_suffix?array<string>

DNS search suffixes provided by this network template

extra_routes?

Additional IPv4 route defaults in this network template

extra_routes6?

Additional IPv6 route defaults in this network template

import_org_networks?array<string>

Organization network names imported into this network template

mist_nac?

Mist NAC defaults applied by this network template

multicast_config?

Multicast settings for networks in the master VRF (not assigned to any vrf_instances); PIM is automatically enabled when any master-VRF network has multicast.enabled==true

name?string

Display name of the network template

networks?

Layer 3 networks configured by this network template

ntp_servers?array<string>

NTP servers provided by this network template

ospf_areas?

OSPF area defaults provided by this network template

port_mirroring?

Port mirroring defaults provided by this network template

port_usages?

Reusable switch port usage profiles provided by this network template

radius_config?

RADIUS authentication and accounting defaults in this network template

remote_syslog?

Remote syslog defaults provided by this network template

remove_existing_configs?boolean

By default, only the configuration generated by Mist is cleaned up during the configuration process. If true, all the existing configuration will be removed.

Defaultfalse
routing_policies?

Routing policy defaults applied by this network template

snmp_config?

SNMP defaults provided by this network template

switch_matching?

Matching rules that select switches for this network template

switch_mgmt?

Management-plane settings applied when this matching rule matches

vrf_config?

VRF defaults applied by this network template

vrf_instances?

VRF instances configured by this network template

Response Body

curl -X POST "https://example.com/api/v1/orgs/000000ab-00ab-00ab-00ab-0000000000ab/networktemplates" \  -H "Content-Type: application/json" \  -d '{    "additional_config_cmds": [      "set snmp community public"    ],    "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"    ],    "import_org_networks": [      "ap"    ],    "mist_nac": {      "enabled": true,      "network": "string"    },    "name": "string",    "networks": {      "property1": {        "subnet": "192.168.1.0/24",        "vlan_id": 10      },      "property2": {        "subnet": "192.168.1.0/24",        "vlan_id": 10      }    },    "ntp_servers": [      "string"    ],    "port_usages": {      "dynamic": {        "mode": "dynamic",        "reset_default_when": "link_down",        "rules": [          {            "equals": "string",            "equals_any": [              "string"            ],            "expression": "string",            "src": "lldp_chassis_id",            "usage": "string"          }        ]      },      "property1": {        "all_networks": false,        "allow_dhcpd": true,        "bypass_auth_when_server_down": true,        "description": "string",        "disable_autoneg": false,        "disabled": false,        "duplex": "auto",        "enable_mac_auth": true,        "enable_qos": true,        "guest_network": "string",        "mac_auth_only": true,        "mac_auth_protocol": "pap",        "mac_limit": 0,        "mode": "access",        "networks": [          "string"        ],        "persist_mac": false,        "poe_disabled": false,        "port_auth": "dot1x",        "port_network": "string",        "server_reject_network": null,        "speed": "auto",        "storm_control": {          "no_broadcast": false,          "no_multicast": false,          "no_registered_multicast": false,          "no_unknown_unicast": false,          "percentage": 80        },        "stp_edge": true,        "voip_network": "string"      },      "property2": {        "all_networks": false,        "allow_dhcpd": true,        "bypass_auth_when_server_down": true,        "description": "string",        "disable_autoneg": false,        "disabled": false,        "duplex": "auto",        "enable_mac_auth": true,        "enable_qos": true,        "guest_network": "string",        "mac_auth_only": true,        "mac_auth_protocol": "pap",        "mac_limit": 0,        "mode": "access",        "networks": [          "string"        ],        "persist_mac": false,        "poe_disabled": false,        "port_network": "string",        "server_reject_network": null,        "speed": "auto",        "storm_control": {          "no_broadcast": false,          "no_multicast": false,          "no_registered_multicast": false,          "no_unknown_unicast": false,          "percentage": 80        },        "stp_edge": true,        "voip_network": "string"      }    },    "switch_mgmt": {      "config_revert_timer": 10,      "protect_re": {        "enabled": false      },      "root_password": "string",      "tacacs": {        "acct_servers": [          {            "host": "198.51.100.1",            "port": "49",            "secret": "string",            "timeout": 10          }        ],        "enabled": true,        "network": "string",        "tacplus_servers": [          {            "host": "198.51.100.1",            "port": "49",            "secret": "string",            "timeout": 10          }        ]      }    },    "vrf_config": {      "enabled": false    },    "vrf_instances": {      "property1": {        "extra_routes": {          "property1": {            "via": "192.0.2.10"          },          "property2": {            "via": "198.51.100.1"          }        },        "networks": [          "string"        ]      },      "property2": {        "extra_routes": {          "property1": {            "via": "198.51.100.1"          },          "property2": {            "via": "198.51.100.10"          }        },        "networks": [          "string"        ]      }    }  }'
{  "additional_config_cmds": [    "set snmp community public"  ],  "created_time": 0,  "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": {    "property1": {      "via": "string"    },    "property2": {      "via": "string"    }  },  "group_tags": {},  "id": "497f6eca-6276-4993-bfeb-53cbbbba6708",  "import_org_networks": [    "ap"  ],  "mist_nac": {    "enabled": true,    "network": "string"  },  "modified_time": 0,  "name": "string",  "networks": {    "property1": {      "subnet": "192.168.1.0/24",      "vlan_id": 10    },    "property2": {      "subnet": "192.168.1.0/24",      "vlan_id": 10    }  },  "ntp_servers": [    "string"  ],  "org_id": "a40f5d1f-d889-42e9-94ea-b9b33585fc6b",  "port_usages": {    "dynamic": {      "mode": "dynamic",      "reset_default_when": "link_down",      "rules": [        {          "equals": "string",          "equals_any": [            "string"          ],          "expression": "string",          "src": "lldp_chassis_id",          "usage": "string"        }      ]    },    "property1": {      "all_networks": false,      "allow_dhcpd": true,      "bypass_auth_when_server_down": true,      "description": "string",      "disable_autoneg": false,      "disabled": false,      "duplex": "auto",      "enable_mac_auth": true,      "enable_qos": true,      "guest_network": "string",      "mac_auth_only": true,      "mac_auth_protocol": "pap",      "mac_limit": 0,      "networks": [        "string"      ],      "persist_mac": false,      "poe_disabled": false,      "port_auth": "dot1x",      "port_network": "string",      "server_reject_network": null,      "speed": "auto",      "storm_control": {        "no_broadcast": false,        "no_multicast": false,        "no_registered_multicast": false,        "no_unknown_unicast": false,        "percentage": 80      },      "stp_edge": true,      "voip_network": "string"    },    "property2": {      "all_networks": false,      "allow_dhcpd": true,      "bypass_auth_when_server_down": true,      "description": "string",      "disable_autoneg": false,      "disabled": false,      "duplex": "auto",      "enable_mac_auth": true,      "enable_qos": true,      "guest_network": "string",      "mac_auth_only": true,      "mac_auth_protocol": "pap",      "mac_limit": 0,      "mode": "access",      "networks": [        "string"      ],      "persist_mac": false,      "poe_disabled": false,      "port_network": "string",      "server_reject_network": null,      "speed": "auto",      "storm_control": {        "no_broadcast": false,        "no_multicast": false,        "no_registered_multicast": false,        "no_unknown_unicast": false,        "percentage": 80      },      "stp_edge": true,      "voip_network": "string"    }  },  "switch_mgmt": {    "config_revert_timer": 10,    "protect_re": {      "enabled": false    },    "root_password": "string",    "tacacs": {      "acct_servers": [        {          "host": "198.51.100.1",          "port": "49",          "secret": "string",          "timeout": 10        }      ],      "enabled": true,      "network": "string",      "tacplus_servers": [        {          "host": "198.51.100.1",          "port": "49",          "secret": "string",          "timeout": 10        }      ]    }  },  "vrf_config": {    "enabled": false  },  "vrf_instances": {    "property1": {      "extra_routes": {        "property1": {          "via": "198.51.100.1"        },        "property2": {          "via": "198.51.100.10"        }      },      "networks": [        "string"      ]    },    "property2": {      "extra_routes": {        "property1": {          "via": "198.51.100.1"        },        "property2": {          "via": "198.51.100.10"        }      },      "networks": [        "string"      ]    }  }}

listOrgNetworkTemplates GET

List organization network templates that provide switch network, port, management, routing, NAC, and service configuration at the organization level.

getOrgNetworkTemplate GET

Retrieve details for a specific organization network template, including network, port usage, switch management, routing, NAC, and service defaults.