listSiteWlansDerived
Get the list of derived Wlans for a Site
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
uuidQuery Parameters
Whether to resolve SITE_VARS
falseFilter by WLAN ID
Response Body
curl -X GET "https://example.com/api/v1/sites/000000ab-00ab-00ab-00ab-0000000000ab/wlans/derived"[ { "acct_immediate_update": false, "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" } ], "airwatch": { "api_key": "aHhlbGxvYXNkZmFzZGZhc2Rmc2RmCg==\"", "console_url": "https://hs1.airwatchportals.com", "enabled": false, "password": "user1", "username": "test123" }, "allow_ipv6_ndp": true, "allow_mdns": false, "allow_ssdp": false, "ap_ids": [ "55b52480-965f-447f-a328-756805340652" ], "app_limit": { "apps": { "dropbox": 300, "netflix": 60 }, "enabled": false, "wxtag_ids": { "f99862d9-2726-931f-7559-3dfdf5d070d3": 30 } }, "app_qos": { "apps": { "skype-business-video": { "dscp": 32, "dst_subnet": "10.2.0.0/16", "src_subnet": "10.2.0.0/16" } }, "enabled": false, "others": [ { "dscp": "string", "dst_subnet": "10.2.0.0/16", "port_ranges": "80,1024-6553", "protocol": "udp", "src_subnet": "10.2.0.0/16" } ] }, "apply_to": "aps", "arp_filter": false, "auth": { "anticlog_threshold": 16, "eap_reauth": false, "enable_beacon_protection": false, "enable_gcmp256": false, "enable_mac_auth": false, "key_idx": 1, "keys": [], "multi_psk_only": false, "owe": "disabled", "pairwise": [ "wpa2-ccmp" ], "private_wlan": false, "psk": "foryoureyesonly", "type": "psk", "wep_as_secondary_auth": false }, "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_nas_id": "5c5b350e0101-nas", "auth_servers_nas_ip": "15.3.1.5", "auth_servers_retries": 5, "auth_servers_timeout": 5, "band": "string", "band_steer": false, "band_steer_force_band5": false, "bands": [ "24", "5", "6" ], "block_blacklist_clients": false, "bonjour": { "additional_vlan_ids": "string", "enabled": false, "services": { "airplay": { "radius_groups": [ "teachers" ], "scope": "same_ap" } } }, "cisco_cwa": { "allowed_hostnames": [ "snapchat.com" ], "allowed_subnets": [ "63.5.3.0/24" ], "blocked_subnets": [ "192.168.0.0/16" ], "enabled": false }, "client_limit_down": 1, "client_limit_down_enabled": false, "client_limit_up": 1, "client_limit_up_enabled": false, "coa_servers": [ { "disable_event_timestamp_check": false, "enabled": false, "ip": "1.2.3.4", "port": 1, "secret": "testing456" } ], "created_time": 0.1, "disable_11ax": false, "disable_11be": false, "disable_ht_vht_rates": false, "disable_message_authenticator_check": false, "disable_uapsd": false, "disable_v1_roam_notify": false, "disable_v2_roam_notify": false, "disable_when_gateway_unreachable": false, "disable_when_mxtunnel_down": false, "disable_wmm": false, "dns_server_rewrite": { "enabled": false, "radius_groups": { "contractor": "172.1.1.1", "guest": "8.8.8.8" } }, "dtim": 2, "dynamic_psk": { "default_psk": "foryoureyesonly", "default_vlan_id": "string", "enabled": false, "force_lookup": false, "local_vlan_ids": [ "string" ], "source": "cloud_psks" }, "dynamic_vlan": { "default_vlan_id": "string", "default_vlan_ids": [ "string" ], "enabled": false, "local_vlan_ids": [ "string" ], "type": "airespace-interface-name", "vlans": { "131": "default", "322": "fast,video" } }, "enable_ftm": false, "enable_local_keycaching": false, "enable_wireless_bridging": false, "enable_wireless_bridging_dhcp_tracking": false, "enabled": true, "fast_dot1x_timers": false, "for_site": true, "hide_ssid": false, "hostname_ie": false, "hotspot20": { "domain_name": [ "mist.com" ], "enabled": true, "nai_realms": [ "string" ], "operators": [ "google", "att" ], "rcoi": [ "5A03BA0000" ], "venue_name": "some_name" }, "id": "53f10664-3ce8-4c27-b382-0ef66432349f", "inject_dhcp_option_82": { "circuit_id": "{{SSID}}:{{AP_MAC}}", "enabled": false }, "interface": "all", "isolation": false, "l2_isolation": false, "legacy_overds": false, "limit_bcast": false, "limit_probe_response": false, "max_idletime": 1800, "max_num_clients": 0, "mist_nac": { "acct_interim_interval": 60, "auth_servers_retries": 3, "auth_servers_timeout": 5, "coa_enabled": false, "coa_port": 3799, "enabled": false, "fast_dot1x_timers": false, "network": "default", "source_ip": "1.2.3.4" }, "modified_time": 0.1, "msp_id": "b9d42c2e-88ee-41f8-b798-f009ce7fe909", "mxtunnel_id": "6741baab-cbd6-45bd-9e5b-93e8eede3c80", "mxtunnel_ids": [ "08cd7499-5841-51c8-e663-fb16b6f3b45e" ], "mxtunnel_name": [ "default" ], "no_static_dns": false, "no_static_ip": false, "org_id": "a97c1b22-a4e9-411e-9bfd-d8695a0f9e61", "portal": { "allow_wlan_id_roam": false, "amazon_client_id": "", "amazon_client_secret": "", "amazon_email_domains": [], "amazon_enabled": false, "amazon_expire": null, "auth": "none", "azure_client_id": "", "azure_client_secret": "", "azure_enabled": false, "azure_expire": null, "azure_tenant_id": "", "broadnet_password": "password", "broadnet_sid": "MIST", "broadnet_user_id": "juniper", "bypass_when_cloud_down": false, "clickatell_api_key": "string", "cross_site": false, "email_enabled": false, "enabled": false, "expire": 1440, "external_portal_url": "", "facebook_client_id": "", "facebook_client_secret": "", "facebook_email_domains": [], "facebook_enabled": false, "facebook_expire": null, "forward": false, "forward_url": "https://abc.com/promotions", "google_client_id": "", "google_client_secret": "", "google_email_domains": [ "mydomain.edu", "mydomain.org" ], "google_enabled": false, "google_expire": null, "gupshup_password": "pa$$word", "gupshup_userid": "string", "microsoft_client_id": "", "microsoft_client_secret": "", "microsoft_email_domains": [], "microsoft_enabled": false, "microsoft_expire": null, "passphrase_enabled": false, "passphrase_expire": null, "password": "let me in", "predefined_sponsors_enabled": true, "predefined_sponsors_hide_email": false, "privacy": false, "puzzel_password": "pa$$word", "puzzel_service_id": "string", "puzzel_username": "string", "smsMessageFormat": "Code {{code}} expires in {{duration}} minutes.", "sms_enabled": false, "sms_expire": null, "sms_provider": "twilio", "smsglobal_api_key": "string", "smsglobal_api_secret": "pa$$word", "smsglobal_sender": "string", "sponsor_auto_approve": false, "sponsor_email_domains": [ "reserved.net", "reserved.org" ], "sponsor_enabled": false, "sponsor_expire": null, "sponsor_link_validity_duration": 60, "sponsor_notify_all": false, "sponsor_status_notify": false, "sponsors": [ "string" ], "sso_default_role": "", "sso_forced_role": "", "sso_idp_cert": "", "sso_idp_sign_algo": "sha1", "sso_idp_sso_url": "", "sso_issuer": "", "sso_nameid_format": "email", "telstra_client_id": "string", "telstra_client_secret": "pa$$word", "twilio_auth_token": "af9dac44c344a875ab5d31cb7abcdefg", "twilio_phone_number": "+18548888888", "twilio_sid": "af9dac44c344a875ab5d31cb7abcdefg" }, "portal_allowed_hostnames": [ "snapchat.com", "ibm.com" ], "portal_allowed_subnets": [ "63.5.3.0/24" ], "portal_api_secret": "EIfPMOykI3lMlDdNPub2WcbqT6dNOtWwmYHAd6bY", "portal_denied_hostnames": [ "msg.snapchat.com" ], "portal_image": "https://url/to/image.png", "portal_sso_url": "string", "portal_template_url": "", "qos": { "class": "best_effort", "overwrite": false }, "radsec": { "coa_enabled": false, "enabled": true, "idle_timeout": 60, "mxcluster_ids": [ "572586b7-f97b-a22b-526c-8b97a3f609c4" ], "proxy_hosts": [ "mxedge1.local" ], "server_name": "radsec.abc.com", "servers": [ { "host": "1.1.1.1", "port": 1812 } ], "use_mxedge": true, "use_site_mxedge": false }, "rateset": { "property1": { "eht": "3fff0fff0fff03ff", "he": "0fff0fff0fff0fff", "ht": "00ff00ff00ff", "legacy": [ "6", "9", "12", "18", "24b", "36", "48", "54" ], "min_rssi": -70, "template": "compatible", "vht": "03ff03ff03ff01ff" }, "property2": { "eht": "3fff0fff0fff03ff", "he": "0fff0fff0fff0fff", "ht": "00ff00ff00ff", "legacy": [ "6", "9", "12", "18", "24b", "36", "48", "54" ], "min_rssi": -70, "template": "compatible", "vht": "03ff03ff03ff01ff" } }, "reconnect_clients_when_roaming_mxcluster": false, "roam_mode": "NONE", "schedule": { "enabled": false, "hours": { "fri": "09:00-17:00", "mon": "09:00-17:00", "sat": "09:00-17:00", "sun": "09:00-17:00", "thu": "09:00-17:00", "tue": "09:00-17:00", "wed": "09:00-17:00" } }, "site_id": "441a1214-6928-442a-8e92-e1d34b8ec6a6", "sle_excluded": false, "ssid": "corporate", "template_id": "", "thumbnail": "", "use_eapol_v1": false, "vlan_enabled": false, "vlan_id": "string", "vlan_ids": "1,2", "vlan_pooling": false, "wlan_limit_down": 1, "wlan_limit_down_enabled": false, "wlan_limit_up": 1, "wlan_limit_up_enabled": false, "wxtag_ids": [ "87641404-532c-45e5-8837-d23ab1e7d160" ], "wxtunnel_id": "", "wxtunnel_remote_id": "" }]deleteSiteWlanPortalImage DELETE
Delete Site WLAN Portal Image
updateSiteWlanPortalTemplate PUT
Update a Portal Template #### Sponsor Email Template Sponsor Email Template supports following template variables: | **Name** | **Description** | | --- | --- | | approve_url | Renders URL to approve the request; optionally &minutes=N query param can be appended to change the Authorization period of the guest, where N is a valid integer denoting number of minutes a guest remains authorized | | deny_url | Renders URL to reject the request | | guest_email | Renders Email ID of the guest | | guest_name | Renders Name of the guest | | field1 | Renders value of the Custom Field 1 | | field2 | Renders value of the Custom Field 2 | | company | Renders value of the Company field | | sponsor_link_validity_duration | Renders validity time of the request (i.e. Approve/Deny URL) | | auth_expire_minutes | Renders Wlan-level configured Guest Authorization Expiration time period (in minutes), If not configured then default (1 day in minutes) |