openapi: 3.0.3 info: title: ExtremeCloud IQ Account Configuration - Policy API description: 'ExtremeCloud IQ™ API allows customers and partners to create solutions for the management, monitoring, and provisioning of any ExtremeCloud IQ™ environment. All related resources and documentation are available at [ExtremeCloud IQ Developer Portal](https://developer.extremecloudiq.com/). Please check [Get Started and Tutorial](https://developer.extremecloudiq.com/documentation/) to understand how to use the APIs. Get the [latest OpenAPI definition](https://github.com/extremenetworks/ExtremeCloudIQ-OpenAPI/blob/main/xcloudiq-openapi.yaml) from [ExtremeCloud IQ OpenAPI GitHub repository](https://github.com/extremenetworks/ExtremeCloudIQ-OpenAPI). Please have a valid [ExtremeCloud IQ](https://extremecloudiq.com/) account before getting started. If you don''t have one, please [register a new account](https://www.extremenetworks.com/cloud-networking/).' termsOfService: https://www.extremenetworks.com/company/legal/terms-of-use/ contact: name: Extreme Networks Support url: https://www.extremenetworks.com/support email: support@extremenetworks.com license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html version: 25.9.0-36 servers: - url: https://api.extremecloudiq.com description: ExtremeCloud IQ REST API Server tags: - name: Configuration - Policy description: SSID/User Profile/Classification Rule/CCG/Radio Profile/... paths: /classification-rules: get: tags: - Configuration - Policy summary: List classification rules description: List a page of classification rules. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_list_the_classification_rules operationId: listClassificationRules parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/limit' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PagedXiqClassificationRule' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] post: tags: - Configuration - Policy summary: Create classification rule description: Create a new classification rule. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_create_classification_rule_configuration operationId: createClassificationRule requestBody: description: The payload to create a new classification rule content: application/json: schema: $ref: '#/components/schemas/XiqCreateClassificationRuleRequest' required: true responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/XiqClassificationRule' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /classification-rules/{id}: get: tags: - Configuration - Policy summary: Get a classification rule by ID description: Get a specific classification rule. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_classification_rule_by_id operationId: getClassificationRule parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqClassificationRule' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] put: tags: - Configuration - Policy summary: Update classification rule description: Update the exist classification rule. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_update_classification_rule_configuration operationId: updateClassificationRule parameters: - $ref: '#/components/parameters/id' requestBody: description: The payload to update exist classification rule content: application/json: schema: $ref: '#/components/schemas/XiqUpdateClassificationRuleRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqClassificationRule' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] delete: tags: - Configuration - Policy summary: Delete classification rule by ID description: Delete an existing classification rule by ID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_delete_classification_rule_configuration operationId: deleteClassificationRule parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /l3-address-profiles: get: tags: - Configuration - Policy summary: List L3 address profile description: List all L3 Address Profiles. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_list_the_l3_address_profile operationId: listL3AddressProfiles parameters: - name: addressType in: query description: The address type schema: type: string enum: - L3_ADDRESS_TYPE_UNSPECIFIED - L3_ADDRESS_TYPE_IP_ADDRESS - L3_ADDRESS_TYPE_IP_SUBNET - L3_ADDRESS_TYPE_IP_RANGE - L3_ADDRESS_TYPE_HOST_NAME - L3_ADDRESS_TYPE_WILDCARD_HOST_NAME - L3_ADDRESS_TYPE_WILDCARD - UNRECOGNIZED responses: '200': description: OK content: application/json: schema: type: array items: $ref: '#/components/schemas/XiqL3AddressProfile' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] post: tags: - Configuration - Policy summary: Create L3 address profile description: Create a new L3 address profile. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_create_l3_address_profile operationId: createL3AddressProfile requestBody: description: The payload to create a new L3 address profile. content: application/json: schema: $ref: '#/components/schemas/XiqCreateL3AddressProfileRequest' required: true responses: '201': description: Created content: application/json: schema: oneOf: - $ref: '#/components/schemas/XiqHostNameAddressProfile' - $ref: '#/components/schemas/XiqWildcardHostNameAddressProfile' - $ref: '#/components/schemas/XiqIpAddressProfile' - $ref: '#/components/schemas/XiqIpRangeAddressProfile' - $ref: '#/components/schemas/XiqSubnetAddressProfile' - $ref: '#/components/schemas/XiqWildcardAddressProfile' discriminator: propertyName: addressType default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /l3-address-profiles/{id}: get: tags: - Configuration - Policy summary: Get L3 address profile by ID description: Get an existing L3 address profile by the specified ID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_l3_address_profile_by_id operationId: getL3AddressProfile parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/json: schema: oneOf: - $ref: '#/components/schemas/XiqHostNameAddressProfile' - $ref: '#/components/schemas/XiqWildcardHostNameAddressProfile' - $ref: '#/components/schemas/XiqIpAddressProfile' - $ref: '#/components/schemas/XiqIpRangeAddressProfile' - $ref: '#/components/schemas/XiqSubnetAddressProfile' - $ref: '#/components/schemas/XiqWildcardAddressProfile' discriminator: propertyName: addressType default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] put: tags: - Configuration - Policy summary: Update L3 address profile by ID description: Update an existing L3 address profile by the specified ID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_update_L3_address_profile_by_id operationId: updateL3AddressProfile parameters: - $ref: '#/components/parameters/id' requestBody: description: The payload of the update L3 address profile. content: application/json: schema: $ref: '#/components/schemas/XiqUpdateL3AddressProfileRequest' required: true responses: '200': description: OK content: application/json: schema: oneOf: - $ref: '#/components/schemas/XiqHostNameAddressProfile' - $ref: '#/components/schemas/XiqWildcardHostNameAddressProfile' - $ref: '#/components/schemas/XiqIpAddressProfile' - $ref: '#/components/schemas/XiqIpRangeAddressProfile' - $ref: '#/components/schemas/XiqSubnetAddressProfile' - $ref: '#/components/schemas/XiqWildcardAddressProfile' discriminator: propertyName: addressType default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] delete: tags: - Configuration - Policy summary: Delete L3 address profile by ID description: Delete an existing L3 address profile by the specified ID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_delete_L3_address_profile_by_id operationId: deleteL3AddressProfile parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /ip-firewall-policies: get: tags: - Configuration - Policy summary: List IP Firewall policies description: List a page of IP Firewall policies. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_list_ip_firewall_policies operationId: listIpFirewallPolicies parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/limit' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PagedIpFirewall' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] post: tags: - Configuration - Policy summary: Create IP Firewall policy description: Create a new IP Firewall policy. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_create_ip_firewall_policy operationId: createIpFirewallPolicy requestBody: description: The payload to create a new IP Firewall policy. content: application/json: schema: $ref: '#/components/schemas/XiqIpFirewallPolicyRequest' required: true responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/XiqIpFirewall' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /ip-firewall-policies/{id}: get: tags: - Configuration - Policy summary: Get IP Firewall Policy by ID description: Get an existing IP Firewall policy by the specified ID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_ip_firewall_policy_by_id operationId: getIpFirewallPolicy parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqIpFirewall' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] put: tags: - Configuration - Policy summary: Update IP Firewall policy by ID description: Update an existing IP Firewall policy by the specified ID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_update_ip_firewall_policy_by_id operationId: updateIpPolicyRequest parameters: - $ref: '#/components/parameters/id' requestBody: description: The payload of the update IP Firewall policy request. content: application/json: schema: $ref: '#/components/schemas/XiqIpFirewallPolicyRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqIpFirewall' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] delete: tags: - Configuration - Policy summary: Delete IP Firewall policy by ID description: Delete an existing IP Firewall policy by the specified ID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_delete_ip_firewall_policy_by_id operationId: deleteIpFirewallPolicy parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /ip-firewall-policies/{id}/ip-firewall-rule/:attach: post: tags: - Configuration - Policy summary: Attach IP Firewall Rule to IP Firewall policy description: Attach IP Firewall Rule to a IP Firewall policy. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_attach_ip_firewall_rule_to_ip_firewall_policy operationId: attachIpFirewallRuleToIpFirewallPolicy parameters: - $ref: '#/components/parameters/id' requestBody: description: The IP Firewall rule to be attached to the IP Firewall policy. content: application/json: schema: $ref: '#/components/schemas/XiqAttachIpFirewallRuleToIpFirewallPolicy' required: true responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /ip-firewall-policies/{id}/ip-firewall-rule/:detach: post: tags: - Configuration - Policy summary: Detach IP Firewall Rule from IP Firewall policy description: Detach IP Firewall Rule from a IP Firewall policy. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_detach_ip_firewall_rule_from_ip_firewall_policy operationId: detachIpFirewallRuleFromIpFirewallPolicy parameters: - $ref: '#/components/parameters/id' requestBody: description: The IP Firewall Rule ID to be detached from the IP Firewall policy. content: application/json: schema: $ref: '#/components/schemas/XiqIpFirewallRuleId' required: true responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /mac-firewall-policies: get: tags: - Configuration - Policy summary: List MAC Firewall policies description: List a page of MAC Firewall policies. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_list_mac_firewall_policies operationId: listMacFirewallPolicies parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/limit' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PagedMacFirewall' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] post: tags: - Configuration - Policy summary: Create MAC Firewall Policy description: Create a new MAC Firewall policy. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_create_mac_firewall_policy operationId: createMacFirewallPolicy requestBody: description: The payload to create a new Mac Firewall policy. content: application/json: schema: $ref: '#/components/schemas/XiqMacFirewallPolicyRequest' required: true responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/XiqMacFirewall' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /mac-firewall-policies/{id}: get: tags: - Configuration - Policy summary: Get MAC Firewall Policy by ID description: Get an existing MAC Firewall policy by the specified ID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_mac_firewall_policy_by_id operationId: getMacFirewallPolicy parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqMacFirewall' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] put: tags: - Configuration - Policy summary: Update MAC Firewall policy by ID description: Update an existing MAC Firewall policy by the specified ID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_update_mac_firewall_policy_by_id operationId: updateMacPolicyRequest parameters: - $ref: '#/components/parameters/id' requestBody: description: The payload of the update MAC Firewall policy request. content: application/json: schema: $ref: '#/components/schemas/XiqMacFirewallPolicyRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqMacFirewall' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] delete: tags: - Configuration - Policy summary: Delete MAC Firewall policy by ID description: Delete an existing MAC Firewall policy by the specified ID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_delete_mac_firewall_policy_by_id operationId: deleteMacFirewallPolicy parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /mac-object-profiles: get: tags: - Configuration - Policy summary: List MAC objects description: List a page of MAC objects. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_list_mac_objects operationId: listMacObjects parameters: - name: macType in: query description: The MAC object type required: true schema: $ref: '#/components/schemas/XiqMacObjectType' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PagedXiqMacObject' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] post: tags: - Configuration - Policy summary: Create MAC object description: Create a new MAC object. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_create_mac_object operationId: createMacObject requestBody: description: The request body to create new MAC object. content: application/json: schema: $ref: '#/components/schemas/XiqCreateMacObjectRequest' required: true responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/XiqMacObject' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /mac-object-profiles/{id}: get: tags: - Configuration - Policy summary: Get MAC object by ID description: Get an existing MAC object by the specified ID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_mac_object_by_id operationId: getMacObject parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqMacObject' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] put: tags: - Configuration - Policy summary: Update MAC object by ID description: Update an existing MAC object by the specified ID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_update_mac_object_by_id operationId: updateMacObject parameters: - $ref: '#/components/parameters/id' requestBody: description: The payload of the update MAC object request. content: application/json: schema: $ref: '#/components/schemas/XiqUpdateMacObjectRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqMacObject' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] delete: tags: - Configuration - Policy summary: Delete MAC object by ID description: Delete an existing MAC object by the specified ID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_delete_mac_object_by_id operationId: deleteMacObject parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /mac-firewall-policies/{id}/mac-firewall-rule/:attach: post: tags: - Configuration - Policy summary: Attach MAC Firewall Rule to MAC Firewall policy description: Attach MAC Firewall Rule to a MAC Firewall policy. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_attach_mac_firewall_rule_to_mac_firewall_policy operationId: attachMacFirewallRuleToMacFirewallPolicy parameters: - $ref: '#/components/parameters/id' requestBody: description: The MAC Firewall rule to be attached to the MAC Firewall policy. content: application/json: schema: $ref: '#/components/schemas/XiqAttachMacFirewallRuleToMacFirewallPolicy' required: true responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /mac-firewall-policies/{id}/mac-firewall-rule/:detach: post: tags: - Configuration - Policy summary: Detach MAC Firewall Rule from IP Firewall policy description: Detach MAC Firewall Rule from a IP Firewall policy. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_detach_mac_firewall_rule_from_mac_firewall_policy operationId: detachMacFirewallRuleFromMacFirewallPolicy parameters: - $ref: '#/components/parameters/id' requestBody: description: The MAC Firewall rule to be detached from the MAC Firewall policy. content: application/json: schema: $ref: '#/components/schemas/XiqMacFirewallRuleId' required: true responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /radio-profiles: get: tags: - Configuration - Policy summary: List radio profiles description: List a page of radio profiles. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_list_the_radio_profiles operationId: listRadioProfiles parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/limit' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PagedXiqRadioProfile' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] post: tags: - Configuration - Policy summary: Create a radio profile description: Create a new radio profile. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_create_radio_profile_configuration operationId: createRadioProfile requestBody: description: The request body to create new user profile. content: application/json: schema: $ref: '#/components/schemas/XiqCreateRadioProfileRequest' required: true responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/XiqRadioProfile' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /radio-profiles/{id}: get: tags: - Configuration - Policy summary: Get radio profile by ID description: Get radio profile details for the specified ID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_radio_profile_by_id operationId: getRadioProfile parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqRadioProfile' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] put: tags: - Configuration - Policy summary: Update radio profile by ID description: Update the existing radio profile by the profile ID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_update_radio_profile_configuration operationId: updateRadioProfile parameters: - $ref: '#/components/parameters/id' requestBody: description: The payload of the update radio profile request. content: application/json: schema: $ref: '#/components/schemas/XiqUpdateRadioProfileRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqRadioProfile' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] delete: tags: - Configuration - Policy summary: Delete radio profile by ID description: Delete the existing radio profile by the profile ID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_delete_radio_profile_configuration operationId: deleteRadioProfile parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /radio-profiles/channel-selection/{id}: get: tags: - Configuration - Policy summary: Get channel selection settings description: Get the channel selection settings belonging to a radio profile. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_radio_profile_channel_selection_by_id operationId: getRpChannelSelection parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqRpChannelSelection' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] put: tags: - Configuration - Policy summary: Update channel selection settings description: Update the channel selection settings belonging to a radio profile. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_update_radio_profile_channel_selection_by_id operationId: updateRpChannelSelection parameters: - $ref: '#/components/parameters/id' requestBody: description: The payload of the update channel selection settings request. content: application/json: schema: $ref: '#/components/schemas/XiqUpdateRpChannelSelectionRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqRpChannelSelection' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /radio-profiles/mac-ouis: get: tags: - Configuration - Policy summary: List MAC OUI profiles description: List a page of MAC OUI profiles. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_list_mac_oui_profiles operationId: listRpMacOuiProfiles parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/limit' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PagedXiqRpMacOuiProfile' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] post: tags: - Configuration - Policy summary: Create a MAC OUI profile description: Create a new MAC OUI profile for radio usage optimization. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_create_mac_oui_profile_configuration operationId: createMacOuiProfile requestBody: description: The request body to create new user profile. content: application/json: schema: $ref: '#/components/schemas/XiqCreateRpMacOuiProfileRequest' required: true responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/XiqRpMacOuiProfile' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /radio-profiles/mac-ouis/{id}: get: tags: - Configuration - Policy summary: Get MAC OUI profile description: Get the MAC OUI profile belonging the radio optimization settings. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_mac_oui_profile_by_id operationId: getRpMacOuiProfile parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqRpMacOuiProfile' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] put: tags: - Configuration - Policy summary: Update MAC OUI profile description: Update the existing MAC OUI profile for radio usage optimization. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_update_mac_oui_profile_by_id operationId: updateRpMacOuiProfile parameters: - $ref: '#/components/parameters/id' requestBody: description: The payload of the update MAC OUI profile request. content: application/json: schema: $ref: '#/components/schemas/XiqUpdateRpMacOuiProfileRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqRpMacOuiProfile' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] delete: tags: - Configuration - Policy summary: Delete MAC OUI profile description: Delete the existing MAC OUI profile for radio usage optimization. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_delete_mac_oui_profile_by_id operationId: deleteRpMacOuiProfile parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /radio-profiles/miscellaneous/{id}: get: tags: - Configuration - Policy summary: Get radio miscellaneous settings description: Get the radio miscellaneous settings belonging to a radio profile. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_radio_miscellaneous_settings_by_id operationId: getRpMiscellaneousSettings parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqRpMiscellaneousSettings' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] put: tags: - Configuration - Policy summary: Update radio miscellaneous settings description: Update the radio miscellaneous settings belonging to a radio profile. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_update_radio_miscellaneous_settings_by_id operationId: updateRpMiscellaneousSettings parameters: - $ref: '#/components/parameters/id' requestBody: description: The payload of the update radio miscellaneous settings request. content: application/json: schema: $ref: '#/components/schemas/XiqUpdateRpMiscellaneousSettingsRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqRpMiscellaneousSettings' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /radio-profiles/neighborhood-analysis/{id}: get: tags: - Configuration - Policy summary: Get neighborhood analysis settings description: Get the neighborhood analysis settings belonging to a radio profile. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_radio_profile_neighborhood_analysis_by_id operationId: getNeighborhoodAnalysis parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqRpNeighborhoodAnalysis' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] put: tags: - Configuration - Policy summary: Update neighborhood analysis settings description: Update the neighborhood analysis settings belonging to a radio profile. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_update_radio_profile_neighborhood_analysis_by_id operationId: updateNeighborhoodAnalysis parameters: - $ref: '#/components/parameters/id' requestBody: description: The payload of the update neighborhood analysis settings request. content: application/json: schema: $ref: '#/components/schemas/XiqUpdateRpNeighborhoodAnalysisRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqRpNeighborhoodAnalysis' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /radio-profiles/radio-usage-opt/{id}: get: tags: - Configuration - Policy summary: Get radio usage optimization settings description: Get the radio usage optimization settings belonging to a radio profile. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_radio_usage_optimization_by_id operationId: getRpRadioUsageOptimization parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqRpRadioUsageOptimization' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] put: tags: - Configuration - Policy summary: Update radio usage optimization settings description: Update the radio usage optimization settings belonging to a radio profile. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_update_radio_usage_optimization_by_id operationId: updateRpRadioUsageOptimization parameters: - $ref: '#/components/parameters/id' requestBody: description: The payload of the update radio usage optimization settings request. content: application/json: schema: $ref: '#/components/schemas/XiqUpdateRpRadioUsageOptimizationRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqRpRadioUsageOptimization' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /radio-profiles/sensor-scan/{id}: get: tags: - Configuration - Policy summary: Get sensor scan settings description: Get the sensor scan settings belonging to a radio profile. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_sensor_scan_settings_by_id operationId: getRpSensorScanSettings parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqRpSensorScanSettings' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] put: tags: - Configuration - Policy summary: Update sensor scan settings description: Update the sensor scan settings belonging to a radio profile. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_update_sensor_scan_settings_by_id operationId: updateRpSensorScanSettings parameters: - $ref: '#/components/parameters/id' requestBody: description: The payload of the update sensor scan settings request. content: application/json: schema: $ref: '#/components/schemas/XiqUpdateRpSensorScanSettingsRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqRpSensorScanSettings' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /radio-profiles/wmm-qos/{id}: get: tags: - Configuration - Policy summary: Get Wmm QoS settings description: Get the Wi-Fi Multimedia (WMM) QoS settings belonging to a radio profile. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_wmm_qos_settings_by_id operationId: getRpWmmQosSettings parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqRpWmmQosSettings' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] put: tags: - Configuration - Policy summary: Update Wmm QoS settings description: Update the Wi-Fi Multimedia (WMM) QoS settings belonging to a radio profile. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_update_wmm_qos_settings_by_id operationId: updateRpWmmQosSettings parameters: - $ref: '#/components/parameters/id' requestBody: description: The payload of the update Wmm QoS settings request. content: application/json: schema: $ref: '#/components/schemas/XiqUpdateRpWmmQosSettingsRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqRpWmmQosSettings' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /user-profiles: get: tags: - Configuration - Policy summary: List user profiles description: List a page of user profiles. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_list_the_user_profiles operationId: listUserProfiles parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/limit' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PagedXiqUserProfile' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] post: tags: - Configuration - Policy summary: Create a user profile description: Create a new user profile. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_create_user_profile_configuration operationId: createUserProfile requestBody: description: The request body to create new user profile. content: application/json: schema: $ref: '#/components/schemas/XiqCreateUserProfileRequest' required: true responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/XiqUserProfile' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /user-profiles/{id}: get: tags: - Configuration - Policy summary: Get user profile by ID description: Get user profile details for the specified ID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_user_profile_by_id operationId: getUserProfile parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqUserProfile' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] put: tags: - Configuration - Policy summary: Update user profile description: Update an existing user profile. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_update_user_profile_configuration operationId: updateCoUserProfile parameters: - $ref: '#/components/parameters/id' requestBody: description: The payload of user profile. content: application/json: schema: $ref: '#/components/schemas/XiqUpdateUserProfileRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqUserProfile' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] delete: tags: - Configuration - Policy summary: Delete an user profile by ID description: Delete an existing user profile by ID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_delete_user_profile_configuration operationId: deleteCoUserProfile parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /user-profile-assignments: get: tags: - Configuration - Policy summary: List User Profile Assignments description: List a page of User Profile Assignments. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#list_user_profile_assignments operationId: listUserProfileAssignments parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/limit' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PagedXiqUserProfileAssignment' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] post: tags: - Configuration - Policy summary: Create User Profile Assignment description: Create User Profile Assignment. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#create_user_profile_assignment operationId: createUserProfileAssignment requestBody: description: The request body to create new User Profile Assignment object. content: application/json: schema: $ref: '#/components/schemas/XiqCreateUserProfileAssignmentRequest' required: true responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/XiqUserProfileAssignment' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /user-profile-assignments/{id}: get: tags: - Configuration - Policy summary: Get User Profile Assignment by ID description: Get an existing User Profile Assignment object by the specified ID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_user_profile_assignment_by_id operationId: getUpUserProfileAssignment parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqUserProfileAssignment' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] delete: tags: - Configuration - Policy summary: Delete User Profile Assignment by ID description: Delete an existing User Profile Assignment by the specified ID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_delete_user_profile_assignment_by_id operationId: deleteUserProfileAssignment parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /user-profiles/{id}/ip-firewall-policies/:attach: post: tags: - Configuration - Policy summary: Attach IP Firewall policy to User Profile description: Attach an IP Firewall policy to a User Profile. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_attach_ip_firewall_policy_to_user_profile operationId: attachIpFirewallPolicyToUserProfile parameters: - $ref: '#/components/parameters/id' requestBody: description: The IP Firewall policy ID and traffic direction to be attached to the SSID. content: application/json: schema: $ref: '#/components/schemas/XiqAttachIpFirewallRequest' required: true responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /user-profiles/{id}/ip-firewall-policies/:detach: post: tags: - Configuration - Policy summary: Detach IP Firewall policy from User Profile description: Detach an IP Firewall policy from a User Profile. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_detach_ip_firewall_policy_from_user_profile operationId: detachIpFirewallPolicyFromUserProfile parameters: - $ref: '#/components/parameters/id' requestBody: description: The IP Firewall policy ID to be detached from User Profile. content: application/json: schema: $ref: '#/components/schemas/XiqDetachIpFirewallRequest' required: true responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /user-profiles/{id}/mac-firewall-policies/:attach: post: tags: - Configuration - Policy summary: Attach MAC Firewall policy to User Profile description: Attach a MAC Firewall policy to a User Profile. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_attach_mac_firewall_policy_to_user_profile operationId: attachMacFirewallPolicyToUserProfile parameters: - $ref: '#/components/parameters/id' requestBody: description: The MAC Firewall policy ID and traffic direction to be attached to the SSID. content: application/json: schema: $ref: '#/components/schemas/XiqAttachMacFirewallRequest' required: true responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /user-profiles/{id}/mac-firewall-policies/:detach: post: tags: - Configuration - Policy summary: Detach MAC Firewall policy from User Profile description: Detach a MAC Firewall policy from a User Profile. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_detach_mac_firewall_policy_from_user_profile operationId: detachMacFirewallPolicyFromUserProfile parameters: - $ref: '#/components/parameters/id' requestBody: description: The MAC Firewall policy ID and traffic direction to be detached from User Profile. content: application/json: schema: $ref: '#/components/schemas/XiqDetachMacFirewallRequest' required: true responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /hotspot-profiles: get: tags: - Configuration - Policy summary: List Hotspot profiles description: List a page of Hotspot profiles. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_list_the_hotspot_profiles operationId: listHotspotProfiles parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/limit' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PagedXiqHotspotProfile' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] post: tags: - Configuration - Policy summary: Create a Hotspot profile description: Create a new Hotspot profile. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_create_hotspot_profile operationId: createHotspotProfile requestBody: description: The request body to create new Hotspot profile. content: application/json: schema: $ref: '#/components/schemas/XiqHotspotProfileRequest' required: true responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/XiqHotspotProfile' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /hotspot-profiles/{id}: get: tags: - Configuration - Policy summary: Get Hotspot profile by ID description: Get Hotspot profile for the specified ID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_hotspot_profile_by_id operationId: getHotspotProfile parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqHotspotProfile' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] put: tags: - Configuration - Policy summary: Update Hotspot profile by ID description: Update the existing Hotspot profile by the profile ID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_update_hotspot_profile operationId: updateHotspotProfile parameters: - $ref: '#/components/parameters/id' requestBody: description: The payload of the update Hotspot profile request. content: application/json: schema: $ref: '#/components/schemas/XiqHotspotProfileRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqHotspotProfile' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] delete: tags: - Configuration - Policy summary: Delete Hotspot profile by ID description: Delete the existing Hotspot profile by the profile ID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_delete_hotspot_profile operationId: deleteHotspotProfile parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /hotspot-service-profiler-profiles: get: tags: - Configuration - Policy summary: List Hotspot Service Provider profiles description: List a page of Hotspot Service Provider profiles. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_list_the_hotspot_service_provider_profiles operationId: listHotspotServiceProviderProfiles parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/limit' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PagedXiqHotspotServiceProviderProfile' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] post: tags: - Configuration - Policy summary: Create a Hotspot Service Provider profile description: Create a Hotspot Service Provider profile. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_create_hotspot_service_provider_profile operationId: createHotspotServiceProviderProfile requestBody: description: The request body to create new Hotspot Service Provider profile. content: application/json: schema: $ref: '#/components/schemas/XiqHotspotServiceProviderProfileRequest' required: true responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/XiqHotspotServiceProviderProfile' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /hotspot-service-provider-profiles/{id}: get: tags: - Configuration - Policy summary: Get Hotspot Service Provider profile by ID description: Get Hotspot Service Provider profile for the specified ID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_hotspot_service_provider_profile_by_id operationId: getHotspotServiceProviderProfile parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqHotspotServiceProviderProfile' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] put: tags: - Configuration - Policy summary: Update Hotspot Service Provider profile by ID description: Update the existing Hotspot Service Provider profile by ID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_update_hotspot_service_provider_profile operationId: updateHotspotServiceProviderProfile parameters: - $ref: '#/components/parameters/id' requestBody: description: The payload of the update Hotspot Service Provider profile request. content: application/json: schema: $ref: '#/components/schemas/XiqHotspotServiceProviderProfileRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqHotspotServiceProviderProfile' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] delete: tags: - Configuration - Policy summary: Delete Hotspot Service Provider profile by ID description: Delete the existing Hotspot Service Provider profile by ID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_delete_hotspot_service_provider_profile operationId: deleteHotspotServiceProviderProfile parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /ssids: get: tags: - Configuration - Policy summary: List SSIDs description: List SSIDs with filter and pagination. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_list_ssids operationId: listSsids parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/limit' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PagedXiqSsid1' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /ssids/{id}/:rename: post: tags: - Configuration - Policy summary: Rename SSID (Wireless name) description: Change SSID broadcast name (Wireless name). externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_rename_ssidwireless_name operationId: renameSsid parameters: - $ref: '#/components/parameters/id' requestBody: description: The new SSID name content: application/json: schema: type: string required: true responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /ssids/{id}/cwp/:attach: post: tags: - Configuration - Policy summary: Attach CWP to an SSID description: Attach CWP to an SSID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_attach_cwp_to_an_ssid operationId: attachCwpToSsid parameters: - $ref: '#/components/parameters/id' requestBody: description: The CWP ID to be attached to the SSID. For CWP with only User Auth on Captive Web Portal enabled, please also attach a RADIUS server group or enable ExtremeCloud IQ Authentication Service. content: application/json: schema: type: integer format: int64 required: true responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /ssids/{id}/cwp/:enable: post: tags: - Configuration - Policy summary: Enable and attach the CWP on the SSID description: Enable and attach the CWP on the SSID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_enable_and_attach_the_cwp_on_the_ssid operationId: enableSsidCwp parameters: - $ref: '#/components/parameters/id' requestBody: description: The new CWP ID. For CWP with only User Auth on Captive Web Portal enabled, please also attach a RADIUS server group or enable ExtremeCloud IQ Authentication Service. content: application/json: schema: type: integer format: int64 required: true responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /ssids/{id}/cwp/:disable: post: tags: - Configuration - Policy summary: Disable the CWP on the SSID description: Disable the CWP on the SSID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_disable_and_detach_the_cwp_on_the_ssid operationId: disableSsidCwp parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /ssids/{id}/mode/dot1x: put: tags: - Configuration - Policy summary: Change the SSID mode to 802.1x and Authentication description: Change the SSID mode to 802.1x. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_set_ssid_mode_to_dot1x operationId: setSsidModeDot1x parameters: - $ref: '#/components/parameters/id' requestBody: description: The payload to change the SSID mode to 802.1x and set the Authentication settings content: application/json: schema: $ref: '#/components/schemas/XiqSetSsidModeDot1xRequest' required: true responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /ssids/{id}/mode/open: put: tags: - Configuration - Policy summary: Change the SSID mode to open access description: Change the SSID mode to open access. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_set_ssid_mode_to_open_access operationId: setSsidModeOpen parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /ssids/{id}/mode/psk: put: tags: - Configuration - Policy summary: Change the SSID mode to PSK description: Change the SSID mode to PSK. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_set_ssid_mode_to_psk operationId: setSsidModePsk parameters: - $ref: '#/components/parameters/id' requestBody: description: The payload to change the SSID mode to PSK content: application/json: schema: $ref: '#/components/schemas/XiqSetSsidModePskRequest' required: true responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /ssids/{id}/mode/ppsk: put: tags: - Configuration - Policy summary: Change the SSID mode to PPSK description: Change the SSID mode to PPSK. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_set_ssid_mode_to_ppsk operationId: setSsidModePpsk parameters: - $ref: '#/components/parameters/id' requestBody: description: The payload to change the SSID mode to PPSK content: application/json: schema: $ref: '#/components/schemas/XiqSetSsidModePpskRequest' required: true responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /ssids/{id}/mode/wep: put: tags: - Configuration - Policy summary: Change the SSID mode to WEP description: Change the SSID mode to WEP. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_set_ssid_mode_to_wep operationId: setSsidModeWep parameters: - $ref: '#/components/parameters/id' requestBody: description: The payload to change the SSID mode to WEP content: application/json: schema: $ref: '#/components/schemas/XiqSetSsidModeWepRequest' required: true responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /ssids/{id}/psk/password: put: tags: - Configuration - Policy summary: Change the SSID PSK password description: Change the SSID PSK password. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_change_the_ssid_psk_password operationId: changePskPassword parameters: - $ref: '#/components/parameters/id' requestBody: description: The new SSID PSK password content: application/json: schema: type: string required: true responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /ssids/{id}/radius-server-group/:attach: post: tags: - Configuration - Policy summary: Attach radius server group to an SSID description: Attach radius server group to an SSID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_attach_radius_server_group_to_an_ssid operationId: attachRadiusServerGroupToSsid parameters: - $ref: '#/components/parameters/id' requestBody: description: The radius server group ID to be attached to the SSID content: application/json: schema: type: integer format: int64 required: true responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /ssids/{id}/radius-client-profile/:attach: post: tags: - Configuration - Policy summary: Attach RADIUS client profile to an SSID description: Attach RADIUS client profile to an SSID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_attach_radius_client_profile_to_an_ssid operationId: attachRadiusClientProfileToSsid parameters: - $ref: '#/components/parameters/id' requestBody: description: The RADIUS client profile ID to be attached to the SSID content: application/json: schema: type: integer format: int64 required: true responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /ssids/{id}/user-profile-assignments/:attach: post: tags: - Configuration - Policy summary: Attach User Profile Assignment to SSID description: Attach User Profile Assignment to an SSID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_attach_user_profile_assignment_to_ssid operationId: attachUserProfileAssignmentToSsid parameters: - $ref: '#/components/parameters/id' requestBody: description: "The User Profile ID and User Profile Assignment ID to be attached to the SSID. User Profile and User Profile Assignment IDs are added to a User Profile Assignment Rule List within the SSID. Will also set the necessary fields on the SSID to allow User Profile Assignment using RADIUS attributes:\n 'Apply a different user profile to various clients and user groups',\n 'Allow User profile assignment using RADIUS attributes in addition to the three tunnel RADIUS attributes' &\n 'Standard RADIUS Attribute' to 'Filter-Id'." content: application/json: schema: $ref: '#/components/schemas/XiqAttachUPAssignmentRequest' required: true responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /ssids/{id}/user-profile-assignments/:detach: post: tags: - Configuration - Policy summary: Detach User Profile Assignment from SSID description: Detach User Profile Assignment from an SSID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_detach_user_profile_assignment_from_ssid operationId: detachUserProfileAssignmentFromSsid parameters: - $ref: '#/components/parameters/id' requestBody: description: The User Profile ID and User Profile Assignment ID to be detached from the SSID. content: application/json: schema: $ref: '#/components/schemas/XiqDetachUPAssignmentRequest' required: true responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /ssids/{id}/user-profile/:attach: post: tags: - Configuration - Policy summary: Attach user profile to an SSID description: Attach user profile to an SSID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_attach_user_profile_to_an_ssid operationId: attachUserProfileToSsid parameters: - $ref: '#/components/parameters/id' requestBody: description: The user profile ID to be attached to the SSID content: application/json: schema: type: integer format: int64 required: true responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /ssids/advanced-settings/{id}: get: tags: - Configuration - Policy summary: Get advanced settings for SSID description: Get the advanced settings belonging to a SSID profile. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_ssid_advanced_settings_by_id operationId: getSsidAdvancedSettings parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqSsidAdvancedSettings' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] put: tags: - Configuration - Policy summary: Update SSID advanced settings description: Update the advanced settings belonging to a SSID profile. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_update_ssid_advanced_settings_by_id operationId: updateSsidAdvancedSettings parameters: - $ref: '#/components/parameters/id' requestBody: description: The payload of the update advanced settings request. content: application/json: schema: $ref: '#/components/schemas/XiqUpdateSsidAdvancedSettingsRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqSsidAdvancedSettings' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /ssids/{id}/hotspot-profiles/:enable: post: tags: - Configuration - Policy summary: Enable and attach the Hotspot profile on the SSID description: Enable and attach the Hotspot profile on the SSID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_enable_and_attach_the_hotspot_on_the_ssid operationId: enableSsidHotspot parameters: - $ref: '#/components/parameters/id' requestBody: description: The Hotspot profile ID to be attached to the SSID. content: application/json: schema: type: integer format: int64 required: true responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /ssids/{id}/hotspots-profiles/:disable: post: tags: - Configuration - Policy summary: Disable the Hotspot profile on the SSID description: Disable the Hotspot profile on the SSID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_disable_and_detach_the_hotspot_on_the_ssid operationId: disableSsidHotspot parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /ccgs: get: tags: - Configuration - Policy summary: '[LRO] List clould config groups' description: List a papge of cloud config groups. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_list_cloud_config_groups operationId: listCloudConfigGroups parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/async' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PagedXiqCloudConfigGroup' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] post: tags: - Configuration - Policy summary: Create new cloud config group description: Create a new cloud config group. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_create_cloud_config_group operationId: createCloudConfigGroup requestBody: description: Create new cloud config group request body content: application/json: schema: $ref: '#/components/schemas/XiqCreateCloudConfigGroupRequest' required: true responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/XiqCloudConfigGroup' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /ccgs/{id}: get: tags: - Configuration - Policy summary: Get a cloud config group description: Get cloud config group info for the specified ID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_cloud_config_group operationId: getCloudConfigGroup parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqCloudConfigGroup' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] put: tags: - Configuration - Policy summary: Update cloud config group information description: Update the cloud config group details having the specified ID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_update_cloud_config_group operationId: updateCloudConfigGroup parameters: - $ref: '#/components/parameters/id' requestBody: description: Update cloud config group request body content: application/json: schema: $ref: '#/components/schemas/XiqUpdateCloudConfigGroupRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqCloudConfigGroup' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] delete: tags: - Configuration - Policy summary: Delete a cloud config group description: Delete a specific cloud config group by ID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_delete_cloud_config_group operationId: deleteCloudConfigGroup parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /iot-profiles: get: tags: - Configuration - Policy summary: List IoT profiles description: List a page of IoT profiles. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_list_the_iot_profiles operationId: listIotProfiles parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/limit' - name: appSupported in: query description: IoT profile app supported type required: false schema: $ref: '#/components/schemas/XiqIotApplicationSupported' - name: appId in: query description: IoT profile app ID type required: false schema: $ref: '#/components/schemas/XiqIotApplicationId' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PagedXiqIotProfile' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] post: tags: - Configuration - Policy summary: Create an IoT profile description: Create a new IoT profile. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_create_iot_profile_configuration operationId: createIotProfile requestBody: description: The request body to create new IoT profile. content: application/json: schema: $ref: '#/components/schemas/XiqIotProfileRequest' required: true responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/XiqIotProfile' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /iot-profiles/{id}: get: tags: - Configuration - Policy summary: Get IoT profile by ID description: Get IoT profile details for the specified ID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_iot_profile_by_id operationId: getIotProfile parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqIotProfile' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] put: tags: - Configuration - Policy summary: Update IoT profile by ID description: Update the existing IoT profile by the profile ID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_update_iot_profile_configuration operationId: updateIotProfile parameters: - $ref: '#/components/parameters/id' requestBody: description: The payload of the update IoT profile request. content: application/json: schema: $ref: '#/components/schemas/XiqIotProfileRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqIotProfile' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] delete: tags: - Configuration - Policy summary: Delete IoT profile by ID description: Delete the existing IoT profile by the profile ID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_delete_iot_profile_configuration operationId: deleteIotProfile parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /client-monitor-profiles: get: tags: - Configuration - Policy summary: List client monitor profiles description: List a page of client monitor profiles. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_list_client_monitor_profiles operationId: listClientMonitorProfiles parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/limit' - name: sortField in: query description: Sort field. Available values - NAME required: false schema: type: string enum: - NAME - $ref: '#/components/parameters/order' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PagedXiqClientMonitorProfile' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] post: tags: - Configuration - Policy summary: Create a client monitor profile description: Create a new client monitor profile. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_create_client_monitor_profile operationId: createClientMonitorProfile requestBody: description: The request body to create new client monitor profile content: application/json: schema: $ref: '#/components/schemas/XiqClientMonitorProfileRequest' required: true responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/XiqClientMonitorProfile' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /client-monitor-profiles/{id}: get: tags: - Configuration - Policy summary: Get a client monitor profile by ID description: Get client monitor profile details for the specified ID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_client_monitor_profile operationId: getClientMonitorPolicy parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqClientMonitorProfile' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] put: tags: - Configuration - Policy summary: Update client monitor profile by ID description: Update an existing client monitor profile. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_update_client_monitor_profile operationId: updateClientMonitorPolicy parameters: - $ref: '#/components/parameters/id' requestBody: description: The payload of client monitor profile. content: application/json: schema: $ref: '#/components/schemas/XiqClientMonitorProfileRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqClientMonitorProfile' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] delete: tags: - Configuration - Policy summary: Delete a client monitor profile by ID description: Delete an existing client monitor profile by ID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_delete_client_monitor_profile operationId: deleteClientMonitorProfile parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /ssids/{id}/client-monitor-profile/:attach: post: tags: - Configuration - Policy summary: Attach client monitor profile to an SSID description: Attach client monitor profile to an SSID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_attach_client_monitor_profile_to_an_ssid operationId: attachClientMonitorProfileToSsid parameters: - $ref: '#/components/parameters/id' requestBody: description: The client monitor profile ID to be attached to the SSID content: application/json: schema: type: integer format: int64 required: true responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /radio-operating-modes/{productType}: get: tags: - Configuration - Policy summary: Get AP Radio Operating Mode description: "Modern AP hardware types include dual or triple band radios.\nA limited subset of band combinations are supported.\nOperating mode defines the supported band combinations per radio. \nAccess Points with fixed band radios use GENERIC operating mode. \nSERVICE_2_5_6: wifi0-2.4Ghz, wifi1-5Ghz, wifi2-6Ghz\nSENSOR_SERVICE_5_6: wifi0-Tri-band sensor, wifi1-5Ghz, wifi2-6Ghz\nSERVICE_5L_5H_6: wifi0-5G Low, wifi1-5G High, wifi2-6Ghz\nSENSOR_SERVICE_5_2: wifi0-Tri-band sensor, wifi1-5GHz, wifi2-2.4Ghz\nSERVICE_5L_5H_2: wifi0-5G Low, wifi1-5G High, wifi2-2.4Ghz\nSERVICE_6L_5_6H: wifi0-6G Low, wifi1-5GHz, wifi2-6Ghz.\nSERVICE_2_5H_5L: wifi0-2.4Ghz, wifi1-5G High, wifi2-5G Low." externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_radio_operating_mode operationId: getDeviceOperationMode parameters: - name: productType in: path description: Product/AP Model required: true schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqDeviceRadioModesSettings' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] components: schemas: PagedIpFirewall: allOf: - $ref: '#/components/schemas/XiqPage' - type: object properties: data: type: array description: The data in the current page items: $ref: '#/components/schemas/XiqIpFirewall' XiqIotProfile: allOf: - $ref: '#/components/schemas/XiqViqEntity' - $ref: '#/components/schemas/XiqIotProfileRequest' XiqL3AddressType: type: string description: Address type enum: - IP_ADDRESS - IP_SUBNET - IP_RANGE - HOST_NAME - WILDCARD_HOST_NAME - WILDCARD XiqUpdateRpNeighborhoodAnalysisRequest: type: object properties: enable_background_scan: type: boolean description: Whether background scan of neighboring devices is enabled background_scan_interval: maximum: 1440 minimum: 1 type: integer description: The background scan interval in the range of 1 to 1440 minutes format: int32 enable_skip_scan_when_clients_connected: type: boolean description: Whether to skip background scan when devices have client connections enable_skip_scan_when_clients_in_power_save_mode: type: boolean description: Whether to skip background scan when connected devices are in power save mode enable_skip_scan_when_process_voice_traffic: type: boolean description: Whether to skip background scan when devices have network traffic with voice priority XiqExpirationActionType: type: string description: The Expiration Action to take, null if the account is never expired. enum: - SHOW_MESSAGE - REJECT_ACCESS XiqIotpMaBleScanApplication: type: object description: The BLE Scan application oneOf: - $ref: '#/components/schemas/XiqIotpMaBleScanIBeacon' - $ref: '#/components/schemas/XiqIotpMaBleScanEddystoneUrl' - $ref: '#/components/schemas/XiqIotpMaBleScanGeneric' discriminator: propertyName: app_type mapping: IBEACON: '#/components/schemas/XiqIotpMaBleScanIBeacon' EDDYSTONE_URL: '#/components/schemas/XiqIotpMaBleScanEddystoneUrl' GENERIC: '#/components/schemas/XiqIotpMaBleScanGeneric' XiqRecurrenceType: type: string enum: - EVERYDAY - WEEKDAY_RANGE description: The schedule recurrence type. XiqHsNaiRealm: type: object description: The Network Access Identification (NAI) realm. required: - name properties: name: type: string minLength: 1 maxLength: 255 description: NAI realm. description: type: string description: Description of NAI realm. eap_methods: type: array description: The list of Extensible Authentication Protocol (EAP) methods. items: $ref: '#/components/schemas/XiqHsEapMethod' encoding_type: $ref: '#/components/schemas/XiqHsNaiEncodingType' XiqHttpServer: type: object required: - url properties: url: type: string maxLength: 256 format: uri description: The HTTP server URL. interval: maximum: 60 minimum: 1 default: 10 type: integer format: int32 description: The HTTP server interval, in seconds. enable_deduplication: type: boolean default: true description: Enable to remove BLE scan duplicates entries within the specified time interval. XiqIpFirewallAction: type: string enum: - PERMIT - DENY - TRAFFIC_DROP - NAT - REDIRECT XiqRpMacOuiProfile: allOf: - $ref: '#/components/schemas/XiqBaseEntity' - type: object description: The MAC OUI profile for radio profile properties: name: type: string description: The product model description: type: string description: The product description predefined: type: boolean description: Whether the MAC Oui is predefined. value: type: string description: The MAC octets mac_type: type: string description: The type or "MAC_OUI" defender_defined: type: boolean description: Whether defender is defined extreme_iot_defined: type: boolean description: Whether is the Extreme Iot Defined XiqSsidDot1xEncryptionMethod: type: string description: 'The encryption method: for WPA_8021X, WPA2_8021X, please use CCMP or TKIP, for AUTO_8021X, please use AUTO_TKIP_CCMP, for WPA3_8021X, please use AES192' enum: - CCMP - TKIP - AUTO_TKIP_CCMP - AES192 XiqHsRoamingConsortium: type: object description: The Roaming Consortium network provider. required: - consortium_id properties: consortium_id: type: string pattern: ^[0-9A-Fa-f]{6,30}$ description: IEEE-assigned Organizational Identifier (OI). description: type: string description: Description of Roaming Consortium OI. XiqIotpMaBleScan: type: object properties: destination: $ref: '#/components/schemas/XiqIotpMaBleScanDestination' applications: type: array maxItems: 3 description: Collection of BLE Scan applications items: $ref: '#/components/schemas/XiqIotpMaBleScanApplication' XiqRpSensorScanSettings: allOf: - $ref: '#/components/schemas/XiqBaseEntity' - type: object description: The sensor scan settings for the radio profile properties: enable_scan_all_channels: type: boolean description: Whether to enable scanning all channels dwell_time: type: string description: The dwell time in ms scan_channels: type: string description: The comma separated list of scan channels XiqSsid1: allOf: - $ref: '#/components/schemas/XiqViqEntity' - type: object description: The SSID required: - name - broadcast_name - predefined properties: name: type: string description: The SSID profile name broadcast_name: type: string description: The SSID broadcast name description: type: string description: The SSID description predefined: type: boolean description: Whether it is predefined enable_user_profile_assignment: type: boolean description: The flag to enable User Profile Assignment. enable_radius_attribute_user_profile_assignment: type: boolean description: The flag to enable Radius Attribute User Profile Assignment. attribute_type: $ref: '#/components/schemas/XiqAttributeType' description: The SSID attribute type. attribute_key: type: integer description: The SSID attribute key. format: int32 access_security: $ref: '#/components/schemas/XiqSsidAccessSecurity' description: The SSID access security. radius_client_profile: $ref: '#/components/schemas/XiqRadiusClientProfile' description: The RADIUS client profile. default_user_profile: type: integer description: The default User Profile ID. format: int64 vendor_id: type: integer description: The vendor id, when the Attribute type is CUSTOM. user_profile_assignment_rules: type: array description: The user profile assignment rules. items: $ref: '#/components/schemas/XiqUserProfileAssignmentRule' advanced_settings_id: type: integer description: The SSID advanced settings ID format: int64 XiqHsIpv6Type: type: string description: The IPv6 address availability enum. default: UNKNOWN enum: - NOT_AVAILABLE - AVAILABLE - UNKNOWN XiqClientMonitorSetting: type: object description: The client monitor setting properties: association: description: Setting for reporting the client association problem $ref: '#/components/schemas/XiqClientMonitorParameters' authentication: description: Setting for reporting the client authentication problem $ref: '#/components/schemas/XiqClientMonitorParameters' networking: description: Setting for reporting the client networking problem $ref: '#/components/schemas/XiqClientMonitorParameters' XiqCreateUserProfileAssignmentRequest: type: object properties: name: type: string description: The User Profile Assignment description: type: string description: The User Profile Assignment description folder_ids: type: array description: The location folder Id list. items: type: integer format: int64 description: The location ID. assignment_radius_attribute: $ref: '#/components/schemas/XiqUserProfileAssignmentRadiusAttribute' description: The User Profile Assignment Radius Attribute. XiqHsWanLinkStatus: type: string description: The WAN metric status. enum: - DOWN - UP - TEST XiqClassification: allOf: - $ref: '#/components/schemas/XiqBaseEntity' - type: object description: The payload of common object - classification required: - classification_type - match - classification_id - value properties: classification_type: $ref: '#/components/schemas/XiqClassificationType' match: type: boolean description: Contains or not contains classification_id: type: integer description: The ID of location, cloud config group, IP address, IP subnet or IP range. format: int64 value: type: string description: The value of classification XiqIotpMaBleBeaconApplication: type: object description: The BLE Beacon application oneOf: - $ref: '#/components/schemas/XiqIotpMaBleBeaconIBeacon' - $ref: '#/components/schemas/XiqIotpMaBleBeaconEddystoneUrl' discriminator: propertyName: app_type mapping: IBEACON: '#/components/schemas/XiqIotpMaBleBeaconIBeacon' EDDYSTONE_URL: '#/components/schemas/XiqIotpMaBleBeaconEddystoneUrl' XiqL3AddressCommon: allOf: - type: object description: The L3 address common objects required: - name - address_type properties: predefined: type: boolean description: Flag to describe whether the application is predefined or customised. name: type: string description: Address profile name. description: type: string description: Address profile description. value: type: string description: Address profile value. enable_classification: type: boolean description: The flag to enable classification on L3 address profile. address_type: $ref: '#/components/schemas/XiqL3AddressType' description: The L3 address profile type. classified_entries: type: array description: The address profile classified entries. items: $ref: '#/components/schemas/XiqAddressProfileClassifiedEntry' description: address profile classified entry. XiqSetSsidModePpskRequest: type: object description: The request for setting the SSID to be PPSK mode. required: - key_management - encryption_method - user_group_ids - enable_max_clients_per_ppsk - enable_mac_bind properties: key_management: $ref: '#/components/schemas/XiqSsidPpskKeyManagement' encryption_method: $ref: '#/components/schemas/XiqSsidPskEncryptionMethod' user_group_ids: type: array description: The user group IDs to be attached to the SSID, cannot be empty items: type: integer description: The user group IDs to be attached to the SSID, cannot be empty format: int64 enable_max_clients_per_ppsk: type: boolean description: Flag for enabling the max clients per PPSK max_clients_per_ppsk: maximum: 15 minimum: 0 type: integer description: The max clients (0-15) per PPSK if enabled enable_max_clients_per_ppsk flag, 0 means unlimited format: int32 enable_mac_bind: type: boolean description: Flag for enabling mac binding or not. This setting is only supported with local PPSK. max_macs_per_ppsk: maximum: 5 minimum: 1 type: integer description: Set the max MAC binding numbers per private PSK, Min:1, Max:5 format: int32 ppsk_server_id: type: integer description: The PPSK server device ID format: int64 XiqIotpMaBleScanIBeacon: type: object required: - app_type properties: app_type: $ref: '#/components/schemas/XiqIotpMaBleScanAppType' min_rss: maximum: 20 minimum: -120 default: -100 type: integer format: int32 description: BLE Scan iBeacon application minimum Received Signal Strength value, in dBm. uuid: type: string default: 00000000-0000-0000-0000-000000000000 format: uuid description: BLE Scan iBeacon application UUID. A value of "00000000-0000-0000-0000-000000000000" indicates no filtering is applied. XiqExpirationType: type: string description: The for one of the account expiration types. enum: - NEVER_EXPIRE - VALID_DURING_DATES - VALID_FOR_TIME_PERIOD - DAILY XiqHsConnectionCapabilityStatus: type: string description: Connection capability status. enum: - CLOSED - OPEN - UNKNOWN default: UNKNOWN PagedXiqMacObject: allOf: - $ref: '#/components/schemas/XiqPage' - type: object properties: data: type: array description: The data in the current page. items: $ref: '#/components/schemas/XiqMacObject' XiqIpAddressProfile: allOf: - $ref: '#/components/schemas/XiqL3AddressProfile' XiqIotApplicationSupported: type: string enum: - SINGLE - MULTI description: IoT profile supported type. XiqUpdateRpSensorScanSettingsRequest: type: object properties: enable_scan_all_channels: type: boolean description: Whether to enable scanning all channels dwell_time: type: string description: The dwell time in the range from 250 to 30000 ms scan_channels: type: string description: The comma separated list of scan channels XiqHsVenue: type: object description: Venue information helps client devices understand the type and nature of the location where the Wi-Fi network is deployed. properties: venue_group: $ref: '#/components/schemas/XiqHsVenueGroup' venue_type: $ref: '#/components/schemas/XiqHsVenueType' names: type: array description: Localized names for the venue. items: $ref: '#/components/schemas/XiqHsLocalizedName' XiqNetwork: allOf: - $ref: '#/components/schemas/XiqViqEntity' - $ref: '#/components/schemas/XiqNetworkServiceRequest' XiqMacObjectType: type: string description: Mac Object type enum: - MAC_OUI - MAC_RANGE - MAC_ADDRESS XiqUpdateRpRadioUsageOptimizationRequest: type: object properties: preamble: type: string description: The preamble data length -- "AUTO" or "LONG" beacon_period: maximum: 3500 minimum: 40 type: integer description: The amount of time between beacons in the range from 40 to 3500. format: int32 enable_frame_burst: type: boolean description: Whether to enable Frame Burst enable_smart_antenna: type: boolean description: Whether to enable Smart Antenna (Enabling this option will disable (Null) for MU-MIMO) enable_backhaul_failover: type: boolean description: Whether to enable backhaul failover. Backhaul failover settings determine the thresholds at which the device switches from a wired to a wireless backhaul link, and the thresholds at which the device switches back wireless_backhaul_switch_trigger_time: maximum: 5 minimum: 1 type: integer description: Switch to Wireless Backhaul after the number of seconds (1 to 5) after the wired link fails format: int32 wired_backhaul_revert_hold_time: maximum: 300 minimum: 1 type: integer description: Revert Back to Wired Backhaul after the number of seconds (1 to 300) after the wired link is established format: int32 enable_band_steering: type: boolean description: Whether to enable band steering. Enabling steers clients from 2.4 GHz to 5.0 GHz radio band band_steering_mode: type: string description: The band steering mode -- "BALANCE", "URGE_5G", or "ENFORCE_5G" ratio_for5g_clients: maximum: 100 minimum: 1 type: integer description: The allowed percentage distribution of 2.4 and 5.0 GHz clients for "BALANCE" steering mode. format: int32 ignore_initial_client_connection_number: maximum: 100 minimum: 1 type: integer description: The number of connection attempts from 2.4 GHz clients to ignore before responding for URGE_5G steering mode. format: int32 enable_client_load_balancing: type: boolean description: Whether to enable client load balancing. Enabling load-balances clients across neighboring Extreme Networks within the same hive. Set WiFi0 and WiFi1 radios to the same load balancing mode when it is based on the number of associated stations. load_balancing_mode: type: string description: The client load balancing mode -- "AIRTIME_BASED" or "CLIENT_NUMBER" crc_error_rate_per_device: maximum: 99 minimum: 1 type: integer description: The CRC Error rate threshold value for "AIRTIME_BASED" load balancing. Ignore probe and association requests per device when CRC Error rate exceeds the threshold. format: int32 rf_interference_per_device: maximum: 99 minimum: 1 type: integer description: The RF Interference threshold value for "AIRTIME_BASED" load balancing. Ignore probe and association requests per device when RF Interference exceeds the threshold. format: int32 average_airtime_per_client: maximum: 5 minimum: 1 type: integer description: The Average Airtime Per Client threshold value for "AIRTIME_BASED" load balancing. Ignore probe and association requests per device when Average Airtime Per Client exceeds the threshold. format: int32 anchor_period: maximum: 600 minimum: 10 type: integer description: The Anchor Period value for both "AIRTIME_BASED" and "CLIENT_NUMBER" load balancing. Ignore probe and association requests from clients associated with other Extreme Networks devices until Anchor Period Eelapses in the range of 10 to 600 seconds format: int32 neighbor_query_interval: maximum: 600 minimum: 1 type: integer description: In both client load balancing modes, query neighbors about client load every in the range of 1 to 600 seconds format: int32 enable_weak_signal_probe_request_suppression: type: boolean description: Whether to enable Weak Signal Probe Request Suppression. Weak Signal Probe Request Suppression allows the configuration of signal-to-noise threshold beyond which the device does not respond to client probes. weak_snr_threshold: maximum: 100 minimum: 1 type: integer description: The signal to noise threshold in the range of 1 to 100 for Weak Signal Probe Request Suppression. format: int32 enable_safety_net: type: boolean description: Whether to enable Safety Net. When a device is overloaded or is probed by clients with a low signal-to-noise ratio, Safety Net allows the device to respond to association requests after a certain time period lapses. safety_net_period: maximum: 300 minimum: 5 type: integer description: The Safety Net Time Period in the range of 5 to 300 seconds. format: int32 enable_high_density: type: boolean description: Whether to enable High Density Configuration. Enabling optimizes performance in high density environments management_frame_basic_data_rate: type: string description: The data rates to support in high density environment -- "HIGH" or "LOW" enable_suppress_successive_probe_request: type: boolean description: Whether to Reduce Response to Probe Requests. Enabling suppresses successive requests within the same beacon interval probe_response_reduction_option: type: string description: The suppress response to broadcast probes options -- "ONLY_ONE_SSID_RESPOND_AT_A_TIME" (allowed for only one SSID to respond at a time), "REDUCE_CERTAIN_CLIENTS_RESPONSE" (reducing responses to certain client devices). suppression_limit: maximum: 10 minimum: 1 type: integer description: The Number of Connection Attempts in the range of 1 to 10 format: int32 enable_radio_balance: type: boolean description: Whether to enable Radio Load Balancing. Enabling distributes wireless clients that support 5 GHz band evenly across the two radios in Dual-5G mode when an SSID is available on both radios mac_oui_ids: type: array description: The MacOui Profile IDs for the "REDUCE_CERTAIN_CLIENTS_RESPONSE" probe response reduction option items: type: integer description: The MacOui Profile IDs for the "REDUCE_CERTAIN_CLIENTS_RESPONSE" probe response reduction option format: int64 enable_ampdu: type: boolean description: Enable Aggregate MAC Protocol Data Units to combine data frames into larger frames before transmission. enable_mu_mimo: type: boolean description: Whether to enable Multiple-Input Multiple-Output (802.11ac & 802.11ax) for multiple-user access by using different spatial streams. enable_ofdma_down_link: type: boolean description: Whether to enable OFDMA for AP downlink communication. enable_ofdma_up_link: type: boolean description: Whether to enable OFDMA for AP uplink communication. bss_coloring: maximum: 63 minimum: 1 type: integer description: The numerical identifier of the basic service sets (802.11ax ) to identify overlapping basic service sets (OBSSs). format: int32 enable_target_weak_time: type: boolean description: Whether to enable Target Weak Time. XiqWildcardAddressProfile: allOf: - $ref: '#/components/schemas/XiqL3AddressProfile' - type: object description: Wildcard address profile properties: wildcard_mask: type: string description: The wildcard address profile mask value. XiqSsidDot1xKeyManagement: type: string description: 'The key management: WPA_8021X, WPA2_8021X, WPA3_8021X or AUTO_8021X' enum: - WPA_8021X - WPA2_8021X - WPA3_8021X - AUTO_8021X XiqLoggingType: type: string description: Firewall Rule Logging type enum: - 'OFF' - DROPPED_PACKETS - SESSION_INITIATION - SESSION_TERMINATION - BOTH XiqIpFirewallRule: allOf: - $ref: '#/components/schemas/XiqViqEntity' - type: object description: IP Firewall Rule properties: action: $ref: '#/components/schemas/XiqIpFirewallAction' description: The IP Firewall Action. service: anyOf: - $ref: '#/components/schemas/XiqNetworkService' - $ref: '#/components/schemas/XiqApplicationService' discriminator: propertyName: service_type mapping: NETWORK: '#/components/schemas/XiqNetworkService' APPLICATION: '#/components/schemas/XiqApplicationService' description: The IP Firewall service type. source_ip: $ref: '#/components/schemas/XiqL3AddressProfile' description: Source IP for IP Firewall Rule. destination_ip: $ref: '#/components/schemas/XiqL3AddressProfile' description: Destination IP for IP Firewall Rule. logging_type: $ref: '#/components/schemas/XiqLoggingType' description: The logging Type for IP Firewall Rule. XiqClassificationRule: allOf: - $ref: '#/components/schemas/XiqBaseEntity' - type: object description: The payload of common object - classification assignment required: - name properties: name: type: string description: The classification assignment name description: type: string description: The classification assignment description classifications: type: array description: The details of rule assignments items: $ref: '#/components/schemas/XiqClassification' XiqApplicationDetectionRule: type: object description: The Application Detection Rule properties: value: type: string description: The value of detection rule type. protocol: $ref: '#/components/schemas/XiqApplicationDetectionProtocol' type: $ref: '#/components/schemas/XiqApplicationDetectionType' XiqHotspotProfile: allOf: - $ref: '#/components/schemas/XiqViqEntity' - $ref: '#/components/schemas/XiqHotspotProfileRequest' PagedXiqCloudConfigGroup: allOf: - $ref: '#/components/schemas/XiqPage' - type: object properties: data: type: array description: The data in the current page items: $ref: '#/components/schemas/XiqCloudConfigGroup' XiqWirelessIfName: type: string description: 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. enum: - WIFI0 - WIFI1 - WIFI2 PagedXiqClassificationRule: allOf: - $ref: '#/components/schemas/XiqPage' - type: object properties: data: type: array description: The data in the current page items: $ref: '#/components/schemas/XiqClassificationRule' XiqSsidPskEncryptionMethod: type: string description: 'The encryption method: for WPA3_PSK please use CCMP, for WPA2_PSK or WPA_PSK, please use CCMP or TKIP, for AUTO_PSK, please use AUTO_TKIP_CCMP' enum: - CCMP - TKIP - AUTO_TKIP_CCMP XiqDateTimeType: type: object description: The end date and time required: - day_of_month - month - year - hour_of_day - minute_of_hour properties: day_of_month: type: integer description: The day of month format: int32 month: type: integer description: The month format: int32 year: type: integer description: The year format: int32 hour_of_day: type: integer description: The 24-hour format hour of day format: int32 minute_of_hour: type: integer description: The minute of the hour format: int32 XiqRpMiscellaneousSettings: allOf: - $ref: '#/components/schemas/XiqBaseEntity' - type: object description: The Miscellaneous settings for radio profile properties: sla_throughput_level: type: string description: The Client SLA options -- "NORMAL_DENSITY", "HIGH_DENSITY" (performance-oriented), or "LOW_DENSITY" (coverage-oriented) radio_range: type: integer description: The Outdoor Deployment for signal distance from 300 to 10000 meters format: int32 wmm_qos_settings: type: array description: The WMM QoS settings for various media types items: $ref: '#/components/schemas/XiqRpWmmQosSettings' XiqValidTimePeriodAfterType: type: string description: The valid time period after Id creation or first login. enum: - ID_CREATION - FIRST_LOGIN XiqIotpTgWhiteListEntry: type: object required: - long_eui - pskd properties: long_eui: oneOf: - type: string minLength: 16 maxLength: 16 pattern: ^[0-9a-fA-F]+$ description: The factory-assigned IEEE EUI-64. (16 hex digits). FFFFFFFFFFFFFFFF is reserved. - type: string pattern: ^\*$ description: Match any joiner. pskd: type: string minLength: 6 maxLength: 32 description: 'The PSKd (Pre-Shared-Key for the Device) is the Joining Device Credential encoded using base32-thread. A Joining Device Credential is encoded as uppercase, alphanumeric characters (base32-thread: 0-9,A-Y excluding I,O,Q, and Z for readability) with a minimum length of 6 such characters and a maximum length of 32 such characters.' pattern: '[0-9ABCDEFGHJKLMNPRSTUVWXY]+' PagedXiqUserProfileAssignment: allOf: - $ref: '#/components/schemas/XiqPage' - type: object properties: data: type: array description: The data in the current page. items: $ref: '#/components/schemas/XiqUserProfileAssignment' XiqCreateUserProfileRequest: type: object required: - name - vlan_profile_id properties: name: type: string description: The user profile name vlan_profile_id: type: integer description: The VLAN profile id format: int64 XiqL3AddressProfile: allOf: - $ref: '#/components/schemas/XiqViqEntity' - $ref: '#/components/schemas/XiqL3AddressCommon' - type: object description: The L3 address profile XiqMacFirewall: allOf: - $ref: '#/components/schemas/XiqViqEntity' - type: object description: MAC Firewall policy. properties: name: type: string description: The MAC Firewall policy name description: type: string description: The MAC Firewall policy description. rules: type: array description: List of MAC Firewall Rules items: $ref: '#/components/schemas/XiqMacFirewallRule' predefined: type: boolean description: Flag to describe whether the application is predefined or customised. XiqSsidWepEncryptionMethod: type: string description: The encryption method type, WEP104 or WEP40 enum: - WEP40 - WEP104 XiqHostNameAddressProfile: allOf: - $ref: '#/components/schemas/XiqL3AddressProfile' XiqSetSsidModeWepRequest: type: object description: The request for setting the SSID to be WEP mode. required: - key_management - encryption_method properties: key_management: $ref: '#/components/schemas/XiqSsidWepKeyManagement' encryption_method: $ref: '#/components/schemas/XiqSsidWepEncryptionMethod' authentication_method: $ref: '#/components/schemas/XiqSsidWepAuthenticationMethod' default_key: $ref: '#/components/schemas/XiqSsidWepDefaultKey' key_type: $ref: '#/components/schemas/XiqSsidKeyType' key_value: maxLength: 13 minLength: 5 type: string description: The first key value, must be 13 characters long for WEP104, and 5 characters long for WEP40, cannot be null if it is the default key example: abcd123456789 key_value2: maxLength: 13 minLength: 5 type: string description: The second key value, must be 13 characters long for WEP104, and 5 characters long for WEP40, cannot be null if it is the default key key_value3: maxLength: 13 minLength: 5 type: string description: The third key value, must be 13 characters long for WEP104, and 5 characters long for WEP40, cannot be null if it is the default key key_value4: maxLength: 13 minLength: 5 type: string description: The fourth key value, must be 13 characters long for WEP104, and 5 characters long for WEP40, cannot be null if it is the default key radius_server_group_id: type: integer description: The RADIUS server group ID if using WEP_8021x as the key management format: int64 XiqClassificationType: type: string description: Classification type enum: - LOCATION - CLOUD_CONFIG_GROUP - IP_ADDRESS - IP_SUBNET - IP_RANGE XiqAttachUPAssignmentRequest: type: object properties: user_profile_assignment_rules: type: array description: The User Profile Assignment and User Profile Id's to attach to SSID. items: $ref: '#/components/schemas/XiqUserProfileAssignmentEntry' enable_user_profile_assignment: type: boolean description: The flag to enable User Profile Assignment. enable_radius_attribute_user_profile_assignment: type: boolean description: The flag to enable Radius Attribute User Profile Assignment. attribute_type: $ref: '#/components/schemas/XiqAttributeType' description: The SSID attribute type. attribute_key: type: integer description: The SSID attribute key. format: int32 default_radius_client_object_id: type: integer format: int64 description: The default RADIUS client object ID. XiqPasswordSettings: type: object description: The password settings ID required: - psk_generation_method - password_character_types - password_length properties: enable_letters: type: boolean description: Enable use of letters enable_numbers: type: boolean description: Enable use of numbers enable_special_characters: type: boolean description: Enable use of special characters password_concat_string: type: string description: The password concatenated string psk_generation_method: $ref: '#/components/schemas/XiqPskGenerationMethod' password_character_types: $ref: '#/components/schemas/XiqPasswordCharacterType' password_length: type: integer description: The maximun password string length format: int32 XiqNetworkService: allOf: - $ref: '#/components/schemas/XiqNetwork' - type: object description: Network Service required: - service_type properties: service_type: type: string description: Service type. enum: - NETWORK - APPLICATION XiqSchedule: allOf: - type: object description: The schedule. properties: description: type: string description: The schedule description. schedule_type: $ref: '#/components/schemas/XiqScheduleType' description: The schedule type name. start_date: type: string format: date description: The start date. end_date: type: string format: date description: The end date. start_time: type: string description: The start time. end_time: type: string description: The end time. recurrence_type: $ref: '#/components/schemas/XiqRecurrenceType' description: The recurrence type. weekday_from: $ref: '#/components/schemas/XiqWeekDay' description: The weekday from value. weekday_to: $ref: '#/components/schemas/XiqWeekDay' description: The weekday to value. start_time_2: type: string description: The second start time. end_time_2: type: string description: The second end time. PagedXiqHotspotServiceProviderProfile: allOf: - $ref: '#/components/schemas/XiqPage' - type: object properties: data: type: array description: The data in the current page items: $ref: '#/components/schemas/XiqHotspotServiceProviderProfile' XiqRpNeighborhoodAnalysis: allOf: - $ref: '#/components/schemas/XiqBaseEntity' - type: object description: The neighborhood analysis config for the radio profile properties: enable_background_scan: type: boolean description: Whether to enable background scanning of neighboring devices background_scan_interval: type: integer description: The background scan interval from 1 up to 1440 minutes format: int32 enable_skip_scan_when_clients_connected: type: boolean description: Whether to enable skipping of background scan when devices have client connections enable_skip_scan_when_clients_in_power_save_mode: type: boolean description: Whether to skipping of background scan when connected devices are in power save mode enable_skip_scan_when_process_voice_traffic: type: boolean description: Whether to enable skipping of background scan when devices have network traffic with voice priority XiqUpdateL3AddressProfileRequest: type: object properties: name: type: string description: The L3 Address profile name. description: type: string description: The L3 Address profile description. enable_classification: type: boolean description: The flag to enable classification entries on host name address profile. classified_entries: type: array description: The host name address profile classified entries. items: $ref: '#/components/schemas/XiqAddressProfileClassifiedEntry' description: The host name address profile classified entry. ip_address_end: type: string description: The classified entry IP address end. netmask: type: string description: The classified entry IP netmask. wildcard_mask: type: string description: The wildcard address profile mask value. XiqErrorParams: type: object description: Error parameters properties: field: type: string description: The error field value: type: string description: The error value XiqIotpMaBleBeaconAppType: type: string description: The BLE Beacon application type. enum: - IBEACON - EDDYSTONE_URL XiqUpdateRpChannelSelectionRequest: type: object properties: enable_dynamic_channel_switching: type: boolean description: Whether to dynamically select and switch channels based on the defined criteria. channel_width: type: string description: The channel frequency range enable_dynamic_frequency_selection: type: boolean description: Whether dynamic frequency selection is enabled (a/n, a, ac mode) enable_static_channel: type: boolean description: Whether static channel is enabled (manual channel selection return) enable_zero_wait_dfs: type: boolean description: Whether ZeroWait DFS is enabled enable_use_last_selection: type: boolean description: Whether to use the last known power and channel during the AP boot up process exclude_channels: type: string description: The comma-separated list of excluded channels not on the selected channel width. exclude_channels_width: type: string description: The comma-separated list of excluded channels on the selected channel width. channel: maximum: 165 minimum: 1 type: integer description: The number of channel selections or AUTO for default selection. format: int32 enable_limit_channel_selection: type: boolean description: Whether to allow for limiting the channel selection to non-overlapping channels. (b/g,g/n/, axes modes) channel_region: type: string description: The channel region -- "USA", "Canada", "Europe", or "World" channel_model: maximum: 4 minimum: 3 type: integer description: The number of channel models to limit. format: int32 channels: type: string description: The comma separated list of channels allowed channel switching enable_channel_auto_selection: type: boolean description: Whether to enable automatic channel switching during specified time interval. channel_selection_start_time: type: string description: The start time for channel switching in 24-hr time format of hh:mm channel_selection_end_time: type: string description: The end time for channel switching in 24-hr time format of hh:mm enable_avoid_switch_channel_if_clients_connected: type: boolean description: Whether to avoid channel switching if there are already max connected clients channel_selection_max_clients: maximum: 100 minimum: 0 type: integer description: The maximum number of connected clients to avoid switching format: int32 enable_switch_channel_if_exceed_threshold: type: boolean description: Whether to enable channel switching when RF interference exceeds the threshold rf_interference_threshold: maximum: 80 minimum: 10 type: integer description: The RF interference threshold for channel switching. format: int32 crc_error_threshold: maximum: 80 minimum: 10 type: integer description: The CRC error threshold for channel switching. format: int32 XiqHsWanMetrics: type: object description: Hotspot WAN (Wide Area Network) metrics. required: - status - downlink_speed - uplink_speed properties: status: $ref: '#/components/schemas/XiqHsWanLinkStatus' downlink_speed: type: integer minimum: 0 maximum: 4194304 description: The downlink speed for the WAN network, in kbps (where 0 is unknown). uplink_speed: type: integer minimum: 0 maximum: 4194304 description: The uplink speed for the WAN network, in kbps (where 0 is unknown). XiqWeekDay: type: string enum: - MONDAY - TUESDAY - WEDNESDAY - THURSDAY - FRIDAY - SATURDAY - SUNDAY XiqError: type: object properties: error_code: type: string description: The error code error_id: type: string description: The error ID for internal troubleshooting error_message: type: string description: The error detailed message error_message_code: type: string description: The error message code error_message_description: type: string description: The error message description error_params: $ref: '#/components/schemas/XiqErrorParams' required: - error_code - error_id - error_message XiqHsNaiEncodingType: type: string description: The NAI realm encoding type. default: RFC-4282 enum: - RFC-4282 - UTF-8 XiqSetSsidModePskRequest: type: object description: The request for setting the SSID to be PSK mode. required: - key_management - encryption_method - key_type - key_value properties: key_management: $ref: '#/components/schemas/XiqSsidPskKeyManagement' encryption_method: $ref: '#/components/schemas/XiqSsidPskEncryptionMethod' anti_logging_threshold: type: integer description: The anti logging threshold format: int32 key_type: $ref: '#/components/schemas/XiqSsidKeyType' key_value: maxLength: 2147483647 minLength: 8 type: string description: The PSK key value, minimum 8 characters long sae_group: $ref: '#/components/schemas/XiqSsidSaeGroup' transition_mode: type: boolean description: Indicates the transition mode if key management is WPA3 XiqAttachMacFirewallRuleToMacFirewallPolicy: type: object properties: source_mac: type: integer format: int64 description: The Source MAC address ID. destination_mac: type: integer format: int64 description: The Destination MAC address ID. action: $ref: '#/components/schemas/XiqMacFirewallAction' description: The MAC Firewall Action. logging_type: $ref: '#/components/schemas/XiqLoggingType' description: The logging Type for MAC Firewall Rule. XiqPage: required: - count - page - total_count - total_pages type: object properties: page: type: integer description: The current page number format: int32 count: type: integer description: The element count of the current page format: int32 total_pages: type: integer description: The total page number based on request page size format: int32 total_count: type: integer description: The total element count format: int64 XiqValidForTimePeriodSettings: type: object description: The settings for Valid For Time Period option or null for other settings. required: - valid_time_period_after properties: valid_time_period_after: $ref: '#/components/schemas/XiqValidTimePeriodAfterType' after_id_creation_settings: $ref: '#/components/schemas/XiqValidTimePeriodAfterIdCreation' after_first_login_settings: $ref: '#/components/schemas/XiqValidTimePeriodAfterFirstLogin' XiqUserProfileAssignmentRule: allOf: - type: object description: User Profile Assignment Rule properties: user_profile: $ref: '#/components/schemas/XiqUserProfile' description: The User Profile of User Profile Assignment rule. enable_by_cwp: type: boolean description: The flag for enableBypassCwp. user_profile_assignment: $ref: '#/components/schemas/XiqUserProfileAssignment' description: The User Profile Assignment. XiqHsQosMap: type: object properties: dscp_ranges: type: array description: A map of ah-class to DSCP range. items: $ref: '#/components/schemas/XiqHsQosAhClassToDscpRange' dscp_exceptions: type: array description: The list of exceptions to the mapping of ah-class to DSCP values. maxItems: 21 items: $ref: '#/components/schemas/XiqHsQosDscpException' XiqUpdateClassificationRuleRequest: required: - name - classifications type: object properties: name: type: string description: The name of classification assignment description: type: string description: The description of classification assignment classifications: type: array description: The details of rule Rules items: $ref: '#/components/schemas/XiqUpdateClassificationRequest' XiqHotspotServiceProviderProfileRequest: type: object description: The Hotspot Service Provider profile. required: - name properties: name: type: string description: The Hotspot Service Provider name. friendly_names: type: array minItems: 0 maxItems: 10 items: $ref: '#/components/schemas/XiqHsLocalizedName' descriptions: type: array minItems: 0 maxItems: 10 items: $ref: '#/components/schemas/XiqHsLocalizedName' icon_files: type: array description: The list of localized icon files for the service provider. minItems: 0 maxItems: 5 items: $ref: '#/components/schemas/XiqHsspIconFile' nai_realms: type: array description: List of Network Access Identification (NAI) realms. A NAI realm is a FQDN of a service provider. maxItems: 10 items: $ref: '#/components/schemas/XiqHsNaiRealm' roaming_consortiums: type: array description: List of Roaming Consortium identifiers. maxItems: 15 items: $ref: '#/components/schemas/XiqHsRoamingConsortium' cellular_networks: type: array description: List of 3rd Generation Partnership Project (3GPP) cellular networks. maxItems: 15 items: $ref: '#/components/schemas/XiqHsCellularNetwork' osu_uri: type: string description: 'The online signup server URI. ''Syntax available at: http://tools.ietf.org/html/rfc3986#section-1.1.2''' osu_methods: type: array description: Encoded OSU methods and their priorities. Priority is given by the index/position in the array. items: $ref: '#/components/schemas/XiqHsspOsuMethod' osu_nai: type: string description: Network Access Identifier (NAI) used as client identity during EAP authentication. XiqDeviceRadioBand: type: string description: Radio Interface Bands enum: - BAND24 - BAND5 - BAND6 - BAND5LOW - BAND5HIGH - BAND6LOW - BAND6HIGH - BANDNONE example: BAND24 XiqIotpMaBleScanGeneric: type: object required: - app_type properties: app_type: $ref: '#/components/schemas/XiqIotpMaBleScanAppType' min_rss: maximum: 20 minimum: -120 default: -100 type: integer format: int32 description: BLE Scan Eddystone-url application minimum Received Signal Strength value, in dBm. vendors: type: array maxItems: 5 description: Collection of BLE Scan vendor filters for Generic Scan applications. items: $ref: '#/components/schemas/XiqIotpMaBleScanVendor' PagedXiqIotProfile: allOf: - $ref: '#/components/schemas/XiqPage' - type: object properties: data: type: array description: The data in the current page items: $ref: '#/components/schemas/XiqIotProfile' XiqUserProfileAssignmentRadiusAttribute: allOf: - type: object description: User Profile Assignment Radius Attribute properties: attribute_type: $ref: '#/components/schemas/XiqAttributeType' description: The Attribute type name attribute_values: type: string description: The Attribute type value XiqIotProfileRequest: type: object description: The IoT Profile oneOf: - $ref: '#/components/schemas/XiqIotProfileThreadGateway' - $ref: '#/components/schemas/XiqIotProfileMultiApplication' discriminator: propertyName: app_supported mapping: SINGLE: '#/components/schemas/XiqIotProfileThreadGateway' MULTI: '#/components/schemas/XiqIotProfileMultiApplication' XiqHotspotProfileRequest: type: object description: The Hotspot profile. required: - name - domain_name properties: name: type: string description: The Hotspot profile name. hessid: type: string pattern: ^([0-9a-fA-F]{2}[:]){5}([0-9a-fA-F]{2})$ example: 00:50:56:01:AE:79 description: Homogenous Extended Service Set Identifier (HESSID) for a Hotspot 2.0 network. MAC address representation for the user interfaces. The HESSID should be different from any MU MAC. It is recommended to use one of the BSSIDs of a registered AP. domain_name: type: string description: The domain name of the entity or organization operating the IEEE 802.11 access network. minLength: 0 maxLength: 255 operator_names: type: array description: Localized names for the Hotspot operator. items: $ref: '#/components/schemas/XiqHsLocalizedName' venue: $ref: '#/components/schemas/XiqHsVenue' access_network_type: $ref: '#/components/schemas/XiqHsAccessNetworkType' dgaf: type: boolean description: Downstream Group Address Forwarding (DGAF). Forward all downlink wireless broadcast ARP and multicast packets. default: false ipv4_availability: $ref: '#/components/schemas/XiqHsIpv4Type' ipv6_availability: $ref: '#/components/schemas/XiqHsIpv6Type' wan_metrics: $ref: '#/components/schemas/XiqHsWanMetrics' connection_capabilities: type: array description: The list of connection capabilities. items: $ref: '#/components/schemas/XiqHsConnectionCapability' qos_map: $ref: '#/components/schemas/XiqHsQosMap' gas_comeback_delay: type: integer minimum: 0 maximum: 65535 default: 0 description: 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: type: integer minimum: 0 maximum: 65535 default: 0 description: The Access Network Query protocol (ANQP) domain ID. All APs in the same ESS that share a common nonzero ANQP domain ID will have identical ANQP information. When the value is 0, the ANQP information is unique to the AP. online_signup: $ref: '#/components/schemas/XiqHsOnlineSignup' nai_realms: type: array description: List of Network Access Identification (NAI) realms. A NAI realm is a FQDN of a service provider. maxItems: 10 items: $ref: '#/components/schemas/XiqHsNaiRealm' roaming_consortiums: type: array description: List of Roaming Consortium identifiers. maxItems: 15 items: $ref: '#/components/schemas/XiqHsRoamingConsortium' cellular_networks: type: array description: List of 3rd Generation Partnership Project (3GPP) cellular networks. maxItems: 15 items: $ref: '#/components/schemas/XiqHsCellularNetwork' service_providers: type: array description: The list of supported hotspot service providers. items: $ref: '#/components/schemas/XiqHotspotServiceProviderProfileRequest' XiqIotpMaBleScanEddystoneUrl: type: object required: - app_type properties: app_type: $ref: '#/components/schemas/XiqIotpMaBleScanAppType' min_rss: maximum: 20 minimum: -120 default: -100 type: integer format: int32 description: BLE Scan Eddystone-url application minimum Received Signal Strength value, in dBm. XiqUpdateRpMacOuiProfileRequest: type: object properties: name: type: string description: The product name value: type: string description: The product MAC or OUI description: type: string description: The product description mac_type: type: string description: The json type, eg, "mac-oui-profile" or "MAC_OUI" defender_defined: type: boolean description: Whether defender is defined XiqMacFirewallPolicyRequest: type: object required: - name - description - rules properties: name: type: string description: The MAC Firewall policy name. description: type: string description: The MAC Firewall policy description. rules: type: array description: List of MAC Firewall Rules items: $ref: '#/components/schemas/XiqMacFirewallRuleRequest' XiqClientMonitorProfile: allOf: - $ref: '#/components/schemas/XiqViqEntity' - $ref: '#/components/schemas/XiqClientMonitorProfileRequest' XiqIotpMaBleScanAppType: type: string description: The BLE Scan application type. enum: - IBEACON - EDDYSTONE_URL - GENERIC PagedXiqHotspotProfile: allOf: - $ref: '#/components/schemas/XiqPage' - type: object properties: data: type: array description: The data in the current page items: $ref: '#/components/schemas/XiqHotspotProfile' XiqHsLanguageCode: type: string description: 'Language code (3B abbreviation) found at: http://www.loc.gov/standards/iso639-2/ISO-639-2_utf-8.txt.' default: eng pattern: ^[a-z]{3}$ XiqIpFirewallRuleRequest: type: object properties: action: $ref: '#/components/schemas/XiqIpFirewallAction' description: The IP Firewall Action. service: type: integer description: Application or Network Service ID for IP Firewall Rule. format: int64 source_ip: type: integer description: Source IP for IP Firewall Rule. format: int64 destination_ip: type: integer description: Destination IP for IP Firewall Rule. format: int64 logging_type: $ref: '#/components/schemas/XiqLoggingType' description: The logging Type for IP Firewall Rule. XiqClientMonitorProfileRequest: allOf: - type: object properties: name: type: string description: The client monitor profile name - $ref: '#/components/schemas/XiqClientMonitorSetting' XiqIotApplicationId: type: string enum: - THREAD_GATEWAY description: IoT application identifiers. XiqHsConnectionCapability: type: object description: 'The connection capability informs client devices about available network services. Used to identify the IP protocols that are permitted or denied on the network or whose permission status is unknown.' required: - protocol - port_number - status properties: protocol: $ref: '#/components/schemas/XiqHsConnectionCapabilityProtocol' port_number: type: integer format: int32 minimum: 0 maximum: 65535 description: The port number. status: $ref: '#/components/schemas/XiqHsConnectionCapabilityStatus' XiqDetachMacFirewallRequest: type: object required: - policy_id properties: policy_id: type: integer format: int64 description: The MAC Firewall policy ID traffic: $ref: '#/components/schemas/XiqTraffic' description: The MAC Firewall traffic direction. XiqDeliverySettings: type: object description: The password delivery settings properties: email_template_id: type: integer description: The Email Template ID format: int64 sms_template_id: type: integer description: The SMS Template ID format: int64 XiqHsIpv4Type: type: string description: "The IPv4 address availability enum:\n * `NOT_AVAILABLE` - No IPv4 address is available.\n * `PUBLIC` - A publicly routable IPv4 address is available.\n * `PORT_RESTRICTED` - An IPv4 address is available but with port restrictions.\n * `SINGLE_NAT` - A private IPv4 address behind a single NAT (Network Address Translation).\n * `DOUBLE_NAT` - A private IPv4 address behind a double NAT.\n * `PORT_RESTRICTED_SINGLE_NAT` - A private IPv4 address behind a single NAT with port restrictions.\n * `PORT_RESTRICTED_DOUBLE_NAT` - A private IPv4 address behind a double NAT with port restrictions.\n * `UNKNOWN` - The type of IPv4 address availability is unknown." default: UNKNOWN enum: - NOT_AVAILABLE - PUBLIC - PORT_RESTRICTED - SINGLE_NAT - DOUBLE_NAT - PORT_RESTRICTED_SINGLE_NAT - PORT_RESTRICTED_DOUBLE_NAT - UNKNOWN XiqValidDailySettings: type: object description: The settings for Valid Daily option or null for other settings. required: - daily_end_hour - daily_end_minute - daily_start_hour - daily_start_minute properties: daily_start_hour: type: integer description: The 24-hour format start hour of the day format: int32 daily_start_minute: type: integer description: The minute of the hour format: int32 daily_end_hour: type: integer description: The 24-hour format end hour of day the end format: int32 daily_end_minute: type: integer description: The minute of the hour format: int32 XiqRadioMode: type: string description: The supported radio modes. enum: - B_G - G_N - A - A_N - AC - AX_2_4_GHZ - AX_5_GHZ - AX_6_GHZ - BE_2_4_GHZ - BE_5_GHZ - BE_6_GHZ XiqHsAccessNetworkType: type: string description: "The Hotspot profile Access Network:\n * `PRIVATE` - An enterprise network with user accounts.\n * `PRIVATE_WITH_GUEST` - An enterprise network providing guest access.\n * `CHARGEABLE_PUBLIC` - Open to anyone but access requires payment.\n * `FREE_PUBLIC` - Open network, free of charge but may still require acceptance of terms of use (and may involve OSU servers with captive portal).\n * `PERSONAL_DEVICE` - Personal device network.\n * `EMERGENCY` - Emergency services only network. \n * `TEST` - Test or experimental network.\n * `WILDCARD` - Wildcard network." default: CHARGEABLE_PUBLIC enum: - PRIVATE - PRIVATE_WITH_GUEST - CHARGEABLE_PUBLIC - FREE_PUBLIC - PERSONAL_DEVICE - EMERGENCY - TEST - WILDCARD XiqRpRadioUsageOptimization: allOf: - $ref: '#/components/schemas/XiqBaseEntity' - type: object description: The radio usage optimization config for the radio profile properties: preamble: type: string description: The preamble data length -- "AUTO" or "LONG" beacon_period: type: integer description: The amount of time between beacons from 40 up to 3500. format: int32 enable_frame_burst: type: boolean description: Whether to enable Frame Burst enable_smart_antenna: type: boolean description: Whether to enable Smart Antenna (Enabling this option will disable (Null) for MU-MIMO) enable_backhaul_failover: type: boolean description: Whether to enable backhaul failover. Backhaul failover settings determine the thresholds at which the device switches from a wired to a wireless backhaul link, and the thresholds at which the device switches back wireless_backhaul_switch_trigger_time: type: integer description: Switch to Wireless Backhaul after 1 up to 5 seconds after the wired link fails format: int32 wired_backhaul_revert_hold_time: type: integer description: Revert Back to Wired Backhaul after 1 up to 300 seconds after the wired link is established format: int32 enable_band_steering: type: boolean description: Whether to enable band steering. Enabling steers clients from 2.4 GHz to 5.0 GHz radio band band_steering_mode: type: string description: The band steering mode -- "BALANCE", "URGE_5G", or "ENFORCE_5G" ignore_initial_client_connection_number: type: integer description: The number of connection attempts from 1 to 100 for 2.4 GHz clients to ignore before responding for URGE_5G steering mode. format: int32 enable_client_load_balancing: type: boolean description: Whether to enable client load balancing. Enabling load-balances clients across neighboring Extreme Networks within the same hive. Set WiFi0 and WiFi1 radios to the same load balancing mode when it is based on the number of associated stations. load_balancing_mode: type: string description: The client load balancing mode -- "AIRTIME_BASED" or "CLIENT_NUMBER" crc_error_rate_per_device: type: integer description: The CRC Error rate threshold from 1 up to 99 for "AIRTIME_BASED" load balancing. Ignore probe and association requests per device when CRC Error rate exceeds the threshold. format: int32 rf_interference_per_device: type: integer description: The RF Interference threshold from 1 up to 99 for "AIRTIME_BASED" load balancing. Ignore probe and association requests per device when RF Interference exceeds the threshold. format: int32 average_airtime_per_client: type: integer description: The Average Airtime Per Client threshold from 1 up to 5 for "AIRTIME_BASED" load balancing. Ignore probe and association requests per device when Average Airtime Per Client exceeds the threshold. format: int32 anchor_period: type: integer description: The Anchor Period from 10 up to 600 for both "AIRTIME_BASED" and "CLIENT_NUMBER" load balancing. Ignore probe and association requests from clients associated with other Extreme Networks devices until Anchor Period Eelapses in the range of 10 to 600 seconds format: int32 neighbor_query_interval: type: integer description: In both client load balancing modes, query neighbors about client load every 1 up to 600 seconds format: int32 enable_weak_signal_probe_request_suppression: type: boolean description: Whether to enable Weak Signal Probe Request Suppression. Weak Signal Probe Request Suppression allows the configuration of signal-to-noise threshold beyond which the device does not respond to client probes. weak_snr_threshold: type: integer description: The signal to noise threshold from 1 up to 100 for Weak Signal Probe Request Suppression. format: int32 enable_safety_net: type: boolean description: Whether to enable Safety Net. When a device is overloaded or is probed by clients with a low signal-to-noise ratio, Safety Net allows the device to respond to association requests after a certain time period lapses. safety_net_period: type: integer description: The Safety Net Time Period from 5 up to 300 seconds. format: int32 enable_high_density: type: boolean description: Whether to enable High Density Configuration. Enabling optimizes performance in high density environments management_frame_basic_data_rate: type: string description: The data rates to support in high density environment -- "HIGH" or "LOW" enable_suppress_successive_probe_request: type: boolean description: Whether to Reduce Response to Probe Requests. Enabling suppresses successive requests within the same beacon interval probe_response_reduction_option: type: string description: The suppress response to broadcast probes options -- "ONLY_ONE_SSID_RESPOND_AT_A_TIME" (allowed for only one SSID to respond at a time), "REDUCE_CERTAIN_CLIENTS_RESPONSE" (reducing responses to certain client devices). suppression_limit: type: integer description: The Number of Connection Attempts from 1 up to 10 format: int32 enable_radio_balance: type: boolean description: Whether to enable Radio Load Balancing. Enabling distributes wireless clients that support 5 GHz band evenly across the two radios in Dual-5G mode when an SSID is available on both radios enable_ampdu: type: boolean description: Enable Aggregate MAC Protocol Data Units to combine data frames into larger frames before transmission. enable_mu_mimo: type: boolean description: Whether to enable Multiple-Input Multiple-Output (802.11ac & 802.11ax) for multiple-user access by using different spatial streams. enable_ofdma_down_link: type: boolean description: Whether to enable OFDMA for AP downlink communication. enable_ofdma_up_link: type: boolean description: Whether to enable OFDMA for AP uplink communication. bss_coloring: type: integer description: Whether to enable BSS Coloring (802.11ax ) to identify overlapping basic service sets (OBSSs). format: int32 enable_target_weak_time: type: boolean description: Whether to enable Target Weak Time. mac_ouis: type: array description: The device vendor identifiers for the "REDUCE_CERTAIN_CLIENTS_RESPONSE" for the probe response reduction option items: $ref: '#/components/schemas/XiqRpMacOuiProfile' ratio_for_5g_clients: type: integer description: The percentage distribution from 1 up to 100 for 2.4 and 5.0 GHz clients for "BALANCE" steering mode. format: int32 XiqApplicationService: allOf: - $ref: '#/components/schemas/XiqApplication' - type: object description: Application service required: - service_type properties: service_type: type: string description: Service type. enum: - NETWORK - APPLICATION XiqUpdateRpMiscellaneousSettingsRequest: type: object properties: sla_throughput_level: type: string description: The Client SLA options -- "NORMAL_DENSITY", "HIGH_DENSITY" (performance-oriented), or "LOW_DENSITY" (coverage-oriented) radio_range: maximum: 10000 minimum: 300 type: integer description: The Outdoor Deployment for signal distance from 300 to 10000 meters format: int32 XiqHsVenueType: type: string description: 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 accurately describe the venue information. enum: - 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 default: UNSPECIFIED XiqHsOsuNetworkAuthType: type: string description: "The Network Authentication type for Hotspot profiles:\n * `ACCEPTANCE_TERMS` - Indicate that the network requires the user to accept terms and conditions.\n * `ONLINE_SIGN_UP` - Indicate that the network supports online enrollment and that the user can obtain authentication credentials online.\n * `CWP` - Capital web authentication, the network infrastructure performs an HTTP/HTTPS redirect for authentication." enum: - ACCEPTANCE_TERMS - ONLINE_SIGN_UP - CWP XiqNetworkServiceRequest: type: object description: Network properties: name: type: string description: The network service name. description: type: string description: The network service name. ip_protocol: $ref: '#/components/schemas/XiqNetworkIpProtocol' description: The IP protocol. protocol_number: type: integer format: int32 description: The protocol number. port_number: type: integer format: int32 description: The port number. alg_type: $ref: '#/components/schemas/XiqNetworkAlgType' description: The Application Layer Gateway (ALG) type. XiqPostExpirationAction: type: object description: The type of action to take after the account expiration. properties: enable_credentials_renewal: type: boolean description: The renew user credentials option or null for other option. enable_delete_immediately: type: boolean description: The immediate delete option or null to schedule the delete. delete_after_value: type: integer description: The after expiration scheduled time to delete or null to not delete.. format: int32 delete_after_unit: $ref: '#/components/schemas/XiqDateTimeUnitType' XiqRpChannelSelection: allOf: - $ref: '#/components/schemas/XiqBaseEntity' - type: object description: The payload of channel selection for the radio profile properties: enable_dynamic_channel_switching: type: boolean description: Whether to dynamically select and switch channels based on the defined criteria. channel_width: type: string description: The channel frequency range enable_dynamic_frequency_selection: type: boolean description: Whether dynamic frequency selection is enabled (a/n, a, ac mode) enable_static_channel: type: boolean description: Whether static channel is enabled (manual channel selection return) enable_zero_wait_dfs: type: boolean description: Whether ZeroWait DFS is enabled enable_use_last_selection: type: boolean description: Whether to use the last known power and channel during the AP boot up process exclude_channels: type: string description: The comma-separated list of excluded channels not on the selected channel width. exclude_channels_width: type: string description: The comma-separated list of excluded channels on the selected channel width. channel: type: integer description: The number of channel selections from 1 up to 165 or AUTO for default selection. format: int32 enable_limit_channel_selection: type: boolean description: Whether to allow for limiting the channel selection to non-overlapping channels. (b/g,g/n/, axes modes) channel_region: type: string description: The channel region -- "USA", "Canada", "Europe", or "World" channel_model: maximum: 4 minimum: 3 type: integer description: The number of channel models to limit. format: int32 channels: type: string description: The comma separated list of channels allowed channel switching enable_channel_auto_selection: type: boolean description: Whether to enable automatic channel switching during specified time interval. channel_selection_start_time: type: string description: The start time for channel switching in 24-hr time format of hh:mm channel_selection_end_time: type: string description: The end time for channel switching in 24-hr time format of hh:mm enable_avoid_switch_channel_if_clients_connected: type: boolean description: Whether to avoid channel switching if there are already max connected clients channel_selection_max_clients: type: integer description: The maximum number of connected clients from 0 up to 100 to avoid switching format: int32 enable_switch_channel_if_exceed_threshold: type: boolean description: Whether to enable channel switching when RF interference exceeds the threshold rf_interference_threshold: type: integer description: The RF interference threshold from 10 up to 80 for channel switching. format: int32 crc_error_threshold: type: integer description: The CRC error threshold from 10 up to 80 for channel switching. format: int32 XiqUpdateMacObjectRequest: type: object properties: name: type: string description: The product model. description: type: string description: The product description. value: type: string description: The MAC octets. mac_address_end: type: string description: The MAC address end. XiqAttachIpFirewallRuleToIpFirewallPolicy: type: object properties: service_id: type: integer format: int64 description: The Application / Network Service ID. source_ip: type: integer format: int64 description: The Source L3 Address Profile ID. destination_ip: type: integer format: int64 description: The Destination L3 Address Profile ID. action: $ref: '#/components/schemas/XiqIpFirewallAction' description: The IP Firewall Action. logging_type: $ref: '#/components/schemas/XiqLoggingType' description: The logging Type for IP Firewall Rule. XiqHsVenueGroup: type: string description: The venue group ID categorizes the general type of location. enum: - UNSPECIFIED - ASSEMBLY - BUSINESS - EDUCATIONAL - FACTORY_AND_INDUSTRIAL - INSTITUTIONAL - MERCANTILE - RESIDENTIAL - STORAGE - UTILITY_AND_MISCELLANEOUS - VEHICULAR - OUTDOOR default: UNSPECIFIED XiqMacFirewallRule: allOf: - $ref: '#/components/schemas/XiqViqEntity' - type: object description: Mac Firewall Rule properties: action: $ref: '#/components/schemas/XiqMacFirewallAction' description: The Mac Firewall Action. source_mac: $ref: '#/components/schemas/XiqMacObject' description: The Source MAC address. destination_mac: $ref: '#/components/schemas/XiqMacObject' description: The Destination MAC address. logging_type: $ref: '#/components/schemas/XiqLoggingType' description: The logging Type for MAC Firewall Rule. XiqSsidWepAuthenticationMethod: type: string description: The authentication method type, OPEN or SHARED enum: - OPEN - SHARED XiqHsspOsuMethod: type: string description: "OSU protocols supported by the Service Provider:\n * `OMA_DM` - Set OSU provider support of the OMA DM (Open Mobile Alliance Device Management) protocol.\n * `SOAP_XML_SPP` - Set OSU provider support of SOAP XML SPP (Simple Object Access Protocol Extensible Markup Language Subscription Provisioning Protocol)." enum: - OMA_DM - SOAP_XML_SPP XiqHsLocalizedName: type: object description: A language specific name. required: - name properties: name: type: string description: Up to 252 byte UTF-8 string. minLength: 1 maxLength: 252 language: $ref: '#/components/schemas/XiqHsLanguageCode' XiqAttributeType: type: string enum: - TUNNEL - STANDARD - CUSTOM XiqIotpMaBleBeacon: type: object properties: applications: type: array maxItems: 2 description: Collection of BLE Beacon applications items: $ref: '#/components/schemas/XiqIotpMaBleBeaconApplication' XiqCreateRadioProfileRequest: type: object required: - name properties: name: type: string description: The radio profile name description: type: string description: The radio profile description. transmission_power: maximum: 20 minimum: 1 type: integer description: The transmission power floor in the range of 1-20 dBm or null for Auto. format: int32 max_transmit_power: maximum: 20 minimum: 10 type: integer description: The maximum transmit power in the range of 10-20 dBm. format: int32 transmission_power_floor: maximum: 20 minimum: 2 type: integer description: The transmission power floor in the range of 2-20 dBm. format: int32 transmission_power_max_drop: maximum: 18 minimum: 0 type: integer description: The transmission power max drop in the range of 0-18 dB. format: int32 max_clients: maximum: 255 minimum: 1 type: integer description: The maximum number of clients in the range of 1-255. format: int32 enable_client_transmission_power: type: boolean description: Whether or not client transmission power control (802.11h) is enabled. client_transmission_power: maximum: 20 minimum: 1 type: integer description: The client transmission power (in the range of 1-20 dBm) if it is enabled. format: int32 radio_mode: $ref: '#/components/schemas/XiqRadioMode' enable_ofdma: type: boolean description: Whether to enable Orthogonal Frequency Division Multiple Access (802.11ax) for multiple-user access by subdividing a channel. XiqSsidEncryptionMethod: type: string enum: - CCMP - TKIP - AUTO_TKIP_CCMP - WEP40 - WEP104 - AES192 XiqSsidAccessSecurity: allOf: - type: object description: The Ssid Access Security. properties: key_type: $ref: '#/components/schemas/XiqSsidKeyType' description: The key type e.g, ASCII or HEX. key_value: type: string description: The schedule type name. sae_group: $ref: '#/components/schemas/XiqSsidSaeGroup' description: The SAE group. anti_logging_threshold: type: integer format: int64 description: The anti logging threshold value. transition_mode: type: boolean description: The flag for enabling transition mode. security_type: type: string description: The security type. key_management: $ref: '#/components/schemas/XiqSsidKeyManagement' description: The SSID key management value. encryption_method: $ref: '#/components/schemas/XiqSsidEncryptionMethod' description: The SSID encryption method. XiqValidDuringDateSettings: type: object description: The settings for Valid During Dates option or null for other settings. required: - start_date_time - end_date_time - time_zone properties: start_date_time: $ref: '#/components/schemas/XiqDateTimeType' end_date_time: $ref: '#/components/schemas/XiqDateTimeType' time_zone: type: string description: The date/time timezone XiqCreateMacObjectRequest: type: object required: - name - value - mac_type properties: name: type: string description: The product model. description: type: string description: The product description. value: type: string description: The MAC octets. mac_type: $ref: '#/components/schemas/XiqMacObjectType' description: The type e.g, "MAC_OUI", "MAC_RANGE" or "MAC_ADDRESS". mac_address_end: type: string description: The MAC address end, only available for "MAC_RANGE" type. XiqUserProfile: allOf: - $ref: '#/components/schemas/XiqBaseEntity' - type: object description: The payload of User Profile required: - name properties: name: type: string description: The user profile name vlan_profile: $ref: '#/components/schemas/XiqVlanProfile' enable_firewall: type: boolean description: Flag to enable Firewall. inbound_mac_firewall: $ref: '#/components/schemas/XiqMacFirewall' description: The Inbound MAC Firewall policy. outbound_mac_firewall: $ref: '#/components/schemas/XiqMacFirewall' description: The Outbound MAC Firewall policy. mac_firewall_default_action: $ref: '#/components/schemas/XiqMacFirewallAction' description: The MAC Firewall Default action. inbound_ip_firewall: $ref: '#/components/schemas/XiqIpFirewall' description: The Inbound IP Firewall policy. outbound_ip_firewall: $ref: '#/components/schemas/XiqIpFirewall' description: The Outbound IP Firewall policy. ip_firewall_default_action: $ref: '#/components/schemas/XiqIpFirewallAction' description: The IP Firewall Default action. XiqUpdateCloudConfigGroupRequest: type: object properties: name: type: string description: The CCG name description: type: string description: The CCG description device_ids: type: array description: The device ID list. items: type: integer description: The device ID list. format: int64 XiqWildcardHostNameAddressProfile: allOf: - $ref: '#/components/schemas/XiqL3AddressProfile' XiqNetworkAlgType: type: string enum: - NONE - FTP - TFTP - SIP - DNS - HTTP XiqCreateClassificationRequest: type: object description: The details of rule assignments required: - classification_type - match - classification_type_id properties: classification_type: type: string description: Classification type enum: - CLASSIFICATION_TYPE_UNSPECIFIED - CLASSIFICATION_TYPE_LOCATION - CLASSIFICATION_TYPE_CLOUD_CONFIG_GROUP - CLASSIFICATION_TYPE_IP_ADDRESS - CLASSIFICATION_TYPE_IP_SUBNET - CLASSIFICATION_TYPE_IP_RANGE - UNRECOGNIZED match: type: boolean description: Contains or not contains classification_type_id: type: integer description: The ID of location, cloud config group, IP address, IP subnet or IP range. format: int64 XiqUpdateRadioProfileRequest: type: object properties: name: type: string description: The radio profile name description: type: string description: The radio profile description. transmission_power: maximum: 20 minimum: 1 type: integer description: The transmission power floor in the range of 1-20 dBm or null for Auto. format: int32 max_transmit_power: maximum: 20 minimum: 10 type: integer description: The maximum transmit power in the range of 10-20 dBm. format: int32 transmission_power_floor: maximum: 20 minimum: 2 type: integer description: The transmission power floor in the range of 2-20 dBm. format: int32 transmission_power_max_drop: maximum: 18 minimum: 0 type: integer description: The transmission power max drop in the range of 0-18 dB. format: int32 max_clients: maximum: 255 minimum: 1 type: integer description: The maximum number of clients in the range of 1-255. format: int32 enable_client_transmission_power: type: boolean description: Whether or not client transmission power control (802.11h) is enabled. client_transmission_power: maximum: 20 minimum: 1 type: integer description: The client transmission power (in the range of 1-20 dBm) if it is enabled. format: int32 radio_mode: $ref: '#/components/schemas/XiqRadioMode' enable_ofdma: type: boolean description: Whether to enable Orthogonal Frequency Division Multiple Access (802.11ax) for multiple-user access by subdividing a channel. XiqUpdateSsidAdvancedSettingsRequest: type: object properties: enable802_dot11mc: type: boolean description: Whether to enable 802.11mc on SSID. XiqIpRangeAddressProfile: allOf: - $ref: '#/components/schemas/XiqL3AddressProfile' - type: object description: IP range address profile properties: ip_address_end: type: string description: The classified entry IP address end. XiqDeviceRadioOperatingMode: title: OperatingMode description: 'Modern AP hardware types include dual or triple band radios. A limited subset of band combinations are supported. Operating mode defines the supported band combinations per radio. Access Points with fixed band radios use GENERIC operating mode.
SERVICE_2_5_6: wifi0-2.4Ghz, wifi1-5Ghz, wifi2-6Ghz
SENSOR_SERVICE_5_6: wifi0-Tri-band sensor, wifi1-5Ghz, wifi2-6Ghz
SERVICE_5L_5H_6: wifi0-5G Low, wifi1-5G High, wifi2-6Ghz
SENSOR_SERVICE_5_2: wifi0-Tri-band sensor, wifi1-5GHz, wifi2-2.4Ghz
SERVICE_5L_5H_2: wifi0-5G Low, wifi1-5G High, wifi2-2.4Ghz
SERVICE_6L_5_6H: wifi0-6G Low, wifi1-5GHz, wifi2-6Ghz
SERVICE_2_5H_5L: wifi0-2.4Ghz, wifi1-5G High, wifi2-5G Low
' enum: - GENERIC - SERVICE_2_5_6 - SENSOR_SERVICE_5_6 - SERVICE_5L_5H_6 - SENSOR_SERVICE_5_2 - SERVICE_5L_5H_2 - SERVICE_6L_5_6H - SERVICE_2_5H_5L type: string default: GENERIC example: SERVICE_2_5_6 XiqPcgType: type: string description: The private client group type for pcgUseOnly enum: - AP_BASED - KEY_BASED XiqIpFirewallRuleId: type: object required: - ip_firewall_rule_id properties: ip_firewall_rule_id: type: integer format: int64 description: The IP Firewall Rule ID. XiqSsidPpskKeyManagement: type: string description: 'The key management: WPA2_PSK, WPA_PSK, AUTO_PSK' enum: - WPA_PSK - WPA2_PSK - AUTO_PSK XiqApplication: allOf: - $ref: '#/components/schemas/XiqViqEntity' - type: object properties: name: type: string description: The application name. description: type: string description: The application description. predefined: type: boolean description: Flag to describe whether the application is predefined or customized. category_id: type: integer description: The category ID of application. format: int64 category_name: type: string description: The category name of application. detection_rules: type: array description: The application detection rules. items: $ref: '#/components/schemas/XiqApplicationDetectionRule' XiqAttachMacFirewallRequest: type: object required: - policy_id - traffic properties: policy_id: type: integer format: int64 description: The MAC Firewall policy ID traffic: $ref: '#/components/schemas/XiqTraffic' description: The MAC Firewall traffic direction. XiqCreateCloudConfigGroupRequest: type: object required: - name properties: name: type: string description: The CCG name description: type: string description: The CCG description device_ids: type: array description: The device ID list. items: type: integer description: The device ID list. format: int64 XiqOsObject: allOf: - type: object description: The OS object. properties: id: type: integer description: The unique identifier format: int64 name: type: string description: The OS object name. PagedMacFirewall: allOf: - $ref: '#/components/schemas/XiqPage' - type: object properties: data: type: array description: The data in the current page items: $ref: '#/components/schemas/XiqMacFirewall' XiqMacObject: allOf: - $ref: '#/components/schemas/XiqViqEntity' - type: object description: The MAC Object. properties: name: type: string description: The MAC object name. description: type: string description: The MAC object description. predefined: type: boolean description: Whether the MAC Oui is predefined. value: type: string description: The MAC octets. mac_type: $ref: '#/components/schemas/XiqMacObjectType' description: The MAC object type e.g, "MAC_OUI", "MAC_RANGE" or "MAC_ADDRESS". defender_defined: type: boolean description: Whether defender is defined. mac_address_end: type: string description: The MAC address end, only available for "MAC_RANGE" type. XiqSsidWepKeyManagement: type: string description: The key management type, WEP or WEP_8021X enum: - WEP - WEP_8021X XiqRadiusClientProfile: allOf: - type: object description: The RADIUS Client profile. properties: default_radius_client_object_id: type: integer format: int64 description: The default RADIUS client object ID. enable_classification: type: boolean description: The flag to enable classification entries on RADIUS client profile. classified_entries: description: The RADIUS client profile classified entries. type: array items: $ref: '#/components/schemas/XiqRadiusClientProfileEntry' description: The RADIUS client profile entry. XiqValidTimePeriodAfterFirstLogin: type: object description: The settings for the valid time period after First Login option or null for the other option required: - valid_time_period - valid_time_period_unit - first_login_within - first_login_within_unit properties: valid_time_period: type: integer description: The valid time period after the first login format: int32 valid_time_period_unit: $ref: '#/components/schemas/XiqDateTimeUnitType' first_login_within: type: integer description: The first time the access key must be used format: int32 first_login_within_unit: $ref: '#/components/schemas/XiqDateTimeUnitType' XiqHsOnlineSignup: type: object description: The Hotspot profile Online Signup settings. required: - network_auth_type properties: network_auth_type: $ref: '#/components/schemas/XiqHsOsuNetworkAuthType' redirection_url: type: string description: The redirection URL, when the Network Authentication type is CWP. ssid_id: type: integer description: OSU SSID ID, when the Network Authentication type is ONLINE_SIGN_UP. The authentication mode must be open or OSEN. format: int64 XiqPasswordCharacterType: type: string description: Password generation using letters, numbers, and/or special characters enum: - INCLUDE_ALL_CHARACTER_TYPE_ENABLED - INCLUDE_ANY_CHARACTER_TYPES_ENABLED - INCLUDE_ONLY_ONE_CHARACTER_TYPE_ENABLED XiqUserProfileAssignment: allOf: - $ref: '#/components/schemas/XiqViqEntity' - type: object description: The User Profile Assignment properties: name: type: string description: The User Profile Assignment description: type: string description: The User Profile Assignment description authorisation_policy: type: string description: The Authorization policy name. folder_ids: type: array description: The location folder Id list. items: type: integer format: int64 description: The location ID. assignment_radius_attribute: $ref: '#/components/schemas/XiqUserProfileAssignmentRadiusAttribute' description: The User Profile Assignment Radius Attribute. user_groups: type: array uniqueItems: true description: The set of User groups. items: $ref: '#/components/schemas/XiqUserGroup' mac_object_profiles: type: array uniqueItems: true description: The set of Mac object profiles. items: $ref: '#/components/schemas/XiqMacObject' os_object_dhcp: type: array uniqueItems: true description: The set of OS DHCP objects. items: $ref: '#/components/schemas/XiqOsObject' os_object_https: type: array uniqueItems: true description: The set of OS HTTP objects. items: $ref: '#/components/schemas/XiqOsObject' schedules: type: array uniqueItems: true description: The set of schedules. items: $ref: '#/components/schemas/XiqSchedule' XiqCreateRpMacOuiProfileRequest: type: object required: - name - value properties: name: type: string description: The product name value: type: string description: The product MAC or OUI description: type: string description: The product description mac_type: type: string description: The json type, eg, "mac-oui-profile" or "MAC_OUI" defender_defined: type: boolean description: Whether defender is defined XiqIpFirewallPolicyRequest: type: object required: - name - description - rules properties: name: type: string description: The IP firewall policy name description: type: string description: The IP firewall policy description. rules: type: array description: List of IP Firewall Rules..... items: $ref: '#/components/schemas/XiqIpFirewallRuleRequest' XiqMacFirewallAction: type: string enum: - PERMIT - DENY XiqPskGenerationMethod: type: string description: The psk generation method enum: - PASSWORD_ONLY - USER_STRING_PASSWORD XiqHsspIconFile: type: object description: The OSU registration server icon according to language mode. required: - file_name - file properties: file_directory_name: type: string minLength: 1 maxLength: 32 description: The icon file name for the OSU provider. file: type: string minLength: 1 maxLength: 32 description: 'Contains the icon file (jpg, png, bmp, gif format) base64 encoded. A single icon size must be less than 64 KB.' language: $ref: '#/components/schemas/XiqHsLanguageCode' XiqDetachIpFirewallRequest: type: object required: - policy_id properties: policy_id: type: integer format: int64 description: The IP Firewall policy ID traffic: $ref: '#/components/schemas/XiqTraffic' description: The IP Firewall traffic direction. XiqNetworkIpProtocol: type: string enum: - TCP - UDP - SVP - CUSTOM XiqHsConnectionCapabilityProtocol: type: string description: Hotspot Connection Capability protocol. enum: - ESP - ICMP - TCP - UDP XiqAttachIpFirewallRequest: type: object required: - policy_id - traffic properties: policy_id: type: integer format: int64 description: The IP Firewall policy ID traffic: $ref: '#/components/schemas/XiqTraffic' description: The IP Firewall traffic direction. XiqSortOrder: type: string enum: - ASC - DESC XiqSsidSaeGroup: type: string description: 'The SAE group: ALL, ECC, or FFC, must be selected when the key management is WPA3' enum: - ALL - ECC - FFC XiqValidTimePeriodAfterIdCreation: type: object description: The settings for the valid time period after ID Creation option or null for the other option required: - valid_time_period - valid_time_period_unit properties: valid_time_period: type: integer description: The valid time period after account creation format: int32 valid_time_period_unit: $ref: '#/components/schemas/XiqDateTimeUnitType' XiqIotProfileMultiApplication: type: object required: - name - app_supported properties: app_supported: $ref: '#/components/schemas/XiqIotApplicationSupported' name: type: string description: The IoT profile name ble_beacon: $ref: '#/components/schemas/XiqIotpMaBleBeacon' ble_scan: $ref: '#/components/schemas/XiqIotpMaBleScan' XiqPasswordType: type: string description: The access key type enum: - PPSK - RADIUS XiqUserProfileAssignmentEntry: type: object properties: user_profile_id: type: integer format: int64 description: The User Profile ID. user_profile_assignment_id: type: integer format: int64 description: The User Profile Assignment ID. XiqIotpMaBleScanVendor: type: object required: - company_id properties: vendor_type: $ref: '#/components/schemas/XiqIotpMaBleScanVendorType' vendor_name: type: string description: Custom Vendor name, for CUSTOM Vendor type. company_id: maximum: 65535 minimum: -1 default: -1 type: integer format: int32 description: Unique company identifier. This value will be used as a filter, whereby if specified the AP will only forward frames for beacons with matching value on the 2 byte field 6 - 7. A value of "-1" indicates no filtering is applied. Company IDs provided at https://www.bluetooth.com/specifications/assigned-numbers/company-identifiers/ XiqClientMonitorParameters: type: object description: The client monitor setting parameters properties: trigger_times: type: integer format: int32 minimum: 1 maximum: 10 default: 1 description: Set how many times the problem type is detected to trigger reporting the problem and related logs. Default value is 1. Range is 1-10. report_interval: type: integer format: int32 minimum: 0 maximum: 3600 default: 30 description: Set the interval (in seconds) to report the problem and related logs. Default value is 30 seconds. Range is 0 or 30-3600. XiqHsEapMethod: type: string description: The Extensible Authentication Protocol (EAP) method. enum: - EAP_TTLS_PAP - EAP_TTLS_CHAP - EAP_TTLS_MSCHAP - EAP_TTLS_MSCHAPV2 - EAP_TLS - EAP_SIM XiqApplicationDetectionProtocol: type: string enum: - HTTP - HTTPS XiqApplicationDetectionType: type: string enum: - HOST_NAME - SERVER_IP_ADDRESS - PORT_NUMBER PagedXiqClientMonitorProfile: allOf: - $ref: '#/components/schemas/XiqPage' - type: object properties: data: type: array description: The data in the current page items: $ref: '#/components/schemas/XiqClientMonitorProfile' XiqScheduleType: type: string enum: - ONE_TIME - RECURRING description: The schedule type. XiqSubnetAddressProfile: allOf: - $ref: '#/components/schemas/XiqL3AddressProfile' - type: object description: Subnet address profile properties: netmask: type: string description: The Subnet address netmask. XiqDetachUPAssignmentRequest: type: object properties: user_profile_assignment_rules: type: array description: The User Profile Assignment and User Profile Id's to attach to SSID. items: $ref: '#/components/schemas/XiqUserProfileAssignmentEntry' XiqVlanProfile: allOf: - $ref: '#/components/schemas/XiqBaseEntity' - type: object description: The payload of common object - VLAN profile required: - name - default_vlan_id - enable_classification properties: name: type: string description: The VLAN profile name default_vlan_id: type: integer description: The default VLAN ID format: int32 enable_classification: type: boolean description: If apply VLANs to devices using classification classified_entries: type: array description: The VLAN object classified entries items: $ref: '#/components/schemas/XiqVlanObjectClassifiedEntry' XiqBaseEntity: required: - id - create_time - update_time type: object properties: id: type: integer description: The unique identifier format: int64 create_time: type: string description: The create time format: date-time update_time: type: string description: The last update time format: date-time XiqSsidKeyManagement: type: string enum: - WPA_PSK - WPA2_PSK - WPA3_PSK - AUTO_PSK - WPA_8021X - WPA2_8021X - WPA3_8021X - AUTO_8021X - WEP - WEP_8021X XiqMacFirewallRuleRequest: type: object properties: action: $ref: '#/components/schemas/XiqMacFirewallAction' description: The MAC Firewall Action. source_mac: type: integer description: Source MAC address for MAC Firewall Rule. format: int64 destination_mac: type: integer description: Destination MAC address for MAC Firewall Rule. format: int64 logging_type: $ref: '#/components/schemas/XiqLoggingType' description: The logging Type for MAC Firewall Rule. XiqHotspotServiceProviderProfile: allOf: - $ref: '#/components/schemas/XiqViqEntity' - $ref: '#/components/schemas/XiqHotspotServiceProviderProfileRequest' PagedXiqRadioProfile: allOf: - $ref: '#/components/schemas/XiqPage' - type: object properties: data: type: array description: The data in the current page items: $ref: '#/components/schemas/XiqRadioProfile' PagedXiqSsid1: allOf: - $ref: '#/components/schemas/XiqPage' - type: object properties: data: type: array description: The data in the current page items: $ref: '#/components/schemas/XiqSsid1' XiqDateTimeUnitType: type: string description: The after expiration scheduled time unit. enum: - MINUTE - HOUR - DAY - WEEK XiqUpdateRpWmmQosSettingsRequest: type: object properties: arbitration_interframe_space: maximum: 15 minimum: 1 type: integer description: The Arbitration Interframe space, in the range of 1 to 15. format: int32 min_contention_window: maximum: 15 minimum: 1 type: integer description: The Minimum Contention window, in the range of 1 to 15. format: int32 max_contention_window: maximum: 15 minimum: 1 type: integer description: The Maximum Contention window, in the range of 1 to 15. format: int32 transmission_opportunity_limit: maximum: 8192 minimum: 0 type: integer description: The Transmission Opportunity limit, in the range of 0 to 8192. format: int32 enable_no_ack: type: boolean description: Whether to enable No Acknowledgment XiqIpFirewall: allOf: - $ref: '#/components/schemas/XiqViqEntity' - type: object description: IP Firewall policy. properties: name: type: string description: The IP Firewall policy name description: type: string description: The IP Firewall policy description. rules: type: array description: List of IP Firewall Rules. items: $ref: '#/components/schemas/XiqIpFirewallRule' predefined: type: boolean description: Flag to describe whether the application is predefined or customized. XiqCloudConfigGroup: allOf: - $ref: '#/components/schemas/XiqViqEntity' - type: object description: The CCG required: - name - predefined properties: name: type: string description: The CCG name description: type: string description: The CCG description predefined: type: boolean description: Whether it is predefined read_only: type: boolean description: Whether it is read-only zone_name: type: string description: The zone name. zone_id: type: integer description: The zone ID format: int64 zone_location_id: type: integer description: The zone location ID format: int64 device_ids: type: array description: The device IDs selected for this Ccg. items: type: integer description: The device IDs selected for this Ccg. format: int64 XiqIotProfileThreadGateway: type: object required: - name - app_supported properties: app_id: $ref: '#/components/schemas/XiqIotApplicationId' app_supported: $ref: '#/components/schemas/XiqIotApplicationSupported' name: type: string description: The IoT profile name threadGateway: type: object required: - short_pan_id - ext_pan_id - master_key - network_name - channel properties: short_pan_id: type: string minLength: 4 maxLength: 4 pattern: ^[0-9a-fA-F]+$ description: The Personal Area Network (PAN) ID. (4 hex digits). FFFF is reserved. ext_pan_id: type: string minLength: 16 maxLength: 16 pattern: ^[0-9a-fA-F]+$ description: The Extended Personal Area Network (PAN) ID. (16 hex digits) master_key: type: string minLength: 32 maxLength: 32 pattern: ^[0-9a-fA-F]+$ description: The network key is used to secure access to the Thread network. It is used to encrypt and authenticate all messages on the network. (32 hex digits) network_name: type: string minLength: 1 maxLength: 16 description: A human-readable name for the network, up to 16 bytes in length. channel: type: integer minimum: 0 description: 802.15.4 channel number, 11-26 enable_nat64: type: boolean default: true description: Enable NAT64 functions including the translator and the prefix publishing. comm_credentials: type: string minLength: 6 maxLength: 255 pattern: ^.{6,255}$ description: The Commissioner Credential is used along with the Extended PAN ID, and Network Name to create the PSKc (Pre-Shared Key for the Commissioner). comm_timeout: type: integer default: 120 minimum: 1 maximum: 2000000 description: After this timeout the Commissioner will shutdown. The default is 120 sec. but the max is approximately 23 days. white_list: type: array items: $ref: '#/components/schemas/XiqIotpTgWhiteListEntry' description: The table of approved Thread end-devices. default_user_profile_id: type: integer description: The default user-profile ID. format: int64 enable_dns_search_domain: type: boolean default: false description: Enable adding DNS search domain to unqualified host lookups forwarded by upstream DNS (in the thread border router). XiqSsidPskKeyManagement: type: string description: 'The key management: WPA3_PSK, WPA2_PSK, WPA_PSK,AUTO_PSK' enum: - WPA_PSK - WPA2_PSK - WPA3_PSK - AUTO_PSK XiqMacFirewallRuleId: type: object required: - mac_firewall_rule_id properties: mac_firewall_rule_id: type: integer format: int64 description: The MAC Firewall Rule ID. XiqDeviceInterfaceRadioMode: type: object description: Device Radio Interface Band. required: - name - band - default_radio_mode properties: name: $ref: '#/components/schemas/XiqWirelessIfName' band: $ref: '#/components/schemas/XiqDeviceRadioBand' default_radio_mode: $ref: '#/components/schemas/XiqRadioMode' XiqSsidWepDefaultKey: type: string description: The default key, FIRST, SECOND,THIRD, OR FOURTH enum: - FIRST - SECOND - THIRD - FOURTH XiqIotpMaBleBeaconEddystoneUrl: type: object required: - app_type - url properties: app_type: $ref: '#/components/schemas/XiqIotpMaBleBeaconAppType' url: type: string maxLength: 34 format: uri description: BLE Beacon Eddystone-url application URL. measured_rss: maximum: 15 minimum: -120 default: -30 type: integer format: int32 description: BLE Beacon Eddystone-url application measured Received Signal Strength Indication value. advertise_interval: maximum: 10240 minimum: 100 default: 500 type: integer format: int32 description: BLE Beacon Eddystone-url application advertising interval value in milliseconds. tx_power: maximum: 3 minimum: -16 default: 3 type: integer format: int32 description: BLE Beacon Eddystone-url transmit power, measured in dBm. XiqCreateClassificationRuleRequest: type: object required: - name - classifications properties: name: type: string description: The name of classification rule description: type: string description: The description of classification rule classifications: type: array description: The details of rule assignments items: $ref: '#/components/schemas/XiqCreateClassificationRequest' XiqHsQosAhClassToDscpRange: type: object description: 'ah_class 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 value. ' required: - ah_class - dscp_range_start - dscp_range_end properties: ah_class: type: integer minimum: 0 maximum: 7 description: Extreme QoS class value. dscp_range_start: type: integer minimum: 0 maximum: 63 description: Start value for DSCP range. dscp_range_end: type: integer minimum: 0 maximum: 63 description: End value for DSCP range. XiqIotpMaBleScanVendorType: type: string description: The BLE Scan Vendor types for BLE Scan applications. enum: - ANY - CHORUS - CUSTOM PagedXiqUserProfile: allOf: - $ref: '#/components/schemas/XiqPage' - type: object properties: data: type: array description: The data in the current page items: $ref: '#/components/schemas/XiqUserProfile' XiqDeviceRadioModesSettings: type: array description: Device Radio Operating Mode settings based on AP Model. items: type: object required: - key properties: key: $ref: '#/components/schemas/XiqDeviceRadioOperatingMode' wireless_interfaces: description: Wireless Interface type: array items: $ref: '#/components/schemas/XiqDeviceInterfaceRadioMode' XiqRpWmmQosSettings: allOf: - $ref: '#/components/schemas/XiqBaseEntity' - type: object description: The WMM QoS settings for the radio profile properties: access_category: type: string description: The media categories, including "VOICE", "VIDEO", "BEST_EFFORT", and "BACKGROUND" arbitration_interframe_space: type: integer description: The Arbitration Interframe space from 1 up to 15. format: int32 min_contention_window: type: integer description: The Minimum Contention window from 1 up to 15. format: int32 max_contention_window: type: integer description: The Maximum Contention window from 1 up to 15. format: int32 transmission_opportunity_limit: type: integer description: The Transmission Opportunity limit from 0 up to 8192. format: int32 enable_no_ack: type: boolean description: Whether to enable No Acknowledgment XiqUpdateUserProfileRequest: type: object properties: name: type: string description: The user profile name vlan_profile_id: type: integer description: The VLAN profile id format: int64 XiqUserGroup: allOf: - $ref: '#/components/schemas/XiqViqEntity' - type: object description: The password or PPSK notification template for user groups. required: - name - predefined - password_db_location - password_type - delivery_settings - password_settings - expiration_settings properties: name: type: string description: The user group name description: type: string description: The user group description predefined: type: boolean description: Whether it is predefined password_db_location: $ref: '#/components/schemas/XiqPasswordDbLocation' password_type: $ref: '#/components/schemas/XiqPasswordType' pcg_use_only: type: boolean description: Whether it's for PCG use only pcg_type: $ref: '#/components/schemas/XiqPcgType' ppsk_use_only: type: boolean description: Whether it's for PPSK use only enable_cwp_reg: type: boolean description: Whether to enable CWP registration setting password_settings: $ref: '#/components/schemas/XiqPasswordSettings' expiration_settings: $ref: '#/components/schemas/XiqExpirationSettings' delivery_settings: $ref: '#/components/schemas/XiqDeliverySettings' XiqHsCellularNetwork: type: object description: The 3GPP cellular network. required: - mcc - mnc properties: mcc: type: string pattern: ^\d{3}$ description: "Mobile Country Code (MCC). \nThe three-digit mobile country code as defined by the ITU (International Telecommunication Union), which indicates the country in which the user is operating.\nhttps://www.mcc-mnc.com/" mnc: type: string pattern: ^\d{2,3}$ description: "Mobile Network Code (MNC). \nhttps://www.mcc-mnc.com/" description: type: string description: Description of 3GPP cellular network. The MCC is paired with the MNC to uniquely identify a mobile subscriber's network. XiqTraffic: type: string enum: - INBOUND - OUTBOUND description: The Firewall traffic direction. XiqIotpMaBleBeaconIBeacon: type: object required: - app_type - major - minor - uuid properties: app_type: $ref: '#/components/schemas/XiqIotpMaBleBeaconAppType' major: maximum: 65535 minimum: 0 default: 0 type: integer format: int32 description: BLE Beacon iBeacon application major value. minor: maximum: 65535 minimum: 0 default: 0 type: integer format: int32 description: BLE Beacon iBeacon application minor value. uuid: type: string default: 00000000-0000-0000-0000-000000000000 format: uuid description: BLE Beacon iBeacon application UUID. measured_rss: maximum: 15 minimum: -120 default: -52 type: integer format: int32 description: BLE Beacon iBeacon application measured Received Signal Strength value, in dBm. advertise_interval: maximum: 10240 minimum: 100 default: 500 type: integer format: int32 description: BLE Beacon iBeacon application advertising interval value in milliseconds. tx_power: maximum: 3 minimum: -16 default: 3 type: integer format: int32 description: BLE Beacon Eddystone-url transmit power, measured in dBm. XiqIotpMaBleScanDestination: type: object description: The BLE Scan destination. properties: http_server: $ref: '#/components/schemas/XiqHttpServer' XiqViqEntity: allOf: - $ref: '#/components/schemas/XiqBaseEntity' - type: object properties: org_id: type: integer description: The organization identifier, valid when enabling HIQ feature format: int64 required: - org_id XiqHsQosDscpException: type: object description: 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. required: - dscp_value - ah_class properties: ah_class: type: integer minimum: 0 maximum: 7 description: Extreme QoS class value. dscp_value: type: integer minimum: 0 maximum: 63 description: Start value for DSCP range. PagedXiqRpMacOuiProfile: allOf: - $ref: '#/components/schemas/XiqPage' - type: object properties: data: type: array description: The data in the current page items: $ref: '#/components/schemas/XiqRpMacOuiProfile' XiqRadioProfile: allOf: - $ref: '#/components/schemas/XiqBaseEntity' - type: object description: The payload of Radio Profile properties: name: type: string description: The radio profile name predefined: type: boolean description: Whether the radio profile is predefined or user-customized. description: type: string description: The radio profile description. transmission_power: type: integer description: The transmission power floor from 1 up to 20 dBm or null for Auto. format: int32 max_transmit_power: type: integer description: The maximum transmit power from 10 up to 20 dBm. format: int32 transmission_power_floor: type: integer description: The transmission power floor from 2 up to 20 dBm. format: int32 transmission_power_max_drop: type: integer description: The transmission power max drop from 0 up to 18 dB. format: int32 max_clients: type: integer description: The maximum number of clients from 1 up to 255. format: int32 enable_client_transmission_power: type: boolean description: Whether or not client transmission power control (802.11h) is enabled. client_transmission_power: type: integer description: The client transmission power from 1 up to 20 dBm if it is enabled. format: int32 enable_ofdma: type: boolean description: Whether to enable Orthogonal Frequency Division Multiple Access (802.11ax) for multiple-user access by subdividing a channel. radio_mode: $ref: '#/components/schemas/XiqRadioMode' neighborhood_analysis_id: type: integer description: The neighborhood analysis Id. format: int64 channel_selection_id: type: integer description: The channel selection Id. format: int64 radio_usage_optimization_id: type: integer description: The radio usage optimization Id. format: int64 miscellaneous_settings_id: type: integer description: The miscellaneous settings Id format: int64 presence_server_settings_id: type: integer description: The presence server settings Id. format: int64 sensor_scan_settings_id: type: integer description: The sensor scan settings Id. format: int64 XiqSsidKeyType: type: string description: The key type, ASCII or HEX example: ASCII enum: - ASCII - HEX XiqExpirationSettings: type: object description: The password expiration settings properties: expiration_type: $ref: '#/components/schemas/XiqExpirationType' valid_during_dates: $ref: '#/components/schemas/XiqValidDuringDateSettings' valid_for_time_period: $ref: '#/components/schemas/XiqValidForTimePeriodSettings' valid_daily: $ref: '#/components/schemas/XiqValidDailySettings' expiration_action: $ref: '#/components/schemas/XiqExpirationActionType' post_expiration_action: $ref: '#/components/schemas/XiqPostExpirationAction' XiqUpdateClassificationRequest: type: object description: The details of rule Rules required: - classification_type - match - classification_type_id properties: classification_type: type: string description: Classification type enum: - CLASSIFICATION_TYPE_UNSPECIFIED - CLASSIFICATION_TYPE_LOCATION - CLASSIFICATION_TYPE_CLOUD_CONFIG_GROUP - CLASSIFICATION_TYPE_IP_ADDRESS - CLASSIFICATION_TYPE_IP_SUBNET - CLASSIFICATION_TYPE_IP_RANGE - UNRECOGNIZED match: type: boolean description: Contains or not contains) classification_type_id: type: integer description: The ID of location, cloud config group, IP address, IP subnet or IP range. format: int64 XiqVlanObjectClassifiedEntry: allOf: - $ref: '#/components/schemas/XiqBaseEntity' - type: object description: The payload of VLAN object classified entry required: - vlan_id properties: vlan_id: type: integer description: The VLAN ID format: int32 classification_rule: $ref: '#/components/schemas/XiqClassificationRule' XiqRadiusClientProfileEntry: allOf: - type: object description: The RADIUS client profile entry. properties: classification_assignment_id: type: integer format: int64 description: The classification assignment ID for RADIUS client profile entry. radius_client_object_id: type: integer format: int64 description: The RADIUS client object ID for RADIUS client profile entry. XiqCreateL3AddressProfileRequest: type: object required: - name - address_type properties: name: type: string description: The L3 Address profile name. value: type: string description: The L3 Address profile value. description: type: string description: The L3 Address profile description. address_type: $ref: '#/components/schemas/XiqL3AddressType' description: The L3 address type. enable_classification: type: boolean description: The flag to enable classification entries on host name address profile. classified_entries: type: array description: The host name address profile classified entries. items: $ref: '#/components/schemas/XiqAddressProfileClassifiedEntry' description: The host name address profile classified entry. ip_address_end: type: string description: The classified entry IP address end, only available for "IP_RANGE" address type. netmask: type: string description: The classified entry IP address end, only available for "IP_SUBNET" address type. wildcard_mask: type: string description: The wildcard address profile mask value, only available for "WILDCARD" address type. XiqAddressProfileClassifiedEntry: type: object description: Address profile classified entry properties: value: type: string description: The classified entry value. description: type: string description: The classified entry description. netmask: type: string description: The classified entry netmask. ip_address_end: type: string description: The classified entry IP address end. wildcard_mask: type: string description: The classified entry wildcard mask. classification_assignment_id: type: integer format: int64 description: The classification assignment ID for RADIUS client profile entry. XiqSsidAdvancedSettings: allOf: - $ref: '#/components/schemas/XiqBaseEntity' - type: object description: The advanced settings for the SSID properties: enable802_dot11mc: type: boolean description: Whether to enable 802.11mc on SSID XiqPasswordDbLocation: type: string description: The access key storage location enum: - CLOUD - LOCAL XiqSetSsidModeDot1xRequest: type: object description: The request for setting the SSID to be 802.1x mode and Authentication settings. Authentication with ExtremeCloud IQ Authentication Service and Authentication with ExtremeCloud Universal ZTNA are mutually exclusive. required: - key_management - encryption_method properties: key_management: $ref: '#/components/schemas/XiqSsidDot1xKeyManagement' encryption_method: $ref: '#/components/schemas/XiqSsidDot1xEncryptionMethod' enable_idm: type: boolean description: Flag for using ExtremeCloud IQ Authentication Service or not enable_uztna: type: boolean default: false description: Flag for using Authentication with ExtremeCloud Universal ZTNA or not transition_mode: type: boolean description: Flag for enabling transition mode if using WPA3 as the key management type radius_server_group_id: type: integer description: The RADIUS server group ID if not using ExtremeCloud IQ Authentication Service format: int64 user_group_ids: type: array description: The user group IDs if using ExtremeCloud IQ Authentication Service items: type: integer description: The user group IDs if using ExtremeCloud IQ Authentication Service format: int64 parameters: page: name: page in: query description: Page number, min = 1 required: false schema: minimum: 1 type: integer format: int32 default: 1 limit: name: limit in: query description: Page Size, min = 1, max = 100 required: false schema: maximum: 100 minimum: 1 type: integer format: int32 default: 10 async: in: query name: async description: Whether to enable async mode required: false schema: type: boolean default: false id: name: id in: path description: The unique identifier required: true schema: type: integer format: int64 order: name: order in: query description: The sort order (ascending by default) required: false schema: $ref: '#/components/schemas/XiqSortOrder' responses: ErrorResponse: description: The generic ExtremeCloud IQ API error response content: application/json: schema: $ref: '#/components/schemas/XiqError' securitySchemes: BearerAuth: type: http description: JSON Web Token (JWT) based authentication scheme: bearer bearerFormat: JWT externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html