Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Extreme Networks Configuration - Policy API

SSID/User Profile/Classification Rule/CCG/Radio Profile/...

Extreme Networks Configuration - Policy API is one of 52 APIs that Extreme Networks publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Configuration - Policy. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 111 operations across 63 paths, and defines 216 schemas. It is described by OpenAPI 3.0.3, at version 25.9.0-36.

Requests are made against a single base URL, https://api.extremecloudiq.com.

111 operations 63 paths 216 schemas 14 DELETE37 GET34 POST26 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
25.9.0-36
Base URL
https://api.extremecloudiq.com
Authentication
HTTP Bearer
License
Terms of Service
Resource Areas
1

Authentication & Security 1

Extreme Networks Configuration - Policy API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerAuth).

  • BearerAuth — JSON Web Token (JWT) based authentication

Paths & Operations 111

Across 63 paths, the API surfaces 111 operations — 14 DELETE, 37 GET, 34 POST, 26 PUT. Each is listed below with its method, path, parameters, and response codes.

Configuration - Policy 111

SSID/User Profile/Classification Rule/CCG/Radio Profile/...

GET
/classification-rules
List classification rules
listClassificationRules 2 params → 200default
POST
/classification-rules
Create classification rule
createClassificationRule body → 201default
GET
/classification-rules/{id}
Get a classification rule by ID
getClassificationRule 1 param → 200default
PUT
/classification-rules/{id}
Update classification rule
updateClassificationRule 1 param body → 200default
DELETE
/classification-rules/{id}
Delete classification rule by ID
deleteClassificationRule 1 param → 200default
GET
/l3-address-profiles
List L3 address profile
listL3AddressProfiles 1 param → 200default
POST
/l3-address-profiles
Create L3 address profile
createL3AddressProfile body → 201default
GET
/l3-address-profiles/{id}
Get L3 address profile by ID
getL3AddressProfile 1 param → 200default
PUT
/l3-address-profiles/{id}
Update L3 address profile by ID
updateL3AddressProfile 1 param body → 200default
DELETE
/l3-address-profiles/{id}
Delete L3 address profile by ID
deleteL3AddressProfile 1 param → 200default
GET
/ip-firewall-policies
List IP Firewall policies
listIpFirewallPolicies 2 params → 200default
POST
/ip-firewall-policies
Create IP Firewall policy
createIpFirewallPolicy body → 201default
GET
/ip-firewall-policies/{id}
Get IP Firewall Policy by ID
getIpFirewallPolicy 1 param → 200default
PUT
/ip-firewall-policies/{id}
Update IP Firewall policy by ID
updateIpPolicyRequest 1 param body → 200default
DELETE
/ip-firewall-policies/{id}
Delete IP Firewall policy by ID
deleteIpFirewallPolicy 1 param → 200default
POST
/ip-firewall-policies/{id}/ip-firewall-rule/:attach
Attach IP Firewall Rule to IP Firewall policy
attachIpFirewallRuleToIpFirewallPolicy 1 param body → 200default
POST
/ip-firewall-policies/{id}/ip-firewall-rule/:detach
Detach IP Firewall Rule from IP Firewall policy
detachIpFirewallRuleFromIpFirewallPolicy 1 param body → 200default
GET
/mac-firewall-policies
List MAC Firewall policies
listMacFirewallPolicies 2 params → 200default
POST
/mac-firewall-policies
Create MAC Firewall Policy
createMacFirewallPolicy body → 201default
GET
/mac-firewall-policies/{id}
Get MAC Firewall Policy by ID
getMacFirewallPolicy 1 param → 200default
PUT
/mac-firewall-policies/{id}
Update MAC Firewall policy by ID
updateMacPolicyRequest 1 param body → 200default
DELETE
/mac-firewall-policies/{id}
Delete MAC Firewall policy by ID
deleteMacFirewallPolicy 1 param → 200default
GET
/mac-object-profiles
List MAC objects
listMacObjects 1 param → 200default
POST
/mac-object-profiles
Create MAC object
createMacObject body → 201default
GET
/mac-object-profiles/{id}
Get MAC object by ID
getMacObject 1 param → 200default
PUT
/mac-object-profiles/{id}
Update MAC object by ID
updateMacObject 1 param body → 200default
DELETE
/mac-object-profiles/{id}
Delete MAC object by ID
deleteMacObject 1 param → 200default
POST
/mac-firewall-policies/{id}/mac-firewall-rule/:attach
Attach MAC Firewall Rule to MAC Firewall policy
attachMacFirewallRuleToMacFirewallPolicy 1 param body → 200default
POST
/mac-firewall-policies/{id}/mac-firewall-rule/:detach
Detach MAC Firewall Rule from IP Firewall policy
detachMacFirewallRuleFromMacFirewallPolicy 1 param body → 200default
GET
/radio-profiles
List radio profiles
listRadioProfiles 2 params → 200default
POST
/radio-profiles
Create a radio profile
createRadioProfile body → 201default
GET
/radio-profiles/{id}
Get radio profile by ID
getRadioProfile 1 param → 200default
PUT
/radio-profiles/{id}
Update radio profile by ID
updateRadioProfile 1 param body → 200default
DELETE
/radio-profiles/{id}
Delete radio profile by ID
deleteRadioProfile 1 param → 200default
GET
/radio-profiles/channel-selection/{id}
Get channel selection settings
getRpChannelSelection 1 param → 200default
PUT
/radio-profiles/channel-selection/{id}
Update channel selection settings
updateRpChannelSelection 1 param body → 200default
GET
/radio-profiles/mac-ouis
List MAC OUI profiles
listRpMacOuiProfiles 2 params → 200default
POST
/radio-profiles/mac-ouis
Create a MAC OUI profile
createMacOuiProfile body → 201default
GET
/radio-profiles/mac-ouis/{id}
Get MAC OUI profile
getRpMacOuiProfile 1 param → 200default
PUT
/radio-profiles/mac-ouis/{id}
Update MAC OUI profile
updateRpMacOuiProfile 1 param body → 200default
DELETE
/radio-profiles/mac-ouis/{id}
Delete MAC OUI profile
deleteRpMacOuiProfile 1 param → 200default
GET
/radio-profiles/miscellaneous/{id}
Get radio miscellaneous settings
getRpMiscellaneousSettings 1 param → 200default
PUT
/radio-profiles/miscellaneous/{id}
Update radio miscellaneous settings
updateRpMiscellaneousSettings 1 param body → 200default
GET
/radio-profiles/neighborhood-analysis/{id}
Get neighborhood analysis settings
getNeighborhoodAnalysis 1 param → 200default
PUT
/radio-profiles/neighborhood-analysis/{id}
Update neighborhood analysis settings
updateNeighborhoodAnalysis 1 param body → 200default
GET
/radio-profiles/radio-usage-opt/{id}
Get radio usage optimization settings
getRpRadioUsageOptimization 1 param → 200default
PUT
/radio-profiles/radio-usage-opt/{id}
Update radio usage optimization settings
updateRpRadioUsageOptimization 1 param body → 200default
GET
/radio-profiles/sensor-scan/{id}
Get sensor scan settings
getRpSensorScanSettings 1 param → 200default
PUT
/radio-profiles/sensor-scan/{id}
Update sensor scan settings
updateRpSensorScanSettings 1 param body → 200default
GET
/radio-profiles/wmm-qos/{id}
Get Wmm QoS settings
getRpWmmQosSettings 1 param → 200default
PUT
/radio-profiles/wmm-qos/{id}
Update Wmm QoS settings
updateRpWmmQosSettings 1 param body → 200default
GET
/user-profiles
List user profiles
listUserProfiles 2 params → 200default
POST
/user-profiles
Create a user profile
createUserProfile body → 201default
GET
/user-profiles/{id}
Get user profile by ID
getUserProfile 1 param → 200default
PUT
/user-profiles/{id}
Update user profile
updateCoUserProfile 1 param body → 200default
DELETE
/user-profiles/{id}
Delete an user profile by ID
deleteCoUserProfile 1 param → 200default
GET
/user-profile-assignments
List User Profile Assignments
listUserProfileAssignments 2 params → 200default
POST
/user-profile-assignments
Create User Profile Assignment
createUserProfileAssignment body → 201default
GET
/user-profile-assignments/{id}
Get User Profile Assignment by ID
getUpUserProfileAssignment 1 param → 200default
DELETE
/user-profile-assignments/{id}
Delete User Profile Assignment by ID
deleteUserProfileAssignment 1 param → 200default
POST
/user-profiles/{id}/ip-firewall-policies/:attach
Attach IP Firewall policy to User Profile
attachIpFirewallPolicyToUserProfile 1 param body → 200default
POST
/user-profiles/{id}/ip-firewall-policies/:detach
Detach IP Firewall policy from User Profile
detachIpFirewallPolicyFromUserProfile 1 param body → 200default
POST
/user-profiles/{id}/mac-firewall-policies/:attach
Attach MAC Firewall policy to User Profile
attachMacFirewallPolicyToUserProfile 1 param body → 200default
POST
/user-profiles/{id}/mac-firewall-policies/:detach
Detach MAC Firewall policy from User Profile
detachMacFirewallPolicyFromUserProfile 1 param body → 200default
GET
/hotspot-profiles
List Hotspot profiles
listHotspotProfiles 2 params → 200default
POST
/hotspot-profiles
Create a Hotspot profile
createHotspotProfile body → 201default
GET
/hotspot-profiles/{id}
Get Hotspot profile by ID
getHotspotProfile 1 param → 200default
PUT
/hotspot-profiles/{id}
Update Hotspot profile by ID
updateHotspotProfile 1 param body → 200default
DELETE
/hotspot-profiles/{id}
Delete Hotspot profile by ID
deleteHotspotProfile 1 param → 200default
GET
/hotspot-service-profiler-profiles
List Hotspot Service Provider profiles
listHotspotServiceProviderProfiles 2 params → 200default
POST
/hotspot-service-profiler-profiles
Create a Hotspot Service Provider profile
createHotspotServiceProviderProfile body → 201default
GET
/hotspot-service-provider-profiles/{id}
Get Hotspot Service Provider profile by ID
getHotspotServiceProviderProfile 1 param → 200default
PUT
/hotspot-service-provider-profiles/{id}
Update Hotspot Service Provider profile by ID
updateHotspotServiceProviderProfile 1 param body → 200default
DELETE
/hotspot-service-provider-profiles/{id}
Delete Hotspot Service Provider profile by ID
deleteHotspotServiceProviderProfile 1 param → 200default
GET
/ssids
List SSIDs
listSsids 2 params → 200default
POST
/ssids/{id}/:rename
Rename SSID (Wireless name)
renameSsid 1 param body → 200default
POST
/ssids/{id}/cwp/:attach
Attach CWP to an SSID
attachCwpToSsid 1 param body → 200default
POST
/ssids/{id}/cwp/:enable
Enable and attach the CWP on the SSID
enableSsidCwp 1 param body → 200default
POST
/ssids/{id}/cwp/:disable
Disable the CWP on the SSID
disableSsidCwp 1 param → 200default
PUT
/ssids/{id}/mode/dot1x
Change the SSID mode to 802.1x and Authentication
setSsidModeDot1x 1 param body → 200default
PUT
/ssids/{id}/mode/open
Change the SSID mode to open access
setSsidModeOpen 1 param → 200default
PUT
/ssids/{id}/mode/psk
Change the SSID mode to PSK
setSsidModePsk 1 param body → 200default
PUT
/ssids/{id}/mode/ppsk
Change the SSID mode to PPSK
setSsidModePpsk 1 param body → 200default
PUT
/ssids/{id}/mode/wep
Change the SSID mode to WEP
setSsidModeWep 1 param body → 200default
PUT
/ssids/{id}/psk/password
Change the SSID PSK password
changePskPassword 1 param body → 200default
POST
/ssids/{id}/radius-server-group/:attach
Attach radius server group to an SSID
attachRadiusServerGroupToSsid 1 param body → 200default
POST
/ssids/{id}/radius-client-profile/:attach
Attach RADIUS client profile to an SSID
attachRadiusClientProfileToSsid 1 param body → 200default
POST
/ssids/{id}/user-profile-assignments/:attach
Attach User Profile Assignment to SSID
attachUserProfileAssignmentToSsid 1 param body → 200default
POST
/ssids/{id}/user-profile-assignments/:detach
Detach User Profile Assignment from SSID
detachUserProfileAssignmentFromSsid 1 param body → 200default
POST
/ssids/{id}/user-profile/:attach
Attach user profile to an SSID
attachUserProfileToSsid 1 param body → 200default
GET
/ssids/advanced-settings/{id}
Get advanced settings for SSID
getSsidAdvancedSettings 1 param → 200default
PUT
/ssids/advanced-settings/{id}
Update SSID advanced settings
updateSsidAdvancedSettings 1 param body → 200default
POST
/ssids/{id}/hotspot-profiles/:enable
Enable and attach the Hotspot profile on the SSID
enableSsidHotspot 1 param body → 200default
POST
/ssids/{id}/hotspots-profiles/:disable
Disable the Hotspot profile on the SSID
disableSsidHotspot 1 param → 200default
GET
/ccgs
[LRO] List clould config groups
listCloudConfigGroups 3 params → 200default
POST
/ccgs
Create new cloud config group
createCloudConfigGroup body → 201default
GET
/ccgs/{id}
Get a cloud config group
getCloudConfigGroup 1 param → 200default
PUT
/ccgs/{id}
Update cloud config group information
updateCloudConfigGroup 1 param body → 200default
DELETE
/ccgs/{id}
Delete a cloud config group
deleteCloudConfigGroup 1 param → 200default
GET
/iot-profiles
List IoT profiles
listIotProfiles 4 params → 200default
POST
/iot-profiles
Create an IoT profile
createIotProfile body → 201default
GET
/iot-profiles/{id}
Get IoT profile by ID
getIotProfile 1 param → 200default
PUT
/iot-profiles/{id}
Update IoT profile by ID
updateIotProfile 1 param body → 200default
DELETE
/iot-profiles/{id}
Delete IoT profile by ID
deleteIotProfile 1 param → 200default
GET
/client-monitor-profiles
List client monitor profiles
listClientMonitorProfiles 4 params → 200default
POST
/client-monitor-profiles
Create a client monitor profile
createClientMonitorProfile body → 201default
GET
/client-monitor-profiles/{id}
Get a client monitor profile by ID
getClientMonitorPolicy 1 param → 200default
PUT
/client-monitor-profiles/{id}
Update client monitor profile by ID
updateClientMonitorPolicy 1 param body → 200default
DELETE
/client-monitor-profiles/{id}
Delete a client monitor profile by ID
deleteClientMonitorProfile 1 param → 200default
POST
/ssids/{id}/client-monitor-profile/:attach
Attach client monitor profile to an SSID
attachClientMonitorProfileToSsid 1 param body → 200default
GET
/radio-operating-modes/{productType}
Get AP Radio Operating Mode
getDeviceOperationMode 1 param → 200default

Schemas 216

The contract defines 216 schemas that model the data the API accepts and returns. The most detailed are XiqUpdateRpRadioUsageOptimizationRequest (35 properties), XiqUpdateRpChannelSelectionRequest (21 properties), XiqHotspotProfileRequest (19 properties), XiqCreateRadioProfileRequest (11 properties). Each schema is shown below with its type and property counts.

PagedIpFirewall
XiqIotProfile
XiqL3AddressType
string
Address type
XiqUpdateRpNeighborhoodAnalysisRequest
object
5 properties
XiqExpirationActionType
string
The Expiration Action to take, null if the account is never expired.
XiqIotpMaBleScanApplication
object
The BLE Scan application
XiqRecurrenceType
string
The schedule recurrence type.
XiqHsNaiRealm
object
The Network Access Identification (NAI) realm.
4 properties 1 required
XiqHttpServer
object
3 properties 1 required
XiqIpFirewallAction
string
XiqRpMacOuiProfile
XiqSsidDot1xEncryptionMethod
string
The encryption method: for WPA8021X, WPA28021X, please use CCMP or TKIP, for AUTO8021X, please use AUTOTKIPCCMP, for WPA38021X, please use AES192
XiqHsRoamingConsortium
object
The Roaming Consortium network provider.
2 properties 1 required
XiqIotpMaBleScan
object
2 properties
XiqRpSensorScanSettings
XiqSsid1
XiqHsIpv6Type
string
The IPv6 address availability enum.
XiqClientMonitorSetting
object
The client monitor setting
3 properties
XiqCreateUserProfileAssignmentRequest
object
4 properties
XiqHsWanLinkStatus
string
The WAN metric status.
XiqClassification
XiqIotpMaBleBeaconApplication
object
The BLE Beacon application
XiqL3AddressCommon
XiqSetSsidModePpskRequest
object
The request for setting the SSID to be PPSK mode.
8 properties 5 required
XiqIotpMaBleScanIBeacon
object
3 properties 1 required
XiqExpirationType
string
The for one of the account expiration types.
XiqHsConnectionCapabilityStatus
string
Connection capability status.
PagedXiqMacObject
XiqIpAddressProfile
XiqIotApplicationSupported
string
IoT profile supported type.
XiqUpdateRpSensorScanSettingsRequest
object
3 properties
XiqHsVenue
object
Venue information helps client devices understand the type and nature of the location where the Wi-Fi network is deployed.
3 properties
XiqNetwork
XiqMacObjectType
string
Mac Object type
XiqUpdateRpRadioUsageOptimizationRequest
object
35 properties
XiqWildcardAddressProfile
XiqSsidDot1xKeyManagement
string
The key management: WPA8021X, WPA28021X, WPA38021X or AUTO8021X
XiqLoggingType
string
Firewall Rule Logging type
XiqIpFirewallRule
XiqClassificationRule
XiqApplicationDetectionRule
object
The Application Detection Rule
3 properties
XiqHotspotProfile
PagedXiqCloudConfigGroup
XiqWirelessIfName
string
The one or multiple ssid on wifi interfaces (example:wifi0 or wifi1) to be disabled/enabled, cannot be empty or no SSID will be disabled or enabled.
PagedXiqClassificationRule
XiqSsidPskEncryptionMethod
string
The encryption method: for WPA3PSK please use CCMP, for WPA2PSK or WPAPSK, please use CCMP or TKIP, for AUTOPSK, please use AUTOTKIPCCMP
XiqDateTimeType
object
The end date and time
5 properties 5 required
XiqRpMiscellaneousSettings
XiqValidTimePeriodAfterType
string
The valid time period after Id creation or first login.
XiqIotpTgWhiteListEntry
object
2 properties 2 required
PagedXiqUserProfileAssignment
XiqCreateUserProfileRequest
object
2 properties 2 required
XiqL3AddressProfile
XiqMacFirewall
XiqSsidWepEncryptionMethod
string
The encryption method type, WEP104 or WEP40
XiqHostNameAddressProfile
XiqSetSsidModeWepRequest
object
The request for setting the SSID to be WEP mode.
10 properties 2 required
XiqClassificationType
string
Classification type
XiqAttachUPAssignmentRequest
object
6 properties
XiqPasswordSettings
object
The password settings ID
7 properties 3 required
XiqNetworkService
XiqSchedule
PagedXiqHotspotServiceProviderProfile
XiqRpNeighborhoodAnalysis
XiqUpdateL3AddressProfileRequest
object
7 properties
XiqErrorParams
object
Error parameters
2 properties
XiqIotpMaBleBeaconAppType
string
The BLE Beacon application type.
XiqUpdateRpChannelSelectionRequest
object
21 properties
XiqHsWanMetrics
object
Hotspot WAN (Wide Area Network) metrics.
3 properties 3 required
XiqWeekDay
string
XiqError
object
6 properties 3 required
XiqHsNaiEncodingType
string
The NAI realm encoding type.
XiqSetSsidModePskRequest
object
The request for setting the SSID to be PSK mode.
7 properties 4 required
XiqAttachMacFirewallRuleToMacFirewallPolicy
object
4 properties
XiqPage
object
4 properties 4 required
XiqValidForTimePeriodSettings
object
The settings for Valid For Time Period option or null for other settings.
3 properties 1 required
XiqUserProfileAssignmentRule
XiqHsQosMap
object
2 properties
XiqUpdateClassificationRuleRequest
object
3 properties 2 required
XiqHotspotServiceProviderProfileRequest
object
The Hotspot Service Provider profile.
10 properties 1 required
XiqDeviceRadioBand
string
Radio Interface Bands
XiqIotpMaBleScanGeneric
object
3 properties 1 required
PagedXiqIotProfile
XiqUserProfileAssignmentRadiusAttribute
XiqIotProfileRequest
object
The IoT Profile
XiqHotspotProfileRequest
object
The Hotspot profile.
19 properties 2 required
XiqIotpMaBleScanEddystoneUrl
object
2 properties 1 required
XiqUpdateRpMacOuiProfileRequest
object
5 properties
XiqMacFirewallPolicyRequest
object
3 properties 3 required
XiqClientMonitorProfile
XiqIotpMaBleScanAppType
string
The BLE Scan application type.
PagedXiqHotspotProfile
XiqHsLanguageCode
string
Language code (3B abbreviation) found at: http://www.loc.gov/standards/iso639-2/ISO-639-2utf-8.txt.
XiqIpFirewallRuleRequest
object
5 properties
XiqClientMonitorProfileRequest
XiqIotApplicationId
string
IoT application identifiers.
XiqHsConnectionCapability
object
The connection capability informs client devices about available network services. Used to identify the IP protocols that are permitted or denied on the networ…
3 properties 3 required
XiqDetachMacFirewallRequest
object
2 properties 1 required
XiqDeliverySettings
object
The password delivery settings
2 properties
XiqHsIpv4Type
string
The IPv4 address availability enum: NOTAVAILABLE - No IPv4 address is available. PUBLIC - A publicly routable IPv4 address is available. PORTRESTRICTED - An IP…
XiqValidDailySettings
object
The settings for Valid Daily option or null for other settings.
4 properties 4 required
XiqRadioMode
string
The supported radio modes.
XiqHsAccessNetworkType
string
The Hotspot profile Access Network: PRIVATE - An enterprise network with user accounts. PRIVATEWITHGUEST - An enterprise network providing guest access. CHARGE…
XiqRpRadioUsageOptimization
XiqApplicationService
XiqUpdateRpMiscellaneousSettingsRequest
object
2 properties
XiqHsVenueType
string
The venue type ID further specifies the particular kind of location within the general venue group. Each venue type ID must match the venue group ID to accurat…
XiqHsOsuNetworkAuthType
string
The Network Authentication type for Hotspot profiles: ACCEPTANCETERMS - Indicate that the network requires the user to accept terms and conditions. ONLINESIGNU…
XiqNetworkServiceRequest
object
Network
6 properties
XiqPostExpirationAction
object
The type of action to take after the account expiration.
4 properties
XiqRpChannelSelection
XiqUpdateMacObjectRequest
object
4 properties
XiqAttachIpFirewallRuleToIpFirewallPolicy
object
5 properties
XiqHsVenueGroup
string
The venue group ID categorizes the general type of location.
XiqMacFirewallRule
XiqSsidWepAuthenticationMethod
string
The authentication method type, OPEN or SHARED
XiqHsspOsuMethod
string
OSU protocols supported by the Service Provider: OMADM - Set OSU provider support of the OMA DM (Open Mobile Alliance Device Management) protocol. SOAPXMLSPP -…
XiqHsLocalizedName
object
A language specific name.
2 properties 1 required
XiqAttributeType
string
XiqIotpMaBleBeacon
object
1 property
XiqCreateRadioProfileRequest
object
11 properties 1 required
XiqSsidEncryptionMethod
string
XiqSsidAccessSecurity
XiqValidDuringDateSettings
object
The settings for Valid During Dates option or null for other settings.
3 properties 3 required
XiqCreateMacObjectRequest
object
5 properties 3 required
XiqUserProfile
XiqUpdateCloudConfigGroupRequest
object
3 properties
XiqWildcardHostNameAddressProfile
XiqNetworkAlgType
string
XiqCreateClassificationRequest
object
The details of rule assignments
3 properties 3 required
XiqUpdateRadioProfileRequest
object
11 properties
XiqUpdateSsidAdvancedSettingsRequest
object
1 property
XiqIpRangeAddressProfile
XiqDeviceRadioOperatingMode
string
Modern AP hardware types include dual or triple band radios. A limited subset of band combinations are supported. Operating mode defines the supported band com…
XiqPcgType
string
The private client group type for pcgUseOnly
XiqIpFirewallRuleId
object
1 property 1 required
XiqSsidPpskKeyManagement
string
The key management: WPA2PSK, WPAPSK, AUTOPSK
XiqApplication
XiqAttachMacFirewallRequest
object
2 properties 2 required
XiqCreateCloudConfigGroupRequest
object
3 properties 1 required
XiqOsObject
PagedMacFirewall
XiqMacObject
XiqSsidWepKeyManagement
string
The key management type, WEP or WEP8021X
XiqRadiusClientProfile
XiqValidTimePeriodAfterFirstLogin
object
The settings for the valid time period after First Login option or null for the other option
4 properties 4 required
XiqHsOnlineSignup
object
The Hotspot profile Online Signup settings.
3 properties 1 required
XiqPasswordCharacterType
string
Password generation using letters, numbers, and/or special characters
XiqUserProfileAssignment
XiqCreateRpMacOuiProfileRequest
object
5 properties 2 required
XiqIpFirewallPolicyRequest
object
3 properties 3 required
XiqMacFirewallAction
string
XiqPskGenerationMethod
string
The psk generation method
XiqHsspIconFile
object
The OSU registration server icon according to language mode.
3 properties 2 required
XiqDetachIpFirewallRequest
object
2 properties 1 required
XiqNetworkIpProtocol
string
XiqHsConnectionCapabilityProtocol
string
Hotspot Connection Capability protocol.
XiqAttachIpFirewallRequest
object
2 properties 2 required
XiqSortOrder
string
XiqSsidSaeGroup
string
The SAE group: ALL, ECC, or FFC, must be selected when the key management is WPA3
XiqValidTimePeriodAfterIdCreation
object
The settings for the valid time period after ID Creation option or null for the other option
2 properties 2 required
XiqIotProfileMultiApplication
object
4 properties 2 required
XiqPasswordType
string
The access key type
XiqUserProfileAssignmentEntry
object
2 properties
XiqIotpMaBleScanVendor
object
3 properties 1 required
XiqClientMonitorParameters
object
The client monitor setting parameters
2 properties
XiqHsEapMethod
string
The Extensible Authentication Protocol (EAP) method.
XiqApplicationDetectionProtocol
string
XiqApplicationDetectionType
string
PagedXiqClientMonitorProfile
XiqScheduleType
string
The schedule type.
XiqSubnetAddressProfile
XiqDetachUPAssignmentRequest
object
1 property
XiqVlanProfile
XiqBaseEntity
object
3 properties 3 required
XiqSsidKeyManagement
string
XiqMacFirewallRuleRequest
object
4 properties
XiqHotspotServiceProviderProfile
PagedXiqRadioProfile
PagedXiqSsid1
XiqDateTimeUnitType
string
The after expiration scheduled time unit.
XiqUpdateRpWmmQosSettingsRequest
object
5 properties
XiqIpFirewall
XiqCloudConfigGroup
XiqIotProfileThreadGateway
object
4 properties 2 required
XiqSsidPskKeyManagement
string
The key management: WPA3PSK, WPA2PSK, WPAPSK,AUTOPSK
XiqMacFirewallRuleId
object
1 property 1 required
XiqDeviceInterfaceRadioMode
object
Device Radio Interface Band.
3 properties 3 required
XiqSsidWepDefaultKey
string
The default key, FIRST, SECOND,THIRD, OR FOURTH
XiqIotpMaBleBeaconEddystoneUrl
object
5 properties 2 required
XiqCreateClassificationRuleRequest
object
3 properties 2 required
XiqHsQosAhClassToDscpRange
object
ahclass to DSCP range. The DSCP range for each user priority is non-overlapping. The end value for the DSCP range must be greater than or equal to the start va…
3 properties 3 required
XiqIotpMaBleScanVendorType
string
The BLE Scan Vendor types for BLE Scan applications.
PagedXiqUserProfile
XiqDeviceRadioModesSettings
array
Device Radio Operating Mode settings based on AP Model.
XiqRpWmmQosSettings
XiqUpdateUserProfileRequest
object
2 properties
XiqUserGroup
XiqHsCellularNetwork
object
The 3GPP cellular network.
3 properties 2 required
XiqTraffic
string
The Firewall traffic direction.
XiqIotpMaBleBeaconIBeacon
object
7 properties 4 required
XiqIotpMaBleScanDestination
object
The BLE Scan destination.
1 property
XiqViqEntity
XiqHsQosDscpException
object
A DSCP priority to map to an Extreme QoS class that is different than the class mapped to the DSCP range in which the DSCP priority already exists.
2 properties 2 required
PagedXiqRpMacOuiProfile
XiqRadioProfile
XiqSsidKeyType
string
The key type, ASCII or HEX
XiqExpirationSettings
object
The password expiration settings
6 properties
XiqUpdateClassificationRequest
object
The details of rule Rules
3 properties 3 required
XiqVlanObjectClassifiedEntry
XiqRadiusClientProfileEntry
XiqCreateL3AddressProfileRequest
object
9 properties 2 required
XiqAddressProfileClassifiedEntry
object
Address profile classified entry
6 properties
XiqSsidAdvancedSettings
XiqPasswordDbLocation
string
The access key storage location
XiqSetSsidModeDot1xRequest
object
The request for setting the SSID to be 802.1x mode and Authentication settings. Authentication with ExtremeCloud IQ Authentication Service and Authentication w…
7 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

extreme-networks-configuration-policy-api-openapi.yml Raw ↑

Other APIs Extreme Networks publishes across the network.

ExtremeCloud IQ Controller REST API Gateway
ExtremeCloud IQ Controller Application Manager API
Ansible Network Collection for Extreme EXOS
Ansible Network Collection for Extreme VOSS
Ansible Network Collection for Extreme SLX-OS
Ansible Network Collection for Extreme NOS
Ansible Network Collection for Extreme Fabric Engine
Extreme Networks Account API
Extreme Networks Administration API
Extreme Networks AFC API
Extreme Networks Alert API
Extreme Networks Application API