---
title: "Create a Hotspot profile"
method: POST
path: "/hotspot-profiles"
tags: ["Configuration - Policy"]
---

# Create a Hotspot profile

`POST /hotspot-profiles`

Create a new Hotspot profile.

## Request body

- XiqHotspotProfileRequest
  - `name` string, required — The Hotspot profile name
  - `hessid` string — Homogenous Extended Service Set Identifier (HESSID) for a Hotspot 2.0 network.
  - `domain_name` string — The domain name of the entity or organization operating the IEEE 802.11 access network.
  - `operator_names` XiqHotspotLocalizedName[] — Localized names for the Hotspot operator.
    - `name` string, required — A language specific name, up to 252 byte UTF-8 string.
    - `language` string — Language code (3B abbreviation) found at: http://www.loc.gov/standards/iso639-2/ISO-639-2_utf-8.txt.
  - `venue` XiqHotspotVenue — Venue information helps client devices understand the type and nature of the location where the Wi-Fi network is deployed.
    - `venue_group` 'UNSPECIFIED' | 'ASSEMBLY' | 'BUSINESS' | 'EDUCATIONAL' | 'FACTORY_AND_INDUSTRIAL' | 'INSTITUTIONAL' | 'MERCANTILE' | 'RESIDENTIAL' | 'STORAGE' | 'UTILITY_AND_MISCELLANEOUS' | 'VEHICULAR' | 'OUTDOOR' — The venue group ID categorizes the general type of location.
    - `venue_type` 'UNSPECIFIED' | 'ARENA' | 'STADIUM' | 'PASSENGER_TERMINAL' | 'AMPHITHEATRE' | 'AMUSEMENT_PARK' | 'PLACE_OF_WORSHIP' | 'CONVENTION_CENTRE' | 'LIBRARY' | 'MUSEUM' | 'RESTAURANT' | 'THEATRE' | 'BAR' | 'COFFEE_SHOP' | 'ZOO_OR_AQUARIUM' | 'EMERGENCY_COORDINATION_CENTRE' | 'DOCTOR_OR_DENTIST_OFFICE' | 'BANK' | 'FIRE_STATION' | 'POLICE_STATION' | 'POST_OFFICE' | 'PROFESSIONAL_OFFICE' | 'RESEARCH_AND_DEVELOPMENT_FACILITY' | 'ATTORNEY_OFFICE' | 'SCHOOL_PRIMARY' | 'SCHOOL_SECONDARY' | 'UNIVERSITY_OR_COLLEGE' | 'FACTORY' | 'HOSPITAL' | 'LONG_TERM_CARE_FACILITY' | 'ALCOHOL_AND_DRUG_REHABILITATION_CENTRE' | 'GROUP_HOME' | 'PRISON_OR_JAIL' | 'RETAIL_STORE' | 'GROCERY_MARKET' | 'AUTOMOTIVE_SERVICE_STATION' | 'SHOPPING_MALL' | 'GAS_STATION' | 'PRIVATE_RESIDENCE' | 'HOTEL_OR_MOTEL' | 'DORMITORY' | 'BOARDING_HOUSE' | 'AUTOMOBILE_OR_TRUCK' | 'AIRPLANE' | 'BUS' | 'FERRY' | 'SHIP_OR_BOAT' | 'TRAIN' | 'MOTOR_BIKE' | 'MUNI_MESH_NETWORK' | 'CITY_PARK' | 'REST_AREA' | 'TRAFFIC_CONTROL' | 'BUS_STOP' | 'KIOSK' — The venue type ID further specifies the particular kind of location within the general venue group.
    - `names` XiqHotspotLocalizedName[] — Localized names for the venue.
      - `name` string, required — A language specific name, up to 252 byte UTF-8 string.
      - `language` string — Language code (3B abbreviation) found at: http://www.loc.gov/standards/iso639-2/ISO-639-2_utf-8.txt.
  - `access_network_type` 'PRIVATE' | 'PRIVATE_WITH_GUEST' | 'CHARGEABLE_PUBLIC' | 'FREE_PUBLIC' | 'PERSONAL_DEVICE' | 'EMERGENCY' | 'TEST' | 'WILDCARD' — The Hotspot profile Access Network type.
  - `dgaf` boolean — Downstream Group Address Forwarding (DGAF). Forward all downlink wireless broadcast ARP and multicast packets.
  - `ipv4_availability` 'NOT_AVAILABLE' | 'PUBLIC' | 'PORT_RESTRICTED' | 'SINGLE_NAT' | 'DOUBLE_NAT' | 'PORT_RESTRICTED_SINGLE_NAT' | 'PORT_RESTRICTED_DOUBLE_NAT' | 'UNKNOWN' — The IPv4 address availability type.
  - `ipv6_availability` 'NOT_AVAILABLE' | 'AVAILABLE' | 'UNKNOWN' — The IPv6 address availability type.
  - `wan_metrics` XiqHotspotWanMetrics — Hotspot WAN (Wide Area Network) metrics.
    - `status` 'DOWN' | 'UP' | 'TEST', required — The WAN metric status.
    - `downlink_speed` integer, required — The downlink speed for the WAN network, in kbps (where 0 is unknown).
    - `uplink_speed` integer, required — The downlink speed for the WAN network, in kbps (where 0 is unknown).
  - `connection_capabilities` XiqHotspotConnectionCapability[] — The connection capability informs client devices about available network services.
    - `protocol` 'ESP' | 'ICMP' | 'TCP' | 'UDP', required — IP protocol number available from [IANA Protocol Numbers](https://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml).
    - `port_number` integer, required — The port number.
    - `status` 'CLOSED' | 'OPEN' | 'UNKNOWN', required — The Hotspot Connection Capability status.
  - `qos_map` XiqHotspotQosMap — Quality of Service (QoS) map for Hotspot profile.
    - `dscp_ranges` XiqHotspotQosAhClassToDscpRange[] — A list of ah-class to DSCP range.
      - `ah_class` integer, required — Extreme QoS class value.
      - `dscp_range_start` integer, required — Start value for DSCP range.
      - `dscp_range_end` integer, required — End value for DSCP range.
    - `dscp_exceptions` XiqHotspotQosDscpException[] — The list of exceptions to the mapping of ah-class to DSCP values.
      - `ah_class` integer, required — Extreme QoS class value.
      - `dscp_value` integer, required — Value for DSCP range.
  - `gas_comeback_delay` integer — Generic Advertisement Service (GAS) comeback message delay time. The unit is Time Unit (TU) 1 TU = 1024 microseconds. When GAS delay is 0, there is no delay.
  - `anqp_domain_id` integer — The Access Network Query protocol (ANQP) domain ID.
  - `online_signup` XiqHotspotOnlineSignup — The Hotspot profile Online Signup settings.
    - `network_auth_type` 'ACCEPTANCE_TERMS' | 'ONLINE_SIGN_UP' | 'CWP', required — The Network Authentication type for Hotspot profiles.
    - `redirection_url` string — The redirection URL, when the Network Authentication type is CWP.
    - `ssid_id` integer — OSU SSID ID, when the Network Authentication type is ONLINE_SIGN_UP. The authentication mode must be open or OSEN.
  - `nai_realms` XiqHotspotNaiRealm[] — The list of Network Access Identification (NAI) realms.
    - `name` string, required — The Network Access Identifier (NAI) Realm name
    - `description` string — The NAI Realm description.
    - `eap_methods` XiqHotspotEapMethod[] — The list of Extensible Authentication Protocol (EAP) methods.
    - `encoding_type` 'RFC_4282' | 'UTF_8' — The NAI realm encoding type.
  - `roaming_consortiums` XiqHotspotRoamingConsortium[] — The list of Roaming Consortium network providers.
    - `consortium_id` string, required — IEEE-assigned Organizational Identifier (OI).
    - `description` string — Description of Roaming Consortium OI.
  - `cellular_networks` XiqHotspotCellularNetwork[] — List of 3rd Generation Partnership Project (3GPP) cellular networks.
    - `mcc` string, required — Mobile Country Code (MCC).
    - `mnc` string, required — MCC
    - `description` string — MCC
  - `service_provider_ids` integer[] — The list of Hotspot Service Provider IDs.

## Response `201`

Created

- XiqHotspotProfile — The payload of Hotspot profile
  - `id` integer, required — The unique identifier
  - `create_time` string, date-time, required — The create time in UTC (ISO 8601 format)
  - `update_time` string, date-time, required — The last update time in UTC (ISO 8601 format)
  - `name` string, required — The Hotspot profile name
  - `hessid` string — Homogenous Extended Service Set Identifier (HESSID) for a Hotspot 2.0 network.
  - `domain_name` string, required — The domain name of the entity or organization operating the IEEE 802.11 access network.
  - `operator_names` XiqHotspotLocalizedName[] — Localized names for the Hotspot operator.
    - `name` string, required — A language specific name, up to 252 byte UTF-8 string.
    - `language` string — Language code (3B abbreviation) found at: http://www.loc.gov/standards/iso639-2/ISO-639-2_utf-8.txt.
  - `venue` XiqHotspotVenue — Venue information helps client devices understand the type and nature of the location where the Wi-Fi network is deployed.
    - `venue_group` 'UNSPECIFIED' | 'ASSEMBLY' | 'BUSINESS' | 'EDUCATIONAL' | 'FACTORY_AND_INDUSTRIAL' | 'INSTITUTIONAL' | 'MERCANTILE' | 'RESIDENTIAL' | 'STORAGE' | 'UTILITY_AND_MISCELLANEOUS' | 'VEHICULAR' | 'OUTDOOR' — The venue group ID categorizes the general type of location.
    - `venue_type` 'UNSPECIFIED' | 'ARENA' | 'STADIUM' | 'PASSENGER_TERMINAL' | 'AMPHITHEATRE' | 'AMUSEMENT_PARK' | 'PLACE_OF_WORSHIP' | 'CONVENTION_CENTRE' | 'LIBRARY' | 'MUSEUM' | 'RESTAURANT' | 'THEATRE' | 'BAR' | 'COFFEE_SHOP' | 'ZOO_OR_AQUARIUM' | 'EMERGENCY_COORDINATION_CENTRE' | 'DOCTOR_OR_DENTIST_OFFICE' | 'BANK' | 'FIRE_STATION' | 'POLICE_STATION' | 'POST_OFFICE' | 'PROFESSIONAL_OFFICE' | 'RESEARCH_AND_DEVELOPMENT_FACILITY' | 'ATTORNEY_OFFICE' | 'SCHOOL_PRIMARY' | 'SCHOOL_SECONDARY' | 'UNIVERSITY_OR_COLLEGE' | 'FACTORY' | 'HOSPITAL' | 'LONG_TERM_CARE_FACILITY' | 'ALCOHOL_AND_DRUG_REHABILITATION_CENTRE' | 'GROUP_HOME' | 'PRISON_OR_JAIL' | 'RETAIL_STORE' | 'GROCERY_MARKET' | 'AUTOMOTIVE_SERVICE_STATION' | 'SHOPPING_MALL' | 'GAS_STATION' | 'PRIVATE_RESIDENCE' | 'HOTEL_OR_MOTEL' | 'DORMITORY' | 'BOARDING_HOUSE' | 'AUTOMOBILE_OR_TRUCK' | 'AIRPLANE' | 'BUS' | 'FERRY' | 'SHIP_OR_BOAT' | 'TRAIN' | 'MOTOR_BIKE' | 'MUNI_MESH_NETWORK' | 'CITY_PARK' | 'REST_AREA' | 'TRAFFIC_CONTROL' | 'BUS_STOP' | 'KIOSK' — The venue type ID further specifies the particular kind of location within the general venue group.
    - `names` XiqHotspotLocalizedName[] — Localized names for the venue.
      - `name` string, required — A language specific name, up to 252 byte UTF-8 string.
      - `language` string — Language code (3B abbreviation) found at: http://www.loc.gov/standards/iso639-2/ISO-639-2_utf-8.txt.
  - `access_network_type` 'PRIVATE' | 'PRIVATE_WITH_GUEST' | 'CHARGEABLE_PUBLIC' | 'FREE_PUBLIC' | 'PERSONAL_DEVICE' | 'EMERGENCY' | 'TEST' | 'WILDCARD' — The Hotspot profile Access Network type.
  - `dgaf` boolean — Downstream Group Address Forwarding (DGAF). Forward all downlink wireless broadcast ARP and multicast packets.
  - `ipv4_availability` 'NOT_AVAILABLE' | 'PUBLIC' | 'PORT_RESTRICTED' | 'SINGLE_NAT' | 'DOUBLE_NAT' | 'PORT_RESTRICTED_SINGLE_NAT' | 'PORT_RESTRICTED_DOUBLE_NAT' | 'UNKNOWN' — The IPv4 address availability type.
  - `ipv6_availability` 'NOT_AVAILABLE' | 'AVAILABLE' | 'UNKNOWN' — The IPv6 address availability type.
  - `wan_metrics` XiqHotspotWanMetrics — Hotspot WAN (Wide Area Network) metrics.
    - `status` 'DOWN' | 'UP' | 'TEST', required — The WAN metric status.
    - `downlink_speed` integer, required — The downlink speed for the WAN network, in kbps (where 0 is unknown).
    - `uplink_speed` integer, required — The downlink speed for the WAN network, in kbps (where 0 is unknown).
  - `connection_capabilities` XiqHotspotConnectionCapability[] — The connection capability informs client devices about available network services.
    - `protocol` 'ESP' | 'ICMP' | 'TCP' | 'UDP', required — IP protocol number available from [IANA Protocol Numbers](https://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml).
    - `port_number` integer, required — The port number.
    - `status` 'CLOSED' | 'OPEN' | 'UNKNOWN', required — The Hotspot Connection Capability status.
  - `qos_map` XiqHotspotQosMap — Quality of Service (QoS) map for Hotspot profile.
    - `dscp_ranges` XiqHotspotQosAhClassToDscpRange[] — A list of ah-class to DSCP range.
      - `ah_class` integer, required — Extreme QoS class value.
      - `dscp_range_start` integer, required — Start value for DSCP range.
      - `dscp_range_end` integer, required — End value for DSCP range.
    - `dscp_exceptions` XiqHotspotQosDscpException[] — The list of exceptions to the mapping of ah-class to DSCP values.
      - `ah_class` integer, required — Extreme QoS class value.
      - `dscp_value` integer, required — Value for DSCP range.
  - `gas_comeback_delay` integer — Generic Advertisement Service (GAS) comeback message delay time. The unit is Time Unit (TU) 1 TU = 1024 microseconds. When GAS delay is 0, there is no delay.
  - `anqp_domain_id` integer — The Access Network Query protocol (ANQP) domain ID.
  - `online_signup` XiqHotspotOnlineSignup — The Hotspot profile Online Signup settings.
    - `network_auth_type` 'ACCEPTANCE_TERMS' | 'ONLINE_SIGN_UP' | 'CWP', required — The Network Authentication type for Hotspot profiles.
    - `redirection_url` string — The redirection URL, when the Network Authentication type is CWP.
    - `ssid_id` integer — OSU SSID ID, when the Network Authentication type is ONLINE_SIGN_UP. The authentication mode must be open or OSEN.
  - `nai_realms` XiqHotspotNaiRealm[] — The list of Network Access Identification (NAI) realms.
    - `name` string, required — The Network Access Identifier (NAI) Realm name
    - `description` string — The NAI Realm description.
    - `eap_methods` XiqHotspotEapMethod[] — The list of Extensible Authentication Protocol (EAP) methods.
    - `encoding_type` 'RFC_4282' | 'UTF_8' — The NAI realm encoding type.
  - `roaming_consortiums` XiqHotspotRoamingConsortium[] — The list of Roaming Consortium network providers.
    - `consortium_id` string, required — IEEE-assigned Organizational Identifier (OI).
    - `description` string — Description of Roaming Consortium OI.
  - `cellular_networks` XiqHotspotCellularNetwork[] — List of 3rd Generation Partnership Project (3GPP) cellular networks.
    - `mcc` string, required — Mobile Country Code (MCC).
    - `mnc` string, required — MCC
    - `description` string — MCC
  - `service_providers` XiqHotspotServiceProviderProfile[] — The list of supported hotspot service providers.
    - `id` integer, required — The unique identifier
    - `create_time` string, date-time, required — The create time in UTC (ISO 8601 format)
    - `update_time` string, date-time, required — The last update time in UTC (ISO 8601 format)
    - `name` string, required — The Hotspot Service Provider profile name.
    - `friendly_names` XiqHotspotLocalizedName[] — List of friendly names.
      - `name` string, required — A language specific name, up to 252 byte UTF-8 string.
      - `language` string — Language code (3B abbreviation) found at: http://www.loc.gov/standards/iso639-2/ISO-639-2_utf-8.txt.
    - `descriptions` XiqHotspotLocalizedName[] — List of Hotspot profile descriptions
      - `name` string, required — A language specific name, up to 252 byte UTF-8 string.
      - `language` string — Language code (3B abbreviation) found at: http://www.loc.gov/standards/iso639-2/ISO-639-2_utf-8.txt.
    - `icon_files` XiqHotspotServiceProviderIconFile[] — The list of localized icon files for the service provider.
      - `file_directory_name` string, required — Hotspot Service Provider profile icon file directory name.
      - `file` string, required — Hotspot Service Provider profile icon file.
      - `language` string — Hotspot Service Provider profile icon file language.
    - `nai_realms` XiqHotspotNaiRealm[] — List of Network Access Identification (NAI) realms. A NAI realm is a FQDN of a service provider.
      - `name` string, required — The Network Access Identifier (NAI) Realm name
      - `description` string — The NAI Realm description.
      - `eap_methods` XiqHotspotEapMethod[] — The list of Extensible Authentication Protocol (EAP) methods.
      - `encoding_type` 'RFC_4282' | 'UTF_8' — The NAI realm encoding type.
    - `roaming_consortiums` XiqHotspotRoamingConsortium[] — List of Roaming Consortium identifiers.
      - `consortium_id` string, required — IEEE-assigned Organizational Identifier (OI).
      - `description` string — Description of Roaming Consortium OI.
    - `cellular_networks` XiqHotspotCellularNetwork[] — List of 3rd Generation Partnership Project (3GPP) cellular networks.
      - `mcc` string, required — Mobile Country Code (MCC).
      - `mnc` string, required — MCC
      - `description` string — MCC
    - `osu_uri` string — The online signup (OSU) server URI.
    - `osu_methods` XiqHotspotServiceProviderOsuMethod[] — Encoded OSU methods and their priorities. Priority is given by the index/position in the array.
    - `osu_nai` string — Network Access Identifier (NAI) used as client identity during EAP authentication.

---

[API](https://skmtc.net/extremecloudiq/apis/extremecloud-iq-api.md) · [All operations](https://skmtc.net/extremecloudiq/apis/extremecloud-iq-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/extremecloudiq/extremecloud-iq-api/versions/5ff7ab84e8e8/schema)