API ReferenceNew CentralGuidesMRT APIConfiguration API
GithubAirheads Developer Community
API Reference
GithubAirheads Developer Community

Create new Passpoint profile.

post
https://de1.api.central.arubanetworks.com/network-config/v1alpha1/passpoint/

List of passpoint profile 802.11u public access service providers.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
length ≤ 9999

Passpoint profile name.

Query Params
string

LOCAL - To create local objects. SHARED - To create shared objects. Default - Defaults to SHARED if not provided

string

Scope at which local object needs to be created. Mandatory if object-type = LOCAL. Should not be provided for object-type = SHARED.

string

Device function for which the local object needs to be created. Mandatory if object_type = LOCAL. Should not be provided for object_type = SHARED.

Body Params

profilebody object

string
enum
Defaults to PRIVATE

Specifies the 802.11u network type.

Show Details
CHARGEABLE_PUBLICpasspoint access-nw-type type is Chargeable-public
EMERGENCY_SERVICESpasspoint access-nw-type type is Emergency-services
FREE_PUBLICpasspoint access-nw-type type is Free-public
PERSONAL_DEVICEpasspoint access-nw-type type is Personal-device
PRIVATEpasspoint access-nw-type type is Private
PRIVATE_WITH_GUESTpasspoint access-nw-type type is Private-with-guest
TESTpasspoint access-nw-type type is Test
WILDCARDpasspoint access-nw-type type is Wildcard
boolean
Defaults to false

Additional Steps required for Access.

int32
0 to 255

Additional roaming consortium organization identifiers.

int32
0 to 65535

Number representing the ANQP Domain Id. Zero means no domain.

anqp-domain-name
array of objects
length ≤ 2147483647

List of domain names to be sent in an ANQP information element in a GAS query response.

anqp-domain-name
anqp-ip-addr-avail
array of objects
length ≤ 2147483647

List of available IP address types to be sent in an ANQP information element in a GAS query response.

anqp-ip-addr-avail
anqp-nwk-auth-profile
array of objects
length ≤ 2147483647

List of ANQP Network Authentication profiles to define authentication type
being used by the hotspot network.

anqp-nwk-auth-profile
anqp-venue-info
array of objects
length ≤ 2147483647

List of venue information be sent in an ANQP information element in a GAS query response.

anqp-venue-info
boolean
Defaults to false

By default, ANQP information is obtained from a GAS(Generic advertisement service) Request and Response.
If you enable the comebackmode option, advertisement information is obtained
using a GAS Request and Response. as well as a Comeback-Request and Comeback-Response.
This option is disabled by default.

string
length between 1 and 256

Passpoint profile description.

int32
100 to 6000
Defaults to 500

GAS Comeback Delay in milliseconds.

boolean
Defaults to false

Downstream Group Addressed Frames Forwarding(DGAF).

h2qp-conn-cap-profile
array of objects
length ≤ 2147483647

List of H2QP profiles that advertises hotspot protocol and port capabilities.

h2qp-conn-cap-profile
h2qp-oper-class-profile
array of objects
length ≤ 2147483647

List of Hotspot 2.0 Query Protocol (H2QP) profiles that defines the Operating Class to be sent in the Access network Query Protocol (ANQP) IE.

h2qp-oper-class-profile
h2qp-oper-name
array of objects
length ≤ 2147483647

List of H2QP operator-friendly name profiles.

h2qp-oper-name
h2qp-wan-metrics-profile
array of objects
length ≤ 2147483647

List of H2QP metrics and WAN status profiles.

h2qp-wan-metrics-profile
string
length ≤ 9999

This optional parameter devices an AP's homogenous ESS identifier, which is that device's MAC address in colonseparated hexadecimal format.

identity-profile
array of strings
length ≤ 2147483647
identity-profile
boolean
Defaults to false

Network Internet Access enabled.

string
length between 1 and 64

Passpoint profile name.

boolean
Defaults to false

Enable OSU Server-only authenticated layer 2 Encryption Network (OSEN).

string
length between 1 and 64

OSU NAI for OSEN.

string
length between 1 and 128

OSU SSID.

boolean
Defaults to false

P2P Cross Connect.

boolean
Defaults to false

P2P Device Management.

boolean
Defaults to false

Pre Association Message Exchange BSSID Independent.

string
length ≤ 9999

Qos Map DSCP Exception fields (upto 21 sets).

string
length ≤ 9999

Qos Map DSCP Ranges (total 8 sets :, cannot be greater than ).

int32
1 to 6
Defaults to 4

GAS Query Response Length Limit(1-6).

boolean
Defaults to false

Disable RADUIS Chargeable-User Identity (CUI) attribute defined by RFC 4372. Home
networks can use this attribute to identify a user for the
roaming transactions that take place outside of that home network.

boolean
Defaults to false

Disable RADIUS Location Data attribute defined by RFC 5580. Enabling this
parameter allows the RADIUS server to use location data.

int32
1 to 2
Defaults to 2

Hotspot 2.0 Release Number.

roam-cons
array of objects
length ≤ 2147483647

Roaming Consortium OI value.

roam-cons
string
enum
Defaults to BUSINESS

Network venue group under hotspot2 profile.

Show Details
ASSEMBLYvenue-group is Assembly
BUSINESSvenue-group is Business
EDUCATIONALvenue-group is Educational
FACTORY_AND_INDUSTRIALvenue-group is Factory-and-industrial
INSTITUTIONALvenue-group is Institutional
MERCANTILEvenue-group is Mercantile
OUTDOORvenue-group is Outdoor
RESIDENTIALvenue-group is Residential
STORAGEvenue-group is Storage
UNSPECIFIEDvenue-group is Unspecified
UTILITY_AND_MISCvenue-group is Utility-and-misc
VEHICULARvenue-group is Vehicular
string
enum
Defaults to RESEARCH_AND_DEV_FACILITY

Network venue type under hotspot2 profile.

Show Details
AIRPLANEvenue-type is Airplane
ALC_DRUG_REHABvenue-type is Alc-drug-rehab
AMPHITHEATERvenue-type is Amphitheater
AMUSEMENT_PARKvenue-type is Amusement-park
ARENAvenue-type is Arena
ATTORNEY_OFFICEvenue-type is Attorney-office
AUTOMOBILE_OR_TRUCKvenue-type is Automobile-or-truck
AUTO_SERVICE_STATIONvenue-type is Auto-service-station
BANKvenue-type is Bank
BARvenue-type is Bar
BOARDING_HOUSEvenue-type is Boarding-house
BUSvenue-type is Bus
BUS_STOPvenue-type is Bus-stop
CITY_PARKvenue-type is City-park
COFFEE_SHOPvenue-type is Coffee-shop
CONVENTION_CENTERvenue-type is Convention-center
DOCTORvenue-type is Doctor
DORMITORYvenue-type is Dormitory
EMERGENCY_CORD_CENTERvenue-type is Emergency-cord-center
FACTORYvenue-type is Factory
FERRYvenue-type is Ferry
FIRE_STATIONvenue-type is Fire-station
GAS_STATIONvenue-type is Gas-station
GROCERY_MARKETvenue-type is Grocery-market
GROUP_HOMEvenue-type is Group-home
HOSPITALvenue-type is Hospital
HOTELvenue-type is Hotel
KIOSKvenue-type is Kiosk
LIBRARYvenue-type is Library
LONG_TERM_CAREvenue-type is Long-term-care
MOTOR_BIKEvenue-type is Motor-bike
MUNI_MESH_NETWORKvenue-type is Muni-mesh-network
MUSEUMvenue-type is Museum
PASSENGER_TERMINALvenue-type is Passenger-terminal
PLACE_OF_WORSHIPvenue-type is Place-of-worship
POLICE_STATIONvenue-type is Police-station
POST_OFFICEvenue-type is Post-office
PRISON_OR_JAILvenue-type is Prison-or-jail
PRIVATE_RESIDENCEvenue-type is Private-residence
PROFESSIONAL_OFFICEvenue-type is Professional-office
RESEARCH_AND_DEV_FACILITYvenue-type is Research-and-dev-facility
RESTAURANTvenue-type is Restaurant
REST_AREAvenue-type is Rest-area
RETAIL_STOREvenue-type is Retail-store
SCHOOL_PRIMARYvenue-type is School-primary
SCHOOL_SECONDARYvenue-type is School-secondary
SHIPvenue-type is Ship
SHOPPING_MALLvenue-type is Shopping-mall
STADIUMvenue-type is Stadium
THEATERvenue-type is Theater
TRAFFIC_CONTROLvenue-type is Traffic-control
TRAINvenue-type is Train
UNIV_OR_COLLEGEvenue-type is Univ-or-college
UNSPECIFIEDvenue-type is Unspecified
ZOO_OR_AQUARIUMvenue-type is Zoo-or-aquarium
Responses

Updated 11 days ago

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 11 days ago