{"openapi":"3.0.1","info":{"title":"ExtremeCloud IQ API","description":"ExtremeCloud IQ RESTful API for external and internal applications.","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":"24.2.0.52"},"externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html"},"servers":[{"url":"https://api.extremecloudiq.com","description":"ExtremeCloud IQ REST API Server"}],"tags":[{"name":"Authentication","description":"User login & logout"},{"name":"Authorization","description":"API token and permissions"},{"name":"Operation","description":"Long-Running Operations (LRO) management for asynchronous APIs"},{"name":"Account","description":"ExtremeCloud IQ Account"},{"name":"User","description":"Local and external user management in ExtremeCloud IQ account"},{"name":"HIQ","description":"Hierarchical ExtremeCloud IQ"},{"name":"Location","description":"Hierarchical locations and floor plan"},{"name":"Device","description":"Supported device platforms: Cloud Engine, IQ Engine, WiNG, VOSS, EXOS ..."},{"name":"Network Policy","description":"Unified configuration management for wireless and wired network devices"},{"name":"Client","description":"The clients associate to the devices of ExtremeCloud IQ"},{"name":"Application","description":"Application management and application metrics"},{"name":"Alert","description":"ExtremeCloud IQ generated alerts and events"},{"name":"Log","description":"Access all kinds of logs in ExtremeCloud IQ"},{"name":"Notification","description":"Push events/logs to users via Webhook, Email, SMS, etc."},{"name":"Configuration - Deployment","description":"Push configuration to devices"},{"name":"Configuration - Basic","description":"VLAN Profile/DHCP Server/..."},{"name":"Configuration - User Management","description":"User Group/End User/PCG/PPSK Classification"},{"name":"Configuration - Policy","description":"SSID/User Profile/Classification Rule/CCG/Radio Profile/..."},{"name":"Configuration - Network","description":"ExtremeCloud Tunnel Concentrator/..."},{"name":"Configuration - Authentication","description":"AD/LDAP/RADIUS/CWP/..."},{"name":"Configuration - Certificate","description":"Certificate"},{"name":"Copilot - Connectivity Experience","description":"ExtremeCloud IQ Copilot"},{"name":"Copilot - Anomalies","description":"ExtremeCloud IQ Copilot"},{"name":"Packet Capture","description":"The packet capture sessions in ExtremeCloud IQ"},{"name":"Essentials - ExtremeLocation","description":"The ExtremeLocation and Analytics API"},{"name":"Misc","description":"Metadata - Country/..."},{"name":"License","description":"ExtremeCloud IQ License"}],"paths":{"/usergroups/{id}":{"put":{"tags":["Configuration - User Management"],"summary":"Update user group","description":"Update existing user group information.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_update_user_group"},"operationId":"updateUserGroup","parameters":[{"name":"id","in":"path","description":"The user group ID.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"description":"Update user-group request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqUpdateUserGroupRequest"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqUserGroup"}}}}},"security":[{"BearerAuth":[]}]},"delete":{"tags":["Configuration - User Management"],"summary":"Delete user group by ID","description":"Delete the user-group for the specified ID.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_delete_user_group"},"operationId":"deleteUserGroup","parameters":[{"name":"id","in":"path","description":"The user group ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK"}},"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":[{"name":"id","in":"path","description":"The user profile ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqUserProfile"}}}}},"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":[{"name":"id","in":"path","description":"The user profile ID.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"description":"The payload of user profile.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqUpdateUserProfileRequest"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqUserProfile"}}}}},"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":[{"name":"id","in":"path","description":"The user profile ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK"}},"security":[{"BearerAuth":[]}]}},"/tunnel-concentrators/{id}":{"get":{"tags":["Configuration - Network"],"summary":"Get Tunnel Concentrator by ID","description":"Get Tunnel Concentrator details for the specified ID.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_tunnel_concentrator_by_id"},"operationId":"getTunnelConcentrator","parameters":[{"name":"id","in":"path","description":"The Tunnel Concentrator ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqTunnelConcentrator"}}}}},"security":[{"BearerAuth":[]}]},"put":{"tags":["Configuration - Network"],"summary":"Update TunnelConcentrator by ID","description":"Update the existing Tunnel Concentrator by ID.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_update_tunnel_concentrator_configuration"},"operationId":"updateTunnelConcentrator","parameters":[{"name":"id","in":"path","description":"The Tunnel Concentrator ID.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"description":"The payload of the update Tunnel Concentrator request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqTunnelConcentratorRequest"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqTunnelConcentrator"}}}}},"security":[{"BearerAuth":[]}]},"delete":{"tags":["Configuration - Network"],"summary":"Delete TunnelConcentrator by ID","description":"Delete the existing TunnelConcentrator by the profile ID.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_delete_tunnel_concentrator_configuration"},"operationId":"deleteTunnelConcentrator","parameters":[{"name":"id","in":"path","description":"The TunnelConcentrator ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK"}},"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":[{"name":"id","in":"path","description":"The SSID ID","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"description":"The new SSID PSK password","content":{"application/json":{"schema":{"type":"string"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK"}},"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":[{"name":"id","in":"path","description":"The SSID ID","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"description":"The payload to change the SSID mode to WEP","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqSetSsidModeWepRequest"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK"}},"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":[{"name":"id","in":"path","description":"The SSID ID","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"description":"The payload to change the SSID mode to PSK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqSetSsidModePskRequest"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK"}},"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":[{"name":"id","in":"path","description":"The SSID ID","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"description":"The payload to change the SSID mode to PPSK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqSetSsidModePpskRequest"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK"}},"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":[{"name":"id","in":"path","description":"The SSID ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK"}},"security":[{"BearerAuth":[]}]}},"/ssids/{id}/mode/dot1x":{"put":{"tags":["Configuration - Policy"],"summary":"Change the SSID mode to 802.1x","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":[{"name":"id","in":"path","description":"The SSID ID","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"description":"The payload to change the SSID mode to 802.1x","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqSetSsidModeDot1xRequest"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK"}},"security":[{"BearerAuth":[]}]}},"/ssids/advanced-settings/{id}":{"get":{"tags":["Configuration - Policy"],"summary":"Get SSID advanced settings","description":"Get the advanced settings belonging to the SSID.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_ssid_advanced_settings_by_id"},"operationId":"getSsidAdvancedSettings","parameters":[{"name":"id","in":"path","description":"The SSID's advanced settings ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqSsidAdvancedSettings"}}}}},"security":[{"BearerAuth":[]}]},"put":{"tags":["Configuration - Policy"],"summary":"Update SSID advanced settings","description":"Update the advanced settings belonging to the SSID.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_update_ssid_advanced_settings_by_id"},"operationId":"updateSsidAdvancedSettings","parameters":[{"name":"id","in":"path","description":"The SSID advanced settings ID.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"description":"The payload of the update advanced settings request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqUpdateSsidAdvancedSettingsRequest"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqSsidAdvancedSettings"}}}}},"security":[{"BearerAuth":[]}]}},"/radius-servers/internal/{id}":{"get":{"tags":["Configuration - Authentication"],"summary":"Get internal RADIUS server by ID","description":"Get detailed configuration for internal RADIUS server by ID.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_list_the_internal_radius_server_by_id"},"operationId":"getInternalRadiusServer","parameters":[{"name":"id","in":"path","description":"The ID for internal RADIUS server","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqInternalRadiusServer"}}}}},"security":[{"BearerAuth":[]}]},"put":{"tags":["Configuration - Authentication"],"summary":"Update internal RADIUS server configuration","description":"Update internal RADIUS server configuration by ID.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_update_internal_radius_server_configuration"},"operationId":"updateInternalRadiusServer","parameters":[{"name":"id","in":"path","description":"The internal RADIUS server ID","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"description":"The payload to update the internal RADIUS server","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqUpdateInternalRadiusServerRequest"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqInternalRadiusServer"}}}}},"security":[{"BearerAuth":[]}]},"delete":{"tags":["Configuration - Authentication"],"summary":"Delete internal RADIUS server configuration","description":"Delete an existing internal RADIUS server configuration by ID.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_delete_internal_radius_server_configuration"},"operationId":"deleteInternalRadiusServer","parameters":[{"name":"id","in":"path","description":"The internal RADIUS server ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK"}},"security":[{"BearerAuth":[]}]}},"/radius-servers/external/{id}":{"get":{"tags":["Configuration - Authentication"],"summary":"Get external RADIUS server by ID","description":"Get detailed configuration for a specific external RADIUS server.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_list_the_external_radius_server_by_id"},"operationId":"getExternalRadiusServer","parameters":[{"name":"id","in":"path","description":"The ID for external RADIUS server","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqExternalRadiusServer"}}}}},"security":[{"BearerAuth":[]}]},"put":{"tags":["Configuration - Authentication"],"summary":"Update external RADIUS server configuration","description":"Update external RADIUS server configuration by ID.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_update_external_radius_server_configuration"},"operationId":"updateExternalRadiusServer","parameters":[{"name":"id","in":"path","description":"The external RADIUS server ID.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"description":"The payload to update the external RADIUS server","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqUpdateExternalRadiusServerRequest"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK"}},"security":[{"BearerAuth":[]}]},"delete":{"tags":["Configuration - Authentication"],"summary":"Delete external RADIUS server configuration","description":"Delete an existing external RADIUS server configuration by ID.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_delete_external_radius_server_configuration"},"operationId":"deleteExternalRadiusServer","parameters":[{"name":"id","in":"path","description":"The external RADIUS server ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK"}},"security":[{"BearerAuth":[]}]}},"/radius-proxies/{id}":{"get":{"tags":["Configuration - Authentication"],"summary":"Get the RADIUS proxy configuration","description":"Get an existing RADIUS proxy configuration by ID.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_the_radius_proxy_configuration_by_id"},"operationId":"getRadiusProxy","parameters":[{"name":"id","in":"path","description":"The RADIUS proxy ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqRadiusProxy"}}}}},"security":[{"BearerAuth":[]}]},"put":{"tags":["Configuration - Authentication"],"summary":"Update RADIUS proxy configuration","description":"Update RADIUS proxy configuration by ID.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_update_radius_proxy_configuration"},"operationId":"updateRadiusProxy","parameters":[{"name":"id","in":"path","description":"The RADIUS proxy ID","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"description":"The body of update RADIUS proxy API","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqUpdateRadiusProxyRequest"},"examples":{"Update an existing RADIUS proxy":{"summary":"Update an existing RADIUS proxy","description":"The payload to update an existing RADIUS proxy","value":{"name":"radius-proxy-1","description":"Radius Proxy 1","format_type":"NAI","retry_count":3,"retry_delay":5,"dead_time":300,"enable_inject_operator_name_attribute":false,"clients":[{"id":1},{"shared_secret":"123456","description":"","l3_address_profile_id":1000}],"realms":[{"id":1},{"id":2},{"name":"test-realm","enable_strip_realm_name":false,"radius_client_object_id":3000}]}}}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqRadiusProxy"}}}}},"security":[{"BearerAuth":[]}]},"delete":{"tags":["Configuration - Authentication"],"summary":"Delete the RADIUS proxy configuration","description":"Delete an existing RADIUS proxy configuration by ID.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_delete_radius_proxy_configuration"},"operationId":"deleteRadiusProxy","parameters":[{"name":"id","in":"path","description":"The RADIUS proxy ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK"}},"security":[{"BearerAuth":[]}]}},"/radius-client-objects/{id}":{"get":{"tags":["Configuration - Authentication"],"summary":"Get RADIUS client object by ID","description":"Get detailed configuration for a specific RADIUS client object.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_list_the_radius_client_object_configuration_by_id"},"operationId":"getRadiusClientObject","parameters":[{"name":"id","in":"path","description":"The ID of RADIUS client object","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqRadiusClientObject"}}}}},"security":[{"BearerAuth":[]}]},"put":{"tags":["Configuration - Authentication"],"summary":"Update RADIUS client object configuration","description":"Update RADIUS client object configuration by ID.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_update_radius_client_object_configuration"},"operationId":"updateRadiusClientObject","parameters":[{"name":"id","in":"path","description":"The RADIUS client object ID.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"description":"The payload to update the RADIUS client object","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqUpdateRadiusClientObjectRequest"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK"}},"security":[{"BearerAuth":[]}]},"delete":{"tags":["Configuration - Authentication"],"summary":"Delete a RADIUS client object configuration","description":"Delete an existing RADIUS client object configuration by ID.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_delete_radius_client_object_configuration"},"operationId":"deleteRadiusClientObject","parameters":[{"name":"id","in":"path","description":"The RADIUS client object ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK"}},"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":[{"name":"id","in":"path","description":"The radio profile ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqRadioProfile"}}}}},"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":[{"name":"id","in":"path","description":"The radio profile ID.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"description":"The payload of the update radio profile request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqUpdateRadioProfileRequest"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqRadioProfile"}}}}},"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":[{"name":"id","in":"path","description":"The radio profile ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK"}},"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":[{"name":"id","in":"path","description":"The radio QoS settings ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqRpWmmQosSettings"}}}}},"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":[{"name":"id","in":"path","description":"The Wmm QoS settings ID.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"description":"The payload of the update Wmm QoS settings request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqUpdateRpWmmQosSettingsRequest"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqRpWmmQosSettings"}}}}},"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":[{"name":"id","in":"path","description":"The sensor scan settings ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqRpSensorScanSettings"}}}}},"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":[{"name":"id","in":"path","description":"The sensor scan settings ID.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"description":"The payload of the update sensor scan settings request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqUpdateRpSensorScanSettingsRequest"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqRpSensorScanSettings"}}}}},"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":[{"name":"id","in":"path","description":"The radio usage optimization settings ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqRpRadioUsageOptimization"}}}}},"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":[{"name":"id","in":"path","description":"The radio usage optimization settings ID.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"description":"The payload of the update radio usage optimization settings request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqUpdateRpRadioUsageOptimizationRequest"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqRpRadioUsageOptimization"}}}}},"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":[{"name":"id","in":"path","description":"The neighborhood analysis settings ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqRpNeighborhoodAnalysis"}}}}},"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":[{"name":"id","in":"path","description":"The neighborhood analysis settings ID.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"description":"The payload of the update neighborhood analysis settings request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqUpdateRpNeighborhoodAnalysisRequest"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqRpNeighborhoodAnalysis"}}}}},"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":[{"name":"id","in":"path","description":"The radio miscellaneous settings ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqRpMiscellaneousSettings"}}}}},"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":[{"name":"id","in":"path","description":"The radio miscellaneous settings ID.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"description":"The payload of the update radio miscellaneous settings request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqUpdateRpMiscellaneousSettingsRequest"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqRpMiscellaneousSettings"}}}}},"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":[{"name":"id","in":"path","description":"The MAC OUI profile ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqRpMacOuiProfile"}}}}},"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":[{"name":"id","in":"path","description":"The MAC OUI profile ID.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"description":"The payload of the update MAC OUI profile request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqUpdateRpMacOuiProfileRequest"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqRpMacOuiProfile"}}}}},"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":[{"name":"id","in":"path","description":"The MAC OUI profile ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK"}},"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":[{"name":"id","in":"path","description":"The channel selection settings ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqRpChannelSelection"}}}}},"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":[{"name":"id","in":"path","description":"The channel selection settings ID.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"description":"The payload of the update channel selection settings request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqUpdateRpChannelSelectionRequest"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqRpChannelSelection"}}}}},"security":[{"BearerAuth":[]}]}},"/pcgs/key-based/network-policy-{policyId}/users":{"get":{"tags":["Configuration - User Management"],"summary":"Get users for a PCG-enabled network policy","description":"Get users for a specific PCG-enabled network policy.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_key_based_pcg_users_from_given_network_policy_id"},"operationId":"getKeyBasedPcgUsers","parameters":[{"name":"policyId","in":"path","description":"The network policy ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/XiqKeyBasedPcgUser"}}}}}},"security":[{"BearerAuth":[]}]},"put":{"tags":["Configuration - User Management"],"summary":"Replace all users in a PCG-enabled network policy","description":"Replace all users in a specific PCG-enabled network policy.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_replace_all_key_based_pcg_users"},"operationId":"updateKeyBasedPcgUsers","parameters":[{"name":"policyId","in":"path","description":"The network policy ID","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"description":"The payload of update Key-based PCG users request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqUpdateKeyBasedPcgUsersRequest"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"202":{"description":"Accepted"}},"security":[{"BearerAuth":[]}]},"post":{"tags":["Configuration - User Management"],"summary":"Add users to a PCG-enabled network policy","description":"Add users to a PCG-enabled network policy.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_add_key_based_pcg_users_to_an_exists_key_based_pcg"},"operationId":"addKeyBasedPcgUsers","parameters":[{"name":"policyId","in":"path","description":"The network policy ID","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"description":"The payload of add users to PCG-enabled network policy","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqCreateKeyBasedPcgUsersRequest"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"202":{"description":"Accepted"}},"security":[{"BearerAuth":[]}]},"delete":{"tags":["Configuration - User Management"],"summary":"Delete users from a PCG-enabled network policy","description":"Delete users from a PCG-enabled network policy.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_delete_key_based_pcg_users"},"operationId":"deleteKeyBasedPcgUsers","parameters":[{"name":"policyId","in":"path","description":"The network policy ID","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"description":"The payload of delete Key-based PCG users request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqDeleteKeyBasedPcgUsersRequest"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"202":{"description":"Accepted"}},"security":[{"BearerAuth":[]}]}},"/network-policies/{id}":{"get":{"tags":["Network Policy"],"summary":"Get the network policy","description":"Get an existing network policy by ID.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_network_policy"},"operationId":"getNetworkPolicy","parameters":[{"name":"id","in":"path","description":"The network policy ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqNetworkPolicy"}}}}},"security":[{"BearerAuth":[]}]},"put":{"tags":["Network Policy"],"summary":"Update the network policy","description":"Update network policy by ID.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_update_network_policy"},"operationId":"updateNetworkPolicy","parameters":[{"name":"id","in":"path","description":"The network policy ID","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"description":"The body of update network policy API","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqUpdateNetworkPolicyRequest"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqNetworkPolicy"}}}}},"security":[{"BearerAuth":[]}]},"delete":{"tags":["Network Policy"],"summary":"Delete the network policy","description":"Delete an existing network policy by ID.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_delete_network_policy"},"operationId":"deleteNetworkPolicy","parameters":[{"name":"id","in":"path","description":"The network policy ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK"}},"security":[{"BearerAuth":[]}]}},"/locations/{id}":{"put":{"tags":["Location"],"summary":"Update a location","description":"Update a location information with the specified location ID.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_update_location"},"operationId":"updateLocation","parameters":[{"name":"id","in":"path","description":"The location ID","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"description":"Update location request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqUpdateLocationRequest"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqLocation"}}}}},"security":[{"BearerAuth":[]}]},"delete":{"tags":["Location"],"summary":"Delete a location by ID","description":"Delete a location for the specified ID.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_delete_location"},"operationId":"deleteLocation","parameters":[{"name":"id","in":"path","description":"The location ID","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"force_delete","in":"query","description":"Force deletion of this location and its descendants recursively","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK"}},"security":[{"BearerAuth":[]}]}},"/locations/site/{id}":{"get":{"tags":["Location"],"summary":"Get a site by ID","description":"Get a site for the specified ID.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_site"},"operationId":"getSite","parameters":[{"name":"id","in":"path","description":"The site ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqSite"}}}}},"security":[{"BearerAuth":[]}]},"put":{"tags":["Location"],"summary":"Update a site by ID","description":"Update a site for the specified ID.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_update_site"},"operationId":"updateSite","parameters":[{"name":"id","in":"path","description":"The site ID","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"description":"Update site request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqUpdateSiteRequest"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqSite"}}}}},"security":[{"BearerAuth":[]}]},"delete":{"tags":["Location"],"summary":"Delete a site by ID","description":"Delete a site for the specified ID.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_delete_site"},"operationId":"deleteSite","parameters":[{"name":"id","in":"path","description":"The site ID","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"force_delete","in":"query","description":"Force deletion of this site and its descendants recursively","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK"}},"security":[{"BearerAuth":[]}]}},"/locations/floor/{id}":{"get":{"tags":["Location"],"summary":"Get a floor by ID","description":"Get the floor for the specified ID.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_floor"},"operationId":"getFloor","parameters":[{"name":"id","in":"path","description":"The floor ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqFloor"}}}}},"security":[{"BearerAuth":[]}]},"put":{"tags":["Location"],"summary":"Update a floor","description":"Update a floor information with the floor ID.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_update_floor"},"operationId":"updateFloor","parameters":[{"name":"id","in":"path","description":"The floor ID.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"description":"Update floor request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqUpdateFloorRequest"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqFloor"}}}}},"security":[{"BearerAuth":[]}]},"delete":{"tags":["Location"],"summary":"Delete a floor by ID","description":"Delete a floor for the specified ID.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_delete_floor"},"operationId":"deleteFloor","parameters":[{"name":"id","in":"path","description":"The floor ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK"}},"security":[{"BearerAuth":[]}]}},"/locations/building/{id}":{"get":{"tags":["Location"],"summary":"Get a building by ID","description":"Get the building for the specified ID.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_building"},"operationId":"getBuilding","parameters":[{"name":"id","in":"path","description":"The building ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqBuilding"}}}}},"security":[{"BearerAuth":[]}]},"put":{"tags":["Location"],"summary":"Update a building","description":"Update a building information with the building ID.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_update_building"},"operationId":"updateBuilding","parameters":[{"name":"id","in":"path","description":"The building ID","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"description":"Update building request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqUpdateBuildingRequest"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqBuilding"}}}}},"security":[{"BearerAuth":[]}]},"delete":{"tags":["Location"],"summary":"Delete a building by ID","description":"Delete a building for the specified ID.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_delete_building"},"operationId":"deleteBuilding","parameters":[{"name":"id","in":"path","description":"The building ID","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"force_delete","in":"query","description":"Force deletion of this building and its descendants recursively","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK"}},"security":[{"BearerAuth":[]}]}},"/licenses/nac-entitlement-allocation":{"get":{"tags":["License"],"summary":"Get NAC entitlement allocation","description":"Get NAC entitlement allocation.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_nac_entitlement_allocation"},"operationId":"getNacEntitlementAllocation","responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqNacEntitlementAllocation"}}}}},"security":[{"BearerAuth":[]}]},"put":{"tags":["License"],"summary":"Set NAC entitlement allocation","description":"Get NAC entitlement allocation.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_set_nac_entitlement_allocation"},"operationId":"setNacEntitlementAllocation","requestBody":{"description":"The payload to set NAC entitlement allocation","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/XiqSetNacEntitlementAllocationRequest"}}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK"}},"security":[{"BearerAuth":[]}]}},"/ldap-servers/{id}":{"get":{"tags":["Configuration - Authentication"],"summary":"Get LDAP server by ID","description":"Get a specific LDAP server by ID.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_ldap_server"},"operationId":"getLdapServer","parameters":[{"name":"id","in":"path","description":"The LDAP server ","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqLdapServer"}}}}},"security":[{"BearerAuth":[]}]},"put":{"tags":["Configuration - Authentication"],"summary":"Update LDAP server configuration","description":"Update configuration for a specific LDAP server.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_update_ldap_server"},"operationId":"updateLdapServer","parameters":[{"name":"id","in":"path","description":"The LDAP server ID.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"description":"The body of update LDAP server API","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqUpdateLdapServerRequest"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqLdapServer"}}}}},"security":[{"BearerAuth":[]}]},"delete":{"tags":["Configuration - Authentication"],"summary":"Delete a LDAP server","description":"Delete a specific LDAP server by ID.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_delete_ldap_server"},"operationId":"deleteLdapServer","parameters":[{"name":"id","in":"path","description":"The LDAP server ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK"}},"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":[{"name":"id","in":"path","description":"The IoT profile ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqIotProfile"}}}}},"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":[{"name":"id","in":"path","description":"The IoT profile ID.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"description":"The payload of the update IoT profile request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqIotProfileRequest"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqIotProfile"}}}}},"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":[{"name":"id","in":"path","description":"The IoT profile ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK"}},"security":[{"BearerAuth":[]}]}},"/hiq/context":{"get":{"tags":["HIQ"],"summary":"Get HIQ context","description":"Get the current effective HIQ context for reading or creating data in organizations.\nAppliable when HIQ is enabled.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_hiq_context"},"operationId":"getHiqContext","responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqHiqContext"}}}}},"security":[{"BearerAuth":[]}]},"put":{"tags":["HIQ"],"summary":"Set HIQ context","description":"Set the current effective HIQ context for reading or creating data in organizations.\nOnly HIQ Admin can performance this operation when HIQ is enabled.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_set_hiq_context"},"operationId":"setHiqContext","requestBody":{"description":"The new HIQ context","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqHiqContext"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK"}},"security":[{"BearerAuth":[]}]}},"/hiq/context/reading":{"get":{"tags":["HIQ"],"summary":"Get organizations for reading data","description":"Get organizations for reading data (Empty list means reading data from all organizations in the HIQ).\nAppliable when HIQ is enabled.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_reading_context"},"operationId":"getReadingOrgIds","responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"integer","format":"int64"}}}}}},"security":[{"BearerAuth":[]}]},"put":{"tags":["HIQ"],"summary":"Set organizations for reading data","description":"Set organization for reading data (Empty list means reading data from all organizations in the HIQ).\nOnly HIQ Admin can performance this operation.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_set_reading_context"},"operationId":"setReadingOrgIds","requestBody":{"description":"The organization IDs used for reading data","content":{"application/json":{"schema":{"type":"array","items":{"type":"integer","format":"int64"}}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK"}},"security":[{"BearerAuth":[]}]}},"/hiq/context/creating":{"get":{"tags":["HIQ"],"summary":"Get organization for creating new data","description":"Get organization for creating new data (Only one organization is active for creating new data).\nAppliable when HIQ is enabled.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_creating_context"},"operationId":"getCreatingOrgId","responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"type":"integer","format":"int64"}}}}},"security":[{"BearerAuth":[]}]},"put":{"tags":["HIQ"],"summary":"Set organization for creating new data","description":"Set organization for creating new data (Only one organization is active for creating new data).\nOnly HIQ Admin can performance this operation when HIQ is enabled.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_set_creating_context"},"operationId":"setCreatingOrgId","requestBody":{"description":"The organization ID used for creating new data","content":{"application/json":{"schema":{"type":"integer","format":"int64"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK"}},"security":[{"BearerAuth":[]}]}},"/endusers/{id}":{"put":{"tags":["Configuration - User Management"],"summary":"Update an end user","description":"Update a specific end user.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_update_end_user"},"operationId":"updateEndUser","parameters":[{"name":"id","in":"path","description":"The end user ID","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"description":"Update end user request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqUpdateEndUserRequest"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqEndUser"}}}}},"security":[{"BearerAuth":[]}]},"delete":{"tags":["Configuration - User Management"],"summary":"Delete end user by ID","description":"Delete a specific end user.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_delete_end_user"},"operationId":"deleteSsidUser","parameters":[{"name":"id","in":"path","description":"The end user ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK"}},"security":[{"BearerAuth":[]}]}},"/devices/{id}/network-policy":{"get":{"tags":["Device"],"summary":"Get network policy for a device","description":"Get the network policy for a specific device.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_network_policy_for_one_device"},"operationId":"getDeviceNetworkPolicy","parameters":[{"name":"id","in":"path","description":"The device ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqNetworkPolicy"}}}}},"security":[{"BearerAuth":[]}]},"put":{"tags":["Device"],"summary":"Assign network policy to a device","description":"Assign a network policy to a specific device.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_assign_network_policy_to_one_device"},"operationId":"assignDeviceNetworkPolicy","parameters":[{"name":"id","in":"path","description":"The device ID","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"networkPolicyId","in":"query","description":"The network policy ID to assign","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK"}},"security":[{"BearerAuth":[]}]},"delete":{"tags":["Device"],"summary":"Revoke network policy for a device","description":"Revoke the assigned network policy for a specific device.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_revoke_network_policy_for_one_device"},"operationId":"revokeDeviceNetworkPolicy","parameters":[{"name":"id","in":"path","description":"The device ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK"}},"security":[{"BearerAuth":[]}]}},"/devices/{id}/location":{"get":{"tags":["Device"],"summary":"Get location for a device","description":"Get the location info for a specific device.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_location_for_one_device"},"operationId":"getDeviceLocation","parameters":[{"name":"id","in":"path","description":"The device ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqDeviceLocation"}}}}},"security":[{"BearerAuth":[]}]},"put":{"tags":["Device"],"summary":"Assign location to a device","description":"Assign a location to a specific device with extra map and geographical properties.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_assign_location_to_one_device"},"operationId":"assignDeviceLocation","parameters":[{"name":"id","in":"path","description":"The device ID","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqDeviceLocationAssignment"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK"}},"security":[{"BearerAuth":[]}]},"delete":{"tags":["Device"],"summary":"Revoke location for a device","description":"Revoke the assigned location for a specific device.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_revoke_location_for_one_device"},"operationId":"revokeDeviceLocation","parameters":[{"name":"id","in":"path","description":"The device ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK"}},"security":[{"BearerAuth":[]}]}},"/devices/{id}/hostname":{"put":{"tags":["Device"],"summary":"Change hostname for a device","description":"Change hostname for a specific device.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_change_hostname_for_one_device"},"operationId":"changeHostname","parameters":[{"name":"id","in":"path","description":"The device ID","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"hostname","in":"query","description":"The new hostname","required":true,"schema":{"type":"string"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK"}},"security":[{"BearerAuth":[]}]}},"/devices/{id}/ftm-settings":{"get":{"tags":["Device"],"summary":"Get FTM Settings by device ID","description":"Get FTM Settings for the specified device ID.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_ftm_settings_by_device_id"},"operationId":"getFtmSettings","parameters":[{"name":"id","in":"path","description":"The device ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqFtmSettings"}}}}},"security":[{"BearerAuth":[]}]},"put":{"tags":["Device"],"summary":"Configure (create / update) device FTM Settings","description":"Configure (create / update) device FTM Settings.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_configure_ftm_settings"},"operationId":"configureFtmSettings","parameters":[{"name":"id","in":"path","description":"The device ID","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"description":"The payload of the configure device FTM Settings request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqFtmSettingsRequest"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqFtmSettings"}}}}},"security":[{"BearerAuth":[]}]},"delete":{"tags":["Device"],"summary":"Delete FTM Settings by device ID","description":"Delete FTM Settings by device ID.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_delete_ftm_settings"},"operationId":"deleteFtmSettings","parameters":[{"name":"id","in":"path","description":"The device ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK"}},"security":[{"BearerAuth":[]}]}},"/devices/{id}/description":{"put":{"tags":["Device"],"summary":"Change description for a device","description":"Change description for a specific device.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_change_description_for_one_device"},"operationId":"changeDeviceDescription","parameters":[{"name":"id","in":"path","description":"The device ID","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"description":"The device description","content":{"text/plain":{"schema":{"maxLength":64,"minLength":1,"type":"string"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK"}},"security":[{"BearerAuth":[]}]}},"/devices/radius-proxy/:assign":{"put":{"tags":["Device"],"summary":"Assign RADIUS proxy to devices","description":"Assign a RADIUS proxy to multiple devices.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_assign_radius_proxy_to_multiple_devices"},"operationId":"assignDevicesRadiusProxy","parameters":[{"name":"ids","in":"query","description":"The device IDs","required":true,"schema":{"type":"array","items":{"type":"integer","format":"int64"}}},{"name":"radiusProxyId","in":"query","description":"The RADIUS proxy ID to assign","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK"}},"security":[{"BearerAuth":[]}]}},"/devices/ibeacon":{"put":{"tags":["Device"],"summary":"Change iBeacon settings for devices","description":"Update the existing or create new iBeacon settings for multiple devices.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_change_devices_ibeacon"},"operationId":"changeDevicesIbeacon","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqChangeDevicesIbeaconRequest"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK"}},"security":[{"BearerAuth":[]}]}},"/copilot/anomalies/update-device-action":{"put":{"tags":["Copilot - Anomalies"],"summary":"[LRO] Update Anomalies and Devices","description":"Update Anomalies and Devices.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#update_copilot_anomalies_devices_action"},"operationId":"updateCopilotAnomaliesDevicesAction","parameters":[{"name":"async","in":"query","description":"Whether to enable async mode","required":false,"schema":{"type":"boolean","default":false}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqUpdateAnomaliesAndDevicesRequest"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK"}},"security":[{"BearerAuth":[]}]}},"/copilot/anomalies/update-action":{"put":{"tags":["Copilot - Anomalies"],"operationId":"updateAnomalyAction","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqAnomaliesUpdateActionRequest"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqCopilotAnomaliesActionResponse"}}}}},"security":[{"BearerAuth":[]}]}},"/copilot/anomalies/devices/update-action":{"put":{"tags":["Copilot - Anomalies"],"operationId":"updateAnomalyDeviceAction","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqAnomaliesDeviceUpdateActionRequest"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqCopilotAnomaliesActionResponse"}}}}},"security":[{"BearerAuth":[]}]}},"/copilot/anomalies/devices/feedback":{"put":{"tags":["Copilot - Anomalies"],"operationId":"updateAnomaliesFeedback","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqAnomaliesFeedbackRequest"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqCopilotAnomaliesActionResponse"}}}}},"security":[{"BearerAuth":[]}]}},"/clients/alias":{"put":{"tags":["Client"],"summary":"Set the aliases for multiple clients","description":"Bulk update the aliases for multiple clients based on the mac addresses. Empty or null alias value deletes the previous client alias.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_set_clients_aliases"},"operationId":"setClientsAliases","requestBody":{"description":"A list of client mac addresses and aliases","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/XiqClientMacAddressAlias"}}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK"}},"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":[{"name":"id","in":"path","description":"The classification Rule ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqClassificationRule"}}}}},"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":[{"name":"id","in":"path","description":"The classification rule ID","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"description":"The payload to update exist classification rule","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqUpdateClassificationRuleRequest"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqClassificationRule"}}}}},"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":[{"name":"id","in":"path","description":"The classification rule ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK"}},"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":[{"name":"id","in":"path","description":"The cloud config group ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqCloudConfigGroup"}}}}},"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":[{"name":"id","in":"path","description":"The cloud config group ID","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"description":"Update cloud config group request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqUpdateCloudConfigGroupRequest"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqCloudConfigGroup"}}}}},"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":[{"name":"id","in":"path","description":"The cloud config group ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK"}},"security":[{"BearerAuth":[]}]}},"/alert-subscriptions/webhooks/{id}":{"get":{"tags":["Alert"],"summary":"Get alert webhook subscription","description":"Get an exist alert webhook subscription.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_an_alert_webhook_subscription"},"operationId":"getAlertWebhookSubscription","parameters":[{"name":"id","in":"path","description":"The alert webhook subscription ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqAlertWebhookSubscription"}}}}},"security":[{"BearerAuth":[]}]},"put":{"tags":["Alert"],"summary":"Update alert webhook subscription","description":"Update alert webhook subscription.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_update_an_alert_webhook_subscription"},"operationId":"updateAlertWebhookSubscription","parameters":[{"name":"id","in":"path","description":"The alert webhook subscription ID","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"description":"The payload of update alert webhook subscription","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqUpdateAlertWebhookSubscriptionRequest"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqAlertWebhookSubscription"}}}}},"security":[{"BearerAuth":[]}]},"delete":{"tags":["Alert"],"summary":"Delete alert webhook subscription","description":"Delete an exist alert webhook subscription.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_delete_an_alert_webhook_subscription"},"operationId":"deleteAlertWebhookSubscription","parameters":[{"name":"id","in":"path","description":"The alert webhook subscription ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK"}},"security":[{"BearerAuth":[]}]}},"/alert-subscriptions/emails/{id}":{"get":{"tags":["Alert"],"summary":"Get alert email subscription","description":"Get an exist alert email subscription.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_an_alert_email_subscription"},"operationId":"getAlertEmailSubscription","parameters":[{"name":"id","in":"path","description":"The alert email subscription ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqAlertEmailSubscription"}}}}},"security":[{"BearerAuth":[]}]},"put":{"tags":["Alert"],"summary":"Update alert email subscription","description":"Update alert email subscription.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_update_an_alert_email_subscription"},"operationId":"updateAlertEmailSubscription","parameters":[{"name":"id","in":"path","description":"The alert email subscription ID","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"description":"The payload of update alert email subscription","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqUpdateAlertEmailSubscriptionRequest"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqAlertEmailSubscription"}}}}},"security":[{"BearerAuth":[]}]},"delete":{"tags":["Alert"],"summary":"Delete alert email subscription","description":"Delete an exist alert email subscription.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_delete_an_alert_email_subscription"},"operationId":"deleteAlertEmailSubscription","parameters":[{"name":"id","in":"path","description":"The alert email subscription ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK"}},"security":[{"BearerAuth":[]}]}},"/alert-policies/{policyId}/rules/{ruleId}":{"get":{"tags":["Alert"],"summary":"Get details of an alert rule","description":"Get the full details of an alert rule's state. Users can obtain a rule ID by calling #_get_alert_policy first.The returned rule ID might be different from a predefined rule ID provided as a path parameter when the user overrides the predefined rule ","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_alert_rule"},"operationId":"getAlertRule","parameters":[{"name":"policyId","in":"path","description":"The policy ID","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"ruleId","in":"path","description":"The rule ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqAlertRule"}}}}},"security":[{"BearerAuth":[]}]},"put":{"tags":["Alert"],"summary":"Update an alert rule","description":"Update the state of an alert rule. Users can obtain a rule ID by calling #_get_alert_policy first.If all changes adhere to a predetermined rule, a new rule will be duplicated from the predefined one, and all changes will be applied to the newly cloned rule. As a result, users might receive a new rule ID that differs from the one provided as a path parameter.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_update_an_alert_rule"},"operationId":"updateAlertRule","parameters":[{"name":"policyId","in":"path","description":"The policy ID","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"ruleId","in":"path","description":"The rule ID","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqUpdateAlertRuleRequest"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqAlertRule"}}}}},"security":[{"BearerAuth":[]}]}},"/alert-policies/{id}":{"get":{"tags":["Alert"],"summary":"Get details of an alert policy","description":"Get the details related to a specific alert policy, given the policy's identifier.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_an_alert_policy"},"operationId":"getAlertPolicy","parameters":[{"name":"id","in":"path","description":"The policy ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqAlertPolicy"}}}}},"security":[{"BearerAuth":[]}]},"put":{"tags":["Alert"],"summary":"Update a site-based alert policy","description":"Delete an alert policy. All the associated alert rules will be deleted as well.\n The global policy cannot be deleted.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_update_an_alert_policy"},"operationId":"updateAlertPolicy","parameters":[{"name":"id","in":"path","description":"The policy ID","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqAlertPolicyFilter"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqAlertPolicy"}}}}},"security":[{"BearerAuth":[]}]},"delete":{"tags":["Alert"],"summary":"Delete a site-based alert policy","description":"Modify a site-based alert policy's details, including the policy name and sites.\n The global policy cannot be updated.\n The sites can be obtained from the alerts/sites API.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_delete_an_alert_policy"},"operationId":"deleteAlertPolicy","parameters":[{"name":"id","in":"path","description":"The policy ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK"}},"security":[{"BearerAuth":[]}]}},"/account/viq/default-device-password":{"get":{"tags":["Account"],"summary":"Get the default device password in the account","description":"Get the default device password in the account.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_default_device_password"},"operationId":"getDefaultDevicePassword","responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqDefaultDevicePassword"}}}}},"security":[{"BearerAuth":[]}]},"put":{"tags":["Account"],"summary":"Update the default device password in the account","description":"Update the default device password in the global setting for accessing the console/shell of the devices.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_update_default_device_password"},"operationId":"updateDefaultDevicePassword","requestBody":{"description":"The new default device password","content":{"application/json":{"schema":{"type":"string"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK"}},"security":[{"BearerAuth":[]}]}},"/vlan-profiles":{"get":{"tags":["Configuration - Basic"],"summary":"List VLAN profiles","description":"Get a page of VLAN profiles.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_list_the_vlan_profiles"},"operationId":"listVlanProfiles","parameters":[{"name":"page","in":"query","description":"Page number, min = 1","required":false,"schema":{"minimum":1,"type":"integer","format":"int32","default":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 100","required":false,"schema":{"maximum":100,"minimum":1,"type":"integer","format":"int32","default":10}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqVlanProfile"}}}}},"security":[{"BearerAuth":[]}]},"post":{"tags":["Configuration - Basic"],"summary":"Create VLAN profile","description":"Create a new VLAN profile.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_create_vlan_profile_configuration"},"operationId":"createVlanProfile","requestBody":{"description":"The payload to create new VLAN profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqCreateVlanProfileRequest"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqVlanProfile"}}}}},"security":[{"BearerAuth":[]}]}},"/vlan-profiles/:delete":{"post":{"tags":["Configuration - Basic"],"summary":"[LRO] Delete VLAN profiles","description":"Delete VLAN profiles.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_delete_vlan_profiles"},"operationId":"deleteVlanProfiles","parameters":[{"name":"async","in":"query","description":"Whether to enable async mode","required":false,"schema":{"type":"boolean","default":false}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqVlanProfileFilter"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK"}},"security":[{"BearerAuth":[]}]}},"/users":{"get":{"tags":["User"],"summary":"List all users","description":"List users with pagination.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_user_list"},"operationId":"listUsers","parameters":[{"name":"page","in":"query","description":"Page number, min = 1","required":false,"schema":{"minimum":1,"type":"integer","format":"int32","default":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 100","required":false,"schema":{"maximum":100,"minimum":1,"type":"integer","format":"int32","default":10}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqUser"}}}}},"security":[{"BearerAuth":[]}]},"post":{"tags":["User"],"summary":"Create new user","description":"Create a new user to access.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_create_new_user"},"operationId":"createUser","requestBody":{"description":"Create new user request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqCreateUserRequest"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqUser"}}}}},"security":[{"BearerAuth":[]}]}},"/users/external":{"get":{"tags":["User"],"summary":"List external access users","description":"List a page of external access users.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_external_user_list"},"operationId":"listExternalUsers","parameters":[{"name":"page","in":"query","description":"Page number, min = 1","required":false,"schema":{"minimum":1,"type":"integer","format":"int32","default":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 100","required":false,"schema":{"maximum":100,"minimum":1,"type":"integer","format":"int32","default":10}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqExternalUser"}}}}},"security":[{"BearerAuth":[]}]},"post":{"tags":["User"],"summary":"Grant external access","description":"Grant external access to a specific user.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_grant_external_user"},"operationId":"grantExternalUser","requestBody":{"description":"Grant external user request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqGrantExternalUserRequest"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqExternalUser"}}}}},"security":[{"BearerAuth":[]}]}},"/usergroups":{"get":{"tags":["Configuration - User Management"],"summary":"List user groups","description":"List a page of user groups.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_list_user_groups"},"operationId":"listUserGroups","parameters":[{"name":"page","in":"query","description":"Page number, min = 1","required":false,"schema":{"minimum":1,"type":"integer","format":"int32","default":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 100","required":false,"schema":{"maximum":100,"minimum":1,"type":"integer","format":"int32","default":10}},{"name":"password_db_location","in":"query","description":"The password DB location","required":false,"schema":{"$ref":"#/components/schemas/XiqPasswordDbLocation"}},{"name":"password_type","in":"query","description":"The password type","required":false,"schema":{"$ref":"#/components/schemas/XiqPasswordType"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqUserGroup"}}}}},"security":[{"BearerAuth":[]}]},"post":{"tags":["Configuration - User Management"],"summary":"Create user group","description":"Create a new user group.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_create_user_group"},"operationId":"createUserGroup","requestBody":{"description":"Create user group request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqCreateUserGroupRequest"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqUserGroup"}}}}},"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":[{"name":"page","in":"query","description":"Page number, min = 1","required":false,"schema":{"minimum":1,"type":"integer","format":"int32","default":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 100","required":false,"schema":{"maximum":100,"minimum":1,"type":"integer","format":"int32","default":10}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqUserProfile"}}}}},"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":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqUserProfile"}}}}},"security":[{"BearerAuth":[]}]}},"/tunnel-concentrators":{"get":{"tags":["Configuration - Network"],"summary":"List Tunnel Concentrators","description":"List a page of Tunnel Concentrators.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_list_the_tunnel_concentrators"},"operationId":"listTunnelConcentrators","parameters":[{"name":"page","in":"query","description":"Page number, min = 1","required":false,"schema":{"minimum":1,"type":"integer","format":"int32","default":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 100","required":false,"schema":{"maximum":500,"minimum":1,"type":"integer","format":"int32","default":10}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqTunnelConcentrator"}}}}},"security":[{"BearerAuth":[]}]},"post":{"tags":["Configuration - Network"],"summary":"Create a Tunnel Concentrator","description":"Create a new Tunnel Concentrator.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_create_tunnel_concentrator_configuration"},"operationId":"createTunnelConcentrator","requestBody":{"description":"The request body to create new Tunnel Concentrator.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqTunnelConcentratorRequest"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqTunnelConcentrator"}}}}},"security":[{"BearerAuth":[]}]}},"/subscriptions/webhook":{"get":{"tags":["Notification"],"summary":"List webhook subscriptions","description":"List all webhook subscriptions.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_list_webhook_subscriptions"},"operationId":"list","responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/XiqWebhookSubscription"}}}}}},"security":[{"BearerAuth":[]}]},"post":{"tags":["Notification"],"summary":"Create webhook subscriptions","description":"Create multiple webhook subscriptions.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_create_webhook_subscriptions"},"operationId":"createSubscriptions","requestBody":{"description":"The payload of create multiple webhook subscriptions","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/XiqCreateWebhookSubscriptionRequest"}}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"202":{"description":"Accepted"}},"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":[{"name":"id","in":"path","description":"The SSID ID","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"description":"The user profile ID to be attached to the SSID","content":{"application/json":{"schema":{"type":"integer","format":"int64"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK"}},"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":[{"name":"id","in":"path","description":"The SSID ID","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"description":"The radius server group ID to be attached to the SSID","content":{"application/json":{"schema":{"type":"integer","format":"int64"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK"}},"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":[{"name":"id","in":"path","description":"The SSID ID","required":true,"schema":{"type":"integer","format":"int64"}}],"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":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK"}},"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":[{"name":"id","in":"path","description":"The SSID ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK"}},"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":[{"name":"id","in":"path","description":"The SSID ID","required":true,"schema":{"type":"integer","format":"int64"}}],"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":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK"}},"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":[{"name":"id","in":"path","description":"The SSID ID","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"description":"The new SSID name","content":{"application/json":{"schema":{"type":"string"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK"}},"security":[{"BearerAuth":[]}]}},"/radius-servers/internal":{"get":{"tags":["Configuration - Authentication"],"summary":"List all internal RADIUS servers","description":"List all internal RADIUS servers configurations.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_list_the_internal_radius_servers"},"operationId":"listInternalRadiusServers","parameters":[{"name":"page","in":"query","description":"Page number, min = 1","required":false,"schema":{"minimum":1,"type":"integer","format":"int32","default":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 100","required":false,"schema":{"maximum":100,"minimum":1,"type":"integer","format":"int32","default":10}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqInternalRadiusServer"}}}}},"security":[{"BearerAuth":[]}]},"post":{"tags":["Configuration - Authentication"],"summary":"Create internal RADIUS server configuration","description":"Create a new internal RADIUS server configuration.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_create_internal_radius_server_configuration"},"operationId":"createInternalRadiusServer","requestBody":{"description":"Use the payload configuration to create a new internal RADIUS server","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqCreateInternalRadiusServerRequest"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqInternalRadiusServer"}}}}},"security":[{"BearerAuth":[]}]},"delete":{"tags":["Configuration - Authentication"],"summary":"[LRO] Delete internal RADIUS server configuration","description":"Delete an existing internal RADIUS server configuration by ID.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_delete_internal_radius_server_configuration"},"operationId":"deleteBulkInternalRadiusServer","parameters":[{"name":"ids","in":"query","description":"The internal RADIUS server IDs to be delete, min = 1 ID, max = 100 IDs","required":true,"schema":{"type":"array","items":{"type":"integer","format":"int64"}}},{"name":"async","in":"query","description":"Whether to enable async mode","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK"}},"security":[{"BearerAuth":[]}]}},"/radius-servers/external":{"get":{"tags":["Configuration - Authentication"],"summary":"List external RADIUS servers","description":"List a page of external RADIUS server configurations.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_list_the_external_radius_servers"},"operationId":"listExternalRadiusServers","parameters":[{"name":"page","in":"query","description":"Page number, min = 1","required":false,"schema":{"minimum":1,"type":"integer","format":"int32","default":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 100","required":false,"schema":{"maximum":100,"minimum":1,"type":"integer","format":"int32","default":10}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqExternalRadiusServer"}}}}},"security":[{"BearerAuth":[]}]},"post":{"tags":["Configuration - Authentication"],"summary":"Create external RADIUS server configuration","description":"Create a new external RADIUS server configuration.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_create_external_radius_server_configuration"},"operationId":"createExternalRadiusServer","requestBody":{"description":"Use the payload configuration to create a new external RADIUS server","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqCreateExternalRadiusServerRequest"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqExternalRadiusServer"}}}}},"security":[{"BearerAuth":[]}]}},"/radius-proxies":{"get":{"tags":["Configuration - Authentication"],"summary":"List RADIUS proxies","description":"List a page of RADIUS proxy configurations.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_list_the_radius_proxy_configuration"},"operationId":"listRadiusProxies","parameters":[{"name":"page","in":"query","description":"Page number, min = 1","required":false,"schema":{"minimum":1,"type":"integer","format":"int32","default":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 100","required":false,"schema":{"maximum":100,"minimum":1,"type":"integer","format":"int32","default":10}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqRadiusProxy"}}}}},"security":[{"BearerAuth":[]}]},"post":{"tags":["Configuration - Authentication"],"summary":"Create RADIUS proxy configuration","description":"Create a new RADIUS proxy configuration.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_create_radius_proxy_configuration"},"operationId":"createRadiusProxy","requestBody":{"description":"The body of create RADIUS proxy API","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqCreateRadiusProxyRequest"},"examples":{"Create a new RADIUS proxy":{"summary":"Create a new RADIUS proxy","description":"The payload to create a new RADIUS proxy","value":{"name":"radius-proxy-1","description":"Radius Proxy 1","format_type":"NAI","retry_count":3,"retry_delay":5,"dead_time":300,"enable_inject_operator_name_attribute":false,"device_ids":[1],"clients":[{"shared_secret":"123456","description":"","l3_address_profile_id":1000}],"realms":[{"name":"NULL","enable_strip_realm_name":false,"radius_client_object_id":2000},{"name":"DEFAULT","enable_strip_realm_name":false,"radius_client_object_id":3000}]}}}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqRadiusProxy"}}}}},"security":[{"BearerAuth":[]}]}},"/radius-client-objects":{"get":{"tags":["Configuration - Authentication"],"summary":"List RADIUS client objects","description":"List a page of RADIUS client object configurations.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_list_the_radius_client_objects_configuration"},"operationId":"listRadiusClientObjects","parameters":[{"name":"page","in":"query","description":"Page number, min = 1","required":false,"schema":{"minimum":1,"type":"integer","format":"int32","default":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 100","required":false,"schema":{"maximum":100,"minimum":1,"type":"integer","format":"int32","default":10}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqRadiusClientObject"}}}}},"security":[{"BearerAuth":[]}]},"post":{"tags":["Configuration - Authentication"],"summary":"Create RADIUS client object configuration","description":"Create a new RADIUS client object configuration.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_create_radius_client_object_configuration"},"operationId":"createRadiusClientObject","requestBody":{"description":"Use the payload configuration to create a new RADIUS client object","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqCreateRadiusClientObjectRequest"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqRadiusClientObject"}}}}},"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":[{"name":"page","in":"query","description":"Page number, min = 1","required":false,"schema":{"minimum":1,"type":"integer","format":"int32","default":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 100","required":false,"schema":{"maximum":100,"minimum":1,"type":"integer","format":"int32","default":10}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqRadioProfile"}}}}},"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":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqRadioProfile"}}}}},"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":[{"name":"page","in":"query","description":"Page number, min = 1","required":false,"schema":{"minimum":1,"type":"integer","format":"int32","default":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 100","required":false,"schema":{"maximum":100,"minimum":1,"type":"integer","format":"int32","default":10}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqRpMacOuiProfile"}}}}},"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":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqRpMacOuiProfile"}}}}},"security":[{"BearerAuth":[]}]}},"/pcgs/key-based":{"get":{"tags":["Configuration - User Management"],"summary":"List Key-based Private Client Groups","description":"List all Key-based Private Client Groups.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_list_all_key_based_pcg_entries"},"operationId":"listKeyBasedPrivateClientGroups","responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/XiqKeyBasedPcg"}}}}}},"security":[{"BearerAuth":[]}]},"post":{"tags":["Configuration - User Management"],"summary":"Setup a Key-based Private Client Group","description":"Setup a Key-based Private Client Group, including network policy, user, user group, SSID, etc.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_initiate_key_based_pcg"},"operationId":"setupKeyBasedPrivateClientGroupNetworkPolicy","requestBody":{"description":"The request to setup Key-based PCG network policy","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqInitKeyBasedPcgNetworkPolicyRequest"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"202":{"description":"Accepted"}},"security":[{"BearerAuth":[]}]}},"/pcgs/key-based/network-policy-{policyId}/port-assignments":{"get":{"tags":["Configuration - User Management"],"summary":"Get device port assignments in network policy","description":"Get port assignments for devices (currently support for AP150W & AP302W) in a network policy.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_port_assignment_details_of_ap150w"},"operationId":"getPortAssignments","parameters":[{"name":"policyId","in":"path","description":"The network policy ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqGetPortAssignmentDetailsResponse"}}}}},"security":[{"BearerAuth":[]}]},"post":{"tags":["Configuration - User Management"],"summary":"Assign ports to devices in network policy","description":"Assign ports for devices (currently support for AP150W & AP302W) in a network policy.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_pcg_assign_ports"},"operationId":"assignPorts","parameters":[{"name":"policyId","in":"path","description":"The network policy ID","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"description":"The payload of assign ports for devices","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqPcgAssignPortsRequest"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqPcgAssignPortsResponse"}}}}},"security":[{"BearerAuth":[]}]}},"/pcgs/key-based/network-policy-{policyId}/keys/:generate":{"post":{"tags":["Configuration - User Management"],"summary":"Generate shared keys for users in network policy","description":"Generate/regenerate shared keys for specified users in a specific PCG-enable network policy.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_generate_keys"},"operationId":"generateKeys","parameters":[{"name":"policyId","in":"path","description":"The network policy ID","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"userIds","in":"query","description":"The user IDs","required":true,"schema":{"type":"array","items":{"type":"integer","format":"int64"}}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"202":{"description":"Accepted"}},"security":[{"BearerAuth":[]}]}},"/pcgs/key-based/network-policy-{policyId}/keys/:email":{"post":{"tags":["Configuration - User Management"],"summary":"Send keys to users in network policy via Email","description":"Send keys to specified users in PCG-enabled network policy via Email.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_email_keys"},"operationId":"emailKeys","parameters":[{"name":"policyId","in":"path","description":"The network policy ID","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"userIds","in":"query","description":"The user IDs","required":true,"schema":{"type":"array","items":{"type":"integer","format":"int64"}}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"202":{"description":"Accepted"}},"security":[{"BearerAuth":[]}]}},"/pcgs/key-based/network-policy-{policyId}/:onboard":{"post":{"tags":["Configuration - User Management"],"summary":"Create Key-based PCG in network policy","description":"Create a Key-based Private Client Group for a specific network policy.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_create_key_based_pcg_data"},"operationId":"onboardKeyBasedPrivateClientGroup","parameters":[{"name":"policyId","in":"path","description":"The network policy ID","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqOnboardKeyBasedPcgRequest"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"202":{"description":"Accepted"}},"security":[{"BearerAuth":[]}]}},"/packetcaptures":{"get":{"tags":["Packet Capture"],"summary":"List packet capture sessions","description":"List packet captures with filters and pagination.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_list_packet_captures"},"operationId":"listPacketCaptures","parameters":[{"name":"searchString","in":"query","description":"The string to be searched in capture session name, interface name and device host name","required":false,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Page number, min = 1","required":false,"schema":{"minimum":1,"type":"integer","format":"int32","default":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 500","required":false,"schema":{"maximum":500,"minimum":1,"type":"integer","format":"int32","default":10}},{"name":"sortField","in":"query","description":"Sort field. Available values - NAME, START_TIME and STATUS","required":false,"schema":{"$ref":"#/components/schemas/XiqPacketCaptureSortField"}},{"name":"order","in":"query","description":"Sort order (ascending by default)","required":false,"schema":{"$ref":"#/components/schemas/XiqSortOrder"}},{"name":"fields","in":"query","description":"The packet capture fields to return","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/XiqPacketCaptureField"}}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqPacketCapture"}}}}},"security":[{"BearerAuth":[]}]},"post":{"tags":["Packet Capture"],"summary":"Create a new packet capture session","description":"Create and start a new packet capture session with requested capture location and filter criteria.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_create_packet_capture"},"operationId":"createPacketCapture","requestBody":{"description":"The packet capture to start","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqPacketCapture"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqPacketCapture"}}}}},"security":[{"BearerAuth":[]}]}},"/packetcaptures/{id}/:upload":{"post":{"tags":["Packet Capture"],"summary":"Upload a packet capture session's capture files","description":"Upload the capture files from a packet capture session, if files previously failed to be uploaded to XIQ cloud.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_upload_packet_capture_files"},"operationId":"uploadPacketCaptureFiles","parameters":[{"name":"id","in":"path","description":"The packet capture ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK"}},"security":[{"BearerAuth":[]}]}},"/packetcaptures/{id}/:stop":{"post":{"tags":["Packet Capture"],"summary":"Stop a packet capture session","description":"Stop an active packet capture session.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_stop_packet_capture"},"operationId":"stopPacketCapture","parameters":[{"name":"id","in":"path","description":"The packet capture ID","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqCaptureStopRequest"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK"}},"security":[{"BearerAuth":[]}]}},"/operations/{operationId}/:cancel":{"post":{"tags":["Operation"],"summary":"Cancel Long-Running Operation (LRO)","description":"When the cancelable is true in operation metadata the clients are allowed to send a cancel request to ask the backend to cancel the operation.\nThe server makes its best effort to cancel the operation, but success is not guaranteed.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_cancel_operation"},"operationId":"cancelOperation","parameters":[{"name":"operationId","in":"path","description":"The operation ID","required":true,"schema":{"type":"string"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK"}},"security":[{"BearerAuth":[]}]}},"/network-policies":{"get":{"tags":["Network Policy"],"summary":"List network policies","description":"List a page of network policies.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_list_network_policies"},"operationId":"listNetworkPolices","parameters":[{"name":"page","in":"query","description":"Page number, min = 1","required":false,"schema":{"minimum":1,"type":"integer","format":"int32","default":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 100","required":false,"schema":{"maximum":100,"minimum":1,"type":"integer","format":"int32","default":10}},{"name":"policyNames","in":"query","description":"The list of full network policy names to filter the query","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"keyword","in":"query","description":"The keyword to partial search by network policy name","required":false,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"The network policy fields to return","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/XiqNetworkPolicyField"}}},{"name":"view","in":"query","description":"The views to return network policy fields (Check fields for each view at XiqNetworkPolicyView schema)","required":false,"schema":{"$ref":"#/components/schemas/XiqNetworkPolicyView"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqNetworkPolicy"}}}}},"security":[{"BearerAuth":[]}]},"post":{"tags":["Network Policy"],"summary":"Create network policy","description":"Create a new network policy.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_create_network_policy"},"operationId":"createNetworkPolicy","requestBody":{"description":"The body of create network policy API","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqCreateNetworkPolicyRequest"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqNetworkPolicy"}}}}},"security":[{"BearerAuth":[]}]}},"/network-policies/{id}/ssids/:remove":{"post":{"tags":["Network Policy"],"summary":"Removes SSIDs from the network policy","description":"Removing multiple SSIDs from the network policy.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_removing_multiple_ssids_from_the_network_policy"},"operationId":"deleteSsidsFromNetworkPolicy","parameters":[{"name":"id","in":"path","description":"The network policy ID","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"description":"The SSID ids to be removed from the network policy","content":{"application/json":{"schema":{"type":"array","items":{"type":"integer","format":"int64"}}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK"}},"security":[{"BearerAuth":[]}]}},"/network-policies/{id}/ssids/:add":{"post":{"tags":["Network Policy"],"summary":"Add SSIDs to a network policy","description":"Add SSIDs to a specific network policy.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_adding_multiple_ssids_to_the_network_policy"},"operationId":"addSsidsToNetworkPolicy","parameters":[{"name":"id","in":"path","description":"The network policy ID","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"description":"The SSID ids to be added to the network policy","content":{"application/json":{"schema":{"type":"array","items":{"type":"integer","format":"int64"}}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK"}},"security":[{"BearerAuth":[]}]}},"/logs/audit/reports":{"post":{"tags":["Log"],"summary":"[LRO] Create audit logs report","description":"Creates a report page of audit logs.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_audit_log_report"},"operationId":"auditLogsReport","parameters":[{"name":"sortField","in":"query","description":"The field for sorting","required":false,"schema":{"$ref":"#/components/schemas/XiqAuditLogSortField"}},{"name":"sortOrder","in":"query","description":"The sorting order","required":false,"schema":{"$ref":"#/components/schemas/XiqSortOrder"}},{"name":"categories","in":"query","description":"Audit category","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/XiqAuditLogCategory"}}},{"name":"username","in":"query","description":"The user login name","required":false,"schema":{"type":"string"}},{"name":"startTime","in":"query","description":"The start time to query, epoch time in milliseconds since 1/1/1970, default is 0 if not specified or is negative","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"endTime","in":"query","description":"The end time to query, epoch time in milliseconds since 1/1/1970, default is now if not specified or is negative, endTime - startTime must be no greater than 2592000000 (30 days)","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"timeZoneOffset","in":"query","description":"The time zone off set","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"keyword","in":"query","description":"The case-insensitive keyword to search in description","required":false,"schema":{"type":"string"}},{"name":"async","in":"query","description":"Whether to enable async mode","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqAuditLogReport"}}}}},"security":[{"BearerAuth":[]}]}},"/logout":{"post":{"tags":["Authentication"],"summary":"User logout (Revoke the current access token)","description":"User logout, the current access token will be revoked and the following access with the same token will be immediately denied.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_logout"},"operationId":"logout","responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK"}},"security":[{"BearerAuth":[]}]}},"/login":{"post":{"tags":["Authentication"],"summary":"User login with username and password","description":"Get access token via username and password authentication.\nThe client must present Bearer token to access the protected API endpoints.The Bearer token should be present in the \"Authorization\" request header field and use the \"Bearer\" HTTP authentication scheme to transmit the access token.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_login"},"operationId":"login","requestBody":{"description":"Login request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqLoginRequest"},"examples":{"Extreme login":{"summary":"Login with username and password","description":"User login with username/email and password","value":{"username":"username@company.com","password":"ChangeMe"}}}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"UNAUTHORIZED","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqLoginResponse"},"examples":{"200 example":{"summary":"Login successful","description":"Login successful response example.","value":{"access_token":"eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjpmYWxzZSwib3duZXJfaWQiOjEwMiwib3JnX2lkIjowLCJkYXRhX2NlbnRlciI6IlVTX1dlc3QiLCJxdW90YSI6Ijc1MDA7dz0zNjAwIiwianRpIjoiMTcyZTExMWMwNDMzNDBkODkyYmViYTkyNmZlOTM0NmYiLCJpc3MiOiJleHRyZW1lY2xvdWRpcS5jb20iLCJpYXQiOjE2NDQ4NzcwNDgsImV4cCI6MTY0NDk2MzQ0OH0.kFRSUXLhg9800gSU2BQ4Gf7l_8eEhgpd0D90Ia6w0kw","token_type":"Bearer","expires_in":86400}}}}}}}}},"/locations":{"post":{"tags":["Location"],"summary":"Create a location","description":"Create a new location under the parent location.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_create_location"},"operationId":"createLocation","requestBody":{"description":"Create location request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqCreateLocationRequest"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqLocation"}}}}},"security":[{"BearerAuth":[]}]}},"/locations/site":{"get":{"tags":["Location"],"summary":"List sites","description":"List a page of sites by filter.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_list_sites"},"operationId":"listSites","parameters":[{"name":"page","in":"query","description":"Page number, min = 1","required":false,"schema":{"minimum":1,"type":"integer","format":"int32","default":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 100","required":false,"schema":{"maximum":100,"minimum":1,"type":"integer","format":"int32","default":10}},{"name":"order","in":"query","description":"The sort order by name (ascending by default)","required":false,"schema":{"$ref":"#/components/schemas/XiqSortOrder"}},{"name":"name","in":"query","description":"List sites by name (case insensitive)","required":false,"schema":{"type":"string"}},{"name":"ids","in":"query","description":"List sites by IDs","required":false,"schema":{"type":"array","items":{"type":"integer","format":"int64"}}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqSite"}}}}},"security":[{"BearerAuth":[]}]},"post":{"tags":["Location"],"summary":"Create a site","description":"Create a new site under the site group.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_create_site"},"operationId":"createSite","requestBody":{"description":"Create site request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqCreateSiteRequest"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqSite"}}}}},"security":[{"BearerAuth":[]}]}},"/locations/floor":{"get":{"tags":["Location"],"summary":"List floors","description":"List a page of floors by filter.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_list_floors"},"operationId":"listFloors","parameters":[{"name":"page","in":"query","description":"Page number, min = 1","required":false,"schema":{"minimum":1,"type":"integer","format":"int32","default":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 100","required":false,"schema":{"maximum":100,"minimum":1,"type":"integer","format":"int32","default":10}},{"name":"order","in":"query","description":"The sort order by name (ascending by default)","required":false,"schema":{"$ref":"#/components/schemas/XiqSortOrder"}},{"name":"name","in":"query","description":"List floors by name (case insensitive)","required":false,"schema":{"type":"string"}},{"name":"ids","in":"query","description":"List floors by IDs","required":false,"schema":{"type":"array","items":{"type":"integer","format":"int64"}}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqFloor"}}}}},"security":[{"BearerAuth":[]}]},"post":{"tags":["Location"],"summary":"Create a floor","description":"Create a new floor under the parent building.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_create_floor"},"operationId":"createFloor","requestBody":{"description":"Create floor request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqCreateFloorRequest"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqFloor"}}}}},"security":[{"BearerAuth":[]}]}},"/locations/floorplan":{"post":{"tags":["Location"],"summary":"Upload floorplan","description":"Upload the floorplan map for the VIQ.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_upload_floor_plan"},"operationId":"uploadFloorplan","requestBody":{"content":{"multipart/form-data":{"schema":{"required":["file"],"type":"object","properties":{"file":{"type":"string","description":"The floorplan image file to upload. \n For better performance, Extreme Networks recommends that the image file (.png .jpeg) be less than 10 MB.","format":"binary"}}}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK"}},"security":[{"BearerAuth":[]}]}},"/locations/building":{"get":{"tags":["Location"],"summary":"List buildings","description":"List a page of buildings by filter.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_list_buildings"},"operationId":"listBuildings","parameters":[{"name":"page","in":"query","description":"Page number, min = 1","required":false,"schema":{"minimum":1,"type":"integer","format":"int32","default":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 100","required":false,"schema":{"maximum":100,"minimum":1,"type":"integer","format":"int32","default":10}},{"name":"order","in":"query","description":"The sort order by name (ascending by default)","required":false,"schema":{"$ref":"#/components/schemas/XiqSortOrder"}},{"name":"name","in":"query","description":"List buildings by name (case insensitive)","required":false,"schema":{"type":"string"}},{"name":"ids","in":"query","description":"List buildings by IDs","required":false,"schema":{"type":"array","items":{"type":"integer","format":"int64"}}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqBuilding"}}}}},"security":[{"BearerAuth":[]}]},"post":{"tags":["Location"],"summary":"Create a building","description":"Create a new building under the parent site.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_create_building"},"operationId":"createBuilding","requestBody":{"description":"Create building request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqCreateBuildingRequest"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqBuilding"}}}}},"security":[{"BearerAuth":[]}]}},"/locations/:init":{"post":{"tags":["Location"],"summary":"Initialize organization location","description":"Initialize the organization location hierarchy tree.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_initialize_location"},"operationId":"initializeLocation","requestBody":{"description":"Initialize organization location request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqInitializeLocationRequest"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqLocation"}}}}},"security":[{"BearerAuth":[]}]}},"/licenses/legacy-licenses":{"post":{"tags":["License"],"summary":"Add legacy license","description":"Add legacy license.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_add_legacy_license"},"operationId":"addLegacyLicense","requestBody":{"description":"The payload to add legacy license key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqAddLegacyLicenseRequest"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqAddLegacyLicenseResponse"}}}}},"security":[{"BearerAuth":[]}]}},"/licenses/extreme-portal/:unlink":{"post":{"tags":["License"],"summary":"Unlink Extreme portal account","description":"Unlink Extreme portal account.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_unlink_extreme_portal"},"operationId":"unlinkExtremePortal","responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK"}},"security":[{"BearerAuth":[]}]}},"/licenses/:synchronize":{"post":{"tags":["License"],"summary":"Synchronize licenses","description":"Synchronize licenses.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_synchronize_licenses"},"operationId":"synchronizeLicenses","responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK"}},"security":[{"BearerAuth":[]}]}},"/ldap-servers":{"get":{"tags":["Configuration - Authentication"],"summary":"List LDAP servers","description":"List a page of LDAP servers.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_list_ldap_servers"},"operationId":"listLdapServers","parameters":[{"name":"page","in":"query","description":"Page number, min = 1","required":false,"schema":{"minimum":1,"type":"integer","format":"int32","default":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 100","required":false,"schema":{"maximum":100,"minimum":1,"type":"integer","format":"int32","default":10}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqLdapServer"}}}}},"security":[{"BearerAuth":[]}]},"post":{"tags":["Configuration - Authentication"],"summary":"Create LDAP server","description":"Create a new LDAP server.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_create_ldap_server"},"operationId":"createLdapServer","requestBody":{"description":"The body of create LDAP server API","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqCreateLdapServerRequest"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqLdapServer"}}}}},"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":[{"name":"page","in":"query","description":"Page number, min = 1","required":false,"schema":{"minimum":1,"type":"integer","format":"int32","default":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 100","required":false,"schema":{"maximum":500,"minimum":1,"type":"integer","format":"int32","default":10}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqIotProfile"}}}}},"security":[{"BearerAuth":[]}]},"post":{"tags":["Configuration - Policy"],"summary":"Create a 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":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqIotProfile"}}}}},"security":[{"BearerAuth":[]}]}},"/hiq/organizations":{"get":{"tags":["HIQ"],"summary":"List all organizations","description":"List all organizations in current HIQ (Available when HIQ is enabled).","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_all_organizations"},"operationId":"listOrganizations","responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/XiqOrganization"}}}}}},"security":[{"BearerAuth":[]}]},"post":{"tags":["HIQ"],"summary":"Create a new organization","description":"Create a new organization in current HIQ (Available when HIQ is enabled).","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_create_organization"},"operationId":"createOrganization","requestBody":{"description":"Create new organization request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqCreateOrganizationRequest"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqOrganization"}}}}},"security":[{"BearerAuth":[]}]}},"/hiq/organizations/{id}/:rename":{"post":{"tags":["HIQ"],"summary":"Rename an existing organization","description":"Rename an existing organization (Available when HIQ is enabled).","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_rename_organization"},"operationId":"renameOrganization","parameters":[{"name":"id","in":"path","description":"Organization ID to rename","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"description":"The new organization name","content":{"application/json":{"schema":{"type":"string"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"204":{"description":"No Content"}},"security":[{"BearerAuth":[]}]}},"/endusers":{"get":{"tags":["Configuration - User Management"],"summary":"List end users","description":"List a page of end users.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_list_end_users"},"operationId":"listEndUsers","parameters":[{"name":"page","in":"query","description":"Page number, min = 1","required":false,"schema":{"minimum":1,"type":"integer","format":"int32","default":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 100","required":false,"schema":{"maximum":100,"minimum":1,"type":"integer","format":"int32","default":10}},{"name":"user_group_ids","in":"query","description":"The user group IDs","required":false,"schema":{"type":"array","items":{"type":"integer","format":"int64"}}},{"name":"usernames","in":"query","description":"The list of username","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqEndUser"}}}}},"security":[{"BearerAuth":[]}]},"post":{"tags":["Configuration - User Management"],"summary":"Create an end user","description":"Create a new end user.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_create_end_user"},"operationId":"createEndUser","requestBody":{"description":"Create end user request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqCreateEndUserRequest"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqEndUser"}}}}},"security":[{"BearerAuth":[]}]}},"/endusers/{id}/:regenerate-password":{"post":{"tags":["Configuration - User Management"],"summary":"Regenerate a new password for the end user","description":"Update the user's password with a system generated password.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_regenerate_end_user_password"},"operationId":"regenerateEndUserPassword","parameters":[{"name":"id","in":"path","description":"The enduser's ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqRegenerateEndUserPasswordResponse"}}}}},"security":[{"BearerAuth":[]}]}},"/devices/{id}/thread/commissioner/:stop":{"post":{"tags":["Device"],"summary":"Stop Thread Commissioner","description":"Stop the thread commissioner on the device.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_device_thread_commissioner_stop"},"operationId":"stopThreadCommissioner","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqThreadStopCommissionerRequest"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK"}},"security":[{"BearerAuth":[]}]}},"/devices/{id}/thread/commissioner/:start":{"post":{"tags":["Device"],"summary":"Start Thread Commissioner","description":"Start the thread commissioner on the device.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_device_thread_commissioner_start"},"operationId":"startThreadCommissioner","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqThreadStartCommissionerRequest"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK"}},"security":[{"BearerAuth":[]}]}},"/devices/{id}/ssid/status/:change":{"post":{"tags":["Device"],"summary":"Enable or disable SSID for a device","description":"Enable or disable SSIDs on the given wifi interfaces for a specific device.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_change_the_device_level_ssid_status_on_each_wifi_interface"},"operationId":"changeDeviceLevelSsidStatus","parameters":[{"name":"id","in":"path","description":"The device ID","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqUpdateDeviceLevelSsidStatus"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK"}},"security":[{"BearerAuth":[]}]}},"/devices/{id}/ssid/:override":{"post":{"tags":["Device"],"summary":"Override SSID for a device","description":"Override SSID broadcast name/passphrase for a specific device.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_device_level_ssid_override"},"operationId":"overrideDeviceLevelSsid","parameters":[{"name":"id","in":"path","description":"The device ID","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqDeviceLevelSsid"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK"}},"security":[{"BearerAuth":[]}]}},"/devices/{id}/config/vlan-ipv4-static":{"get":{"tags":["Device"],"summary":"Get IPv4 Static Route for a device","description":"Get the IPv4 Static Route for a specific device.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_configure_ipv4_static_routes"},"operationId":"getDeviceIpv4StaticRoutes","parameters":[{"name":"id","in":"path","description":"Device ID","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"page","in":"query","description":"Page number, min = 1","required":false,"schema":{"minimum":1,"type":"integer","format":"int32","default":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 100","required":false,"schema":{"maximum":100,"minimum":1,"type":"integer","format":"int32","default":10}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqDeviceConfigureIpv4StaticRoute"}}}}},"security":[{"BearerAuth":[]}]},"post":{"tags":["Device"],"summary":"Create an IPv4 Static Route for a device","description":"Create the IPv4 Static Route for a specific device.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_create_configure_ipv4_static_route"},"operationId":"createDeviceIpv4StaticRoute","parameters":[{"name":"id","in":"path","description":"Device ID","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"description":"The payload to create a new IPv4 Static Route attribute","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqDeviceCreateConfigureIpv4StaticRoute"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqDeviceUpdateConfigureIpv4StaticRoute"}}}}},"security":[{"BearerAuth":[]}]},"delete":{"tags":["Device"],"summary":"Delete one or more IPv4 Static Routes for a device","description":"Delete one or more IPv4 Static Routes for a specific device.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_delete_configure_ipv4_static_routes"},"operationId":"deleteDeviceIpv4StaticRoutes","parameters":[{"name":"id","in":"path","description":"Device ID","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"staticRouteIds","in":"query","description":"IPv4 Static Routes IDs","required":true,"schema":{"type":"array","items":{"type":"integer","format":"int64"}}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK"}},"security":[{"BearerAuth":[]}]}},"/devices/{id}/config/vlan-ipv4-intf":{"get":{"tags":["Device"],"summary":"Get IPv4 Interfaces for a device","description":"Get the IPv4 Interfaces for a specific device.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_configure_ipv4_interfaces"},"operationId":"getDeviceIpv4Interfaces","parameters":[{"name":"id","in":"path","description":"Device ID","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"page","in":"query","description":"Page number, min = 1","required":false,"schema":{"minimum":1,"type":"integer","format":"int32","default":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 100","required":false,"schema":{"maximum":100,"minimum":1,"type":"integer","format":"int32","default":10}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqDeviceConfigureIpv4Interface"}}}}},"security":[{"BearerAuth":[]}]},"post":{"tags":["Device"],"summary":"Create an IPv4 Interface for a device","description":"Create the IPv4 Interface for a specific device.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_create_configure_ipv4_interface"},"operationId":"createDeviceIpv4Interface","parameters":[{"name":"id","in":"path","description":"Device ID","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"description":"The payload to create a new IPv4 Interface attribute","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqDeviceCreateConfigureIpv4Interface"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqDeviceConfigureIpv4InterfaceResponse"}}}}},"security":[{"BearerAuth":[]}]},"delete":{"tags":["Device"],"summary":"Delete one or more IPv4 Interfaces for a device","description":"Delete one or more IPv4 Interfaces for a specific device.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_delete_configure_ipv4_interfaces"},"operationId":"deleteDeviceIpv4Interfaces","parameters":[{"name":"id","in":"path","description":"Device ID","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"interfaceIds","in":"query","description":"IPv4 Interfaces IDs","required":true,"schema":{"type":"array","items":{"type":"integer","format":"int64"}}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK"}},"security":[{"BearerAuth":[]}]}},"/devices/{id}/config/vlan-attributes":{"get":{"tags":["Device"],"summary":"List vlan attributes for a device","description":"List vlan attributes for a specific device.","operationId":"listDeviceVlanAttrs","parameters":[{"name":"id","in":"path","description":"The device id","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"page","in":"query","description":"Page number, min = 1","required":false,"schema":{"minimum":1,"type":"integer","format":"int32","default":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 100","required":false,"schema":{"maximum":100,"minimum":1,"type":"integer","format":"int32","default":10}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqDeviceVlanAttributes"}}}}},"security":[{"BearerAuth":[]}]},"post":{"tags":["Device"],"summary":"Create a Vlan attribute","description":"Create a new VLAN attribute.","operationId":"createDeviceVlanAttrs","parameters":[{"name":"id","in":"path","description":"id","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"description":"The payload to create a new VLAN attribute","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqDeviceCreateVlanAttributes"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK"}},"security":[{"BearerAuth":[]}]},"delete":{"tags":["Device"],"summary":"Delete vlan attributes","description":"Delete one or more VLAN attributes.","operationId":"deleteDeviceVlanAttributes","parameters":[{"name":"id","in":"path","description":"The device id","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"vlanIds","in":"query","description":"VLAN ids to be deleted","required":true,"schema":{"type":"array","items":{"type":"integer","format":"int32"}}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK"}},"security":[{"BearerAuth":[]}]}},"/devices/{id}/bounce-port":{"post":{"tags":["Device"],"summary":"Bounce port of a device (EXOS, VOSS and SR Switches","description":"Bounce port for the given device id.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_bounce_port_for_single_device"},"operationId":"bounceDevicePort","parameters":[{"name":"id","in":"path","description":"The device id","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqBounceDevicePortRequest"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqBounceDevicePortResponse"}}}}},"security":[{"BearerAuth":[]}]}},"/devices/{id}/:unmanage":{"post":{"tags":["Device"],"summary":"Change admin state to 'Unmanaged' for a device","description":"Change device admin state to 'Unmanaged' for a specific device.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_change_status_to_unmanaged_for_one_device"},"operationId":"changeDeviceStatusToUnmanage","parameters":[{"name":"id","in":"path","description":"The device ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK"}},"security":[{"BearerAuth":[]}]}},"/devices/{id}/:reset":{"post":{"tags":["Device"],"summary":"[LRO] Reset a device to factory default","description":"Reset a device to factory default settings.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_factory_reset_a_device"},"operationId":"resetDevice","parameters":[{"name":"id","in":"path","description":"The device ID","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"async","in":"query","description":"Whether to enable async mode","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK"}},"security":[{"BearerAuth":[]}]}},"/devices/{id}/:reboot":{"post":{"tags":["Device"],"summary":"Reboot a device","description":"Reboot a specific device.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_reboot_one_device"},"operationId":"rebootDevice","parameters":[{"name":"id","in":"path","description":"The device ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK"}},"security":[{"BearerAuth":[]}]}},"/devices/{id}/:manage":{"post":{"tags":["Device"],"summary":"Change admin state to 'Managed' for a device","description":"Change device management status to Managed for a specific device.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_change_status_to_managed_for_one_device"},"operationId":"changeDeviceStatusToManage","parameters":[{"name":"id","in":"path","description":"The device ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK"}},"security":[{"BearerAuth":[]}]}},"/devices/{id}/:cli":{"post":{"tags":["Device"],"summary":"Send CLI to a device","description":"Send CLI commands to a specific device.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_send_cli_to_one_device"},"operationId":"sendCliToDevice","parameters":[{"name":"id","in":"path","description":"The device ID","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"description":"The one or multiple CLIs to send","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqSendCliResponse"}}}}},"security":[{"BearerAuth":[]}]}},"/devices/os/:change":{"post":{"tags":["Device"],"summary":"Change device OS mode","description":"Change OS mode for AP or Switch.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_change_multiple_devices_os_mode"},"operationId":"changeDevicesOsMode","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqChangeDevicesOsModeRequest"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK"}},"security":[{"BearerAuth":[]}]}},"/devices/network-policy/:revoke":{"post":{"tags":["Device"],"summary":"Revoke network policy for multiple devices","description":"Revoke the network policy from the target devices.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_revoke_network_policy_for_multiple_devices"},"operationId":"revokeDevicesNetworkPolicy","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqDeviceFilter"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK"}},"security":[{"BearerAuth":[]}]}},"/devices/network-policy/:query":{"post":{"tags":["Device"],"summary":"Query network policy for multiple devices","description":"Query the network policy for the target devices.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_query_network_policy_for_multiple_devices"},"operationId":"queryDevicesNetworkPolicy","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqDeviceFilter"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/XiqNetworkPolicy"}}}}}},"security":[{"BearerAuth":[]}]}},"/devices/network-policy/:assign":{"post":{"tags":["Device"],"summary":"Assign network policy to multiple devices","description":"Assign the network policy to the target devices.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_assign_network_policy_to_multiple_devices"},"operationId":"assignDevicesNetworkPolicy","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqAssignDevicesNetworkPolicyRequest"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK"}},"security":[{"BearerAuth":[]}]}},"/devices/location/:revoke":{"post":{"tags":["Device"],"summary":"Revoke location for multiple devices","description":"Revoke the location from the target devices.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_revoke_location_for_multiple_devices"},"operationId":"revokeDevicesLocation","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqDeviceFilter"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK"}},"security":[{"BearerAuth":[]}]}},"/devices/location/:query":{"post":{"tags":["Device"],"summary":"Query location for multiple devices","description":"Query the location for the target devices.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_query_location_for_multiple_devices"},"operationId":"queryDevicesLocation","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqDeviceFilter"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/XiqDeviceLocation"}}}}}},"security":[{"BearerAuth":[]}]}},"/devices/location/:assign":{"post":{"tags":["Device"],"summary":"Assign location to multiple devices","description":"Assign the location to the target devices.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_assign_location_to_multiple_devices"},"operationId":"assignDevicesLocation","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqAssignDevicesLocationRequest"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK"}},"security":[{"BearerAuth":[]}]}},"/devices/country-code/:assign":{"post":{"tags":["Device"],"summary":"Assign a country code to devices","description":"Assign the country code to one or more devices.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_assign_country_code_to_multiple_devices"},"operationId":"assignDevicesCountryCode","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqAssignDevicesCountryCodeRequest"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK"}},"security":[{"BearerAuth":[]}]}},"/devices/:unmanage":{"post":{"tags":["Device"],"summary":"Change status to Unmanaged","description":"Change device management status to Unmanaged for the target devices.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_change_status_to_unmanaged"},"operationId":"changeStatusToUnmanage","requestBody":{"description":"The device filter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqDeviceFilter"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK"}},"security":[{"BearerAuth":[]}]}},"/devices/:reboot":{"post":{"tags":["Device"],"summary":"Reboot devices","description":"Reboot the target devices.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_reboot_devices"},"operationId":"rebootDevices","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqDeviceFilter"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK"}},"security":[{"BearerAuth":[]}]}},"/devices/:onboard":{"post":{"tags":["Device"],"summary":"Onboard Devices","description":"Onboard devices for all devices, such as Extreme/Aerohive, EXOS, VOSS, WiNG, Dell, and Digital Twin.\nThis is asynchronized operation to support massive device onboarding.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_onboard_devices"},"operationId":"onboardDevices","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqOnboardDeviceRequest"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"202":{"description":"Accepted"}},"security":[{"BearerAuth":[]}]}},"/devices/:manage":{"post":{"tags":["Device"],"summary":"Change status to Managed","description":"Change device management status to Managed for the target devices.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_change_status_to_managed"},"operationId":"changeStatusToManage","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqDeviceFilter"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK"}},"security":[{"BearerAuth":[]}]}},"/devices/:delete":{"post":{"tags":["Device"],"summary":"Delete devices","description":"Bulk delete the devices matching the filter criteria.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_delete_devices"},"operationId":"deleteDevices","parameters":[{"name":"force_delete","in":"query","description":"Force deletion of devices","required":false,"schema":{"type":"boolean","default":false}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqDeviceFilter"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK"}},"security":[{"BearerAuth":[]}]}},"/devices/:cli":{"post":{"tags":["Device"],"summary":"[LRO] Send CLI to devices","description":"Send CLI commands to the target devices. This API can be run at async mode, please follow the Long-Running Operation (LRO) guide to track the progress and the result.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_send_cli"},"operationId":"sendCliToDevices","parameters":[{"name":"async","in":"query","description":"Whether to enable async mode","required":false,"schema":{"type":"boolean","default":false}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqSendCliRequest"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqSendCliResponse"}}}}},"security":[{"BearerAuth":[]}]}},"/devices/:advanced-onboard":{"post":{"tags":["Device"],"summary":"[LRO] Advanced Onboard Devices","description":"Advanced onboard devices for all devices, such as Extreme/Aerohive, EXOS, VOSS, WiNG, Dell, and Digital Twin. Advanced onboard devices will allow the user to set the device hostname, attach the device location, associate network policy, etc. in a single API request.\nTo avoid API timeout when onboarding a large number of devices, please make sure to enable async mode (set async=true in query parameter) and use long-running operation API to query the result.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_advanced_onboard_devices"},"operationId":"advancedOnboardDevices","parameters":[{"name":"async","in":"query","description":"Whether to enable async mode","required":false,"schema":{"type":"boolean","default":false}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqAdvancedOnboardDeviceRequest"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqAdvancedOnboardDeviceResponse"}}}}},"security":[{"BearerAuth":[]}]}},"/deployments":{"post":{"tags":["Configuration - Deployment"],"summary":"Push configuration and upgrade firmware","description":"Push configuration and upgrade firmware to the target devices.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_push_configuration_and_upgrade_firmware_to_devices"},"operationId":"deployConfig","requestBody":{"description":"The device deploy configuration","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqDeploymentRequest"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqDeploymentResponse"}}}}},"security":[{"BearerAuth":[]}]}},"/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":[{"name":"page","in":"query","description":"Page number, min = 1","required":false,"schema":{"minimum":1,"type":"integer","format":"int32","default":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 100","required":false,"schema":{"maximum":100,"minimum":1,"type":"integer","format":"int32","default":10}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqClassificationRule"}}}}},"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":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqClassificationRule"}}}}},"security":[{"BearerAuth":[]}]}},"/ccgs":{"get":{"tags":["Configuration - Policy"],"summary":"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":[{"name":"page","in":"query","description":"Page number, min = 1","required":false,"schema":{"minimum":1,"type":"integer","format":"int32","default":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 100","required":false,"schema":{"maximum":100,"minimum":1,"type":"integer","format":"int32","default":10}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqCloudConfigGroup"}}}}},"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":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqCloudConfigGroup"}}}}},"security":[{"BearerAuth":[]}]}},"/auth/permissions/:check":{"post":{"tags":["Authorization"],"summary":"Check permissions","description":"Get required permissions for given HTTP request.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_check_permissions"},"operationId":"checkPermissions","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqCheckPermissionRequest"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"403":{"description":"Access Denied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqCheckPermissionResponse"}}}}},"security":[{"BearerAuth":[]}]}},"/auth/apitoken":{"post":{"tags":["Authorization"],"summary":"Generate new API token","description":"Generate a new API token with given permissions and expiration time. \nThe available permission list can be found via 'GET /auth/permissions' endpoint.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_generate_api_token"},"operationId":"generateApiToken","requestBody":{"description":"Generate API token request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqGenerateApiTokenRequest"},"examples":{"Generate API token example 1":{"summary":"Generate API token with specific permissions","description":"Generate API token with a single permission to read account info","value":{"description":"Token for reading account info only","expire_time":1604737598,"permissions":["account:r"]}}}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqGenerateApiTokenResponse"}}}}},"security":[{"BearerAuth":[]}]}},"/auth/apitoken/:validate":{"post":{"tags":["Authorization"],"summary":"Validate API token","description":"Validate JWT format API token","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_validate_api_token"},"operationId":"validateApiToken","requestBody":{"content":{"text/plain":{"schema":{"type":"string","description":"The API token to be validated"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK"}}}},"/alerts/reports":{"post":{"tags":["Alert"],"summary":"[LRO] Create the alerts report","description":"Create the alerts by filter.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_create_an_alert_report"},"operationId":"createAlertReport","parameters":[{"name":"startTime","in":"query","description":"The start time for querying alerts in milliseconds","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"endTime","in":"query","description":"The end time for querying alerts in milliseconds","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"severityIds","in":"query","description":"The severity identifier. The currently supported severity IDs are 1 for critical, 2 for warning, and 3 for info.","required":false,"schema":{"type":"array","items":{"type":"integer","format":"int64"}}},{"name":"categoryIds","in":"query","description":"The alert category Id to filter","required":false,"schema":{"type":"array","items":{"type":"integer","format":"int64"}}},{"name":"messageMetadataIds","in":"query","description":"The alert type to filter","required":false,"schema":{"type":"array","items":{"type":"integer","format":"int64"}}},{"name":"acknowledged","in":"query","description":"The site to filter, return global data if not specified","required":false,"schema":{"type":"boolean"}},{"name":"siteId","in":"query","description":"The site id to filter","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"timeZoneOffset","in":"query","description":"The time zone to setup the timestamp","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"keyword","in":"query","description":"The keyword to filter, such as source name or description","required":false,"schema":{"type":"string"}},{"name":"sortField","in":"query","description":"The sort field","required":false,"schema":{"$ref":"#/components/schemas/XiqAlertSortField"}},{"name":"order","in":"query","description":"The sort order (ascending by default)","required":false,"schema":{"$ref":"#/components/schemas/XiqSortOrder"}},{"name":"async","in":"query","description":"Whether to enable async mode","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqAlertReport"}}}}},"security":[{"BearerAuth":[]}]}},"/alerts/:acknowledge":{"post":{"tags":["Alert"],"summary":"Acknowledge the alerts","description":"acknowledge the alerts by alert ids.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_acknowledge_the_alerts"},"operationId":"acknowledgeAlerts","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqAcknowledgeAlertsRequest"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/XiqAlert"}}}}}},"security":[{"BearerAuth":[]}]}},"/alert-subscriptions/webhooks":{"get":{"tags":["Alert"],"summary":"List alert webhook subscriptions","description":"List all alert webhook subscriptions.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_list_the_alert_webhook_subscriptions"},"operationId":"listAlertWebhookSubscriptions","responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/XiqAlertWebhookSubscription"}}}}}},"security":[{"BearerAuth":[]}]},"post":{"tags":["Alert"],"summary":"Create alert webhook subscription","description":"Create alert webhook subscription.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_create_an_alert_webhook_subscription"},"operationId":"createAlertWebhookSubscription","requestBody":{"description":"The payload of create alert webhook subscription","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqCreateAlertWebhookSubscriptionRequest"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqAlertWebhookSubscription"}}}}},"security":[{"BearerAuth":[]}]}},"/alert-subscriptions/webhooks/:delete":{"post":{"tags":["Alert"],"summary":"Delete alert webhook subscription in bulk","description":"Delete alert webhook subscription in bulk.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_bulk_delete_alert_webhook_subscriptions"},"operationId":"deleteBulkAlertSubscriptionWebhook","parameters":[{"name":"async","in":"query","description":"Whether to enable async mode","required":false,"schema":{"type":"boolean","default":false}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqDeleteBulkAlertSubscriptionRequest"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqDeleteBulkAlertSubscriptionWebhookResponse"}}}}},"security":[{"BearerAuth":[]}]}},"/alert-subscriptions/emails":{"get":{"tags":["Alert"],"summary":"List alert email subscriptions","description":"List all alert email subscriptions.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_list_alert_email_subscriptions"},"operationId":"listAlertEmailSubscriptions","responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/XiqAlertEmailSubscription"}}}}}},"security":[{"BearerAuth":[]}]},"post":{"tags":["Alert"],"summary":"Create alert email subscription","description":"Create alert email subscription.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_create_an_alert_email_subscription"},"operationId":"createAlertEmailSubscription","requestBody":{"description":"The payload of create alert email subscription","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqCreateAlertEmailSubscriptionRequest"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqAlertEmailSubscription"}}}}},"security":[{"BearerAuth":[]}]}},"/alert-subscriptions/emails/{id}/:verify":{"post":{"tags":["Alert"],"summary":"Email Verification","description":"Send a request to verify an email","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_verify_an_alert_email_subscription"},"operationId":"verifySubscriptionEmail","parameters":[{"name":"id","in":"path","description":"The alert email subscription ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK"}},"security":[{"BearerAuth":[]}]}},"/alert-subscriptions/emails/:delete":{"post":{"tags":["Alert"],"summary":"Delete alert email subscription in bulk","description":"Delete alert email subscription in bulk.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_bulk_delete_alert_email_subscriptions"},"operationId":"deleteBulkAlertSubscriptionEmail","parameters":[{"name":"async","in":"query","description":"Whether to enable async mode","required":false,"schema":{"type":"boolean","default":false}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqDeleteBulkAlertSubscriptionRequest"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqDeleteBulkAlertSubscriptionEmailResponse"}}}}},"security":[{"BearerAuth":[]}]}},"/alert-policies":{"get":{"tags":["Alert"],"summary":"List all alert policies","description":"Get a list of all alert policies belonging to the current user and an overview \n of their associated alert rules. The details for the rules is available from the alert policy rules API.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_list_the_alert_policies"},"operationId":"listAlertPolicies","parameters":[{"name":"keyword","in":"query","description":"The keyword to filter, such as policy name or site name","required":false,"schema":{"type":"string"}},{"name":"policyType","in":"query","description":"The policy type to filter, such as site or global","required":false,"schema":{"$ref":"#/components/schemas/XiqAlertPolicyType"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqListAlertPolicies"}}}}},"security":[{"BearerAuth":[]}]},"post":{"tags":["Alert"],"summary":"Create a site based alert policy","description":"Create a new site-based alert policy. The global policy for each account is created automatically.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_create_an_alert_policy"},"operationId":"createAlertPolicy","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqAlertPolicyFilter"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqAlertPolicy"}}}}},"security":[{"BearerAuth":[]}]}},"/alert-policies/{policyId}/rules/{ruleId}/:enable":{"post":{"tags":["Alert"],"summary":"Enable a rule from an alert policy","description":"Set the status of a rule to enabled. Users can obtain a rule ID by calling #_get_alert_policy first.If the ENABLE operation adheres to a predetermined rule, a new rule will be duplicated from the predefined one, and the ENABLE operation will be applied to the newly cloned rule. As a result, users might receive a new rule ID that differs from the one provided as a path parameter.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_enable_an_alert_rule"},"operationId":"enableAlertRule","parameters":[{"name":"policyId","in":"path","description":"The policy ID","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"ruleId","in":"path","description":"The rule ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqAlertRule"}}}}},"security":[{"BearerAuth":[]}]}},"/alert-policies/{policyId}/rules/{ruleId}/:disable":{"post":{"tags":["Alert"],"summary":"Disable a rule from an alert policy","description":"Set the status of a rule to disabled. Users can obtain a rule ID by calling #_get_alert_policy first.If the DISABLE operation adheres to a predetermined rule, a new rule will be duplicated from the predefined one, and the DISABLE operation will be applied to the newly cloned rule. As a result, users might receive a new rule ID that differs from the one provided as a path parameter.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_disable_an_alert_rule"},"operationId":"disableAlertRule","parameters":[{"name":"policyId","in":"path","description":"The policy ID","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"ruleId","in":"path","description":"The rule ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqAlertRule"}}}}},"security":[{"BearerAuth":[]}]}},"/account/viq/:backup":{"post":{"tags":["Account"],"summary":"Backup VIQ","description":"Backup VIQ in ExtremeCloud IQ.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_viq_backup"},"operationId":"backupViq","responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK"}},"security":[{"BearerAuth":[]}]}},"/account/:switch":{"post":{"tags":["Account"],"summary":"Switch to another ExtremeCloud IQ account","description":"Switch to external ExtremeCloud IQ account or switch back to home ExtremeCloud IQ account.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_switch_account"},"operationId":"switchAccount","parameters":[{"name":"id","in":"query","description":"The account ID to switch, switch back to home ExtremeCloud IQ account if not provide","required":false,"schema":{"type":"integer","format":"int64"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqLoginResponse"}}}}},"security":[{"BearerAuth":[]}]}},"/vlan-profiles/{id}":{"get":{"tags":["Configuration - Basic"],"summary":"Get a VLAN profile","description":"Get a specific VLAN profile by ID.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_vlan_profile_by_id"},"operationId":"getVlanProfile","parameters":[{"name":"id","in":"path","description":"The VLAN profile ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqVlanProfile"}}}}},"security":[{"BearerAuth":[]}]},"delete":{"tags":["Configuration - Basic"],"summary":"Delete a VLAN profile","description":"Delete a specific VLAN profile by ID.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_delete_vlan_profile_configuration"},"operationId":"deleteVlanProfile","parameters":[{"name":"id","in":"path","description":"The VLAN profile ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK"}},"security":[{"BearerAuth":[]}]},"patch":{"tags":["Configuration - Basic"],"summary":"Update a VLAN profile","description":"Update a specific VLAN profile.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_update_vlan_profile_configuration"},"operationId":"updateVlanProfile","parameters":[{"name":"id","in":"path","description":"The VLAN profile ID.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"description":"The payload to update VLAN profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqUpdateVlanProfileRequest"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqVlanProfile"}}}}},"security":[{"BearerAuth":[]}]}},"/users/{id}":{"get":{"tags":["User"],"summary":"Get user info by ID","description":"Get user info for a specific user.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_user"},"operationId":"getUser","parameters":[{"name":"id","in":"path","description":"The user ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqUser"}}}}},"security":[{"BearerAuth":[]}]},"delete":{"tags":["User"],"summary":"Delete user by ID","description":"Delete a specific user.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_delete_user"},"operationId":"deleteUser","parameters":[{"name":"id","in":"path","description":"The user ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK"}},"security":[{"BearerAuth":[]}]},"patch":{"tags":["User"],"summary":"Update user info","description":"Updates user info for a specific user.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_update_user"},"operationId":"updateUser","parameters":[{"name":"id","in":"path","description":"The user ID","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"description":"Update user request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqUpdateUserRequest"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqUser"}}}}},"security":[{"BearerAuth":[]}]}},"/users/external/{id}":{"get":{"tags":["User"],"summary":"Get external access info","description":"Get external access info for a specific external user.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_external_user"},"operationId":"getExternalUser","parameters":[{"name":"id","in":"path","description":"The external user ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqExternalUser"}}}}},"security":[{"BearerAuth":[]}]},"delete":{"tags":["User"],"summary":"Revoke external access","description":"Revoke external acccess for a specific user.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_revoke_external_user"},"operationId":"revokeExternalUser","parameters":[{"name":"id","in":"path","description":"The external user ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK"}},"security":[{"BearerAuth":[]}]},"patch":{"tags":["User"],"summary":"Update external access info","description":"Updates external access info for a specific user.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_update_external_user"},"operationId":"updateExternalUser","parameters":[{"name":"id","in":"path","description":"The external user ID","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"description":"Update external user request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqUpdateExternalUserRequest"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK"}},"security":[{"BearerAuth":[]}]}},"/devices/{id}/config/vlan-ipv4-static/{ipv4StaticRouteId}":{"patch":{"tags":["Device"],"summary":"Update an IPv4 Static Route for a device","description":"Update the IPv4 Static Route for a specific device.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_update_configure_ipv4_interface"},"operationId":"updateDeviceIpv4StaticRoute","parameters":[{"name":"id","in":"path","description":"Device ID","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"ipv4StaticRouteId","in":"path","description":"IPv4 Static Route ID of the entry to be changed","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"description":"The payload to create a new IPv4 Static Route attribute","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqDeviceUpdateConfigureIpv4StaticRoute"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqDeviceUpdateConfigureIpv4StaticRoute"}}}}},"security":[{"BearerAuth":[]}]}},"/devices/{id}/config/vlan-ipv4-intf/{ipv4InterfaceId}":{"patch":{"tags":["Device"],"summary":"Update an IPv4 Interface for a device","description":"Update the IPv4 Interface for a specific device.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_update_configure_ipv4_interface"},"operationId":"updateDeviceIpv4Interface","parameters":[{"name":"id","in":"path","description":"Device ID","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"ipv4InterfaceId","in":"path","description":"IPv4 Interface ID of the entry to be changed","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"description":"The payload to create a new IPv4 Interface attribute","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqDeviceUpdateConfigureIpv4Interface"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqDeviceConfigureIpv4InterfaceResponse"}}}}},"security":[{"BearerAuth":[]}]}},"/devices/{id}/config/vlan-attributes/{vlanId}":{"patch":{"tags":["Device"],"summary":"Change vlan attributes","description":"Change one or more VLAN attributes.","operationId":"updateDeviceVlanAttributes","parameters":[{"name":"id","in":"path","description":"The device id","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"vlanId","in":"path","description":"VLAN id of the entry to be changed","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"description":"The payload to update a VLAN attribute","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqDeviceUpdateVlanAttributes"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqDeviceVlanAttributes"}}}}},"security":[{"BearerAuth":[]}]}},"/users/me":{"get":{"tags":["User"],"summary":"Get current user info","description":"Get currently login user info.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_current_user"},"operationId":"getCurrentUser","responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqUser"}}}}},"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":[{"name":"page","in":"query","description":"Page number, min = 1","required":false,"schema":{"minimum":1,"type":"integer","format":"int32","default":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 100","required":false,"schema":{"maximum":100,"minimum":1,"type":"integer","format":"int32","default":10}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqSsid"}}}}},"security":[{"BearerAuth":[]}]}},"/sms-templates":{"get":{"tags":["Configuration - User Management"],"summary":"List SMS templates","description":"List all SMS notification templates.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_list_sms_templates"},"operationId":"listSmsTemplates","parameters":[{"name":"passwordType","in":"query","description":"The password type","required":false,"schema":{"$ref":"#/components/schemas/XiqPasswordType"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/XiqSmsTemplate"}}}}}},"security":[{"BearerAuth":[]}]}},"/radius-servers/internal/devices":{"get":{"tags":["Configuration - Authentication"],"summary":"List all internal RADIUS devices","description":"List all internal RADIUS devices fields.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_list_the_internal_radius_devices"},"operationId":"listInternalRadiusDevices","parameters":[{"name":"page","in":"query","description":"Page number, min = 1","required":false,"schema":{"minimum":1,"type":"integer","format":"int32","default":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 100","required":false,"schema":{"maximum":100,"minimum":1,"type":"integer","format":"int32","default":10}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqInternalRadiusDevice"}}}}},"security":[{"BearerAuth":[]}]}},"/radius-proxies/devices":{"get":{"tags":["Configuration - Authentication"],"summary":"List Radius proxy devices","description":"List devices for Radius Proxy.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_list_radius_proxy_devices"},"operationId":"listRadiusProxyDevices","parameters":[{"name":"page","in":"query","description":"Page number, min = 1","required":false,"schema":{"minimum":1,"type":"integer","format":"int32","default":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 100","required":false,"schema":{"maximum":100,"minimum":1,"type":"integer","format":"int32","default":10}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqInternalRadiusDevice"}}}}},"security":[{"BearerAuth":[]}]}},"/packetcaptures/{id}":{"get":{"tags":["Packet Capture"],"summary":"Get a packet capture session","description":"Get packet capture session by ID.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_packet_capture"},"operationId":"getPacketCapture","parameters":[{"name":"id","in":"path","description":"The packet capture ID","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"fields","in":"query","description":"The packet capture fields to return","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/XiqPacketCaptureField"}}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqPacketCapture"}}}}},"security":[{"BearerAuth":[]}]},"delete":{"tags":["Packet Capture"],"summary":"Delete a packet capture session","description":"Delete an existing packet capture session and capture files by ID.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_delete_packet_capture"},"operationId":"deletePacketCapture","parameters":[{"name":"id","in":"path","description":"The packet capture ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK"}},"security":[{"BearerAuth":[]}]}},"/packetcaptures/files":{"get":{"tags":["Packet Capture"],"summary":"Get an AP packet capture file","description":"Get an AP packet capture file from XIQ cloud storage.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_packet_capture_file"},"operationId":"getPacketCaptureFile","parameters":[{"name":"cloudFileUrl","in":"query","description":"The packet capture file path","required":true,"schema":{"type":"string"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/octet-stream":{"schema":{"type":"array","items":{"type":"string","format":"byte"}}}}}},"security":[{"BearerAuth":[]}]}},"/operations/{operationId}":{"get":{"tags":["Operation"],"summary":"Get Long-Running Operation (LRO) status and result","description":"Get the Long-Running Operation (LRO) status and result.\nThe response will include either result or error if the operation is done.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_operation"},"operationId":"getOperation","parameters":[{"name":"operationId","in":"path","description":"The operation ID","required":true,"schema":{"type":"string"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqOperationObject"}}}}},"security":[{"BearerAuth":[]}]},"delete":{"tags":["Operation"],"summary":"Delete Long-Running Operation (LRO)","description":"The Long-Running Operation (LRO) can be deleted when the operation is done or in PENDING status.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_delete_operation"},"operationId":"deleteOperation","parameters":[{"name":"operationId","in":"path","description":"The operation ID","required":true,"schema":{"type":"string"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK"}},"security":[{"BearerAuth":[]}]}},"/network-policies/{id}/ssids":{"get":{"tags":["Network Policy"],"summary":"List SSIDs for a network policy","description":"List a page of SSIDs for a specific network policy.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_list_ssid_list_for_the_network_policy"},"operationId":"listSsidsByNetworkPolicy","parameters":[{"name":"id","in":"path","description":"The network policy ID","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"page","in":"query","description":"Page number, min = 1","required":false,"schema":{"minimum":1,"type":"integer","format":"int32","default":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 100","required":false,"schema":{"maximum":100,"minimum":1,"type":"integer","format":"int32","default":10}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqSsid"}}}}},"security":[{"BearerAuth":[]}]}},"/logs/sms":{"get":{"tags":["Log"],"summary":"List SMS logs","description":"List a page of SMS logs.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_list_sms_log"},"operationId":"listSmsLogs","parameters":[{"name":"page","in":"query","description":"Page number, min = 1","required":false,"schema":{"minimum":1,"type":"integer","format":"int32","default":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 100","required":false,"schema":{"maximum":100,"minimum":1,"type":"integer","format":"int32","default":10}},{"name":"phoneNumber","in":"query","description":"The phone number","required":false,"schema":{"type":"string"}},{"name":"startTime","in":"query","description":"The start time to query, epoch time in milliseconds since 1/1/1970, default is 0 if not specified or is negative","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"endTime","in":"query","description":"The end time to query, epoch time in milliseconds since 1/1/1970, default is now if not specified or is negative","required":false,"schema":{"type":"integer","format":"int64"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqSmsLog"}}}}},"security":[{"BearerAuth":[]}]}},"/logs/email":{"get":{"tags":["Log"],"summary":"List Email logs","description":"List a page of Email logs.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_list_email_log"},"operationId":"listEmailLogs","parameters":[{"name":"page","in":"query","description":"Page number, min = 1","required":false,"schema":{"minimum":1,"type":"integer","format":"int32","default":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 100","required":false,"schema":{"maximum":100,"minimum":1,"type":"integer","format":"int32","default":10}},{"name":"username","in":"query","description":"The user login name","required":false,"schema":{"type":"string"}},{"name":"startTime","in":"query","description":"The start time to query, epoch time in milliseconds since 1/1/1970, default is 0 if not specified or is negative","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"endTime","in":"query","description":"The end time to query, epoch time in milliseconds since 1/1/1970, default is now if not specified or is negative","required":false,"schema":{"type":"integer","format":"int64"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqEmailLog"}}}}},"security":[{"BearerAuth":[]}]}},"/logs/credential":{"get":{"tags":["Log"],"summary":"List credential logs","description":"List a page of credential logs.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_list_credential_log"},"operationId":"listCredentialLogs","parameters":[{"name":"page","in":"query","description":"Page number, min = 1","required":false,"schema":{"minimum":1,"type":"integer","format":"int32","default":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 100","required":false,"schema":{"maximum":100,"minimum":1,"type":"integer","format":"int32","default":10}},{"name":"username","in":"query","description":"The user login name","required":false,"schema":{"type":"string"}},{"name":"startTime","in":"query","description":"The start time to query, epoch time in milliseconds since 1/1/1970, default is 0 if not specified or is negative","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"endTime","in":"query","description":"The end time to query, epoch time in milliseconds since 1/1/1970, default is now if not specified or is negative","required":false,"schema":{"type":"integer","format":"int64"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqCredentialLog"}}}}},"security":[{"BearerAuth":[]}]}},"/logs/auth":{"get":{"tags":["Log"],"summary":"List auth logs","description":"List a page of auth logs.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_list_authentication_log"},"operationId":"listAuthLogs","parameters":[{"name":"page","in":"query","description":"Page number, min = 1","required":false,"schema":{"minimum":1,"type":"integer","format":"int32","default":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 100","required":false,"schema":{"maximum":100,"minimum":1,"type":"integer","format":"int32","default":10}},{"name":"username","in":"query","description":"The user login name","required":false,"schema":{"type":"string"}},{"name":"callingStationId","in":"query","description":"The calling station ID","required":false,"schema":{"type":"string"}},{"name":"startTime","in":"query","description":"The start time to query, epoch time in milliseconds since 1/1/1970, default is 0 if not specified or is negative","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"endTime","in":"query","description":"The end time to query, epoch time in milliseconds since 1/1/1970, default is now if not specified or is negative","required":false,"schema":{"type":"integer","format":"int64"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqAuthLog"}}}}},"security":[{"BearerAuth":[]}]}},"/logs/audit":{"get":{"tags":["Log"],"summary":"List audit logs","description":"List a page of audit logs.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_list_audit_log"},"operationId":"listAuditLogs","parameters":[{"name":"page","in":"query","description":"Page number, min = 1","required":false,"schema":{"minimum":1,"type":"integer","format":"int32","default":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 500","required":false,"schema":{"maximum":500,"minimum":1,"type":"integer","format":"int32","default":10}},{"name":"sortField","in":"query","description":"The field for sorting","required":false,"schema":{"$ref":"#/components/schemas/XiqAuditLogSortField"}},{"name":"sortOrder","in":"query","description":"The sorting order","required":false,"schema":{"$ref":"#/components/schemas/XiqSortOrder"}},{"name":"categories","in":"query","description":"Audit category","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/XiqAuditLogCategory"}}},{"name":"username","in":"query","description":"The user login name","required":false,"schema":{"type":"string"}},{"name":"startTime","in":"query","description":"The start time to query, epoch time in milliseconds since 1/1/1970","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"endTime","in":"query","description":"The end time to query, epoch time in milliseconds since 1/1/1970. Note: endTime - startTime must be no greater than 2592000000 (30 days)","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"keyword","in":"query","description":"The case-insensitive keyword to search in description","required":false,"schema":{"type":"string"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqAuditLog"}}}}},"security":[{"BearerAuth":[]}]}},"/logs/audit/reports/{id}":{"get":{"tags":["Log"],"summary":"Download audit logs","description":"Download report of audit logs.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_audit_log_download"},"operationId":"downloadAuditLogsReport","parameters":[{"name":"id","in":"path","description":"The report ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"string","format":"byte"}}}}}},"security":[{"BearerAuth":[]}]}},"/logs/accounting":{"get":{"tags":["Log"],"summary":"List accounting logs","description":"List a page of accounting logs.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_list_accounting_log"},"operationId":"listAccountingLogs","parameters":[{"name":"page","in":"query","description":"Page number, min = 1","required":false,"schema":{"minimum":1,"type":"integer","format":"int32","default":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 100","required":false,"schema":{"maximum":100,"minimum":1,"type":"integer","format":"int32","default":10}},{"name":"username","in":"query","description":"The user login name","required":false,"schema":{"type":"string"}},{"name":"callingStationId","in":"query","description":"The calling station ID","required":false,"schema":{"type":"string"}},{"name":"startTime","in":"query","description":"The start time to query, epoch time in milliseconds since 1/1/1970, default is 0 if not specified or is negative","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"endTime","in":"query","description":"The end time to query, epoch time in milliseconds since 1/1/1970, default is now if not specified or is negative","required":false,"schema":{"type":"integer","format":"int64"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqAccountingLog"}}}}},"security":[{"BearerAuth":[]}]}},"/locations/tree":{"get":{"tags":["Location"],"summary":"Get location tree","description":"Get location hierarchical tree.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_location_tree"},"operationId":"getLocationTree","parameters":[{"name":"parentId","in":"query","description":"The parent location ID, return root locations if parent is null","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"expandChildren","in":"query","description":"Whether to return the child locations recursively, default is true.\nSet it to false to improve performance when there are a lot of child locations.","required":false,"schema":{"type":"boolean","default":true}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/XiqLocation"}}}}}},"security":[{"BearerAuth":[]}]}},"/locations/tree/maps":{"get":{"tags":["Location"],"summary":"Get maps on the location hierarchy.","description":"Get maps on the location hierarchy with pagination.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_location_tree_maps"},"operationId":"getLocationMapsList","parameters":[{"name":"page","in":"query","description":"Page number, min = 1","required":false,"schema":{"minimum":1,"type":"integer","format":"int32","default":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 100","required":false,"schema":{"maximum":100,"minimum":1,"type":"integer","format":"int32","default":10}},{"name":"locationId","in":"query","description":"The location ID, or null for all locations.","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"expandChildren","in":"query","description":"Whether to return the child locations recursively, default is true.\nSet it to false to improve performance when there are a lot of child locations.","required":false,"schema":{"type":"boolean","default":true}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqLocationTreeMap"}}}}},"security":[{"BearerAuth":[]}]}},"/locations/tree/devices":{"get":{"tags":["Location"],"summary":"Get devices on the location hierarchy.","description":"Get devices on the location hierarchy with pagination.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_location_tree_devices"},"operationId":"getLocationDevicesList","parameters":[{"name":"page","in":"query","description":"Page number, min = 1","required":false,"schema":{"minimum":1,"type":"integer","format":"int32","default":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 100","required":false,"schema":{"maximum":100,"minimum":1,"type":"integer","format":"int32","default":10}},{"name":"locationId","in":"query","description":"The location ID, or null for all locations.","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"expandChildren","in":"query","description":"Whether to return the child locations recursively, default is true.\nSet it to false to improve performance when there are a lot of child locations.","required":false,"schema":{"type":"boolean","default":true}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqLocationTreeDevice"}}}}},"security":[{"BearerAuth":[]}]}},"/licenses":{"get":{"tags":["License"],"summary":"List licenses","description":"List licenses with filters.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_list_licenses"},"operationId":"listLicenses","parameters":[{"name":"applicationId","in":"query","description":"Application ID","required":false,"schema":{"type":"string"}},{"name":"groupByApplication","in":"query","description":"Whether group by application, if applicationId is null, groupByApplication will be false","required":false,"schema":{"type":"boolean","default":false}},{"name":"keyword","in":"query","description":"The keyword to filter, will search the feature type and feature type description","required":false,"schema":{"type":"string"}},{"name":"quickFilter","in":"query","description":"Quick filter option","required":false,"schema":{"$ref":"#/components/schemas/XiqLicenseQuickFilter"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/XiqListLicensesResponse"}}}}}},"security":[{"BearerAuth":[]}]}},"/licenses/{licenseType}":{"get":{"tags":["License"],"summary":"List license details","description":"List license details with filters.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_list_license_details"},"operationId":"listLicenseDetails","parameters":[{"name":"licenseType","in":"path","description":"The license type","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Page number, min = 1","required":false,"schema":{"minimum":1,"type":"integer","format":"int32","default":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 100","required":false,"schema":{"maximum":100,"minimum":1,"type":"integer","format":"int32","default":10}},{"name":"quickFilter","in":"query","description":"Quick filter option","required":false,"schema":{"$ref":"#/components/schemas/XiqLicenseQuickFilter"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqListLicenseDetailsResponse"}}}}},"security":[{"BearerAuth":[]}]}},"/licenses/viq-cuid-info":{"get":{"tags":["License"],"summary":"Get VIQ linked CUID info","description":"Get the VIQ-Extreme Portal Account link CUID information.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_viq_cuid_info"},"operationId":"getViqLinkedCuidInfo","responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqViqLinkedCuidInfo"}}}}},"security":[{"BearerAuth":[]}]}},"/licenses/summary":{"get":{"tags":["License"],"summary":"Get license summary","description":"Get license summary.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_license_summary"},"operationId":"getLicenseSummary","responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqLicenseSummary"}}}}},"security":[{"BearerAuth":[]}]}},"/licenses/extreme-portal-link-param":{"get":{"tags":["License"],"summary":"Get Extreme portal account link parameter","description":"Get the VIQ-Extreme portal account link parameter.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_extreme_portal_link_param"},"operationId":"getExtremePortalLinkParam","parameters":[{"name":"url","in":"query","description":"After linking operation, which web page to redirect to","required":true,"schema":{"type":"string"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqExtremePortalLinkParam"}}}}},"security":[{"BearerAuth":[]}]}},"/licenses/application-filter":{"get":{"tags":["License"],"summary":"Get application filter","description":"Get the application filter for listing licenses.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_application_filter"},"operationId":"getApplicationFilter","responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/XiqApplicationFilterItem"}}}}}},"security":[{"BearerAuth":[]}]}},"/l3-address-profiles":{"get":{"tags":["Configuration - Policy"],"summary":"List L3 address profiles","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","required":true,"schema":{"type":"string","enum":["L3_ADDRESS_TYPE_UNSPECIFIED","L3_ADDRESS_TYPE_IP_ADDRESS","L3_ADDRESS_TYPE_IP_SUBNET","L3_ADDRESS_TYPE_IP_RANGE","UNRECOGNIZED"]}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/XiqL3AddressProfile"}}}}}},"security":[{"BearerAuth":[]}]}},"/hiq/status":{"get":{"tags":["HIQ"],"summary":"Get HIQ status","description":"Get Hierarchical ExtremeCloud IQ (HIQ) status.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_hiq_status"},"operationId":"getHiqStatus","responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqHiqStatus"}}}}},"security":[{"BearerAuth":[]}]}},"/essentials/eloc/clients/{clientMac}/last-known-location":{"get":{"tags":["Essentials - ExtremeLocation"],"summary":"Get the last known location of the client","description":"Get the last known location of the client on the floor plan.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_last_known_location_of_the_client"},"operationId":"getClientLastLocation","parameters":[{"name":"clientMac","in":"path","description":"The mac address of client","required":true,"schema":{"type":"string"}},{"name":"floorId","in":"query","description":"Location Id of the floor","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"parentId","in":"query","description":"Location Id of the floor's parent","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EssentialsElocLastKnownLocation"}}}}},"security":[{"BearerAuth":[]}]}},"/email-templates":{"get":{"tags":["Configuration - User Management"],"summary":"List Email templates","description":"List all Email notification templates.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_list_email_templates"},"operationId":"listEmailTemplates","parameters":[{"name":"passwordType","in":"query","description":"The password type","required":false,"schema":{"$ref":"#/components/schemas/XiqPasswordType"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/XiqEmailTemplate"}}}}}},"security":[{"BearerAuth":[]}]}},"/devices":{"get":{"tags":["Device"],"summary":"[LRO] List devices","description":"List devices with filters and pagination.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_device_list"},"operationId":"listDevices","parameters":[{"name":"page","in":"query","description":"Page number, min = 1","required":false,"schema":{"minimum":1,"type":"integer","format":"int32","default":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 100","required":false,"schema":{"maximum":100,"minimum":1,"type":"integer","format":"int32","default":10}},{"name":"locationId","in":"query","description":"Location Id","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"connected","in":"query","description":"The device connect status","required":false,"schema":{"type":"boolean"}},{"name":"adminStates","in":"query","description":"The device admin states","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/XiqDeviceAdminState"}}},{"name":"macAddresses","in":"query","description":"The device mac addresses","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"sns","in":"query","description":"The device serial numbers","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"hostnames","in":"query","description":"The device host names","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"sortField","in":"query","description":"The sort field","required":false,"schema":{"$ref":"#/components/schemas/XiqDeviceSortField"}},{"name":"order","in":"query","description":"The sort order (ascending by default)","required":false,"schema":{"$ref":"#/components/schemas/XiqSortOrder"}},{"name":"views","in":"query","description":"The views to return device fields (Check fields for each view at XiqDeviceView schema)","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/XiqDeviceView"}}},{"name":"fields","in":"query","description":"The device fields to return","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/XiqDeviceField"}}},{"name":"deviceTypes","in":"query","description":"The device types to return","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/XiqDeviceType"},"default":["REAL"]}},{"name":"nullField","in":"query","description":"The device empty field, only returns the selected field that is null","required":false,"schema":{"$ref":"#/components/schemas/XiqDeviceNullField"}},{"name":"locationIds","in":"query","description":"The location IDs","required":false,"schema":{"type":"array","items":{"type":"integer","format":"int64"}}},{"name":"async","in":"query","description":"Whether to enable async mode","required":false,"schema":{"type":"boolean","default":false}},{"name":"configMismatch","in":"query","description":"Config audit status(MATCHED(false) or UNMATCHED(true))","required":false,"schema":{"type":"boolean"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqDevice"}}}}},"security":[{"BearerAuth":[]}]}},"/devices/{id}":{"get":{"tags":["Device"],"summary":"Get device info for a specific device","description":"Get device info for a specific device.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_device_details_for_one_device"},"operationId":"getDevice","parameters":[{"name":"id","in":"path","description":"The device ID","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"views","in":"query","description":"The views to return device fields (Check details at XiqDeviceView schema)","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/XiqDeviceView"}}},{"name":"fields","in":"query","description":"The device fields to return","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/XiqDeviceField"}}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqDevice"}}}}},"security":[{"BearerAuth":[]}]},"delete":{"tags":["Device"],"summary":"Delete a device","description":"Delete a specific device.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_delete_device"},"operationId":"deleteDevice","parameters":[{"name":"id","in":"path","description":"The device ID","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"force_delete","in":"query","description":"Force deletion of device","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK"}},"security":[{"BearerAuth":[]}]}},"/devices/{id}/ssid/status":{"get":{"tags":["Device"],"summary":"Get SSID status for a device","description":"Get the SSIDs status on each wifi interface for a specific device.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_device_level_ssid_status_on_each_wifi_interface"},"operationId":"getDeviceLevelSsidStatus","parameters":[{"name":"id","in":"path","description":"The device ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/XiqDeviceLevelSsidStatus"}}}}}},"security":[{"BearerAuth":[]}]}},"/devices/{id}/monitor/vlan-ipv4-intf":{"get":{"tags":["Device"],"summary":"Get VLAN IPv4 Interfaces per VLAN for a device","description":"Get VLAN IPv4 Interfaces that are monitored per VLAN for a device.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_device_monitor_vlan_ipv4_interfaces_per_vlan"},"operationId":"ListDeviceMonitorVlanIpv4Interfaces","parameters":[{"name":"id","in":"path","description":"Device ID","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"page","in":"query","description":"Page number, min = 1","required":false,"schema":{"minimum":1,"type":"integer","format":"int32","default":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 2048","required":false,"schema":{"maximum":2048,"minimum":1,"type":"integer","format":"int32","default":10}},{"name":"sortBy","in":"query","description":"Sort field (VLAN_ID by default)","required":false,"schema":{"$ref":"#/components/schemas/XiqDeviceVlanIpv4InterfacesSortField"}},{"name":"sortOrder","in":"query","description":"Sort order (Ascending by default)","required":false,"schema":{"$ref":"#/components/schemas/XiqSortOrder"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqDeviceMonitorVlanIpv4Interfaces"}}}}},"security":[{"BearerAuth":[]}]}},"/devices/{id}/monitor/vlan-attr":{"get":{"tags":["Device"],"summary":"Get VLAN attributes per VLAN for a device","description":"Get VLAN attributes that are monitored per VLAN for a device.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_device_monitor_vlan_attributes_per_vlan"},"operationId":"ListDeviceMonitorVlanAttributes","parameters":[{"name":"id","in":"path","description":"Device ID","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"page","in":"query","description":"Page number, min = 1","required":false,"schema":{"minimum":1,"type":"integer","format":"int32","default":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 4095","required":false,"schema":{"maximum":4095,"minimum":1,"type":"integer","format":"int32","default":10}},{"name":"sortBy","in":"query","description":"Sort field (VLAN_ID by default)","required":false,"schema":{"$ref":"#/components/schemas/XiqDeviceVlanSortField"}},{"name":"sortOrder","in":"query","description":"Sort order (Ascending by default)","required":false,"schema":{"$ref":"#/components/schemas/XiqSortOrder"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqDeviceMonitorVlanAttributes"}}}}},"security":[{"BearerAuth":[]}]}},"/devices/{id}/monitor/ipv4-routing":{"get":{"tags":["Device"],"summary":"Get IPv4 Routing information for a device","description":"Get IPv4 Routing information that is monitored for a device.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_device_monitor_ipv4_routing_per_device"},"operationId":"ListDeviceMonitorIpv4Routing","parameters":[{"name":"id","in":"path","description":"Device ID","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"page","in":"query","description":"Page number, min = 1","required":false,"schema":{"minimum":1,"type":"integer","format":"int32","default":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 100","required":false,"schema":{"maximum":100,"minimum":1,"type":"integer","format":"int32","default":10}},{"name":"sortBy","in":"query","description":"Sort field (DESTINATION by default)","required":false,"schema":{"$ref":"#/components/schemas/XiqDeviceIpv4RoutingSortField"}},{"name":"sortOrder","in":"query","description":"Sort order (Ascending by default)","required":false,"schema":{"$ref":"#/components/schemas/XiqSortOrder"}},{"name":"routeOrigin","in":"query","description":"Route Origin (ALL by default)","required":false,"schema":{"$ref":"#/components/schemas/XiqDeviceIpv4RoutingRouteOriginField"}},{"name":"status","in":"query","description":"Status (ALL by default)","required":false,"schema":{"$ref":"#/components/schemas/XiqDeviceIpv4RoutingStatusField"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqDeviceMonitorIpv4Routing"}}}}},"security":[{"BearerAuth":[]}]}},"/devices/{id}/monitor/ipv4-routing-timeline":{"get":{"tags":["Device"],"summary":"Get IPv4 Routing Timeline information per Routing Instance for a device","description":"Get IPv4 Routing Summary Timeline information per Routing Instance that is monitored for a device.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_device_monitor_ipv4_routing_timeline_per_device"},"operationId":"ListDeviceMonitorIpv4RoutingTimeline","parameters":[{"name":"id","in":"path","description":"Device ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqDeviceMonitorIpv4RoutingTimeline"}}}}},"security":[{"BearerAuth":[]}]}},"/devices/{id}/interfaces/wifi":{"get":{"tags":["Device"],"summary":"Get the device WiFi interfaces stats","description":"Get the device WiFi interfaces stats by device ID.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_device_wifi_interface_stats"},"operationId":"getDeviceWifiInterface","parameters":[{"name":"id","in":"path","description":"The device ID","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"startTime","in":"query","description":"The start time for collecting the wifi interfaces stat","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"endTime","in":"query","description":"The end time for collecting the wifi interfaces stat","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/XiqDeviceWifiInterface"}}}}}},"security":[{"BearerAuth":[]}]}},"/devices/{id}/installation-report":{"get":{"tags":["Device"],"summary":"Get device installation report","description":"Get device installation report of a specific device.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_device_installation_report"},"operationId":"getXiqDeviceInstallationReport","parameters":[{"name":"id","in":"path","description":"The device ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqDeviceInstallationReport"}}}}},"security":[{"BearerAuth":[]}]}},"/devices/{id}/ibeacon":{"get":{"tags":["Device"],"summary":"Get the device iBeacon setting","description":"Get the device iBeacon setting by device ID.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_device_ibeacon"},"operationId":"getDeviceIbeacon","parameters":[{"name":"id","in":"path","description":"The device ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqDeviceIbeacon"}}}}},"security":[{"BearerAuth":[]}]}},"/devices/{id}/history/cpu-mem":{"get":{"tags":["Device"],"summary":"Get device CPU/memory usage history","description":"Get average device CPU and memory usage history.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_device_cpu_and_memory_usage_for_one_device"},"operationId":"getDeviceCpuMemoryHistory","parameters":[{"name":"id","in":"path","description":"Device ID","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"startTime","in":"query","description":"The start time to query, epoch time in milliseconds since 1/1/1970","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"endTime","in":"query","description":"The end time to query, epoch time in milliseconds since 1/1/1970","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"interval","in":"query","description":"The aggregate interval in milliseconds","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/XiqDeviceCpuMemoryUsage"}}}}}},"security":[{"BearerAuth":[]}]}},"/devices/{id}/gallery-image":{"get":{"tags":["Device"],"summary":"Download device gallery image.","description":"Download the image file from the device media gallery.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_download_device_gallery_image"},"operationId":"downloadDeviceGalleryImage","parameters":[{"name":"id","in":"path","description":"The device ID","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"imageName","in":"query","description":"The image name","required":true,"schema":{"type":"string"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}}},"security":[{"BearerAuth":[]}]}},"/devices/{id}/alarms":{"get":{"tags":["Device"],"summary":"List alarms for a device","description":"List alarms for a specific device.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_device_alarms_for_one_device"},"operationId":"listDeviceAlarm","parameters":[{"name":"id","in":"path","description":"Device ID","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"page","in":"query","description":"Page number, min = 1","required":false,"schema":{"minimum":1,"type":"integer","format":"int32","default":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 100","required":false,"schema":{"maximum":100,"minimum":1,"type":"integer","format":"int32","default":10}},{"name":"startTime","in":"query","description":"The start time for query alarm","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"endTime","in":"query","description":"The end time for query alarm","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqDeviceAlarm"}}}}},"security":[{"BearerAuth":[]}]}},"/devices/stats":{"get":{"tags":["Device"],"summary":"Get device stats","description":"Get device stats, such as total device count, managed device count, connected device count, etc.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_list_device_status_summary"},"operationId":"getDeviceStats","parameters":[{"name":"locationId","in":"query","description":"The location ID","required":false,"schema":{"type":"integer","format":"int64"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqDeviceStats"}}}}},"security":[{"BearerAuth":[]}]}},"/devices/radio-information":{"get":{"tags":["Device"],"summary":"Get Devices Radio Information","description":"Get client radios information of the devices.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_list_devices_radio_information"},"operationId":"listDevicesRadioInformation","parameters":[{"name":"page","in":"query","description":"Page number, min = 1","required":false,"schema":{"minimum":1,"type":"integer","format":"int32","default":1}},{"name":"limit","in":"query","description":"Number of Records, min = 1, max = 50","required":false,"schema":{"maximum":50,"minimum":1,"type":"integer","format":"int32","default":10}},{"name":"deviceIds","in":"query","description":"the list of devices","required":true,"schema":{"type":"array","items":{"type":"integer","format":"int64"}}},{"name":"includeDisabledRadio","in":"query","description":"Include Disabled Radios","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqRadioEntity"}}}}},"security":[{"BearerAuth":[]}]}},"/devices/network-policy/{policyId}":{"get":{"tags":["Device"],"summary":"List assigned devices for network policy","description":"List assigned devices for the network policy with pagination.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_list_assigned_devices_for_network_policy"},"operationId":"listDevicesByNetworkPolicy","parameters":[{"name":"policyId","in":"path","description":"The network policy ID","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"page","in":"query","description":"Page number, min = 1","required":false,"schema":{"minimum":1,"type":"integer","format":"int32","default":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 100","required":false,"schema":{"maximum":100,"minimum":1,"type":"integer","format":"int32","default":10}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqDevice"}}}}},"security":[{"BearerAuth":[]}]}},"/devices/digital-twin":{"get":{"tags":["Device"],"summary":"List Digital Twin product information.","description":"List of Digital Twin product information with pagination.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_list_digital_twin_products"},"operationId":"listDigitalTwinProducts","parameters":[{"name":"page","in":"query","description":"Page number, min = 1","required":false,"schema":{"minimum":1,"type":"integer","format":"int32","default":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 100","required":false,"schema":{"maximum":100,"minimum":1,"type":"integer","format":"int32","default":10}},{"name":"makes","in":"query","description":"List by makes or any with null/empty makes.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/XiqDigitalTwinMake"}}},{"name":"models","in":"query","description":"List by makes or any with null/empty models.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/XiqDigitalTwinModel"}}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqDigitalTwinProducts"}}}}},"security":[{"BearerAuth":[]}]}},"/deployments/status":{"get":{"tags":["Configuration - Deployment"],"summary":"Get configuration deployment status","description":"Get configuration deployment status for the target devices.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_configuration_deployment_status"},"operationId":"getDeployStatus","parameters":[{"name":"deviceIds","in":"query","description":"The target device IDs","required":true,"schema":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int64"}}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/XiqDeploymentStatus"}}}}}},"security":[{"BearerAuth":[]}]}},"/deployments/overview":{"get":{"tags":["Configuration - Deployment"],"summary":"Get configuration deployment overview","description":"Get configuration deployment status overview.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_configuration_deployment_overview"},"operationId":"getDeployOverview","responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqDeploymentOverview"}}}}},"security":[{"BearerAuth":[]}]}},"/cwps":{"get":{"tags":["Configuration - Authentication"],"summary":"List captive web portals","description":"List a page of Captive Web Portals.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_list_captive_web_portals"},"operationId":"listCaptiveWebPortals","parameters":[{"name":"page","in":"query","description":"Page number, min = 1","required":false,"schema":{"minimum":1,"type":"integer","format":"int32","default":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 100","required":false,"schema":{"maximum":100,"minimum":1,"type":"integer","format":"int32","default":10}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqCwp"}}}}},"security":[{"BearerAuth":[]}]}},"/countries":{"get":{"tags":["Misc"],"summary":"Get country list","description":"Get list of countries and country codes.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_country_list"},"operationId":"getCountryList","responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/XiqCountry"}}}}}},"security":[{"BearerAuth":[]}]}},"/countries/{countryCode}/:validate":{"get":{"tags":["Misc"],"summary":"Validate country code","description":"Validate whether the country code is a valid code or not.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_validate_country_code"},"operationId":"validateCountryCode","parameters":[{"name":"countryCode","in":"path","description":"The country code.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"type":"boolean"}}}}},"security":[{"BearerAuth":[]}]}},"/copilot/connectivity/wireless/views":{"get":{"tags":["Copilot - Connectivity Experience"],"operationId":"getWirelessViews","parameters":[{"name":"viewType","in":"query","description":"The type of View","required":true,"schema":{"$ref":"#/components/schemas/XiqWirelessViewsListType"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqWirelessViewsTypeResponse"}}}}},"security":[{"BearerAuth":[]}]}},"/copilot/connectivity/wireless/time-to-connect":{"get":{"tags":["Copilot - Connectivity Experience"],"operationId":"getWirelessTimeToConnect","parameters":[{"name":"viewType","in":"query","description":"The type of View","required":true,"schema":{"$ref":"#/components/schemas/XiqConnectivityExperienceViewType"}},{"name":"startTime","in":"query","description":"The start time to query, epoch time in milliseconds since 1/1/1970","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"endTime","in":"query","description":"The end time to query, epoch time in milliseconds since 1/1/1970","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"viewId","in":"query","description":"The view type identifier","required":false,"schema":{"type":"string","default":""}},{"name":"forensicBucket","in":"query","description":"The time period bucket detected","required":false,"schema":{"$ref":"#/components/schemas/XiqForensicBucket"}},{"name":"locationId","in":"query","description":"The location identifier","required":false,"schema":{"type":"string","default":"0"}},{"name":"locationType","in":"query","description":"The location type","required":false,"schema":{"type":"string"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqWirelessTimeToConnectResponse"}}}}},"security":[{"BearerAuth":[]}]}},"/copilot/connectivity/wireless/quality-index":{"get":{"tags":["Copilot - Connectivity Experience"],"operationId":"getWirelessQualityIndex","parameters":[{"name":"viewType","in":"query","description":"The type of View","required":true,"schema":{"$ref":"#/components/schemas/XiqConnectivityExperienceViewType"}},{"name":"startTime","in":"query","description":"The start time to query, epoch time in milliseconds since 1/1/1970","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"endTime","in":"query","description":"The end time to query, epoch time in milliseconds since 1/1/1970","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"viewId","in":"query","description":"The view type identifier","required":false,"schema":{"type":"string","default":""}},{"name":"forensicBucket","in":"query","description":"The time period bucket detected","required":false,"schema":{"$ref":"#/components/schemas/XiqForensicBucket"}},{"name":"locationId","in":"query","description":"The location identifier","required":false,"schema":{"type":"string","default":"0"}},{"name":"locationType","in":"query","description":"The location type","required":false,"schema":{"type":"string"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqWirelessQualityIndexResponse"}}}}},"security":[{"BearerAuth":[]}]}},"/copilot/connectivity/wireless/performance":{"get":{"tags":["Copilot - Connectivity Experience"],"operationId":"getWirelessPerformance","parameters":[{"name":"viewType","in":"query","description":"The type of View","required":true,"schema":{"$ref":"#/components/schemas/XiqConnectivityExperienceViewType"}},{"name":"startTime","in":"query","description":"The start time to query, epoch time in milliseconds since 1/1/1970","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"endTime","in":"query","description":"The end time to query, epoch time in milliseconds since 1/1/1970","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"viewId","in":"query","description":"The view type identifier","required":false,"schema":{"type":"string","default":""}},{"name":"forensicBucket","in":"query","description":"The time period bucket detected","required":false,"schema":{"$ref":"#/components/schemas/XiqForensicBucket"}},{"name":"locationId","in":"query","description":"The location identifier","required":false,"schema":{"type":"string","default":"0"}},{"name":"locationType","in":"query","description":"The location type","required":false,"schema":{"type":"string","default":""}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqWirelessConnectivityPerformanceResponse"}}}}},"security":[{"BearerAuth":[]}]}},"/copilot/connectivity/wireless/locations/time-to-connect":{"get":{"tags":["Copilot - Connectivity Experience"],"operationId":"getWirelessTimeToConnectByLocation","parameters":[{"name":"locationId","in":"query","description":"The location identifier","required":true,"schema":{"type":"string"}},{"name":"ssid","in":"query","description":"The ssid","required":false,"schema":{"type":"string","default":""}},{"name":"osType","in":"query","description":"The client type","required":false,"schema":{"type":"string","default":""}},{"name":"startTime","in":"query","description":"The start time to query, epoch time in milliseconds since 1/1/1970","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"endTime","in":"query","description":"The end time to query, epoch time in milliseconds since 1/1/1970","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"forensicBucket","in":"query","description":"The time period bucket detected","required":false,"schema":{"$ref":"#/components/schemas/XiqForensicBucket"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqWirelessTimeToConnectResponse"}}}}},"security":[{"BearerAuth":[]}]}},"/copilot/connectivity/wireless/locations/quality-index":{"get":{"tags":["Copilot - Connectivity Experience"],"operationId":"getWirelessQualityIndexByLocation","parameters":[{"name":"locationId","in":"query","description":"The location identifier","required":true,"schema":{"type":"string"}},{"name":"ssid","in":"query","description":"The ssid","required":false,"schema":{"type":"string","default":""}},{"name":"osType","in":"query","description":"The os type","required":false,"schema":{"type":"string","default":""}},{"name":"startTime","in":"query","description":"The start time to query, epoch time in milliseconds since 1/1/1970","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"endTime","in":"query","description":"The end time to query, epoch time in milliseconds since 1/1/1970","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"forensicBucket","in":"query","description":"The time period bucket detected","required":false,"schema":{"$ref":"#/components/schemas/XiqForensicBucket"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqWirelessQualityIndexByLocationResponse"}}}}},"security":[{"BearerAuth":[]}]}},"/copilot/connectivity/wireless/locations/performance":{"get":{"tags":["Copilot - Connectivity Experience"],"operationId":"getWirelessPerformanceByLocation","parameters":[{"name":"locationId","in":"query","description":"The location identifier","required":true,"schema":{"type":"string"}},{"name":"ssid","in":"query","description":"The ssid","required":false,"schema":{"type":"string","default":""}},{"name":"osType","in":"query","description":"The client type","required":false,"schema":{"type":"string","default":""}},{"name":"startTime","in":"query","description":"The start time to query, epoch time in milliseconds since 1/1/1970","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"endTime","in":"query","description":"The end time to query, epoch time in milliseconds since 1/1/1970","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"forensicBucket","in":"query","description":"The time period bucket detected","required":false,"schema":{"$ref":"#/components/schemas/XiqForensicBucket"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqWirelessConnectivityPerformanceResponse"}}}}},"security":[{"BearerAuth":[]}]}},"/copilot/connectivity/wireless/locations/events":{"get":{"tags":["Copilot - Connectivity Experience"],"operationId":"getWirelessEventsByLocation","parameters":[{"name":"page","in":"query","description":"Page number, min = 1","required":false,"schema":{"minimum":1,"type":"integer","format":"int32","default":1}},{"name":"limit","in":"query","description":"Number of Records, min = 1, max = 100","required":false,"schema":{"maximum":100,"minimum":1,"type":"integer","format":"int32","default":10}},{"name":"startTime","in":"query","description":"The start time to query, epoch time in milliseconds since 1/1/1970","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"endTime","in":"query","description":"The end time to query, epoch time in milliseconds since 1/1/1970","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"sortField","in":"query","description":"the sort field","required":false,"schema":{"$ref":"#/components/schemas/XiqCopilotEventsWirelessSortField"}},{"name":"sortOrder","in":"query","description":"The sorting order","required":false,"schema":{"$ref":"#/components/schemas/XiqSortOrder"}},{"name":"scoreType","in":"query","description":"The wireless score type","required":true,"schema":{"$ref":"#/components/schemas/XiqCopilotWirelessEventsScoreType"}},{"name":"forensicBucket","in":"query","description":"The time period bucket detected","required":false,"schema":{"$ref":"#/components/schemas/XiqForensicBucket"}},{"name":"searchKey","in":"query","description":"The search key","required":false,"schema":{"type":"string","default":""}},{"name":"locationId","in":"query","description":"The location identifier","required":true,"schema":{"type":"string"}},{"name":"timestamp","in":"query","description":"The timestamp to query, epoch time in milliseconds since 1/1/1970","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"ssid","in":"query","description":"The ssid","required":false,"schema":{"type":"string","default":""}},{"name":"osType","in":"query","description":"The os type","required":false,"schema":{"type":"string","default":""}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqCopilotWirelessEvent"}}}}},"security":[{"BearerAuth":[]}]}},"/copilot/connectivity/wireless/experience":{"get":{"tags":["Copilot - Connectivity Experience"],"operationId":"getWirelessConnectivityExperience","parameters":[{"name":"viewType","in":"query","description":"View by location, ssid or osTypes","required":true,"schema":{"$ref":"#/components/schemas/XiqConnectivityExperienceViewType"}},{"name":"page","in":"query","description":"Page number, min = 1","required":false,"schema":{"minimum":1,"type":"integer","format":"int32","default":1}},{"name":"limit","in":"query","description":"Number of Records, min = 1, max = 100","required":false,"schema":{"maximum":100,"minimum":1,"type":"integer","format":"int32","default":10}},{"name":"startTime","in":"query","description":"The start time to query, epoch time in milliseconds since 1/1/1970","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"endTime","in":"query","description":"The end time to query, epoch time in milliseconds since 1/1/1970","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"sortField","in":"query","description":"sort by name or quality index","required":false,"schema":{"$ref":"#/components/schemas/XiqSortField"}},{"name":"sortOrder","in":"query","description":"The sorting order","required":false,"schema":{"$ref":"#/components/schemas/XiqSortOrder"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqConnectivityExperienceData"}}}}},"security":[{"BearerAuth":[]}]}},"/copilot/connectivity/wireless/events":{"get":{"tags":["Copilot - Connectivity Experience"],"operationId":"getWirelessEvents","parameters":[{"name":"viewType","in":"query","description":"View by location, ssid or osTypes","required":true,"schema":{"$ref":"#/components/schemas/XiqConnectivityExperienceViewType"}},{"name":"page","in":"query","description":"Page number, min = 1","required":false,"schema":{"minimum":1,"type":"integer","format":"int32","default":1}},{"name":"limit","in":"query","description":"Number of Records, min = 1, max = 100","required":false,"schema":{"maximum":100,"minimum":1,"type":"integer","format":"int32","default":10}},{"name":"startTime","in":"query","description":"The start time to query, epoch time in milliseconds since 1/1/1970","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"endTime","in":"query","description":"The end time to query, epoch time in milliseconds since 1/1/1970","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"sortField","in":"query","description":"the sort field","required":false,"schema":{"$ref":"#/components/schemas/XiqCopilotEventsWirelessSortField"}},{"name":"sortOrder","in":"query","description":"The sorting order","required":false,"schema":{"$ref":"#/components/schemas/XiqSortOrder"}},{"name":"viewId","in":"query","description":"The view type identifier","required":false,"schema":{"type":"string","default":""}},{"name":"scoreType","in":"query","description":"The wireless score type","required":true,"schema":{"$ref":"#/components/schemas/XiqCopilotWirelessEventsScoreType"}},{"name":"forensicBucket","in":"query","description":"The time period bucket detected","required":false,"schema":{"$ref":"#/components/schemas/XiqForensicBucket"}},{"name":"searchKey","in":"query","description":"The search key","required":false,"schema":{"type":"string","default":""}},{"name":"locationId","in":"query","description":"The location identifier","required":false,"schema":{"type":"string","default":"0"}},{"name":"locationType","in":"query","description":"The location type","required":false,"schema":{"type":"string"}},{"name":"timestamp","in":"query","description":"The timestamp to query, epoch time in milliseconds since 1/1/1970","required":false,"schema":{"type":"integer","format":"int64"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqCopilotWirelessEvent"}}}}},"security":[{"BearerAuth":[]}]}},"/copilot/connectivity/wireless/apps":{"get":{"tags":["Copilot - Connectivity Experience"],"operationId":"getWirelessApps","parameters":[{"name":"viewType","in":"query","description":"The type of View","required":true,"schema":{"$ref":"#/components/schemas/XiqConnectivityExperienceViewType"}},{"name":"startTime","in":"query","description":"The start time to query, epoch time in milliseconds since 1/1/1970","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"endTime","in":"query","description":"The end time to query, epoch time in milliseconds since 1/1/1970","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"viewId","in":"query","description":"The view type identifier","required":false,"schema":{"type":"string","default":""}},{"name":"forensicBucket","in":"query","description":"The time period bucket detected","required":false,"schema":{"$ref":"#/components/schemas/XiqForensicBucket"}},{"name":"locationId","in":"query","description":"The location identifier","required":false,"schema":{"type":"string","default":"0"}},{"name":"locationType","in":"query","description":"The location type","required":false,"schema":{"type":"string","default":""}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqWirelessAppsResponse"}}}}},"security":[{"BearerAuth":[]}]}},"/copilot/connectivity/wired/quality-index":{"get":{"tags":["Copilot - Connectivity Experience"],"operationId":"getWiredQualityIndex","parameters":[{"name":"viewType","in":"query","description":"The type of View","required":false,"schema":{"$ref":"#/components/schemas/XiqWiredViewType"}},{"name":"startTime","in":"query","description":"The start time to query, epoch time in milliseconds since 1/1/1970","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"endTime","in":"query","description":"The end time to query, epoch time in milliseconds since 1/1/1970","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"viewId","in":"query","description":"The view id based on view type","required":false,"schema":{"type":"string","default":""}},{"name":"forensicBucket","in":"query","description":"The selected time bucket","required":false,"schema":{"$ref":"#/components/schemas/XiqForensicBucket"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqWiredQualityIndexResponse"}}}}},"security":[{"BearerAuth":[]}]}},"/copilot/connectivity/wired/locations/hardware":{"get":{"tags":["Copilot - Connectivity Experience"],"operationId":"getWiredHardwareByLocation","parameters":[{"name":"viewType","in":"query","description":"The type of View","required":false,"schema":{"$ref":"#/components/schemas/XiqWiredViewType"}},{"name":"startTime","in":"query","description":"The start time to query, epoch time in milliseconds since 1/1/1970","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"endTime","in":"query","description":"The end time to query, epoch time in milliseconds since 1/1/1970","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"viewId","in":"query","description":"The view id based on view type","required":false,"schema":{"type":"string","default":""}},{"name":"forensicBucket","in":"query","description":"The selected time bucket","required":true,"schema":{"$ref":"#/components/schemas/XiqForensicBucket"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqWiredHardwareByLocationResponse"}}}}},"security":[{"BearerAuth":[]}]}},"/copilot/connectivity/wired/hardware":{"get":{"tags":["Copilot - Connectivity Experience"],"operationId":"getWiredHardware","parameters":[{"name":"viewType","in":"query","description":"The type of View","required":true,"schema":{"$ref":"#/components/schemas/XiqWiredViewType"}},{"name":"startTime","in":"query","description":"The start time to query, epoch time in milliseconds since 1/1/1970","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"endTime","in":"query","description":"The end time to query, epoch time in milliseconds since 1/1/1970","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"viewId","in":"query","description":"The view id based on view type","required":false,"schema":{"type":"string","default":""}},{"name":"forensicBucket","in":"query","description":"The selected time bucket","required":true,"schema":{"$ref":"#/components/schemas/XiqForensicBucket"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqWiredHardwareResponse"}}}}},"security":[{"BearerAuth":[]}]}},"/copilot/connectivity/wired/experience":{"get":{"tags":["Copilot - Connectivity Experience"],"operationId":"getWiredConnectivityExperience","parameters":[{"name":"viewType","in":"query","description":"The type of View","required":true,"schema":{"$ref":"#/components/schemas/XiqWiredViewType"}},{"name":"startTime","in":"query","description":"The start time to query, epoch time in milliseconds since 1/1/1970","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"endTime","in":"query","description":"The end time to query, epoch time in milliseconds since 1/1/1970","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"page","in":"query","description":"Page number, min = 1","required":false,"schema":{"type":"integer","format":"int32","default":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 100","required":false,"schema":{"type":"integer","format":"int32","default":10}},{"name":"sortField","in":"query","description":"sort by name or quality index","required":false,"schema":{"$ref":"#/components/schemas/XiqSortField"}},{"name":"sortOrder","in":"query","description":"The sorting order","required":false,"schema":{"$ref":"#/components/schemas/XiqSortOrder"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqConnectivityExperienceData"}}}}},"security":[{"BearerAuth":[]}]}},"/copilot/connectivity/wired/events":{"get":{"tags":["Copilot - Connectivity Experience"],"operationId":"getWiredEvents","parameters":[{"name":"viewType","in":"query","description":"The type of View","required":true,"schema":{"$ref":"#/components/schemas/XiqWiredViewType"}},{"name":"startTime","in":"query","description":"The start time to query, epoch time in milliseconds since 1/1/1970","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"endTime","in":"query","description":"The end time to query, epoch time in milliseconds since 1/1/1970","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"page","in":"query","description":"Page number, min = 1","required":false,"schema":{"type":"integer","format":"int32","default":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 100","required":false,"schema":{"type":"integer","format":"int32","default":10}},{"name":"sortBy","in":"query","description":"The sort field","required":false,"schema":{"$ref":"#/components/schemas/XiqCopilotEventsWiredSortField"}},{"name":"sortOrder","in":"query","description":"The sorting order","required":false,"schema":{"$ref":"#/components/schemas/XiqSortOrder"}},{"name":"viewId","in":"query","description":"The view id based on view type","required":false,"schema":{"type":"string","default":""}},{"name":"forensicBucket","in":"query","description":"The selected time bucket","required":true,"schema":{"$ref":"#/components/schemas/XiqForensicBucket"}},{"name":"scoreType","in":"query","description":"The selected score type","required":true,"schema":{"$ref":"#/components/schemas/XiqCopilotWiredEventsScoreType"}},{"name":"searchKey","in":"query","description":"The selected search key","required":false,"schema":{"type":"string","default":""}},{"name":"locationType","in":"query","description":"The selected location type","required":false,"schema":{"type":"string","default":""}},{"name":"locationId","in":"query","description":"The selected location id","required":false,"schema":{"type":"string","default":"0"}},{"name":"timestamp","in":"query","description":"The timestamp to query, epoch time in milliseconds since 1/1/1970","required":false,"schema":{"type":"integer","format":"int64"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqWiredEventEntity"}}}}},"security":[{"BearerAuth":[]}]}},"/copilot/connectivity/locations":{"get":{"tags":["Copilot - Connectivity Experience"],"operationId":"getConnectivityDetailsByLocations","parameters":[{"name":"startTime","in":"query","description":"The start time to query, epoch time in milliseconds since 1/1/1970","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"endTime","in":"query","description":"The end time to query, epoch time in milliseconds since 1/1/1970","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"page","in":"query","description":"Page number, min = 1","required":false,"schema":{"type":"integer","format":"int32","default":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 100","required":false,"schema":{"type":"integer","format":"int32","default":10}},{"name":"sortField","in":"query","description":"sort by name or quality index","required":false,"schema":{"$ref":"#/components/schemas/XiqSortField"}},{"name":"sortOrder","in":"query","description":"The sorting order","required":false,"schema":{"$ref":"#/components/schemas/XiqSortOrder"}},{"name":"locationId","in":"query","description":"The location Id","required":false,"schema":{"type":"integer","format":"int64","default":0}},{"name":"searchKey","in":"query","description":"The search value","required":false,"schema":{"type":"string","default":""}},{"name":"clientType","in":"query","description":"The client type","required":false,"schema":{"$ref":"#/components/schemas/XiqClientType"}},{"name":"forensicBucket","in":"query","description":"The time period bucket detected","required":false,"schema":{"$ref":"#/components/schemas/XiqForensicBucket"}},{"name":"qualityIndex","in":"query","description":"The quality index value","required":false,"schema":{"$ref":"#/components/schemas/XiqQualityIndex"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqConnectivityExperienceData"}}}}},"security":[{"BearerAuth":[]}]}},"/copilot/connectivity/client-type":{"get":{"tags":["Copilot - Connectivity Experience"],"operationId":"getConnectivityDetailsByClientType","parameters":[{"name":"startTime","in":"query","description":"The start time to query, epoch time in milliseconds since 1/1/1970","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"endTime","in":"query","description":"The end time to query, epoch time in milliseconds since 1/1/1970","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"locationId","in":"query","description":"The location Id","required":false,"schema":{"type":"integer","format":"int64","default":0}},{"name":"clientType","in":"query","description":"The client type","required":false,"schema":{"$ref":"#/components/schemas/XiqClientType"}},{"name":"forensicBucket","in":"query","description":"The time period bucket detected","required":false,"schema":{"$ref":"#/components/schemas/XiqForensicBucket"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqConnectivityDetailsByClientTypeResponse"}}}}},"security":[{"BearerAuth":[]}]}},"/copilot/assurance-scans/overview":{"get":{"tags":["Copilot - Anomalies"],"operationId":"getAssuranceScansOverviewData","responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqAssuranceScansOverviewResponse"}}}}},"security":[{"BearerAuth":[]}]}},"/copilot/anomalies/wifi-efficiency/stats":{"get":{"tags":["Copilot - Anomalies"],"operationId":"getWifiEfficiencyStats","parameters":[{"name":"anomalyId","in":"query","description":"The anomaly id","required":true,"schema":{"type":"string"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqWifiEfficiencyStatsResponse"}}}}},"security":[{"BearerAuth":[]}]}},"/copilot/anomalies/wifi-efficiency/client-list":{"get":{"tags":["Copilot - Anomalies"],"operationId":"getWifiEfficiencyClientList","parameters":[{"name":"deviceId","in":"query","description":"The device id","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"channel","in":"query","description":"The channel number","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"timestamp","in":"query","description":"The timestamp","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqWifiEfficiencyClientListResponse"}}}}},"security":[{"BearerAuth":[]}]}},"/copilot/anomalies/wifi-capacity/stats":{"get":{"tags":["Copilot - Anomalies"],"operationId":"getWifiCapacityStats","parameters":[{"name":"anomalyId","in":"query","description":"The anomaly id","required":true,"schema":{"type":"string"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqWifiCapacityStatsResponse"}}}}},"security":[{"BearerAuth":[]}]}},"/copilot/anomalies/wifi-capacity/client-list":{"get":{"tags":["Copilot - Anomalies"],"operationId":"getWifiCapacityClientList","parameters":[{"name":"deviceId","in":"query","description":"The device id","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"channel","in":"query","description":"The channel","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"timestamp","in":"query","description":"The timestamp","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqWifiCapacityClientListResponse"}}}}},"security":[{"BearerAuth":[]}]}},"/copilot/anomalies/report":{"get":{"tags":["Copilot - Anomalies"],"operationId":"getAnomaliesReport","parameters":[{"name":"startTime","in":"query","description":"The start time to query, epoch time in milliseconds since 1/1/1970","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"endTime","in":"query","description":"The end time to query, epoch time in milliseconds since 1/1/1970","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"anomalyType","in":"query","description":"The type of anomaly","required":false,"schema":{"$ref":"#/components/schemas/XiqAnomalyType"}},{"name":"buildingId","in":"query","description":"The location identifier","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"severity","in":"query","description":"The severity of anomaly","required":false,"schema":{"$ref":"#/components/schemas/XiqAnomalySeverity"}},{"name":"excludeMuted","in":"query","description":"Exclude muted anomalies","required":false,"schema":{"type":"boolean","default":false}},{"name":"sortField","in":"query","description":"The sorting field","required":false,"schema":{"$ref":"#/components/schemas/XiqAnomalySortField"}},{"name":"sortOrder","in":"query","description":"The sorting order","required":false,"schema":{"$ref":"#/components/schemas/XiqSortOrder"}},{"name":"searchKey","in":"query","description":"The search key","required":false,"schema":{"type":"string","default":""}},{"name":"fileType","in":"query","description":"The file format","required":false,"schema":{"type":"string","default":"csv"}},{"name":"offsetTime","in":"query","description":"The offset value","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string","format":"binary"}}}}},"security":[{"BearerAuth":[]}]}},"/copilot/anomalies/port-efficiency/stats":{"get":{"tags":["Copilot - Anomalies"],"operationId":"getPortEfficiencyStats","parameters":[{"name":"anomalyId","in":"query","description":"The anomaly id","required":true,"schema":{"type":"string"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqPortEfficiencyStatsResponse"}}}}},"security":[{"BearerAuth":[]}]}},"/copilot/anomalies/port-efficiency/speed-duplex-stats":{"get":{"tags":["Copilot - Anomalies"],"operationId":"getPortEfficiencySpeedDuplexStats","parameters":[{"name":"anomalyId","in":"query","description":"The anomaly id","required":true,"schema":{"type":"string"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqPortEfficiencySpeedDuplexStatsResponse"}}}}},"security":[{"BearerAuth":[]}]}},"/copilot/anomalies/poeflapping/stats":{"get":{"tags":["Copilot - Anomalies"],"operationId":"getPoeFlappingStats","parameters":[{"name":"anomalyId","in":"query","description":"The anomaly id","required":true,"schema":{"type":"string"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqPoeFlappingStatsResponse"}}}}},"security":[{"BearerAuth":[]}]}},"/copilot/anomalies/notifications":{"get":{"tags":["Copilot - Anomalies"],"operationId":"getAnomaliesNotifications","responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqAnomaliesNotificationsResponse"}}}}},"security":[{"BearerAuth":[]}]}},"/copilot/anomalies/locations":{"get":{"tags":["Copilot - Anomalies"],"operationId":"listAnomalyLocations","parameters":[{"name":"anomalyType","in":"query","description":"Anomaly type","required":false,"schema":{"$ref":"#/components/schemas/XiqAnomalyType"}},{"name":"page","in":"query","description":"Page number, min = 1","required":false,"schema":{"minimum":1,"type":"integer","format":"int32","default":1}},{"name":"limit","in":"query","description":"Number of Records, min = 1, max = 100","required":false,"schema":{"maximum":100,"minimum":1,"type":"integer","format":"int32","default":10}},{"name":"sortField","in":"query","description":"sort by field","required":false,"schema":{"$ref":"#/components/schemas/XiqAnomalySortField"}},{"name":"sortOrder","in":"query","description":"The sorting order","required":false,"schema":{"$ref":"#/components/schemas/XiqSortOrder"}},{"name":"excludeMuted","in":"query","description":"exclude muted","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqCopilotPagedXiqAnomalyLocationEntity"}}}}},"security":[{"BearerAuth":[]}]}},"/copilot/anomalies/dfs-recurrence/count-stats":{"get":{"tags":["Copilot - Anomalies"],"operationId":"getDfsRecurrenceCountStats","parameters":[{"name":"anomalyId","in":"query","description":"The anomaly id","required":true,"schema":{"type":"string"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqDfsRecurenceCountStatsResponse"}}}}},"security":[{"BearerAuth":[]}]}},"/copilot/anomalies/dfs-recurrence/channel-stats":{"get":{"tags":["Copilot - Anomalies"],"operationId":"getDfsRecurrenceChannelStats","parameters":[{"name":"anomalyId","in":"query","description":"The anomaly id","required":true,"schema":{"type":"string"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqDfsRecurenceChannelStatsResponse"}}}}},"security":[{"BearerAuth":[]}]}},"/copilot/anomalies/devices-with-locations":{"get":{"tags":["Copilot - Anomalies"],"operationId":"getCopilotDevicesWithLocations","parameters":[{"name":"page","in":"query","description":"Page number, min = 1","required":false,"schema":{"minimum":1,"type":"integer","format":"int32","default":1}},{"name":"limit","in":"query","description":"Number of Records, min = 1, max = 100","required":false,"schema":{"maximum":100,"minimum":1,"type":"integer","format":"int32","default":10}},{"name":"anomalyType","in":"query","description":"The type of anomaly","required":false,"schema":{"$ref":"#/components/schemas/XiqAnomalyType"}},{"name":"startTime","in":"query","description":"The start time to query, epoch time in milliseconds since 1/1/1970","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"endTime","in":"query","description":"The end time to query, epoch time in milliseconds since 1/1/1970","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"buildingId","in":"query","description":"The location identifier","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"severity","in":"query","description":"The severity of anomaly","required":false,"schema":{"$ref":"#/components/schemas/XiqAnomalySeverity"}},{"name":"excludeMuted","in":"query","description":"Exclude muted anomalies","required":false,"schema":{"type":"boolean","default":false}},{"name":"sortField","in":"query","description":"The sorting field","required":false,"schema":{"$ref":"#/components/schemas/XiqAnomalySortField"}},{"name":"sortOrder","in":"query","description":"The sorting order","required":false,"schema":{"$ref":"#/components/schemas/XiqSortOrder"}},{"name":"searchKey","in":"query","description":"The search key","required":false,"schema":{"type":"string","default":""}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqCopilotPagedXiqAnomalyDeviceWithLocation"}}}}},"security":[{"BearerAuth":[]}]}},"/copilot/anomalies/devices-by-location":{"get":{"tags":["Copilot - Anomalies"],"operationId":"getDevicesByLocation","parameters":[{"name":"anomalyType","in":"query","description":"Anomaly type","required":false,"schema":{"$ref":"#/components/schemas/XiqAnomalyType"}},{"name":"locationIds","in":"query","description":"The location IDs","required":true,"schema":{"type":"array","items":{"type":"integer","format":"int64"}}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqAnomalyDevicesByLocationResponse"}}}}},"security":[{"BearerAuth":[]}]}},"/copilot/anomalies/anomalies-by-category":{"get":{"tags":["Copilot - Anomalies"],"operationId":"getCopilotAnomaliesbyCategory","parameters":[{"name":"anomalyType","in":"query","description":"The type of anomaly","required":false,"schema":{"$ref":"#/components/schemas/XiqAnomalyType"}},{"name":"startTime","in":"query","description":"The start time to query, epoch time in milliseconds since 1/1/1970","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"endTime","in":"query","description":"The end time to query, epoch time in milliseconds since 1/1/1970","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"buildingId","in":"query","description":"The location identifier","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"severity","in":"query","description":"The severity od anomaly","required":false,"schema":{"$ref":"#/components/schemas/XiqAnomalySeverity"}},{"name":"excludeMuted","in":"query","description":"exclude muted","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqCopilotAnomaliesByCategory"}}}}},"security":[{"BearerAuth":[]}]}},"/copilot/anomalies/adverse-traffic/packet-counts":{"get":{"tags":["Copilot - Anomalies"],"operationId":"getAtpPacketCounts","parameters":[{"name":"anomalyId","in":"query","description":"The anomaly id","required":true,"schema":{"type":"string"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqAtpPacketCountsResponse"}}}}},"security":[{"BearerAuth":[]}]}},"/copilot/anomalies/adverse-traffic/device-stats":{"get":{"tags":["Copilot - Anomalies"],"operationId":"getAtpDeviceStats","parameters":[{"name":"anomalyId","in":"query","description":"The anomaly id","required":true,"schema":{"type":"string"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqAtpDeviceStatsResponse"}}}}},"security":[{"BearerAuth":[]}]}},"/clients/{id}":{"get":{"tags":["Client"],"summary":"Get client info","description":"Get client detailed information.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_client_details_for_one_client"},"operationId":"getClient","parameters":[{"name":"id","in":"path","description":"The client ID","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"views","in":"query","description":"The views to return client fields (Check fields for each view at XiqClientView schema)","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/XiqClientView"}}},{"name":"fields","in":"query","description":"The client fields to return","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/XiqClientField"}}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqClient"}}}}},"security":[{"BearerAuth":[]}]}},"/clients/usage":{"get":{"tags":["Client"],"summary":"Get usage per client","description":"Get the client usage.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_client_usage"},"operationId":"getClientUsage","parameters":[{"name":"clientIds","in":"query","description":"The client IDs","required":true,"schema":{"type":"array","items":{"type":"integer","format":"int64"}}},{"name":"startTime","in":"query","description":"The start time to query, epoch time in milliseconds since 1/1/1970","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"endTime","in":"query","description":"The end time to query, epoch time in milliseconds since 1/1/1970","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/XiqClientUsage"}}}}}},"security":[{"BearerAuth":[]}]}},"/clients/summary":{"get":{"tags":["Client"],"summary":"Get client summary metrics","description":"Get number of connected wireless clients and number of detected wired clients.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_client_summary"},"operationId":"getClientSummary","parameters":[{"name":"locationIds","in":"query","description":"The location IDs","required":false,"schema":{"type":"array","items":{"type":"integer","format":"int64"}}},{"name":"deviceIds","in":"query","description":"The device IDs","required":false,"schema":{"type":"array","items":{"type":"integer","format":"int64"}}},{"name":"vlans","in":"query","description":"The associate VLAN IDs","required":false,"schema":{"type":"array","items":{"type":"integer","format":"int32"}}},{"name":"userProfileNames","in":"query","description":"The user profile names","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"ssids","in":"query","description":"The SSIDs","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"clientOsNames","in":"query","description":"The client os names","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"clientHealthStatus","in":"query","description":"The client health status: 1 - HEALTHY, 2 - POOR","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"excludeLocallyManaged","in":"query","description":"Return Cloud managed Devices' clients count","required":false,"schema":{"type":"boolean","default":false}},{"name":"searchString","in":"query","description":"The search string","required":false,"schema":{"type":"string"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqClientSummary"}}}}},"security":[{"BearerAuth":[]}]}},"/clients/byMac/{clientMac}":{"get":{"tags":["Client"],"summary":"Get client info by mac","description":"Get client detailed information based on clientMac.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_client_details_for_one_client_by_mac"},"operationId":"getClientByMac","parameters":[{"name":"clientMac","in":"path","description":"The client mac address","required":true,"schema":{"type":"string"}},{"name":"views","in":"query","description":"The views to return client fields (Check fields for each view at XiqClientView schema)","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/XiqClientView"}}},{"name":"fields","in":"query","description":"The client fields to return","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/XiqClientField"}}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqClient"}}}}},"security":[{"BearerAuth":[]}]},"delete":{"tags":["Client"],"summary":"Disconnect the client","description":"Disconnect the client by macAddress.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_disconnect_client_by_macAddress_for_one_client"},"operationId":"disconnectClient","parameters":[{"name":"clientMac","in":"path","description":"The client mac address","required":true,"schema":{"type":"string"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK"}},"security":[{"BearerAuth":[]}]}},"/clients/active":{"get":{"tags":["Client"],"summary":"List active clients","description":"List active clients with filters and pagination.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_client_list"},"operationId":"listActiveClients","parameters":[{"name":"locationIds","in":"query","description":"The location IDs","required":false,"schema":{"type":"array","items":{"type":"integer","format":"int64"}}},{"name":"deviceIds","in":"query","description":"The device IDs","required":false,"schema":{"type":"array","items":{"type":"integer","format":"int64"}}},{"name":"vlans","in":"query","description":"The associate vlan IDs","required":false,"schema":{"type":"array","items":{"type":"integer","format":"int32"}}},{"name":"userProfileNames","in":"query","description":"The user profile names","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"ssids","in":"query","description":"The SSIDs","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"clientOsNames","in":"query","description":"The client os names","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"clientConnectionTypes","in":"query","description":"The client connection types: 1 - WIRELESS, 2 - WIRED, -1 - UNDETERMINED","required":false,"schema":{"type":"array","items":{"type":"integer","format":"int32"}}},{"name":"clientHealthStatus","in":"query","description":"The client health status: 1 - HEALTHY, 2 - POOR","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"excludeLocallyManaged","in":"query","description":"Return Cloud managed Devices' clients","required":false,"schema":{"type":"boolean","default":false}},{"name":"userNames","in":"query","description":"The user names","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"searchString","in":"query","description":"The search string","required":false,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Page number, min = 1","required":false,"schema":{"minimum":1,"type":"integer","format":"int32","default":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 100","required":false,"schema":{"maximum":100,"minimum":1,"type":"integer","format":"int32","default":10}},{"name":"sortField","in":"query","description":"Sort field","required":false,"schema":{"$ref":"#/components/schemas/XiqClientSortField"}},{"name":"sortOrder","in":"query","description":"Sort order (ascending by default)","required":false,"schema":{"$ref":"#/components/schemas/XiqSortOrder"}},{"name":"views","in":"query","description":"The views to return client fields (Check fields for each view at XiqClientView schema)","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/XiqClientView"}}},{"name":"fields","in":"query","description":"The client fields to return","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/XiqClientField"}}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqClient"}}}}},"security":[{"BearerAuth":[]}]}},"/clients/active/count":{"get":{"tags":["Client"],"summary":"Get active clients count","description":"Get number of active clients with filters and pagination.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_active_clients_count"},"operationId":"getActiveClientsCount","parameters":[{"name":"locationIds","in":"query","description":"The location IDs","required":false,"schema":{"type":"array","items":{"type":"integer","format":"int64"}}},{"name":"deviceIds","in":"query","description":"The device IDs","required":false,"schema":{"type":"array","items":{"type":"integer","format":"int64"}}},{"name":"vlans","in":"query","description":"The associate VLAN IDs","required":false,"schema":{"type":"array","items":{"type":"integer","format":"int32"}}},{"name":"userProfileNames","in":"query","description":"The user profile names","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"ssids","in":"query","description":"The SSIDs","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"clientOsNames","in":"query","description":"The client os names","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"clientConnectionTypes","in":"query","description":"The client connection types: 1 - WIRELESS, 2 - WIRED, -1 - UNDETERMINED","required":false,"schema":{"type":"array","items":{"type":"integer","format":"int32"}}},{"name":"clientHealthStatus","in":"query","description":"The client health status: 1 - HEALTHY, 2 - POOR","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"excludeLocallyManaged","in":"query","description":"Return Cloud managed Devices' clients count","required":false,"schema":{"type":"boolean","default":false}},{"name":"searchString","in":"query","description":"The search string","required":false,"schema":{"type":"string"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"type":"integer","format":"int64"}}}}},"security":[{"BearerAuth":[]}]}},"/certificates":{"get":{"tags":["Configuration - Certificate"],"summary":"List certificates","description":"List a page of certificates.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_list_certificates"},"operationId":"listCertificates","parameters":[{"name":"page","in":"query","description":"Page number, min = 1","required":false,"schema":{"minimum":1,"type":"integer","format":"int32","default":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 100","required":false,"schema":{"maximum":100,"minimum":1,"type":"integer","format":"int32","default":10}},{"name":"certType","in":"query","description":"The certificate type","required":false,"schema":{"$ref":"#/components/schemas/XiqCertificateType"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqCertificate"}}}}},"security":[{"BearerAuth":[]}]}},"/auth/permissions":{"get":{"tags":["Authorization"],"summary":"Get permissions for current login user","description":"Get permissions for current login user, which are allowed for generating new API tokens.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_user_permissions"},"operationId":"listPermissions","responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"UNAUTHORIZED","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"403":{"description":"Access denied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]}]}},"/auth/apitoken/info":{"get":{"tags":["Authorization"],"summary":"Get current API token details","description":"Introspect current API token and get detail information.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_api_token_details"},"operationId":"getCurrentApiTokenInfo","responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqApiTokenInfo"}}}}},"security":[{"BearerAuth":[]}]}},"/applications":{"get":{"tags":["Application"],"summary":"List the applications","description":"List a page of applications by filter.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_list_the_applications"},"operationId":"listApplications","parameters":[{"name":"page","in":"query","description":"Page number, min = 1","required":false,"schema":{"minimum":1,"type":"integer","format":"int32","default":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 100","required":false,"schema":{"maximum":100,"minimum":1,"type":"integer","format":"int32","default":10}},{"name":"name","in":"query","description":"Application Name","required":false,"schema":{"type":"string"}},{"name":"detectionProtocol","in":"query","description":"Application Detection Protocol, only for custom Application","required":false,"schema":{"$ref":"#/components/schemas/XiqApplicationDetectionProtocol"}},{"name":"detectionType","in":"query","description":"Application Detection Type, only for custom Application","required":false,"schema":{"$ref":"#/components/schemas/XiqApplicationDetectionType"}},{"name":"predefined","in":"query","description":"Flag to filter predefined or custom Application","required":false,"schema":{"type":"boolean"},"example":true},{"name":"sortField","in":"query","description":"The sort field","required":false,"schema":{"$ref":"#/components/schemas/XiqApplicationSortField"}},{"name":"order","in":"query","description":"The sort order (ascending by default)","required":false,"schema":{"$ref":"#/components/schemas/XiqSortOrder"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqApplication"}}}}},"security":[{"BearerAuth":[]}]}},"/applications/{id}/clients/top{n}":{"get":{"tags":["Application"],"summary":"List the TopN clients for a application","description":"List the TopN clients by usage for a specific application.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_list_top_n_clients_usage_for_one_application"},"operationId":"listApplicationTopClientsUsage","parameters":[{"name":"id","in":"path","description":"The application ID","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"n","in":"path","description":"The TopN number","required":true,"schema":{"maximum":100,"minimum":1,"type":"integer","format":"int32"}},{"name":"startTime","in":"query","description":"The start time for querying top client usage of application","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"endTime","in":"query","description":"The end time for querying top application usage of application","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/XiqApplicationTopClientsUsage"}}}}}},"security":[{"BearerAuth":[]}]}},"/applications/top{n}":{"get":{"tags":["Application"],"summary":"List the TopN applications","description":"List the TopN applications by usage.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_list_top_n_applications_usage"},"operationId":"listTopApplicationsUsage","parameters":[{"name":"n","in":"path","description":"The TopN number","required":true,"schema":{"maximum":100,"minimum":1,"type":"integer","format":"int32"}},{"name":"startTime","in":"query","description":"The start time for querying top application usage","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"endTime","in":"query","description":"The end time for querying top application usage","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/XiqTopApplicationsUsage"}}}}}},"security":[{"BearerAuth":[]}]}},"/alerts":{"get":{"tags":["Alert"],"summary":"List the alerts","description":"List a page of alerts by filter.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_list_the_alerts"},"operationId":"listAlerts","parameters":[{"name":"page","in":"query","description":"Page number, min = 1","required":false,"schema":{"minimum":1,"type":"integer","format":"int32","default":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 100","required":false,"schema":{"maximum":100,"minimum":1,"type":"integer","format":"int32","default":10}},{"name":"startTime","in":"query","description":"The start time for querying alerts in milliseconds","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"endTime","in":"query","description":"The end time for querying alerts in milliseconds","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"severityIds","in":"query","description":"The alert severity identifiers to filter. The currently supported severity IDs are 1 for critical, 2 for warning, and 3 for info.","required":false,"schema":{"type":"array","items":{"type":"integer","format":"int64"}}},{"name":"categoryIds","in":"query","description":"The alert category ID to filter","required":false,"schema":{"type":"array","items":{"type":"integer","format":"int64"}}},{"name":"messageMetadataIds","in":"query","description":"The message metadata ID list to filter","required":false,"schema":{"type":"array","items":{"type":"integer","format":"int64"}}},{"name":"acknowledged","in":"query","description":"The acknowledged to filter, return global data if not specified","required":false,"schema":{"type":"boolean"}},{"name":"siteId","in":"query","description":"The site id to filter","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"keyword","in":"query","description":"The keyword to filter, such as summary, severity, source, etc.","required":false,"schema":{"type":"string"}},{"name":"sortField","in":"query","description":"The sort field","required":false,"schema":{"$ref":"#/components/schemas/XiqAlertSortField"}},{"name":"order","in":"query","description":"The sort order (descending by default)","required":false,"schema":{"$ref":"#/components/schemas/XiqSortOrder"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqAlert"}}}}},"security":[{"BearerAuth":[]}]}},"/alerts/reports/{id}":{"get":{"tags":["Alert"],"summary":"Download the alerts report","description":"Download report of alerts.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_download_an_alert_report"},"operationId":"downloadAlertReport","parameters":[{"name":"id","in":"path","description":"The report ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"string","format":"byte"}}}}}},"security":[{"BearerAuth":[]}]}},"/alerts/count-by-{group}":{"get":{"tags":["Alert"],"summary":"Count the alerts by different grouping","description":"Count the number of alerts and events based on Severity, Category, and Alert Type.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_count_the_alerts_by_group"},"operationId":"countAlertsByGroup","parameters":[{"name":"group","in":"path","description":"The group to count from","required":true,"schema":{"$ref":"#/components/schemas/XiqAlertGroupQuery"}},{"name":"acknowledged","in":"query","description":"The acknowledged to filter, return global data if not specified","required":false,"schema":{"type":"boolean"}},{"name":"siteId","in":"query","description":"The site id for counting the alerts, default to global","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"startTime","in":"query","description":"The start time for counting the alerts","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"endTime","in":"query","description":"The end time for counting the alerts","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/XiqAlertGroupCount"}}}}}},"security":[{"BearerAuth":[]}]}},"/alert-policies/available-sites":{"get":{"tags":["Alert"],"summary":"The list of current owner's available sites","description":"List all sites belonging to the current owner. If the site has been configured an site policy,\n then the site will not be available.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_list_the_available_sites"},"operationId":"listAvailableSites","responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/XiqAlertSite"}}}}}},"security":[{"BearerAuth":[]}]}},"/ad-servers":{"get":{"tags":["Configuration - Authentication"],"summary":"List active directory servers","description":"List a page of active directory servers.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_list_the_active_directory_server"},"operationId":"listActiveDirectoryServers","parameters":[{"name":"page","in":"query","description":"Page number, min = 1","required":false,"schema":{"minimum":1,"type":"integer","format":"int32","default":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 100","required":false,"schema":{"maximum":100,"minimum":1,"type":"integer","format":"int32","default":10}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqActiveDirectoryServer"}}}}},"security":[{"BearerAuth":[]}]}},"/account/viq":{"get":{"tags":["Account"],"summary":"Get VIQ Info","description":"Get account VIQ and license info.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_viq_info"},"operationId":"getViqInfo","responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqViq"}}}}},"security":[{"BearerAuth":[]}]}},"/account/home":{"get":{"tags":["Account"],"summary":"Get home ExtremeCloud IQ account info","description":"Get home ExtremeCloud IQ account info.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_basic_info"},"operationId":"getHomeAccount","responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqAccount"}}}}},"security":[{"BearerAuth":[]}]}},"/account/external":{"get":{"tags":["Account"],"summary":"List accessible external guest accounts","description":"List accessible external ExtremeCloud IQ accounts.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_list_external_accounts"},"operationId":"listExternalAccounts","responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/XiqExternalAccount"}}}}}},"security":[{"BearerAuth":[]}]}},"/subscriptions/webhook/{id}":{"delete":{"tags":["Notification"],"summary":"Delete webhook subscription","description":"Delete an exist webhook subscription.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_delete_webhook_subscriptions"},"operationId":"deleteSubscription","parameters":[{"name":"id","in":"path","description":"The webhook subscription ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"202":{"description":"Accepted"}},"security":[{"BearerAuth":[]}]}},"/pcgs/key-based/network-policy-{policyId}":{"delete":{"tags":["Configuration - User Management"],"summary":"Delete Private Client Group from a network policy","description":"Delete Private Client Group settings from a network policy.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_delete_key_based_pcg"},"operationId":"deletePcg","parameters":[{"name":"policyId","in":"path","description":"The network policy ID","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"ids","in":"query","description":"The IDs of the Key-based PCG entity to be deleted from network policy","required":true,"schema":{"type":"array","items":{"type":"integer","format":"int64"}}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"202":{"description":"Accepted"}},"security":[{"BearerAuth":[]}]}},"/licenses/legacy-licenses/{id}":{"delete":{"tags":["License"],"summary":"Delete legacy license","description":"Delete legacy license.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_delete_legacy_license"},"operationId":"deleteLegacyLicense","parameters":[{"name":"id","in":"path","description":"The legacy license ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK"}},"security":[{"BearerAuth":[]}]}},"/hiq/organizations/{id}":{"delete":{"tags":["HIQ"],"summary":"Delete an existing organization","description":"Delete an existing organization (Available when HIQ is enabled).","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_delete_organization"},"operationId":"deleteOrganization","parameters":[{"name":"id","in":"path","description":"Organization ID to delete","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"204":{"description":"No Content"}},"security":[{"BearerAuth":[]}]}},"/devices/radius-proxy/:revoke":{"delete":{"tags":["Device"],"summary":"Revoke RADIUS proxy from multiple devices","description":"Revoke the RADIUS proxy from the target devices.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_revoke_radius_proxy_for_multiple_devices"},"operationId":"revokeDevicesRadiusProxy","parameters":[{"name":"ids","in":"query","description":"The device IDs","required":true,"schema":{"type":"array","items":{"type":"integer","format":"int64"}}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"200":{"description":"OK"}},"security":[{"BearerAuth":[]}]}}},"components":{"schemas":{"XiqError":{"required":["error_code","error_id","error_message"],"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 detail message"}}},"XiqDateTimeType":{"required":["day_of_month","hour_of_day","minute_of_hour","month","year"],"type":"object","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"}},"description":"The end date and time"},"XiqDateTimeUnitType":{"type":"string","description":"The after expiration scheduled time unit.","enum":["MINUTE","HOUR","DAY","WEEK"]},"XiqDeliverySettings":{"type":"object","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"}},"description":"The password delivery settings"},"XiqExpirationActionType":{"type":"string","description":"The Expiration Action to take, null if the account is never expired.","enum":["SHOW_MESSAGE","REJECT_ACCESS"]},"XiqExpirationSettings":{"type":"object","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"}},"description":"The password expiration settings"},"XiqExpirationType":{"type":"string","description":"The for one of the account experation types.","enum":["NEVER_EXPIRE","VALID_DURING_DATES","VALID_FOR_TIME_PERIOD","DAILY"]},"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"]},"XiqPasswordDbLocation":{"type":"string","description":"The access key storage location","enum":["CLOUD","LOCAL"]},"XiqPasswordSettings":{"required":["password_character_types","password_length","psk_generation_method"],"type":"object","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"}},"description":"The password settings ID"},"XiqPasswordType":{"type":"string","description":"The access key type","enum":["PPSK","RADIUS"]},"XiqPcgType":{"type":"string","description":"The private client group type for pcgUseOnly","enum":["AP_BASED","KEY_BASED"]},"XiqPostExpirationAction":{"type":"object","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"}},"description":"The type of action to take after the account expiration."},"XiqPskGenerationMethod":{"type":"string","description":"The psk generation method","enum":["PASSWORD_ONLY","USER_STRING_PASSWORD"]},"XiqUpdateUserGroupRequest":{"required":["delivery_settings","expiration_settings","name","password_db_location","password_settings","password_type"],"type":"object","properties":{"name":{"type":"string","description":"The user group name"},"description":{"type":"string","description":"The user group description"},"password_db_location":{"$ref":"#/components/schemas/XiqPasswordDbLocation"},"ppsk_use_only":{"type":"boolean","description":"Whether it's for PPSK use only"},"password_type":{"$ref":"#/components/schemas/XiqPasswordType"},"enable_max_clients_per_ppsk":{"type":"boolean","description":"The enablement for the maximum number of clients per private PSK"},"max_clients_per_ppsk":{"type":"integer","description":"The maximum number of clients per private PSK","format":"int32"},"pcg_use_only":{"type":"boolean","description":"Whether it's for PCG use only"},"pcg_type":{"$ref":"#/components/schemas/XiqPcgType"},"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"}}},"XiqValidDailySettings":{"required":["daily_end_hour","daily_end_minute","daily_start_hour","daily_start_minute"],"type":"object","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"}},"description":"The settings for Valid Daily option or null for other settings."},"XiqValidDuringDateSettings":{"required":["end_date_time","start_date_time","time_zone"],"type":"object","properties":{"start_date_time":{"$ref":"#/components/schemas/XiqDateTimeType"},"end_date_time":{"$ref":"#/components/schemas/XiqDateTimeType"},"time_zone":{"type":"string","description":"The date/time timezone"}},"description":"The settings for Valid During Dates option or null for other settings."},"XiqValidForTimePeriodSettings":{"required":["valid_time_period_after"],"type":"object","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"}},"description":"The settings for Valid For Time Period option or null for other settings."},"XiqValidTimePeriodAfterFirstLogin":{"required":["first_login_within","first_login_within_unit","valid_time_period","valid_time_period_unit"],"type":"object","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"}},"description":"The settings for the valid time period after First Login option or null for the other option"},"XiqValidTimePeriodAfterIdCreation":{"required":["valid_time_period","valid_time_period_unit"],"type":"object","properties":{"valid_time_period":{"type":"integer","description":"The valid time period after account creation","format":"int32"},"valid_time_period_unit":{"$ref":"#/components/schemas/XiqDateTimeUnitType"}},"description":"The settings for the valid time period after ID Creation option or null for the other option"},"XiqValidTimePeriodAfterType":{"type":"string","description":"The valid time period after Id creation or first login.","enum":["ID_CREATION","FIRST_LOGIN"]},"XiqUserGroup":{"required":["create_time","delivery_settings","expiration_settings","id","name","password_db_location","password_settings","password_type","predefined","ssids","update_time","user_count"],"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"},"org_id":{"type":"integer","description":"The organization identifier, valid when enabling HIQ feature","format":"int64"},"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"},"user_count":{"type":"integer","description":"The user count","format":"int32"},"ssids":{"type":"array","description":"The ssids","items":{"type":"string","description":"The ssids"}}}},"XiqUpdateUserProfileRequest":{"type":"object","properties":{"name":{"type":"string","description":"The user profile name"},"vlan_profile_id":{"type":"integer","description":"The VLAN profile id","format":"int64"}}},"XiqClassification":{"required":["classification_id","classification_type","create_time","id","match","update_time","value"],"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"},"org_id":{"type":"integer","description":"The organization identifier, valid when enabling HIQ feature","format":"int64"},"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"}},"description":"The payload of common object - classification"},"XiqClassificationRule":{"required":["create_time","id","name","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"},"org_id":{"type":"integer","description":"The organization identifier, valid when enabling HIQ feature","format":"int64"},"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"}}},"description":"The payload of common object - classification assignment"},"XiqClassificationType":{"type":"string","description":"Classification type","enum":["LOCATION","CLOUD_CONFIG_GROUP","IP_ADDRESS","IP_SUBNET","IP_RANGE"]},"XiqUserProfile":{"required":["create_time","id","name","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"},"name":{"type":"string","description":"The user profile name"},"vlan_profile":{"$ref":"#/components/schemas/XiqVlanProfile"}},"description":"The payload of User Profile"},"XiqVlanObjectClassifiedEntry":{"required":["create_time","id","update_time","vlan_id"],"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"},"org_id":{"type":"integer","description":"The organization identifier, valid when enabling HIQ feature","format":"int64"},"vlan_id":{"maximum":4094,"minimum":1,"type":"integer","description":"The VLAN ID","format":"int32"},"classification_rule":{"$ref":"#/components/schemas/XiqClassificationRule"}},"description":"The payload of VLAN object classified entry"},"XiqVlanProfile":{"required":["create_time","default_vlan_id","enable_classification","id","name","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"},"org_id":{"type":"integer","description":"The organization identifier, valid when enabling HIQ feature","format":"int64"},"name":{"type":"string","description":"The VLAN profile name"},"default_vlan_id":{"maximum":4094,"minimum":1,"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"}}},"description":"The payload of common object - VLAN profile"},"XiqTunnelConcentratorRequest":{"required":["description","name","native_vlan","primary_bridging_interface","primary_listening_interface","primary_tagged","primary_tc","primary_vlan","tunnel_address"],"type":"object","properties":{"name":{"type":"string","description":" The Tunnel Concentrator Service name"},"description":{"type":"string","description":" The Tunnel Concentrator Service description"},"redundant":{"type":"boolean","description":"Indicates if redundant Tunnel Concentrators (primary and backup) are configured "},"primary_tc":{"type":"integer","description":" The Primary Tunnel Concentrator device ID","format":"int64"},"backup_tc":{"type":"integer","description":"The Backup Tunnel Concentrator device ID","format":"int64"},"primary_listening_interface":{"maximum":4,"minimum":1,"type":"integer","description":"Primary Listening Interface ID.","format":"int32"},"backup_listening_interface":{"maximum":4,"minimum":1,"type":"integer","description":"Backup Listening Interface ID.","format":"int32"},"primary_bridging_interface":{"maximum":4,"minimum":1,"type":"integer","description":"Primary Bridging Interface ID.","format":"int32"},"backup_bridging_interface":{"maximum":4,"minimum":1,"type":"integer","description":"Backup Bridging Interface ID.","format":"int32"},"primary_ip":{"type":"string","description":"The primary IP address of network interface for accepting connections from APs (listening interface)."},"backup_ip":{"type":"string","description":"The backup IP address of network interface for accepting connections from APs (listening interface)"},"primary_vlan":{"maximum":4094,"minimum":1,"type":"integer","description":"The VLAN ID for the primary listening interface","format":"int32"},"backup_vlan":{"maximum":4094,"minimum":1,"type":"integer","description":"The VLAN ID for the backup listening interface","format":"int32"},"primary_tagged":{"type":"boolean","description":"Indicates if primary VLAN is tagged."},"backup_tagged":{"type":"boolean","description":"Indicates if backup VLAN is tagged"},"tunnel_address":{"pattern":"^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])/([1-9]|[12][0-9]|3[012])$","type":"string","description":"IP address/CIDR of listening interface."},"router_id":{"type":"integer","description":"Virtual Router group ID","format":"int32"},"gateway":{"type":"string","description":"The TunnelConcentrator optional gateway ip address"},"native_vlan":{"maximum":4094,"minimum":1,"type":"integer","description":"Specifies which VLAN ID is transmitted untagged on the bridged interface.","format":"int32"}}},"XiqTunnelConcentrator":{"required":["create_time","description","id","name","native_vlan","primary_bridging_interface","primary_listening_interface","primary_tagged","primary_tc","primary_vlan","tunnel_address","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"},"name":{"type":"string","description":" The Tunnel Concentrator Service name"},"description":{"type":"string","description":" The Tunnel Concentrator Service description"},"redundant":{"type":"boolean","description":"Indicates if redundant Tunnel Concentrators (primary and backup) are configured "},"primary_tc":{"type":"integer","description":" The Primary Tunnel Concentrator device ID","format":"int64"},"backup_tc":{"type":"integer","description":"The Backup Tunnel Concentrator device ID","format":"int64"},"primary_listening_interface":{"maximum":4,"minimum":1,"type":"integer","description":"Primary Listening Interface ID.","format":"int32"},"backup_listening_interface":{"maximum":4,"minimum":1,"type":"integer","description":"Backup Listening Interface ID.","format":"int32"},"primary_bridging_interface":{"maximum":4,"minimum":1,"type":"integer","description":"Primary Bridging Interface ID.","format":"int32"},"backup_bridging_interface":{"maximum":4,"minimum":1,"type":"integer","description":"Backup Bridging Interface ID.","format":"int32"},"primary_ip":{"type":"string","description":"The primary IP address of network interface for accepting connections from APs (listening interface)."},"backup_ip":{"type":"string","description":"The backup IP address of network interface for accepting connections from APs (listening interface)"},"primary_vlan":{"maximum":4094,"minimum":1,"type":"integer","description":"The VLAN ID for the primary listening interface","format":"int32"},"backup_vlan":{"maximum":4094,"minimum":1,"type":"integer","description":"The VLAN ID for the backup listening interface","format":"int32"},"primary_tagged":{"type":"boolean","description":"Indicates if primary VLAN is tagged."},"backup_tagged":{"type":"boolean","description":"Indicates if backup VLAN is tagged"},"tunnel_address":{"pattern":"^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])/([1-9]|[12][0-9]|3[012])$","type":"string","description":"IP address/CIDR of listening interface."},"router_id":{"type":"integer","description":"Virtual Router group ID","format":"int32"},"gateway":{"type":"string","description":"The TunnelConcentrator optional gateway ip address"},"native_vlan":{"maximum":4094,"minimum":1,"type":"integer","description":"Specifies which VLAN ID is transmitted untagged on the bridged interface.","format":"int32"}},"description":"The payload of Tunnel Concentrator"},"XiqSetSsidModeWepRequest":{"required":["encryption_method","key_management"],"type":"object","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"}},"description":"The request for setting the SSID to be WEP mode."},"XiqSsidKeyType":{"type":"string","description":"The key type, ASCII or HEX","example":"ASCII","enum":["ASCII","HEX"]},"XiqSsidWepAuthenticationMethod":{"type":"string","description":"The authentication method type, OPEN or SHARED","enum":["OPEN","SHARED"]},"XiqSsidWepDefaultKey":{"type":"string","description":"The default key, FIRST, SECOND,THIRD, OR FOURTH","example":"FIRST","enum":["FIRST","SECOND","THIRD","FOURTH"]},"XiqSsidWepEncryptionMethod":{"type":"string","description":"The encryption method type, WEP104 or WEP40","example":"WEP104","enum":["WEP40","WEP104"]},"XiqSsidWepKeyManagement":{"type":"string","description":"The key management type, WEP or WEP_8021X","example":"WEP_8021X","enum":["WEP","WEP_8021X"]},"XiqSetSsidModePskRequest":{"required":["encryption_method","key_management","key_type","key_value"],"type":"object","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"}},"description":"The request for setting the SSID to be PSK mode."},"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"]},"XiqSsidPskKeyManagement":{"type":"string","description":"The key management: WPA3_PSK, WPA2_PSK, WPA_PSK,AUTO_PSK","enum":["WPA_PSK","WPA2_PSK","WPA3_PSK","AUTO_PSK"]},"XiqSsidSaeGroup":{"type":"string","description":"The SAE group: ALL, ECC, or FFC, must be selected when the key management is WPA3","enum":["ALL","ECC","FFC"]},"XiqSetSsidModePpskRequest":{"required":["enable_mac_bind","enable_max_clients_per_ppsk","encryption_method","key_management","user_group_ids"],"type":"object","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"}},"description":"The request for setting the SSID to be PPSK mode."},"XiqSsidPpskKeyManagement":{"type":"string","description":"The key management: WPA2_PSK, WPA_PSK,AUTO_PSK","enum":["WPA_PSK","WPA2_PSK","AUTO_PSK"]},"XiqSetSsidModeDot1xRequest":{"required":["enable_idm","encryption_method","key_management"],"type":"object","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"},"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"}}},"description":"The request for setting the SSID to be 802.1x mode."},"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","example":"CCMP","enum":["CCMP","TKIP","AUTO_TKIP_CCMP","AES192"]},"XiqSsidDot1xKeyManagement":{"type":"string","description":"The key management: WPA_8021X, WPA2_8021X, WPA3_8021X or AUTO_8021X","example":"WPA3_8021X","enum":["WPA_8021X","WPA2_8021X","WPA3_8021X","AUTO_8021X"]},"XiqUpdateSsidAdvancedSettingsRequest":{"type":"object","properties":{"enable802_dot11mc":{"type":"boolean","description":"Whether to enable 802.11mc on SSID."}}},"XiqSsidAdvancedSettings":{"required":["create_time","id","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"},"enable802_dot11mc":{"type":"boolean"}},"description":"The payload of config for the SSID advanced settings."},"XiqInternalRadiusServerAuthenticationMethod":{"type":"string","description":"The default authentication method","enum":["TLS","PEAP","TTLS","LEAP","MD5"]},"XiqInternalRadiusServerAuthenticationMethodGroup":{"type":"string","description":"The authentication group","enum":["TLS_PEAP_TTLS_LEAP_MD5","TLS_PEAP_TTLS_LEAP","TLS_PEAP","TLS_TTLS","TLS","LEAP"]},"XiqRadiusClient":{"type":"object","properties":{"id":{"type":"integer","description":"The RADIUS client ID","format":"int64"},"shared_secret":{"type":"string","description":"The shared secret of RADIUS client"},"description":{"type":"string","description":"The RADIUS client description"},"l3_address_profile_id":{"type":"integer","description":"The associate L3 address profile ID","format":"int64"}},"description":"The associate RADIUS client for RADIUS proxy"},"XiqUpdateInternalRadiusServerRequest":{"required":["authentication_method_group","ca_certificate_id","default_authentication_method","enable_authentication_server","enable_check_cert_common_name","enable_check_user_for_tls_auth","enable_radius_accounting_settings","enable_verify_server_cert","name","server_certificate_id","server_key_id"],"type":"object","properties":{"name":{"type":"string","description":"The internal RADIUS server name"},"description":{"type":"string","description":"The internal RADIUS server description"},"authentication_method_group":{"$ref":"#/components/schemas/XiqInternalRadiusServerAuthenticationMethodGroup"},"default_authentication_method":{"$ref":"#/components/schemas/XiqInternalRadiusServerAuthenticationMethod"},"enable_verify_server_cert":{"type":"boolean","description":"Enable verify server cert or not"},"server_key_password":{"type":"string","description":"password for server key"},"enable_check_cert_common_name":{"type":"boolean","description":"Enable check cert common name or not"},"enable_check_user_for_tls_auth":{"type":"boolean","description":"Enable check user for TLS auth or not"},"enable_check_user_for_peap_auth":{"type":"boolean","description":"Enable check user for PEAP auth or not, for Active Directory as the external user directory only"},"enable_check_user_for_ttls_auth":{"type":"boolean","description":"Enable check user for TTLS auth or not, for Active Directory as the external user directory only"},"enable_authentication_server":{"type":"boolean","description":"Enable the RADIUS server as authentication or not"},"enable_radius_accounting_settings":{"type":"boolean","description":"Enable the RADIUS server as accounting or not, must enable authentication server if want to enable accounting settings"},"authentication_server_port":{"maximum":65535,"minimum":1,"type":"integer","description":"Port for the authentication, must enable authentication. Max:65535, Min:1","format":"int32","default":1812},"active_session_limit":{"maximum":15,"minimum":0,"type":"integer","description":"Active session limit, must enable accounting setting. Max:15, Min:0","format":"int32","default":0},"active_session_age_timeout":{"maximum":300000000,"minimum":30,"type":"integer","description":"Active session age timeout in seconds, must enable accounting setting. Max:300000000, Min:0","format":"int32","default":30},"ca_certificate_id":{"type":"integer","description":"The CA certificate ID, which could be fetched from endpoint: '/certificates' and pick up with type 'CA'","format":"int64"},"server_certificate_id":{"type":"integer","description":"The Server certificate ID, which could be fetched from endpoint: '/certificates' and pick up with type 'CERT'","format":"int64"},"server_key_id":{"type":"integer","description":"The Server key ID, which could be fetched from endpoint: '/certificates' and pick up with type 'KEY'","format":"int64"},"clients":{"type":"array","description":"The RADIUS clients of RADIUS proxy, which could be fetched form endpoint: '/radius-proxy'","items":{"$ref":"#/components/schemas/XiqRadiusClient"}}}},"XiqExternalUserDirectory":{"required":["cache_lifetime","enable_radius_server_credential_caching","entries","external_user_directory_type","ldap_retry_interval","local_check_interval","remote_check_interval","user_group_attribute"],"type":"object","properties":{"ldap_retry_interval":{"maximum":200000000,"minimum":60,"type":"integer","description":"Retry the previously unresponsive primary server after the specified seconds","format":"int32","default":600},"local_check_interval":{"maximum":3600,"minimum":30,"type":"integer","description":"Time to user local cache if none of the external servers are reachable in seconds","format":"int32","default":300},"remote_check_interval":{"maximum":3600,"minimum":10,"type":"integer","description":"Try the next backup server after specified seconds","format":"int32","default":30},"enable_radius_server_credential_caching":{"type":"boolean","description":"Caching credentials allows for better performance and higher availability by reducing the dependence on RADIUS servers across high-latency WAN links."},"cache_lifetime":{"maximum":2592000,"minimum":3600,"type":"integer","description":"Retain Cache for","format":"int32","default":86400},"user_group_attribute":{"type":"string","description":"The user group attribute, use string such as: 'memberOf'","example":"memberOf","default":"memberOf"},"external_user_directory_type":{"$ref":"#/components/schemas/XiqExternalUserDirectoryType"},"entries":{"type":"array","description":"The external user directory server entries","items":{"$ref":"#/components/schemas/XiqExternalUserDirectoryEntry"}}},"description":"The setting for external user directory, AD or LDAP"},"XiqExternalUserDirectoryEntry":{"required":["default_server_id","server_role"],"type":"object","properties":{"default_server_id":{"type":"integer","description":"The default external user directory server id, could be active directory server id(get the id list from endpoint: '/ad-servers') or LDAP server id(get the id list from endpoint: '/ldap-servers') depends on the 'external_user_directory_type' ","format":"int64"},"server_role":{"$ref":"#/components/schemas/XiqServerRole"}},"description":"The payload of common object - External User Directory Entry"},"XiqExternalUserDirectoryType":{"type":"string","description":"The external user directory type","enum":["OPEN_LDAP","ACTIVE_DIRECTORY"]},"XiqInternalRadiusServer":{"required":["authentication_method_group","authentication_server_port","ca_certificate_id","create_time","default_authentication_method","device_ids","enable_authentication_server","enable_check_cert_common_name","enable_check_user_for_tls_auth","enable_radius_accounting_settings","enable_verify_server_cert","external_user_directory","id","name","server_certificate_id","server_key_id","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"},"org_id":{"type":"integer","description":"The organization identifier, valid when enabling HIQ feature","format":"int64"},"name":{"type":"string","description":"The internal RADIUS server name"},"description":{"type":"string","description":"The internal RADIUS server description"},"authentication_method_group":{"$ref":"#/components/schemas/XiqInternalRadiusServerAuthenticationMethodGroup"},"default_authentication_method":{"$ref":"#/components/schemas/XiqInternalRadiusServerAuthenticationMethod"},"enable_verify_server_cert":{"type":"boolean","description":"Enable verify server cert or not"},"server_key_password":{"type":"string","description":"password for server key"},"enable_check_cert_common_name":{"type":"boolean","description":"Enable check cert common name or not"},"enable_check_user_for_tls_auth":{"type":"boolean","description":"Enable check user for TLS auth or not"},"enable_check_user_for_peap_auth":{"type":"boolean","description":"Enable check user for PEAP auth or not, for Active Directory as the external user directory only"},"enable_check_user_for_ttls_auth":{"type":"boolean","description":"Enable check user for TTLS auth or not, for Active Directory as the external user directory only"},"enable_authentication_server":{"type":"boolean","description":"Enable the RADIUS server as authentication or not"},"enable_radius_accounting_settings":{"type":"boolean","description":"Enable the RADIUS server as accounting or not, must enable authentication server if want to enable accounting settings"},"authentication_server_port":{"maximum":65535,"minimum":1,"type":"integer","description":"Port for the authentication, must enable authentication. Max:65535, Min:1","format":"int32","default":1812},"active_session_limit":{"maximum":15,"minimum":0,"type":"integer","description":"Active session limit, must enable accounting setting. Max:15, Min:0","format":"int32","default":0},"active_session_age_timeout":{"maximum":300000000,"minimum":30,"type":"integer","description":"Active session age timeout in seconds, must enable accounting setting. Max:300000000, Min:0","format":"int32","default":30},"external_user_directory":{"$ref":"#/components/schemas/XiqExternalUserDirectory"},"ca_certificate_id":{"type":"integer","description":"The CA certificate ID","format":"int64"},"server_certificate_id":{"type":"integer","description":"The Server certificate ID","format":"int64"},"server_key_id":{"type":"integer","description":"The Server key ID","format":"int64"},"device_ids":{"type":"array","description":"The list of device ID associated with the internal RADIUS server","items":{"type":"integer","description":"The list of device ID associated with the internal RADIUS server","format":"int64"}},"clients":{"type":"array","description":"The RADIUS clients of RADIUS proxy","items":{"$ref":"#/components/schemas/XiqRadiusClient"}}},"description":"The configuration of internal RADIUS server object"},"XiqServerRole":{"type":"string","description":"The server role, Primary or Backup","enum":["PRIMARY","BACKUP1","BACKUP2","BACKUP3"]},"XiqRadiusServerType":{"type":"string","description":"The port type of the RADIUS server, can only be either ACCOUNTING, AUTHENTICATION, or BOTH","example":"BOTH","enum":["ACCOUNTING","AUTHENTICATION","BOTH"]},"XiqUpdateExternalRadiusServerRequest":{"required":["accounting_port","authentication_port","ip_addr","name","server_type"],"type":"object","properties":{"name":{"type":"string","description":"The external RADIUS server name"},"shared_secret":{"type":"string","description":"The shared secret for the external RADIUS server (optional)"},"authentication_port":{"maximum":65535,"minimum":1,"type":"integer","description":"The authentication port for the external RADIUS server (1 ~ 65535)","format":"int32","default":1812},"accounting_port":{"maximum":65535,"minimum":1,"type":"integer","description":"The accounting port for the external RADIUS server (1 ~ 65535)","format":"int32","default":1813},"server_type":{"$ref":"#/components/schemas/XiqRadiusServerType"},"ip_addr":{"type":"string","description":"The IP address or hostname of the RADIUS server"}}},"XiqRadiusProxyFormatType":{"type":"string","description":"The format type of RADIUS proxy","enum":["NAI","NT","SPN","AUTO"]},"XiqUpdateRadiusClient":{"type":"object","properties":{"id":{"type":"integer","description":"The RADIUS client ID, using an existing ID or leave empty to create a new one","format":"int64"},"shared_secret":{"type":"string","description":"The shared secret of RADIUS client"},"description":{"type":"string","description":"The RADIUS client description"},"l3_address_profile_id":{"type":"integer","description":"The associate L3 address profile ID","format":"int64"}},"description":"The associate RADIUS client for RADIUS proxy"},"XiqUpdateRadiusProxyRealm":{"type":"object","properties":{"id":{"type":"integer","description":"The RADIUS proxy realm ID, using an existing ID or leave empty to create a new one","format":"int64"},"name":{"type":"string","description":"The RADIUS proxy realm name"},"enable_strip_realm_name":{"type":"boolean","description":"The flag for enable strip realm name"},"radius_client_object_id":{"type":"integer","description":"The associate RADIUS client object ID","format":"int64"}},"description":"The associate RADIUS proxy realm for RADIUS proxy"},"XiqUpdateRadiusProxyRequest":{"type":"object","properties":{"name":{"type":"string","description":"The RADIUS proxy name"},"description":{"type":"string","description":"The RADIUS proxy description"},"format_type":{"$ref":"#/components/schemas/XiqRadiusProxyFormatType"},"retry_count":{"type":"integer","description":"The retry count of RADIUS proxy","format":"int32"},"retry_delay":{"type":"integer","description":"The retry delay of RADIUS proxy","format":"int32"},"dead_time":{"type":"integer","description":"The dead time of RADIUS proxy","format":"int32"},"enable_inject_operator_name_attribute":{"type":"boolean","description":"The flag for enable inject operator name attribute"},"clients":{"type":"array","description":"The RADIUS clients of RADIUS proxy","items":{"$ref":"#/components/schemas/XiqUpdateRadiusClient"}},"realms":{"maxItems":2147483647,"minItems":2,"type":"array","description":"The RADIUS realms of RADIUS proxy, provide at least two default RADIUS realms with name 'DEFAULT' and 'NULL'","items":{"$ref":"#/components/schemas/XiqUpdateRadiusProxyRealm"}}},"description":"The payload to update RADIUS proxy"},"XiqRadiusProxy":{"required":["create_time","id","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"},"org_id":{"type":"integer","description":"The organization identifier, valid when enabling HIQ feature","format":"int64"},"name":{"type":"string","description":"The RADIUS proxy name"},"description":{"type":"string","description":"The RADIUS proxy description"},"format_type":{"$ref":"#/components/schemas/XiqRadiusProxyFormatType"},"retry_count":{"type":"integer","description":"The retry count of RADIUS proxy","format":"int32"},"retry_delay":{"type":"integer","description":"The retry delay of RADIUS proxy","format":"int32"},"dead_time":{"type":"integer","description":"The dead time of RADIUS proxy","format":"int32"},"enable_inject_operator_name_attribute":{"type":"boolean","description":"The flag for enable inject operator name attribute"},"clients":{"type":"array","description":"The RADIUS clients of RADIUS proxy","items":{"$ref":"#/components/schemas/XiqRadiusClient"}},"realms":{"type":"array","description":"The RADIUS realms of RADIUS proxy","items":{"$ref":"#/components/schemas/XiqRadiusProxyRealm"}}},"description":"The configuration of RADIUS proxy"},"XiqRadiusProxyRealm":{"type":"object","properties":{"id":{"type":"integer","description":"The RADIUS proxy realm ID","format":"int64"},"name":{"type":"string","description":"The RADIUS proxy realm name"},"enable_strip_realm_name":{"type":"boolean","description":"The flag for enable strip realm name"},"radius_client_object_id":{"type":"integer","description":"The associate RADIUS client object ID","format":"int64"}},"description":"The associate RADIUS proxy realm for RADIUS proxy"},"XiqUpdateRadiusClientObjectRequest":{"required":["accounting_interim_update_interval","enable_inject_operator_name_attribute","enable_message_authenticator_attribute","enable_permit_dynamic_authorization_message_change","name","retry_interval"],"type":"object","properties":{"name":{"type":"string","description":"The RADIUS client object name."},"description":{"type":"string","description":"The RADIUS client object description."},"enable_inject_operator_name_attribute":{"type":"boolean","description":"The flag for enable Inject Operator Name Attribute"},"enable_message_authenticator_attribute":{"type":"boolean","description":"The flag for enable message authenticator attribute"},"enable_permit_dynamic_authorization_message_change":{"type":"boolean","description":"The flag for enable permit dynamic authorization message change"},"retry_interval":{"maximum":100000000,"minimum":60,"type":"integer","description":"The retry interval, 60 - 100000000 seconds","format":"int32"},"accounting_interim_update_interval":{"maximum":100000000,"minimum":60,"type":"integer","description":"The accounting interim update interval, 60 - 100000000 seconds","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"]},"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."}}},"XiqRadioProfile":{"required":["create_time","id","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"},"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"}},"description":"The payload of Radio Profile"},"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"}}},"XiqRpWmmQosSettings":{"required":["create_time","id","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"},"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"}},"description":"The payload of config for the radio profile"},"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"}}},"XiqRpSensorScanSettings":{"required":["create_time","id","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"},"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"}},"description":"The payload of config for the radio profile"},"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."}}},"XiqRpMacOuiProfile":{"required":["create_time","id","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"},"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"}},"description":"The payload of config for the radio profile"},"XiqRpRadioUsageOptimization":{"required":["create_time","id","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"},"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"}},"description":"The payload of config for the radio profile"},"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"}}},"XiqRpNeighborhoodAnalysis":{"required":["create_time","id","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"},"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"}},"description":"The payload of neighborhood analysis config for the radio profile"},"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"}}},"XiqRpMiscellaneousSettings":{"required":["create_time","id","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"},"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"}}},"description":"The payload of config for the radio profile"},"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"}}},"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"}}},"XiqRpChannelSelection":{"required":["create_time","id","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"},"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"}},"description":"The payload of config for the radio profile"},"XiqKeyBasedPcgUserBaseInfo":{"required":["email","name","user_group_name"],"type":"object","properties":{"name":{"type":"string","description":"The user name of key based PCG, which could not share with other exist key based PCG"},"email":{"type":"string","description":"The email for deliver key based PCG user password"},"user_group_name":{"type":"string","description":"The user group name"}},"description":"The user's base info"},"XiqUpdateKeyBasedPcgUsersRequest":{"required":["users"],"type":"object","properties":{"users":{"type":"array","description":"The Key-based PCG users","items":{"$ref":"#/components/schemas/XiqKeyBasedPcgUserBaseInfo"}}},"description":"The payload of replace Key-based Private Client Group users request"},"XiqNetworkPolicyType":{"type":"string","description":"The network policy type","enum":["NETWORK_ACCESS_AND_SWITCHING","BRANCH_ROUTING","WIRELESS_ACCESS","SWITCHING","NETWORK_ACCESS_AND_SWITCHING_AND_BR","NETWORK_ACCESS_AND_BRANCH_ROUTING","SWITCHING_AND_BRANCH_ROUTING"]},"XiqUpdateNetworkPolicyRequest":{"type":"object","properties":{"name":{"type":"string","description":"The network policy name"},"description":{"type":"string","description":"The network policy description"},"type":{"$ref":"#/components/schemas/XiqNetworkPolicyType"}}},"XiqNetworkPolicy":{"required":["create_time","id","name","predefined","type","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"},"org_id":{"type":"integer","description":"The organization identifier, valid when enabling HIQ feature","format":"int64"},"name":{"type":"string","description":"The network policy name"},"description":{"type":"string","description":"The network policy description"},"predefined":{"type":"boolean","description":"Whether it is a predefined network policy"},"type":{"type":"string","description":"The network policy type"}}},"XiqUpdateLocationRequest":{"required":["name","parent_id"],"type":"object","properties":{"parent_id":{"type":"integer","description":"The parent location ID","format":"int64"},"name":{"type":"string","description":"The location name"}}},"XiqLocation":{"required":["create_time","id","name","type","unique_name","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"},"org_id":{"type":"integer","description":"The organization identifier, valid when enabling HIQ feature","format":"int64"},"parent_id":{"type":"integer","description":"The parent location ID","format":"int64"},"name":{"type":"string","description":"The location name"},"unique_name":{"type":"string","description":"The unique location name"},"type":{"type":"string","description":"The location type"},"address":{"type":"string","description":"The address for the location"},"children":{"type":"array","description":"The child locations","items":{"$ref":"#/components/schemas/XiqLocation"}}},"description":"The hierarchical location for Site_Group/Site/Building/Floor"},"XiqAddress":{"required":["address","city","state"],"type":"object","properties":{"address":{"type":"string","description":"The address line 1"},"address2":{"type":"string","description":"The address line 2"},"city":{"type":"string","description":"The city/town of the address"},"state":{"type":"string","description":"The province/state of the address"},"postal_code":{"type":"string","description":"The postal/ZIP code of the address"}},"description":"The address for a site or building."},"XiqUpdateSiteRequest":{"required":["country_code","name"],"type":"object","properties":{"parent_id":{"type":"integer","description":"The parent site group ID","format":"int64"},"name":{"type":"string","description":"The site name"},"address":{"$ref":"#/components/schemas/XiqAddress"},"country_code":{"type":"integer","description":"The site country code. Get the list of country codes from /countries XAPI.","format":"int32"},"latitude":{"type":"number","description":"The latitude coordinate for the site","format":"double"},"longitude":{"type":"number","description":"The longitude coordinate for the site","format":"double"}}},"XiqSite":{"required":["country_code","create_time","id","name","type","unique_name","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"},"org_id":{"type":"integer","description":"The organization identifier, valid when enabling HIQ feature","format":"int64"},"parent_id":{"type":"integer","description":"The parent site group ID","format":"int64"},"name":{"type":"string","description":"The site name"},"unique_name":{"type":"string","description":"The site unique name"},"type":{"type":"string","description":"The location type"},"address":{"$ref":"#/components/schemas/XiqAddress"},"country_code":{"type":"integer","description":"The country code for the site","format":"int32"},"created_by":{"type":"integer","description":"The user ID used to create the site","format":"int64"},"latitude":{"type":"number","description":"The latitude coordinate for the site","format":"double"},"longitude":{"type":"number","description":"The longitude coordinate for the site","format":"double"}},"description":"The site location information."},"XiqMeasurementUnit":{"type":"string","description":"The measurement unit in feet/meters","enum":["FEET","METERS"]},"XiqRfEnvironmentType":{"type":"string","description":"The floor RF environment","enum":["AUTO_ESTIMATE","OFFICE","OUTDOOR_FREE_SPACE","OBSTRUCTED_IN_BUILDING","OUTDOOR_SUBURBAN","WAREHOUSE","OUTDOOR_DENSE_URBAN"]},"XiqUpdateFloorRequest":{"required":["db_attenuation","installation_height","map_size_height","map_size_width","measurement_unit","name","parent_id"],"type":"object","properties":{"parent_id":{"type":"integer","description":"The parent location ID","format":"int64"},"name":{"type":"string","description":"The floor name"},"environment":{"$ref":"#/components/schemas/XiqRfEnvironmentType"},"db_attenuation":{"type":"number","description":"The floor attenuation in dBs","format":"double"},"measurement_unit":{"$ref":"#/components/schemas/XiqMeasurementUnit"},"installation_height":{"type":"number","description":"The installation height","format":"double"},"map_size_width":{"type":"number","description":"The floor map width","format":"double"},"map_size_height":{"type":"number","description":"The floor map height","format":"double"},"map_name":{"type":"string","description":"The floor map name"}}},"XiqFloor":{"required":["create_time","db_attenuation","environment","id","installation_height","measurement_unit","name","parent_id","unique_name","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"},"org_id":{"type":"integer","description":"The organization identifier, valid when enabling HIQ feature","format":"int64"},"parent_id":{"type":"integer","description":"The parent building ID","format":"int64"},"name":{"type":"string","description":"The floor name"},"unique_name":{"type":"string","description":"The floor unique name"},"environment":{"$ref":"#/components/schemas/XiqRfEnvironmentType"},"db_attenuation":{"type":"number","description":"The floor attenuation in dBs","format":"double"},"measurement_unit":{"$ref":"#/components/schemas/XiqMeasurementUnit"},"installation_height":{"type":"number","description":"The installation height","format":"double"},"map_size_width":{"type":"number","description":"The floormap width","format":"double"},"map_size_height":{"type":"number","description":"The floormap height","format":"double"},"map_name":{"type":"string","description":"The floormap name"}},"description":"The Floor information on the floorplan."},"XiqUpdateBuildingRequest":{"required":["address","name","parent_id"],"type":"object","properties":{"parent_id":{"type":"integer","description":"The parent location ID","format":"int64"},"name":{"type":"string","description":"The building name"},"address":{"$ref":"#/components/schemas/XiqAddress"},"latitude":{"type":"number","description":"The latitude coordinate for the building","format":"double"},"longitude":{"type":"number","description":"The longitude coordinate for the building","format":"double"}}},"XiqBuilding":{"required":["create_time","id","name","parent_id","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"},"org_id":{"type":"integer","description":"The organization identifier, valid when enabling HIQ feature","format":"int64"},"parent_id":{"type":"integer","description":"The parent location ID","format":"int64"},"name":{"type":"string","description":"The building name"},"address":{"$ref":"#/components/schemas/XiqAddress"},"latitude":{"type":"number","description":"The latitude coordinate for the building","format":"double"},"longitude":{"type":"number","description":"The longitude coordinate for the building","format":"double"}},"description":"The Building information on the floorplan."},"XiqSetNacEntitlementAllocationRequest":{"required":["serial_no"],"type":"object","properties":{"serial_no":{"type":"string","description":"Nac entitlement serial number"},"percentage":{"type":"number","description":"Nac entitlement allocation percentage","format":"double"}}},"XiqLdapProtocolType":{"type":"string","description":"LDAP server protocol type","enum":["LDAP","LDAPS"]},"XiqLdapServerVerificationMode":{"type":"string","description":"The LDAP server verification mode","enum":["TRY","NEVER","DEMAND"]},"XiqUpdateLdapServerRequest":{"type":"object","properties":{"name":{"type":"string","description":"The LDAP server name"},"description":{"type":"string","description":"The LDAP server description"},"enable_tls":{"type":"boolean","description":"enable TLS or not, if ture, caCertificateId, clientCertificateId and clientKeyId must be specified"},"bind_dn":{"type":"string","description":"The LDAP server bind DN name"},"bind_dn_password":{"type":"string","description":"The LDAP server bind DN password"},"base_dn":{"type":"string","description":"The RADIUS user base DN"},"l3_address_profile_id":{"type":"integer","description":"The L3 address profile ID","format":"int64"},"protocol_type":{"$ref":"#/components/schemas/XiqLdapProtocolType"},"enable_strip_realm_name":{"type":"boolean","description":"enable strip realm name or not"},"destination_port":{"minimum":1,"type":"integer","description":"The LDAP server destination port (1 ~ 65535)","format":"int32"},"verification_mode":{"$ref":"#/components/schemas/XiqLdapServerVerificationMode"},"ca_certificate_id":{"type":"integer","description":"The CA certificate ID, refer to XiqCertificate","format":"int64"},"client_certificate_id":{"type":"integer","description":"The client certificate ID, refer to XiqCertificate","format":"int64"},"client_key_id":{"type":"integer","description":"The client key ID, refer to XiqCertificate","format":"int64"}}},"XiqLdapServer":{"required":["create_time","id","name","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"},"name":{"type":"string","description":"The LDAP server name"},"description":{"type":"string","description":"The LDAP server description"},"enable_tls":{"type":"boolean","description":"The LDAP server is enabled TLS or not"},"bind_dn":{"type":"string","description":"The LDAP server bind DN name"},"bind_dn_password":{"type":"string","description":"The LDAP server bind DN password"},"base_dn":{"type":"string","description":"The RADIUS user base DN"},"l3_address_profile_id":{"type":"integer","description":"The L3 address profile ID","format":"int64"},"protocol_type":{"$ref":"#/components/schemas/XiqLdapProtocolType"},"enable_strip_realm_name":{"type":"boolean","description":"Enable strip realm name or not"},"destination_port":{"type":"integer","description":"The LDAP server destination port","format":"int32"},"verification_mode":{"$ref":"#/components/schemas/XiqLdapServerVerificationMode"},"ca_certificate_id":{"type":"integer","description":"The CA certificate ID","format":"int64"},"client_certificate_id":{"type":"integer","description":"The client certificate ID","format":"int64"},"client_key_id":{"type":"integer","description":"The client key ID","format":"int64"},"client_key_password":{"type":"string","description":"The LDAP server client key password"}},"description":"The common object - LDAP server"},"XiqIotApplicationId":{"type":"string","description":"The supported IoT applications.","enum":["THREAD_GATEWAY"]},"XiqIotProfileRequest":{"required":["app_id","name"],"type":"object","properties":{"name":{"type":"string","description":"The IoT profile name"},"app_id":{"$ref":"#/components/schemas/XiqIotApplicationId"},"thread_gateway":{"$ref":"#/components/schemas/XiqIotProfileThreadGateway"}}},"XiqIotProfileThreadGateway":{"required":["channel","ext_pan_id","master_key","network_name","short_pan_id"],"type":"object","properties":{"short_pan_id":{"maxLength":4,"minLength":4,"pattern":"^[0-9a-fA-F]+$","type":"string","description":"The Personal Area Network (PAN) ID. (4 hex digits). FFFF is reserved."},"ext_pan_id":{"maxLength":16,"minLength":16,"pattern":"^[0-9a-fA-F]+$","type":"string","description":"The Extended Personal Area Network (PAN) ID. (16 hex digits)"},"master_key":{"maxLength":32,"minLength":32,"pattern":"^[0-9a-fA-F]+$","type":"string","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":{"maxLength":16,"minLength":1,"type":"string","description":"A human-readable name for the network, up to 16 bytes in length."},"channel":{"minimum":0,"type":"integer","description":"802.15.4 channel number, 11-26","format":"int32"},"comm_credentials":{"maxLength":255,"minLength":6,"pattern":"^.{6,255}$","type":"string","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":{"maximum":2000000,"minimum":1,"type":"integer","description":"After this timeout the Commissioner will shutdown. The default is 120 sec. but the max is approximately 23 days.","format":"int32"},"enable_nat64":{"type":"boolean","description":"Enable NAT64 functions including the translator and the prefix publishing."},"white_list":{"type":"array","items":{"$ref":"#/components/schemas/XiqIotpTgWhiteListEntry"}},"default_user_profile_id":{"type":"integer","description":"The default user-profile ID.","format":"int64"}},"description":"Thread Gateway application settings."},"XiqIotpTgWhiteListEntry":{"required":["long_eui","pskd"],"type":"object","properties":{"long_eui":{"pattern":"^([*]|[0-9a-fA-F]{16})$","type":"string","description":"The factory-assigned IEEE EUI-64. (16 hex digits) or * to match any joiner. FFFFFFFFFFFFFFFF is reserved."},"pskd":{"maxLength":32,"minLength":6,"pattern":"^[0-9ABCDEFGHJKLMNPRSTUVWXY]+$","type":"string","description":"The PSKd (Pre-Shared-Key for the Device) is the Joining Device Credential encoded using base32-thread. \nA Joining Device Credential is encoded as uppercase, alphanumeric characters (base32-thread: 0-9,A-Y excluding I,O,Q, and Z for readability) \nwith a minimum length of 6 such characters and a maximum length of 32 such characters."}}},"XiqIotProfile":{"required":["app_id","create_time","id","name","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"},"name":{"type":"string","description":"The IoT profile name"},"app_id":{"$ref":"#/components/schemas/XiqIotApplicationId"},"thread_gateway":{"$ref":"#/components/schemas/XiqIotProfileThreadGateway"}},"description":"The payload of IoT Profile"},"XiqHiqContext":{"required":["creating_org_id","reading_org_ids"],"type":"object","properties":{"reading_org_ids":{"type":"array","description":"The organization ID list for reading data (Empty means read data from all organizations in the HIQ)","items":{"type":"integer","description":"The organization ID list for reading data (Empty means read data from all organizations in the HIQ)","format":"int64"}},"creating_org_id":{"type":"integer","description":"The organization ID for creating new data","format":"int64"}}},"XiqUpdateEndUserRequest":{"type":"object","properties":{"name":{"type":"string","description":"The user common name"},"organization":{"type":"string","description":"The organization name"},"visit_purpose":{"type":"string","description":"The purpose of visit"},"description":{"type":"string","description":"The user description"},"email_address":{"type":"string","description":"The user email"},"phone_number":{"type":"string","description":"The user phone number"},"password":{"type":"string","description":"The user password"},"email_password_delivery":{"type":"string","description":"The password delivery Email"},"sms_password_delivery":{"type":"string","description":"The password delivery SMS"}}},"XiqEndUser":{"required":["approval_type","create_time","email_address","expired_time","id","name","phone_number","update_time","user_group_id","user_group_name","user_name"],"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"},"org_id":{"type":"integer","description":"The organization identifier, valid when enabling HIQ feature","format":"int64"},"name":{"type":"string","description":"The user common name"},"description":{"type":"string","description":"The user description"},"email_address":{"type":"string","description":"The user email address"},"phone_number":{"type":"string","description":"The user phone number"},"password":{"type":"string","description":"The user password"},"user_name":{"type":"string","description":"The user identifiable name or the same one from common name, emailAddress or phoneNumber"},"organization":{"type":"string","description":"The organization name"},"visit_purpose":{"type":"string","description":"The purpose of visit"},"email_password_delivery":{"type":"string","description":"The email address for password delivery"},"sms_password_delivery":{"type":"string","description":"The sms number for password delivery"},"user_group_id":{"type":"integer","description":"The user group ID","format":"int64"},"user_group_name":{"type":"string","description":"The user group name"},"approval_type":{"type":"string","description":"The approval type"},"expired_time":{"type":"integer","description":"The password expired time","format":"int64"}}},"XiqDeviceLocationAssignment":{"required":["location_id"],"type":"object","properties":{"location_id":{"type":"integer","description":"The assigned location ID, it must be FLOOR type","format":"int64"},"x":{"type":"number","description":"The horizontal value in the floor map","format":"double"},"y":{"type":"number","description":"The vertical value in the floor map","format":"double"},"latitude":{"type":"number","description":"The latitude in the geography","format":"double"},"longitude":{"type":"number","description":"The longitude in the geography","format":"double"}},"description":"Device location assignment"},"XiqFtmSettingsRequest":{"required":["civic_address_override","wgs84_override","zsubelement_override"],"type":"object","properties":{"wgs84_override":{"type":"boolean","description":"World Geodetic System 1984 (WGS84) override."},"wgs84":{"$ref":"#/components/schemas/XiqWgs84"},"zsubelement_override":{"type":"boolean","description":"Z-subelement override."},"zsubelement":{"$ref":"#/components/schemas/XiqZsubelement"},"civic_address_override":{"type":"boolean","description":"Civic Address override."},"civic_address":{"type":"string","description":"Civic Address as hex encoded RFC4776 formatted string."}}},"XiqWgs84":{"required":["altitude","latitude","longitude"],"type":"object","properties":{"latitude":{"type":"number","description":"Degrees of latitude. Positive values indicate latitudes north of the equator; negative values indicate latitudes south of the equator. ","format":"double"},"longitude":{"type":"number","description":"Degrees of longitude. Measurements are relative to the zero meridian, with positive values extending east of the meridian and negative values extending west of the meridian.","format":"double"},"altitude":{"type":"number","description":"Meters above sea level.","format":"double"}},"description":"The payload of WGS84 Settings"},"XiqZsubelement":{"required":["expected_to_move","floor_number"],"type":"object","properties":{"expected_to_move":{"type":"boolean","description":"Is the device expected to move?"},"floor_number":{"type":"integer","description":"Floor number where the device is installed.","format":"int32"},"above_floor":{"$ref":"#/components/schemas/XiqZsubelementAboveFloor"}},"description":"The payload of Z-subelement Settings"},"XiqZsubelementAboveFloor":{"required":["height","height_uncertainty"],"type":"object","properties":{"height":{"type":"number","description":"Height above floor in meters","format":"double"},"height_uncertainty":{"type":"number","description":"Height uncertainty in meters","format":"double"}},"description":"Z-subelement Above Floor"},"XiqFtmSettings":{"required":["civic_address_override","create_time","id","update_time","wgs84_override","zsubelement_override"],"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"},"wgs84_override":{"type":"boolean","description":"World Geodetic System 1984 (WGS84) override"},"wgs84":{"$ref":"#/components/schemas/XiqWgs84"},"zsubelement_override":{"type":"boolean","description":"Z Subelement override."},"zsubelement":{"$ref":"#/components/schemas/XiqZsubelement"},"civic_address_override":{"type":"boolean","description":"Civic Address override."},"civic_address":{"type":"string","description":"Civic Address as hex encoded RFC4776 formatted string."}},"description":"The payload of FTM Settings"},"XiqChangeDevicesIbeaconRequest":{"required":["device_ids"],"type":"object","properties":{"device_ids":{"type":"array","description":"The list of device IDs. Consult ExtremeNetworks documentation for the complete list of devices that support the beacon transmitter. The following are some of the AP devices with the embedded beacon: AP122, AP122X, AP150W, AP245X, AP250, and AP550.","items":{"type":"integer","description":"The list of device IDs. Consult ExtremeNetworks documentation for the complete list of devices that support the beacon transmitter. The following are some of the AP devices with the embedded beacon: AP122, AP122X, AP150W, AP245X, AP250, and AP550.","format":"int64"}},"enabled":{"type":"boolean","description":"Whether to enable the device beacon. Default to true for newly enabled device."},"major":{"maximum":65535,"minimum":0,"type":"integer","description":"Identification of a subset of beacons in a geographical venue. Default to 1 for newly enabled device.","format":"int32"},"minor":{"maximum":65535,"minimum":0,"type":"integer","description":"Identification of a beacon in a specific location. Default to 1 for newly enabled device.","format":"int32"},"power":{"maximum":127,"minimum":-127,"type":"integer","description":"The transmission power in dBm. Default to -59 for newly enabled device.","format":"int32"},"enable_monitoring":{"type":"boolean","description":"Whether to enable iBeacon monitoring. Default to true for newly enabled device."}},"description":"The request to update the existing device level iBeacon setting or create the new device level iBeacon settings if the devices' Network Policy iBeacon service has been enabled.The update will be effective on all devices or none if one of the devices has Network Policy iBeacon service not enabled."},"XiqActionType":{"type":"string","description":"The anomaly type","enum":["MUTE","UNMUTE","PINNED","UNPINNED","DISMISSED"]},"XiqAnomalyType":{"type":"string","description":"The anomaly Type","enum":["POE_STABILITY","DFS_RECURRENCE","ADVERSE_TRAFFIC","PORT_EFFICIENCY","WIFI_CAPACITY","WIFI_EFFICIENCY"]},"XiqUpdateActionAnomalyDetails":{"required":["anomalyId","anomalyType","buildingId","locationId"],"type":"object","properties":{"buildingId":{"type":"integer","description":"The building ID","format":"int64"},"locationId":{"type":"integer","description":"The location ID","format":"int64"},"anomalyId":{"type":"string","description":"The anomaly ID"},"anomalyType":{"$ref":"#/components/schemas/XiqAnomalyType"}},"description":"Anomaly Action Filter"},"XiqUpdateAnomaliesAndDevicesRequest":{"required":["actionType","anomalyDetails"],"type":"object","properties":{"anomalyDetails":{"type":"array","description":"The anomaly details","items":{"$ref":"#/components/schemas/XiqUpdateActionAnomalyDetails"}},"actionType":{"$ref":"#/components/schemas/XiqActionType"}},"description":"Update Copilot Anomalies and Devices"},"XiqAnomaliesUpdateActionRequest":{"type":"object","properties":{"anomaly_type":{"$ref":"#/components/schemas/XiqAnomalyType"},"action_type":{"$ref":"#/components/schemas/XiqActionType"},"building_id":{"type":"integer","description":"The location id","format":"int64"}},"description":"Copilot Anomalies Update Action Request"},"XiqCopilotAnomaliesActionResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"success value"}},"description":"Copilot Anomalies Success Response"},"XiqAnomaliesDeviceUpdateActionRequest":{"type":"object","properties":{"anomaly_type":{"$ref":"#/components/schemas/XiqAnomalyType"},"action_type":{"$ref":"#/components/schemas/XiqActionType"},"location_id":{"type":"integer","description":"The location id","format":"int64"},"anomaly_id":{"type":"string","description":"The anomaly Id"}},"description":"Copilot Anomalies Devices Update Action Request"},"XiqAnomaliesFeedbackRequest":{"type":"object","properties":{"anomaly_type":{"$ref":"#/components/schemas/XiqAnomalyType"},"anomaly_id":{"type":"string","description":"The anomaly Id"},"feedback_type":{"$ref":"#/components/schemas/XiqFeedbackType"},"feedback":{"type":"string","description":"The feedback description"}},"description":"Copilot Anomalies Feedback Request"},"XiqFeedbackType":{"type":"string","description":"The feedback type","enum":["LIKE","DISLIKE"]},"XiqClientMacAddressAlias":{"required":["mac_address"],"type":"object","properties":{"mac_address":{"maxLength":16,"minLength":12,"type":"string","description":"The MAC address of the client"},"alias":{"maxLength":255,"minLength":0,"type":"string","description":"The alias of the client"}},"description":"The client MAC address and associated alias"},"XiqUpdateClassificationRequest":{"required":["classification_type","classification_type_id","match"],"type":"object","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"}},"description":"The details of rule Rules"},"XiqUpdateClassificationRuleRequest":{"required":["classifications","name"],"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"}}}},"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"}}}},"XiqCloudConfigGroup":{"required":["create_time","id","name","predefined","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"},"org_id":{"type":"integer","description":"The organization identifier, valid when enabling HIQ feature","format":"int64"},"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"}}},"description":"The CCG"},"XiqUpdateAlertWebhookSubscriptionRequest":{"required":["alert_policy_ids"],"type":"object","properties":{"url":{"type":"string","description":"The webhook endpoint URL."},"secret":{"type":"string","description":"The auth secret for the webhook endpoint."},"is_enabled":{"type":"boolean","description":"Enable/disable alert notifications for a webhook url."},"is_subscribe_all":{"type":"boolean","description":"The all alert policy selected flag."},"alert_policy_ids":{"type":"array","description":"The selected alert policy list.","items":{"type":"integer","description":"The selected alert policy list.","format":"int64"}}},"description":"The alert webhook subscription update"},"XiqAlertWebhookSubscription":{"required":["create_time","id","is_enabled","is_subscribe_all","secret","update_time","url"],"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"},"url":{"type":"string","description":"The webhook endpoint URL."},"secret":{"type":"string","description":"The auth secret for the webhook endpoint."},"is_enabled":{"type":"boolean","description":"Enable/disable alert notifications for a webhook endpoint."},"is_subscribe_all":{"type":"boolean","description":"The all alert policy selected flag."},"alert_policy_ids":{"type":"array","description":"The selected alert policy list.","items":{"type":"integer","description":"The selected alert policy list.","format":"int64"}}},"description":"The alert webhook subscription data model"},"XiqUpdateAlertEmailSubscriptionRequest":{"required":["alert_policy_ids"],"type":"object","properties":{"email":{"type":"string","description":"The email address."},"is_enabled":{"type":"boolean","description":"Enable/disable alert notifications for an email."},"is_subscribe_all":{"type":"boolean","description":"The all alert policy selected flag."},"alert_policy_ids":{"type":"array","description":"The selected alert policy list.","items":{"type":"integer","description":"The selected alert policy list.","format":"int64"}}},"description":"The alert email subscription update"},"XiqAlertEmailSubscription":{"required":["create_time","email","id","is_email_verified","is_enabled","is_subscribe_all","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"},"email":{"type":"string","description":"The email address."},"is_enabled":{"type":"boolean","description":"Enable/disable alert notifications for an email."},"is_email_verified":{"type":"boolean","description":"The email address verified flag."},"is_subscribe_all":{"type":"boolean","description":"The all alert policy selected flag."},"alert_policy_ids":{"type":"array","description":"The selected alert policy list.","items":{"type":"integer","description":"The selected alert policy list.","format":"int64"}}},"description":"The alert email subscription data model"},"XiqUpdateAlertRuleRequest":{"type":"object","properties":{"description":{"type":"string","description":"This is a description for the alert rule."},"severity_id":{"type":"integer","description":"The severity identifier. The currently supported severity IDs are 1 for critical, 2 for warning, and 3 for info.","format":"int64"},"trigger_type":{"type":"string","description":"The configured trigger type of the rule."},"duration":{"type":"integer","description":"Has value when trigger_type is \"DEFERRED\". The deferred duration, in seconds.","format":"int32"},"time_window":{"type":"integer","description":"Has value when trigger_type is \"REPEATED\". The time window to count the number of repeated messages, in seconds.","format":"int32"},"count":{"type":"integer","description":"Has value when trigger_type is \"REPEATED\". The lower bound of the number of messages required to trigger this rule.","format":"int32"},"threshold":{"type":"number","description":"Has value when type is \"METRIC\". The threshold for the message.","format":"double"},"operator":{"type":"string","description":"Has value when message_metadata_type is \"METRIC\". The operator to compare against the threshold."}}},"XiqAlertRule":{"required":["id","is_enabled","message_metadata_id","severity_id","trigger_type"],"type":"object","properties":{"id":{"type":"integer","description":"The unique identifier","format":"int64"},"message_metadata_id":{"type":"integer","description":"The identifier for the unique message type that corresponds to this rule.","format":"int64"},"message_metadata_name":{"type":"string","description":"The display name for the message."},"message_metadata_type":{"type":"string","description":"The type of the message."},"description":{"type":"string","description":"This is a description for the alert rule."},"severity_id":{"type":"integer","description":"The severity identifier. The currently supported severity IDs are 1 for critical, 2 for warning, and 3 for info.","format":"int64"},"severity_name":{"type":"string","description":"The display name for the alert severity."},"is_enabled":{"type":"boolean","description":"True if this rule is active and enabled."},"trigger_type":{"type":"string","description":"The configured trigger type of the rule."},"duration":{"type":"integer","description":"Has value when trigger_type is \"DEFERRED\". The deferred duration, in seconds.","format":"int32"},"time_window":{"type":"integer","description":"Has value when trigger_type is \"REPEATED\". The time window to count the number of repeated messages, in seconds.","format":"int32"},"count":{"type":"integer","description":"Has value when trigger_type is \"REPEATED\". The lower bound of the number of messages required to trigger this rule.","format":"int32"},"threshold":{"type":"number","description":"Has value when type is \"METRIC\". The threshold for the message.","format":"double"},"unit":{"type":"string","description":"The unit of this threshold"},"operator":{"type":"string","description":"Has value when message_metadata_type is \"METRIC\". The operator to compare against the threshold."}},"description":"The state for a configured alert rule"},"XiqAlertPolicyFilter":{"required":["site_ids"],"type":"object","properties":{"name":{"type":"string","description":"The policy name."},"site_ids":{"type":"array","description":"The site ID list.","items":{"type":"integer","description":"The site ID list.","format":"int64"}}},"description":"The update and create request of alert policy"},"XiqAlertEventRulesByCategory":{"required":["category_id","category_name","rules"],"type":"object","properties":{"category_id":{"type":"integer","description":"The unique identifier of category ID.","format":"int64"},"category_name":{"type":"string","description":"The category name of category"},"rules":{"type":"array","description":"A list of overviews of the event-based alert rules, grouped by event.","items":{"$ref":"#/components/schemas/XiqAlertRuleOverview"}}},"description":"The Alert Event Rule Model"},"XiqAlertMetricRulesByMetricset":{"required":["metricset_id","metricset_name","rules"],"type":"object","properties":{"metricset_id":{"type":"integer","description":"The unique identifier of the metricset.","format":"int64"},"metricset_name":{"type":"string","description":"The human-readable name of the metricset."},"rules":{"type":"array","description":"A list of overviews of the metric-based alert rules, grouped by metricset.","items":{"$ref":"#/components/schemas/XiqAlertRuleOverview"}}},"description":"The Alert Metric Rule Model"},"XiqAlertPolicy":{"required":["id"],"type":"object","properties":{"id":{"type":"integer","description":"The unique identifier","format":"int64"},"owner_id":{"type":"integer","description":"The owner ID","format":"int64"},"org_id":{"type":"integer","description":"The organization identifier, valid when enabling HIQ feature","format":"int64"},"name":{"type":"string","description":"The name of the alert policy"},"sites":{"type":"array","description":"The message metadata type","items":{"$ref":"#/components/schemas/XiqAlertSite"}},"event_rules_overview":{"type":"array","description":"A list of overviews of the event-based alert rules, grouped by category.","items":{"$ref":"#/components/schemas/XiqAlertEventRulesByCategory"}},"metric_rules_overview":{"type":"array","description":"A list of overviews of the metric-based alert rules, grouped by metricset.","items":{"$ref":"#/components/schemas/XiqAlertMetricRulesByMetricset"}}},"description":"The Alert Policy Model"},"XiqAlertRuleOverview":{"required":["enabled","id","name"],"type":"object","properties":{"id":{"type":"integer","description":"The unique identifier of rule.","format":"int64"},"name":{"type":"string","description":"The human-readable name of this rule. Corresponds to the message_metadata_name from the get alert rule details API."},"enabled":{"type":"boolean","description":"Indicates whether this rule is in effect."}},"description":"The Alert Rule Overview Model"},"XiqAlertSite":{"required":["site_id"],"type":"object","properties":{"site_id":{"type":"integer","description":"The unique identifier of site","format":"int64"},"site_name":{"type":"string","description":"The site name of the alert policy site"}},"description":"The Alert Policy Site Model"},"XiqCreateVlanObjectClassifiedEntryRequest":{"required":["classification_rule_id","vlan_id"],"type":"object","properties":{"vlan_id":{"type":"integer","description":"The VLAN ID","format":"int32"},"classification_rule_id":{"type":"integer","description":"The classification rule ID","format":"int64"}},"description":"The VLAN object classified entries"},"XiqCreateVlanProfileRequest":{"required":["default_vlan_id","enable_classification","name"],"type":"object","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/XiqCreateVlanObjectClassifiedEntryRequest"}}}},"XiqVlanProfileFilter":{"type":"object","properties":{"ids":{"type":"array","description":"The VLAN profile ID list","items":{"type":"integer","description":"The VLAN profile ID list","format":"int64"}}},"description":"The filter to get matched VLAN profiles"},"XiqCreateUserRequest":{"required":["display_name","idle_timeout","login_name","user_role"],"type":"object","properties":{"login_name":{"type":"string","description":"Login name, i.e. username or login Email"},"display_name":{"type":"string","description":"The user name to display"},"idle_timeout":{"type":"integer","description":"The idle timeout in minutes.","format":"int32"},"user_role":{"$ref":"#/components/schemas/XiqUserRole"},"location_ids":{"type":"array","description":"The location IDs to assign. Null or empty list will assign Admin default locations.","items":{"type":"integer","description":"The location IDs to assign. Null or empty list will assign Admin default locations.","format":"int64"}}}},"XiqUserRole":{"type":"string","description":"The user administrative role","enum":["ADMINISTRATOR","OPERATOR","MONITOR","HELP_DESK","GUEST_MANAGEMENT","OBSERVER","INSTALLER","APPLICATION_OPERATOR"]},"XiqUser":{"required":["create_time","id","login_name","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"},"login_name":{"type":"string","description":"Login name, i.e. username or login Email"},"first_name":{"type":"string","description":"The first name"},"last_name":{"type":"string","description":"The last name, i.e. family name"},"display_name":{"type":"string","description":"The name to display"},"phone":{"type":"string","description":"The Phone Number"},"job_title":{"type":"string","description":"The job title"},"locale":{"type":"string","description":"The locale"},"user_role":{"$ref":"#/components/schemas/XiqUserRole"},"idle_timeout":{"type":"integer","description":"The idle timeout in minutes, the minimum value is 5 minutes and the maximum value is 4 hours","format":"int32"},"last_login_time":{"type":"string","description":"The last login time","format":"date-time"},"org_id":{"type":"integer","description":"The HIQ organization ID if it is HIQ user","format":"int64"},"location_ids":{"type":"array","description":"The assigned location IDs.","items":{"type":"integer","description":"The assigned location IDs.","format":"int64"}}}},"XiqGrantExternalUserRequest":{"required":["login_name","user_role"],"type":"object","properties":{"login_name":{"type":"string","description":"Login name, i.e. username or login Email"},"user_role":{"$ref":"#/components/schemas/XiqUserRole"},"org_id":{"type":"integer","description":"The HIQ organization ID if it is HIQ user, otherwise leave it as empty","format":"int64"},"location_ids":{"type":"array","description":"The location IDs to assign. Null or empty list will assign Admin default locations.","items":{"type":"integer","description":"The location IDs to assign. Null or empty list will assign Admin default locations.","format":"int64"}}}},"XiqExternalUser":{"required":["create_time","id","login_name","update_time","user_role"],"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"},"login_name":{"type":"string","description":"Login name, i.e. username or login Email"},"user_role":{"$ref":"#/components/schemas/XiqUserRole"},"org_id":{"type":"integer","description":"The HIQ organization ID if it is HIQ user.","format":"int64"},"location_ids":{"type":"array","description":"The assigned location IDs.","items":{"type":"integer","description":"The assigned location IDs.","format":"int64"}},"grantee_id":{"type":"integer","description":"The home VIQ user ID of external user.","format":"int64"}}},"XiqCreateUserGroupRequest":{"required":["delivery_settings","expiration_settings","name","password_db_location","password_settings","password_type"],"type":"object","properties":{"name":{"type":"string","description":"The user group name"},"description":{"type":"string","description":"The user group description"},"password_db_location":{"$ref":"#/components/schemas/XiqPasswordDbLocation"},"ppsk_use_only":{"type":"boolean","description":"Whether it's for PPSK use only"},"password_type":{"$ref":"#/components/schemas/XiqPasswordType"},"enable_max_clients_per_ppsk":{"type":"boolean","description":"The enablement for the maximum number of clients per private PSK"},"max_clients_per_ppsk":{"type":"integer","description":"The maximum number of clients per private PSK","format":"int32"},"pcg_use_only":{"type":"boolean","description":"Whether it's for PCG use only"},"pcg_type":{"$ref":"#/components/schemas/XiqPcgType"},"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"}}},"XiqCreateUserProfileRequest":{"required":["name","vlan_profile_id"],"type":"object","properties":{"name":{"type":"string","description":"The user profile name"},"vlan_profile_id":{"type":"integer","description":"The VLAN profile id","format":"int64"}}},"XiqCreateWebhookSubscriptionRequest":{"required":["application","message_type","url"],"type":"object","properties":{"application":{"type":"string","description":"The external application name.","example":"example-app"},"url":{"type":"string","description":"The webhook endpoint URL.","example":"https://webhook_endpoint-example-123"},"secret":{"type":"string","description":"The basic auth secret for the webhook endpoint.","example":"erw3245cq3dasbjtyj"},"message_type":{"$ref":"#/components/schemas/XiqSubscriptionMessageType"}},"description":"The payload to create webhook subscription"},"XiqSubscriptionMessageType":{"type":"string","description":"The subscription message type.","example":"LOCATION_AP_CENTRIC","enum":["LOCATION_AP_CENTRIC","LOCATION_CLIENT_CENTRIC","AUDIT_LOG_ALL","GDPR_LOG_ALL","CREDENTIAL_LOG_ALL","ACCOUNTING_LOG_ALL","AUTHENTICATION_LOG_ALL","EMAIL_LOG_ALL","SMS_LOG_ALL"]},"XiqCreateInternalRadiusServerRequest":{"required":["authentication_method_group","ca_certificate_id","default_authentication_method","device_ids","enable_authentication_server","enable_check_cert_common_name","enable_check_user_for_tls_auth","enable_radius_accounting_settings","enable_verify_server_cert","external_user_directory","name","server_certificate_id","server_key_id"],"type":"object","properties":{"name":{"type":"string","description":"The internal RADIUS server name"},"description":{"type":"string","description":"The internal RADIUS server description"},"authentication_method_group":{"$ref":"#/components/schemas/XiqInternalRadiusServerAuthenticationMethodGroup"},"default_authentication_method":{"$ref":"#/components/schemas/XiqInternalRadiusServerAuthenticationMethod"},"enable_verify_server_cert":{"type":"boolean","description":"Enable verify server cert or not"},"server_key_password":{"type":"string","description":"password for server key"},"enable_check_cert_common_name":{"type":"boolean","description":"Enable check cert common name or not"},"enable_check_user_for_tls_auth":{"type":"boolean","description":"Enable check user for TLS auth or not"},"enable_check_user_for_peap_auth":{"type":"boolean","description":"Enable check user for PEAP auth or not, for Active Directory as the external user directory only"},"enable_check_user_for_ttls_auth":{"type":"boolean","description":"Enable check user for TTLS auth or not, for Active Directory as the external user directory only"},"enable_authentication_server":{"type":"boolean","description":"Enable the RADIUS server as authentication or not"},"enable_radius_accounting_settings":{"type":"boolean","description":"Enable the RADIUS server as accounting or not, must enable authentication server if want to enable accounting settings"},"authentication_server_port":{"maximum":65535,"minimum":1,"type":"integer","description":"Port for the authentication, must enable authentication. Max:65535, Min:1","format":"int32","default":1812},"active_session_limit":{"maximum":15,"minimum":0,"type":"integer","description":"Active session limit, must enable accounting setting. Max:15, Min:0","format":"int32","default":0},"active_session_age_timeout":{"maximum":300000000,"minimum":30,"type":"integer","description":"Active session age timeout in seconds, must enable accounting setting. Max:300000000, Min:30","format":"int32","default":1800},"external_user_directory":{"$ref":"#/components/schemas/XiqExternalUserDirectory"},"ca_certificate_id":{"type":"integer","description":"The CA certificate ID, which could be fetched from endpoint: '/certificates' and pick up with type 'CA'","format":"int64"},"server_certificate_id":{"type":"integer","description":"The Server certificate ID, which could be fetched from endpoint: '/certificates' and pick up with type 'CERT'","format":"int64"},"server_key_id":{"type":"integer","description":"The Server key ID, which could be fetched from endpoint: '/certificates' and pick up with type 'KEY'","format":"int64"},"device_ids":{"type":"array","description":"The list of device ID associated with the internal RADIUS server","items":{"type":"integer","description":"The list of device ID associated with the internal RADIUS server","format":"int64"}},"clients":{"type":"array","description":"The RADIUS clients of RADIUS proxy, which could be fetched from endpoint: '/radius-proxy'","items":{"$ref":"#/components/schemas/XiqRadiusClient"}}}},"XiqCreateExternalRadiusServerRequest":{"required":["accounting_port","authentication_port","enable_a3","ip_addr","name","server_type"],"type":"object","properties":{"name":{"type":"string","description":"The external RADIUS server name"},"shared_secret":{"type":"string","description":"The shared secret for the external RADIUS server (optional)"},"authentication_port":{"maximum":65535,"minimum":1,"type":"integer","description":"The authentication port for the external RADIUS server (1 ~ 65535)","format":"int32","default":1812},"accounting_port":{"maximum":65535,"minimum":1,"type":"integer","description":"The accounting port for the external RADIUS server (1 ~ 65535)","format":"int32","default":1813},"server_type":{"$ref":"#/components/schemas/XiqRadiusServerType"},"ip_addr":{"type":"string","description":"The IP address or hostname of the RADIUS server"},"enable_a3":{"type":"boolean","description":"Indicates whether this is an Extreme A3 RADIUS server or not, cannot be updated after creation. Please set it to false if it is not an Extreme A3 RADIUS server."}}},"XiqExternalRadiusServer":{"required":["accounting_port","authentication_port","create_time","enable_a3","id","ip_address","name","server_type","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"},"org_id":{"type":"integer","description":"The organization identifier, valid when enabling HIQ feature","format":"int64"},"name":{"type":"string","description":"The external RADIUS server name"},"shared_secret":{"type":"string","description":"The shared secret for the external RADIUS server (optional)"},"authentication_port":{"type":"integer","description":"The authentication port for the external RADIUS server (1 ~ 65535)","format":"int32"},"accounting_port":{"type":"integer","description":"The accounting port for the external RADIUS server (1 ~ 65535)","format":"int32"},"server_type":{"$ref":"#/components/schemas/XiqRadiusServerType"},"ip_address":{"type":"string","description":"The ip address or hostname of the RADIUS server"},"enable_a3":{"type":"boolean","description":"Indicates whether this is an Extreme A3 RADIUS server or not, cannot be updated after creation. Please set it to false if it is not an Extreme A3 RADIUS server."}},"description":"The configuration of external RADIUS server object"},"XiqCreateRadiusClient":{"type":"object","properties":{"shared_secret":{"type":"string","description":"The shared secret of RADIUS client"},"description":{"type":"string","description":"The RADIUS client description"},"l3_address_profile_id":{"type":"integer","description":"The associate L3 address profile ID","format":"int64"}},"description":"The associate RADIUS client for RADIUS proxy"},"XiqCreateRadiusProxyRealm":{"type":"object","properties":{"name":{"type":"string","description":"The RADIUS proxy realm name"},"enable_strip_realm_name":{"type":"boolean","description":"The flag for enable strip realm name"},"radius_client_object_id":{"type":"integer","description":"The associate RADIUS client object ID","format":"int64"}},"description":"The associate RADIUS proxy realm for RADIUS proxy"},"XiqCreateRadiusProxyRequest":{"required":["dead_time","device_ids","format_type","name","realms","retry_count","retry_delay"],"type":"object","properties":{"name":{"type":"string","description":"The RADIUS proxy name"},"description":{"type":"string","description":"The RADIUS proxy description"},"format_type":{"$ref":"#/components/schemas/XiqRadiusProxyFormatType"},"retry_count":{"type":"integer","description":"The retry count of RADIUS proxy","format":"int32"},"retry_delay":{"type":"integer","description":"The retry delay of RADIUS proxy","format":"int32"},"dead_time":{"type":"integer","description":"The dead time of RADIUS proxy","format":"int32"},"enable_inject_operator_name_attribute":{"type":"boolean","description":"The flag for enable inject operator name attribute"},"clients":{"type":"array","description":"The RADIUS clients of RADIUS proxy","items":{"$ref":"#/components/schemas/XiqCreateRadiusClient"}},"realms":{"maxItems":2147483647,"minItems":2,"type":"array","description":"The RADIUS realms of RADIUS proxy, provide at least two default RADIUS realms with name 'DEFAULT' and 'NULL'","items":{"$ref":"#/components/schemas/XiqCreateRadiusProxyRealm"}},"device_ids":{"type":"array","description":"The device IDS to assign RADIUS proxy","items":{"type":"integer","description":"The device IDS to assign RADIUS proxy","format":"int64"}}},"description":"The payload to create a new RADIUS proxy"},"XiqCreateRadiusClientObjectRequest":{"required":["accounting_interim_update_interval","enable_inject_operator_name_attribute","enable_message_authenticator_attribute","enable_permit_dynamic_authorization_message_change","entries","name","retry_interval"],"type":"object","properties":{"name":{"type":"string","description":"The RADIUS client object name."},"description":{"type":"string","description":"The RADIUS client object description."},"enable_inject_operator_name_attribute":{"type":"boolean","description":"The flag for enable Inject Operator Name Attribute"},"enable_message_authenticator_attribute":{"type":"boolean","description":"The flag for enable message authenticator attribute"},"enable_permit_dynamic_authorization_message_change":{"type":"boolean","description":"The flag for enable permit dynamic authorization message change"},"retry_interval":{"maximum":100000000,"minimum":60,"type":"integer","description":"The retry interval, 60 - 100000000 seconds","format":"int32"},"accounting_interim_update_interval":{"maximum":100000000,"minimum":60,"type":"integer","description":"The accounting interim update interval, 60 - 100000000 seconds","format":"int32"},"entries":{"maxItems":2147483647,"minItems":1,"type":"array","description":"The list of RADIUS client object entries","items":{"$ref":"#/components/schemas/XiqRadiusClientObjectEntry"}}}},"XiqRadiusClientObjectEntry":{"required":["radius_server_id","server_role","server_type"],"type":"object","properties":{"server_role":{"$ref":"#/components/schemas/XiqServerRole"},"server_type":{"$ref":"#/components/schemas/XiqRadiusClientObjectType"},"radius_server_id":{"type":"integer","description":"The ID of the RADIUS server object, for EXTERNAL_RADIUS_SERVER please use the ID of external RADIUS server object. For INTERNAL_RADIUS_SERVER, please use the RADIUS device ID","format":"int64"}},"description":"The entry of RADIUS client object"},"XiqRadiusClientObjectType":{"type":"string","description":"The entry server type: INTERNAL_RADIUS_SERVER, EXTERNAL_RADIUS_SERVER, INTERNAL_RADIUS_PROXY","enum":["EXTERNAL_RADIUS_SERVER","INTERNAL_RADIUS_SERVER","INTERNAL_RADIUS_PROXY"]},"XiqRadiusClientObject":{"required":["accounting_interim_update_interval","create_time","enable_inject_operator_name_attribute","enable_message_authenticator_attribute","enable_permit_dynamic_authorization_message_change","entries","id","name","retry_interval","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"},"name":{"type":"string","description":"The RADIUS client object name."},"description":{"type":"string","description":"The RADIUS client object description."},"enable_inject_operator_name_attribute":{"type":"boolean","description":"The flag for enable inject operator name attribute."},"enable_message_authenticator_attribute":{"type":"boolean","description":"The flag for enable message authenticator attribute"},"enable_permit_dynamic_authorization_message_change":{"type":"boolean","description":"The flag for enable permit dynamic authorization message change"},"retry_interval":{"maximum":100000000,"minimum":60,"type":"integer","description":"The retry interval, 60 - 100000000 seconds","format":"int32"},"accounting_interim_update_interval":{"maximum":100000000,"minimum":60,"type":"integer","description":"The accounting interim update interval, 60 - 100000000 seconds","format":"int32"},"entries":{"maxItems":2147483647,"minItems":1,"type":"array","description":"The list of RADIUS client object entries","items":{"$ref":"#/components/schemas/XiqRadiusClientObjectEntry"}}},"description":"The RADIUS client object configuration"},"XiqCreateRadioProfileRequest":{"required":["name"],"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."}}},"XiqCreateRpMacOuiProfileRequest":{"required":["name","value"],"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"}}},"XiqInitKeyBasedPcgNetworkPolicyRequest":{"required":["policy_name","ssid_name","users"],"type":"object","properties":{"policy_name":{"type":"string","description":"The network policy name"},"ssid_name":{"type":"string","description":"The SSID name"},"users":{"type":"array","description":"The Key-based PCG users","items":{"$ref":"#/components/schemas/XiqKeyBasedPcgUserBaseInfo"}}},"description":"The request to initiate Key-based Private Client Group"},"XiqCreateKeyBasedPcgUsersRequest":{"required":["users"],"type":"object","properties":{"users":{"type":"array","description":"The key based PCG users","items":{"$ref":"#/components/schemas/XiqKeyBasedPcgUserBaseInfo"}}},"description":"The payload of add Key-based Private Client Group users request"},"XiqPcgAssignPortsRequest":{"required":["port_assignments"],"type":"object","properties":{"port_assignments":{"type":"array","description":"The port assignment list","items":{"$ref":"#/components/schemas/XiqPcgPortAssignment"}}},"description":"The payload to assign ports for AP150W or AP302W)"},"XiqPcgPortAssignment":{"required":["device_id"],"type":"object","properties":{"device_id":{"type":"integer","description":"The device ID of AP150W or AP302W","format":"int64"},"eth1_user_id":{"type":"integer","description":"The eth1 user ID, get available users from \"/pcgs/key-based/network-policy-{policyId}/users\"","format":"int64"},"eth2_user_id":{"type":"integer","description":"The eth2 user ID, get available users from \"/pcgs/key-based/network-policy-{policyId}/users\"","format":"int64"},"eth3_user_id":{"type":"integer","description":"The eth3 user ID, get available users from \"/pcgs/key-based/network-policy-{policyId}/users\"","format":"int64"}},"description":"The PCG port assignment entry"},"XiqPcgAssignPortsResponse":{"required":["pcg_port_assignment_entries","policy_id","policy_name"],"type":"object","properties":{"policy_id":{"type":"integer","description":"The network policy ID","format":"int64"},"policy_name":{"type":"string","description":"The network policy name"},"pcg_port_assignment_entries":{"type":"array","description":"The port assignment entry list","items":{"$ref":"#/components/schemas/XiqPcgPortAssignmentEntry"}}},"description":"The response of assign ports for AP150W or AP302W"},"XiqPcgPortAssignmentEntry":{"required":["create_time","device_id","id","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"},"org_id":{"type":"integer","description":"The organization identifier, valid when enabling HIQ feature","format":"int64"},"device_id":{"type":"integer","description":"The device ID of AP150W or AP302W","format":"int64"},"eth1_user_id":{"type":"integer","description":"The eth1 user ID, get available users from \"/pcgs/key-based/network-policy-{policyId}/users\"","format":"int64"},"eth2_user_id":{"type":"integer","description":"The eth2 user ID, get available users from \"/pcgs/key-based/network-policy-{policyId}/users\"","format":"int64"},"eth3_user_id":{"type":"integer","description":"The eth3 user ID, get available users from \"/pcgs/key-based/network-policy-{policyId}/users\"","format":"int64"}},"description":"The PCG port assignment entry"},"XiqOnboardKeyBasedPcgRequest":{"required":["enabled","ssid_name","user_ids"],"type":"object","properties":{"ssid_name":{"type":"string"},"enabled":{"type":"boolean","description":"Enable the key based PCG"},"user_ids":{"type":"array","description":"The request user IDs","items":{"type":"integer","description":"The request user IDs","format":"int64"}}},"description":"The payload to create Key Based PCG data(from exist network policy and SSID)"},"XiqCaptureBandSelection":{"type":"string","description":"The wireless band to capture. Set to ALL for all bands.","enum":["ALL","2.4GHZ","5GHZ","6GHZ"]},"XiqCaptureDirectionSelection":{"type":"string","description":"The capture traffic direction","enum":["BOTH","OUT","IN"]},"XiqCaptureFilter":{"type":"object","properties":{"mac_addr":{"type":"array","description":"List of the client MAC addresses used for packet capturing","items":{"type":"string","description":"List of the client MAC addresses used for packet capturing"}},"ip_addr":{"type":"array","description":"List of the client IP addresses used to filter the packets","items":{"type":"string","description":"List of the client IP addresses used to filter the packets"}},"protocol":{"$ref":"#/components/schemas/XiqPolicyRuleProtocolType"},"protocol_number":{"maximum":255,"minimum":0,"type":"integer","description":"The protocol number if protocol is \"USER_DEFINED\"","format":"int32"},"port":{"type":"integer","description":"The port for packet capture","format":"int32"},"vlan":{"type":"string","description":"Specific vlan ids in a string, e.g. range \"2-100\"; single \"3\"; list \"1,2,5,7,122\"; mixed \"2,4,5-10,19,29\". If not specified, default is all VLANs."},"wlan":{"type":"string","description":"A WLAN SSID. If not specified, default is all WLANs."}},"description":"The filter criteria for packet capture"},"XiqCaptureIdentifierType":{"type":"string","description":"The capture identifier type for selecting the APs. Depending on the type, one of \"ap_serial_number\", \"device_ids\" and \"location_id\" must be provided.","enum":["AP_SERIAL_NUMBER","DEVICE_IDS","LOCATION"]},"XiqCaptureLocation":{"type":"object","properties":{"direction":{"$ref":"#/components/schemas/XiqCaptureDirectionSelection"},"radio":{"$ref":"#/components/schemas/XiqCaptureRadioSelection"},"wired_interface":{"$ref":"#/components/schemas/XiqCaptureWiredSelection"},"wireless_band":{"$ref":"#/components/schemas/XiqCaptureBandSelection"},"wired_filters":{"type":"array","description":"The list of pre-defined wired filters for packet capture","items":{"$ref":"#/components/schemas/XiqWiredFilterType"}},"wireless_filters":{"type":"array","description":"The list of pre-defined wireless filters for packet capture","items":{"$ref":"#/components/schemas/XiqWirelessFilterType"}}},"description":"This represents the options for location packet capture."},"XiqCaptureRadioSelection":{"type":"string","description":"The wireless radio to capture. Set to ALL for all radios.","enum":["ALL","RADIO1","RADIO2","RADIO3"]},"XiqCaptureResult":{"type":"object","properties":{"id":{"type":"integer","description":"The unique identifier","format":"int64"},"org_id":{"type":"integer","description":"The organization identifier, valid when enabling HIQ feature","format":"int64"},"start_time":{"type":"string","description":"The packet capture start time","format":"date-time"},"end_time":{"type":"string","description":"The packet capture end time","format":"date-time"},"device_id":{"type":"integer","description":"The device identifier","format":"int64"},"hostname":{"type":"string","description":"The device host name"},"mac_address":{"type":"string","description":"The device MAC address"},"interface_name":{"type":"string","description":"The interface name such as \"WIFI0\", \"WIFI1\", \"ETH0\", etc."},"location_id":{"type":"integer","description":"The location ID","format":"int64"},"locations":{"type":"array","description":"The detailed location","items":{"$ref":"#/components/schemas/XiqLocationLegend"}},"status":{"$ref":"#/components/schemas/XiqPacketCaptureStatus"},"error_message":{"type":"string","description":"The error message (may be empty)."},"storage":{"$ref":"#/components/schemas/XiqStorage"}},"description":"This represents the packet capture result on an AP's interface. A packet capture session may involve multiple APs on multiple interfaces."},"XiqCaptureWiredSelection":{"type":"string","description":"The name of the wired interface to capture. Set to ALL for all interfaces.","enum":["ALL","ETH0","ETH1","ETH2","ETH3"]},"XiqCloudSharkStorage":{"type":"object","properties":{"file_name":{"type":"string","description":"File name in CloudShark"},"file_url":{"type":"string","description":"File URL in CloudShark"}},"description":"The packet capture file name and URL in CloudShark."},"XiqDestinationType":{"type":"string","description":"The destination for the packet capture files. CLOUD for XIQ cloud storage. CLOUD_SHARK for sending the capture files to CloudShark, in addition to XIQ cloud storage.","enum":["CLOUD","CLOUD_SHARK"]},"XiqLocationLegend":{"type":"object","properties":{"id":{"type":"integer","description":"The location ID","format":"int64"},"name":{"type":"string","description":"The location name"}},"description":"The simple location information"},"XiqPacketCapture":{"type":"object","properties":{"id":{"type":"integer","description":"The unique identifier","format":"int64"},"start_time":{"type":"string","description":"The packet capture start time","format":"date-time"},"end_time":{"type":"string","description":"The packet capture end time","format":"date-time"},"org_id":{"type":"integer","description":"The organization identifier, valid when enabling HIQ feature","format":"int64"},"name":{"type":"string","description":"The packet capture session name. If the name is null or empty, it will be auto generated."},"duration":{"maximum":604800,"minimum":0,"type":"integer","description":"An integer containing the set packet capture duration in seconds, from 5 to a maximum of 604800 seconds (1 week). If duration is set to 0 or unspecified, capture stops when platform-maximum size is reached.","format":"int32"},"capture_id_type":{"$ref":"#/components/schemas/XiqCaptureIdentifierType"},"ap_serial_number":{"type":"string","description":"The globally unique serial number of the device being registered. The serial number is represented as a string."},"device_ids":{"type":"array","description":"The device ID list.","items":{"type":"integer","description":"The device ID list.","format":"int64"}},"location_id":{"type":"integer","description":"The assigned location ID, it must be FLOOR type","format":"int64"},"destination":{"$ref":"#/components/schemas/XiqDestinationType"},"filter":{"$ref":"#/components/schemas/XiqCaptureFilter"},"capture_if":{"$ref":"#/components/schemas/XiqCaptureLocation"},"status":{"$ref":"#/components/schemas/XiqPacketCaptureStatus"},"results":{"type":"array","description":"The list of packet capture results - a PacketCaptureResult for each device's interface","items":{"$ref":"#/components/schemas/XiqCaptureResult"}},"cloud_storage":{"type":"string","description":"XIQ cloud storage location for the archive of all capture files in this capture session, if available."}},"description":"This represents the packet capture session"},"XiqPacketCaptureStatus":{"type":"string","description":"The status of the packet capture result","enum":["INITIAL","ACTIVE","SUCCESS","PARTIAL_SUCCESS","FAILED"]},"XiqPolicyRuleProtocolType":{"type":"string","description":"Protocol type to filter by","enum":["ANY","USER_DEFINED","ICMP","ICMPV6","TCP","UDP","GRE","IPSEC_ESP","IPSEC_AH"]},"XiqStorage":{"type":"object","properties":{"cloud_storage":{"type":"string","description":"XIQ cloud storage location after a packet capture is completed."},"cloud_shark_storage":{"$ref":"#/components/schemas/XiqCloudSharkStorage"}},"description":"The packet capture file storage"},"XiqWiredFilterType":{"type":"string","description":"The list of pre-defined wired filters for packet capture","enum":["DHCP","RADIUS","LLDP","ARP","MDNS"]},"XiqWirelessFilterType":{"type":"string","description":"The list of pre-defined wireless filters for packet capture","enum":["MANAGEMENT","CONTROL","DATA","EAPOL","BEACONS","PROBES"]},"XiqCaptureStopRequest":{"type":"object","properties":{"device_ids":{"type":"array","description":"The IDs of the devices for which the active packet capture is to be stopped. If empty, packet capture is to be stopped on all devices in this packet capture.","items":{"type":"integer","description":"The IDs of the devices for which the active packet capture is to be stopped. If empty, packet capture is to be stopped on all devices in this packet capture.","format":"int64"}}},"description":"The IDs of the devices for which the active packet capture is to be stopped. If empty, packet capture is to be stopped on all devices in this packet capture."},"XiqCreateNetworkPolicyRequest":{"required":["name","type"],"type":"object","properties":{"name":{"type":"string","description":"The network policy name"},"description":{"type":"string","description":"The network policy description"},"type":{"$ref":"#/components/schemas/XiqNetworkPolicyType"}}},"XiqAuditLogSortField":{"type":"string","description":"All fields used to sort the audit logs","enum":["TIMESTAMP"]},"XiqSortOrder":{"type":"string","enum":["ASC","DESC"]},"XiqAuditLogCategory":{"type":"string","enum":["ADMIN","SYSTEM","DEPLOYMENT","CONFIG","MONITOR","ALARM"]},"XiqAuditLogReport":{"required":["id"],"type":"object","properties":{"id":{"type":"integer","description":"The audit log reportId","format":"int64"}},"description":"ExtremeCloud IQ Audit Log report"},"XiqLoginRequest":{"required":["password","username"],"type":"object","properties":{"username":{"type":"string","description":"The login username"},"password":{"type":"string","description":"The login password"}}},"XiqLoginResponse":{"required":["access_token","expires_in","token_type"],"type":"object","properties":{"access_token":{"type":"string","description":"The access token with JWT format issued by ExtremeCloud IQ"},"token_type":{"type":"string","description":"The type of token, only supports \"Bearer\" currently"},"expires_in":{"type":"integer","description":"The lifetime in seconds of the access token","format":"int32"}}},"XiqCreateLocationRequest":{"required":["name","parent_id"],"type":"object","properties":{"parent_id":{"type":"integer","description":"The parent location ID","format":"int64"},"name":{"type":"string","description":"The location name"}}},"XiqCreateSiteRequest":{"required":["country_code","name"],"type":"object","properties":{"parent_id":{"type":"integer","description":"The parent site group ID","format":"int64"},"name":{"type":"string","description":"The site name"},"address":{"$ref":"#/components/schemas/XiqAddress"},"country_code":{"type":"integer","description":"The site country code. Get the list of country codes from /countries XAPI.","format":"int32"},"latitude":{"type":"number","description":"The latitude coordinate for the site","format":"double"},"longitude":{"type":"number","description":"The longitude coordinate for the site","format":"double"}}},"XiqCreateFloorRequest":{"required":["db_attenuation","installation_height","map_size_height","map_size_width","measurement_unit","name","parent_id"],"type":"object","properties":{"parent_id":{"type":"integer","description":"The parent building ID","format":"int64"},"name":{"type":"string","description":"The floor name"},"environment":{"$ref":"#/components/schemas/XiqRfEnvironmentType"},"db_attenuation":{"type":"number","description":"The floor attenuation in dBs","format":"double"},"measurement_unit":{"$ref":"#/components/schemas/XiqMeasurementUnit"},"installation_height":{"type":"number","description":"The installation height","format":"double"},"map_size_width":{"type":"number","description":"The floor map width","format":"double"},"map_size_height":{"type":"number","description":"The floor map height","format":"double"},"map_name":{"type":"string","description":"The floor map name"}}},"XiqCreateBuildingRequest":{"required":["address","name","parent_id"],"type":"object","properties":{"parent_id":{"type":"integer","description":"The parent location ID","format":"int64"},"name":{"type":"string","description":"The building name"},"address":{"$ref":"#/components/schemas/XiqAddress"},"latitude":{"type":"number","description":"The latitude coordinate for the building","format":"double"},"longitude":{"type":"number","description":"The longitude coordinate for the building","format":"double"}}},"XiqCountryCode":{"type":"string","description":"The organization country code.","enum":["AFGHANISTAN_4","ALGERIA_12","ARGENTINA_32","ARUBA_533","AUSTRALIA_36","AUSTRIA_40","AZERBAIJAN_31","BAHAMAS_44","BAHRAIN_48","BANGLADESH_50","BARBADOS_52","BELARUS_112","BELGIUM_56","BERMUDA_60","BHUTAN_64","BOLIVIA_68","BRAZIL_76","BULGARIA_100","CAMBODIA_116","CAMEROON_120","CANADA_124","CAYMAN_ISLANDS_136","CHILE_152","COLOMBIA_170","COSTA_RICA_188","CROATIA_191","CYPRUS_196","CZECH_REPUBLIC_203","DENMARK_208","DOMINICAN_REPUBLIC_214","ECUADOR_218","EGYPT_818","EL_SALVADOR_222","ESTONIA_233","FINLAND_246","FRANCE_250","FRENCH_GUIANA_254","GEORGIA_268","GERMANY_276","GHANA_288","GREECE_300","GUAM_316","GUATEMALA_320","GUYANA_328","HAITI_332","HONDURAS_340","HONG_KONG_344","HUNGARY_348","ICELAND_352","INDIA_356","INDONESIA_360","IRELAND_372","PAKISTAN_586","ISRAEL_376","ITALY_380","JAMAICA_388","JAPAN_4014","JORDAN_400","KAZAKHSTAN_398","KENYA_404","KOREA_410","KUWAIT_414","KYRGYZSTAN_417","LATVIA_428","LEBANON_422","LIECHTENSTEIN_438","LITHUANIA_440","LUXEMBOURG_442","MACAO_446","MALAWI_454","MALAYSIA_458","MALTA_470","MAURITIUS_480","MEXICO_484","MOLDOVA_498","MOROCCO_504","MOZAMBIQUE_508","NEPAL_524","NETHERLANDS_528","NEW_CALEDONIA_540","NEW_ZEALAND_554","NICARAGUA_558","NIGERIA_566","NORWAY_578","OMAN_512","PALAU_585","PANAMA_591","PAPUA_NEW_GUINEA_598","PARAGUAY_600","CHINA_156","PERU_604","POLAND_616","PORTUGAL_620","PUERTO_RICO_630","QATAR_634","PHILIPPINES_608","ROMANIA_642","RUSSIA_643","SAUDI_ARABIA_682","SERBIA_688","SINGAPORE_702","SLOVAK_REPUBLIC_703","SLOVENIA_705","SOUTH_AFRICA_710","SPAIN_724","SRI_LANKA_144","SURINAME_740","SWEDEN_752","SWITZERLAND_756","TAIWAN_158","TANZANIA_834","THAILAND_764","REPUBLIC_OF_MACEDONIA_807","TOGO_768","TRINIDAD_Y_TOBAGO_780","TUNISIA_788","TURKEY_792","TURKS_AND_CAICOS_ISLANDS_796","U_A_E_784","US_VIRGIN_ISLANDS_850","UKRAINE_804","UNITED_KINGDOM_826","UNITED_STATES_840","URUGUAY_858","VANUATU_548","VENEZUELA_862","VIETNAM_704"]},"XiqInitializeLocationRequest":{"required":["country","organization"],"type":"object","properties":{"organization":{"type":"string","description":"The organization name."},"country":{"$ref":"#/components/schemas/XiqCountryCode"}}},"XiqAddLegacyLicenseRequest":{"required":["license_key"],"type":"object","properties":{"license_key":{"type":"string","description":"Legacy license key"},"description":{"type":"string","description":"Legacy license description"}}},"XiqAddLegacyLicenseResponse":{"required":["id","license_key"],"type":"object","properties":{"id":{"type":"integer","description":"The unique identifier","format":"int64"},"license_key":{"type":"string","description":"Legacy license key"},"description":{"type":"string","description":"Legacy license description"}}},"XiqCreateLdapServerRequest":{"required":["base_dn","bind_dn","bind_dn_password","destination_port","enable_strip_realm_name","enable_tls","l3_address_profile_id","name","protocol_type","verification_mode"],"type":"object","properties":{"name":{"type":"string","description":"The LDAP server name"},"description":{"type":"string","description":"The LDAP server description(optional)"},"enable_tls":{"type":"boolean","description":"To enable TLS or not, if ture, caCertificateId, clientCertificateId and clientKeyId must be specified"},"bind_dn":{"type":"string","description":"The LDAP server bind DN name"},"bind_dn_password":{"type":"string","description":"The LDAP server bind DN password"},"base_dn":{"type":"string","description":"The RADIUS user base DN"},"l3_address_profile_id":{"type":"integer","description":"The L3 address profile ID","format":"int64"},"protocol_type":{"$ref":"#/components/schemas/XiqLdapProtocolType"},"enable_strip_realm_name":{"type":"boolean","description":"enable strip realm name or not"},"destination_port":{"minimum":1,"type":"integer","description":"The LDAP server destination port (1 ~ 65535)","format":"int32"},"verification_mode":{"$ref":"#/components/schemas/XiqLdapServerVerificationMode"},"ca_certificate_id":{"type":"integer","description":"The CA certificate ID, refer to XiqCertificate","format":"int64"},"client_certificate_id":{"type":"integer","description":"The client certificate ID, refer to XiqCertificate","format":"int64"},"client_key_id":{"type":"integer","description":"The client key ID, refer to XiqCertificate","format":"int64"},"client_key_password":{"type":"string","description":"The LDAP server client key password"}}},"XiqCreateOrganizationRequest":{"required":["name"],"type":"object","properties":{"name":{"type":"string","description":"The organization name, must be unique in VIQ"},"color":{"type":"string","description":"The tagged color for the organization"}}},"XiqOrganization":{"required":["create_time","id","name","type","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"},"org_id":{"type":"integer","description":"The organization identifier, valid when enabling HIQ feature","format":"int64"},"name":{"type":"string","description":"The organization name"},"type":{"$ref":"#/components/schemas/XiqOrganizationType"},"color":{"type":"string","description":"The tagged color for the organization"}}},"XiqOrganizationType":{"type":"string","description":"The organization type","enum":["REGULAR","PRIVATE"]},"XiqCreateEndUserRequest":{"required":["user_group_id","user_name"],"type":"object","properties":{"user_group_id":{"type":"integer","description":"The user group ID","format":"int64"},"name":{"type":"string","description":"The user common name"},"user_name":{"type":"string","description":"The designated username, must match either the user's name, emailAddress, or phoneNumber"},"organization":{"type":"string","description":"The organization name"},"visit_purpose":{"type":"string","description":"The purpose of visit"},"description":{"type":"string","description":"The user description"},"email_address":{"type":"string","description":"The user email"},"phone_number":{"type":"string","description":"The user phone number"},"password":{"type":"string","description":"The user password, if null a random password will be generated base on the user group rule"},"email_password_delivery":{"type":"string","description":"The password delivery Email"},"sms_password_delivery":{"type":"string","description":"The password delivery SMS"}}},"XiqRegenerateEndUserPasswordResponse":{"required":["password"],"type":"object","properties":{"password":{"type":"string","description":"The new password of the end user"}},"description":"The newly generated password for the end user"},"XiqThreadStopCommissionerRequest":{"required":["device_id"],"type":"object","properties":{"device_id":{"type":"integer","description":"The device id","format":"int64"},"interface_name":{"type":"string","description":"The IoT interface on which to stop the Commissioner."}},"description":"The request to stop the thread commissioner on an iot interface of a device."},"XiqThreadStartCommissionerRequest":{"required":["device_id"],"type":"object","properties":{"device_id":{"type":"integer","description":"The device id","format":"int64"},"comm_timeout":{"maximum":2000000,"minimum":1,"type":"integer","description":"After this timeout the Commissioner will shutdown. The default is 120 sec. but the max is approximately 23 days.","format":"int32"},"interface_name":{"type":"string","description":"The IoT interface on which to start the Commissioner."}},"description":"The request to start the thread commissioner on an iot interface of a device."},"XiqUpdateDeviceLevelSsidStatus":{"required":["enabled","if_names","ssid_ids"],"type":"object","properties":{"ssid_ids":{"type":"array","description":"The one or multiple SSID to be disabled/enabled, cannot be empty or no action will be triggered.","items":{"type":"integer","description":"The one or multiple SSID to be disabled/enabled, cannot be empty or no action will be triggered.","format":"int64"}},"if_names":{"type":"array","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.","items":{"$ref":"#/components/schemas/XiqWirelessIfName"}},"enabled":{"type":"boolean","description":"To disable or enable the given device level SSIDs on the wifi interfaces."}},"description":"The request for disable/enable device level ssid."},"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"]},"XiqDeviceLevelSsid":{"required":["ssid_id"],"type":"object","properties":{"ssid_id":{"type":"integer","description":"The SSID ID to override, cannot be null.","format":"int64"},"ssid":{"type":"string","description":"The broadcast ssid name to override. Can only override if the SSID profile is OPEN or PSK mode."},"passphrase":{"type":"string","description":"The ssid passphrase to override. Can only override if the SSID profile is in PSK mode."}},"description":"The ssid/passphrase for device level ssid to override"},"XiqDeviceCreateConfigureIpv4StaticRoute":{"required":["dest_subnetwork","metric","name","next_hop_ip","next_hop_ip_ping_protection","predefined","routing_instance"],"type":"object","properties":{"name":{"type":"string","description":"Name of the static route"},"dest_subnetwork":{"type":"string","description":"Destination subnetwork IP and mask"},"next_hop_ip":{"type":"string","description":"Next hop IP"},"next_hop_ip_ping_protection":{"type":"boolean","description":"Next hop IP ping protection"},"metric":{"type":"integer","description":"Metric set up on a static route","format":"int32"},"routing_instance":{"type":"string","description":"The Routing Instance"},"predefined":{"type":"boolean","description":"The value is predefined and can not be change"}},"description":"IPv4 Static Route model"},"XiqDeviceUpdateConfigureIpv4StaticRoute":{"required":["dest_subnetwork","metric","name","next_hop_ip","next_hop_ip_ping_protection","predefined","routing_instance"],"type":"object","properties":{"name":{"type":"string","description":"Name of the static route"},"dest_subnetwork":{"type":"string","description":"Destination subnetwork IP and mask"},"next_hop_ip":{"type":"string","description":"Next hop IP"},"next_hop_ip_ping_protection":{"type":"boolean","description":"Next hop IP ping protection"},"metric":{"type":"integer","description":"Metric set up on a static route","format":"int32"},"routing_instance":{"type":"string","description":"The Routing Instance"},"predefined":{"type":"boolean","description":"The value is predefined and can not be change"},"ipv4_static_route_id":{"type":"integer","description":"The IPv4 Static Route ID","format":"int64"}},"description":"IPv4 Static Route model"},"XiqDeviceCreateConfigureIpv4Interface":{"required":["enable_dhcp","enable_forwarding","enable_vlan_loopback","ip_address","override_dhcp_relay","predefined","primary_dhcp_server","routing_instance","secondary_dhcp_server","use_ip_addr_as_ospf_router_id"],"type":"object","properties":{"ip_address":{"type":"string","description":"The IPv4 address set on the interface"},"routing_instance":{"type":"string","description":"The Routing Instance"},"enable_forwarding":{"type":"boolean","description":"Indicates whether or not IPv4 is forwarding on the VLAN"},"enable_vlan_loopback":{"type":"boolean","description":"Indicates whether or not Vlan Loopback is enabled on the interface"},"use_ip_addr_as_ospf_router_id":{"type":"boolean","description":"Indicates whether or not to use ip address as ospf router id on the interface"},"override_dhcp_relay":{"type":"boolean","description":"Indicates whether or not to override DHCP relay on the interface"},"enable_dhcp":{"type":"boolean","description":"Indicates whether or not to enable DHCP relay on the interface if override DHCP relay is enabled"},"primary_dhcp_server":{"type":"string","description":"Primary DHCP Server can be set if DHCP is enabled"},"secondary_dhcp_server":{"type":"string","description":"Secondary DHCP Server can be set if DHCP is enabled"},"predefined":{"type":"boolean","description":"The value is predefined and can not be change"},"vlan_id":{"type":"integer","description":"The VLAN attribute ID","format":"int32"}},"description":"IPv4 Interface model"},"XiqDeviceConfigureIpv4InterfaceResponse":{"required":["enable_dhcp","enable_forwarding","enable_vlan_loopback","ip_address","override_dhcp_relay","predefined","primary_dhcp_server","routing_instance","secondary_dhcp_server","use_ip_addr_as_ospf_router_id"],"type":"object","properties":{"ip_address":{"type":"string","description":"The IPv4 address set on the interface"},"routing_instance":{"type":"string","description":"The Routing Instance"},"enable_forwarding":{"type":"boolean","description":"Indicates whether or not IPv4 is forwarding on the VLAN"},"enable_vlan_loopback":{"type":"boolean","description":"Indicates whether or not Vlan Loopback is enabled on the interface"},"use_ip_addr_as_ospf_router_id":{"type":"boolean","description":"Indicates whether or not to use ip address as ospf router id on the interface"},"override_dhcp_relay":{"type":"boolean","description":"Indicates whether or not to override DHCP relay on the interface"},"enable_dhcp":{"type":"boolean","description":"Indicates whether or not to enable DHCP relay on the interface if override DHCP relay is enabled"},"primary_dhcp_server":{"type":"string","description":"Primary DHCP Server can be set if DHCP is enabled"},"secondary_dhcp_server":{"type":"string","description":"Secondary DHCP Server can be set if DHCP is enabled"},"predefined":{"type":"boolean","description":"The value is predefined and can not be change"},"subnetwork_id":{"type":"integer","description":"The Subnetwork ID","format":"int64"},"ipv4_interface_id":{"type":"integer","description":"The IPv4 Interface ID","format":"int64"},"vlan_attribute":{"$ref":"#/components/schemas/XiqDeviceVlanAttributes"}},"description":"IPv4 Interface model"},"XiqDeviceVlanAttributes":{"type":"object","properties":{"name":{"type":"string","description":"Name of the vlan"},"dhcp_snooping_enabled":{"type":"boolean","description":"Whether dhcp snooping is enabled on this vlan"},"dhcp_snooping_action":{"$ref":"#/components/schemas/XiqDeviceVlanAttributesDhcpSnoopingAction"},"igmp_snooping_enabled":{"type":"boolean","description":"Whether igmp snooping is enabled on this vlan"},"immediate_leave":{"type":"boolean","description":"When enabled, the multicast host is removed immediately if it leaves the group"},"always_create":{"type":"boolean","description":"Should the vlan be created irrespective of port bindings"},"vlan_id":{"type":"integer","description":"Id of the vlan","format":"int32"}},"description":"Vlan Attribute model"},"XiqDeviceVlanAttributesDhcpSnoopingAction":{"type":"string","description":"Action to take when rogue DHCP packets are detected","enum":["NONE","DROP_PACKET"]},"XiqDeviceCreateVlanAttributes":{"type":"object","properties":{"name":{"type":"string","description":"Name of the vlan"},"dhcp_snooping_enabled":{"type":"boolean","description":"Whether dhcp snooping is enabled on this vlan"},"dhcp_snooping_action":{"$ref":"#/components/schemas/XiqDeviceVlanAttributesDhcpSnoopingAction"},"igmp_snooping_enabled":{"type":"boolean","description":"Whether igmp snooping is enabled on this vlan"},"immediate_leave":{"type":"boolean","description":"When enabled, the multicast host is removed immediately if it leaves the group"},"always_create":{"type":"boolean","description":"Should the vlan be created irrespective of port bindings"},"vlan_id":{"type":"integer","description":"Id of the vlan","format":"int32"}},"description":"Vlan Attribute model"},"XiqBounceDevicePortRequest":{"type":"object","properties":{"device_id":{"type":"integer","description":"The device id","format":"int64"},"port_number":{"type":"string","description":"The port number of the device (eg. 1,2, ..)"},"bounce_port_reason":{"type":"string","description":"The reason to bounce the port of the device (eg. reset the inline power on the port so that the connected AP can be restarted)"}},"description":"The request for bouncing port of a single device. Includes EXOS, VOSS devices and SR switches"},"XiqBounceDevicePortData":{"type":"object","properties":{"status":{"type":"integer","description":"The status value","format":"int32"},"request_id":{"type":"integer","description":"The requestId of the response","format":"int64"},"results":{"type":"array","description":"The list of results","items":{"$ref":"#/components/schemas/XiqBounceDevicePortOperationResult"}}},"description":"The data required for bounce port response"},"XiqBounceDevicePortOperationResult":{"type":"object","properties":{"status":{"type":"integer","description":"The status value","format":"int32"},"message":{"type":"string","description":"The message"}},"description":"The list required for bounce port response"},"XiqBounceDevicePortResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/XiqBounceDevicePortData"}},"description":"The response for bounce port"},"XiqCliOutput":{"required":["cli","response_code"],"type":"object","properties":{"cli":{"type":"string","description":"The CLI sent to the device"},"response_code":{"$ref":"#/components/schemas/XiqCliResponseCode"},"output":{"type":"string","description":"The CLI output"}},"description":"The CLI output"},"XiqCliResponseCode":{"type":"string","description":"The CLI response code","enum":["UNSPECIFIED","SUCCEED","ERR_DEVICE_NOT_EXIST","ERR_DEVICE_NOT_ACTIVE","ERR_SEND_MESSAGE","ERR_CLI_EXECUTED","ERR_DEVICE_NOT_SUPPORTED","ERR_SIMULATE_NOT_SUPPORTED","ERR_VERSION_NOT_SUPPORTED","ERR_PARSE_FILE","ERR_UNMANAGED_DEVICE","ERR_CLI_NOT_SENT","ERR_TIMEOUT","ERR_VPN_USING","CLI_SENT_SUCCEED","ERR_CLI_MAX_CLI_LIMIT_EXCEEDED"]},"XiqSendCliResponse":{"type":"object","properties":{"device_cli_outputs":{"type":"object","additionalProperties":{"type":"array","description":"device ID -> CLI outputs","items":{"$ref":"#/components/schemas/XiqCliOutput"}},"description":"device ID -> CLI outputs"}},"description":"The response for sending CLIs to devices"},"XiqChangeDevicesOsModeRequest":{"required":["device_ids","target_os"],"type":"object","properties":{"device_ids":{"maxItems":2147483647,"minItems":1,"type":"array","description":"The one or multiple device IDs to change the OS mode. Must be all AP or Switches in the same list. For AP only \"AP_410C\", \"AP_460C\", \"AP_305C\", \"AP_305CX\", \"AP_460S6C\", \"AP_460S12C\", \"AP_302W\" are allowed change to WiNG OS. For Switch: only \"5520\", \"5420F\", \"5420M\" are allowed to change its OS type.","items":{"type":"integer","description":"The one or multiple device IDs to change the OS mode. Must be all AP or Switches in the same list. For AP only \"AP_410C\", \"AP_460C\", \"AP_305C\", \"AP_305CX\", \"AP_460S6C\", \"AP_460S12C\", \"AP_302W\" are allowed change to WiNG OS. For Switch: only \"5520\", \"5420F\", \"5420M\" are allowed to change its OS type.","format":"int64"}},"target_os":{"type":"string","description":"The target OS mode to change to, for AP: only WiNG is supported, for Switch: EXOS or VOSS","example":"WiNG"}},"description":"The request for change the device(s) OS mode."},"XiqDeviceFilter":{"type":"object","properties":{"ids":{"type":"array","description":"The device ID list","items":{"type":"integer","description":"The device ID list","format":"int64"}}},"description":"The filter to get matched devices"},"XiqAssignDevicesNetworkPolicyRequest":{"required":["devices","network_policy_id"],"type":"object","properties":{"devices":{"$ref":"#/components/schemas/XiqDeviceFilter"},"network_policy_id":{"type":"integer","description":"The assigned network policy","format":"int64"}},"description":"Device network policy assignment for multiple devices"},"XiqDeviceLocation":{"required":["create_time","location_name","location_type","location_unique_name","update_time"],"type":"object","properties":{"location_id":{"type":"integer","description":"The assigned location ID, it must NOT be BUILDING type","format":"int64"},"create_time":{"type":"string","description":"The timestamp when the device assigned to the location","format":"date-time"},"update_time":{"type":"string","description":"The timestamp when the location info was last updated","format":"date-time"},"org_id":{"type":"integer","description":"The organization identifier, valid when enabling HIQ feature","format":"int64"},"parent_id":{"type":"integer","description":"The parent location ID","format":"int64"},"location_name":{"type":"string","description":"The location name"},"location_unique_name":{"type":"string","description":"The unique location name"},"location_type":{"type":"string","description":"The location type"},"location_address":{"type":"string","description":"The address for the location"},"x":{"type":"number","description":"The horizontal value in the floor map","format":"double"},"y":{"type":"number","description":"The vertical value in the floor map","format":"double"},"latitude":{"type":"number","description":"The latitude in the geography","format":"double"},"longitude":{"type":"number","description":"The longitude in the geography","format":"double"}},"description":"Device location info"},"XiqAssignDevicesLocationRequest":{"required":["device_location","devices"],"type":"object","properties":{"devices":{"$ref":"#/components/schemas/XiqDeviceFilter"},"device_location":{"$ref":"#/components/schemas/XiqDeviceLocationAssignment"}},"description":"Device location assignment for multiple devices"},"XiqAssignDevicesCountryCodeRequest":{"required":["country_code","devices"],"type":"object","properties":{"devices":{"$ref":"#/components/schemas/XiqDeviceFilter"},"country_code":{"$ref":"#/components/schemas/XiqCountryCode"}},"description":"Device country-code assignment for multiple devices"},"XiqDellDevices":{"required":["sn_to_st"],"type":"object","properties":{"sn_to_st":{"type":"object","additionalProperties":{"type":"string","description":"Serial number -> Service tag"},"description":"Serial number -> Service tag"}},"description":"Dell devices to onboard"},"XiqDigitalTwinDevice":{"required":["make","model","os_version"],"type":"object","properties":{"make":{"$ref":"#/components/schemas/XiqDigitalTwinMake"},"model":{"$ref":"#/components/schemas/XiqDigitalTwinModel"},"os_type":{"type":"string","description":"The Digital Twin device OS type."},"os_version":{"type":"string","description":"The Digital Twin device OS version."},"vim_modules":{"type":"array","description":"The Digital Twin VIM modules.","items":{"$ref":"#/components/schemas/XiqDigitalTwinVimModule"}},"feat_licenses":{"type":"array","description":"The Digital Twin feature licenses.","items":{"$ref":"#/components/schemas/XiqDigitalTwinFeatLicense"}}},"description":"The Digital Twin device to onboard."},"XiqDigitalTwinDevices":{"type":"object","properties":{"dts":{"type":"array","description":"The Digital Twin devices to onboard.","items":{"$ref":"#/components/schemas/XiqDigitalTwinDevice"}}},"description":"Digital Twin devices to onboard"},"XiqDigitalTwinFeatLicense":{"type":"string","description":"The Digital Twin feature licenses.","enum":["PRD_5000_PRMR","PRD_5000_MACSEC","PRD_5320_10G_4P","PRD_5320_10G_8P","PRD_7000_PRMR","PRD_7000_MACSEC"]},"XiqDigitalTwinMake":{"type":"string","description":"The Digital Twin device make.","enum":["SWITCH_ENGINE","FABRIC_ENGINE"]},"XiqDigitalTwinModel":{"type":"string","description":"The Digital Twin device model.","enum":["DT_5320_16P_4XE","DT_5320_16P_4XE_DC","DT_5320_24P_8XE","DT_5320_24T_8XE","DT_5320_48P_8XE","DT_5320_48T_8XE","DT_5420F_16MW_32P_4XE","DT_5420F_16W_32P_4XE","DT_5420F_24P_4XE","DT_5420F_24S_4XE","DT_5420F_24T_4XE","DT_5420F_48P_4XE","DT_5420F_48P_4XL","DT_5420F_48T_4XE","DT_5420F_8W_16P_4XE","DT_5420M_16MW_32P_4YE","DT_5420M_24T_4YE","DT_5420M_24W_4YE","DT_5420M_48T_4YE","DT_5420M_48W_4YE","DT_5520_12MW_36W","DT_5520_24T","DT_5520_24W","DT_5520_24X","DT_5520_48SE","DT_5520_48T","DT_5520_48W","DT_5520_24T_ACDC","DT_5520_48T_ACDC","DT_5520_24X_ACDC","DT_5520_48SE_ACDC","DT_5720_24MW","DT_5720_24MXW","DT_5720_48MW","DT_5720_48MXW","DT_7520_48YE_8CE","DT_7520_48XT_6C","DT_7520_48Y_8C","DT_7720_32C"]},"XiqDigitalTwinVimModule":{"type":"string","description":"The Digital Twin VIM modules.","enum":["DT_5520_VIM_4X","DT_5520_VIM_4XE","DT_5520_VIM_4YE","DT_5720_VIM_2CE","DT_5720_VIM_6YE"]},"XiqExosDevices":{"required":["sns"],"type":"object","properties":{"sns":{"type":"array","description":"The serial numbers","items":{"type":"string","description":"The serial numbers"}}},"description":"ExtremeXOS (EXOS) devices to onboard"},"XiqExtremeDevices":{"required":["sns"],"type":"object","properties":{"sns":{"type":"array","description":"The serial numbers","items":{"type":"string","description":"The serial numbers"}}},"description":"Extreme/Aerohive devices to onboard"},"XiqOnboardDeviceRequest":{"type":"object","properties":{"extreme":{"$ref":"#/components/schemas/XiqExtremeDevices"},"exos":{"$ref":"#/components/schemas/XiqExosDevices"},"voss":{"$ref":"#/components/schemas/XiqVossDevices"},"wing":{"$ref":"#/components/schemas/XiqWingDevices"},"dell":{"$ref":"#/components/schemas/XiqDellDevices"},"dt":{"$ref":"#/components/schemas/XiqDigitalTwinDevices"}},"description":"The payload to onboard devices"},"XiqVossDevices":{"required":["sns"],"type":"object","properties":{"sns":{"type":"array","description":"The serial numbers","items":{"type":"string","description":"The serial numbers"}}},"description":"VSP Operating System Software (VOSS) devices to onboard"},"XiqWingDevices":{"required":["sn_to_mac"],"type":"object","properties":{"sn_to_mac":{"type":"object","additionalProperties":{"type":"string","description":"Serial number -> MAC address"},"description":"Serial number -> MAC address"}},"description":"ExtremeWireless (WiNG) devices to onboard"},"XiqSendCliRequest":{"required":["clis","devices"],"type":"object","properties":{"devices":{"$ref":"#/components/schemas/XiqDeviceFilter"},"clis":{"type":"array","description":"The one or multiple CLIs to send","items":{"type":"string","description":"The one or multiple CLIs to send"}}},"description":"The request for sending CLIs to devices"},"XiqAdvancedOnboardDeviceRequest":{"type":"object","properties":{"extreme":{"type":"array","description":"The selected target devices","items":{"$ref":"#/components/schemas/XiqExtremeDevice"}},"exos":{"type":"array","description":"The selected target devices","items":{"$ref":"#/components/schemas/XiqExosDevice"}},"voss":{"type":"array","description":"The selected target devices","items":{"$ref":"#/components/schemas/XiqVossDevice"}},"wing":{"type":"array","description":"The selected target devices","items":{"$ref":"#/components/schemas/XiqWingDevice"}},"dell":{"type":"array","description":"The selected target devices","items":{"$ref":"#/components/schemas/XiqDellDevice"}},"dt":{"type":"array","description":"The selected target devices","items":{"$ref":"#/components/schemas/XiqDigitalTwinOnboardDevice"}},"unmanaged":{"type":"boolean","description":"Whether to unmanage the devices"}},"description":"The payload to advanced onboard devices"},"XiqDellDevice":{"required":["location","serial_number","service_tag"],"type":"object","properties":{"serial_number":{"type":"string","description":"The serial number"},"service_tag":{"type":"string","description":"The service tag"},"location":{"$ref":"#/components/schemas/XiqDeviceLocationAssignment"},"network_policy_id":{"type":"integer","description":"The assigned network policy","format":"int64"},"hostname":{"type":"string","description":"The device hostname"}},"description":"Dell device to onboard"},"XiqDigitalTwinOnboardDevice":{"required":["digital_twin_device","location"],"type":"object","properties":{"digital_twin_device":{"$ref":"#/components/schemas/XiqDigitalTwinDevice"},"location":{"$ref":"#/components/schemas/XiqDeviceLocationAssignment"},"network_policy_id":{"type":"integer","description":"The assigned network policy","format":"int64"},"hostname":{"type":"string","description":"The device hostname"}},"description":"The Digital Twin device to onboard."},"XiqExosDevice":{"required":["location","serial_number"],"type":"object","properties":{"serial_number":{"type":"string","description":"The serial number"},"location":{"$ref":"#/components/schemas/XiqDeviceLocationAssignment"},"network_policy_id":{"type":"integer","description":"The assigned network policy","format":"int64"},"hostname":{"type":"string","description":"The device hostname"}},"description":"ExtremeXOS (EXOS) device to onboard"},"XiqExtremeDevice":{"required":["location","serial_number"],"type":"object","properties":{"serial_number":{"type":"string","description":"The serial number"},"location":{"$ref":"#/components/schemas/XiqDeviceLocationAssignment"},"network_policy_id":{"type":"integer","description":"The assigned network policy","format":"int64"},"hostname":{"type":"string","description":"The device hostname"}},"description":"Extreme/Aerohive device to onboard"},"XiqVossDevice":{"required":["location","serial_number"],"type":"object","properties":{"serial_number":{"type":"string","description":"The serial number"},"location":{"$ref":"#/components/schemas/XiqDeviceLocationAssignment"},"network_policy_id":{"type":"integer","description":"The assigned network policy","format":"int64"},"hostname":{"type":"string","description":"The device hostname"}},"description":"VSP Operating System Software (VOSS) device to onboard"},"XiqWingDevice":{"required":["location","mac_address","serial_number"],"type":"object","properties":{"serial_number":{"type":"string","description":"The serial number"},"mac_address":{"type":"string","description":"The mac address"},"location":{"$ref":"#/components/schemas/XiqDeviceLocationAssignment"},"network_policy_id":{"type":"integer","description":"The assigned network policy","format":"int64"},"hostname":{"type":"string","description":"The device hostname"}},"description":"ExtremeWireless (WiNG) device to onboard"},"XiqAdvancedOnboardDeviceResponse":{"type":"object","properties":{"success_devices":{"type":"array","description":"The success devices","items":{"$ref":"#/components/schemas/XiqSuccessOnboardDevice"}},"failure_devices":{"type":"array","description":"The failure devices","items":{"$ref":"#/components/schemas/XiqFailureOnboardDevice"}}},"description":"The response for advanced onboard devices"},"XiqFailureOnboardDevice":{"required":["serial_number"],"type":"object","properties":{"serial_number":{"type":"string","description":"The serial number"},"error":{"$ref":"#/components/schemas/XiqOnboardError"}},"description":"The failure onboard device"},"XiqOnboardError":{"type":"string","description":"The onboard error code","enum":["UNKNOWN","SUCCEED","EXIST_IN_REDIRECT","FAILED_IN_DB","FAILED_STORE_IN_REDIRECT","SN_IS_NOT_RIGHT","PRODUCT_TYPE_NOT_EXIST","REACH_MAX_SIZE","NOT_SUPPORT_DEVICE","SN_EXISTED_IN_HM","DEVICE_EXISTED","NETMASK_IP_NOT_NULL","BRANCH_ID_USED","INVALID_SERVICE_TAG","RADIO_WIFI1_NOT_SUPPORT","RADIO_PROFILE_NOT_EXIST","SDR_PROFILE_NOT_EXIST","ADMIN_STATE_NOT_SUPPORT","WIFI_POWER_NOT_SUPPORT","OPERATION_MODE_NOT_SUPPORT","COUNTRY_CODE_NOT_SUPPORT","WIFI0_CHANNEL_NOT_SUPPORT","WIFI1_CHANNEL_NOT_SUPPORT","COUNTRY_CODE_IS_NEEDED","MAC_ADDR_REQUIRED","WING_AP_INVALID_ONBOARDING_DATA","NOT_DUAL_BOOT_AP","INVALID_CSV_LOCATION","NOT_SUPPORTED_FOR_CONNECT","DEVICE_EXISTED_ANOTHER_ACCOUNT","FAILED_IN_DTIS_SERVICE","FAILED_IN_DTIS_MAX_CONCURRENT_LIMIT_REACHED","FAILED_DTINSTANCE_ALREADY_ASSOCIATED","FAILED_IN_DTIS_MAX_OVERALL_LIMIT_REACHED","FAILED_IN_DTIS_MAX_LICENSE_LIMIT_REACHED","FAILED_DTINSTANCE_RELAUNCHED_RECENTLY","FAILED_COPILOT_DISABLED","FAILED_IN_DTIS_MAX_CONCURRENT_LIMIT_REACHED_BY_BATCH","FAILED_IN_DTIS_MAX_OVERALL_LIMIT_REACHED_BY_BATCH","NETWORK_POLICY_NOT_FOUND"]},"XiqSuccessOnboardDevice":{"required":["device_id","serial_number"],"type":"object","properties":{"serial_number":{"type":"string","description":"The serial number"},"device_id":{"type":"integer","description":"The device ID","format":"int64"}},"description":"The success onboard device"},"XiqDeploymentPolicy":{"required":["enable_complete_configuration_update"],"type":"object","properties":{"enable_complete_configuration_update":{"type":"boolean","description":"true if update complete configuration, otherwise update delta configuration. Note: ExtremeCloud IQ will neither upgrade device firmware nor reboot device for a delta configuration push. That means that the other parameters for firmware upgrade and activation are not required when this is false."},"firmware_upgrade_policy":{"$ref":"#/components/schemas/XiqFirmwareUpgradePolicy"},"firmware_activate_option":{"$ref":"#/components/schemas/XiqFirmwareActivateOption"}},"description":"Push configuration and upgrade firmware policy"},"XiqDeploymentRequest":{"required":["devices","policy"],"type":"object","properties":{"devices":{"$ref":"#/components/schemas/XiqDeviceFilter"},"policy":{"$ref":"#/components/schemas/XiqDeploymentPolicy"}},"description":"The configuration deployment request to devices"},"XiqFirmwareActivateOption":{"type":"object","properties":{"enable_activate_at_next_reboot":{"type":"boolean","description":"Activate at next reboot (requires rebooting manually)"},"activation_delay_seconds":{"type":"integer","description":"Activate after the given seconds","format":"int64"},"activation_time":{"type":"integer","description":"Activate at the following time according to the system clock on the updated device","format":"int64"}},"description":"The firmware activate option (Only one of them can be enabled)"},"XiqFirmwareUpgradePolicy":{"required":["enable_distributed_upgrade","enable_enforce_upgrade"],"type":"object","properties":{"enable_enforce_upgrade":{"type":"boolean","description":"Whether enforce firmware upgrade even if the versions are the same"},"enable_distributed_upgrade":{"type":"boolean","description":"Whether enable distributed firmware upgrade (Only applicable to APs)"}},"description":"The firmware upgrade policy"},"XiqDeploymentResponse":{"type":"object","properties":{"request_id":{"type":"integer","format":"int64"}},"description":"The configuration deployment response"},"XiqCreateClassificationRequest":{"required":["classification_type","classification_type_id","match"],"type":"object","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"}},"description":"The details of rule assignments"},"XiqCreateClassificationRuleRequest":{"required":["classifications","name"],"type":"object","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"}}}},"XiqCreateCloudConfigGroupRequest":{"required":["name"],"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"}}}},"XiqCheckPermissionRequest":{"required":["method","uri"],"type":"object","properties":{"uri":{"type":"string","description":"The request HTTP URI"},"method":{"type":"string","description":"The request HTTP method"}}},"XiqCheckPermissionResponse":{"required":["permissions","roles"],"type":"object","properties":{"permissions":{"type":"array","description":"The permission list","items":{"$ref":"#/components/schemas/XiqPermission"}},"roles":{"uniqueItems":true,"type":"array","description":"The role list","items":{"type":"string","description":"The role list"}}}},"XiqPermission":{"required":["category","description","name"],"type":"object","properties":{"name":{"type":"string","description":"The permission name"},"description":{"type":"string","description":"The description for the permission"},"category":{"type":"string","description":"The category for the permission"}},"description":"The permission list"},"XiqGenerateApiTokenRequest":{"required":["permissions"],"type":"object","properties":{"expire_time":{"type":"integer","description":"The token expire time, format is the number of seconds from epoch of 1970-01-01T00:00:00Z. If null means no expiration, the minimum value is current time plus 300 seconds.","format":"int64"},"description":{"type":"string","description":"The token description"},"permissions":{"type":"array","description":"The token permissions","items":{"type":"string","description":"The token permissions"}}}},"XiqGenerateApiTokenResponse":{"required":["access_token","create_time","creator_id","customer_id","permissions"],"type":"object","properties":{"access_token":{"type":"string","description":"The API access token"},"create_time":{"type":"string","description":"The create timestamp","format":"date-time"},"expire_time":{"type":"string","description":"The expire timestamp, if null means no expiration","format":"date-time"},"creator_id":{"type":"integer","description":"The user ID who created the API token","format":"int64"},"customer_id":{"type":"integer","description":"The customer ID who owns the API token","format":"int64"},"description":{"type":"string","description":"The description for the API token"},"permissions":{"type":"array","description":"The permissions for the API token","items":{"type":"string","description":"The permissions for the API token"}}}},"XiqAlertSortField":{"type":"string","description":"All available device sort fields
TIMESTAMP = Last Detected
SOURCE = Source Name","enum":["TIMESTAMP","SOURCE"]},"XiqAlertReport":{"required":["id"],"type":"object","properties":{"id":{"type":"integer","description":"The alert reportId","format":"int64"}},"description":"ExtremeCloud IQ Alert report"},"XiqAcknowledgeAlertsRequest":{"required":["alert_ids"],"type":"object","properties":{"alert_ids":{"type":"array","description":"The alert ID list.","items":{"type":"string","description":"The alert ID list."}}},"description":"The acknowledge alert"},"XiqAlert":{"required":["id","tags","timestamp"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier"},"owner_id":{"type":"integer","description":"The owner ID","format":"int64"},"timestamp":{"type":"string","description":"The alert create time","format":"date-time"},"org_id":{"type":"integer","description":"The organization identifier, valid when enabling HIQ feature","format":"int64"},"message_metadata_id":{"type":"integer","description":"The message metadata id","format":"int64"},"message_metadata_type":{"type":"string","description":"The message metadata type"},"summary":{"type":"string","description":"A high-level, text summary message of the event. Will be used to construct an alert's description."},"severity_name":{"type":"string","description":"The severity name of the alert"},"category_name":{"type":"string","description":"The alert category name"},"severity_id":{"type":"integer","description":"The severity Id of the alert","format":"int64"},"category_id":{"type":"integer","description":"The alert category Id","format":"int64"},"source":{"$ref":"#/components/schemas/XiqAlertSource"},"tags":{"type":"array","description":"Additional information for the alert","items":{"$ref":"#/components/schemas/XiqAlertTag"}},"acknowledged":{"type":"boolean","description":"The acknowledged status of alert"},"site_id":{"type":"integer","description":"The site id of alert","format":"int64"},"site_name":{"type":"string","description":"The site name of alert"},"alert_policy_id":{"type":"integer","description":"The policy id of alert","format":"int64"},"alert_policy_name":{"type":"string","description":"The policy name of alert"},"alert_rule_id":{"type":"integer","description":"The rule id of alert","format":"int64"},"acknowledged_username":{"type":"string","description":"The user's email who acknowledged"}},"description":"The Alert Model"},"XiqAlertSource":{"type":"object","properties":{"source_type_id":{"type":"integer","description":"The alert source type ID","format":"int64"},"source_name":{"type":"string","description":"The alert source name"},"source_type_name":{"type":"string","description":"The alert source type name"},"source_id":{"type":"string","description":"The alert source ID"}},"description":"The alert source info"},"XiqAlertTag":{"required":["id"],"type":"object","properties":{"id":{"type":"integer","description":"The unique identifier for the tag metadata","format":"int64"},"name":{"type":"string","description":"The tag display name."},"value":{"type":"string","description":"The tag value."},"is_hidden":{"type":"boolean","description":"If tag should be hidden from the user."}},"description":"The Alert Tag Model"},"XiqCreateAlertWebhookSubscriptionRequest":{"required":["alert_policy_ids","is_subscribe_all","url"],"type":"object","properties":{"url":{"type":"string","description":"The webhook endpoint URL."},"secret":{"type":"string","description":"The auth secret for the webhook endpoint."},"is_enabled":{"type":"boolean","description":"Enable/disable alert notifications for a webhook url."},"is_subscribe_all":{"type":"boolean","description":"The all alert policy selected flag."},"alert_policy_ids":{"type":"array","description":"The selected alert policy list.","items":{"type":"integer","description":"The selected alert policy list.","format":"int64"}}},"description":"The alert webhook subscription create"},"XiqDeleteBulkAlertSubscriptionRequest":{"required":["ids"],"type":"object","properties":{"ids":{"type":"array","description":"The subscription ID list.","items":{"type":"integer","description":"The subscription ID list.","format":"int64"}}},"description":"Delete bulk alert subscription request"},"XiqBulkDeleteWebhookSubscriptionResult":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"url":{"type":"string"}},"description":"The result of bulk detele webhook susbscriptions"},"XiqBulkOperationResult":{"type":"string","enum":["SUCCESS","PARTIAL_SUCCESS"]},"XiqDeleteBulkAlertSubscriptionWebhookResponse":{"type":"object","properties":{"result":{"$ref":"#/components/schemas/XiqBulkOperationResult"},"reason":{"type":"string"},"unresolved_deletions":{"type":"array","items":{"$ref":"#/components/schemas/XiqBulkDeleteWebhookSubscriptionResult"}}},"description":"The result of bulk detele webhook susbscriptions"},"XiqCreateAlertEmailSubscriptionRequest":{"required":["alert_policy_ids","email","is_subscribe_all"],"type":"object","properties":{"email":{"type":"string","description":"The email address."},"is_enabled":{"type":"boolean","description":"Enable/disable alert notifications for an email."},"is_subscribe_all":{"type":"boolean","description":"The all alert policy selected flag."},"alert_policy_ids":{"type":"array","description":"The selected alert policy list.","items":{"type":"integer","description":"The selected alert policy list.","format":"int64"}}},"description":"The alert email subscription create"},"XiqBulkDeleteEmailSubscriptionResult":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"email":{"type":"string"}},"description":"The result of bulk detele email susbscriptions"},"XiqDeleteBulkAlertSubscriptionEmailResponse":{"type":"object","properties":{"result":{"$ref":"#/components/schemas/XiqBulkOperationResult"},"reason":{"type":"string"},"unresolved_deletions":{"type":"array","items":{"$ref":"#/components/schemas/XiqBulkDeleteEmailSubscriptionResult"}}},"description":"The result of bulk delete email susbscriptions"},"XiqUpdateVlanObjectClassifiedEntryRequest":{"required":["classification_rule_id","vlan_id"],"type":"object","properties":{"vlan_id":{"type":"integer","description":"The VLAN ID","format":"int32"},"classification_rule_id":{"type":"integer","description":"The classification rule ID","format":"int64"}},"description":"The VLAN object classified entries"},"XiqUpdateVlanProfileRequest":{"required":["default_vlan_id","enable_classification","name"],"type":"object","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/XiqUpdateVlanObjectClassifiedEntryRequest"}}}},"XiqUpdateUserRequest":{"type":"object","properties":{"login_name":{"type":"string","description":"Login name, i.e. username or login Email"},"display_name":{"type":"string","description":"The user name to display"},"idle_timeout":{"type":"integer","description":"The idle timeout in minutes.","format":"int32"},"user_role":{"$ref":"#/components/schemas/XiqUserRole"},"location_ids":{"type":"array","description":"The location IDs to reassign.","items":{"type":"integer","description":"The location IDs to reassign.","format":"int64"}}}},"XiqUpdateExternalUserRequest":{"type":"object","properties":{"user_role":{"$ref":"#/components/schemas/XiqUserRole"},"org_id":{"type":"integer","description":"The HIQ organization ID if it is HIQ user, otherwise leave it as empty.","format":"int64"},"location_ids":{"type":"array","description":"The location IDs to assign.","items":{"type":"integer","description":"The location IDs to assign.","format":"int64"}}}},"XiqDeviceUpdateConfigureIpv4Interface":{"required":["enable_dhcp","enable_forwarding","enable_vlan_loopback","ip_address","override_dhcp_relay","predefined","primary_dhcp_server","routing_instance","secondary_dhcp_server","use_ip_addr_as_ospf_router_id"],"type":"object","properties":{"ip_address":{"type":"string","description":"The IPv4 address set on the interface"},"routing_instance":{"type":"string","description":"The Routing Instance"},"enable_forwarding":{"type":"boolean","description":"Indicates whether or not IPv4 is forwarding on the VLAN"},"enable_vlan_loopback":{"type":"boolean","description":"Indicates whether or not Vlan Loopback is enabled on the interface"},"use_ip_addr_as_ospf_router_id":{"type":"boolean","description":"Indicates whether or not to use ip address as ospf router id on the interface"},"override_dhcp_relay":{"type":"boolean","description":"Indicates whether or not to override DHCP relay on the interface"},"enable_dhcp":{"type":"boolean","description":"Indicates whether or not to enable DHCP relay on the interface if override DHCP relay is enabled"},"primary_dhcp_server":{"type":"string","description":"Primary DHCP Server can be set if DHCP is enabled"},"secondary_dhcp_server":{"type":"string","description":"Secondary DHCP Server can be set if DHCP is enabled"},"predefined":{"type":"boolean","description":"The value is predefined and can not be change"},"subnetwork_id":{"type":"integer","description":"The Subnetwork ID","format":"int64"},"vlan_id":{"type":"integer","description":"The VLAN attribute ID","format":"int32"}},"description":"IPv4 Interface model"},"XiqDeviceUpdateVlanAttributes":{"type":"object","properties":{"name":{"type":"string","description":"Name of the vlan"},"dhcp_snooping_enabled":{"type":"boolean","description":"Whether dhcp snooping is enabled on this vlan"},"dhcp_snooping_action":{"$ref":"#/components/schemas/XiqDeviceVlanAttributesDhcpSnoopingAction"},"igmp_snooping_enabled":{"type":"boolean","description":"Whether igmp snooping is enabled on this vlan"},"immediate_leave":{"type":"boolean","description":"When enabled, the multicast host is removed immediately if it leaves the group"},"always_create":{"type":"boolean","description":"Should the vlan be created irrespective of port bindings"}},"description":"Vlan Attribute model"},"PagedXiqVlanProfile":{"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"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqVlanProfile"}}}},"PagedXiqUser":{"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"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqUser"}}}},"PagedXiqExternalUser":{"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"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqExternalUser"}}}},"PagedXiqUserGroup":{"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"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqUserGroup"}}}},"PagedXiqUserProfile":{"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"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqUserProfile"}}}},"PagedXiqTunnelConcentrator":{"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"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqTunnelConcentrator"}}}},"XiqSubscriptionDataType":{"type":"string","description":"The webhook subscription data type.","enum":["LOCATION","AUDIT_LOG","GDPR_LOG","CREDENTIAL_LOG","ACCOUNTING_LOG","AUTHENTICATION_LOG","EMAIL_LOG","SMS_LOG"]},"XiqSubscriptionStatus":{"type":"string","description":"The webhook subscription status.","enum":["ENABLED","DISABLED"]},"XiqWebhookSubscription":{"required":["application","create_time","data_type","id","message_type","secret","status","update_time","url"],"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"},"application":{"type":"string","description":"The external application name."},"url":{"type":"string","description":"The webhook endpoint URL."},"secret":{"type":"string","description":"The basic auth secret for the webhook endpoint."},"data_type":{"$ref":"#/components/schemas/XiqSubscriptionDataType"},"message_type":{"$ref":"#/components/schemas/XiqSubscriptionMessageType"},"status":{"$ref":"#/components/schemas/XiqSubscriptionStatus"}},"description":"The webhook subscription data model"},"PagedXiqSsid":{"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"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqSsid"}}}},"XiqSsid":{"required":["broadcast_name","create_time","id","name","predefined","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"},"org_id":{"type":"integer","description":"The organization identifier, valid when enabling HIQ feature","format":"int64"},"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"},"advanced_settings_id":{"type":"integer","description":"The SSID advanced settings ID.","format":"int64"}},"description":"The SSID"},"XiqSmsTemplate":{"required":["create_time","id","name","password_type","predefined","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"},"org_id":{"type":"integer","description":"The organization identifier, valid when enabling HIQ feature","format":"int64"},"name":{"type":"string","description":"The SMS template name"},"description":{"type":"string","description":"The SMS template description"},"predefined":{"type":"boolean","description":"Wheter or not it is a system prefined template"},"content":{"type":"string","description":"The SMS template content"},"password_type":{"$ref":"#/components/schemas/XiqPasswordType"}},"description":"The password or PPSK notification template for user groups."},"PagedXiqInternalRadiusServer":{"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"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqInternalRadiusServer"}}}},"PagedXiqInternalRadiusDevice":{"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"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqInternalRadiusDevice"}}}},"XiqInternalRadiusDevice":{"required":["create_time","host_name","id","radius_server_id","radius_server_name","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"},"org_id":{"type":"integer","description":"The organization identifier, valid when enabling HIQ feature","format":"int64"},"radius_server_id":{"type":"integer","description":"The RADIUS server id","format":"int64"},"radius_server_name":{"type":"string","description":"The RADIUS server name"},"host_name":{"type":"string","description":"The RADIUS server device hostname"}},"description":"The configuration of internal RADIUS device object"},"PagedXiqExternalRadiusServer":{"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"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqExternalRadiusServer"}}}},"PagedXiqRadiusProxy":{"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"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqRadiusProxy"}}}},"PagedXiqRadiusClientObject":{"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"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqRadiusClientObject"}}}},"PagedXiqRadioProfile":{"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"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqRadioProfile"}}}},"PagedXiqRpMacOuiProfile":{"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"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqRpMacOuiProfile"}}}},"XiqKeyBasedPcg":{"required":["create_time","enabled","id","policy_id","policy_name","ssid_name","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"},"org_id":{"type":"integer","description":"The organization identifier, valid when enabling HIQ feature","format":"int64"},"policy_id":{"type":"integer","description":"The network policy ID","format":"int64"},"policy_name":{"type":"string","description":"The network policy name"},"ssid_name":{"type":"string","description":"The SSID name"},"enabled":{"type":"boolean","description":"Enabled Key Based PCG"},"users":{"type":"array","description":"The XIQ key based PCG users","items":{"$ref":"#/components/schemas/XiqKeyBasedPcgUser"}}},"description":"The response of key based PCG data"},"XiqKeyBasedPcgUser":{"required":["create_time","email","id","name","update_time","user_group_name"],"type":"object","properties":{"name":{"type":"string","description":"The user name of key based PCG, which could not share with other exist key based PCG"},"email":{"type":"string","description":"The email for deliver key based PCG user password"},"user_group_name":{"type":"string","description":"The user group name"},"id":{"type":"integer","description":"The user ID","format":"int64"},"create_time":{"type":"string","description":"The create timestamp","format":"date-time"},"update_time":{"type":"string","description":"The create timestamp","format":"date-time"},"org_id":{"type":"integer","description":"The organization ID","format":"int64"}},"description":"The key based PCG user detailed info"},"XiqGetPortAssignmentDetailsResponse":{"required":["policy_id","policy_name"],"type":"object","properties":{"policy_id":{"type":"integer","description":"The network policy ID","format":"int64"},"policy_name":{"type":"string","description":"The network policy name"},"pcg_port_assignment_entry_details":{"type":"array","description":"The PCG port assignment entry details","items":{"$ref":"#/components/schemas/XiqPcgPortAssignmentEntryDetail"}}},"description":"The response of port assignment details for AP150W"},"XiqPcgPortAssignmentEntryDetail":{"required":["create_time","id","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"},"org_id":{"type":"integer","description":"The organization identifier, valid when enabling HIQ feature","format":"int64"},"device":{"$ref":"#/components/schemas/XiqPcgPortAssignmentEntryDeviceMeta"},"eth1":{"$ref":"#/components/schemas/XiqPcgPortAssignmentEntryEthUserMeta"},"eth2":{"$ref":"#/components/schemas/XiqPcgPortAssignmentEntryEthUserMeta"},"eth3":{"$ref":"#/components/schemas/XiqPcgPortAssignmentEntryEthUserMeta"}},"description":"The PCG port assignment entry detail"},"XiqPcgPortAssignmentEntryDeviceMeta":{"required":["create_time","id","mac_address","product_type","serial_number","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"},"org_id":{"type":"integer","description":"The organization identifier, valid when enabling HIQ feature","format":"int64"},"mac_address":{"type":"string","description":"The mac address"},"serial_number":{"type":"string","description":"The serial number"},"product_type":{"type":"string","description":"The product type"}},"description":"The PCG port assignment entry device info"},"XiqPcgPortAssignmentEntryEthUserMeta":{"required":["create_time","id","name","password","ssids","update_time","user_group_name","user_type"],"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"},"org_id":{"type":"integer","description":"The organization identifier, valid when enabling HIQ feature","format":"int64"},"name":{"type":"string","description":"The user name"},"password":{"type":"string","description":"The user password"},"user_type":{"type":"string","description":"The user type"},"user_group_name":{"type":"string","description":"The user group name"},"ssids":{"type":"array","description":"The SSIDs","items":{"type":"string","description":"The SSIDs"}}},"description":"The PCG port assignment entry of eth user info"},"XiqPacketCaptureSortField":{"type":"string","enum":["NAME","START_TIME","STATUS"]},"XiqPacketCaptureField":{"type":"string","enum":["ID","START_TIME","END_TIME","ORG_ID","NAME","CAPTURE_ID_TYPE","AP_SERIAL_NUMBER","DEVICE_IDS","LOCATION_ID","DURATION","DESTINATION","FILTER","CAPTURE_IF","STATUS","CLOUD_STORAGE","RESULTS"]},"PagedXiqPacketCapture":{"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"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqPacketCapture"}}}},"XiqOperationMetadata":{"required":["cancelable","create_time","expires_in","status","update_time"],"type":"object","properties":{"status":{"$ref":"#/components/schemas/XiqOperationStatus"},"cancelable":{"type":"boolean","description":"Indicates if the operation can be canceled in the current status"},"percentage":{"maximum":100,"minimum":0,"type":"integer","description":"The progress in percentage ranges from 0 to 100 (it's not guaranteed to be accurate)","format":"int32"},"step":{"type":"string","description":"The optional step name for multiple steps operations when the operation is running"},"create_time":{"type":"string","description":"The operation's create time, which is the time when the operation is in PENDING status","format":"date-time"},"update_time":{"type":"string","description":"The operation's last update time","format":"date-time"},"start_time":{"type":"string","description":"The operation's start time, which is the time when the operation is in RUNNING status","format":"date-time"},"end_time":{"type":"string","description":"The operation's end time, which is the time when the operation is done","format":"date-time"},"expires_in":{"type":"integer","description":"The number of seconds remaining until the operation expires and is to be deleted.","format":"int64"}},"description":"The metadata of Long Running Operation (LRO)"},"XiqOperationObject":{"required":["done","id","metadata"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the operation"},"metadata":{"$ref":"#/components/schemas/XiqOperationMetadata"},"done":{"type":"boolean","description":"Whether the operation is done"},"response":{"type":"object","description":"The API response of the operation if the status is SUCCEEDED"},"error":{"$ref":"#/components/schemas/XiqError"}},"description":"Long Running Operation (LRO) model"},"XiqOperationStatus":{"type":"string","description":"The current operation status","enum":["PENDING","RUNNING","CANCELING","SUCCEEDED","FAILED","CANCELED"]},"XiqNetworkPolicyField":{"type":"string","enum":["ID","CREATE_TIME","UPDATE_TIME","ORG_ID","NAME","DESCRIPTION","TYPE","PREDEFINED"]},"XiqNetworkPolicyView":{"type":"string","description":"The logic collections of network policy fields
BASIC: ID, ORG_ID, NAME, TYPE
FULL: All fields
","enum":["BASIC","FULL"]},"PagedXiqNetworkPolicy":{"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"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqNetworkPolicy"}}}},"PagedXiqSmsLog":{"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"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqSmsLog"}}}},"XiqSmsLog":{"required":["id"],"type":"object","properties":{"id":{"type":"integer","description":"The SMS log id","format":"int64"},"user_id":{"type":"integer","description":"The user id","format":"int64"},"customer_id":{"type":"string","description":"The customer id"},"tel":{"type":"string","description":"The phone number"},"profile_name":{"type":"string","description":"The profile name"},"status":{"$ref":"#/components/schemas/XiqSmsLogStatus"},"message_id":{"type":"string","description":"The message id from 3rd provider"},"status_from_provider":{"type":"string","description":"The status from provider"},"provider_type":{"type":"string","description":"The provider type"},"org_id":{"type":"integer","description":"The org id","format":"int64"},"timestamp":{"type":"integer","description":"The audit log timestamp","format":"int64"}},"description":"ExtremeCloud IQ SMS Log"},"XiqSmsLogStatus":{"type":"string","description":"The SMS status","enum":["SEND_OUT","COMPLETE","SUCCESS","FAIL"]},"PagedXiqEmailLog":{"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"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqEmailLog"}}}},"XiqEmailLog":{"required":["id"],"type":"object","properties":{"id":{"type":"integer","description":"The Email log id","format":"int64"},"username":{"type":"string","description":"The username"},"org_id":{"type":"integer","description":"The org id","format":"int64"},"timestamp":{"type":"integer","description":"The email log timestamp","format":"int64"},"user_id":{"type":"integer","description":"The user id","format":"int64"},"customer_id":{"type":"string","description":"The customer id"},"approver_email":{"type":"string","description":"The approver Email"},"status":{"type":"string","description":"The email log status"}},"description":"ExtremeCloud IQ Email Log"},"PagedXiqCredentialLog":{"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"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqCredentialLog"}}}},"XiqCredentialLog":{"required":["id"],"type":"object","properties":{"id":{"type":"integer","description":"The Credential log id","format":"int64"},"username":{"type":"string","description":"The username"},"vhm_id":{"type":"string","description":"The vhm id"},"org_id":{"type":"integer","description":"The org id","format":"int64"},"timestamp":{"type":"integer","description":"The credential log timestamp","format":"int64"}},"description":"ExtremeCloud IQ Credential Log"},"PagedXiqAuthLog":{"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"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqAuthLog"}}}},"XiqAuthLog":{"required":["id"],"type":"object","properties":{"id":{"type":"string","description":"The auth log id"},"auth_type":{"type":"string","description":"The auth type"},"sn":{"type":"string","description":"The serial number"},"vhm_id":{"type":"string","description":"The vhm id"},"username":{"type":"string","description":"The username"},"reply":{"type":"string","description":"The reply"},"called_station_id":{"type":"string","description":"The called station id"},"calling_station_id":{"type":"string","description":"The calling station id"},"auth_date":{"type":"integer","description":"The authentication date","format":"int64"},"ssid":{"type":"string","description":"The ssid"},"identity":{"type":"string","description":"The identity"},"nas_port_type":{"type":"string","description":"The nas port type"},"reject_reason":{"type":"string","description":"The reject reason"},"nas_identifier":{"type":"string","description":"The nas identifier"},"mgmt_mac_address":{"type":"string","description":"The management mac address"},"org_id":{"type":"integer","description":"The org id","format":"int64"},"timestamp":{"type":"integer","description":"The audit log timestamp","format":"int64"}},"description":"ExtremeCloud IQ Auth Log"},"PagedXiqAuditLog":{"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"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqAuditLog"}}}},"XiqAuditLog":{"required":["id"],"type":"object","properties":{"id":{"type":"integer","description":"The audit log id","format":"int64"},"category":{"$ref":"#/components/schemas/XiqAuditLogCategory"},"user_id":{"type":"integer","description":"The user id","format":"int64"},"code":{"type":"integer","description":"The audit log code","format":"int32"},"username":{"type":"string","description":"The user name"},"vhm_name":{"type":"string","description":"The vhm name"},"parameters":{"type":"string","description":"The audit log parameters"},"org_id":{"type":"integer","description":"The org id","format":"int64"},"timestamp":{"type":"integer","description":"The audit log timestamp","format":"int64"},"description":{"type":"string","description":"The audit log summary"}},"description":"ExtremeCloud IQ Audit Log"},"PagedXiqAccountingLog":{"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"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqAccountingLog"}}}},"XiqAccountingLog":{"required":["id"],"type":"object","properties":{"id":{"type":"integer","description":"The Accounting log id","format":"int64"},"username":{"type":"string","description":"The username"},"org_id":{"type":"integer","description":"The org id","format":"int64"},"timestamp":{"type":"integer","description":"The email log timestamp","format":"int64"},"vhm_id":{"type":"string","description":"The vhm id"},"device_serial_number":{"type":"string","description":"The device serial number"},"acct_session_id":{"type":"string","description":"The acct session id"},"acct_multi_id":{"type":"string","description":"The acct multi id"},"group_name":{"type":"string","description":"The group name"},"nas_ip_address":{"type":"string","description":"The nas ip address"},"nas_port":{"type":"string","description":"The nas port"},"nas_port_type":{"type":"string","description":"The nas port type"},"acct_start_time":{"type":"integer","description":"The acct start time","format":"int64"},"acct_stop_time":{"type":"integer","description":"The acct stop time","format":"int64"},"acct_session_time":{"type":"integer","description":"The acct session time","format":"int64"},"acct_authentic":{"type":"string","description":"The acct authentic"},"connect_info":{"type":"string","description":"The connect info"},"acct_input_octets":{"type":"integer","description":"The acct input octets","format":"int64"},"acct_output_octets":{"type":"integer","description":"The acct output octets","format":"int64"},"called_station_id":{"type":"string","description":"The called station id"},"calling_station_id":{"type":"string","description":"The calling station id"},"acct_terminate_cause":{"type":"string","description":"The acct terminate cause"},"service_type":{"type":"string","description":"The service type"},"framed_ip_address":{"type":"string","description":"The framed ip address"},"acct_start_delay":{"type":"integer","description":"The acct start delay","format":"int64"},"acct_stop_delay":{"type":"integer","description":"The acct stop delay","format":"int64"},"ssid":{"type":"string","description":"The ssid"},"identity":{"type":"string","description":"The identity"},"nas_identifier":{"type":"string","description":"The nas identifier"},"mgmt_mac_address":{"type":"string","description":"The management mac address"},"attribute_num":{"type":"integer","description":"The attribute num","format":"int32"},"event_time":{"type":"integer","description":"The event time","format":"int64"},"usage":{"type":"integer","description":"The usage","format":"int64"}},"description":"ExtremeCloud IQ Accounting Log"},"PagedXiqLocationTreeMap":{"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"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqLocationTreeMap"}}}},"XiqLocationTreeMap":{"required":["data","map_name"],"type":"object","properties":{"map_name":{"type":"string","description":"The background map name."},"width":{"type":"number","description":"The x-dimension of the map in pixels.","format":"double"},"height":{"type":"number","description":"The y-dimension of the map in pixels.","format":"double"},"data":{"type":"string","description":"The base-64 encoded string of the map."}},"description":"The map on the location hierarchy."},"PagedXiqLocationTreeDevice":{"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"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqLocationTreeDevice"}}}},"XiqLocationTreeDevice":{"required":["device_name","mac_address"],"type":"object","properties":{"device_name":{"type":"string","description":"The name of the device."},"serial_number":{"type":"string","description":"The device serial number."},"mac_address":{"type":"string","description":"The device MAC address."},"device_function":{"type":"string","description":"The device function, such as AP, Router, Switch, etc."},"product_type":{"type":"string","description":"The product type, such as: AP_230, BR_100, NX9600, etc."},"ip_address":{"type":"string","description":"The device IPv4 address."},"location_id":{"type":"integer","description":"The location ID of the device on the location hierarchy.","format":"int64"},"map_name":{"type":"string","description":"The associated background map for the device."},"x":{"type":"number","description":"The x-position of the device relative to the horizontal scale in meter.","format":"double"},"y":{"type":"number","description":"The y-position of the device relative to the vertical scale in meter.","format":"double"},"scale_x":{"type":"number","description":"The horizontal scale for the background map in meter.","format":"double"},"scale_y":{"type":"number","description":"The vertical scale for the background map in meter.","format":"double"}},"description":"The device on the location hierarchy."},"PagedXiqSite":{"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"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqSite"}}}},"PagedXiqFloor":{"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"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqFloor"}}}},"PagedXiqBuilding":{"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"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqBuilding"}}}},"XiqLicenseQuickFilter":{"type":"string","enum":["ACTIVE","INACTIVE","EXPIRE_0_TO_30_DAYS","EXPIRE_31_TO_60_DAYS","EXPIRE_61_TO_120_DAYS"]},"XiqLicenseHealthColor":{"type":"string","description":"License health color","enum":["GREEN","YELLOW","RED"]},"XiqLicenseHealthState":{"type":"string","description":"License health state","enum":["EXPIRED","INACTIVE","EXPIRING","TRIAL_EXPIRING","ACTIVE_GRACE_PERIOD"]},"XiqLicenseStatus":{"type":"object","properties":{"license_health_color":{"$ref":"#/components/schemas/XiqLicenseHealthColor"},"license_health_state":{"$ref":"#/components/schemas/XiqLicenseHealthState"},"param1":{"type":"string","description":"License health state parameter 1"},"param2":{"type":"string","description":"License health state parameter 2"},"description":{"type":"string","description":"License status description"}},"description":"License status"},"XiqLicenseType":{"type":"object","properties":{"license_type":{"type":"string","description":"License type"},"license_type_display_name":{"type":"string","description":"License type display name"},"license_description":{"type":"string","description":"License description"},"license_entitlement_count":{"type":"integer","description":"Entitlement count of this license type","format":"int32"},"application_id":{"type":"string","description":"Application Id"},"application_name":{"type":"string","description":"Application name"},"status":{"$ref":"#/components/schemas/XiqLicenseStatus"},"total_licenses":{"type":"integer","description":"Total licenses","format":"int32"},"active_licenses":{"type":"integer","description":"Activated licenses","format":"int32"},"available_licenses":{"type":"integer","description":"Available licenses","format":"int32"}},"description":"The license type"},"XiqListLicensesResponse":{"type":"object","properties":{"group_by_application":{"type":"boolean","description":"Whether group by application"},"application_id":{"type":"string","description":"Application Id of current group, valid when groupByApplication is true"},"application_name":{"type":"string","description":"Application name of current group, valid when groupByApplication is true"},"license_type_count":{"type":"integer","description":"License type count of current group, valid when groupByApplication is true","format":"int32"},"license_entitlement_count":{"type":"integer","description":"License entitlement count of current group, valid when groupByApplication is true","format":"int32"},"license_types":{"type":"array","description":"License type list","items":{"$ref":"#/components/schemas/XiqLicenseType"}}},"description":"The license information"},"PagedXiqListLicenseDetailsResponse":{"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"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqListLicenseDetailsResponse"}}}},"XiqLicenseDetailHealthState":{"type":"string","description":"License detail health state","enum":["EXPIRED","INACTIVE","EXPIRING","TRIAL_EXPIRING"]},"XiqLicenseDetailStatus":{"type":"object","properties":{"license_health_color":{"$ref":"#/components/schemas/XiqLicenseHealthColor"},"license_detail_health_state":{"$ref":"#/components/schemas/XiqLicenseDetailHealthState"},"param1":{"type":"string","description":"License detail health state parameter 1"},"param2":{"type":"string","description":"License detail health state parameter 2"},"description":{"type":"string","description":"License detail status description"}},"description":"License detail status"},"XiqListLicenseDetailsResponse":{"type":"object","properties":{"id":{"type":"integer","description":"License id","format":"int64"},"license_key":{"type":"string","description":"License Key"},"status":{"$ref":"#/components/schemas/XiqLicenseDetailStatus"},"devices":{"type":"integer","description":"License device count","format":"int32"},"start_time":{"type":"string","description":"Entitlement start time","format":"date-time"},"end_time":{"type":"string","description":"Entitlement end time","format":"date-time"}},"description":"The license detail information"},"XiqViqLinkedCuidInfo":{"type":"object","properties":{"system_cuid":{"type":"string","description":"The system CUID."},"shared_cuid":{"type":"string","description":"The shared CUID."},"viq_id":{"type":"string","description":"The VIQ Id."},"link_status":{"type":"string","description":"The license link status for the VIQ."},"link_error":{"type":"string","description":"The license link error message for the VIQ."}},"description":"The VIQ-Extreme Portal Account linked CUID information."},"XiqLicenseSummary":{"required":["extreme_portal_linked","legacy_license_added"],"type":"object","properties":{"legacy_license_added":{"type":"boolean","description":"Whether there is legacy license added"},"extreme_portal_linked":{"type":"boolean","description":"Whether Extreme portal account is linked"},"shared_cuid":{"type":"string","description":"Shared Cuid of the Extreme portal account"}},"description":"The license summary"},"XiqNacEntitlementAllocation":{"type":"object","properties":{"allocation_list":{"type":"array","description":"Allocation detail list","items":{"$ref":"#/components/schemas/XiqNacEntitlementAllocationDetail"}},"total_available_nac_licenses":{"type":"integer","description":"Total available NAC license count","format":"int32"},"available_nac_licenses":{"type":"integer","description":"Available NAC license count","format":"int32"}},"description":"The NAC entitlement allocation information"},"XiqNacEntitlementAllocationDetail":{"type":"object","properties":{"owner_id":{"type":"integer","description":"Owner Id","format":"int64"},"serial_no":{"type":"string","description":"Serial number"},"display_name":{"type":"string","description":"Display name"},"percentage":{"type":"number","description":"Allocated percentage","format":"double"},"allocated_devices":{"type":"integer","description":"Allocated device count","format":"int32"}},"description":"The NAC entitlement allocation detail"},"XiqExtremePortalLinkParam":{"type":"object","properties":{"base_url":{"type":"string","description":"Base Url"},"client_id":{"type":"string","description":"Client Id"},"response_type":{"type":"string","description":"Oauth response type, \"code\""},"redirect_url":{"type":"string","description":"Oauth callback Url"},"state":{"type":"string","description":"Oauth state"},"extreme_portal_url":{"type":"string","description":"Extreme portal Url"},"extr_sfdc_license_landing_url":{"type":"string","description":"Extreme portal license landing Url"}},"description":"Extreme portal account link parameter"},"XiqApplicationFilterItem":{"type":"object","properties":{"global":{"type":"boolean","description":"Whether it is an item for all applications"},"application_id":{"type":"string","description":"Application ID, valid when global is false"},"application_name":{"type":"string","description":"Application Name, valid when global is false"},"license_health_color":{"$ref":"#/components/schemas/XiqLicenseHealthColor"}},"description":"The application filter item for listing licenses"},"PagedXiqLdapServer":{"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"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqLdapServer"}}}},"XiqL3AddressProfile":{"required":["address_type","create_time","id","name","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"},"address_type":{"$ref":"#/components/schemas/XiqL3AddressType"},"name":{"type":"string","description":"Address profile name"}}},"XiqL3AddressType":{"type":"string","description":"Address type","enum":["IP_ADDRESS","IP_SUBNET","IP_RANGE"]},"PagedXiqIotProfile":{"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"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqIotProfile"}}}},"XiqHiqStatus":{"required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean","description":"HIQ is enabled or not"}}},"EssentialsElocLastKnownLocation":{"type":"object","properties":{"timestamp":{"type":"string","description":"The located client's last known timestamp in format of date, time and abbreviated timezone"},"x":{"type":"number","description":"The located client's last known horizontal value on the floor plan","format":"double"},"y":{"type":"number","description":"The located client's last known vertical value on the floor plan","format":"double"}},"description":"The client's last known location on the floor plan"},"PagedXiqEndUser":{"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"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqEndUser"}}}},"XiqEmailTemplate":{"required":["create_time","id","name","password_type","predefined","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"},"org_id":{"type":"integer","description":"The organization identifier, valid when enabling HIQ feature","format":"int64"},"name":{"type":"string","description":"The email template name"},"description":{"type":"string","description":"The email template description"},"predefined":{"type":"boolean","description":"Wheter or not it is a system prefined template"},"content":{"type":"string","description":"The email template form."},"enable_preview":{"type":"boolean","description":"The setting to enable preview"},"logo_url":{"type":"string","description":"The logo url"},"icon_url":{"type":"string","description":"The icon url"},"password_type":{"$ref":"#/components/schemas/XiqPasswordType"}},"description":"The password or ppsk notification template for user groups."},"XiqDeviceAdminState":{"type":"string","enum":["NEW","BOOTSTRAP","STAGED","MANAGED","UNMANAGED"]},"XiqDeviceSortField":{"type":"string","description":"All available device sort fields
MAC = Device MAC Address
SN = Device Serial Number","enum":["MAC","SN"]},"XiqDeviceView":{"type":"string","description":"The logic collections of device fields
BASIC: ID, ORG_ID, SERIAL_NUMBER, SERVICE_TAG, MAC_ADDRESS, SIMULATED, DEVICE_FUNCTION, PRODUCT_TYPE, HOSTNAME, IP_ADDRESS, SOFTWARE_VERSION, DEVICE_ADMIN_STATE, CONNECTED, CONFIG_MISMATCH
FULL: All fields
STATUS: ID, DEVICE_ADMIN_STATE, CONNECTED
LOCATION: ID, LOCATION_ID, LOCATIONS
CLIENT: ID, ACTIVE_CLIENTS
DETAIL: ID, ORG_ID, CREATE_TIME, UPDATE_TIME, SERIAL_NUMBER, SERVICE_TAG, MAC_ADDRESS,SIMULATED, DEVICE_FUNCTION, PRODUCT_TYPE, HOSTNAME, IP_ADDRESS, SOFTWARE_VERSION, DEVICE_ADMIN_STATE, CONNECTED, LAST_CONNECT_TIME, DNS_SERVER_ADDRESS, SUBNET_MASK, DEFAULT_GATEWAY, IPV6_ADDRESS, IPV6_NETMASK, DISPLAY_VERSION ,CONFIG_MISMATCH, THREAD_EUI64, THREAD_EXT_MAC","enum":["BASIC","FULL","STATUS","LOCATION","CLIENT","DETAIL"]},"XiqDeviceField":{"type":"string","enum":["ID","CREATE_TIME","UPDATE_TIME","ORG_ID","SERIAL_NUMBER","SERVICE_TAG","MAC_ADDRESS","DEVICE_FUNCTION","PRODUCT_TYPE","HOSTNAME","IP_ADDRESS","SOFTWARE_VERSION","DEVICE_ADMIN_STATE","CONNECTED","LAST_CONNECT_TIME","NETWORK_POLICY_NAME","NETWORK_POLICY_ID","NTP_SERVER_ADDRESS","DNS_SERVER_ADDRESS","SUBNET_MASK","DEFAULT_GATEWAY","IPV6_ADDRESS","IPV6_NETMASK","SIMULATED","DISPLAY_VERSION","ACTIVE_CLIENTS","LOCATION_ID","LOCATIONS","DESCRIPTION","COUNTRY_CODE","LLDP_CDP_INFO","SYSTEM_UP_TIME","CONFIG_MISMATCH","MANAGED_BY","THREAD_EUI64","THREAD_EXT_MAC"]},"XiqDeviceType":{"type":"string","enum":["REAL","DIGITAL_TWIN","SIMULATED"]},"XiqDeviceNullField":{"type":"string","enum":["LOCATION_ID","NETWORK_POLICY_ID"]},"PagedXiqDevice":{"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"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqDevice"}}}},"XiqDevice":{"required":["create_time","id","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"},"org_id":{"type":"integer","description":"The organization identifier, valid when enabling HIQ feature","format":"int64"},"serial_number":{"type":"string","description":"The device serial number, valid for all non-HAC devices"},"service_tag":{"type":"string","description":"The device service tag, valid for all HAC devices"},"mac_address":{"type":"string","description":"The device MAC address"},"device_function":{"$ref":"#/components/schemas/XiqDeviceFunction"},"product_type":{"type":"string","description":"The product type, such as: AP_230, BR_100, NX9600, etc."},"hostname":{"type":"string","description":"The device hostname"},"ip_address":{"type":"string","description":"The device IPv4 address"},"software_version":{"type":"string","description":"The device OS software version"},"device_admin_state":{"$ref":"#/components/schemas/XiqDeviceAdminState"},"connected":{"type":"boolean","description":"The device connection status"},"last_connect_time":{"type":"string","description":"The device last connect time","format":"date-time"},"network_policy_name":{"type":"string","description":"The network policy name for the device"},"network_policy_id":{"type":"integer","description":"The network policy ID for the device","format":"int64"},"primary_ntp_server_address":{"type":"string","description":"The primary NTP server address for the device"},"primary_dns_server_address":{"type":"string","description":"The primary DNS server address for the device"},"subnet_mask":{"type":"string","description":"The subnet mask for the device"},"default_gateway":{"type":"string","description":"The default gateway for the device"},"ipv6_address":{"type":"string","description":"The ipv6 address for the device"},"ipv6_netmask":{"type":"integer","description":"The ipv6 netmask for the device","format":"int32"},"simulated":{"type":"boolean","description":"The device is simulated or not"},"display_version":{"type":"string","description":"The display version for the device"},"active_clients":{"type":"integer","description":"The active client count for the device","format":"int32"},"location_id":{"type":"integer","description":"The location ID for the device","format":"int64"},"locations":{"type":"array","description":"The detailed location","items":{"$ref":"#/components/schemas/XiqLocationLegend"}},"country_code":{"type":"integer","description":"The assigned country code on the device","format":"int32"},"description":{"type":"string","description":"The device description"},"lldp_cdp_infos":{"type":"array","description":"The device LLDP/CDP information","items":{"$ref":"#/components/schemas/XiqDeviceLldpCdpInfo"}},"system_up_time":{"type":"integer","description":"The device uptime","format":"int64"},"config_mismatch":{"type":"boolean","description":"Config audit status(MATCHED or UNMATCHED)"},"managed_by":{"type":"string","description":"The managed application for the device"},"thread0_eui64":{"type":"string","description":"Thread router EUI64"},"thread0_ext_mac":{"type":"string","description":"Thread router extended MAC address"}},"description":"Generic ExtremeCloud IQ Device model"},"XiqDeviceFunction":{"type":"string","description":"The device function, such as AP, Router, Switch, etc.","enum":["AP","ROUTER","ROUTER_AS_L2_VPN_GATEWAY","ROUTER_AS_L3_VPN_GATEWAY","SWITCH","SWITCH_HAC","SWITCH_DELL","L2_VPN_GATEWAY","L3_VPN_GATEWAY"]},"XiqDeviceLldpCdpInfo":{"type":"object","properties":{"port_id":{"type":"string","description":"The port ID."},"system_id":{"type":"string","description":"The system ID."},"system_name":{"type":"string","description":"The system name."},"interface_name":{"type":"string","description":"The interface name."}},"description":"The LLDP/CDP information"},"XiqDeviceLevelSsidStatus":{"required":["wifi0_enabled","wifi1_enabled"],"type":"object","properties":{"wifi0_enabled":{"type":"boolean","description":"The SSID is enabled or not on wifi0 interface"},"wifi1_enabled":{"type":"boolean","description":"The SSID is enabled or not on wifi1 interface"}},"description":"The SSID status"},"XiqDeviceVlanIpv4InterfacesSortField":{"type":"string","description":"All available VLAN IPv4 Interfaces sort fields for a device
VLAN_ID = VLAN ID
IPV4_FORWARDING_ENABLED = Indicates if IPv4 Forwarding is enabled or not on the IPv4 interface
ROUTING_INSTANCE = The Routing instance of the IPv4 interface
IPV4_ADDRESS = IPv4 Address of the interface
IPV4_SUBNET = IPv4 subnet of the interface
","enum":["VLAN_ID","IPV4_FORWARDING_ENABLED","ROUTING_INSTANCE","IPV4_ADDRESS","IPV4_SUBNET"]},"PagedXiqDeviceMonitorVlanIpv4Interfaces":{"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"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqDeviceMonitorVlanIpv4Interfaces"}}}},"XiqDeviceMonitorVlanIpv4Interfaces":{"required":["earliest_refresh_time","latest_refresh_time","latest_refresh_timestamp","vlan_ipv4_interfaces_details"],"type":"object","properties":{"earliest_refresh_time":{"type":"string","description":"the earliest time the refresh was successful"},"latest_refresh_time":{"type":"string","description":"the latest time the refresh was successful"},"latest_refresh_timestamp":{"type":"integer","description":"The latest successful refresh timestamp","format":"int64"},"vlan_ipv4_interfaces_details":{"type":"array","description":"The VLAN IPv4 Interfaces info that are monitored per VLAN on the device","items":{"$ref":"#/components/schemas/XiqDeviceMonitorVlanIpv4InterfacesDetails"}}},"description":"The VLAN IPv4 Interfaces that are monitored per VLAN on the device"},"XiqDeviceMonitorVlanIpv4InterfacesDetails":{"required":["vlan_id"],"type":"object","properties":{"vlan_id":{"type":"integer","description":"The VLAN ID","format":"int32"},"vlan_name":{"type":"string","description":"The VLAN Name"},"ipv4_forwarding_enabled":{"type":"boolean","description":"Indication of IPv4 Forwarding status on the VLAN"},"routing_instance":{"type":"string","description":"The Routing instance name where the IPv4 Interface is configured for this VLAN"},"ipv4_address":{"type":"string","description":"The IPv4 Address of the interface"},"ipv4_subnet":{"type":"string","description":"The IPv4 Subnet of the interface"},"member_ports":{"type":"array","description":"The member ports in the VLAN","items":{"type":"string","description":"The member ports in the VLAN"}},"tagged_ports":{"type":"array","description":"The tagged ports in the VLAN","items":{"type":"string","description":"The tagged ports in the VLAN"}},"untagged_ports":{"type":"array","description":"The untagged ports in the VLAN","items":{"type":"string","description":"The untagged ports in the VLAN"}},"non_forwarding_vlan_enabled":{"type":"boolean","description":"Indicates whether or not this is a Non Forwarding VLAN (learning VLAN)"}},"description":"The VLAN IPv4 Interfaces info that are monitored per VLAN on the device"},"XiqDeviceVlanSortField":{"type":"string","description":"All available VLAN Attributes sort fields for a device
VLAN_ID = VLAN ID
ACTIVE_PORTS = Number of Active ports in the VLAN
IGMP_SNOOPING_ENABLED = Disabled or Enabled
DHCP_SNOOPING_ENABLED = Disabled or Enabled
STP_INSTANCE = STP Instance Name
","enum":["VLAN_ID","ACTIVE_PORTS","IGMP_SNOOPING_ENABLED","DHCP_SNOOPING_ENABLED","STP_INSTANCE"]},"PagedXiqDeviceMonitorVlanAttributes":{"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"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqDeviceMonitorVlanAttributes"}}}},"XiqDeviceMonitorVlanAttributes":{"required":["earliest_refresh_time","latest_refresh_time","latest_refresh_timestamp","vlan_attributes_info"],"type":"object","properties":{"earliest_refresh_time":{"type":"string","description":"the earliest time the refresh was successful"},"latest_refresh_time":{"type":"string","description":"the latest time the refresh was successful"},"latest_refresh_timestamp":{"type":"integer","description":"The latest successful refresh timestamp","format":"int64"},"vlan_attributes_info":{"type":"array","description":"The VLAN attributes info that are monitored per VLAN on the device","items":{"$ref":"#/components/schemas/XiqDeviceMonitorVlanAttributesInfo"}}},"description":"The VLAN attributes that are monitored per VLAN on the device"},"XiqDeviceMonitorVlanAttributesInfo":{"required":["vlan_id"],"type":"object","properties":{"vlan_id":{"type":"integer","description":"The VLAN ID","format":"int32"},"vlan_name":{"type":"string","description":"The VLAN Name"},"active_ports":{"type":"array","description":"The active ports in the VLAN","items":{"type":"string","description":"The active ports in the VLAN"}},"stp_instance":{"type":"string","description":"The STP instance name for the VLAN"},"stp_enabled":{"type":"boolean","description":"Indicates whether or not STP is enabled or disabled on the VLAN"},"igmp_snooping_enabled":{"type":"boolean","description":"Indicates whether or not IGMP Snooping is enabled or disabled on the VLAN"},"dhcp_snooping_enabled":{"type":"boolean","description":"Indicates whether or not DCHP Snooping is enabled or disabled on the VLAN"},"vrf_name":{"type":"string","description":"The name of the VRF for the VLAN"},"dynamic_enabled":{"type":"boolean","description":"Indicates whether or not this is a Dynamic VLAN"},"member_ports":{"type":"array","description":"The member ports in the VLAN","items":{"type":"string","description":"The member ports in the VLAN"}},"tagged_ports":{"type":"array","description":"The tagged ports in the VLAN","items":{"type":"string","description":"The tagged ports in the VLAN"}},"untagged_ports":{"type":"array","description":"The untagged ports in the VLAN","items":{"type":"string","description":"The untagged ports in the VLAN"}},"dynamic_ports":{"type":"array","description":"The dynamic ports in the VLAN","items":{"type":"string","description":"The dynamic ports in the VLAN"}},"non_forwarding_vlan_enabled":{"type":"boolean","description":"Indicates whether or not this is a Non Forwarding VLAN (learning VLAN)"}},"description":"The VLAN attributes info that are monitored per VLAN on the device"},"XiqDeviceIpv4RoutingSortField":{"type":"string","description":"All available IPv4 Routing sort fields for a device
DESTINATION = IPv4 Route Destination
NEXTHOP = Nexthop of the IPv4 Route Destination
VLAN_NAME = VLAN Name of the IPv4 Route
VLAN_ID = VLAN ID of the IPv4 Route
ROUTE_ORIGIN = The route origin of the IPv4 Route
STATUS = The status of the IPv4 Route
METRIC = The metric of the IPv4 Route
AGE = The age of the IPv4 route
ROUTE_TYPE_PRIORITY = The route type priority of the IPv4 Route
ROUTING_INSTANCE = The routing instance of the IPv4 Route
","enum":["DESTINATION","NEXTHOP","VLAN_NAME","VLAN_ID","ROUTE_ORIGIN","STATUS","METRIC","AGE","ROUTE_TYPE_PRIORITY","ROUTING_INSTANCE"]},"XiqDeviceIpv4RoutingRouteOriginField":{"type":"string","description":"All available Route origin type fields for a route on a device
ALL = All the Routes
DIRECT = DIRECT Routes
STATIC = Static Routes
OSPF = OSPF Route
","enum":["ALL","DIRECT","STATIC","OSPF"]},"XiqDeviceIpv4RoutingStatusField":{"type":"string","description":"All available Status types for a route on a device
ALL = Show all Routes
UP = UP Routes
DOWN = DOWN Route
","enum":["ALL","UP","DOWN"]},"PagedXiqDeviceMonitorIpv4Routing":{"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"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqDeviceMonitorIpv4Routing"}}}},"XiqDeviceMonitorIpv4RouteNexthop":{"type":"object","properties":{"nexthop_ipv4_address":{"type":"string","description":"The IPv4 Address of the Nexthop"},"nexthop_device_id":{"type":"integer","description":"The Device ID of the Nexthop","format":"int64"},"nexthop_host_name":{"type":"string","description":"The host name of the Nexthop"},"ping_protection_enabled":{"type":"boolean","description":"Indicates whether or not ping route protection is enabled for Static Routes"},"ping_protection_state":{"type":"string","description":"The state of the IPv4 ping protection gateway"},"ping_protection_last_uptime":{"type":"string","description":"The last time the gateway transitioned to the UP state"},"ping_protection_last_downtime":{"type":"string","description":"The last time the gateway transitioned to the DOWN state"},"routing_instance":{"type":"string","description":"The Routing Instance of the Nexthop"}},"description":"The Nexthop of the IPv4 Route on the device"},"XiqDeviceMonitorIpv4Routing":{"required":["earliest_refresh_time","ipv4_routing_details","latest_refresh_time","latest_refresh_timestamp"],"type":"object","properties":{"earliest_refresh_time":{"type":"string","description":"the earliest time the refresh was successful"},"latest_refresh_time":{"type":"string","description":"the latest time the refresh was successful"},"latest_refresh_timestamp":{"type":"integer","description":"The latest successful refresh timestamp","format":"int64"},"ipv4_routing_details":{"type":"array","description":"The IPv4 Routing detail information that is monitored on the device","items":{"$ref":"#/components/schemas/XiqDeviceMonitorIpv4RoutingDetail"}}},"description":"The Ipv4 Routing that is monitored on the device"},"XiqDeviceMonitorIpv4RoutingDetail":{"required":["destination","vlan_id"],"type":"object","properties":{"destination":{"type":"string","description":"The IPv4 Route destination"},"nexthop":{"$ref":"#/components/schemas/XiqDeviceMonitorIpv4RouteNexthop"},"vlan_id":{"type":"integer","description":"The VLAN ID of the IPv4 Route","format":"int32"},"vlan_name":{"type":"string","description":"The VLAN Name of the IPv4 Route"},"route_origin":{"type":"string","description":"The Route Origin of the IPv4 Route"},"status":{"type":"string","description":"The status of the IPv4 Route"},"metric":{"type":"integer","description":"The metric of the IPv4 Route","format":"int32"},"age":{"type":"integer","description":"The age of the IPv4 Route","format":"int32"},"route_type_priority":{"type":"string","description":"The route type priority of the IPv4 Route"},"routing_instance":{"type":"string","description":"The Routing instance name of the IPv4 Route"}},"description":"The IPv4 Routing info that is monitored on the device"},"XiqDeviceMonitorIpv4RoutingTimeline":{"required":["ipv4_routing_timelines","precision","range_start_time","range_stop_time","response_code","updated"],"type":"object","properties":{"response_code":{"type":"integer","description":"Response code","format":"int32"},"range_start_time":{"type":"integer","description":"Start Time","format":"int64"},"range_stop_time":{"type":"integer","description":"Range stop time","format":"int64"},"updated":{"type":"integer","description":"updated ","format":"int64"},"precision":{"type":"integer","description":"precision","format":"int64"},"ipv4_routing_timelines":{"type":"array","description":"The IPv4 Routing timeline info that are monitored per Routing Instance on the device","items":{"$ref":"#/components/schemas/XiqDeviceMonitorIpv4RoutingTimelineInfo"}}},"description":"The IPv4 Routing Timeline information per Routing instance that is monitored on the device"},"XiqDeviceMonitorIpv4RoutingTimelineInfo":{"type":"object","properties":{"static_routes_count":{"type":"integer","description":"The number of Static routes","format":"int32"},"direct_routes_count":{"type":"integer","description":"The number of Direct routes","format":"int32"},"ospf_routes_count":{"type":"integer","description":"The number of OSPF routes","format":"int32"},"total_routes_count":{"type":"integer","description":"The total number of routes","format":"int32"},"timestamp":{"type":"integer","description":"The timestamp for when route information was collected","format":"int64"},"routing_instance":{"type":"string","description":"The Routing instance name for the routing timeline information"}},"description":"The IPv4 Routing Timeline information per Routing instance that is monitored on the device"},"XiqDeviceWifiInterface":{"type":"object","properties":{"frequency":{"type":"string","description":"The WiFi frequency."},"ssid_count":{"type":"integer","description":"The number of SSID assigned on this wireless interface.","format":"int32"},"client_count":{"type":"integer","description":"The number of clients associated to this wireless interface.","format":"int64"},"neighbor_clients":{"type":"integer","description":"The number of neighboring clients.","format":"int64"},"channel_util":{"type":"integer","description":"The channel utilization.","format":"int32"},"channel":{"type":"integer","description":"The channel associated.","format":"int32"},"channel_width":{"type":"integer","description":"The channel width.","format":"int32"},"tx_utilization":{"type":"integer","description":"The total tx utilization.","format":"int64"},"rx_utilization":{"type":"integer","description":"The total rx utilization.","format":"int64"},"tx_byte_count":{"type":"integer","description":"The total tx byte count.","format":"int64"},"rx_byte_count":{"type":"integer","description":"The total rx byte count.","format":"int64"},"noise_floor":{"type":"integer","description":"The noise floor.","format":"int64"},"crc_error_frame":{"type":"integer","description":"The crc error frame count.","format":"int64"},"tx_retry_frame":{"type":"integer","description":"The tx retry frame","format":"int64"},"rx_retry_frame":{"type":"integer","description":"The rx retry fram.","format":"int64"},"unicast_tx_packet_count":{"type":"integer","description":"The unicast tx packet count.","format":"int64"},"unicast_rx_packet_count":{"type":"integer","description":"The unicast rx packet count.","format":"int64"},"broadcast_tx_packet_count":{"type":"integer","description":"The broadcast tx packet count.","format":"int64"},"broadcast_rx_packet_count":{"type":"integer","description":"The broadcast rx packet count.","format":"int64"},"tx_air_time":{"type":"integer","description":"The tx air time.","format":"int64"},"rx_air_time":{"type":"integer","description":"The rx air time.","format":"int64"},"total_utilization":{"type":"integer","description":"The total utilization.","format":"int64"},"scan_avg_interference":{"type":"integer","description":"The average interference.","format":"int32"},"mac_address":{"type":"string","description":"The bssid."},"power":{"type":"integer","description":"The radio power.","format":"int32"},"rx_errors":{"type":"integer","description":"The rx errors.","format":"int64"},"tx_errors":{"type":"integer","description":"The tx errors.","format":"int64"},"interface_name":{"type":"string","description":"The interface name."},"radio_profile_name":{"type":"string","description":"The ExtremecloudIQ radio profile name."}},"description":"Get the device WiFi interface stats"},"XiqDeviceInstallationReport":{"type":"object","properties":{"onboarded":{"type":"boolean"},"location_name":{"type":"string"},"network_policy_name":{"type":"string"},"device_template_name":{"type":"string"},"ip_address":{"type":"string"},"default_gateway":{"type":"string"},"ntp_server":{"type":"string"},"dns_server":{"type":"string"},"enable_poe":{"type":"boolean"},"xiq_connectivity":{"type":"boolean"},"image_count":{"type":"integer","format":"int32"},"image_names":{"type":"array","items":{"type":"string"}}}},"XiqDeviceIbeacon":{"required":["device_id"],"type":"object","properties":{"device_id":{"type":"integer","description":"The device ID.","format":"int64"},"enabled":{"type":"boolean","description":"Whether the device beacon is enabled."},"major":{"maximum":65635,"minimum":0,"type":"integer","description":"Identification of a subset of beacons in a geographical venue.","format":"int32"},"minor":{"maximum":65635,"minimum":0,"type":"integer","description":"Identification of a beacon in a specific location.","format":"int32"},"power":{"maximum":127,"minimum":-128,"type":"integer","description":"The transmission power in dBm.","format":"int32"},"enable_monitoring":{"type":"boolean","description":"Whether iBeacon monitoring is enabled."}},"description":"The device iBeacon settings."},"XiqDeviceCpuMemoryUsage":{"type":"object","properties":{"average_cpu":{"type":"integer","description":"The device average cpu usage","format":"int32"},"average_memory":{"type":"integer","description":"The device average memory usage","format":"int32"},"timestamp":{"type":"integer","description":"The timestamp for data aggregate","format":"int64"}},"description":"Get time series of the average device cpu and memory usage"},"PagedXiqDeviceConfigureIpv4StaticRoute":{"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"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqDeviceConfigureIpv4StaticRoute"}}}},"XiqDeviceConfigureIpv4StaticRoute":{"required":["dest_subnetwork","metric","name","next_hop_ip","next_hop_ip_ping_protection","predefined","routing_instance"],"type":"object","properties":{"name":{"type":"string","description":"Name of the static route"},"dest_subnetwork":{"type":"string","description":"Destination subnetwork IP and mask"},"next_hop_ip":{"type":"string","description":"Next hop IP"},"next_hop_ip_ping_protection":{"type":"boolean","description":"Next hop IP ping protection"},"metric":{"type":"integer","description":"Metric set up on a static route","format":"int32"},"routing_instance":{"type":"string","description":"The Routing Instance"},"predefined":{"type":"boolean","description":"The value is predefined and can not be change"},"ipv4_static_route_id":{"type":"integer","description":"The IPv4 Static Route ID","format":"int64"}},"description":"IPv4 Static Route model"},"PagedXiqDeviceConfigureIpv4Interface":{"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"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqDeviceConfigureIpv4Interface"}}}},"XiqDeviceConfigureIpv4Interface":{"required":["enable_dhcp","enable_forwarding","enable_vlan_loopback","ip_address","override_dhcp_relay","predefined","primary_dhcp_server","routing_instance","secondary_dhcp_server","use_ip_addr_as_ospf_router_id","vlan_attribute"],"type":"object","properties":{"subnetwork":{"$ref":"#/components/schemas/XiqDeviceSubnetworkIpv4"},"vlan_attribute":{"$ref":"#/components/schemas/XiqDeviceVlanAttributes"},"ip_address":{"type":"string","description":"The IPv4 address set on the interface"},"routing_instance":{"type":"string","description":"The Routing Instance"},"enable_forwarding":{"type":"boolean","description":"Indicates whether or not IPv4 is forwarding on the VLAN"},"enable_vlan_loopback":{"type":"boolean","description":"Indicates whether or not Vlan Loopback is enabled on the interface"},"use_ip_addr_as_ospf_router_id":{"type":"boolean","description":"Indicates whether or not to use ip address as ospf router id on the interface"},"override_dhcp_relay":{"type":"boolean","description":"Indicates whether or not to override DHCP relay on the interface"},"enable_dhcp":{"type":"boolean","description":"Indicates whether or not to enable DHCP relay on the interface if override DHCP relay is enabled"},"primary_dhcp_server":{"type":"string","description":"Primary DHCP Server can be set if DHCP is enabled"},"secondary_dhcp_server":{"type":"string","description":"Secondary DHCP Server can be set if DHCP is enabled"},"predefined":{"type":"boolean","description":"The value is predefined and can not be change"},"ipv4_interface_id":{"type":"integer","description":"The IPv4 Interface ID","format":"int64"}},"description":"IPv4 Interface model"},"XiqDeviceDhcpRelay":{"required":["id","name","platform","primary_server","service_type"],"type":"object","properties":{"id":{"type":"integer","description":"The DHCP relay agent and server ID","format":"int64"},"name":{"type":"string","description":"Name of DHCP relay agent or server"},"description":{"type":"string","description":"Description of DHCP relay agent or server"},"service_type":{"$ref":"#/components/schemas/XiqDhcpServiceType"},"platform":{"$ref":"#/components/schemas/XiqDhcpPlatform"},"primary_server":{"type":"string","description":"Primary Ip server of DHCP agent"},"secondary_server":{"type":"string","description":"Secondary Ip server of DHCP agent"}},"description":"DHCP relay agent and server."},"XiqDeviceSubnetworkIpv4":{"required":["clients_number","enable_dhcp","gateway_ip_type","id","ip_addr_space","name","vlan_profile"],"type":"object","properties":{"id":{"type":"integer","description":"The IPv4 Subnetwork ID","format":"int64"},"name":{"type":"string","description":"Subnetwork name"},"description":{"type":"string","description":"Subnetwork description"},"ip_addr_space":{"type":"string","description":"Subnetwork Ipv4 address"},"gateway_ip_type":{"$ref":"#/components/schemas/XiqGatewayIpType"},"vlan_profile":{"type":"string","description":"The VLAN ID"},"enable_dhcp":{"type":"boolean","description":"Enable DHCP relay server"},"dhcp_relay":{"$ref":"#/components/schemas/XiqDeviceDhcpRelay"},"clients_number":{"type":"integer","description":"Number of clients available for subnetwork","format":"int32"}},"description":"The IPv4 Subnetwork Interface that is configured on the device."},"XiqDhcpPlatform":{"type":"string","description":"Platform type selection XR / AP or VOSS / EXOS","enum":["SWITCH_ENGINE_OR_FABRIC_ENGINE","XR_OR_AP"]},"XiqDhcpServiceType":{"type":"string","description":"Service type DHCP Agent or DHCP Server","enum":["DHCP_RELAY_AGENT","DHCP_SERVER"]},"XiqGatewayIpType":{"type":"string","description":"Subnetwork gateway type","enum":["FIRST","LAST"]},"PagedXiqDeviceVlanAttributes":{"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"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqDeviceVlanAttributes"}}}},"PagedXiqDeviceAlarm":{"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"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqDeviceAlarm"}}}},"XiqDeviceAlarm":{"type":"object","properties":{"entity_id":{"type":"integer","description":"The device ID","format":"int64"},"timestamp":{"type":"integer","description":"The timestamp for alarm created","format":"int64"},"severity":{"type":"string","description":"The severity of the alarm"},"category":{"type":"string","description":"The category of the alarm"},"device_mac":{"type":"string","description":"The device MAC of the alarm"},"client_mac":{"type":"string","description":"The client MAC of the alarm"},"description":{"type":"string","description":"The alarm description"}},"description":"The device alarm view"},"XiqDeviceStats":{"type":"object","properties":{"total_device_count":{"type":"integer","format":"int32"},"managed_device_count":{"type":"integer","format":"int32"},"connected_device_count":{"type":"integer","format":"int32"}}},"PagedXiqRadioEntity":{"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"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqRadioEntity"}}}},"XiqRadio":{"required":["channel_width","mode","name"],"type":"object","properties":{"name":{"type":"string","description":"the radio name"},"channel_number":{"type":"integer","description":"the channel number","format":"int32"},"channel_width":{"type":"string","description":"the channel width"},"mode":{"type":"string","description":"the radio mode"},"mac_address":{"type":"string","description":"the radio MAC address"},"power":{"type":"integer","description":"the radio power","format":"int32"},"clients":{"type":"array","description":"the clients and SSID details","items":{"$ref":"#/components/schemas/XiqWirelessClient"}}},"description":"ExtremeCloud IQ Radio Information associated to a device"},"XiqRadioEntity":{"required":["device_id"],"type":"object","properties":{"device_id":{"type":"integer","description":"the device ID","format":"int64"},"radios":{"type":"array","description":"the radio information associated to device","items":{"$ref":"#/components/schemas/XiqRadio"}}},"description":"ExtremeCloud IQ Radio Information per device"},"XiqSsidAccessSecurityType":{"type":"string","description":"The SSID access security type","enum":["OPEN","ENHANCED_OPEN","PPSK","PSK","WEP","TYPE_802DOT1X"]},"XiqSsidStatus":{"type":"string","description":"The SSID status","enum":["OPEN","CLOSED"]},"XiqWirelessClient":{"type":"object","properties":{"network_policy_name":{"type":"string","description":"The Network Policy Name"},"ssid":{"type":"string","description":"The SSID"},"ssid_status":{"$ref":"#/components/schemas/XiqSsidStatus"},"ssid_security_type":{"$ref":"#/components/schemas/XiqSsidAccessSecurityType"}},"description":"ExtremeCloud IQ BSS and Network Data"},"PagedXiqDigitalTwinProducts":{"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"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqDigitalTwinProducts"}}}},"XiqDigitalTwinProducts":{"required":["make","model","os_versions"],"type":"object","properties":{"make":{"type":"string","description":"The Digital Twin device make."},"model":{"type":"string","description":"The Digital Twin device model."},"os_type":{"type":"string","description":"The Digital Twin device OS type."},"os_versions":{"type":"array","description":"The Digital Twin device OS versions.","items":{"type":"string","description":"The Digital Twin device OS versions."}}},"description":"The Digital Twin product information."},"XiqDeploymentStatus":{"type":"object","properties":{"current_progress":{"type":"integer","description":"The current deploy progress if not finished, range from 0 to 100","format":"int32"},"current_step_code":{"type":"string","description":"The code of the current deploy step if not finished"},"current_step_message":{"type":"string","description":"The readable message of the current deploy step if not finished"},"is_finished_successful":{"type":"boolean","description":"Indicates whether the last deployment is successful if finished"},"last_deploy_time":{"type":"integer","description":"The last deployed time (Only valid when in_progress = false)","format":"int64"},"finished":{"type":"boolean"}},"description":"The configuration deployment status"},"XiqDeploymentOverview":{"required":["in_progress_devices","total_progress"],"type":"object","properties":{"in_progress_devices":{"type":"integer","description":"The device count with in progress deployment","format":"int32"},"total_progress":{"type":"integer","description":"The total progress, range from 0 to 100","format":"int32"}},"description":"The configuration deployment overview"},"PagedXiqCwp":{"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"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqCwp"}}}},"XiqCwp":{"required":["create_time","id","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"},"org_id":{"type":"integer","description":"The organization identifier, valid when enabling HIQ feature","format":"int64"},"name":{"type":"string","description":"The CWP name"}},"description":"The Captive Web Portal Entity."},"XiqCountry":{"type":"object","properties":{"dial_code":{"type":"string","description":"The dialing code for international calls, typically prefixed by the '+' key for mobile."},"alpha2_code":{"type":"string","description":"The country ISO 2-letter code."},"country_code":{"maximum":999,"minimum":1,"type":"integer","description":"The country ISO numeric code.","format":"int32"},"internal_country_codes":{"type":"array","description":"Extreme IQ internal country codes.","items":{"type":"integer","description":"Extreme IQ internal country codes.","format":"int32"}},"short_name":{"type":"string","description":"The country short name."},"name_en":{"type":"string","description":"The country official name in English."},"name_jp":{"type":"string","description":"The country official name in Japanese."},"name_fr":{"type":"string","description":"The country official name in French."},"name_de":{"type":"string","description":"The country official name in German."},"name_it":{"type":"string","description":"The country official name in Italian."},"name_pt":{"type":"string","description":"The country official name in Portuguese."},"name_zh":{"type":"string","description":"The country official name in Chinese."},"name_es":{"type":"string","description":"The country official name in Spanish."},"name_ko":{"type":"string","description":"The country official name in Korean."}}},"XiqWirelessViewsListType":{"type":"string","enum":["SSID","OS"]},"XiqWirelessViewsTypeResponse":{"type":"object","properties":{"views_list_entities":{"type":"array","description":"the wireless getViews entities data","items":{"type":"string","description":"the wireless getViews entities data"}}},"description":"Copilot Wireless getViews Response"},"XiqConnectivityExperienceViewType":{"type":"string","enum":["LOCATION","SSID","OS"]},"XiqForensicBucket":{"type":"string","enum":["TWENTY_FOUR_HOURS","ONE_HOUR","TODAY","ONE_WEEK","SEVEN_DAYS","THIRTY_DAYS","NINETY_DAYS"]},"XiqWirelessTimeToConnectEntity":{"required":["timestamp"],"type":"object","properties":{"timestamp":{"type":"integer","description":"The timestamp","format":"int64"},"quality_index":{"type":"integer","description":"The quality index","format":"int32"},"total_clients":{"type":"integer","description":"The total clients","format":"int32"},"time_to_connect_score":{"type":"integer","description":"The time to connect score","format":"int32"},"above_assoc_threshold":{"type":"integer","description":"The above association threshold","format":"int32"},"above_auth_threshold":{"type":"integer","description":"The above authentication threshold","format":"int32"},"above_dhcp_threshold":{"type":"integer","description":"The above dhcp threshold","format":"int32"},"time_to_assoc":{"type":"integer","description":"The time to associate","format":"int32"},"time_to_auth":{"type":"integer","description":"The time to authenticate","format":"int32"},"time_to_dhcp":{"type":"integer","description":"The time to dhcp","format":"int32"},"performance_score":{"type":"integer","description":"The performance score","format":"int32"}},"description":"ExtremeCloud IQ Connectivity Experience data"},"XiqWirelessTimeToConnectResponse":{"type":"object","properties":{"quality_index_graph":{"type":"array","description":"the wireless timeToConnect entities data","items":{"$ref":"#/components/schemas/XiqWirelessTimeToConnectEntity"}}},"description":"Copilot Wireless TimeToConnect Response"},"XiqWirelessQualityIndexResponse":{"type":"object","properties":{"time_to_connect_score":{"type":"integer","description":"the time to connect score","format":"int32"},"quality_index":{"type":"integer","description":"the quality index","format":"int32"},"performance_score":{"type":"integer","description":"the performance score","format":"int32"}},"description":"Copilot Wireless Quality Index Response"},"XiqWirelessConnectivityPerformanceResponse":{"type":"object","properties":{"quality_index_graph":{"type":"array","description":"The wireless performance entities data","items":{"$ref":"#/components/schemas/XiqWirelessPerformanceEntity"}}},"description":"Copilot Wireless Performance Response"},"XiqWirelessPerformanceEntity":{"required":["timestamp"],"type":"object","properties":{"timestamp":{"type":"integer","description":"The timestamp","format":"int64"},"quality_index":{"type":"integer","description":"The quality index","format":"int32"},"total_clients":{"type":"integer","description":"The total clients","format":"int32"},"time_to_connect_score":{"type":"integer","description":"The time to connect score","format":"int32"},"performance_score":{"type":"integer","description":"The performance score","format":"int32"},"snr":{"type":"integer","description":"The average snr","format":"int32"},"retries_data":{"$ref":"#/components/schemas/XiqWirelessPerformanceRetriesEntity"}},"description":"ExtremeCloud IQ Connectivity Experience Performance data"},"XiqWirelessPerformanceRetriesEntity":{"type":"object","properties":{"rx_retry":{"type":"number","description":"The rx retries","format":"double"},"tx_retry":{"type":"number","description":"The tx retries","format":"double"},"above_retry_threshold":{"type":"number","description":"The above retry threshold","format":"double"}},"description":"ExtremeCloud IQ Connectivity Experience Wireless Performance Retries Details"},"XiqWirelessQualityIndexByLocationResponse":{"type":"object","properties":{"time_to_connect_score":{"type":"integer","description":"the time to connect score","format":"int32"},"quality_index":{"type":"integer","description":"the quality index","format":"int32"},"performance_score":{"type":"integer","description":"the performance score","format":"int32"},"total_clients":{"type":"integer","description":"the performance score","format":"int32"}},"description":"Copilot Wireless Quality Index By Location Response"},"XiqCopilotEventsWirelessSortField":{"type":"string","enum":["AVERAGE_VALUE","AVG_RX_RETRY","AVG_TX_RETRY"]},"XiqCopilotWirelessEventsScoreType":{"type":"string","enum":["TIME_TO_AUTHENTICATE","TIME_TO_ASSOCIATE","TIME_TO_DHCP","DNS","RETRIES"]},"PagedXiqCopilotWirelessEvent":{"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"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqCopilotWirelessEvent"}}}},"XiqCopilotWirelessEvent":{"required":["client_id","mac"],"type":"object","properties":{"average_value":{"type":"number","description":"The average duration to associate/authenticate","format":"double"},"maximum_value":{"type":"number","description":"The maximum duration to associate/authenticate","format":"double"},"mac":{"type":"string","description":"The mac address"},"os_type":{"type":"string","description":"The os type"},"threshold":{"type":"number","description":"The threshold for association/authentication","format":"double"},"hostname":{"type":"string","description":"The hostname"},"ssid":{"type":"string","description":"The SSID"},"client_id":{"type":"string","description":"The unique identifier for clients"},"retries_data":{"$ref":"#/components/schemas/XiqWirelessEventRetriesEntity"}},"description":"ExtremeCloud IQ Connectivity Experience Client Details"},"XiqWirelessEventRetriesEntity":{"type":"object","properties":{"avg_rx_retry":{"type":"number","description":"The average duration of rxRetry","format":"double"},"max_rx_retry":{"type":"number","description":"The maximum duration of rxRetry","format":"double"},"avg_tx_retry":{"type":"number","description":"The average duration of txRetry","format":"double"},"max_tx_retry":{"type":"number","description":"The maximum duration of txRetry","format":"double"},"rx_retry_threshold":{"type":"number","description":"The threshold value of rxRetry","format":"double"},"tx_retry_threshold":{"type":"number","description":"The threshold value of txRetry","format":"double"}},"description":"ExtremeCloud IQ Connectivity Experience Wireless Events Retries Details"},"XiqSortField":{"type":"string","enum":["NAME","QUALITY_INDEX"]},"PagedXiqConnectivityExperienceData":{"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"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqConnectivityExperienceData"}}}},"XiqClientType":{"type":"string","description":"the client type","enum":["WIRELESS","WIRED","UNSPECIFIED"]},"XiqConnectivityExperienceData":{"required":["client_type","name","quality_index","quality_index_graph","quality_index_value","trend_indicator"],"type":"object","properties":{"id":{"type":"string","description":"the unique identifier"},"info":{"type":"string","description":"the info related to connectivity experience view type"},"name":{"type":"string","description":"the location/ssid/os-name based on view type"},"quality_index":{"type":"integer","description":"the quality index","format":"int32"},"quality_index_value":{"$ref":"#/components/schemas/XiqQualityIndex"},"client_type":{"$ref":"#/components/schemas/XiqClientType"},"trend_indicator":{"$ref":"#/components/schemas/XiqTrendIndicator"},"quality_index_graph":{"type":"array","description":"the quality index graph","items":{"$ref":"#/components/schemas/XiqDataPoint"}}},"description":"ExtremeCloud IQ Connectivity Experience data"},"XiqDataPoint":{"required":["timestamp"],"type":"object","properties":{"timestamp":{"type":"integer","description":"The timestamp","format":"int64"},"value":{"type":"number","description":"The data point value"}},"description":"ExtremeCloud IQ Data Point"},"XiqQualityIndex":{"type":"string","description":"the quality index value","enum":["LOW","MEDIUM","HIGH","UNSPECIFIED"]},"XiqTrendIndicator":{"type":"string","description":"the quality index trend indicator","enum":["UP","DOWN","EQUAL","NA"]},"XiqWirelessAppsResponse":{"type":"object","properties":{"total_clients":{"type":"integer","description":"the total clients","format":"int32"},"most_active_app":{"type":"string","description":"the most active app"},"most_active_user":{"type":"string","description":"the most active user"},"total_apps":{"type":"integer","description":"the total apps","format":"int32"},"total_users":{"type":"integer","description":"the total users","format":"int32"}},"description":"Copilot Wireless Apps Response"},"XiqWiredViewType":{"type":"string","enum":["LOCATION"]},"XiqWiredQualityIndexResponse":{"type":"object","properties":{"hardware_score":{"type":"integer","description":"the hardware score","format":"int32"},"quality_index":{"type":"integer","description":"the quality index","format":"int32"}},"description":"Copilot Wired Quality Index Response"},"XiqWiredHardwareByLocationResponse":{"type":"object","properties":{"quality_index_graph":{"type":"array","description":"the wired hardware entities data","items":{"$ref":"#/components/schemas/XiqWiredHardwareEntity"}},"total_affected_ports":{"type":"integer","description":"the total affected ports","format":"int32"},"total_ports":{"type":"integer","description":"the total ports","format":"int32"}},"description":"Copilot Wired Hardware By Location Response"},"XiqWiredHardwareEntity":{"required":["timestamp"],"type":"object","properties":{"quality_index":{"type":"integer","description":"the quality index","format":"int32"},"timestamp":{"type":"integer","description":"the timestamp","format":"int64"},"total_switches":{"type":"integer","description":"the total number of switches","format":"int32"},"affected_ratio":{"type":"integer","description":"the affected ratio","format":"int32"},"affected":{"type":"number","description":"the affected percentage","format":"double"}},"description":"ExtremeCloud IQ Connectivity Experience data"},"XiqWiredHardwareResponse":{"type":"object","properties":{"quality_index_graph":{"type":"array","description":"the wired hardware entities data","items":{"$ref":"#/components/schemas/XiqWiredHardwareEntity"}}},"description":"Copilot Wired Hardware Response"},"XiqCopilotEventsWiredSortField":{"type":"string","enum":["INTERFACE_ERRORS"]},"XiqCopilotWiredEventsScoreType":{"type":"string","enum":["PORT_ERRORS"]},"PagedXiqWiredEventEntity":{"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"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqWiredEventEntity"}}}},"XiqWiredEventEntity":{"type":"object","properties":{"device_id":{"type":"string","description":"the device id"},"hostname":{"type":"string","description":"the host name"},"interface_errors":{"type":"number","description":"the interface errors ratio","format":"double"},"maximum_errors":{"type":"number","description":"the maximum errors ratio","format":"double"},"mgmt_ip":{"type":"string","description":"the management ip"},"port":{"type":"string","description":"the port"},"serial_number":{"type":"string","description":"the device serial number"}},"description":"ExtremeCloud IQ Connectivity Experience data"},"XiqConnectivityDetailsByClientTypeResponse":{"type":"object","properties":{"sites_by_wireless":{"$ref":"#/components/schemas/XiqSitesByWirelessEntity"},"sites_by_wired":{"$ref":"#/components/schemas/XiqSitesByWiredEntity"}},"description":"Connectivity Details by Client Type"},"XiqSitesByWiredEntity":{"type":"object","properties":{"low_quality_score_count":{"type":"integer","description":"Locations count with low severity","format":"int32"},"medium_quality_score_count":{"type":"integer","description":"Locations count with medium severity","format":"int32"},"high_quality_score_count":{"type":"integer","description":"Locations count with high severity","format":"int32"},"total_locations_count":{"type":"integer","description":"Total Locations count by severity","format":"int32"}},"description":"Copilot Sites by Wired"},"XiqSitesByWirelessEntity":{"type":"object","properties":{"low_quality_score_count":{"type":"integer","description":"Locations count with low severity","format":"int32"},"medium_quality_score_count":{"type":"integer","description":"Locations count with medium severity","format":"int32"},"high_quality_score_count":{"type":"integer","description":"Locations count with high severity","format":"int32"},"total_locations_count":{"type":"integer","description":"Total Locations count by severity","format":"int32"}},"description":"Copilot Sites by Wireless"},"XiqAnomaliesCountVoEntity":{"required":["timestamp"],"type":"object","properties":{"timestamp":{"type":"integer","description":"The timestamp","format":"int64"},"total_anomalies_count":{"type":"integer","description":"The total anomalies count","format":"int64"},"wifi_efficiency_count":{"type":"integer","description":"The wifi efficiency count","format":"int64"},"wifi_capacity_count":{"type":"integer","description":"The wifi capacity count","format":"int64"},"poe_count":{"type":"integer","description":"The poe flapping count","format":"int64"},"pe_count":{"type":"integer","description":"The port efficiency count","format":"int64"},"dfs_count":{"type":"integer","description":"The dfs recurrece count","format":"int64"},"mb_cast_count":{"type":"integer","description":"The multibroadcast count","format":"int64"}},"description":"ExtremeCloud IQ Count Entity"},"XiqAssuranceScansOverviewResponse":{"type":"object","properties":{"aggregated_scans_count":{"type":"integer","description":"The aggregated scans count","format":"int64"},"anomalies_count_vos":{"type":"array","description":"the channel stats data","items":{"$ref":"#/components/schemas/XiqAnomaliesCountVoEntity"}}},"description":"Copilot AssuranceScans Overview"},"XiqSessionsDataEntity":{"required":["timestamp"],"type":"object","properties":{"timestamp":{"type":"integer","description":"The timestamp","format":"int64"},"data_rate_failure_percent":{"type":"number","description":"The data rate failure percent ","format":"double"},"client_count":{"type":"integer","description":"The client count","format":"int32"},"normal_failure_percent":{"type":"integer","description":"The normal failure percent","format":"int32"}},"description":"ExtremeCloud IQ Sessions Data"},"XiqWifiEfficiencyStatsResponse":{"type":"object","properties":{"total_client_sessions":{"type":"integer","description":"The total client sessions","format":"int64"},"show_tx_data":{"type":"boolean","description":"The show tx data"},"sessions_data":{"type":"array","description":"The sessions data","items":{"$ref":"#/components/schemas/XiqSessionsDataEntity"}}},"description":"Copilot Wifi Efficiency Stats"},"XiqAnomalyHealthType":{"type":"string","description":" The health score","enum":["NONE","GOOD","MEDIUM","POOR"]},"XiqClientStatsEntity":{"type":"object","properties":{"client_mac":{"type":"string","description":"The client mac"},"client_name":{"type":"string","description":"The client name"},"client_host_os":{"type":"string","description":"The client host os"},"avg_snr":{"type":"integer","description":"The average SNR","format":"int32"},"avg_tx_rate":{"type":"integer","description":"The average TX rate","format":"int32"},"avg_rx_rate":{"type":"integer","description":"The average RX rate","format":"int32"},"client_id":{"type":"integer","description":"The client id","format":"int64"},"avg_rssi":{"type":"integer","description":" The average RSSI ","format":"int32"},"health_score":{"$ref":"#/components/schemas/XiqAnomalyHealthType"}},"description":"ExtremeCloud IQ Client List Stats"},"XiqWifiEfficiencyClientListResponse":{"type":"object","properties":{"client_stats_entities":{"type":"array","description":"the anomaly devices data","items":{"$ref":"#/components/schemas/XiqClientStatsEntity"}}},"description":"Copilot Wifi Efficiency Client List"},"XiqDeviceStatsEntity":{"required":["timestamp"],"type":"object","properties":{"timestamp":{"type":"integer","description":"The timestamp","format":"int64"},"avg_interference_utilization":{"type":"integer","description":"The average interference utilization ","format":"int32"},"avg_tx_utilization":{"type":"integer","description":"The Average Tx Utilization","format":"int32"},"avg_rx_utilization":{"type":"integer","description":"The Average Rx Utilization","format":"int32"},"avg_total_channel_utilization":{"type":"integer","description":"The Average Total Channel Utilization ","format":"int32"},"avg_num_clients":{"type":"integer","description":"The Average Number of Clients","format":"int32"},"normal_interference":{"type":"integer","description":"The normal interference ","format":"int32"}},"description":"ExtremeCloud IQ Device Stats Entity"},"XiqWifiCapacityStatsResponse":{"type":"object","properties":{"device_stats":{"type":"array","description":"The device stats","items":{"$ref":"#/components/schemas/XiqDeviceStatsEntity"}}},"description":"Copilot Wifi Capacity Stats"},"XiqWifiCapacityClientListResponse":{"type":"object","properties":{"client_wifi_stats":{"type":"array","description":"the anomaly devices data","items":{"$ref":"#/components/schemas/XiqClientStatsEntity"}}},"description":"Copilot Wifi Capacity Client List"},"XiqAnomalySeverity":{"type":"string","enum":["NONE","LOW","MEDIUM","HIGH"]},"XiqAnomalySortField":{"type":"string","enum":["LOCATION","SEVERITY","TIME","CATEGORY","ANOMALY_TYPE","DEVICE_NAME"]},"XiqDuplexDataRateEntity":{"required":["timestamp"],"type":"object","properties":{"timestamp":{"type":"integer","description":"The timestamp","format":"int64"},"duplex_mode":{"type":"integer","description":"The duplex mode","format":"int32"},"datarate_mode":{"type":"integer","description":"The data rate mode","format":"int32"}},"description":"ExtremeCloud IQ Duplex DataRate"},"XiqPortEfficiencyStatsResponse":{"type":"object","properties":{"duplex_data_rate_entities":{"type":"array","description":"the duplex data rate data","items":{"$ref":"#/components/schemas/XiqDuplexDataRateEntity"}}},"description":"Copilot Port Efficiency Stats"},"XiqPortEfficiencySpeedDuplexStatsResponse":{"type":"object","properties":{"speed_duplex_entities":{"type":"array","description":"the speed duplex data","items":{"$ref":"#/components/schemas/XiqSpeedDuplexEntity"}}},"description":"Copilot Port Efficiency Speed Duplex Stats"},"XiqSpeedDuplexEntity":{"required":["timestamp"],"type":"object","properties":{"timestamp":{"type":"integer","description":"The timestamp","format":"int64"},"speed_value":{"type":"integer","description":"The speed value","format":"int32"},"duplex_value":{"type":"integer","description":"The duplex value","format":"int32"}},"description":"ExtremeCloud IQ Speed Duplex"},"XiqFlapCountEntity":{"required":["timestamp"],"type":"object","properties":{"timestamp":{"type":"integer","description":"The timestamp","format":"int64"},"flap_count":{"type":"number","description":"The flap count"},"sub_optimal_count":{"type":"integer","description":"The sub-optimal count","format":"int32"},"optimal_time_spent":{"type":"number","description":"The time spent","format":"double"}},"description":"ExtremeCloud IQ FlapCount Point"},"XiqPoeFlappingStatsResponse":{"type":"object","properties":{"summary":{"type":"string","description":"the anomaly location"},"flap_count_entities":{"type":"array","description":"the anomaly devices data","items":{"$ref":"#/components/schemas/XiqFlapCountEntity"}}},"description":"Copilot PoeFlapping Stats"},"XiqAnomaliesNotificationsResponse":{"type":"object","properties":{"total_anomaly_count":{"type":"integer","description":"The total anomaly count","format":"int64"},"location_entity":{"type":"array","description":"the anomaly location","items":{"$ref":"#/components/schemas/XiqAnomalyLocationEntity"}}},"description":"Copilot Anomalies Notification Response"},"XiqAnomalyLocationEntity":{"type":"object","properties":{"location_type":{"$ref":"#/components/schemas/XiqLocationType"},"location_ids":{"type":"array","description":"the location id","items":{"type":"integer","description":"the location id","format":"int64"}},"building_id":{"type":"integer","description":"the building id","format":"int64"},"location_name":{"type":"string","description":"the location name"},"pinned":{"type":"boolean","description":"is location pinned"},"muted":{"type":"boolean","description":"the location muted"},"severity":{"$ref":"#/components/schemas/XiqAnomalySeverity"},"severity_id":{"type":"integer","description":"the severity id","format":"int32"},"summary":{"type":"string","description":"the anomaly summary"},"affected_device_count":{"type":"integer","description":"the affected number of devices","format":"int32"},"last_detected_time":{"type":"integer","description":"the last detected time","format":"int64"},"anomaly_type":{"$ref":"#/components/schemas/XiqAnomalyType"}},"description":"Copilot Anomaly Locations data"},"XiqLocationType":{"type":"string","description":"the location type","enum":["SITE","BUILDING","FLOOR"]},"XiqAnomalyAffectedCount":{"required":["affected_devices_count","affected_location_count","total_anomaly_count"],"type":"object","properties":{"total_anomaly_count":{"type":"integer","description":"The total anomaly count","format":"int32"},"affected_location_count":{"type":"integer","description":"The affected location count","format":"int32"},"affected_devices_count":{"type":"integer","description":"The affected devices count","format":"int32"}},"description":"Copilot Anomalies Affected count"},"XiqCopilotPagedXiqAnomalyLocationEntity":{"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"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqAnomalyLocationEntity"}},"summary":{"type":"string","description":"The summary"},"affected_count":{"$ref":"#/components/schemas/XiqAnomalyAffectedCount"}}},"XiqDfsChannelChangesEntity":{"required":["timestamp"],"type":"object","properties":{"timestamp":{"type":"integer","description":"The timestamp","format":"int64"},"count":{"type":"integer","description":"The count","format":"int32"}},"description":"ExtremeCloud IQ Count Stats"},"XiqDfsRecurenceCountStatsResponse":{"type":"object","properties":{"dfs_channel_changes_entities":{"type":"array","description":"the count stats data","items":{"$ref":"#/components/schemas/XiqDfsChannelChangesEntity"}},"normal":{"type":"integer","description":"The normal count","format":"int32"}},"description":"Copilot DfsRecurrence Count Stats"},"XiqDfsChannelStatsEntity":{"required":["timestamp"],"type":"object","properties":{"timestamp":{"type":"integer","description":"The timestamp","format":"int64"},"channel_number":{"type":"integer","description":"The channel number","format":"int32"}},"description":"ExtremeCloud IQ Channel Stats"},"XiqDfsRecurenceChannelStatsResponse":{"type":"object","properties":{"dfs_channel_stats_entities":{"type":"array","description":"the channel stats data","items":{"$ref":"#/components/schemas/XiqDfsChannelStatsEntity"}},"min_channel":{"type":"integer","description":"The min channel","format":"int32"},"max_channel":{"type":"integer","description":"The max channel","format":"int32"}},"description":"Copilot DfsRecurrence Channel Stats"},"XiqAnomalyDeviceWithLocation":{"required":["anomaly_type","building_id","category","device_id","device_make","device_model","device_name","interface_name","last_detected_time","location_name","muted","severity","switch_stack"],"type":"object","properties":{"building_id":{"type":"integer","description":"The building ID","format":"int64"},"location_name":{"type":"string","description":"The location name"},"muted":{"type":"boolean","description":"To filter muted anomalies"},"severity":{"$ref":"#/components/schemas/XiqAnomalySeverity"},"anomaly_type":{"$ref":"#/components/schemas/XiqAnomalyType"},"last_detected_time":{"type":"integer","description":"The last detected time of anomaly","format":"int64"},"device_id":{"type":"integer","description":"The device ID","format":"int64"},"device_name":{"type":"string","description":"The device name"},"device_model":{"type":"string","description":"The device model"},"device_make":{"type":"string","description":"The device make"},"switch_stack":{"type":"boolean","description":"The device model"},"category":{"$ref":"#/components/schemas/XiqDeviceCategory"},"interface_name":{"type":"string","description":"The interface name"},"location_id":{"type":"integer","description":"The location ID","format":"int64"},"anomaly_id":{"type":"string","description":"The anomaly ID"},"frequency":{"type":"string","description":"The frequency"},"channel_number":{"type":"integer","description":"The channel number","format":"int32"},"channel_mode":{"type":"string","description":"The channel mode"},"recommended_action":{"type":"string","description":"The recommended action"},"issue":{"type":"string","description":"The issue"}},"description":"Copilot Anomaly details with Location"},"XiqCopilotPagedXiqAnomalyDeviceWithLocation":{"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"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqAnomalyDeviceWithLocation"}},"summary":{"type":"string","description":"The summary"},"affected_count":{"$ref":"#/components/schemas/XiqAnomalyAffectedCount"}}},"XiqDeviceCategory":{"type":"string","description":"The wired or wireless category","enum":["WIRED","WIRELESS"]},"XiqAnomalyDeviceEntity":{"type":"object","properties":{"device_id":{"type":"integer","description":"the device id","format":"int64"},"device_name":{"type":"string","description":"the device name"},"pinned":{"type":"boolean","description":"is device pinned"},"wired":{"type":"boolean","description":"is device wired"},"anomaly_id":{"type":"string","description":"the anomaly id"},"severity":{"$ref":"#/components/schemas/XiqAnomalySeverity"},"summary":{"type":"string","description":"the anomaly summary"},"last_detected_time":{"type":"integer","description":"the last detected time","format":"int64"},"recommended_action":{"type":"string","description":"the recommended action"},"anomaly_subtypes":{"type":"string","description":"the anomaly sub-type"},"interface_name":{"type":"string","description":"the interface name"},"channel_mode":{"type":"string","description":"the channel mode : tx or rx"},"channel":{"type":"integer","description":"the channel number","format":"int32"},"frequency":{"type":"string","description":"the frequency"},"location_id":{"type":"integer","description":"the location id","format":"int64"}},"description":"Copilot Anomaly Device data"},"XiqAnomalyDevicesByLocationResponse":{"type":"object","properties":{"location_entity":{"$ref":"#/components/schemas/XiqAnomalyLocationEntity"},"devices":{"type":"array","description":"the anomaly devices data","items":{"$ref":"#/components/schemas/XiqAnomalyDeviceEntity"}}},"description":"Copilot Anomaly Devices"},"XiqAnomaliesSeverityEntity":{"type":"object","properties":{"low_severity_anomalies_count":{"type":"integer","description":"Anomalies count with low severity","format":"int32"},"medium_severity_anomalies_count":{"type":"integer","description":"Anomalies count with medium severity","format":"int32"},"high_severity_anomalies_count":{"type":"integer","description":"Anomalies count with high severity","format":"int32"},"anomalies_count_by_severity":{"type":"integer","description":"Total Anomalies count by severity","format":"int32"}},"description":"Copilot Anomalies By Severity"},"XiqAnomaliesSiteEntity":{"type":"object","properties":{"building_id":{"type":"integer","description":"the location type","format":"int64"},"location_name":{"type":"string","description":"the location type"},"anomalies_count_by_location":{"type":"integer","description":"the location type","format":"int32"}},"description":"Copilot Anomalies By Site"},"XiqAnomaliesTypeEntity":{"type":"object","properties":{"anomaly_type":{"$ref":"#/components/schemas/XiqAnomalyType"},"anomalies_count_by_type":{"type":"integer","description":"Anomalies count with low severity","format":"int32"}},"description":"Copilot Anomalies By Type"},"XiqCopilotAnomaliesByCategory":{"type":"object","properties":{"anomalies_by_location":{"type":"array","description":"The total anomalies by location","items":{"$ref":"#/components/schemas/XiqAnomaliesSiteEntity"}},"anomalies_by_severity":{"$ref":"#/components/schemas/XiqAnomaliesSeverityEntity"},"anomalies_by_type":{"type":"array","description":"The total anomalies by type","items":{"$ref":"#/components/schemas/XiqAnomaliesTypeEntity"}}},"description":"Copilot Anomalies Data by Category"},"XiqAtpPacketCountsEntity":{"required":["timestamp"],"type":"object","properties":{"timestamp":{"type":"integer","description":"The timestamp","format":"int64"},"unicast_tx":{"type":"number","description":"Unicast Tx"},"unicast_rx":{"type":"number","description":"Unicast Rx"},"multicast_tx":{"type":"number","description":"Multicast Tx"},"multicast_rx":{"type":"number","description":"Multicast Rx"},"broadcast_tx":{"type":"number","description":"Broadcast Tx"},"broadcast_rx":{"type":"number","description":"Broadcast Rx"}},"description":"ExtremeCloud IQ Data Point"},"XiqAtpPacketCountsResponse":{"type":"object","properties":{"summary":{"type":"string","description":"the anomaly location"},"atp_packet_counts_entities":{"type":"array","description":"the anomaly device data","items":{"$ref":"#/components/schemas/XiqAtpPacketCountsEntity"}}},"description":"Copilot Atp Device Packet Counts"},"XiqAtpDeviceStatsEntity":{"required":["timestamp"],"type":"object","properties":{"timestamp":{"type":"integer","description":"The timestamp","format":"int64"},"avg_cpu":{"type":"number","description":"Avg Cpu"},"avg_memory":{"type":"number","description":"Avg Memory"},"avg_client_count":{"type":"integer","description":"Avg Client Count","format":"int32"}},"description":"ExtremeCloud IQ Data Point"},"XiqAtpDeviceStatsResponse":{"type":"object","properties":{"summary":{"type":"string","description":"the anomaly location"},"atp_device_stats_entities":{"type":"array","description":"the anomaly devices data","items":{"$ref":"#/components/schemas/XiqAtpDeviceStatsEntity"}}},"description":"Copilot Atp Device Stats"},"XiqClientView":{"type":"string","description":"The logic collections of client fields
BASIC: ID, ORG_ID, HOSTNAME, MAC_ADDRESS, IP_ADDRESS, IPV6_ADDRESS, OS_TYPE, DEVICE_ID,CONNECTED, ONLINE_TIME, OFFLINE_TIME, CONNECTION_TYPE, SSID, PORT
FULL: All fields
STATUS: ID, CONNECTED, ONLINE_TIME, OFFLINE_TIME
DETAIL: ID, CREATE_TIME, UPDATE_TIME, ORG_ID, ORG_NAME, LOCATION_ID, HOSTNAME, MAC_ADDRESS, IP_ADDRESS, IPV6_ADDRESS, OS_TYPE, DEVICE_ID, DEVICE_FUNCTION,DEVICE_NAME, DEVICE_MAC_ADDRESS, USERNAME, USER_PROFILE_NAME, CONNECTED, ONLINE_TIME, OFFLINE_TIME, VLAN, CONNECTION_TYPE, SSID, PORT, BSSID, PORT_TYPE_NAME, INTERFACE_NAME, AUTH, ENCRYPTION_METHOD, CHANNEL, RSSI, SNR, WING_AP, VENDOR, RADIO_TYPE, ALIAS
LOCATION: ID, LOCATION_ID, LOCATIONS
METRICS: ID, CLIENT_HEALTH, APPLICATION_HEALTH, NETWORK_HEALTH, RADIO_HEALTH
IOT: ID, MOBILITY, CATEGORY, DESCRIPTION","enum":["BASIC","FULL","STATUS","DETAIL","LOCATION","METRICS","IOT"]},"XiqClientField":{"type":"string","enum":["ID","CREATE_TIME","UPDATE_TIME","ORG_ID","ORG_NAME","LOCATION_ID","LOCATIONS","HOSTNAME","MAC_ADDRESS","IP_ADDRESS","IPV6_ADDRESS","OS_TYPE","DEVICE_ID","DEVICE_FUNCTION","DEVICE_NAME","USERNAME","USER_PROFILE_NAME","CONNECTED","ONLINE_TIME","OFFLINE_TIME","VLAN","CONNECTION_TYPE","SSID","PORT","BSSID","PORT_TYPE_NAME","INTERFACE_NAME","AUTH","ENCRYPTION_METHOD","CHANNEL","CLIENT_HEALTH","APPLICATION_HEALTH","NETWORK_HEALTH","RADIO_HEALTH","RSSI","SNR","RADIO_TYPE","WING_AP","VENDOR","MOBILITY","CATEGORY","DESCRIPTION","DEVICE_MAC_ADDRESS","ALIAS","PRODUCT_TYPE"]},"XiqClient":{"required":["create_time","id","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"},"org_id":{"type":"integer","description":"The organization identifier, valid when enabling HIQ feature","format":"int64"},"location_id":{"type":"integer","description":"The location ID","format":"int64"},"device_id":{"type":"integer","description":"The device ID","format":"int64"},"hostname":{"type":"string","description":"The hostname of the client"},"mac_address":{"type":"string","description":"The MAC address of the client"},"ip_address":{"type":"string","description":"The IP address of the client"},"ipv6_address":{"type":"string","description":"The IPv6 address of the client"},"os_type":{"type":"string","description":"The OS type of the client"},"username":{"type":"string","description":"The username of the client."},"user_profile_name":{"type":"string","description":"The user profile name of the client"},"connected":{"type":"boolean","description":"Client is connected or not"},"online_time":{"type":"string","description":"The online time for the client","format":"date-time"},"offline_time":{"type":"string","description":"The offline time for the client","format":"date-time"},"vlan":{"type":"integer","description":"The associate VLAN","format":"int32"},"connection_type":{"type":"integer","description":"The connection type","format":"int32"},"ssid":{"type":"string","description":"The SSID"},"port":{"type":"string","description":"The associate device port"},"org_name":{"type":"string","description":"The organization name"},"device_function":{"type":"integer","description":"The associated device function","format":"int32"},"device_mac_address":{"type":"string","description":"The associated device mac address"},"device_name":{"type":"string","description":"The associated device name"},"auth":{"type":"integer","description":"The authentication type","format":"int32"},"channel":{"type":"integer","description":"The channel value","format":"int32"},"client_health":{"type":"integer","description":"The health score of client","format":"int32"},"application_health":{"type":"integer","description":"The health score of application","format":"int32"},"radio_health":{"type":"integer","description":"The health score of radio","format":"int32"},"network_health":{"type":"integer","description":"The health score of network","format":"int32"},"radio_type":{"type":"integer","description":"The radio type","format":"int32"},"encryption_method":{"type":"integer","description":"The encryption method","format":"int32"},"interface_name":{"type":"string","description":"The interface name"},"bssid":{"type":"string","description":"The bssid"},"rssi":{"type":"integer","description":"The RSSI","format":"int32"},"snr":{"type":"integer","description":"The SNR","format":"int32"},"description":{"type":"string","description":"The description of client"},"category":{"type":"string","description":"The category of client"},"mobility":{"type":"string","description":"The client mobility"},"port_type_name":{"type":"string","description":"The client port type name"},"wing_ap":{"type":"boolean","description":"Wing ap flag"},"vendor":{"type":"string","description":"The vendor of client"},"locations":{"type":"array","description":"The detailed location","items":{"$ref":"#/components/schemas/XiqLocationLegend"}},"product_type":{"type":"string","description":"The Category which describes the Extreme device types(For example:For example:SR_2208P, AP_4000, AP_5010)"},"alias":{"type":"string","description":"The alias of the client"}},"description":"The Client associate to ExtremeCloud IQ device"},"XiqClientUsage":{"type":"object","properties":{"client_id":{"type":"integer","description":"The client ID","format":"int64"},"usage":{"type":"integer","description":"The client total usage","format":"int64"}},"description":"The client usage over the period"},"XiqClientSummary":{"type":"object","properties":{"connected_wireless_client_count":{"type":"integer","description":"The connected wireless client count","format":"int64"},"detected_wired_client_count":{"type":"integer","description":"The detected wired client count","format":"int64"},"connected_thread_client_count":{"type":"integer","description":"The connected thread client count","format":"int64"}},"description":"The summary for clients"},"XiqClientSortField":{"type":"string","enum":["AUTH_METHOD","CHANNEL","CONNECTED_VIA","CONNECTION_TYPE","DEVICE_NAME","HOST_NAME","IPV4","IPV6","MAC","NAC_DETAILS","NAC_PROFILE","OS_TYPE","REPORTED_BY","START_TIME","USER_NAME","USER_PROFILE","VLAN"]},"PagedXiqClient":{"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"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqClient"}}}},"PagedXiqClassificationRule":{"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"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqClassificationRule"}}}},"XiqCertificateType":{"type":"string","enum":["CERT","KEY"]},"PagedXiqCertificate":{"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"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqCertificate"}}}},"XiqCertificate":{"required":["create_time","encrypted","file_size","id","name","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"},"cert_type":{"$ref":"#/components/schemas/XiqCertificateType"},"name":{"type":"string","description":"The certificate file name"},"encrypted":{"type":"boolean","description":"The certificate encrypted or not"},"description":{"type":"string","description":"The certificate description"},"file_size":{"type":"integer","description":"The certificate file size","format":"int64"}},"description":"The data in the current page"},"PagedXiqCloudConfigGroup":{"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"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqCloudConfigGroup"}}}},"XiqApiTokenInfo":{"required":["data_center","issued_at","owner_id","role","scopes","user_id","user_name"],"type":"object","properties":{"user_name":{"type":"string","description":"The login username"},"user_id":{"type":"integer","description":"The login user ID","format":"int64"},"role":{"type":"string","description":"The role of login user"},"owner_id":{"type":"integer","description":"The home ownerId of login user","format":"int64"},"data_center":{"type":"string","description":"The home data center of login user"},"scopes":{"type":"array","description":"The login user permissions","items":{"type":"string","description":"The login user permissions"}},"issued_at":{"type":"string","description":"The time at which the JWT was issued","format":"date-time"},"expiration_time":{"type":"string","description":"The expiration time on or after which the JWT MUST NOT be accepted for processing","format":"date-time"},"expires_in":{"type":"integer","description":"The expires in seconds","format":"int64"}}},"XiqApplicationDetectionProtocol":{"type":"string","enum":["HTTP","HTTPS"]},"XiqApplicationDetectionType":{"type":"string","enum":["HOST_NAME","SERVER_IP_ADDRESS","PORT_NUMBER"]},"XiqApplicationSortField":{"type":"string","enum":["NAME","CATEGORY"]},"PagedXiqApplication":{"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"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqApplication"}}}},"XiqApplication":{"required":["create_time","id","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"},"org_id":{"type":"integer","description":"The organization identifier, valid when enabling HIQ feature","format":"int64"},"name":{"type":"string","description":"The application name"},"description":{"type":"string","description":"The application description"},"predefined":{"type":"boolean","description":"Flag to describle 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"}}},"description":"The Application Model"},"XiqApplicationDetectionRule":{"type":"object","properties":{"value":{"type":"string","description":"The value of detection rule type"},"protocol":{"$ref":"#/components/schemas/XiqApplicationDetectionProtocol"},"type":{"$ref":"#/components/schemas/XiqApplicationDetectionType"}},"description":"The Application Detection Rule"},"XiqApplicationTopClientsUsage":{"type":"object","properties":{"application_id":{"type":"integer","description":"The application ID","format":"int64"},"client_id":{"type":"integer","description":"The TOP N client ID","format":"int64"},"client_mac_address":{"type":"string","description":"The MAC address of TOP N client"},"client_host_name":{"type":"string","description":"The host name of TOP N client"},"usage":{"type":"integer","description":"The TOP N client usage","format":"int64"}},"description":"The Top N Clients Usage per Application"},"XiqTopApplicationsUsage":{"type":"object","properties":{"id":{"type":"integer","description":"The application ID","format":"int64"},"name":{"type":"string","description":"The application name"},"clients":{"type":"integer","description":"The associated unique client count","format":"int64"},"users":{"type":"integer","description":"The associated unique user count","format":"int64"},"usage":{"type":"integer","description":"The application usage","format":"int64"}},"description":"The Top N Applications Usage"},"PagedXiqAlert":{"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"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqAlert"}}}},"XiqAlertGroupQuery":{"type":"string","enum":["SEVERITY","CATEGORY","ALERT_TYPE"]},"XiqAlertGroupCount":{"required":["count","group_id"],"type":"object","properties":{"group_id":{"type":"integer","description":"The group unique identifier","format":"int64"},"group_name":{"type":"string","description":"The group name"},"count":{"type":"integer","description":"The count of group","format":"int64"}},"description":"The Alert Group Count Model"},"XiqAlertPolicyType":{"type":"string","enum":["GLOBAL","SITE"]},"XiqListAlertPolicies":{"type":"object","properties":{"global_policy":{"$ref":"#/components/schemas/XiqAlertPolicy"},"site_policies":{"type":"array","description":"The site alert policy List","items":{"$ref":"#/components/schemas/XiqAlertPolicy"}}},"description":"The List Alert Policy Response Model"},"PagedXiqActiveDirectoryServer":{"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"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqActiveDirectoryServer"}}}},"XiqActiveDirectoryServer":{"required":["create_time","id","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"},"org_id":{"type":"integer","description":"The organization identifier, valid when enabling HIQ feature","format":"int64"},"name":{"type":"string","description":"The active directory server name"},"description":{"type":"string","description":"The description for active directory server"},"base_dn":{"type":"string","description":"The base DN of active directory server"},"enable_tls":{"type":"boolean","description":"Flag to enable TLS"},"bind_dn":{"type":"string","description":"The bind DN of active directory server"},"bind_dn_password":{"type":"string","description":"The bind DN password of active directory server"},"domain":{"type":"string","description":"The domain of active directory server"},"computer_ou":{"type":"string","description":"The compute OU of active directory server"},"domain_admin":{"type":"string","description":"The domain admin of active directory server"},"domain_admin_password":{"type":"string","description":"The domain admin password of active directory server"},"enable_save_domain_admin_credentials":{"type":"boolean","description":"Flag to enable save domain admin credentials"},"short_domain":{"type":"string","description":"The short domain of active directory server"},"realm":{"type":"string","description":"The realm of active directory server"},"base_dn_fetch_mode":{"$ref":"#/components/schemas/XiqActiveDirectoryServerBaseDnFetchMode"},"connection_setup_device_id":{"type":"integer","description":"The connection setup device ID for active directory server","format":"int64"},"l3_address_profile_id":{"type":"integer","description":"The associate L3 address profile ID for active directory server","format":"int64"}},"description":"The configuration of Active Directory Server"},"XiqActiveDirectoryServerBaseDnFetchMode":{"type":"string","description":"The base DN fetch mode of active directory server","enum":["AUTO","MANUAL"]},"XiqEntitlementType":{"type":"string","description":"The entitlement key type","enum":["EVALUATION","PERMANENT","RENEW","UNKNOWN"]},"XiqLicenseMode":{"type":"string","description":"The license mode","enum":["BUY","PLANNER","EVAL","MSP","UNKNOWN"]},"XiqViq":{"type":"object","properties":{"devices":{"type":"integer","description":"Total # of all licensed devices","format":"int32"},"standalone":{"type":"boolean","description":"Returns true if HIQ is not enabled, otherwise returns false"},"expired":{"type":"boolean","description":"Whether VIQ is expired"},"customer_id":{"type":"string","description":"The customer ID, also known as Salesforce customer ID"},"vhm_id":{"type":"string","description":"The VIQ ID"},"owner_id":{"type":"integer","description":"The owner account ID","format":"int64"},"licenses":{"type":"array","description":"The license list","items":{"$ref":"#/components/schemas/XiqViqLicense"}}}},"XiqViqLicense":{"required":["create_time","id","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"},"status":{"$ref":"#/components/schemas/XiqLicenseStatus"},"active_date":{"type":"string","description":"The active date","format":"date-time"},"expire_date":{"type":"string","description":"The expire date","format":"date-time"},"entitlement_key":{"type":"string","description":"The entitlement key"},"entitlement_type":{"$ref":"#/components/schemas/XiqEntitlementType"},"mode":{"$ref":"#/components/schemas/XiqLicenseMode"},"devices":{"type":"integer","description":"The device number","format":"int32"},"activated":{"type":"integer","description":"The activated device number","format":"int32"},"available":{"type":"integer","description":"The available device number","format":"int32"},"license_type":{"type":"string","description":"The Gemalto license type"}},"description":"The license list"},"XiqDefaultDevicePassword":{"required":["password"],"type":"object","properties":{"password":{"type":"string","description":"The default device password"}},"description":"The default device password"},"XiqAccount":{"required":["account_mode","account_type","create_time","data_center","id","name","quota","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"},"name":{"type":"string","description":"Account name"},"account_type":{"$ref":"#/components/schemas/XiqAccountType"},"account_mode":{"$ref":"#/components/schemas/XiqAccountMode"},"quota":{"type":"string","description":"The API quota policy"},"data_center":{"type":"string","description":"The default Regional Data Center (RDC) to hold data from customer network"},"industry":{"type":"string","description":"The industry of the account belongs to"},"country":{"type":"string","description":"The country for the account"},"state":{"type":"string","description":"The state for the account (if any)"},"city":{"type":"string","description":"The city for the account"},"address":{"type":"string","description":"The address for the account"},"zipcode":{"type":"string","description":"The zipcode of the address"}}},"XiqAccountMode":{"type":"string","description":"Account mode","enum":["COPILOT","CONNECT"]},"XiqAccountType":{"type":"string","description":"Account type","enum":["INTERNAL","CUSTOMER","HIQ","PARTNER"]},"XiqExternalAccount":{"required":["active","alias","create_time","data_center","id","name","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"},"name":{"type":"string","description":"The external account name"},"alias":{"type":"string","description":"The external account alias"},"active":{"type":"boolean","description":"Enable or not"},"data_center":{"type":"string","description":"The data center to store the VIQ data"}}},"XiqDeleteKeyBasedPcgUsersRequest":{"required":["user_ids"],"type":"object","properties":{"user_ids":{"type":"array","description":"The user ID list","items":{"type":"integer","description":"The user ID list","format":"int64"}}},"description":"The payload of delete Key Based Private Client Group users request"}},"securitySchemes":{"BearerAuth":{"type":"http","description":"JSON Web Token (JWT) based authentication","scheme":"bearer","bearerFormat":"JWT"}}}}