Juniper Mist AI Sites Wlans API
A Site Wlan is a wireless local area network that is configured and applied to a specific site within an organization.It allows for the creation and management of wireless network settings, such as SSIDs (service set identifiers), authentication settings, VLAN configurations, etc... for a particular site.Site Wlans are created and managed at the site level and can only be referenced and used within that particular site.
Juniper Mist AI Sites Wlans 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 Wlans. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 9 operations across 5 paths, and defines 117 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.
9 operations
5 paths
117 schemas
2 DELETE3 GET2 POST2 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 3
Juniper Mist AI Sites Wlans 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 9
Across 5 paths, the API surfaces 9 operations — 2 DELETE, 3 GET, 2 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.
Sites Wlans 9
A Site Wlan is a wireless local area network that is configured and applied to a specific site within an organization. It allows for the creation and management of wireless networ…
GET
/api/v1/sites/{site_id}/wlans
listSiteWlans
POST
/api/v1/sites/{site_id}/wlans
createSiteWlan
GET
/api/v1/sites/{site_id}/wlans/derived
listSiteWlansDerived
DELETE
/api/v1/sites/{site_id}/wlans/{wlan_id}
deleteSiteWlan
GET
/api/v1/sites/{site_id}/wlans/{wlan_id}
getSiteWlan
PUT
/api/v1/sites/{site_id}/wlans/{wlan_id}
updateSiteWlan
DELETE
/api/v1/sites/{site_id}/wlans/{wlan_id}/portal_image
deleteSiteWlanPortalImage
POST
/api/v1/sites/{site_id}/wlans/{wlan_id}/portal_image
uploadSiteWlanPortalImage
PUT
/api/v1/sites/{site_id}/wlans/{wlan_id}/portal_template
updateSiteWlanPortalTemplate
Schemas 117
The contract defines 117 schemas that model the data the API accepts and returns. The most detailed are wlan_portal_template_setting (162 properties), wlan (105 properties), wlan_portal_template_setting_locale (98 properties), wlan_portal (76 properties). Each schema is shown below with its type and property counts.
wlan_mxtunnel_ids
array
When interface=mxtunnel, id of the Mist Tunnel
wlan_cisco_cwa_allowed_hostnames
array
List of hostnames without http(s):// (matched by substring)
coa_server
object
CoA Server
5 properties
2 required
strings
array
wlan_bonjour
object
Bonjour gateway wlan settings
3 properties
wlan_portal_sponsors
Object of allowed sponsors email with name. Required if sponsorenabled is true and sponsoremaildomains is empty. Property key is the sponsor email, Property va…
wlan_portal_template_setting
object
Portal template wlan settings
162 properties
1 required
hour
string
Hour range of the day (e.g. 09:00-17:00). If the hour is not defined then it's treated as 00:00-23:59.
wlan_schedule
object
WLAN operating schedule, default is disabled
2 properties
radsec_idle_timeout
Radsec Idle Timeout in seconds. Default is 60
radius_acct_port
Radius Auth Port, value from 1 to 65535, default is 1813
wlan_bonjour_service_properties_scope
string
how bonjour services should be discovered for the same WLAN. enum: sameap, samemap, samesite
wlan_bonjour_service_properties
object
3 properties
wlan_dynamic_vlan_default_vlan_ids
array
Default VLAN ID(s) can be a number, a range of VLAN IDs, a variable or multiple numbers, ranges or variables as a VLAN pool. Default VLAN as a pool of VLANS re…
radius_coa_port
Radius CoA Port, value from 1 to 65535, default is 3799
wlan_portal_allowed_subnets
array
List of CIDRs
wlan_portal
object
Portal wlan settings
76 properties
wlan_auth_servers
array
List of RADIUS authentication servers, at least one is needed if auth type==eap, order matters where the first one is treated as primary
wlan_auth_pairwise
array
When type=psk or type=eap, one or more of wpa1-ccmp, wpa1-tkip, wpa2-ccmp, wpa2-tkip, wpa3
wlan_ap_ids
arraynull
List of device ids
wlan_auth_type
string
enum: eap, eap192, open, psk, psk-tkip, psk-wpa2-tkip, wep
wlan_portal_idp_sign_algo
string
Optional if wlanportalauth==sso, Signing algorithm for SAML Assertion. enum: sha1, sha256, sha384, sha512
wlan_portal_template_setting_locale
object
98 properties
radsec_servers
array
List of RadSec Servers. Only if not Mist Edge.
wlan_hotspot20_domain_name
array
wlan_hotspot_20
object
Hostspot 2.0 wlan settings
6 properties
coa_servers
array
List of COA (change of authorization) servers, optional
response_http401
object
1 property
wlan_rateset
object
Property key is the RF band. enum: 24, 5, 6
wlan_portal_microsoft_email_domains
array
Optional if microsoftenabled==true. Matches authenticated user email against provided domains. If null or [], all authenticated emails will be allowed.
wlan_vlan_id_with_variable
radius_acct_server
object
7 properties
2 required
dynamic_psk_source
string
enum: cloudpsks, radius
radius_auth_port
Radius Auth Port, value from 1 to 65535, default is 1812
wlan_portal_sso_nameid_format
string
Optional if wlanportalauth==sso. enum: email, unspecified
radsec_proxy_hosts
array
Default is site.mxedge.radsec.proxyhosts which must be a superset of all wlans[].radsec.proxyhosts. When radsec.proxyhosts are not used, tunnel peers (org or s…
wlan_vlan_ids_string
string
If vlanenabled==true and vlanpooling==true. List of VLAN IDs to be used in the VLAN Pool
wlan_qos_class
string
enum: background, besteffort, video, voice
wlan_wxtag_ids
arraynull
List of wxtagids
radius_auth_server
object
Authentication Server
8 properties
2 required
wlan_cisco_cwa_allowed_subnets
array
List of CIDRs
wlan_hotspot20_operators_item
string
enum: ameriband, att, boingo, charter, eduroam, globalreach, google, hughessystique, openroaminglegacy, openroamingsettled, openroamingsettlementfree, singledi…
vlan_id_with_variable
wlan_dynamic_vlan_default_vlan_id
VLAN ID, VLAN range or variable to use when there’s no match from RADIUS
additional_vlan_ids_array
array
wlan_auth_server_selection
string
When ordered, AP will prefer and go back to the first server if possible. enum: ordered, unordered
wlan_hotspot20_operators
array
List of operators to support
msp_id
string
wlan_portal_auth
string
authentication scheme. enum: amazon, azure, email, external, facebook, google, microsoft, multi, none, password, sms, sponsor, sso
wlan_datarates_legacy
array
If template==custom. List of supported rates (IE=1) and extended supported rates (IE=50) for custom template, append ‘b’ at the end to indicate a rate being ba…
wlan_apply_to
string
enum: aps, site, wxtags
wlan_dynamic_vlan_local_vlan_ids
array
VLANids to be locally bridged
wlan_portal_google_email_domains
array
Optional if googleenabled==true. Matches authenticated user email against provided domains. If null or [], all authenticated emails will be allowed.
wlan_mxtunnel_name
array
When interface=sitemxedge, name of the mxtunnel that in mxtunnels under Site Setting
created_time
number
When the object has been created, in epoch
wlan_roam_mode
string
enum: 11r, OKC, NONE
wlan
object
Note: portaltemplate will be forked out of wlan objects soon. To fetch portaltemplate, please query portaltemplateurl. To update portaltemplate, use Wlan Porta…
105 properties
1 required
image_import
object
2 properties
1 required
sponsor_link_validity_duration
Optional if sponsorenabled==true. How long to remain valid sponsored guest request approve/deny link received in email, in minutes. Value is between 5 and 60.
portal_template_alignment
string
defines alignment on portal. enum: center, left, right
wlan_airwatch
object
Airwatch wlan settings
5 properties
wlan_portal_facebook_email_domains
array
Optional if facebookenabled==true. Matches authenticated user email against provided domains. If null or [], all authenticated emails will be allowed.
wlan_vlan_ids
additional_vlan_ids
List or Comma separated list of additional VLAN IDs (on the LAN side or from other WLANs) should we be forwarding bonjour queries/responses
wlan_portal_sponsors_object
object
wlan_qos
object
2 properties
radius_keywrap_format
string
enum: ascii, hex
wlan_portal_sponsors_list
array
wlan_hotspot20_rcoi
array
wlan_dns_server_rewrite
objectnull
For radiusgroup-based DNS server (rewrite DNS request depending on the Group RADIUS server returns)
2 properties
wlan_cisco_cwa_blocked_subnets
array
List of blocked CIDRs
wlan_auth_keys
array
When type=wep, four 10-character or 26-character hex string, null can be used. All keys, if provided, have to be in the same length
wlan_mist_nac
object
9 properties
wlan_auth_pairwise_item
stringnull
enum: wpa1-ccmp, wpa1-tkip, wpa2-ccmp, wpa2-tkip, wpa3
response_http429
object
1 property
hours
object
Days/Hours of operation filter, the available days (mon, tue, wed, thu, fri, sat, sun)
7 properties
wlan_limit
In kbps, value from 1 to 999000
wlan_dynamic_vlan
objectnull
For 802.1x
6 properties
wlan_bonjour_service_properties_radius_groups
array
Optional, if the service is further restricted for certain RADIUS groups
wlan_dynamic_psk
objectnull
For dynamic PSK where we get peruser PSK from Radius. dynamicpsk allows PSK to be selected at runtime depending on context (wlan/site/user/...) thus following…
5 properties
org_id
string
wlan_app_qos_others
array
wlan_portal_sponsor_email_domains
array
List of domain allowed for sponsor email. Required if sponsorenabled is true and sponsors is empty.
wlan_portal_denied_hostnames
array
List of hostnames without http(s):// (matched by substring), this takes precedence over portalallowedhostnames
id
string
Unique ID of the object instance in the Mist Organization
radsec_mxcluster_ids
array
To use Org mxedges when this WLAN does not use mxtunnel, specify their mxclusterids. Org mxedge(s) identified by mxclusterids
wlan_dynamic_vlan_default_vlan_id_deprecated
vlanid to use when there’s no match from RADIUS
response_http403
object
1 property
wlan_dynamic_vlan_type
string
standard (using Tunnel-Private-Group-ID, widely supported), airespace-interface-name (Airespace/Cisco). enum: airespace-interface-name, standard
radsec
object
RadSec settings
9 properties
wlan_app_qos
object
APP qos wlan settings
3 properties
wlan_bands
array
List of radios that the wlan should apply to. enum: 24, 5, 5-dedicated, 5-selectable, 6, 6-dedicated, 6-selectable
wlan_auth
object
Authentication wlan settings
14 properties
1 required
radsec_server
object
2 properties
wlan_datarates
object
Data rates wlan settings
7 properties
site_id
string
wlan_portal_template
object
1 property
response_http404
object
1 property
wlan_datarates_template
stringnull
Data Rates template to apply. enum: no-legacy: no 11b compatible: all, like before, default setting that Broadcom/Atheros used legacy-only: disable 802.11n and…
wlan_portal_amazon_email_domains
array
Optional if amazonenabled==true. Matches authenticated user email against provided domains. If null or [], all authenticated emails will be allowed.
wlan_vlan_ids_list
array
If vlanenabled==true and vlanpooling==true. List of VLAN IDs (comma separated) to be used in the VLAN Pool
wlan_datarates_legacy_item
string
enum: 1, 11, 11b, 12, 12b, 18, 18b, 1b, 2, 24, 24b, 2b, 36, 36b, 48, 48b, 5.5, 5.5b, 54, 54b, 6, 6b, 9, 9b
response_http400
object
1 property
wlan_auth_owe
string
if type==open. enum: disabled, enabled (means transition mode), required
wlan_acct_servers
array
List of RADIUS accounting servers, optional, order matters where the first one is treated as primary
wlan_app_qos_others_item
object
5 properties
wlans
array
dscp
DSCP value range between 0 and 63
dot11_band
string
enum: 24, 5, 5-dedicated, 5-selectable, 6, 6-dedicated, 6-selectable
wlan_cisco_cwa
object
Cisco CWA (central web authentication) required RADIUS with COA in order to work. See CWA: https://www.cisco.com/c/en/us/support/docs/security/identity-service…
4 properties
wlan_app_qos_apps_properties
object
3 properties
wlan_inject_dhcp_option_82
object
2 properties
wlan_interface
string
where this WLAN will be connected to. enum: all, eth0, eth1, eth2, eth3, mxtunnel, sitemxedge, wxtunnel
wlan_portal_sms_provider
string
Optional if smsenabled==true. enum: broadnet, clickatell, gupshup, manual, puzzel, smsglobal, telstra, twilio
wlan_portal_allowed_hostnames
array
List of hostnames without http(s):// (matched by substring)
modified_time
number
When the object has been modified for the last time, in epoch
wlan_app_limit
object
Bandwidth limiting for apps (applies to up/down)
3 properties
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 Wlans