HomeGuidesAPI Reference
GuidesAPI ReferenceGitHubAirheads Developer CommunityLog In
API Reference

Captive Portal Authentication Profile

Configure Captive Portal authentication profile for guest users.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
required
1 to 256
Defaults to /md

Hierarchy path

string
required
1 to 256

SESSION id from authentication cookie

Body Params

Configure Captive Portal authentication profile for guest users.

string
required
1 to 256

Profile name

cp_default_role
object
cp_default_guest_role
object
cp_server_group
object
cp_redirect_pause
object
allow_user
object
allow_guest
object
logout_popup
object
cp_proto_http
object
cp_min_delay
object
cp_max_delay
object
cp_load_thresh
object
cp_maxf
object
cp_show_fqdn
object
authentication_method
object
cp_login_location
object
cp_welcome_location
object
cp_welcome_location_enable
object
proxy
object
switch_ip_in_redir_url
object
user_vlan_in_redir_url
object
ap_mac_in_redir_url
object
ip_addr_in_redir_url
object
single_session
object
cp_white_list
array of objects
cp_white_list
cp_black_list
array of objects
cp_black_list
show_aup
object
user_idle_timeout_cp
object
cp_redirect_url
object
apple_cna_bypass
object
url_hash_key
object
cp_auth_profile_clone
object
Responses
200

Successful Response

401

Unauthorized

403

Forbidden

415

Unsupported Type

Language
LoadingLoading…