Sign in

v4

latestOpenAPI 3.0.1Apache 2.02026-08-036821,1001.5 MB
Configuration - Policy

Create a Hotspot profile

Create a new Hotspot profile.

post/hotspot-profiles

Request body

namestring required

The Hotspot profile name

hessidstring

Homogenous Extended Service Set Identifier (HESSID) for a Hotspot 2.0 network.

domain_namestring

The domain name of the entity or organization operating the IEEE 802.11 access network.

access_network_type'PRIVATE' | 'PRIVATE_WITH_GUEST' | 'CHARGEABLE_PUBLIC' | 'FREE_PUBLIC' | 'PERSONAL_DEVICE' | 'EMERGENCY' | 'TEST' | 'WILDCARD'

The Hotspot profile Access Network type.

dgafboolean

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.

gas_comeback_delayinteger

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_idinteger

The Access Network Query protocol (ANQP) domain ID.

service_provider_idsinteger[]

The list of Hotspot Service Provider IDs.

Response

Created

idinteger required

The unique identifier

create_timestring date-time required

The create time in UTC (ISO 8601 format)

update_timestring date-time required

The last update time in UTC (ISO 8601 format)

namestring required

The Hotspot profile name

hessidstring

Homogenous Extended Service Set Identifier (HESSID) for a Hotspot 2.0 network.

domain_namestring required

The domain name of the entity or organization operating the IEEE 802.11 access network.

access_network_type'PRIVATE' | 'PRIVATE_WITH_GUEST' | 'CHARGEABLE_PUBLIC' | 'FREE_PUBLIC' | 'PERSONAL_DEVICE' | 'EMERGENCY' | 'TEST' | 'WILDCARD'

The Hotspot profile Access Network type.

dgafboolean

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.

gas_comeback_delayinteger

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_idinteger

The Access Network Query protocol (ANQP) domain ID.