HomeGuidesAPI Reference
GuidesAPI ReferenceGitHubAirheads Developer CommunityLog In
API Reference

Create a new hotspot.

Create a new hotspot.

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 Hotspot to create.
Example:hotspot_1.

string
required

Hotspot mode name.
Example:HS2.

Body Params

Data of the new Hotspot.

string
required

"hotspot": {
"name": "aruba-passpoint",
"mode": "HS2",
"enable": false,
"comeback_mode": false,
"gas_comeback_delay": 0,
"release_number": 0,
"asra": false,
"internet": false,
"osen": false,
"query_response_length_limit": 127,
"access_network_type": "private",
"roam_cons_len_1": 0,
"roam_cons_oi_1": "",
"roam_cons_len_2": "",
"roam_cons_oi_2": "",
"roam_cons_len_3": 0,
"roam_cons_oi_3": "",
"addtl_roam_cons_ois": 0,
"venue_group": "business",
"venue_type": "research-and-dev-facility",
"pame_bi": false,
"group_frame_block": false,
"p2p_dev_mgmt": false,
"p2p_cross_connect": false,
"osu_nai": "",
"osu_ssid": "",
"qos_map_range": "",
"qos_map_excp": "",
"anqp_nai_realm": "",
"anqp_venue_name": "",
"anqp_nwk_auth": "",
"anqp_roam_cons": "",
"anqp_3gpp": "",
"anqp_ip_addr_avail": "",
"anqp_domain_name": "",
"h2qp_oper_name": "",
"h2qp_wan_metrics": "",
"h2qp_conn_cap": "",
"h2qp_oper_class": "",
"h2qp_osu_provider": ""
}

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