API ReferenceNew CentralGuidesMRT APIConfiguration API
GithubAirheads Developer Community
API Reference

Update profile by name

List of NAI realms whose information can be sent as
an ANQP information element in a GAS query response.

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

Profile name.

Query Params
string

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

string

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

string

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

Body Params

profilebody object

anqp-3gpp
array of objects
length ≤ 2147483647

List of 3GPP Cellular Network for hotspots that have roaming relationships with cellular operators.

anqp-3gpp
anqp-roam-cons
array of objects
length ≤ 2147483647

List Roaming Consortium OI information be sent in an ANQP information element in a GAS query response.

anqp-roam-cons
string
length between 1 and 256

Passpoint identity profile description.

eap-method
array of objects
length ≤ 2147483647

NAI Realm EAP Auth Method.

eap-method
boolean

Enable this profile.

string
length between 1 and 256

The user may apply an alias named 'enable-alias' for device specific practical config when no enable
is configured, allowing the user to control the profile enablement.

string
enum
Defaults to UTF8

Issue this command if the NAI Realm named
defined by nai-realm-name is
a UTF-8 formatted character string that is not
formatted in accordance with IETF RFC 4282.

Show Details
RFC4282nai-realm-enc type is Rfc4282
UTF8nai-realm-enc type is Utf8
Allowed:
boolean
Defaults to false

Marks the Realm in this profile as the NAI Home Realm.

string
enum

Type of authentication used for AirPass.

Show Details
EDUROAMAir Pass with Eduroam.
OPENROAMINGAir Pass with OpenRoaming.
SIMAir Pass with SIM.
Allowed:
nai-realm-name
array of objects
length ≤ 2147483647

List of names for the NAI realm. The realm name is often the domain name of the service provider.

nai-realm-name
string
length between 1 and 64

Profile name.

Responses

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