HomeGuidesAPI Reference
GuidesAPI ReferenceGitHubAirheads Developer CommunityLog In
API Reference

Create a new WLAN.

Create a new WLAN.

Path Params
string
required

Group name of the group or guid of the swarm or serial number of 10x AP.
Example:Group_1 or 6a5d123b01f9441806244ea6e023fab5841b77c828a085f04f or CNF7JSS9L1.

string
required

Name of WLAN to create.
Example:wlan_1.

Body Params

Data of the new WLAN.

string

"wlan": {
"a_max_tx_rate": "54",
"a_min_tx_rate":"6",
"access_type":"unrestricted",
"accounting_server1":"",
"accounting_server2":"",
"air_time_limit":"",
"air_time_limit_cb":false,
"auth_cache_timeout":24,
"auth_req_threshold":0,
"auth_server1":"as1",
"auth_server2":"",
"auth_survivability":false,
"bandwidth_limit":"",
"bandwidth_limit_cb":false,
"blacklist":true,
"broadcast_filter":"arp",
"called_station_id_deli":0,
"called_station_id_incl_ssid":false,
"called_station_id_type":"macaddr",
"captive_exclude":[

],
"captive_portal":"disable",
"captive_portal_proxy_ip":"",
"captive_portal_proxy_port":"",
"captive_profile_name":"",
"cloud_guest":false,
"cluster_name":"",
"content_filtering":false,
"deny_intra_vlan_traffic":false,
"disable_ssid":false,
"dmo_channel_util_threshold":90,
"dot11k":false,
"dot11r":false,
"dot11v":false,
"download_role":false,
"dtim_period":1,
"dynamic_multicast_optimization":false,
"wpa_passphrase_changed":false,
"okc":false,
"dynamic_vlans":[

],
"enforce_dhcp":false,
"essid":"wlan1",
"explicit_ageout_client":false,
"g_max_tx_rate":"54",
"g_min_tx_rate":"1",
"gw_profile_name":"",
"hide_ssid":false,
"high_efficiency_disable":true,
"high_throughput_disable":true,
"inactivity_timeout":1000,
"index":1,
"l2_auth_failthrough":false,
"l2switch_mode":false,
"leap_use_session_key":false,
"local_probe_req_threshold":0,
"mac_authentication":false,
"mac_authentication_delimiter":"",
"mac_authentication_upper_case":false,
"management_frame_protection":false,
"max_auth_failures":0,
"max_clients_threshold":64,
"mdid":"",
"multicast_rate_optimization":false,
"name":"wlan1",
"okc_disable":false,
"oos_def":"vpn-down",
"oos_name":"none",
"oos_time":30,
"opmode":"wpa3-aes-ccm-128",
"opmode_transition_disable":true,
"per_user_limit":"",
"per_user_limit_cb":false,
"radius_accounting":false,
"radius_accounting_mode":"user-authentication",
"radius_interim_accounting_interval":0,
"reauth_interval":0,
"rf_band":"all",
"roles":[

],
"server_load_balancing":false,
"set_role_mac_auth":"",
"set_role_machine_auth_machine_only":"",
"set_role_machine_auth_user_only":"",
"set_role_pre_auth":"",
"ssid_encoding":"utf8",
"strict_svp":false,
"termination":false,
"time_range_profiles_status":[

],
"tspec":false,
"tspec_bandwidth":2000,
"type":"employee",
"use_ip_for_calling_station":false,
"user_bridging":false,
"very_high_throughput_disable":true,
"vlan":"",
"wep_index":0,
"wep_key":"",
"wispr":false,
"wmm_background_dscp":"",
"wmm_background_share":0,
"wmm_best_effort_dscp":"",
"wmm_best_effort_share":0,
"wmm_uapsd":true,
"wmm_video_dscp":"",
"wmm_video_share":0,
"wmm_voice_dscp":"",
"wmm_voice_share":0,
"work_without_uplink":false,
"wpa_passphrase":"",
"zone":"",
"hotspot_profile":""
},
"access_rule": {
"name":"wlan1",
"action":"allow",
"app_rf_mv_info":"",
"blacklist":false,
"classify_media":false,
"disable_scanning":false,
"dot1p_priority":"",
"eport":"any",
"ipaddr":"any",
"log":false,
"match":"match",
"nat_ip":"",
"nat_port":0,
"netmask":"any",
"protocol":"any",
"protocol_id":"",
"service_name":"",
"service_type":"network",
"source":"default",
"sport":"any",
"throttle_downstream":"",
"throttle_upstream":"",
"time_range":"",
"tos":"",
"vlan":0
}

Responses
200

Successful operation.

304

Not Modified.

401

Unauthorized access, authentication required.

403

Forbidden, do not have write access for group.

413

Request-size limit exceeded.

417

Request-size limit exceeded.

429

API Rate limit exceeded.

default

the default response

Language
Credentials
Bearer
URL
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json