OrgsWlans

createOrgWlan

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

Create Org Wlan

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

Note: portal_template will be forked out of wlan objects soon. To fetch portal_template, please query portal_template_url. To update portal_template, use Wlan Portal Template.

acct_immediate_update?boolean

Enable coa-immediate-update and address-change-immediate-update on the access profile.

Defaultfalse
acct_interim_interval?integer

How frequently should interim accounting be reported, 60-65535. default is 0 (use one specified in Access-Accept request from RADIUS Server). Very frequent messages can affect the performance of the RADIUS server, 600 and up is recommended when enabled

Range0 <= value <= 65535
Default0
acct_servers?array<>

RADIUS accounting servers used by this WLAN

airwatch?

Integration settings for AirWatch device compliance on this WLAN

allow_ipv6_ndp?boolean

Only applicable when limit_bcast==true, which allows or disallows ipv6 Neighbor Discovery packets to go through

Defaulttrue
allow_mdns?boolean

Only applicable when limit_bcast==true, which allows mDNS / Bonjour packets to go through

Defaultfalse
allow_ssdp?boolean

Only applicable when limit_bcast==true, which allows SSDP

Defaultfalse
ap_ids?array<>|

Access point identifiers used when apply_to==aps

app_limit?

Bandwidth limits for applications on this WLAN

app_qos?

QoS rules for application traffic on this WLAN

apply_to?wlan_apply_to

Scope that determines where this WLAN is applied. enum: aps, site, wxtags.

Value in

  • "aps"
  • "site"
  • "wxtags"
arp_filter?boolean

Whether to enable smart arp filter

Defaultfalse
auth?

Settings that control client authentication for this WLAN

auth_server_selection?wlan_auth_server_selection

RADIUS authentication server selection behavior for this WLAN. enum: ordered, unordered.

Default"ordered"

Value in

  • "ordered"
  • "unordered"
auth_servers?array<>

RADIUS authentication servers used by this WLAN. Required when auth.type==eap

auth_servers_nas_id?|

Optional, up to 48 bytes, will be dynamically generated if not provided. used only for authentication servers

auth_servers_nas_ip?|

Optional, NAS-IP-ADDRESS to use

auth_servers_retries?integer

RADIUS auth session retries. Following fast timers are set if "fast_dot1x_timers" knob is enabled. ‘retries’ are set to value of auth_servers_retries. ‘max-requests’ is also set when setting auth_servers_retries and is set to default value to 3.

Default2
auth_servers_timeout?integer

RADIUS auth session timeout. Following fast timers are set if "fast_dot1x_timers" knob is enabled. ‘quite-period’ and ‘transmit-period’ are set to half the value of auth_servers_timeout. ‘supplicant-timeout’ is also set when setting auth_servers_timeout and is set to default value of 10.

Default5
band?string
Deprecated

band is deprecated and kept for backward compatibility. Use bands instead

band_steer?boolean

Whether to enable band_steering, this works only when band==both

Defaultfalse
band_steer_force_band5?boolean

Force dual_band capable client to connect to 5G

Defaultfalse
bands?array<>

Radio bands on which this WLAN is broadcast

Default

[  "24",  "5",  "6"]
block_blacklist_clients?boolean

Whether to block the clients in the blacklist (up to first 256 macs)

Defaultfalse
bonjour?

Service discovery gateway settings for Bonjour traffic on this WLAN

cisco_cwa?

Central web authentication settings for Cisco CWA on this WLAN

client_limit_down?|

Downlink bandwidth limit applied per client

client_limit_down_enabled?boolean

If downlink limiting per-client is enabled

Defaultfalse
client_limit_up?|

Downlink bandwidth limit applied per client

client_limit_up_enabled?boolean

If uplink limiting per-client is enabled

Defaultfalse
coa_servers?array<>

RADIUS Change of Authorization servers available to this WLAN

disable_11ax?boolean

Some old WLAN drivers may not be compatible

Defaultfalse
disable_11be?boolean

To disable Wi-Fi 7 EHT IEs

Defaultfalse
disable_ht_vht_rates?boolean

To disable ht or vht rates

Defaultfalse
disable_message_authenticator_check?boolean

whether to disable Message-Authenticator Check, which is used to verify the integrity of RADIUS messages, default is false (i.e. for better security)

Defaultfalse
disable_uapsd?boolean

Whether to disable U-APSD

Defaultfalse
disable_v1_roam_notify?boolean

Disable sending v2 roam notification messages

Defaultfalse
disable_v2_roam_notify?boolean

Disable sending v2 roam notification messages

Defaultfalse
disable_when_gateway_unreachable?boolean

When any of the following is true, this WLAN will be disabled

  • cannot get IP
  • cannot obtain default gateway
  • cannot reach default gateway
Defaultfalse
disable_when_mxtunnel_down?boolean

Whether to disable this WLAN when the configured Mist tunnel is down

Defaultfalse
disable_wmm?boolean

Whether to disable WMM

Defaultfalse
dns_server_rewrite?|

RADIUS group based DNS server rewrite settings for this WLAN

dtim?integer

Delivery Traffic Indication Message interval for this WLAN

Default2
dynamic_psk?|

Per-user PSK selection settings for this WLAN

dynamic_vlan?|

VLAN assignment settings for 802.1X dynamic VLANs

enable_ftm?boolean

Enable FTM (Fine-Time Measurement, 802.11mc); configures the AP as an FTM Responder (target), allowing clients to perform ranging requests against it

Defaultfalse
enable_local_keycaching?boolean

Enable AP-AP keycaching via multicast

Defaultfalse
enable_wireless_bridging?boolean

By default, we'd inspect all DHCP packets and drop those unrelated to the wireless client itself in the case where client is a wireless bridge (DHCP packets for other MACs will need to be forwarded), wireless_bridging can be enabled

Defaultfalse
enable_wireless_bridging_dhcp_tracking?boolean

If the client bridge is doing DHCP on behalf of other devices (L2-NAT), enable dhcp_tracking will cut down DHCP response packets to be forwarded to wireless

Defaultfalse
enabled?boolean

If this wlan is enabled

Defaulttrue
fast_dot1x_timers?boolean

If set to true, sets default fast-timers with values calculated from ‘auth_servers_timeout’ and ‘auth_server_retries’ .

Defaultfalse
hide_ssid?boolean

Whether to hide SSID in beacon

Defaultfalse
hostname_ie?boolean

Include hostname inside IE in AP beacons / probe responses

Defaultfalse
hotspot20?

Passpoint and Hotspot 2.0 settings for this WLAN

inject_dhcp_option_82?

DHCP Option 82 insertion settings for this WLAN

interface?wlan_interface

Network interface or tunnel where this WLAN bridges client traffic. enum: all, eth0, eth1, eth2, eth3, mxtunnel, site_mxedge, wxtunnel.

Default"all"

Value in

  • "all"
  • "eth0"
  • "eth1"
  • "eth2"
  • "eth3"
  • "mxtunnel"
  • "site_mxedge"
  • "wxtunnel"
isolation?boolean

Whether to stop clients to talk to each other

Defaultfalse
l2_isolation?boolean

If isolation is enabled, whether to deny clients to talk to L2 on the LAN

Defaultfalse
legacy_overds?boolean

Legacy devices requires the Over-DS (for Fast BSS Transition) bit set (while our chip doesn’t support it). Warning! Enabling this will cause problem for iOS devices.

Defaultfalse
limit_bcast?boolean

Whether to limit broadcast packets going to wireless (i.e. only allow certain bcast packets to go through)

Defaultfalse
limit_probe_response?boolean

Limit probe response base on some heuristic rules

Defaultfalse
max_idletime?integer

Max idle time in seconds

Range60 <= value <= 86400
Default1800
max_num_clients?integer

Maximum number of client connected to the SSID. 0 means unlimited

Range0 <= value <= 128
Default0
mist_nac?

Juniper Mist NAC settings used by this WLAN

mxtunnel_id?string
Deprecated

(deprecated, use mxtunnel_ids instead) when interface==mxtunnel, id of the Mist Tunnel

Formatuuid
mxtunnel_ids?array<string>

Mist Tunnel identifiers used when interface==mxtunnel

Formatuuid
mxtunnel_name?array<>

Mist Tunnel names used when interface==site_mxedge

no_static_dns?boolean

Whether to only allow client to use DNS that we’ve learned from DHCP response

Defaultfalse
no_static_ip?boolean

Whether to only allow client that we’ve learned from DHCP exchange to talk

Defaultfalse
portal?

Guest portal settings for this WLAN

portal_allowed_hostnames?array<string>

Guest portal hostnames that clients may reach before authorization

Default[]
portal_allowed_subnets?array<string>

Guest portal CIDR subnets that clients may reach before authorization

Default[]
portal_api_secret?|

API secret (auto-generated) that can be used to sign guest authorization requests, only generated when auth is set to external

Default""
portal_denied_hostnames?array<string>

Guest portal hostnames denied before authorization, taking precedence over allowed hostnames

Default[]
qos?

Quality-of-service settings for WLAN client traffic

radsec?

TLS-secured RADIUS transport settings for this WLAN

rateset?

Data rate settings by RF band for this WLAN

reconnect_clients_when_roaming_mxcluster?boolean

When different mxcluster is on different subnet, we'd want to disconnect clients (so they'll reconnect and get new IPs)

Defaultfalse
roam_mode?wlan_roam_mode

Fast roaming mode configured for this WLAN. enum: 11r, NONE, OKC.

Default"NONE"

Value in

  • "11r"
  • "NONE"
  • "OKC"
schedule?

Operating schedule controlling when this WLAN is active

sle_excluded?boolean

Whether to exclude this WLAN from SLE metrics

Defaultfalse
ssid*string

Name of the SSID

template_id?|

Identifier of the WLAN template associated with this WLAN

Formatuuid
Default""
use_eapol_v1?boolean

If auth.type==eap or auth.type==psk, should only be set for legacy client, such as pre-2004, 802.11b devices

Defaultfalse
vlan_enabled?boolean

If vlan tagging is enabled

Defaultfalse
vlan_id?||

Default VLAN ID, range, or variable used when vlan_enabled==true

vlan_ids?|array<|>

Pool of VLAN IDs used when vlan_enabled==true and vlan_pooling==true

vlan_pooling?boolean

Requires vlan_enabled==true to be set to true. Vlan pooling allows AP to place client on different VLAN using a deterministic algorithm

Defaultfalse
wlan_limit_down?|

Downlink bandwidth limit applied per client

wlan_limit_down_enabled?boolean

If downlink limiting for whole wlan is enabled

Defaultfalse
wlan_limit_up?|

Downlink bandwidth limit applied per client

wlan_limit_up_enabled?boolean

If uplink limiting for whole wlan is enabled

Defaultfalse
wxtag_ids?array<>|

Identifiers of WxLAN tags used when apply_to==wxtags

wxtunnel_id?|

When interface=wxtunnel, id of the WXLAN Tunnel

Default""
wxtunnel_remote_id?|

When interface=wxtunnel, remote tunnel identifier

Default""

Response Body

curl -X POST "https://example.com/api/v1/orgs/000000ab-00ab-00ab-00ab-0000000000ab/wlans" \  -H "Content-Type: application/json" \  -d '{    "ssid": "corporate"  }'
{  "allow_ipv6_ndp": true,  "allow_mdns": false,  "allow_ssdp": false,  "arp_filter": false,  "band_steer": false,  "band_steer_force_band5": false,  "bands": [    "24",    "5"  ],  "block_blacklist_clients": false,  "bonjour": {    "additional_vlan_ids": "10, 20",    "enabled": false,    "services": {      "airplay": {        "radius_groups": [          "teachers"        ],        "scope": "same_ap"      }    }  },  "client_limit_down": 1000,  "client_limit_down_enabled": false,  "client_limit_up": 512,  "client_limit_up_enabled": false,  "disable_11ax": false,  "disable_ht_vht_rates": false,  "disable_uapsd": false,  "disable_v1_roam_notify": false,  "disable_v2_roam_notify": false,  "disable_wmm": false,  "dynamic_vlan": {    "default_vlan_id": 999,    "enabled": false,    "local_vlan_ids": [      1    ],    "type": "airespace-interface-name",    "vlans": {      "131": "default",      "322": "fast,video"    }  },  "enable_local_keycaching": false,  "enable_wireless_bridging": false,  "enabled": true,  "fast_dot1x_timers": false,  "hide_ssid": false,  "hostname_ie": false,  "ssid": "demo"}