{"openapi":"3.1.0","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":"25.12.0-123"},"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":"Use Folder Preferences","description":"User folder preferences"},{"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":"Client - Details","description":"The details of client associate to the devices of ExtremeCloud IQ"},{"name":"Switch Inspector Panel","description":"Get the switch inspector panel"},{"name":"D360","description":"D360 API Endpoint"},{"name":"Dashboard","description":"Dashboard"},{"name":"Dashboard Wired Usage and Capacity","description":"Get the dashboard for usage and capacity"},{"name":"Dashboard Wired Client Health","description":"Get the dashboard for client health"},{"name":"Dashboard Wired Device Health","description":"Get the dashboard for wired device health"},{"name":"Dashboard Wireless Usage and Capacity","description":"Get the dashboard for usage and capacity health"},{"name":"Dashboard Wireless Client Health","description":"Get the dashboard for client health"},{"name":"Dashboard Wireless Device Health","description":"Get the dashboard for device health"},{"name":"Geo View","description":"Geo View API Endpoint"},{"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":"Administration","description":"API Token Management, 3rd Party API Connections, Credential Distribution Groups"},{"name":"NOS","description":"Get device info by NOS"},{"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":"Network Scorecard","description":"The scorecard containing device, client, network, wifi and services health of the selected location."},{"name":"Essentials - ExtremeLocation","description":"The ExtremeLocation and Analytics API"},{"name":"Misc","description":"Metadata - Country/..."},{"name":"Thread","description":"The thread mesh network topology"},{"name":"NG Reports (Ondemand)","description":"Supports following metrics"},{"name":"NG Reports (Scheduled)","description":"NG Scheduled Reports & Recipients API Endpoint"},{"name":"Universal Compute Platform","description":"Universal Compute Platform"}],"paths":{"/v1/account/viq/default-device-password":{"put":{"tags":["Account"],"summary":"Update the default device password in the account (with validation)","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_with_validation"},"operationId":"updateDefaultDevicePasswordWithValidation","requestBody":{"description":"The new default device password","content":{"application/json":{"schema":{"type":"string"}}},"required":true},"responses":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqUserGroup"}}}}},"security":[{"Bearer":[]}]},"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":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqUserProfile"}}}}},"security":[{"Bearer":[]}]},"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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqUserProfile"}}}}},"security":[{"Bearer":[]}]},"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":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/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"},"operationId":"getTunnelConcentrator","parameters":[{"name":"id","in":"path","description":"The Tunnel Concentrator ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqTunnelConcentrator"}}}}},"security":[{"Bearer":[]}]},"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"},"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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqTunnelConcentrator"}}}}},"security":[{"Bearer":[]}]},"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"},"operationId":"deleteTunnelConcentrator","parameters":[{"name":"id","in":"path","description":"The TunnelConcentrator ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/third-party-api-connection":{"get":{"tags":["Administration"],"summary":"List third party api connections","description":"List a page of third party api connections.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_list_third_party_api_connection"},"operationId":"listThirdPartyApiConnections","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/XiqThirdPartyApiConnection"}}}}}},"security":[{"Bearer":[]}]},"put":{"tags":["Administration"],"summary":"Update a third party api connection","description":"The payload to update 3rd party API connection.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_update_third_party_api_connection"},"operationId":"updateThirdPartyApiConnection","requestBody":{"description":"The payload to update 3rd party API connection.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqUpdateThirdPartyApiConnectionRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqThirdPartyApiConnection"}}}}},"security":[{"Bearer":[]}]},"delete":{"tags":["Administration"],"summary":"Delete a third party api connection","description":"Delete 3rd party API connection.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_delete_third_party_api_connection"},"operationId":"deleteThirdPartyApiConnection","responses":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/subscriptions/webhook/{id}":{"put":{"tags":["Notification"],"summary":"Update webhook subscription","description":"Update webhook subscription by ID.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_update_webhook_subscription"},"operationId":"updateWebhookSubscription","parameters":[{"name":"id","in":"path","description":"The webhook subscription ID","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"description":"The body of update webhook subscription API","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqUpdateWebhookSubscriptionRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqWebhookSubscription"}}}}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqSsidAdvancedSettings"}}}}},"security":[{"Bearer":[]}]},"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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqSsidAdvancedSettings"}}}}},"security":[{"Bearer":[]}]}},"/site/afc/schedule":{"get":{"tags":["afc-endpoint"],"operationId":"getSiteAfcSchedule","parameters":[{"name":"ownerId","in":"query","description":"Owner Id","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"folderId","in":"query","description":"Folder Id","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqSiteAfcSchedule"}}}}},"security":[{"Bearer":[]}]},"put":{"tags":["afc-endpoint"],"operationId":"updateSiteAfcSchedule","requestBody":{"description":"AFC site schedule request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqSiteAfcSchedule"}}},"required":true},"responses":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]},"post":{"tags":["afc-endpoint"],"operationId":"createSiteAfcSchedule","requestBody":{"description":"AFC site schedule request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqSiteAfcSchedule"}}},"required":true},"responses":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/radsec-proxies/{id}":{"get":{"tags":["Configuration - Authentication"],"summary":"Get the RADSEC proxy configuration","description":"Get an existing RADSEC proxy configuration by ID.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_the_radsec_proxy_configuration_by_id"},"operationId":"getRadsecProxy","parameters":[{"name":"id","in":"path","description":"The RADSEC proxy ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqRadsecProxy"}}}}},"security":[{"Bearer":[]}]},"put":{"tags":["Configuration - Authentication"],"summary":"Update RADSEC proxy configuration","description":"Update RADSEC proxy configuration by ID.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_update_radsec_proxy_configuration"},"operationId":"updateRadsecProxy","parameters":[{"name":"id","in":"path","description":"The RADSEC proxy ID","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"description":"The body of update RADSEC proxy API","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqUpdateRadsecProxyRequest"},"examples":{"Update an existing RADSEC proxy":{"summary":"Update an existing RADSEC proxy","description":"The payload to update an existing RADSEC proxy","value":{"name":"radsec-proxy-1","description":"Radsec Proxy 1","format_type":"NAI","enable_inject_operator_name_attribute":true,"realms":[{"id":1},{"id":2},{"name":"test-realm","enable_strip_realm_name":false,"external_radius_server_object_ids":[3000,3001]}]}}}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqRadsecProxy"}}}}},"security":[{"Bearer":[]}]},"delete":{"tags":["Configuration - Authentication"],"summary":"Delete the RADSEC proxy configuration","description":"Delete an existing RADSEC proxy configuration by ID.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_delete_radsec_proxy_configuration"},"operationId":"deleteRadsecProxy","parameters":[{"name":"id","in":"path","description":"The RADSEC proxy ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqInternalRadiusServer"}}}}},"security":[{"Bearer":[]}]},"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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqInternalRadiusServer"}}}}},"security":[{"Bearer":[]}]},"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":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqExternalRadiusServer"}}}}},"security":[{"Bearer":[]}]},"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":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]},"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":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqRadiusProxy"}}}}},"security":[{"Bearer":[]}]},"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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqRadiusProxy"}}}}},"security":[{"Bearer":[]}]},"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":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqRadiusClientObject"}}}}},"security":[{"Bearer":[]}]},"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":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]},"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":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqRadioProfile"}}}}},"security":[{"Bearer":[]}]},"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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqRadioProfile"}}}}},"security":[{"Bearer":[]}]},"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":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqRpWmmQosSettings"}}}}},"security":[{"Bearer":[]}]},"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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqRpWmmQosSettings"}}}}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqRpSensorScanSettings"}}}}},"security":[{"Bearer":[]}]},"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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqRpSensorScanSettings"}}}}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqRpRadioUsageOptimization"}}}}},"security":[{"Bearer":[]}]},"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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqRpRadioUsageOptimization"}}}}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqRpNeighborhoodAnalysis"}}}}},"security":[{"Bearer":[]}]},"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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqRpNeighborhoodAnalysis"}}}}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqRpMiscellaneousSettings"}}}}},"security":[{"Bearer":[]}]},"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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqRpMiscellaneousSettings"}}}}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqRpMacOuiProfile"}}}}},"security":[{"Bearer":[]}]},"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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqRpMacOuiProfile"}}}}},"security":[{"Bearer":[]}]},"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":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqRpChannelSelection"}}}}},"security":[{"Bearer":[]}]},"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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqRpChannelSelection"}}}}},"security":[{"Bearer":[]}]}},"/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"}},{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"integer","format":"int32","default":1,"minimum":1}},{"name":"limit","in":"query","description":"Page Size","required":false,"schema":{"type":"integer","format":"int32","default":10,"maximum":100,"minimum":1}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqKeyBasedPcgUser"}}}}},"security":[{"Bearer":[]}]},"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":{"202":{"description":"Accepted"}},"security":[{"Bearer":[]}]},"post":{"tags":["Configuration - User Management"],"summary":"[LRO] 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"}},{"name":"async","in":"query","description":"Whether to enable async mode","required":false,"schema":{"type":"boolean","default":false}}],"requestBody":{"description":"The payload of add users to PCG-enabled network policy","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqCreateKeyBasedPcgUsersRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqCreateKeyBasedPcgUsersResponse"}}}}},"security":[{"Bearer":[]}]},"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":{"202":{"description":"Accepted"}},"security":[{"Bearer":[]}]}},"/ng-reports/scheduled/{reportId}/recipients":{"get":{"tags":["NG Reports (Scheduled)"],"summary":"Get Recipients for Report","description":"Retrieves all recipients for a given report.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_recipients_for_report"},"operationId":"getRecipientsForReport","parameters":[{"name":"reportId","in":"path","description":"The report ID","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"keyword","in":"query","description":"The keyword to search","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqRecipientsForReportSchedule"}}}}},"security":[{"Bearer":[]}]},"put":{"tags":["NG Reports (Scheduled)"],"summary":"Add Recipients to Report","description":"Adds a list of recipient emails to the specified report.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_add_recipients_to_report"},"operationId":"addRecipientsToReport","parameters":[{"name":"reportId","in":"path","description":"The report ID","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/XiqRecipientCnsInfo"}}}},"required":true},"responses":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]},"post":{"tags":["NG Reports (Scheduled)"],"summary":"Delete Recipients from Report","description":"Deletes a list of recipient emails from the specified report.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_delete_recipients_from_report"},"operationId":"deleteRecipientsFromReport","parameters":[{"name":"reportId","in":"path","description":"The report ID","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqRecipientIdsRequest"}}},"required":true},"responses":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/ng-reports/scheduled/custom/{reportId}":{"get":{"tags":["NG Reports (Scheduled)"],"summary":"Get a custom report schedule","description":"Fetch details of a scheduled custom report by its ID.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_custom_report_by_id"},"operationId":"getCustomReportSchedule","parameters":[{"name":"reportId","in":"path","description":"The report ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqCustomReportResponse"}}}}},"security":[{"Bearer":[]}]},"put":{"tags":["NG Reports (Scheduled)"],"summary":"Update a scheduled custom report","description":"Update an existing scheduled custom report identified by reportScheduleId.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_update_scheduled_custom_report"},"operationId":"updateScheduledCustomReport","parameters":[{"name":"reportId","in":"path","description":"The report ID","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqUpdateCustomReportRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqCustomReportResponse"}}}}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqNetworkPolicy"}}}}},"security":[{"Bearer":[]}]},"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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqNetworkPolicy"}}}}},"security":[{"Bearer":[]}]},"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":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/mac-object-profiles/{id}":{"get":{"tags":["Configuration - Policy"],"summary":"Get MAC Object by ID","description":"Get an existing MAC object by the specified ID.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_mac_object_by_id"},"operationId":"getMacObject","parameters":[{"name":"id","in":"path","description":"The MAC Object ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqMacObject"}}}}},"security":[{"Bearer":[]}]},"put":{"tags":["Configuration - Policy"],"summary":"Update MAC Object by ID","description":"Update an existing MAC object by the specified ID.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_update_mac_object_by_id"},"operationId":"updateMacObject","parameters":[{"name":"id","in":"path","description":"The MAC Object ID.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"description":"The payload of the update MAC Object request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqUpdateMacObjectRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqMacObject"}}}}},"security":[{"Bearer":[]}]},"delete":{"tags":["Configuration - Policy"],"summary":"Delete a MAC object by ID","description":"Delete an existing MAC object by the specified ID.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_delete_mac_object_by_id"},"operationId":"deleteMacObjectProfiles","parameters":[{"name":"id","in":"path","description":"The Mac object ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/mac-firewall-policies/{id}":{"get":{"tags":["Configuration - Policy"],"summary":"Get MAC Firewall Policy by ID","description":"Get an existing MAC Firewall policy by the specified ID.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_mac_firewall_policy_by_id"},"operationId":"getMacFirewallPolicy","parameters":[{"name":"id","in":"path","description":"The MAC firewall policy ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqMacFirewall"}}}}},"security":[{"Bearer":[]}]},"put":{"tags":["Configuration - Policy"],"summary":"Update MAC Firewall policy by ID","description":"Update an existing MAC Firewall policy by the specified ID.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_update_mac_firewall_policy_by_id"},"operationId":"updateMacFirewallPolicy","parameters":[{"name":"id","in":"path","description":"The MAC Firewall Policy ID.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"description":"The payload of the update MAC Firewall policy request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqMacFirewallPolicyRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqMacFirewall"}}}}},"security":[{"Bearer":[]}]},"delete":{"tags":["Configuration - Policy"],"summary":"Delete MAC Firewall policy by ID","description":"Delete an existing MAC Firewall policy by the specified ID.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_delete_mac_firewall_policy_by_id"},"operationId":"deleteMacFirewallPolicy","parameters":[{"name":"id","in":"path","description":"The MAC Firewall Policy ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqLocation"}}}}},"security":[{"Bearer":[]}]},"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":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/locations/wall/type/{id}":{"put":{"tags":["Location"],"summary":"Update a wall type","description":"Update the custom wall type with the specified ID.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_update_wall_type"},"operationId":"updateWallType","parameters":[{"name":"id","in":"path","description":"The Wall Type ID","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"description":"Update wall type request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqUpdateTypeRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqWallType"}}}}},"security":[{"Bearer":[]}]},"delete":{"tags":["Location"],"summary":"Delete a wall type","description":"Delete a wall type for the specified ID.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_delete_wall_type"},"operationId":"deleteWallType","parameters":[{"name":"id","in":"path","description":"The Wall Type ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"204":{"description":"No Content"}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqSite"}}}}},"security":[{"Bearer":[]}]},"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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqSite"}}}}},"security":[{"Bearer":[]}]},"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":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/locations/folder/zones":{"put":{"tags":["Location"],"summary":"Update zones in folder","description":"Update zones for the specified folder ID.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_update_zones"},"operationId":"updateZones","requestBody":{"description":"Update zones request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqUpdateZonesRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/XiqZone"}}}}}},"security":[{"Bearer":[]}]},"post":{"tags":["Location"],"summary":"Create a zone","description":"Create a zone.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_create_zone"},"operationId":"createZone","requestBody":{"description":"Create zone","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqCreateZoneRequest"}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqZone"}}}}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqFloor"}}}}},"security":[{"Bearer":[]}]},"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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqFloor"}}}}},"security":[{"Bearer":[]}]},"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":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/locations/floor/{floorId}/label":{"get":{"tags":["Location"],"summary":"Find all floor map labels referencing the floor","description":"Finds all labels referencing the floor given by its id.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_find_all_labels"},"operationId":"getFloorMapLabels","parameters":[{"name":"floorId","in":"path","description":"The Floor ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/XiqFloorMapLabel"}}}}}},"security":[{"Bearer":[]}]},"put":{"tags":["Location"],"summary":"Updates one floor map label.","description":"Updates one floor map label which references the floor given by its id.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_update_one_label"},"operationId":"updateFloorMapLabel","parameters":[{"name":"floorId","in":"path","description":"The Floor ID","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqFloorMapLabel"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqFloorMapLabel"}}}}},"security":[{"Bearer":[]}]},"post":{"tags":["Location"],"summary":"Creates one floor map label.","description":"Creates one floor map label which references the floor given by its id.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_create_one_label"},"operationId":"createFloorMapLabel","parameters":[{"name":"floorId","in":"path","description":"The Floor ID","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqFloorMapLabel"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqFloorMapLabel"}}}}},"security":[{"Bearer":[]}]}},"/locations/floor/bulk/label":{"put":{"tags":["Location"],"summary":"Updates one ore more floor map labels.","description":"Updates one or more floor map labels.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_update_one_or_more_labels"},"operationId":"bulkUpdateFloorMapLabels","requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/XiqFloorMapLabel"}}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/XiqFloorMapLabel"}}}}}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqBuilding"}}}}},"security":[{"Bearer":[]}]},"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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqBuilding"}}}}},"security":[{"Bearer":[]}]},"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":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqLdapServer"}}}}},"security":[{"Bearer":[]}]},"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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqLdapServer"}}}}},"security":[{"Bearer":[]}]},"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":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/l3-address-profiles/{id}":{"get":{"tags":["Configuration - Policy"],"summary":"Get a L3 address profile by ID","description":"Get L3 address profile details for the specified ID.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_l3_address_profile_by_id"},"operationId":"getL3AddressProfile","parameters":[{"name":"id","in":"path","description":"The L3 address profile ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqL3AddressProfileResponse"}}}}},"security":[{"Bearer":[]}]},"put":{"tags":["Configuration - Policy"],"summary":"Update a L3 address profile","description":"Update an existing address profile.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_update_l3_address_profile"},"operationId":"updateL3AddressProfile","parameters":[{"name":"id","in":"path","description":"The L3 address profile ID.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"description":"The payload of L3 address profile.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqUpdateL3AddressProfileRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqL3AddressProfileResponse"}}}}},"security":[{"Bearer":[]}]},"delete":{"tags":["Configuration - Policy"],"summary":"Delete a L3 address profile by ID","description":"Delete an existing L3 address profile by ID.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_delete_l3_address_profile"},"operationId":"deleteL3AddressProfile","parameters":[{"name":"id","in":"path","description":"The L3 address profile ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/ip-firewall-policies/{id}":{"get":{"tags":["Configuration - Policy"],"summary":"Get IP Firewall Policy by ID","description":"Get an existing IP Firewall policy by the specified ID.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_ip_firewall_policy_by_id"},"operationId":"getIpFirewallPolicy","parameters":[{"name":"id","in":"path","description":"The ip firewall policy ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqIpFirewall"}}}}},"security":[{"Bearer":[]}]},"put":{"tags":["Configuration - Policy"],"summary":"Update IP Firewall policy by ID","description":"Update an existing IP Firewall policy by the specified ID.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_update_ip_firewall_policy_by_id"},"operationId":"updateIpPolicyRequest","parameters":[{"name":"id","in":"path","description":"The Ip Firewall Policy ID.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"description":"The payload of the update IP Firewall policy request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqIpFirewallPolicyRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqIpFirewall"}}}}},"security":[{"Bearer":[]}]},"delete":{"tags":["Configuration - Policy"],"summary":"Delete IP Firewall policy by ID","description":"Delete an existing IP Firewall policy by the specified ID.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_delete_ip_firewall_policy_by_id"},"operationId":"deleteIpFirewallPolicy","parameters":[{"name":"id","in":"path","description":"The Ip Firewall Policy ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqIotProfile"}}}}},"security":[{"Bearer":[]}]},"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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqIotProfile"}}}}},"security":[{"Bearer":[]}]},"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":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/hotspot-service-provider-profiles/{id}":{"get":{"tags":["Configuration - Policy"],"summary":"Get Hotspot Service Provider profile by ID","description":"Get Hotspot Service Provider profile details for the specified ID.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_hotspot_profile_by_id"},"operationId":"getHotspotServiceProviderProfile","parameters":[{"name":"id","in":"path","description":"The Hotspot Service Provider profile ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqHotspotServiceProviderProfile"}}}}},"security":[{"Bearer":[]}]},"put":{"tags":["Configuration - Policy"],"summary":"Update Hotspot Service Provider profile by ID","description":"Update the existing Hotspot Service Provider profile by the profile ID.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_update_hotspot_profile_configuration"},"operationId":"updateHotspotServiceProviderProfile","parameters":[{"name":"id","in":"path","description":"The Hotspot Service Provider profile ID.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"description":"The payload of the update Hotspot Service Provider profile request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqHotspotServiceProviderProfileRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqHotspotServiceProviderProfile"}}}}},"security":[{"Bearer":[]}]},"delete":{"tags":["Configuration - Policy"],"summary":"Delete Hotspot Service Provider profile by ID","description":"Delete the existing Hotspot Service Provider profile by the profile ID.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_delete_hotspot_profile_configuration"},"operationId":"deleteHotspotServiceProviderProfile","parameters":[{"name":"id","in":"path","description":"The Hotspot Service Provider profile ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/hotspot-profiles/{id}":{"get":{"tags":["Configuration - Policy"],"summary":"Get Hotspot profile by ID","description":"Get Hotspot profile details for the specified ID.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_hotspot_profile_by_id"},"operationId":"getHotspotProfile","parameters":[{"name":"id","in":"path","description":"The Hotspot profile ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqHotspotProfile"}}}}},"security":[{"Bearer":[]}]},"put":{"tags":["Configuration - Policy"],"summary":"Update Hotspot profile by ID","description":"Update the existing Hotspot profile by the profile ID.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_update_hotspot_profile_configuration"},"operationId":"updateHotspotProfile","parameters":[{"name":"id","in":"path","description":"The Hotspot profile ID.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"description":"The payload of the update Hotspot profile request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqHotspotProfileRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqHotspotProfile"}}}}},"security":[{"Bearer":[]}]},"delete":{"tags":["Configuration - Policy"],"summary":"Delete Hotspot profile by ID","description":"Delete the existing Hotspot profile by the profile ID.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_delete_hotspot_profile_configuration"},"operationId":"deleteHotspotProfile","parameters":[{"name":"id","in":"path","description":"The Hotspot profile ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqHiqContext"}}}}},"security":[{"Bearer":[]}]},"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":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"integer","format":"int64"}}}}}},"security":[{"Bearer":[]}]},"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":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"integer","format":"int64"}}}}},"security":[{"Bearer":[]}]},"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":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/floor/afc/details":{"get":{"tags":["afc-endpoint"],"summary":"AFC Related Floor Height and Accuracy data","description":"AFC Related Floor Height and Accuracy data","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_floor_afc_details"},"operationId":"getFloorAfcProperties","parameters":[{"name":"ownerId","in":"query","description":"Owner Id","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"floorId","in":"query","description":"The Id of the floor","required":true,"schema":{"type":"integer","format":"int64"},"example":1234567890}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqAfcFloorDetails"}}}}},"security":[{"Bearer":[]}]},"put":{"tags":["afc-endpoint"],"summary":"AFC Related Floor and AP Height and Accuracy data","description":"AFC Related Floor and AP Height and Accuracy data","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_update_floor_afc_details"},"operationId":"updateFloorAfcProperties","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqAfcFloorDetails"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqAfcFloorDetails"}}}}},"security":[{"Bearer":[]}]},"post":{"tags":["afc-endpoint"],"summary":"AFC Related Floor and AP Height and Accuracy data","description":"AFC Related Floor and AP Height and Accuracy data","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_add_floor_afc_details"},"operationId":"addFloorAfcProperties","requestBody":{"description":"Floor AFC related properties body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqAfcFloorDetailsCreateRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqAfcFloorDetails"}}}}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqEndUser"}}}}},"security":[{"Bearer":[]}]},"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":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/devices/{id}/visible":{"put":{"tags":["Device"],"summary":"Update the visible status of a device in a floor","description":"Update the visible status of a device in a floor","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_change_visible_for_one_device"},"operationId":"updateDeviceVisible","parameters":[{"name":"id","in":"path","description":"The device ID","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"visible","in":"query","description":"The new visible status of a device in a floor","required":true,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/devices/{id}/radio-operating-mode":{"get":{"tags":["Device"],"summary":"Get the device radio operating mode","description":"Get the device radio operating mode by device ID.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_device_radio_operating_mode"},"operationId":"getDeviceRadioOperatingMode","parameters":[{"name":"id","in":"path","description":"The device ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqDeviceRadioOperatingMode"}}}}},"security":[{"Bearer":[]}]},"put":{"tags":["Device"],"summary":"Configure radio operating mode of a device","description":"Configure the device-specific radio operating mode settings at device level","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_configure_device_radio_operating_mode"},"operationId":"configureDeviceRadioOperatingMode","parameters":[{"name":"id","in":"path","description":"The device ID","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqDeviceRadioOperatingMode"}}},"required":true},"responses":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqNetworkPolicy"}}}}},"security":[{"Bearer":[]}]},"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":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]},"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":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/devices/{id}/mobileapp/gps":{"put":{"tags":["Device"],"summary":"Update AP GPS settings","description":"Update AP GPS settings","operationId":"mobileappGpsSettings","parameters":[{"name":"id","in":"path","description":"The device ID","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqMobileappGpsSettingsRequest"}}},"required":true},"responses":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqDeviceLocation"}}}}},"security":[{"Bearer":[]}]},"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":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]},"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":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqFtmSettings"}}}}},"security":[{"Bearer":[]}]},"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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqFtmSettings"}}}}},"security":[{"Bearer":[]}]},"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":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/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":{"type":"string"}}},"required":true},"responses":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/devices/{id}/client-monitor":{"get":{"tags":["Device"],"summary":"Get client monitor setting for a device","description":"Get the client monitor info for a specific device.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_client_monitor_setting_for_one_device"},"operationId":"getDeviceClientMonitor","parameters":[{"name":"id","in":"path","description":"The device ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqDeviceClientMonitor"}}}}},"security":[{"Bearer":[]}]},"put":{"tags":["Device"],"summary":"Assign client monitor setting to a device","description":"Assign a client monitor to a specific device with extra map and geographical properties.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_configure_client_monitor_setting_for_one_device"},"operationId":"assignDeviceClientMonitor","parameters":[{"name":"id","in":"path","description":"The device ID","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqDeviceClientMonitor"}}},"required":true},"responses":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]},"delete":{"tags":["Device"],"summary":"Revoke client monitor setting for a device","description":"Revoke the assigned client monitor for a specific device.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_delete_client_monitor_setting_for_one_device"},"operationId":"revokeDeviceClientMonitor","parameters":[{"name":"id","in":"path","description":"The device ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/deployments/{deploymentId}":{"get":{"tags":["Configuration - Deployment"],"summary":"Get deployment details by Id","description":"Get deployment schedule across multiple sites","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_deployment_details_by_id"},"operationId":"getDeploymentDetailsById","parameters":[{"name":"deploymentId","in":"path","description":"The deployment ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqDeploymentDetailsResponse"}}}}},"security":[{"Bearer":[]}]},"put":{"tags":["Configuration - Deployment"],"summary":"Update schedule with deployment ID","description":"Update deployment configuration across multiple sites","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_update_schedule_with_deployment_id"},"operationId":"updateFirmwareUpgradeSchedule","parameters":[{"name":"deploymentId","in":"path","description":"The deployment ID","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqUpdateFirmwareUpgradeRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqDeploymentScheduleActionResponse"}}}}},"security":[{"Bearer":[]}]},"delete":{"tags":["Configuration - Deployment"],"summary":"Delete the deployment schedule by ID","description":"Delete firmware and deployment configuration upgrade schedule.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_delete_the_deployment_schedule_by_id"},"operationId":"deleteFirmwareUpgradeSchedule","parameters":[{"name":"deploymentId","in":"path","description":"The deployment ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqDeploymentScheduleActionResponse"}}}}},"security":[{"Bearer":[]}]}},"/credential-distribution-groups/{id}":{"put":{"tags":["Administration"],"summary":"Update Credential Distribution Group by ID","description":"Update an existing Credential Distribution Group by the specified ID.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_update_credential_distribution_groups"},"operationId":"updateCredentialDistributionGroup","parameters":[{"name":"id","in":"path","description":"The Credential Distribution Group ID.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"description":"The payload of the update Credential Distribution Group request. Updatable fields:name, member of, restrict number, user group, enable email approval, enable user limitation. EMPLOYEE GROUP TYPE IS NOT EDITABLE ","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqCredentialDistributionGroupUpdateRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqCredentialDistributionGroupUpdate"}}}}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/copilot/anomalies/update-action":{"put":{"tags":["Copilot - Anomalies"],"operationId":"updateAnomalyAction","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqAnomaliesUpdateActionRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqCopilotAnomaliesActionResponse"}}}}},"security":[{"Bearer":[]}]}},"/copilot/anomalies/devices/update-action":{"put":{"tags":["Copilot - Anomalies"],"operationId":"updateAnomalyDeviceAction","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqAnomaliesDeviceUpdateActionRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqCopilotAnomaliesActionResponse"}}}}},"security":[{"Bearer":[]}]}},"/copilot/anomalies/devices/feedback":{"put":{"tags":["Copilot - Anomalies"],"operationId":"updateAnomaliesFeedback","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqAnomaliesFeedbackRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqCopilotAnomaliesActionResponse"}}}}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/client-monitor-profiles/{id}":{"get":{"tags":["Configuration - Policy"],"summary":"Get client monitor profile by ID","description":"Get client monitor profile details for the specified ID.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_client_monitor_profile"},"operationId":"getClientMonitorProfile","parameters":[{"name":"id","in":"path","description":"The client monitor profile ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqClientMonitorProfile"}}}}},"security":[{"Bearer":[]}]},"put":{"tags":["Configuration - Policy"],"summary":"Update client monitor profile","description":"Update an existing client monitor profile.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_update_client_monitor_profile"},"operationId":"updateClientMonitorProfile","parameters":[{"name":"id","in":"path","description":"The client monitor profile ID.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"description":"The payload of client monitor profile.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqUpdateClientMonitorProfileRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqClientMonitorProfile"}}}}},"security":[{"Bearer":[]}]},"delete":{"tags":["Configuration - Policy"],"summary":"Delete an client monitor profile by ID","description":"Delete an existing client monitor profile by ID.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_delete_client_monitor_profile"},"operationId":"deleteClientMonitorProfile","parameters":[{"name":"id","in":"path","description":"The client monitor profile ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/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"},"operationId":"getClassificationRule","parameters":[{"name":"id","in":"path","description":"The classification Rule ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqClassificationRule"}}}}},"security":[{"Bearer":[]}]},"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"},"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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqClassificationRule"}}}}},"security":[{"Bearer":[]}]},"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"},"operationId":"deleteClassificationRule","parameters":[{"name":"id","in":"path","description":"The classification rule ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/certificate-bundles/{id}":{"get":{"tags":["Configuration - Certificate"],"summary":"Get Certificate Bundle by ID","description":"Get Certificate Bundle for the specified ID.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_certificate_bundle_by_id"},"operationId":"getCertificateBundle","parameters":[{"name":"id","in":"path","description":"The Certificate Bundle ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqCertificateBundle"}}}}},"security":[{"Bearer":[]}]},"put":{"tags":["Configuration - Certificate"],"summary":"Update Certificate Bundle by ID","description":"Update the existing Certificate Bundle by the profile ID.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_update_certificate_bundle_configuration"},"operationId":"updateCertificateBundle","parameters":[{"name":"id","in":"path","description":"The Certificate Bundle ID.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"description":"The payload of the update Certificate Bundle request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqUpdateCertificateBundleRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqCertificateBundle"}}}}},"security":[{"Bearer":[]}]},"delete":{"tags":["Configuration - Certificate"],"summary":"Delete Certificate Bundle by ID","description":"Delete the existing Certificate Bundle by the ID.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_delete_certificate_bundle"},"operationId":"deleteCertificateBundle","parameters":[{"name":"id","in":"path","description":"The Certificate Bundle ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqCloudConfigGroup"}}}}},"security":[{"Bearer":[]}]},"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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqCloudConfigGroup"}}}}},"security":[{"Bearer":[]}]},"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":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqAlertWebhookSubscription"}}}}},"security":[{"Bearer":[]}]},"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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqAlertWebhookSubscription"}}}}},"security":[{"Bearer":[]}]},"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":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/alert-subscriptions/servicenow/{id}":{"get":{"tags":["Alert"],"summary":"Get a specific ServiceNow subscription","description":"Get ServiceNow subscription info for a specific ServiceNow account.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_an_alert_servicenow_subscription"},"operationId":"getServiceNowSubscription","parameters":[{"name":"id","in":"path","description":"The unique identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqAlertServiceNowSubscription"}}}}},"security":[{"Bearer":[]}]},"put":{"tags":["Alert"],"summary":"Update ServiceNow subscription","description":"Update ServiceNow subscription.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_update_an_alert_servicenow_subscription"},"operationId":"updateServiceNowSubscription","parameters":[{"name":"id","in":"path","description":"The unique identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqUpdateAlertServiceNowSubscriptionRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqAlertServiceNowSubscription"}}}}},"security":[{"Bearer":[]}]},"patch":{"tags":["Alert"],"summary":"Partial or full update ServiceNow subscription","description":"Partial or full update ServiceNow subscription.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_patch_an_alert_servicenow_subscription"},"operationId":"patchServiceNowSubscription","parameters":[{"name":"id","in":"path","description":"The unique identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqPatchAlertServiceNowSubscriptionRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqAlertServiceNowSubscription"}}}}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqAlertEmailSubscription"}}}}},"security":[{"Bearer":[]}]},"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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqAlertEmailSubscription"}}}}},"security":[{"Bearer":[]}]},"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":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqAlertRule"}}}}},"security":[{"Bearer":[]}]},"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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqAlertRule"}}}}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqAlertPolicy"}}}}},"security":[{"Bearer":[]}]},"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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqAlertPolicy"}}}}},"security":[{"Bearer":[]}]},"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":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqDefaultDevicePassword"}}}}},"security":[{"Bearer":[]}]},"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_device_default_password"},"operationId":"updateDefaultDevicePassword","requestBody":{"description":"The new default device password","content":{"application/json":{"schema":{"type":"string"}}},"required":true},"responses":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/account/vhm/setting/{id}":{"put":{"tags":["Account"],"summary":"Update Vhm Setting","description":"Update an existing Vhm Setting.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_update_vhm_setting"},"operationId":"updateVhmSetting","parameters":[{"name":"id","in":"path","description":"The Vhm Setting ID.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"description":"The payload of the update VhmSetting request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqUpdateVhmSettingRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqVhmSetting"}}}}},"security":[{"Bearer":[]}]}},"/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_vlan_profiles"},"operationId":"listVlanProfiles","parameters":[{"name":"page","in":"query","description":"Page number, min = 1","required":false,"schema":{"type":"integer","format":"int32","default":1,"minimum":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 100","required":false,"schema":{"type":"integer","format":"int32","default":10,"maximum":100,"minimum":1}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqVlanProfile"}}}}},"security":[{"Bearer":[]}]},"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"},"operationId":"createVlanProfile","requestBody":{"description":"The payload to create new VLAN profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqCreateVlanProfileRequest"}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqVlanProfile"}}}}},"security":[{"Bearer":[]}]}},"/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_profile"},"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":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/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":{"type":"integer","format":"int32","default":1,"minimum":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 100","required":false,"schema":{"type":"integer","format":"int32","default":10,"maximum":100,"minimum":1}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqUser"}}}}},"security":[{"Bearer":[]}]},"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":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqUser"}}}}},"security":[{"Bearer":[]}]}},"/users/type-distribution":{"post":{"tags":["User"],"summary":"Get user type distribution","description":"User type distribution and total connected users","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_user_type_distribution"},"operationId":"getUserTypeDistribution","parameters":[{"name":"startTime","in":"query","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"endTime","in":"query","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"description":"Request body for user type distribution","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RmUserFilterRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RmUserTypeDistribution"}}}}},"security":[{"Bearer":[]}]}},"/users/grid":{"post":{"tags":["User"],"summary":"List Users","description":"Returns a paginated list of users with support for search, filter, and sort.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_list_users"},"operationId":"listUsersGrid","parameters":[{"name":"page","in":"query","description":"Page number, min = 1","required":false,"schema":{"type":"integer","format":"int32","default":1,"minimum":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 500","required":false,"schema":{"type":"integer","format":"int32","default":10,"maximum":500,"minimum":1}},{"name":"search","in":"query","description":"The search string","required":false,"schema":{"type":"string"}},{"name":"startTime","in":"query","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"endTime","in":"query","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RmUserGridRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedRmUsersGridResponse"}}}}},"security":[{"Bearer":[]}]}},"/users/grid-export":{"post":{"tags":["User"],"summary":"Export the Users grid data","description":"Export the Users grid data as a CSV file.","operationId":"exportToCsv","parameters":[{"name":"search","in":"query","description":"The search string","required":false,"schema":{"type":"string"}},{"name":"startTime","in":"query","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"endTime","in":"query","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"timezoneOffset","in":"query","description":"timezone offset","required":false,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RmUserGridRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RmMetricReport"}}}}},"security":[{"Bearer":[]}]}},"/users/filter-metadata":{"post":{"tags":["User"],"summary":"List user grid filter metadata","description":"Lists of values for user grid filters","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_list_user_grid_filter_metadata"},"operationId":"listUserGridFilterMetadata","parameters":[{"name":"startTime","in":"query","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"endTime","in":"query","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"description":"Request body for user type distribution","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RmUserFilterRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RmUsersGridFilterMetadata"}}}}},"security":[{"Bearer":[]}]}},"/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":{"type":"integer","format":"int32","default":1,"minimum":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 100","required":false,"schema":{"type":"integer","format":"int32","default":10,"maximum":100,"minimum":1}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqExternalUser"}}}}},"security":[{"Bearer":[]}]},"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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqExternalUser"}}}}},"security":[{"Bearer":[]}]}},"/users/data-usage":{"post":{"tags":["User"],"summary":"Get user data usage","description":"Returns data usage in bytes for each user.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_user_data_usage"},"operationId":"getUserDataUsage","parameters":[{"name":"startTime","in":"query","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"endTime","in":"query","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"description":"Request body for user type distribution","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RmUserFilterRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RmUserDataUsage"}}}}},"security":[{"Bearer":[]}]}},"/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":{"type":"integer","format":"int32","default":1,"minimum":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 100","required":false,"schema":{"type":"integer","format":"int32","default":10,"maximum":100,"minimum":1}},{"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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqUserGroup"}}}}},"security":[{"Bearer":[]}]},"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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqUserGroup"}}}}},"security":[{"Bearer":[]}]}},"/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":{"type":"integer","format":"int32","default":1,"minimum":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 100","required":false,"schema":{"type":"integer","format":"int32","default":10,"maximum":100,"minimum":1}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqUserProfile"}}}}},"security":[{"Bearer":[]}]},"post":{"tags":["Configuration - Policy"],"summary":"Create a user profile","description":"Create a new user profile.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_create_user_profile_configuration"},"operationId":"createUserProfile","requestBody":{"description":"The request body to create new user profile.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqCreateUserProfileRequest"}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqUserProfile"}}}}},"security":[{"Bearer":[]}]}},"/user-profiles/{id}/mac-firewall-policies/:detach":{"post":{"tags":["Configuration - Policy"],"summary":"Detach MAC Firewall Policy from an User Profile","description":"Detach MAC Firewall from an User Profile.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_detach_mac_firewall_from_an_user_profile"},"operationId":"detachMacFirewallPolicyFromUserProfile","parameters":[{"name":"id","in":"path","description":"The User Profile ID","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"description":"The MAC Firewall Policy ID to be detached from the User Profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqAttachMacFirewallPolicyToUserProfileRequest"}}},"required":true},"responses":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/user-profiles/{id}/mac-firewall-policies/:attach":{"post":{"tags":["Configuration - Policy"],"summary":"Attach MAC Firewall Policy to an User Profile","description":"Attach MAC Firewall to an User Profile.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_attach_mac_firewall_to_an_user_profile"},"operationId":"attachMacFirewallPolicyToUserProfile","parameters":[{"name":"id","in":"path","description":"The User Profile ID","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"description":"The MAC Firewall Policy ID to be attached to the User Profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqAttachMacFirewallPolicyToUserProfileRequest"}}},"required":true},"responses":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/user-profiles/{id}/ip-firewall-policies/:detach":{"post":{"tags":["Configuration - Policy"],"summary":"Detach IP Firewall Policy from an User Profile","description":"Detach IP Firewall from an User Profile.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_detach_ip_firewall_from_an_user_profile"},"operationId":"detachIpFirewallPolicyFromUserProfile","parameters":[{"name":"id","in":"path","description":"The User Profile ID","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"description":"The IP Firewall Policy ID to be detached from the User Profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqAttachIpFirewallPolicyToUserProfileRequest"}}},"required":true},"responses":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/user-profiles/{id}/ip-firewall-policies/:attach":{"post":{"tags":["Configuration - Policy"],"summary":"Attach IP Firewall Policy to an User Profile","description":"Attach IP Firewall to an User Profile.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_attach_ip_firewall_to_an_user_profile"},"operationId":"attachIpFirewallPolicyToUserProfile","parameters":[{"name":"id","in":"path","description":"The User Profile ID","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"description":"The IP Firewall Policy ID to be attached to the User Profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqAttachIpFirewallPolicyToUserProfileRequest"}}},"required":true},"responses":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/user-profile-assignments":{"get":{"tags":["Configuration - Policy"],"summary":"List user profile assignments","description":"List a page of user profile assignments.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_list_the_user_profiles_assignments"},"operationId":"listUserProfileAssignments","parameters":[{"name":"page","in":"query","description":"Page number, min = 1","required":false,"schema":{"type":"integer","format":"int32","default":1,"minimum":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 100","required":false,"schema":{"type":"integer","format":"int32","default":10,"maximum":100,"minimum":1}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqUserProfileAssignment"}}}}},"security":[{"Bearer":[]}]},"post":{"tags":["Configuration - Policy"],"summary":"Create a user profile assignment","description":"Create a new user profile assignment.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_create_user_profile_assignment"},"operationId":"createUserProfileAssignment","requestBody":{"description":"The request body to create new user profile.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqCreateUserProfileAssignmentRequest"}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqUserProfileAssignment"}}}}},"security":[{"Bearer":[]}]}},"/user-folder-preferences/{folderId}":{"post":{"tags":["Use Folder Preferences"],"summary":"Save user folder preferences values.","description":"Persists given preferences values.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_userFolderPreferences"},"operationId":"saveUserFolderPreferences","parameters":[{"name":"folderId","in":"path","description":"The id of the folder","required":true,"schema":{"type":"integer","format":"int64"},"example":1248163264}],"requestBody":{"content":{"application/json":{"schema":{"description":"The preferences object to save.","oneOf":[{"$ref":"#/components/schemas/XiqClientDensityThresholds"},{"$ref":"#/components/schemas/XiqCoChannelInterferenceThresholds"},{"$ref":"#/components/schemas/XiqCoverageOverlapThresholds"},{"$ref":"#/components/schemas/XiqLayerOpacityPreferences"},{"$ref":"#/components/schemas/XiqRssiThresholds"},{"$ref":"#/components/schemas/XiqSnrThresholds"}]}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/XiqClientDensityThresholds"},{"$ref":"#/components/schemas/XiqCoChannelInterferenceThresholds"},{"$ref":"#/components/schemas/XiqCoverageOverlapThresholds"},{"$ref":"#/components/schemas/XiqLayerOpacityPreferences"},{"$ref":"#/components/schemas/XiqRssiThresholds"},{"$ref":"#/components/schemas/XiqSnrThresholds"}]}}}}},"security":[{"Bearer":[]}]}},"/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_tunnel_concentrators"},"operationId":"listTunnelConcentrators","parameters":[{"name":"page","in":"query","description":"Page number, min = 1","required":false,"schema":{"type":"integer","format":"int32","default":1,"minimum":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 100","required":false,"schema":{"type":"integer","format":"int32","default":10,"maximum":500,"minimum":1}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqTunnelConcentrator"}}}}},"security":[{"Bearer":[]}]},"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"},"operationId":"createTunnelConcentrator","requestBody":{"description":"The request body to create new Tunnel Concentrator.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqTunnelConcentratorRequest"}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqTunnelConcentrator"}}}}},"security":[{"Bearer":[]}]}},"/switch-inspector/diagnostics":{"post":{"tags":["Switch Inspector Panel"],"summary":"Switch Inspector Panel Diagnostics","description":"Returns the switch inspector panel diagnostics widget data (Device Health, Usage and Capacity and Client Health issue counts)","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_post_switch_inspector_panel_diagnostics"},"operationId":"getDiagnostics","parameters":[{"name":"deviceId","in":"query","description":"The ID of the device","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqSwitchInspectorPanelDiagnosticsResponse"}}}}},"security":[{"Bearer":[]}]}},"/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","parameters":[{"name":"page","in":"query","description":"Page number, min = 1","required":false,"schema":{"type":"integer","format":"int32","default":1,"minimum":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 100","required":false,"schema":{"type":"integer","format":"int32","default":10,"maximum":100,"minimum":1}},{"name":"order","in":"query","description":"The sort order (descending by default)","required":false,"schema":{"$ref":"#/components/schemas/XiqSortOrder","default":"DESC"}},{"name":"keyword","in":"query","description":"The keyword - url","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqWebhookSubscription"}}}}},"security":[{"Bearer":[]}]},"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":{"202":{"description":"Accepted"}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/ssids/{id}/user-profile-assignment/:attach":{"post":{"tags":["Configuration - Policy"],"summary":"Attach user profile assignment to an SSID","description":"Attach user profile assignment to an SSID.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_attach_user_profile_assignment_to_an_ssid"},"operationId":"attachUserProfileAssignmentToSsid","parameters":[{"name":"id","in":"path","description":"The SSID ID","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"description":"The user profile assignment ID to be attached to the SSID","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqAttachUPAssignmentRequest"}}},"required":true},"responses":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/ssids/{id}/radius-client-profile/:attach":{"post":{"tags":["Configuration - Policy"],"summary":"Attach RADIUS client profile to an SSID","description":"Attach RADIUS client profile to an SSID.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_attach_radius_client_profile_to_an_ssid"},"operationId":"attachRadiusClientProfileToSsid","parameters":[{"name":"id","in":"path","description":"The SSID ID","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"description":"The radius client profile to be attached to the SSID","content":{"application/json":{"schema":{"type":"integer","format":"int64"}}},"required":true},"responses":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/ssids/{id}/client-monitor-profile/:attach":{"post":{"tags":["Configuration - Policy"],"summary":"Attach client monitor profile to an SSID","description":"Attach client monitor profile to an SSID.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_attach_client_monitor_profile_to_an_ssid"},"operationId":"attachClientMonitorProfileToSsid","parameters":[{"name":"id","in":"path","description":"The SSID ID","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"description":"The client monitor profile ID to be attached to the SSID","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqAttachClientMonitorProfileRequest"}}},"required":true},"responses":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/site/spectrum/":{"post":{"tags":["afc-endpoint"],"operationId":"getAfcSpectrumPerSite","parameters":[{"name":"IsEmptyList","in":"query","required":true,"schema":{"type":"boolean"}}],"requestBody":{"description":"get afc spectrum by site request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqGetAfcSpectrumForSiteApsRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/XiqAfcAvailableSpectrum"}}}}}},"security":[{"Bearer":[]}]}},"/rtts":{"post":{"tags":["rtts-endpoint"],"summary":"Create","description":"Create ","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_create"},"operationId":"createRttsSession","parameters":[{"name":"ownerId","in":"query","description":"Owner Id","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"description":"Rtts","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RttsSessionDevices"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqRttsSessionResponse"}}}}},"security":[{"Bearer":[]}]}},"/rtts/supported-devices":{"post":{"tags":["rtts-endpoint"],"summary":"List RTTS supported devices","description":"List RTTS supported devices for the specified location filter.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_list_rtts_supported_devices"},"operationId":"listRttsSupportedDevices","requestBody":{"description":"Filter to fetch RTTS supported devices for given location","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RttsSupportedDevicesRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RttsSupportedDevice"}}}}}},"security":[{"Bearer":[]}]}},"/radsec-proxies":{"get":{"tags":["Configuration - Authentication"],"summary":"List RADSEC proxies","description":"List a page of RADSEC proxy configurations.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_list_the_radsec_proxy_configuration"},"operationId":"listRadsecProxies","parameters":[{"name":"page","in":"query","description":"Page number, min = 1","required":false,"schema":{"type":"integer","format":"int32","default":1,"minimum":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 100","required":false,"schema":{"type":"integer","format":"int32","default":10,"maximum":100,"minimum":1}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqRadsecProxy"}}}}},"security":[{"Bearer":[]}]},"post":{"tags":["Configuration - Authentication"],"summary":"Create RADSEC proxy configuration","description":"Create a new RADSEC proxy configuration.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_create_radsec_proxy_configuration"},"operationId":"createRadsecProxy","requestBody":{"description":"The body of create RADSEC proxy API","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqCreateRadsecProxyRequest"},"examples":{"Create a new RADSEC proxy":{"summary":"Create a new RADSEC proxy","description":"The payload to create a new RADSEC proxy","value":{"name":"radsec-proxy-1","description":"RADSEC Proxy 1","format_type":"WBAID","enable_inject_operator_name_attribute":false,"operator_name_type":"WBAID","operator_name":"SP.Extreme:CA","realms":[{"name":"NULL","enable_strip_realm_name":false,"external_radius_server_object_ids":[3000,3001]}]}}}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqRadsecProxy"}}}}},"security":[{"Bearer":[]}]}},"/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":{"type":"integer","format":"int32","default":1,"minimum":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 100","required":false,"schema":{"type":"integer","format":"int32","default":10,"maximum":100,"minimum":1}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqInternalRadiusServer"}}}}},"security":[{"Bearer":[]}]},"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":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqInternalRadiusServer"}}}}},"security":[{"Bearer":[]}]},"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":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/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":{"type":"integer","format":"int32","default":1,"minimum":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 100","required":false,"schema":{"type":"integer","format":"int32","default":10,"maximum":100,"minimum":1}},{"name":"accessType","in":"query","description":"The access type: STANDARD, SECURE","required":false,"schema":{"$ref":"#/components/schemas/XiqRadiusAccessType"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqExternalRadiusServer"}}}}},"security":[{"Bearer":[]}]},"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":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqExternalRadiusServer"}}}}},"security":[{"Bearer":[]}]}},"/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":{"type":"integer","format":"int32","default":1,"minimum":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 100","required":false,"schema":{"type":"integer","format":"int32","default":10,"maximum":100,"minimum":1}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqRadiusProxy"}}}}},"security":[{"Bearer":[]}]},"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":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqRadiusProxy"}}}}},"security":[{"Bearer":[]}]}},"/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":{"type":"integer","format":"int32","default":1,"minimum":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 100","required":false,"schema":{"type":"integer","format":"int32","default":10,"maximum":100,"minimum":1}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqRadiusClientObject"}}}}},"security":[{"Bearer":[]}]},"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":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqRadiusClientObject"}}}}},"security":[{"Bearer":[]}]}},"/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":{"type":"integer","format":"int32","default":1,"minimum":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 100","required":false,"schema":{"type":"integer","format":"int32","default":10,"maximum":100,"minimum":1}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqRadioProfile"}}}}},"security":[{"Bearer":[]}]},"post":{"tags":["Configuration - Policy"],"summary":"Create a radio profile","description":"Create a new radio profile.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_create_radio_profile_configuration"},"operationId":"createRadioProfile","requestBody":{"description":"The request body to create new user profile.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqCreateRadioProfileRequest"}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqRadioProfile"}}}}},"security":[{"Bearer":[]}]}},"/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":{"type":"integer","format":"int32","default":1,"minimum":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 100","required":false,"schema":{"type":"integer","format":"int32","default":10,"maximum":100,"minimum":1}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqRpMacOuiProfile"}}}}},"security":[{"Bearer":[]}]},"post":{"tags":["Configuration - Policy"],"summary":"Create a MAC OUI profile","description":"Create a new MAC OUI profile for radio usage optimization.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_create_mac_oui_profile_configuration"},"operationId":"createMacOuiProfile","requestBody":{"description":"The request body to create new user profile.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqCreateRpMacOuiProfileRequest"}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqRpMacOuiProfile"}}}}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/XiqKeyBasedPcg"}}}}}},"security":[{"Bearer":[]}]},"post":{"tags":["Configuration - User Management"],"summary":"[LRO] Create a Key-based Private Client Group","description":"Create 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#_create_key_based_pcg_network_policy"},"operationId":"createKeyBasedPcgNetworkPolicy","parameters":[{"name":"async","in":"query","description":"Whether to enable async mode","required":false,"schema":{"type":"boolean","default":false}}],"requestBody":{"description":"The request to create Key-based PCG network policy","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqInitKeyBasedPcgNetworkPolicyRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqKeyBasedPcg"}}}}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqGetPortAssignmentDetailsResponse"}}}}},"security":[{"Bearer":[]}]},"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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqPcgAssignPortsResponse"}}}}},"security":[{"Bearer":[]}]}},"/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":{"202":{"description":"Accepted"}},"security":[{"Bearer":[]}]}},"/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":{"202":{"description":"Accepted"}},"security":[{"Bearer":[]}]}},"/pcgs/key-based/network-policy-{policyId}/:onboard":{"post":{"tags":["Configuration - User Management"],"summary":"[LRO] Onboard Key-based PCG in network policy","description":"Onboard a Key-based Private Client Group for a specific network policy.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_onboard_key_based_pcg_data"},"operationId":"onboardKeyBasedPrivateClientGroup","parameters":[{"name":"policyId","in":"path","description":"The network policy 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}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqOnboardKeyBasedPcgRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqOnboardKeyBasedPcgResponse"}}}}},"security":[{"Bearer":[]}]}},"/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":{"type":"integer","format":"int32","default":1,"minimum":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 500","required":false,"schema":{"type":"integer","format":"int32","default":10,"maximum":500,"minimum":1}},{"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","default":"ASC"}},{"name":"fields","in":"query","description":"The packet capture fields to return","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/XiqPacketCaptureField"}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqPacketCapture"}}}}},"security":[{"Bearer":[]}]},"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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqPacketCapture"}}}}},"security":[{"Bearer":[]}]},"delete":{"tags":["Packet Capture"],"summary":"Delete packet capture sessions","description":"Delete existing packet capture sessions and capture files by ID.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_delete_packet_captures"},"operationId":"deletePacketCaptures","parameters":[{"name":"ids","in":"query","description":"The packet capture IDs","required":true,"schema":{"type":"array","items":{"type":"integer","format":"int64"}}}],"responses":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/ng-reports/timeseries":{"post":{"tags":["NG Reports (Ondemand)"],"summary":"Get QoE Diagnostics Time Series Data","description":"Retrieve QoE diagnostics time-series data for the selected metric using applicable filters","externalDocs":{"description":"API reference for QoE diagnostics time-series data","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_qoe_diagnostics_time_series_data"},"operationId":"qoeDiagnosticsTimeSeriesData","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqQoeDiagnosticsTimeSeriesFilters"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqQoeDiagnosticsResponse"}}}}},"security":[{"Bearer":[]}]}},"/ng-reports/tabledata":{"post":{"tags":["NG Reports (Ondemand)"],"summary":"Get QoE Diagnostics Table Data","description":"Retrieve QoE diagnostics table data for the selected metric using applicable filters","externalDocs":{"description":"API reference for QoE diagnostics table data","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_qoe_diagnostics_table_data"},"operationId":"qoeDiagnosticsTableData","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqQoeDiagnosticsTableDataFilters"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedMapStringObject"}}}}},"security":[{"Bearer":[]}]}},"/ng-reports/scheduled/custom":{"get":{"tags":["NG Reports (Scheduled)"],"summary":"List Custom Report Schedules","description":"List custom report schedules with filters and pagination.","externalDocs":{"description":"API reference for listing scheduled custom reports","url":"https://extremecloudiq.com/api-docs/api-reference.html#_list_custom_report_schedules"},"operationId":"listScheduledCustomReports","parameters":[{"name":"page","in":"query","description":"Page number, min = 1","required":false,"schema":{"type":"integer","format":"int32","default":1,"minimum":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 500","required":false,"schema":{"type":"integer","format":"int32","default":10,"maximum":500,"minimum":1}},{"name":"frequency","in":"query","description":"The frequency of the scheduled report (e.g., DAILY, WEEKLY, MONTHLY)","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/XiqScheduleFrequency"}}},{"name":"keyword","in":"query","description":"The keyword to search in the report name","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqCustomReportSchedule"}}}}},"security":[{"Bearer":[]}]},"post":{"tags":["NG Reports (Scheduled)"],"summary":"Create a scheduled custom report","description":"Create a new scheduled custom report with the provided details.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_create_scheduled_custom_report"},"operationId":"createScheduledCustomReport","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqCustomReportRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqCustomReportResponse"}}}}},"security":[{"Bearer":[]}]},"delete":{"tags":["NG Reports (Scheduled)"],"summary":"Delete scheduled custom reports","description":"Bulk delete scheduled custom reports by IDs.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_delete_custom_report_schedules"},"operationId":"deleteScheduledCustomReports","parameters":[{"name":"reportScheduleIds","in":"query","description":"List of scheduled report IDs to delete","required":true,"schema":{"type":"array","items":{"type":"integer","format":"int64"}}}],"responses":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/ng-reports/metadata/user":{"post":{"tags":["NG Reports (Ondemand)"],"summary":"List of Users for filtering","description":"Gives List of Users for filtering","externalDocs":{"description":"API reference for Users metadata for filtering","url":"https://extremecloudiq.com/api-docs/api-reference.html#_list_of_users_for_filtering"},"operationId":"getUsersListForFilter","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqQoeMetadataUsersFilter"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/XiqUser"}}}}}},"security":[{"Bearer":[]}]}},"/ng-reports/metadata/ssids":{"post":{"tags":["NG Reports (Ondemand)"],"summary":"List of SSIDs for filtering","description":"Please note: if you need to fetch all SSIDs configured in VIQ, send fetchAll as true; otherwise, send with start time and end time","externalDocs":{"description":"API reference for SSIDs metadata for filtering","url":"https://extremecloudiq.com/api-docs/api-reference.html#_list_of_ssids_for_filtering"},"operationId":"getSsisMetadata","parameters":[{"name":"fetchAll","in":"query","description":"fetch all ssid","required":false,"schema":{"type":"boolean","default":false}}],"requestBody":{"description":"Request body for Ssid Filter Metadata","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqQoeDiagnosticsSsidMetadataFilter"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}}},"security":[{"Bearer":[]}]}},"/ng-reports/metadata/os":{"post":{"tags":["NG Reports (Ondemand)"],"summary":"List of OS for filtering","description":"Gives List of OS for filtering","externalDocs":{"description":"API reference for OS metadata for filtering","url":"https://extremecloudiq.com/api-docs/api-reference.html#_list_of_os_for_filtering"},"operationId":"getOsFilterMetadata","requestBody":{"description":"Request body for Ssid Filter Metadata","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqQoeDiagnosticsChannelMetadataFilter"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}}},"security":[{"Bearer":[]}]}},"/ng-reports/metadata/device":{"post":{"tags":["NG Reports (Ondemand)"],"summary":"List of Devices for filtering","description":"Gives List of Devices for filtering","externalDocs":{"description":"API reference for Devices metadata for filtering","url":"https://extremecloudiq.com/api-docs/api-reference.html#_list_of_devices_for_filtering"},"operationId":"getDeviceListForFilter","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqQoeMetadataDeviceFilter"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/XiqDevice"}}}}}},"security":[{"Bearer":[]}]}},"/ng-reports/metadata/client":{"post":{"tags":["NG Reports (Ondemand)"],"summary":"List of Clients for filtering","description":"Gives List of Clients for filtering","externalDocs":{"description":"API reference for Clients metadata for filtering","url":"https://extremecloudiq.com/api-docs/api-reference.html#_list_of_clients_for_filtering"},"operationId":"getClientListForFilter","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqQoeMetadataClientFilter"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/XiqClient"}}}}}},"security":[{"Bearer":[]}]}},"/ng-reports/metadata/bands":{"post":{"tags":["NG Reports (Ondemand)"],"summary":"List of Band for filtering","description":"Gives List of Band for filtering, please note there is no validation for start time and end time","externalDocs":{"description":"API reference for Band metadata for filtering","url":"https://extremecloudiq.com/api-docs/api-reference.html#_list_of_bands_for_filtering"},"operationId":"getBandMetadata","requestBody":{"description":"Request body for Ssid Filter Metadata","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqQoeDiagnosticsBandMetadataFilter"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/XiqDiagnosticsBands"}}}}}},"security":[{"Bearer":[]}]}},"/ng-reports/metadata/application":{"post":{"tags":["NG Reports (Ondemand)"],"summary":"List of Applications for filtering","description":"Gives List of Applications for filtering","externalDocs":{"description":"API reference for Applications metadata for filtering","url":"https://extremecloudiq.com/api-docs/api-reference.html#_list_of_applications_for_filtering"},"operationId":"getApplicationListForFilter","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqQoeMetadataApplicationFilter"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/XiqApplication"}}}}}},"security":[{"Bearer":[]}]}},"/ng-reports/downloads/reports":{"post":{"tags":["NG Reports (Ondemand)"],"summary":"Download the Reports","description":"Download reports of Metrics","externalDocs":{"description":"API reference for download reports and supported metrics","url":"https://extremecloudiq.com/api-docs/api-reference.html#_download_the_reports"},"operationId":"qoeDiagnosticsXlsxData","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqXlsxNgReportsDataFilters"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NgMetricsReport"}}}}},"security":[{"Bearer":[]}]}},"/network-services":{"get":{"tags":["Configuration - Network"],"summary":"List Network Services","description":"List a page of Network Services.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_list_network_services"},"operationId":"listNetworkServices","parameters":[{"name":"page","in":"query","description":"Page number, min = 1","required":false,"schema":{"type":"integer","format":"int32","default":1,"minimum":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 100","required":false,"schema":{"type":"integer","format":"int32","default":10,"maximum":100,"minimum":1}},{"name":"name","in":"query","description":"Network Service name.","required":false,"schema":{"type":"string"}},{"name":"ipProtocol","in":"query","description":"IP Protocol, only for custom Application.","required":false,"schema":{"$ref":"#/components/schemas/XiqNetworkIpProtocol"}},{"name":"algType","in":"query","description":"Application Layer Gateway (ALG) type, only for custom Application.","required":false,"schema":{"$ref":"#/components/schemas/XiqNetworkAlgType"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqNetworkService"}}}}},"security":[{"Bearer":[]}]},"post":{"tags":["Configuration - Network"],"summary":"Create Network Services","description":"Create a new Network Services.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_create_network_services"},"operationId":"createNetworkServices","requestBody":{"description":"The request body to create new user profile.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqNetworkServiceRequest"}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqNetworkService"}}}}},"security":[{"Bearer":[]}]}},"/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":{"type":"integer","format":"int32","default":1,"minimum":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 2000","required":false,"schema":{"type":"integer","format":"int32","default":10,"maximum":2000,"minimum":1}},{"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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqNetworkPolicy"}}}}},"security":[{"Bearer":[]}]},"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":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqNetworkPolicy"}}}}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/mac-object-profiles":{"get":{"tags":["Configuration - Policy"],"summary":"List mac object profiles","description":"List a page of mac object profiles.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_list_mac_objects"},"operationId":"listMacObjectProfiles","parameters":[{"name":"page","in":"query","description":"Page number, min = 1","required":false,"schema":{"type":"integer","format":"int32","default":1,"minimum":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 100","required":false,"schema":{"type":"integer","format":"int32","default":10,"maximum":100,"minimum":1}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqMacObject"}}}}},"security":[{"Bearer":[]}]},"post":{"tags":["Configuration - Policy"],"summary":"Create a mac object","description":"Create a new mac object","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_create_mac_object"},"operationId":"createMacObject","requestBody":{"description":"The request body to create new mac object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqCreateMacObjectRequest"}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqMacObject"}}}}},"security":[{"Bearer":[]}]}},"/mac-firewall-policies":{"get":{"tags":["Configuration - Policy"],"summary":"List MAC Firewall policies","description":"List a page of MAC Firewall policies.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_list_mac_firewall_policies"},"operationId":"listMacFirewallPolicies","parameters":[{"name":"page","in":"query","description":"Page number, min = 1","required":false,"schema":{"type":"integer","format":"int32","default":1,"minimum":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 100","required":false,"schema":{"type":"integer","format":"int32","default":10,"maximum":100,"minimum":1}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqMacFirewall"}}}}},"security":[{"Bearer":[]}]},"post":{"tags":["Configuration - Policy"],"summary":"Create MAC Firewall policy","description":"Create a new MAC Firewall policy.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_create_mac_firewall_policy"},"operationId":"createMacFirewallPolicy","requestBody":{"description":"The payload to create a new MAC Firewall policy.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqMacFirewallPolicyRequest"}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqMacFirewall"}}}}},"security":[{"Bearer":[]}]}},"/mac-firewall-policies/{id}/mac-firewall-rule/:detach":{"post":{"tags":["Configuration - Policy"],"summary":"Detach MAC Firewall Rule from MAC Firewall policy","description":"Detach MAC Firewall Rule from MAC Firewall policy.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_detach_mac_firewall_rule_from_an_mac_firewall_policy"},"operationId":"detachServiceToMacFirewallPolicy","parameters":[{"name":"id","in":"path","description":"The MAC Firewall Policy ID","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"description":"The MAC Firewall Rule to be detached from the MAC Firewall Policy.","content":{"application/json":{"schema":{"type":"integer","format":"int64"}}},"required":true},"responses":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/mac-firewall-policies/{id}/mac-firewall-rule/:attach":{"post":{"tags":["Configuration - Policy"],"summary":"Attach MAC Firewall Rule to MAC Firewall policy","description":"Attach MAC Firewall Rule to MAC Firewall policy.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_attach_mac_firewall_rule_to_an_mac_firewall_policy"},"operationId":"attachServiceToMacFirewallPolicy","parameters":[{"name":"id","in":"path","description":"The MAC Firewall Policy ID","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"description":"The MAC Firewall Rule to be attached to the MAC Firewall Policy.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqMacFirewallRuleRequest"}}},"required":true},"responses":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/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","default":"DESC"}},{"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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqAuditLogReport"}}}}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/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":{"Normal login":{"summary":"Login with username and password","description":"User login with username/email and password","value":{"username":"username@company.com","password":"ChangeMe"}},"Login with per-hour rate limit":{"summary":"Login with per-hour rate limit","description":"User login with custom per-hour rate limit","value":{"username":"username@company.com","password":"ChangeMe","rate_limit":{"hour":5000}}},"Login with per-hour and per-second rate limit":{"summary":"Login with per-hour and per-second (burst) rate limit","description":"User login with custom per-hour and per-second (burst) rate limit","value":{"username":"username@company.com","password":"ChangeMe","rate_limit":{"hour":5000,"second":100}}}}}},"required":true},"responses":{"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}}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"UNAUTHORIZED","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}}}}},"/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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqLocation"}}}}},"security":[{"Bearer":[]}]}},"/locations/wall/type":{"get":{"tags":["Location"],"summary":"Get wall types","description":"Retrieve the list of wall types, including both predefined and custom ones.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_list_walls_type"},"operationId":"getWallType","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/XiqWallType"}}}}}},"security":[{"Bearer":[]}]},"post":{"tags":["Location"],"summary":"Create a wall type","description":"Create a custom wall type.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_create_wall_type"},"operationId":"createWallType","requestBody":{"description":"Create wall type request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqCreateTypeRequest"}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqWallType"}}}}},"security":[{"Bearer":[]}]}},"/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":{"type":"integer","format":"int32","default":1,"minimum":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 100","required":false,"schema":{"type":"integer","format":"int32","default":10,"maximum":100,"minimum":1}},{"name":"order","in":"query","description":"The sort order by name (ascending by default)","required":false,"schema":{"$ref":"#/components/schemas/XiqSortOrder","default":"ASC"}},{"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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqSite"}}}}},"security":[{"Bearer":[]}]},"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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqSite"}}}}},"security":[{"Bearer":[]}]}},"/locations/import/ekahau":{"post":{"tags":["Location"],"summary":"[LRO] Import one or more floors from an Ekahau archive","description":"Import the specified Ekahau floor(s) from the provided archive.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_start_ekahau_import"},"operationId":"startEkahauImport","parameters":[{"name":"async","in":"query","description":"Whether to enable async mode.","required":false,"schema":{"type":"boolean","default":false}},{"name":"floorAssociations","in":"query","description":"Describes how Ekahau floors are imported into XIQ as floors in buildings.","required":true,"schema":{"type":"array","items":{"$ref":"#/components/schemas/XiqEkahauFloorToFloorAssociation"}}},{"name":"outdoorSiteAssociations","in":"query","description":"Describes how Ekahau floors are Imported into XIQ as outdoor sites in site groups.","required":true,"schema":{"type":"array","items":{"$ref":"#/components/schemas/XiqEkahauFloorToOutdoorSiteAssociation"}}},{"name":"importCustomApConfigurations","in":"query","description":"Whether to also import or not the custom AP configurations such as: Hostname, TX Power & Channel.","required":false,"schema":{"type":"boolean","default":true}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","format":"binary","description":"The Ekahau archive to import floors from."}},"required":["file"]}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqEkahauImportDetails"}}}}},"security":[{"Bearer":[]}]}},"/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":{"type":"object","properties":{"file":{"type":"string","format":"binary","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."}},"required":["file"]}}},"required":true},"responses":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/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":{"type":"integer","format":"int32","default":1,"minimum":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 100","required":false,"schema":{"type":"integer","format":"int32","default":10,"maximum":100,"minimum":1}},{"name":"order","in":"query","description":"The sort order by name (ascending by default)","required":false,"schema":{"$ref":"#/components/schemas/XiqSortOrder","default":"ASC"}},{"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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqFloor"}}}}},"security":[{"Bearer":[]}]},"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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqFloor"}}}}},"security":[{"Bearer":[]}]}},"/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":{"type":"integer","format":"int32","default":1,"minimum":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 100","required":false,"schema":{"type":"integer","format":"int32","default":10,"maximum":100,"minimum":1}},{"name":"order","in":"query","description":"The sort order by name (ascending by default)","required":false,"schema":{"$ref":"#/components/schemas/XiqSortOrder","default":"ASC"}},{"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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqBuilding"}}}}},"security":[{"Bearer":[]}]},"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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqBuilding"}}}}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqLocation"}}}}},"security":[{"Bearer":[]}]}},"/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":{"type":"integer","format":"int32","default":1,"minimum":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 100","required":false,"schema":{"type":"integer","format":"int32","default":10,"maximum":100,"minimum":1}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqLdapServer"}}}}},"security":[{"Bearer":[]}]},"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":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqLdapServer"}}}}},"security":[{"Bearer":[]}]}},"/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","L3_ADDRESS_TYPE_HOST_NAME","L3_ADDRESS_TYPE_WILDCARD_HOST_NAME","L3_ADDRESS_TYPE_WILDCARD","UNRECOGNIZED"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/XiqL3AddressProfile"}}}}}},"security":[{"Bearer":[]}]},"post":{"tags":["Configuration - Policy"],"summary":"Create a L3 address profile","description":"Create a new L3 address profile.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_create_l3_address_profile"},"operationId":"createL3AddressProfile","requestBody":{"description":"The request body to create new L3 address profile.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqCreateL3AddressProfileRequest"}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqL3AddressProfileResponse"}}}}},"security":[{"Bearer":[]}]}},"/ip-firewall-policies":{"get":{"tags":["Configuration - Policy"],"summary":"List IP Firewall policies","description":"List a page of IP Firewall policies.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_list_ip_firewall_policies"},"operationId":"listIpFirewallPolicies","parameters":[{"name":"page","in":"query","description":"Page number, min = 1","required":false,"schema":{"type":"integer","format":"int32","default":1,"minimum":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 100","required":false,"schema":{"type":"integer","format":"int32","default":10,"maximum":100,"minimum":1}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqIpFirewall"}}}}},"security":[{"Bearer":[]}]},"post":{"tags":["Configuration - Policy"],"summary":"Create IP Firewall policy","description":"Create a new IP Firewall policy.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_create_ip_firewall_policy"},"operationId":"createIpFirewallPolicy","requestBody":{"description":"The payload to create a new IP Firewall policy.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqIpFirewallPolicyRequest"}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqIpFirewall"}}}}},"security":[{"Bearer":[]}]}},"/ip-firewall-policies/{id}/ip-firewall-rule/:detach":{"post":{"tags":["Configuration - Policy"],"summary":"Detach IP Firewall Rule from IP Firewall policy","description":"Detach IP Firewall Rule from IP Firewall policy.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_detach_ip_firewall_rule_from_an_ip_firewall_policy"},"operationId":"detachServiceToIpFirewallPolicy","parameters":[{"name":"id","in":"path","description":"The IP Firewall Policy ID","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"description":"The IP Firewall Rule to be detached from the IP Firewall Policy.","content":{"application/json":{"schema":{"type":"integer","format":"int64"}}},"required":true},"responses":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/ip-firewall-policies/{id}/ip-firewall-rule/:attach":{"post":{"tags":["Configuration - Policy"],"summary":"Attach IP Firewall Rule to IP Firewall policy","description":"Attach IP Firewall Rule to IP Firewall policy.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_attach_ip_firewall_rule_to_an_ip_firewall_policy"},"operationId":"attachServiceToIpFirewallPolicy","parameters":[{"name":"id","in":"path","description":"The IP Firewall Policy ID","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"description":"The IP Firewall Rule to be attached to the IP Firewall Policy.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqIpFirewallRuleRequest"}}},"required":true},"responses":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/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":{"type":"integer","format":"int32","default":1,"minimum":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 100","required":false,"schema":{"type":"integer","format":"int32","default":10,"maximum":500,"minimum":1}},{"name":"appId","in":"query","description":"Application ID, e.g. THREAD_GATEWAY","required":false,"schema":{"$ref":"#/components/schemas/XiqIotApplicationId"}},{"name":"appSupported","in":"query","description":"Application Supported, e.g. SINGLE or MULTI","required":false,"schema":{"$ref":"#/components/schemas/XiqIotApplicationSupported"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqIotProfile"}}}}},"security":[{"Bearer":[]}]},"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":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqIotProfile"}}}}},"security":[{"Bearer":[]}]}},"/hotspot-service-provider-profiles":{"get":{"tags":["Configuration - Policy"],"summary":"List Hotspot Service Provider profiles","description":"List a page of Hotspot Service Provider profiles.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_list_the_hotspot_profiles"},"operationId":"listHotspotServiceProviderProfiles","parameters":[{"name":"page","in":"query","description":"Page number, min = 1","required":false,"schema":{"type":"integer","format":"int32","default":1,"minimum":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 500","required":false,"schema":{"type":"integer","format":"int32","default":10,"maximum":500,"minimum":1}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqHotspotServiceProviderProfile"}}}}},"security":[{"Bearer":[]}]},"post":{"tags":["Configuration - Policy"],"summary":"Create a Hotspot Service Provider profile","description":"Create a new Hotspot Service Provider profile.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_create_hotspot_profile_sp_configuration"},"operationId":"createHotspotServiceProviderProfile","requestBody":{"description":"The request body to create new Hotspot Service Provider profile.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqHotspotServiceProviderProfileRequest"}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqHotspotServiceProviderProfile"}}}}},"security":[{"Bearer":[]}]}},"/hotspot-profiles":{"get":{"tags":["Configuration - Policy"],"summary":"List Hotspot profiles","description":"List a page of Hotspot profiles.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_list_the_hotspot_profiles"},"operationId":"listHotspotProfiles","parameters":[{"name":"page","in":"query","description":"Page number, min = 1","required":false,"schema":{"type":"integer","format":"int32","default":1,"minimum":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 500","required":false,"schema":{"type":"integer","format":"int32","default":10,"maximum":500,"minimum":1}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqHotspotProfile"}}}}},"security":[{"Bearer":[]}]},"post":{"tags":["Configuration - Policy"],"summary":"Create a Hotspot profile","description":"Create a new Hotspot profile.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_create_hotspot_profile_configuration"},"operationId":"createHotspotProfile","requestBody":{"description":"The request body to create new Hotspot profile.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqHotspotProfileRequest"}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqHotspotProfile"}}}}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/XiqOrganization"}}}}}},"security":[{"Bearer":[]}]},"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":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqOrganization"}}}}},"security":[{"Bearer":[]}]}},"/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":{"204":{"description":"No Content"}},"security":[{"Bearer":[]}]}},"/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":{"type":"integer","format":"int32","default":1,"minimum":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 100","required":false,"schema":{"type":"integer","format":"int32","default":10,"maximum":100,"minimum":1}},{"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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqEndUser"}}}}},"security":[{"Bearer":[]}]},"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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqEndUser"}}}}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqRegenerateEndUserPasswordResponse"}}}}},"security":[{"Bearer":[]}]}},"/endusers/client/unlock":{"post":{"tags":["Configuration - User Management"],"summary":"Unlock locked clients","description":"Unlock one or more locked clients by MAC address.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_unlock_client"},"operationId":"unlockClients","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqUnlockClientsRequest"}}},"required":true},"responses":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/devices/{id}/monitor/:refresh":{"post":{"tags":["Device"],"summary":"Monitor refresh a device","description":"Monitor refresh a specific device.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_monitor_refresh_one_device"},"operationId":"monitorRefreshDevice","parameters":[{"name":"id","in":"path","description":"The device ID","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"function","in":"query","description":"Monitor refresh function","required":false,"schema":{"type":"string","default":"ROUTE","enum":["ROUTE","MAC","UNRECOGNIZED"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqDeviceMonitorRefreshResponse"}}}}},"security":[{"Bearer":[]}]}},"/devices/{id}/iot/:enable":{"post":{"tags":["Device"],"summary":"Enable IoT Wireless Interface settings on device","description":"Enable and attach IoT profile Wireless Interface settings by device ID and IoT profile ID.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_enable_and_attach_iot_on_device"},"operationId":"enableIotOnDevice","parameters":[{"name":"id","in":"path","description":"The device ID","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"description":"The IoT profile ID to be attached to the device","content":{"application/json":{"schema":{"type":"integer","format":"int64"}}},"required":true},"responses":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/devices/{id}/iot/:disable":{"post":{"tags":["Device"],"summary":"Disable IoT Wireless Interface settings on device","description":"Disable and detach IoT profile Wireless Interface settings by device ID and IoT profile ID.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_disable_and_detach_iot_on_device"},"operationId":"disableIotOnDevice","parameters":[{"name":"id","in":"path","description":"The device ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqBounceDevicePortResponse"}}}}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/XiqChangeStatusToManageResponse"}}}}}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqSendCliResponse"}}}}},"security":[{"Bearer":[]}]}},"/devices/validate-device-action":{"post":{"tags":["Device"],"summary":"validate device action metadata","description":"validate metadata information of actions supported for devices","operationId":"validateDeviceAction","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqRmDeviceActionValidationRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqRmDeviceActionValidationResponse"}}}}},"security":[{"Bearer":[]}]}},"/devices/thread/commissioner/stop":{"post":{"tags":["Device"],"summary":"Stop Thread Commissioner by Buildings","description":"Stop the thread commissioner on the devices located in the buildings.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_thread_stop_commissioner_by_buildings"},"operationId":"stopThreadCommissionerByBuildings","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqThreadStopCommissionerByBuildingsRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqThreadStopCommissionerByBuildingsResponse"}}}}},"security":[{"Bearer":[]}]}},"/devices/thread/commissioner/start":{"post":{"tags":["Device"],"summary":"Start Thread Commissioner by Buildings","description":"Start the thread commissioner on the devices located in the buildings.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_thread_start_commissioner_by_buildings"},"operationId":"startThreadCommissionerByBuildings","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqThreadStartCommissionerByBuildingsRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqThreadStartCommissionerByBuildingsResponse"}}}}},"security":[{"Bearer":[]}]}},"/devices/rm-devices-page":{"post":{"tags":["Device"],"summary":"[LRO] RM Device Page","description":"Device List with pagination.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_rm_device_list"},"operationId":"rmDeviceList","parameters":[{"name":"page","in":"query","description":"Page number, min = 1","required":false,"schema":{"type":"integer","format":"int32","default":1,"minimum":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 100","required":false,"schema":{"type":"integer","format":"int32","default":10,"maximum":100,"minimum":1}},{"name":"keyword","in":"query","description":"The keyword to search","required":false,"schema":{"type":"string"}},{"name":"connected","in":"query","description":"The device connect status","required":false,"schema":{"type":"boolean"}},{"name":"adminStates","in":"query","description":"The device admin states to filter","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/XiqDeviceAdminState"}}},{"name":"deviceCategory","in":"query","description":"The device category - Wired, Wireless, TPME, Appliances","required":false,"schema":{"$ref":"#/components/schemas/XiqRmDeviceCategoryRequest"}},{"name":"sortField","in":"query","description":"The sort field","required":false,"schema":{"$ref":"#/components/schemas/XiqRmDeviceSortField"}},{"name":"order","in":"query","description":"The sort order (ascending by default)","required":false,"schema":{"$ref":"#/components/schemas/XiqSortOrder","default":"ASC"}},{"name":"deviceTypes","in":"query","description":"The device types to return","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/XiqDeviceType"}}},{"name":"configMismatch","in":"query","description":"Config audit status(MATCHED(false) or UNMATCHED(true))","required":false,"schema":{"type":"boolean"}},{"name":"async","in":"query","description":"Whether to enable async mode","required":false,"schema":{"type":"boolean","default":false}},{"name":"includeUnassigned","in":"query","description":"Whether to include unassigned devices","required":false,"schema":{"type":"boolean","default":false}},{"name":"stacked_view","in":"query","description":"Whether to include only virtual stack (stacked_view = true) or also the stack members (stacked_view = false)","required":false,"schema":{"type":"boolean","default":true}},{"name":"copilotLicenseStatuses","in":"query","description":"The copilot license status to filter","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/XiqCopilotLicenseStatus"}}}],"requestBody":{"description":"The site IDs to filter devices","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqRmDeviceListRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqRmDevice"}}}}},"security":[{"Bearer":[]}]}},"/devices/rm-devices-page/export":{"post":{"tags":["Device"],"summary":"[LRO] Export RM devices data to CSV","description":"Export RM devices data to a CSV file.","operationId":"exportRmDevicesToCsv","parameters":[{"name":"keyword","in":"query","description":"The keyword to search","required":false,"schema":{"type":"string"}},{"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":"deviceCategory","in":"query","description":"The device category - wired, wireless","required":false,"schema":{"$ref":"#/components/schemas/XiqDeviceCategory"}},{"name":"sortField","in":"query","description":"The sort field","required":false,"schema":{"$ref":"#/components/schemas/XiqRmDeviceSortField"}},{"name":"sortOrder","in":"query","description":"Sort order (ASC, DESC)","required":false,"schema":{"$ref":"#/components/schemas/XiqSortOrder","default":"ASC"}},{"name":"deviceTypes","in":"query","description":"The device types to return","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/XiqDeviceType"}}},{"name":"configMismatch","in":"query","description":"Config audit status(MATCHED(false) or UNMATCHED(true))","required":false,"schema":{"type":"boolean"}},{"name":"timezoneOffset","in":"query","description":"timezone offset","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"async","in":"query","description":"Param to include additional columns data corresponding to 'Show Additional Data' option on the Network Devices page","required":false,"schema":{"type":"boolean","default":false}},{"name":"includeUnassigned","in":"query","description":"Whether to include unassigned devices","required":false,"schema":{"type":"boolean","default":false}},{"name":"copilotLicenseStatuses","in":"query","description":"Copilot license status to filter devices","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/XiqCopilotLicenseStatus"}}}],"requestBody":{"description":"The site IDs to filter devices","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqRmDeviceListRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqRmDeviceListExport"}}}}},"security":[{"Bearer":[]}]}},"/devices/rm-devices-metadata":{"post":{"tags":["Device"],"summary":"Get Device List Metadata","description":"Retrieve metadata information about devices.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_device_list_metadata"},"operationId":"getDeviceListMetadata","parameters":[{"name":"deviceCategory","in":"query","description":"The device category - Wired, Wireless, TPME, Appliances","required":false,"schema":{"$ref":"#/components/schemas/XiqRmDeviceCategoryRequest"}},{"name":"adminStates","in":"query","description":"The device admin states to filter","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/XiqDeviceAdminState"}}},{"name":"deviceTypes","in":"query","description":"The device types to return","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/XiqDeviceType"}}},{"name":"includeUnassigned","in":"query","description":"Whether to include unassigned devices","required":false,"schema":{"type":"boolean","default":false}}],"requestBody":{"description":"Request body for site id filter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqRmSiteIdsRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqRmDeviceMetadataResponse"}}}}},"security":[{"Bearer":[]}]}},"/devices/rm-devices-connection-status":{"post":{"tags":["Device"],"summary":"Get Device Connection Status","description":"Retrieve the connection status of devices for given site IDs.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_rm_device_connection_status"},"operationId":"getDeviceConnectionStatus","parameters":[{"name":"deviceCategory","in":"query","description":"The device category - Wired, Wireless, TPME, Appliances","required":false,"schema":{"$ref":"#/components/schemas/XiqRmDeviceCategoryRequest"}},{"name":"deviceTypes","in":"query","description":"The device types to return","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/XiqDeviceType"}}},{"name":"includeUnassigned","in":"query","description":"Whether to include unassigned devices","required":false,"schema":{"type":"boolean","default":false}}],"requestBody":{"description":"Request body for site id filter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqRmSiteIdsRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqRmDeviceConnectionStatus"}}}}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/XiqNetworkPolicy"}}}}}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/XiqDeviceLocation"}}}}}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/devices/client-monitor/:revoke":{"post":{"tags":["Device"],"summary":"Revoke client monitor setting for multiple devices","description":"Revoke the client monitor setting from the target devices.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_revoke_client_monitor_for_multiple_devices"},"operationId":"revokeDevicesClientMonitor","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqDeviceFilter"}}},"required":true},"responses":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/devices/client-monitor/:query":{"post":{"tags":["Device"],"summary":"Query client monitor setting for multiple devices","description":"Query the client monitor setting for the target devices.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_query_client_monitor_for_multiple_devices"},"operationId":"queryDevicesClientMonitor","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqDeviceFilter"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/XiqDeviceClientMonitor"}}}}}},"security":[{"Bearer":[]}]}},"/devices/client-monitor/:assign":{"post":{"tags":["Device"],"summary":"Assign client monitor setting to multiple devices","description":"Assign the client monitor setting to the target devices.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_assign_client_monitor_to_multiple_devices"},"operationId":"assignDevicesClientMonitor","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqAssignDevicesClientMonitorRequest"}}},"required":true},"responses":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/devices/anchor/revoke":{"post":{"tags":["Device"],"summary":"Revoke Anchor capability for multiple devices","description":"Revoke Anchor capability from the target devices.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_revoke_multiple_devices_as_anchor"},"operationId":"revokeDevicesAsAnchor","parameters":[{"name":"ids","in":"query","description":"The device IDs","required":true,"schema":{"type":"array","items":{"type":"integer","format":"int64"}}}],"responses":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/devices/anchor/assign":{"post":{"tags":["Device"],"summary":"Assign AP5050 devices as Anchor devices","description":"Assign multiple AP5050 devices as Anchor.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_assign_multiple_devices_as_anchor"},"operationId":"assignDevicesAsAnchor","parameters":[{"name":"ids","in":"query","description":"The device IDs","required":true,"schema":{"type":"array","items":{"type":"integer","format":"int64"}}}],"responses":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/devices/actions-support-metadata":{"post":{"tags":["Device"],"summary":"Get Actions Support metadata","description":"Get metadata information of actions supported for devices","operationId":"getDeviceActionSupportMetadata","parameters":[{"name":"deviceActions","in":"query","description":"Request body for device model properties","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/XiqRmDeviceAction"}}}],"requestBody":{"description":"Filter for product types","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqRmDeviceActionSupportMetadataRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqRmDeviceActionSupportMetadataResponse"}}}}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/devices/:ssh-active-sessions":{"post":{"tags":["Device"],"summary":"List SSH active sessions","description":"List active SSH sessions for devices.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_list_ssh_active_sessions"},"operationId":"listSshActiveSessions","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqSshActiveSessionsRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/XiqSshActiveSessionsResponse"}}}}}},"security":[{"Bearer":[]}]}},"/devices/:reset":{"post":{"tags":["Device"],"summary":"[LRO] Reset devices to factory default","description":"Reset multiple devices to factory default settings.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_factory_reset_devices"},"operationId":"resetDevices","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/XiqDevicesResetToDefaultRequest"}}},"required":true},"responses":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqOnboardDeviceResponse"}}}}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/XiqChangeStatusToManageResponse"}}}}}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqSendCliResponse"}}}}},"security":[{"Bearer":[]}]}},"/devices/:check-ownership":{"post":{"tags":["Device"],"summary":"Check caller is allowed to access the device","description":"Check caller is allowed to access the device.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_check_device_ownership_by_serial_number"},"operationId":"checkDeviceOwnership","requestBody":{"content":{"application/json":{"schema":{"type":"string","description":"The device serial number"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"boolean"}}}}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqAdvancedOnboardDeviceResponse"}}}}},"security":[{"Bearer":[]}]}},"/deployments":{"get":{"tags":["Configuration - Deployment"],"summary":"Get list of deployments","description":"Get deployment details across multiple sites.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_list_of_deployments"},"operationId":"getListOfDeployments","parameters":[{"name":"page","in":"query","description":"Page number, min = 1","required":false,"schema":{"type":"integer","format":"int32","default":1,"minimum":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 100","required":false,"schema":{"type":"integer","format":"int32","default":10,"maximum":100,"minimum":1}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqDeploymentDetailsResponse"}}}}},"security":[{"Bearer":[]}]},"post":{"tags":["Configuration - Deployment"],"summary":"[LRO] Push configuration and upgrade firmware","description":"Push configuration and upgrade firmware to the target devices. To avoid API timeout with large number of devices, \n 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#_push_configuration_and_upgrade_firmware_to_devices"},"operationId":"deployConfig","parameters":[{"name":"async","in":"query","description":"Whether to enable async mode","required":false,"schema":{"type":"boolean"}}],"requestBody":{"description":"The device deploy configuration","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqDeploymentRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqDeploymentResponse"}}}}},"security":[{"Bearer":[]}]}},"/deployments/firmware-metadatas":{"post":{"tags":["Configuration - Deployment"],"summary":"Get device firmware metadatas","description":"Get the compatible firmware metadatas for the devices.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_device_firmware_metadatas"},"operationId":"getDeviceFirmwareMetadatas","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqFirmwareMetadatasRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqFirmwareMetadatasResponse"}}}}},"security":[{"Bearer":[]}]}},"/dashboard/wireless/usage-capacity/grid":{"post":{"tags":["Dashboard Wireless Usage and Capacity"],"summary":"Wireless usage & capacity grid","description":"Returns the usage & capacity grid of wireless devices based on the provided filters. You can filter the results by sites.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_usage_and_capacity_grid"},"operationId":"getUsageCapacityGrid","parameters":[{"name":"page","in":"query","description":"Page number, min = 1","required":false,"schema":{"type":"integer","format":"int32","default":1,"minimum":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 100","required":false,"schema":{"type":"integer","format":"int32","default":10,"maximum":100,"minimum":1}},{"name":"keyword","in":"query","description":"The keyword to search - site name, device hostname, device MAC","required":false,"schema":{"type":"string"}},{"name":"sortField","in":"query","description":"The sort field","required":false,"schema":{"type":"string","enum":["HOSTNAME","SITE","RADIO_2DOT4G_UTILIZATION_SCORE","RADIO_5G_UTILIZATION_SCORE","RADIO_6G_UTILIZATION_SCORE","WIFI0_RETRY_SCORE","WIFI1_RETRY_SCORE","WIFI2_RETRY_SCORE","WIFI0_PACKET_LOSS","WIFI1_PACKET_LOSS","WIFI2_PACKET_LOSS","ETH0_UNICAST_SCORE","ETH0_BROADCAST_SCORE","ETH0_MULTICAST_SCORE","ETH1_UNICAST_SCORE","ETH1_BROADCAST_SCORE","ETH1_MULTICAST_SCORE","WIFI0_INTERFERENCE_SCORE","WIFI1_INTERFERENCE_SCORE","WIFI2_INTERFERENCE_SCORE","WIFI0_NOISE","WIFI1_NOISE","WIFI2_NOISE","TOTAL_ETH0_SCORE","TOTAL_ETH1_SCORE"]}},{"name":"sortOrder","in":"query","description":"The sort order (descending by default)","required":false,"schema":{"$ref":"#/components/schemas/XiqSortOrder","default":"DESC"}},{"name":"includeUnassigned","in":"query","description":"Whether to include unassigned devices","required":false,"schema":{"type":"boolean","default":false}}],"requestBody":{"description":"Request body for  Usage and Capacity Grid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqUsageAndCapacityGridFilter"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqUsageCapacityGridResponse"}}}}},"security":[{"Bearer":[]}]}},"/dashboard/wireless/usage-capacity/export":{"post":{"tags":["Dashboard Wireless Usage and Capacity"],"summary":"Export all Wireless Usage Capacity Data to CSV","description":"Export all Wireless Usage Capacity  Data to a CSV file.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_export_usage_capacity_report"},"operationId":"exportToCsv_1","parameters":[{"name":"keyword","in":"query","description":"The keyword to search - site name, device hostname, device MAC","required":false,"schema":{"type":"string"}},{"name":"sortField","in":"query","description":"The sort field","required":false,"schema":{"type":"string","enum":["HOSTNAME","SITE","RADIO_2DOT4G_UTILIZATION_SCORE","RADIO_5G_UTILIZATION_SCORE","RADIO_6G_UTILIZATION_SCORE","WIFI0_RETRY_SCORE","WIFI1_RETRY_SCORE","WIFI2_RETRY_SCORE","WIFI0_PACKET_LOSS","WIFI1_PACKET_LOSS","WIFI2_PACKET_LOSS","ETH0_UNICAST_SCORE","ETH0_BROADCAST_SCORE","ETH0_MULTICAST_SCORE","ETH1_UNICAST_SCORE","ETH1_BROADCAST_SCORE","ETH1_MULTICAST_SCORE","WIFI0_INTERFERENCE_SCORE","WIFI1_INTERFERENCE_SCORE","WIFI2_INTERFERENCE_SCORE","WIFI0_NOISE","WIFI1_NOISE","WIFI2_NOISE","TOTAL_ETH0_SCORE","TOTAL_ETH1_SCORE"]}},{"name":"sortOrder","in":"query","description":"The sort order (descending by default)","required":false,"schema":{"$ref":"#/components/schemas/XiqSortOrder","default":"DESC"}},{"name":"includeUnassigned","in":"query","description":"Whether to include unassigned devices","required":false,"schema":{"type":"boolean","default":false}}],"requestBody":{"description":"Request body for  Usage and Capacity Grid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqUsageAndCapacityGridFilter"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqMetricReport"}}}}},"security":[{"Bearer":[]}]}},"/dashboard/wireless/usage-capacity/excessive-utilization":{"post":{"tags":["Dashboard Wireless Usage and Capacity"],"summary":"Count of APs with excessive utilization","description":"Returns the count of wireless devices having excessive channel utilization based on the provided filters. You can filter the results by sites, device types, and a specific timestamp.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_count_of_aps_with_excessive_utilization"},"operationId":"getWirelessUsageCapacityExcessiveUtilization","parameters":[{"name":"includeUnassigned","in":"query","description":"Whether to include unassigned devices","required":false,"schema":{"type":"boolean","default":false}}],"requestBody":{"description":"Request body for Device Health Grid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqDashboardFilter"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqWirelessUsageCapacityExcessiveUtilization"}}}}},"security":[{"Bearer":[]}]}},"/dashboard/wireless/usage-capacity/excessive-retries":{"post":{"tags":["Dashboard Wireless Usage and Capacity"],"summary":"Count of APs with excessive retries","description":"Returns the count of wireless devices having excessive retries based on the provided filters. You can filter the results by sites.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_count_of_aps_with_excessive_retries"},"operationId":"getCountExcessiveRetries","parameters":[{"name":"includeUnassigned","in":"query","description":"Whether to include unassigned devices","required":false,"schema":{"type":"boolean","default":false}}],"requestBody":{"description":"Request body for count excessive retries","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqDashboardFilter"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqCountApWithExcessiveRetriesResponse"}}}}},"security":[{"Bearer":[]}]}},"/dashboard/wireless/usage-capacity/excessive-packet-loss":{"post":{"tags":["Dashboard Wireless Usage and Capacity"],"summary":"Count of APs with excessive packet loss","description":"Returns the count of wireless devices having excessive packet loss based on the provided filters. You can filter the results by sites","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_count_of_aps_with_excessive_packet_loss"},"operationId":"getPacketLossExcessiveResponse","parameters":[{"name":"includeUnassigned","in":"query","description":"Whether to include unassigned devices","required":false,"schema":{"type":"boolean","default":false}}],"requestBody":{"description":"Request body for count of APs with excessive packet loss","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqDashboardFilter"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqCountApWithPacketLossExcessiveResponse"}}}}},"security":[{"Bearer":[]}]}},"/dashboard/wireless/device-health/summary":{"post":{"tags":["Dashboard Wireless Device Health"],"summary":"Device health summary for wireless devices","description":"Returns the count of total wireless devices and total devices with health issues based on the provided filters. You can filter the results by sites.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_count_of_device_summary"},"operationId":"getDeviceSummary","parameters":[{"name":"includeUnassigned","in":"query","description":"Whether to include unassigned devices","required":false,"schema":{"type":"boolean","default":false}}],"requestBody":{"description":"List of site IDs to filter the wireless device health summary","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqDashboardFilter"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqDeviceSummary"}}}}},"security":[{"Bearer":[]}]}},"/dashboard/wireless/device-health/issues/poe-usage-issues":{"post":{"tags":["Dashboard Wireless Device Health"],"summary":"PoE usage issues for wireless devices","description":"Returns the count of wireless devices having PoE usage issues (Non-adequate power) based on the provided filters. You can filter the results by sites.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_count_of_device_with_poe_usage_issue"},"operationId":"getDevicePoeUsageIssuesCount","parameters":[{"name":"includeUnassigned","in":"query","description":"Whether to include unassigned devices","required":false,"schema":{"type":"boolean","default":false}}],"requestBody":{"description":"List of site IDs to filter the wireless devices PoE usage issues","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqDashboardFilter"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqDevicePoeUsageIssuesCount"}}}}},"security":[{"Bearer":[]}]}},"/dashboard/wireless/device-health/issues/memory-usage-issues":{"post":{"tags":["Dashboard Wireless Device Health"],"summary":"Memory usage issues for wireless devices","description":"Returns the count of wireless devices having Memory usage issues based on the provided filters. You can filter the results by sites.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_count_of_device_with_memory_usage_issue"},"operationId":"getDeviceMemoryUsageIssueCount","parameters":[{"name":"includeUnassigned","in":"query","description":"Whether to include unassigned devices","required":false,"schema":{"type":"boolean","default":false}}],"requestBody":{"description":"List of site IDs to filter the wireless devices Memory usage issues","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqDashboardFilter"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqDeviceMemoryUsageIssueCount"}}}}},"security":[{"Bearer":[]}]}},"/dashboard/wireless/device-health/issues/cpu-usage-issues":{"post":{"tags":["Dashboard Wireless Device Health"],"summary":"CPU usage issues for wireless devices","description":"Returns the count of wireless devices having CPU usage issues (CPU usage >= 95%) based on the provided filters. You can filter the results by sites.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_count_of_device_with_cpu_usage_issue"},"operationId":"getDeviceCpuUsageIssueCount","parameters":[{"name":"includeUnassigned","in":"query","description":"Whether to include unassigned devices","required":false,"schema":{"type":"boolean","default":false}}],"requestBody":{"description":"List of site IDs to filter the wireless devices Cpu usage issues","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqDashboardFilter"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqDeviceCpuUsageIssueCount"}}}}},"security":[{"Bearer":[]}]}},"/dashboard/wireless/device-health/grid":{"post":{"tags":["Dashboard Wireless Device Health"],"summary":"Wireless device health grid","description":"Returns the device health grid of wireless devices based on the provided filters. The results can be filtered by sites.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_device_health_grid"},"operationId":"getDeviceHealthGrid","parameters":[{"name":"page","in":"query","description":"Page number, min = 1","required":false,"schema":{"type":"integer","format":"int32","default":1,"minimum":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 100","required":false,"schema":{"type":"integer","format":"int32","default":10,"maximum":100,"minimum":1}},{"name":"keyword","in":"query","description":"The keyword to search - site name, device hostname, device MAC, device IP","required":false,"schema":{"type":"string"}},{"name":"sortField","in":"query","description":"The sort field","required":false,"schema":{"$ref":"#/components/schemas/XiqWirelessDeviceHealthSortField"}},{"name":"sortOrder","in":"query","description":"The sort order (descending by default)","required":false,"schema":{"$ref":"#/components/schemas/XiqSortOrder","default":"DESC"}},{"name":"includeUnassigned","in":"query","description":"Whether to include unassigned devices","required":false,"schema":{"type":"boolean","default":false}}],"requestBody":{"description":"Request body for Device health grid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqWirelessDeviceHealthGridFilter"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqDeviceHealthGridResponse"}}}}},"security":[{"Bearer":[]}]}},"/dashboard/wireless/device-health/export":{"post":{"tags":["Dashboard Wireless Device Health"],"summary":"Export all Wireless Device Health Data to CSV","description":"Export all Wireless Device Health Data to a CSV file.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_export_device_health_report"},"operationId":"exportToCsv_2","parameters":[{"name":"keyword","in":"query","description":"The keyword to search - site name, device hostname, device MAC, device IP","required":false,"schema":{"type":"string"}},{"name":"sortField","in":"query","description":"The sort field","required":false,"schema":{"$ref":"#/components/schemas/XiqWirelessDeviceHealthSortField"}},{"name":"sortOrder","in":"query","description":"The sort order (descending by default)","required":false,"schema":{"$ref":"#/components/schemas/XiqSortOrder","default":"DESC"}},{"name":"includeUnassigned","in":"query","description":"Whether to include unassigned devices","required":false,"schema":{"type":"boolean","default":false}}],"requestBody":{"description":"Request body for Device health grid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqWirelessDeviceHealthGridFilter"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqMetricReport"}}}}},"security":[{"Bearer":[]}]}},"/dashboard/wireless/dashboard/criteria":{"get":{"tags":["Dashboard"],"summary":"Criteria for Wireless Diagnostics Dashboard","description":"Returns the criteria for wireless diagnostics dashboard, including client health, device health, and usage and capacity issues.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_criteria_for_wireless_diagnostics_dashboard"},"operationId":"getWirelessDiagnosticsDashboardCriteriaParam","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqWirelessDashboardCriteriaParamResponse"}}}}},"security":[{"Bearer":[]}]}},"/dashboard/wireless/client-health/roaming-issues":{"post":{"tags":["Dashboard Wireless Client Health"],"summary":"Wireless clients count with roaming issues","description":"Returns the wireless clients with roaming issues based on the provided filters. You can filter the results by sites.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_wireless_clients_count_with_roaming_issues"},"operationId":"getClientHealthRoamingIssues","parameters":[{"name":"includeUnassigned","in":"query","description":"Whether to include unassigned devices","required":false,"schema":{"type":"boolean","default":false}}],"requestBody":{"description":"Request body for Roaming Issues Count","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqDashboardFilter"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqClientHealthRoamingIssues"}}}}},"security":[{"Bearer":[]}]}},"/dashboard/wireless/client-health/issue/roaming":{"post":{"tags":["Dashboard Wireless Client Health"],"summary":"Roaming issue for wireless client","description":"Returns roaming issue for wireless client based on the provided filters. You can filter the results by sites and mac address.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_post_client_health_issue_roaming"},"operationId":"getClientRoamingIssues","parameters":[{"name":"page","in":"query","description":"Page number, min = 1","required":false,"schema":{"type":"integer","format":"int32","default":1,"minimum":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 100","required":false,"schema":{"type":"integer","format":"int32","default":10,"maximum":100,"minimum":1}},{"name":"macAddress","in":"query","description":"macAddress","required":true,"schema":{"type":"string","example":"AABBCCDDFFEE","pattern":"^[0-9A-Fa-f]{12}$"}},{"name":"includeUnassigned","in":"query","description":"Whether to include unassigned devices","required":false,"schema":{"type":"boolean","default":false}}],"requestBody":{"description":"Request body for Roaming Issue","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqDashboardFilter"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/XiqIssueClientRoaming"}}}}}},"security":[{"Bearer":[]}]}},"/dashboard/wireless/client-health/issue/ipaddress":{"post":{"tags":["Dashboard Wireless Client Health"],"summary":"Ip Address issue for Wireless client","description":"Returns ip address issue for wireless client based on the provided filters. You can filter the results by sites and mac address.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_post_client_health_issue_ipaddress"},"operationId":"getClientIpAddressIssues","parameters":[{"name":"page","in":"query","description":"Page number, min = 1","required":false,"schema":{"type":"integer","format":"int32","default":1,"minimum":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 100","required":false,"schema":{"type":"integer","format":"int32","default":10,"maximum":100,"minimum":1}},{"name":"macAddress","in":"query","description":"The MAC address in format 'AABBCCDDEEFF' without separators. Accepted formats: (1) OUI only — first 6 hex characters (e.g., 'AABBCC'), (2) Full MAC address — 12 hex characters (e.g., 'AABBCCDDEEFF').","required":true,"schema":{"type":"string","description":"The MAC address in format 'AABBCCDDEEFF' without separators. Accepted formats: (1) OUI only — first 6 hex characters (e.g., 'AABBCC'), (2) Full MAC address — 12 hex characters (e.g., 'AABBCCDDEEFF').","example":"AABBCCDDEEFF"},"example":"AABBCCDDEEFF"},{"name":"includeUnassigned","in":"query","description":"Whether to include unassigned devices","required":false,"schema":{"type":"boolean","default":false}}],"requestBody":{"description":"Request body for IpAddress Issue","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqDashboardFilter"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/XiqIssueClientIpAddress"}}}}}},"security":[{"Bearer":[]}]}},"/dashboard/wireless/client-health/issue/authentication":{"post":{"tags":["Dashboard Wireless Client Health"],"summary":"Authentication issue for wireless client","description":"Returns authentication issue list for wireless client based on the provided filters. You can filter the results by sites and mac address.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_post_client_health_issue_authentication"},"operationId":"getClientAuthIssues","parameters":[{"name":"macAddress","in":"query","description":"The MAC address in format 'AABBCCDDEEFF' without separators. Accepted formats: (1) OUI only — first 6 hex characters (e.g., 'AABBCC'), (2) Full MAC address — 12 hex characters (e.g., 'AABBCCDDEEFF').","required":true,"schema":{"type":"string","description":"The MAC address in format 'AABBCCDDEEFF' without separators. Accepted formats: (1) OUI only — first 6 hex characters (e.g., 'AABBCC'), (2) Full MAC address — 12 hex characters (e.g., 'AABBCCDDEEFF').","example":"AABBCCDDEEFF"},"example":"AABBCCDDEEFF"},{"name":"includeUnassigned","in":"query","description":"Whether to include unassigned devices","required":false,"schema":{"type":"boolean","default":false}}],"requestBody":{"description":"Request body for Authentication Issue","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqDashboardFilter"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/XiqIssueClientAuth"}}}}}},"security":[{"Bearer":[]}]}},"/dashboard/wireless/client-health/issue/association":{"post":{"tags":["Dashboard Wireless Client Health"],"summary":"Association issue for wireless client","description":"Returns association issue list for wireless client based on the provided filters. You can filter the results by sites and macAddress.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_post_client_health_issue_association"},"operationId":"getClientAssociationIssues","parameters":[{"name":"page","in":"query","description":"Page number, min = 1","required":false,"schema":{"type":"integer","format":"int32","default":1,"minimum":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 100","required":false,"schema":{"type":"integer","format":"int32","default":10,"maximum":100,"minimum":1}},{"name":"macAddress","in":"query","description":"The MAC address in format 'AABBCCDDEEFF' without separators. Accepted formats: (1) OUI only — first 6 hex characters (e.g., 'AABBCC'), (2) Full MAC address — 12 hex characters (e.g., 'AABBCCDDEEFF').","required":true,"schema":{"type":"string","description":"The MAC address in format 'AABBCCDDEEFF' without separators. Accepted formats: (1) OUI only — first 6 hex characters (e.g., 'AABBCC'), (2) Full MAC address — 12 hex characters (e.g., 'AABBCCDDEEFF').","example":"AABBCCDDEEFF"},"example":"AABBCCDDEEFF"},{"name":"includeUnassigned","in":"query","description":"Whether to include unassigned devices","required":false,"schema":{"type":"boolean","default":false}}],"requestBody":{"description":"Request body for Association Issue","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqDashboardFilter"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/XiqIssueClientAssociation"}}}}}},"security":[{"Bearer":[]}]}},"/dashboard/wireless/client-health/grid":{"post":{"tags":["Dashboard Wireless Client Health"],"summary":"Wireless client health grid","description":"Returns the client health grid of wireless devices based on the provided filters. You can filter the results by sites.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_post_client_health_grid"},"operationId":"getClientHealthGrid","parameters":[{"name":"page","in":"query","description":"Page number, min = 1","required":false,"schema":{"type":"integer","format":"int32","default":1,"minimum":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 100","required":false,"schema":{"type":"integer","format":"int32","default":10,"maximum":100,"minimum":1}},{"name":"keyword","in":"query","description":"The keyword to search ","required":false,"schema":{"type":"string"}},{"name":"connectionStatus","in":"query","description":"Connection Status","required":false,"schema":{"$ref":"#/components/schemas/XiqClientConnectionStatus"}},{"name":"sortField","in":"query","description":"Sort Field","required":false,"schema":{"$ref":"#/components/schemas/XiqClientHealthSortField"}},{"name":"sortOrder","in":"query","description":"Sort Order","required":false,"schema":{"$ref":"#/components/schemas/XiqSortOrder","default":"DESC"}},{"name":"includeUnassigned","in":"query","description":"Whether to include unassigned devices","required":false,"schema":{"type":"boolean","default":false}}],"requestBody":{"description":"Request body for Client Health Grid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqClientGridFilter"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqClientHealthGridResponse"}}}}},"security":[{"Bearer":[]}]}},"/dashboard/wireless/client-health/frequency-distribution":{"post":{"tags":["Dashboard Wireless Client Health"],"summary":"Wireless clients count with frequency distribution","description":"Returns the wireless clients with different frequency distribution based on the provided filters. You can filter the results by sites.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_wireless_clients_count_with_frequency_distribution"},"operationId":"getClientFrequencyDistribution","parameters":[{"name":"includeUnassigned","in":"query","description":"Whether to include unassigned devices","required":false,"schema":{"type":"boolean","default":false}}],"requestBody":{"description":"Request body for Frequency Distribution Count","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqDashboardFilter"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqClientHealthFrequencyDistribution"}}}}},"security":[{"Bearer":[]}]}},"/dashboard/wireless/client-health/filter-metadata":{"post":{"tags":["Dashboard Wireless Client Health"],"summary":"Filter Metadata for Wireless Client Health Grid","description":"Filter Metadata for Wireless Client Health Grid based on the provided filters. You can filter the results by sites.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_wireless_client_health_grid_filter_metadata"},"operationId":"getClientHealthGridFilterMetadata","parameters":[{"name":"includeUnassigned","in":"query","description":"Whether to include unassigned devices","required":false,"schema":{"type":"boolean","default":false}}],"requestBody":{"description":"Request body for Client Health Grid Filter Metadata","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqDashboardFilter"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqWirelessClientHealthGridFilterMetadata"}}}}},"security":[{"Bearer":[]}]}},"/dashboard/wireless/client-health/export":{"post":{"tags":["Dashboard Wireless Client Health"],"summary":"Export all Client Health Data to CSV","description":"Export all Client Health Data to a CSV file.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_export_client_health_report"},"operationId":"exportToCsv_3","parameters":[{"name":"keyword","in":"query","description":"The keyword to search ","required":false,"schema":{"type":"string"}},{"name":"connectionStatus","in":"query","description":"Connection Status","required":false,"schema":{"$ref":"#/components/schemas/XiqClientConnectionStatus"}},{"name":"sortField","in":"query","description":"Sort Field","required":false,"schema":{"$ref":"#/components/schemas/XiqClientHealthSortField"}},{"name":"sortOrder","in":"query","description":"Sort Order","required":false,"schema":{"$ref":"#/components/schemas/XiqSortOrder"}},{"name":"includeUnassigned","in":"query","description":"Whether to include unassigned devices","required":false,"schema":{"type":"boolean","default":false}}],"requestBody":{"description":"Request body for Client Health Grid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqClientGridFilter"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqMetricReport"}}}}},"security":[{"Bearer":[]}]}},"/dashboard/wireless/client-health/connectivity-issues":{"post":{"tags":["Dashboard Wireless Client Health"],"summary":"Wireless clients count with connectivity issues","description":"Returns the wireless clients with connectivity issues based on the provided filters. You can filter the results by sites.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_wireless_clients_count_with_connectivity_issues"},"operationId":"getClientHealthConnectivityIssues","parameters":[{"name":"includeUnassigned","in":"query","description":"Whether to include unassigned devices","required":false,"schema":{"type":"boolean","default":false}}],"requestBody":{"description":"Request body for Connectivity Issues Count","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqDashboardFilter"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqClientHealthConnectivityIssues"}}}}},"security":[{"Bearer":[]}]}},"/dashboard/wired/usage-capacity/wired-throughput":{"post":{"tags":["Dashboard Wired Usage and Capacity"],"summary":"Wired devices throughput","description":"Returns the throughput for wired devices based on the provided filters. The result can be filtered by sites.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_post_wired_usage_capacity_throughput"},"operationId":"getWiredUsageCapacityThroughput","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqWiredUsageCapacityThroughputRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqWiredUsageCapacityThroughputResponse"}}}}},"security":[{"Bearer":[]}]}},"/dashboard/wired/usage-capacity/wired-congestion":{"post":{"tags":["Dashboard Wired Usage and Capacity"],"summary":"Wired devices congestion","description":"Returns the congestion for wired devices based on the provided filters. The result can be filtered by sites.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_post_wired_usage_capacity_congestion"},"operationId":"getWiredUsageCapacityCongestion","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqWiredUsageCapacityThroughputRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqWiredUsageCapacityCongestionResponse"}}}}},"security":[{"Bearer":[]}]}},"/dashboard/wired/usage-capacity/usage-utilization":{"post":{"tags":["Dashboard Wired Usage and Capacity"],"summary":"Wired devices total utilized bandwidth","description":"Returns total bandwidth utilized by wired devices based on the provided filters. The result can be filtered by sites.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_post_wired_usage_capacity_usage_utilization"},"operationId":"getWiredUsageCapacityUsageUtilization","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqWiredUsageCapacityUsageUtilizationRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqWiredUsageCapacityUsageUtilizationResponse"}}}}},"security":[{"Bearer":[]}]}},"/dashboard/wired/usage-capacity/grid":{"post":{"tags":["Dashboard Wired Usage and Capacity"],"summary":"Wired Usage and Capacity grid","description":"Returns information related to usage and capacity for wired devices based on the provided filters. The result can be filtered by sites.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_post_wired_usage_capacity_grid"},"operationId":"getWiredUsageCapacityGrid","parameters":[{"name":"page","in":"query","description":"Page number, min = 1","required":false,"schema":{"type":"integer","format":"int32","default":1,"minimum":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 100","required":false,"schema":{"type":"integer","format":"int32","default":10,"maximum":100,"minimum":1}},{"name":"keyword","in":"query","description":"The keyword to search","required":false,"schema":{"type":"string"}},{"name":"sortField","in":"query","description":"The field used for sorting","required":false,"schema":{"$ref":"#/components/schemas/XiqWiredUsageAndCapacitySortField","default":"UNSPECIFIED"}},{"name":"sortOrder","in":"query","description":"The sort order","required":false,"schema":{"$ref":"#/components/schemas/XiqSortOrder","default":"DESC"}}],"requestBody":{"description":"Request body for Wired Usage and Capacity grid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqWiredUsageCapacityGridRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqWiredUsageCapacityGridResponse"}}}}},"security":[{"Bearer":[]}]}},"/dashboard/wired/device-health/temperature-status":{"post":{"tags":["Dashboard Wired Device Health"],"summary":"Wired Device Health Temperature Status","description":"Returns the temperature status of the device","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_post_wired_device_health_temperature_status"},"operationId":"getWiredDeviceHealthTempStatus","parameters":[{"name":"deviceId","in":"query","description":"The ID of the device","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqWiredDeviceHealthTemperatureStatusResponse"}}}}},"security":[{"Bearer":[]}]}},"/dashboard/wired/device-health/temperature-issues":{"post":{"tags":["Dashboard Wired Device Health"],"summary":"Wired Device Health Temperature Issues","description":"Returns the total number of wired devices with temperature issues based on the provided filters. The results can be filtered by sites.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_post_wired_device_health_temperature"},"operationId":"getWiredDeviceHealthTemp","requestBody":{"description":"List of site IDs to filter the wired devices","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqWiredDeviceHealthTempRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqWiredDeviceHealthTempResponse"}}}}},"security":[{"Bearer":[]}]}},"/dashboard/wired/device-health/summary":{"post":{"tags":["Dashboard Wired Device Health"],"summary":"Wired Device Health Summary","description":"Returns the total number of wired devices and the total number of wired devices with health issues based on the provided filters. The results can be filtered by sites.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_post_wired_device_health_summary"},"operationId":"getWiredDeviceHealthSummary","requestBody":{"description":"List of site IDs to filter the wired devices","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqWiredDeviceHealthSummaryRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqWiredDeviceHealthSummaryResponse"}}}}},"security":[{"Bearer":[]}]}},"/dashboard/wired/device-health/psu-status":{"post":{"tags":["Dashboard Wired Device Health"],"summary":"Wired Device Health PSU Status","description":"Returns the PSU status of the device","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_post_wired_device_health_psu_status"},"operationId":"getWiredDeviceHealthPsuStatus","parameters":[{"name":"deviceId","in":"query","description":"The ID of the device","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqWiredDeviceHealthPsuStatusResponse"}}}}},"security":[{"Bearer":[]}]}},"/dashboard/wired/device-health/psu-issues":{"post":{"tags":["Dashboard Wired Device Health"],"summary":"Wired Device Health PSU Issues","description":"Returns the total number of wired devices with PSU issues based on the provided filters. The results can be filtered by sites.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_post_wired_device_health_psu"},"operationId":"getWiredDeviceHealthPsu","requestBody":{"description":"List of site IDs to filter the wired devices","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqWiredDeviceHealthPsuRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqWiredDeviceHealthPsuResponse"}}}}},"security":[{"Bearer":[]}]}},"/dashboard/wired/device-health/poe-usage-status":{"post":{"tags":["Dashboard Wired Device Health"],"summary":"Wired Device Health PoE Usage Status","description":"Returns the PoE usage status of the device","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_post_wired_device_health_poe_usage_status"},"operationId":"getWiredDeviceHealthPoeUsageStatus","parameters":[{"name":"deviceId","in":"query","description":"The ID of the device","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqWiredDeviceHealthPoeUsageStatusResponse"}}}}},"security":[{"Bearer":[]}]}},"/dashboard/wired/device-health/poe-usage-issues":{"post":{"tags":["Dashboard Wired Device Health"],"summary":"Wired Device Health PoE Usage Issues","description":"Returns the total number of wired devices with PoE issues based on the provided filters. The results can be filtered by sites.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_post_wired_device_health_poe"},"operationId":"getWiredDeviceHealthPoe","requestBody":{"description":"List of site IDs to filter the wired devices","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqWiredDeviceHealthPoeRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqWiredDeviceHealthPoeResponse"}}}}},"security":[{"Bearer":[]}]}},"/dashboard/wired/device-health/memory-usage-issues":{"post":{"tags":["Dashboard Wired Device Health"],"summary":"Wired Device Health Memory Usage Issues","description":"Returns the total number of wired devices with memory issues based on the provided filters. The results can be filtered by sites.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_post_wired_device_health_mem"},"operationId":"getWiredDeviceHealthMem","requestBody":{"description":"List of site IDs to filter the wired devices","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqWiredDeviceHealthMemRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqWiredDeviceHealthMemResponse"}}}}},"security":[{"Bearer":[]}]}},"/dashboard/wired/device-health/grid":{"post":{"tags":["Dashboard Wired Device Health"],"summary":"Wired Device Health Grid","description":"Returns the wired device health grid based on the provided filters. The results can be filtered by sites.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_post_wired_device_health_grid"},"operationId":"getWiredDeviceHealthGrid","parameters":[{"name":"page","in":"query","description":"Page number, min = 1","required":false,"schema":{"type":"integer","format":"int32","default":1,"minimum":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 100","required":false,"schema":{"type":"integer","format":"int32","default":10,"maximum":100,"minimum":1}},{"name":"keyword","in":"query","description":"The keyword to search","required":false,"schema":{"type":"string"}},{"name":"sortField","in":"query","description":"The sort field","required":false,"schema":{"$ref":"#/components/schemas/XiqWiredDeviceHealthSortField","default":"UNSPECIFIED"}},{"name":"sortOrder","in":"query","description":"The sort order (descending by default)","required":false,"schema":{"$ref":"#/components/schemas/XiqSortOrder","default":"DESC"}}],"requestBody":{"description":"Request body for the Wired Device Health Grid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqWiredDeviceHealthGridRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqWiredDeviceHealthGridResponse"}}}}},"security":[{"Bearer":[]}]}},"/dashboard/wired/device-health/fan-status":{"post":{"tags":["Dashboard Wired Device Health"],"summary":"Wired Device Health Fan Status","description":"Returns the fan status of the device","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_post_wired_device_health_fan_status"},"operationId":"getWiredDeviceHealthFanStatus","parameters":[{"name":"deviceId","in":"query","description":"The ID of the device","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqWiredDeviceHealthFanStatusResponse"}}}}},"security":[{"Bearer":[]}]}},"/dashboard/wired/device-health/fan-issues":{"post":{"tags":["Dashboard Wired Device Health"],"summary":"Wired Device Health Fan Issues","description":"Returns the total number of wired devices with fan issues based on the provided filters. The results can be filtered by sites.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_post_wired_device_health_fan"},"operationId":"getWiredDeviceHealthFan","requestBody":{"description":"List of site IDs to filter the wired devices","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqWiredDeviceHealthFanRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqWiredDeviceHealthFanResponse"}}}}},"security":[{"Bearer":[]}]}},"/dashboard/wired/device-health/cpu-usage-issues":{"post":{"tags":["Dashboard Wired Device Health"],"summary":"Wired Device Health CPU Usage Issues","description":"Returns the total number of wired devices with CPU issues based on the provided filters. The results can be filtered by sites.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_post_wired_device_health_cpu"},"operationId":"getWiredDeviceHealthCpu","requestBody":{"description":"List of site IDs to filter the wired devices","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqWiredDeviceHealthCpuRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqWiredDeviceHealthCpuResponse"}}}}},"security":[{"Bearer":[]}]}},"/dashboard/wired/client-health/traffic-anomalies":{"post":{"tags":["Dashboard Wired Client Health"],"summary":"Wired clients count with traffic anomalies","description":"Returns the wired clients with traffic anomalies based on the provided filters. You can filter the results by sites.","operationId":"getTrafficAnomalies","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqWiredClientHealthTrafficAnomaliesRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqWiredClientHealthTrafficAnomaliesResponse"}}}}},"security":[{"Bearer":[]}]}},"/dashboard/wired/client-health/port-errors":{"post":{"tags":["Dashboard Wired Client Health"],"summary":"Wired clients count with port errors","description":"Returns the wired clients with port errors based on the provided filters. You can filter the results by sites.","operationId":"getPortErrors","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqWiredClientHealthPortErrorsRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqWiredClientHealthPortErrorsResponse"}}}}},"security":[{"Bearer":[]}]}},"/dashboard/wired/client-health/port-congestion":{"post":{"tags":["Dashboard Wired Client Health"],"summary":"Wired clients count with port congestion issues","description":"Returns the wired clients with port congestion issues based on the provided filters. You can filter the results by sites.","operationId":"getPortCongestion","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqWiredClientHealthPortCongestionRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqWiredClientHealthPortCongestionResponse"}}}}},"security":[{"Bearer":[]}]}},"/dashboard/wired/client-health/ip-connectivity-issues":{"post":{"tags":["Dashboard Wired Client Health"],"summary":"Wired clients count with IP connectivity issues","description":"Returns the wired clients with IP connectivity issues based on the provided filters. You can filter the results by sites.","operationId":"getIpConnectivityIssues","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqWiredClientHealthIpConnectivityIssuesRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqWiredClientHealthIpConnectivityIssuesResponse"}}}}},"security":[{"Bearer":[]}]}},"/dashboard/wired/client-health/grid":{"post":{"tags":["Dashboard Wired Client Health"],"summary":"Wired client health grid","description":"Returns the client health grid of wired devices based on the provided filters. You can filter the results by sites.","operationId":"getWiredClientHealthGrid","parameters":[{"name":"page","in":"query","description":"Page number, min = 1","required":false,"schema":{"type":"integer","format":"int32","default":1,"minimum":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 100","required":false,"schema":{"type":"integer","format":"int32","default":10,"maximum":100,"minimum":1}},{"name":"keyword","in":"query","description":"The keyword to search ","required":false,"schema":{"type":"string"}},{"name":"sortField","in":"query","description":"Sort Field","required":false,"schema":{"$ref":"#/components/schemas/XiqWiredClientHealthSortField","default":"UNSPECIFIED"}},{"name":"sortOrder","in":"query","description":"Sort Order","required":false,"schema":{"$ref":"#/components/schemas/XiqSortOrder","default":"DESC"}}],"requestBody":{"description":"Request body for Wired Client Health Grid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqWiredClientHealthGridRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqWiredClientHealthGridResponse"}}}}},"security":[{"Bearer":[]}]}},"/dashboard/usage-capacity":{"post":{"tags":["Dashboard"],"summary":"Usage & capacity statistics","description":"Returns the count of wired, wireless and total usage & capacity issues based on the provided filters. You can filter the results by sites.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_usage_capacity_dashboard"},"operationId":"getUsageAndCapacityDiagnostics","parameters":[{"name":"includeUnassigned","in":"query","description":"Whether to include unassigned devices","required":false,"schema":{"type":"boolean","default":false}}],"requestBody":{"description":"Request body for Usage and Capacity Diagnostics","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqDashboardFilter"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqUsageAndCapacityDashboard"}}}}},"security":[{"Bearer":[]}]}},"/dashboard/sites-with-issues":{"post":{"tags":["Dashboard"],"summary":"Sites with issues","description":"Returns the site names along with alerts, usage and capacity, assets, client health, and device health based on the provided filters. You can filter the results by sites.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_site_with_diagnostics_dashboard"},"operationId":"getSitesWithIssuesDiagnostics","parameters":[{"name":"page","in":"query","description":"Page number, min = 1","required":false,"schema":{"type":"integer","format":"int32","default":1,"minimum":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 100","required":false,"schema":{"type":"integer","format":"int32","default":10,"maximum":100,"minimum":1}},{"name":"sortField","in":"query","description":"Sort Field","required":false,"schema":{"type":"string","enum":["ALERTS","STATUS","DEVICE_HEALTH","CLIENT_HEALTH","USAGE_CAPACITY","SITE_NAME"]}},{"name":"sortOrder","in":"query","description":"Sort Order","required":false,"schema":{"$ref":"#/components/schemas/XiqSortOrder"}},{"name":"keyword","in":"query","description":"The Site Name Filter","required":false,"schema":{"type":"string"}},{"name":"includeUnassigned","in":"query","description":"Whether to include unassigned devices","required":false,"schema":{"type":"boolean","default":false}},{"name":"alertsTimeRange","in":"query","description":"Alerts Time Range in days (defaults to 1 day)","required":false,"schema":{"type":"integer","format":"int32","default":1,"minimum":0}}],"requestBody":{"description":"Request body for Sites with Issues Diagnostics","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqDashboardFilter"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqSiteDashboardResponse"}}}}},"security":[{"Bearer":[]}]}},"/dashboard/export":{"post":{"tags":["Dashboard"],"summary":"Export all dashboard data to CSV","description":"Export all dashboard data to a CSV file.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_export_dashboard_data_to_csv"},"operationId":"exportToCsv_4","parameters":[{"name":"sortField","in":"query","description":"Sort Field","required":false,"schema":{"type":"string","enum":["ALERTS","STATUS","DEVICE_HEALTH","CLIENT_HEALTH","USAGE_CAPACITY","SITE_NAME"]}},{"name":"sortOrder","in":"query","description":"Sort Order","required":false,"schema":{"$ref":"#/components/schemas/XiqSortOrder"}},{"name":"keyword","in":"query","description":"The Site Name Filter","required":false,"schema":{"type":"string"}},{"name":"includeUnassigned","in":"query","description":"Whether to include unassigned devices","required":false,"schema":{"type":"boolean","default":false}},{"name":"alertsTimeRange","in":"query","description":"Alerts Time Range in days (defaults to 1 day)","required":false,"schema":{"type":"integer","format":"int32","default":1,"minimum":0}}],"requestBody":{"description":"Request body for Sites with Issues Diagnostics","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqDashboardFilter"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqMetricReport"}}}}},"security":[{"Bearer":[]}]}},"/dashboard/devices":{"post":{"tags":["Dashboard"],"summary":"Device health statistics","description":"Returns the count of total devices, total unhealthy devices, wired unhealthy devices, and wireless unhealthy devices based on the provided filters. You can filter the results by sites.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_devices_health_dashboard"},"operationId":"getDeviceHealthDiagnostics","parameters":[{"name":"includeUnassigned","in":"query","description":"Whether to include unassigned devices","required":false,"schema":{"type":"boolean","default":false}}],"requestBody":{"description":"Request body for Device Health Diagnostics","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqDashboardFilter"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqDeviceHealthDashboard"}}}}},"security":[{"Bearer":[]}]}},"/dashboard/clients":{"post":{"tags":["Dashboard"],"summary":"Client health statistics","description":"Returns the count of total clients, total unhealthy clients, wired unhealthy clients, and wireless unhealthy clients based on the provided filters.You can filter the results by sites.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_client_health_dashboard"},"operationId":"getClientHealthDiagnostics","parameters":[{"name":"includeUnassigned","in":"query","description":"Whether to include unassigned devices","required":false,"schema":{"type":"boolean","default":false}}],"requestBody":{"description":"Request body for Client Health Diagnostics","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqDashboardFilter"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqClientHealthDashboard"}}}}},"security":[{"Bearer":[]}]}},"/dashboard/assets":{"post":{"tags":["Dashboard"],"summary":"Asset statistics","description":"Returns the count of total devices, total offline devices, wired offline devices, and wireless offline devices based on the provided filters. You can filter the results by sites.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_asset_dashboard_onlineoffline"},"operationId":"getAssetDiagnostics","parameters":[{"name":"includeUnassigned","in":"query","description":"Whether to include unassigned devices","required":false,"schema":{"type":"boolean","default":false}}],"requestBody":{"description":"Request body for Asset Diagnostics","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqDashboardFilter"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqAssetDashboard"}}}}},"security":[{"Bearer":[]}]}},"/dashboard/alerts":{"post":{"tags":["Dashboard"],"summary":"Alert statistics","description":"Returns the count of different types of alerts (critical, warning, information, and total unacknowledged) based on the provided filters. You can filter the results by sites.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_alert_dashboard"},"operationId":"getAlertDiagnostics","parameters":[{"name":"includeUnassigned","in":"query","description":"Whether to include unassigned devices","required":false,"schema":{"type":"boolean","default":false}},{"name":"alertsTimeRange","in":"query","description":"Alerts Time Range in days (defaults to 1 day)","required":false,"schema":{"type":"integer","format":"int32","default":1,"minimum":0}}],"requestBody":{"description":"Request body for Alert Diagnostics","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqDashboardFilter"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqAlertDashboard"}}}}},"security":[{"Bearer":[]}]}},"/d360/wireless/surrounding-aps":{"post":{"tags":["D360"],"summary":"Get a list of SurroundingAps","description":"Returns a list of SurroundingAps","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_surrounding_aps"},"operationId":"getSurroundingAps","parameters":[{"name":"page","in":"query","description":"Page number, min = 1","required":false,"schema":{"type":"integer","format":"int32","default":1,"minimum":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 100","required":false,"schema":{"type":"integer","format":"int32","default":10,"maximum":100,"minimum":1}},{"name":"deviceId","in":"query","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"startTime","in":"query","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"endTime","in":"query","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"selectedTime","in":"query","required":false,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"description":"Request body for Surrounding Aps","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqD360Filter"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqSurroundingAps"}}}}},"security":[{"Bearer":[]}]}},"/d360/client/grid":{"post":{"tags":["D360"],"summary":"Get Client Grid","description":"List of Client","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_client_grid"},"operationId":"getClientStatsGrid","parameters":[{"name":"page","in":"query","description":"Page number, min = 1","required":false,"schema":{"type":"integer","format":"int32","default":1,"minimum":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 100","required":false,"schema":{"type":"integer","format":"int32","default":10,"maximum":100,"minimum":1}},{"name":"keyword","in":"query","description":"The search string","required":false,"schema":{"type":"string"}},{"name":"deviceId","in":"query","description":"The unique identifier of the wireless device","required":true,"schema":{"type":"integer","format":"int64"},"example":12345},{"name":"startTime","in":"query","description":"Start time in milliseconds (epoch time)","required":true,"schema":{"type":"integer","format":"int64"},"example":1708243200000},{"name":"endTime","in":"query","description":"End time in milliseconds (epoch time)","required":true,"schema":{"type":"integer","format":"int64"},"example":1708246800000},{"name":"clientStatus","in":"query","required":false,"schema":{"type":"array","items":{"type":"string","enum":["TOTAL","POOR_HEALTH","UNIQUE"]}}},{"name":"sortField","in":"query","required":false,"schema":{"type":"string","enum":["CONNECTION_STATUS","CLIENT_HOSTNAME","SNR","RSSI","CHANNEL_UTILIZATION_SCORE","ASSOCIATION_ISSUE","AUTHENTICATION_ISSUE","IP_ADDRESS_ISSUE","ROAMING_ISSUE","IPV4","CONNECTED_DEVICE_MAC","SSID","VLAN","LAST_SESSION_START_TIME","OPERATING_SYSTEM","CLIENT_MAC","USERNAME","AUTHENTICATION","USER_NAME","ALIAS","IPV6","CLIENT_TYPE"]}},{"name":"sortOrder","in":"query","required":false,"schema":{"$ref":"#/components/schemas/XiqSortOrder"}},{"name":"connectionStatus","in":"query","required":false,"schema":{"type":"string","enum":["CONNECTED","DISCONNECTED"]}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqD360ClientGridFilterRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqClientStatsGridRow"}}}}},"security":[{"Bearer":[]}]}},"/d360/client/graph":{"post":{"tags":["D360"],"summary":"List a list of connected clients for Device 360 API","description":"List a list of connected clients for Device 360 Api","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_connected_clients_for_graphing_api"},"operationId":"getClientGraph","parameters":[{"name":"deviceId","in":"query","description":"The 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":"filter","in":"query","description":"The filter type","required":true,"schema":{"type":"array","items":{"type":"string","enum":["CONNECTED_CLIENTS","UNIQUE_CLIENTS","POOR_HEALTH_CLIENTS","ALL_CLIENTS"]}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/XiqClientGraphData"}}}}}},"security":[{"Bearer":[]}]}},"/credential-distribution-groups":{"get":{"tags":["Administration"],"summary":"List Credential Distribution Groups","description":"List a page of Credential Distribution Groups.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_list_credential_distribution_groups"},"operationId":"listCredentialDistributionGroups","parameters":[{"name":"page","in":"query","description":"Page number, min = 1","required":false,"schema":{"type":"integer","format":"int32","default":1,"minimum":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 500","required":false,"schema":{"type":"integer","format":"int32","default":10,"maximum":500,"minimum":1}},{"name":"order","in":"query","description":"The sort order (descending by default)","required":false,"schema":{"$ref":"#/components/schemas/XiqSortOrder","default":"DESC"}},{"name":"sortField","in":"query","description":"The sort order (descending by default)","required":false,"schema":{"type":"string","default":"GROUP_NAME","enum":["GROUP_NAME","USER_ALLOWED"]}},{"name":"keyword","in":"query","description":"The keyword to search - Group Name, Member of, User Detail or User Group","required":false,"schema":{"type":"string"}},{"name":"userGroupIds","in":"query","description":"The User Group ID to filter","required":false,"schema":{"type":"array","items":{"type":"integer","format":"int64"}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqCredentialDistributionGroupUpdate"}}}}},"security":[{"Bearer":[]}]},"post":{"tags":["Administration"],"summary":"Create a Credential Distribution Group","description":"Create a new Credential Distribution Group","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_create_credential_distribution_groups"},"operationId":"createCredentialDistributionGroup","requestBody":{"description":"The payload to create a new Credential Distribution Group.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqCredentialDistributionGroupCreateRequest"}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqCredentialDistributionGroup"}}}}},"security":[{"Bearer":[]}]},"delete":{"tags":["Administration"],"summary":"Delete Credential Distribution Group by ID","description":"Delete an existing Credential Distribution Group by the specified ID.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_delete_credential_distribution_groups"},"operationId":"deleteCredentialDistributionGroup","parameters":[{"name":"ids","in":"query","description":"The Credential Distribution Group IDs","required":true,"schema":{"type":"array","items":{"type":"integer","format":"int64"}}}],"responses":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/copilot/anomalies/exclude-vlans":{"post":{"tags":["Copilot - Anomalies"],"operationId":"updateMissingVlanExcludedVlanList","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqMissingVlanExcludedVlanDetailsListRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqUpdateMissingVlanExcludedVlanResponse"}}}}},"security":[{"Bearer":[]}]}},"/copilot/anomalies/exclude-vlans-csv":{"post":{"tags":["Copilot - Anomalies"],"operationId":"updateMissingVlanExcludedVlanCsv","parameters":[{"name":"action_type","in":"query","required":true,"schema":{"$ref":"#/components/schemas/XiqExcludedVlanActionType"}},{"name":"dismiss","in":"query","required":true,"schema":{"type":"boolean"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"csv_file":{"type":"string","format":"binary"}},"required":["csv_file"]}},"application/json":{"schema":{"type":"object","properties":{"csv_file":{"type":"string","format":"binary"}},"required":["csv_file"]}},"text/csv":{"schema":{"type":"object","properties":{"csv_file":{"type":"string","format":"binary"}},"required":["csv_file"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqUpdateMissingVlanExcludedVlanResponse"}}}}},"security":[{"Bearer":[]}]}},"/clients/disconnect":{"post":{"tags":["Client"],"summary":"Disconnect the clients","description":"Disconnect multiple clients by macAddress.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_disconnect_clients_by_macAddress_for_multiple_client"},"operationId":"disconnectClients","requestBody":{"description":"A list of client mac addresses to disconnect","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqDisconnectClientsByMacRequest"}}},"required":true},"responses":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/client-monitor-profiles":{"get":{"tags":["Configuration - Policy"],"summary":"List client monitor profiles","description":"List a page of client monitor profiles.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_list_client_monitor_profiles"},"operationId":"listClientMonitorProfiles","parameters":[{"name":"page","in":"query","description":"Page number, min = 1","required":false,"schema":{"type":"integer","format":"int32","default":1,"minimum":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 100","required":false,"schema":{"type":"integer","format":"int32","default":10,"maximum":100,"minimum":1}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqClientMonitorProfile"}}}}},"security":[{"Bearer":[]}]},"post":{"tags":["Configuration - Policy"],"summary":"Create a client monitor profile","description":"Create a new client monitor profile.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_create_client_monitor_profile"},"operationId":"createClientMonitorProfile","requestBody":{"description":"The request body to create new client monitor profile.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqClientMonitorProfileRequest"}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqClientMonitorProfile"}}}}},"security":[{"Bearer":[]}]}},"/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_classification_rules"},"operationId":"listClassificationRules","parameters":[{"name":"page","in":"query","description":"Page number, min = 1","required":false,"schema":{"type":"integer","format":"int32","default":1,"minimum":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 100","required":false,"schema":{"type":"integer","format":"int32","default":10,"maximum":100,"minimum":1}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqClassificationRule"}}}}},"security":[{"Bearer":[]}]},"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"},"operationId":"createClassificationRule","requestBody":{"description":"The payload to create a new classification rule","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqCreateClassificationRuleRequest"}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqClassificationRule"}}}}},"security":[{"Bearer":[]}]}},"/certificates/import":{"post":{"tags":["Configuration - Certificate"],"summary":"Import Certificate","description":"Import a new Certificate.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_import_certificate"},"operationId":"importCertificate","parameters":[{"name":"name","in":"query","required":true,"schema":{"type":"string"}},{"name":"certType","in":"query","required":false,"schema":{"$ref":"#/components/schemas/XiqCertificateType"}},{"name":"enableConvertPfx","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"pfxPassword","in":"query","required":false,"schema":{"type":"string"}},{"name":"enableConvertDer","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"convertOptionType","in":"query","required":false,"schema":{"$ref":"#/components/schemas/XiqConvertOptionType"}},{"name":"derPassword","in":"query","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"certificate":{"type":"string","format":"binary"}},"required":["certificate"]}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqCertificate"}}}}},"security":[{"Bearer":[]}]}},"/certificate-bundles":{"get":{"tags":["Configuration - Certificate"],"summary":"List Certificate Bundles","description":"List a page of Certificate Bundles.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_list_the_certificate_bundles"},"operationId":"listCertificateBundles","parameters":[{"name":"page","in":"query","description":"Page number, min = 1","required":false,"schema":{"type":"integer","format":"int32","default":1,"minimum":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 100","required":false,"schema":{"type":"integer","format":"int32","default":10,"maximum":100,"minimum":1}},{"name":"certType","in":"query","description":"The certificate bundle type","required":false,"schema":{"type":"string","enum":["TRUST_POINT","CA"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqCertificateBundle"}}}}},"security":[{"Bearer":[]}]},"post":{"tags":["Configuration - Certificate"],"summary":"Create a Certificate Bundle","description":"Create a new Certificate Bundle.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_create_certificate_bundle"},"operationId":"createCertificateBundle","requestBody":{"description":"The request body to create new Certificate Bundle.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqCreateCertificateBundleRequest"}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqCertificateBundle"}}}}},"security":[{"Bearer":[]}]}},"/ccgs":{"get":{"tags":["Configuration - Policy"],"summary":"[LRO] List clould config groups","description":"List a papge of cloud config groups.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_list_cloud_config_groups"},"operationId":"listCloudConfigGroups","parameters":[{"name":"page","in":"query","description":"Page number, min = 1","required":false,"schema":{"type":"integer","format":"int32","default":1,"minimum":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 100","required":false,"schema":{"type":"integer","format":"int32","default":10,"maximum":100,"minimum":1}},{"name":"sortField","in":"query","description":"The Sort field (Name by default)","required":false,"schema":{"$ref":"#/components/schemas/XiqCloudConfigGroupSortField","default":"NAME"}},{"name":"order","in":"query","description":"The Sort order (ascending by default)","required":false,"schema":{"$ref":"#/components/schemas/XiqSortOrder","default":"ASC"}},{"name":"async","in":"query","description":"Whether to enable async mode","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqCloudConfigGroup"}}}}},"security":[{"Bearer":[]}]},"post":{"tags":["Configuration - Policy"],"summary":"Create new cloud config group","description":"Create a new cloud config group.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_create_cloud_config_group"},"operationId":"createCloudConfigGroup","requestBody":{"description":"Create new cloud config group request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqCreateCloudConfigGroupRequest"}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqCloudConfigGroup"}}}}},"security":[{"Bearer":[]}]}},"/backup/history/:restore":{"post":{"tags":["Account"],"summary":"Backup History Restore","description":"Restore Backup History in ExtremeCloud IQ.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_backup_history_restore"},"operationId":"restoreBackup","parameters":[{"name":"backupFile","in":"query","description":"The backup file that needs to be restored.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqCheckPermissionResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"403":{"description":"Access Denied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}}},"security":[{"Bearer":[]}]}},"/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"]}},"Generate API token with per-hour rate limit":{"summary":"Generate API token with per-hour rate limit","description":"Generate API token with custom per-hour rate limit","value":{"description":"Token with per-hour rate limit","expire_time":1604737598,"permissions":["account:r"],"rate_limit":{"hour":5000}}},"Generate API token with per-hour and per-second rate limits":{"summary":"Generate API token with per-hour and per-second (burst) rate limits","description":"Generate API token with custom per-hour and per-second (burst) rate limits","value":{"description":"Token with per-hour and per-second rate limits","expire_time":1604737598,"permissions":["account:r"],"rate_limit":{"hour":5000,"second":100}}}}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqGenerateApiTokenResponse"}}}}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK"}}}},"/aps/afc/update":{"post":{"tags":["afc-endpoint"],"summary":"Manual Spectrum request for device(s)","description":"Manual Spectrum request for device(s).","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_manual_spectrum_aps"},"operationId":"postApsManualAfcSpectrum","requestBody":{"description":"AFC site schedule request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqAfcApManualSpectrum"}}},"required":true},"responses":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/aps/afc/query/":{"get":{"tags":["afc-endpoint"],"summary":"Get AFC APs Summary Data","description":"Get AFC APs Summary Data","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_afc_aps_summary_data"},"operationId":"getApsAfcSummaryInfo","parameters":[{"name":"ownerId","in":"query","description":"Owner Id","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqAfcApsInfoElement"}}}}},"security":[{"Bearer":[]}]},"post":{"tags":["afc-endpoint"],"summary":"Get AFC APs Summary Data","description":"Get AFC APs Summary Data","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_afc_aps_summary_data_with_filter"},"operationId":"getApsAfcSummaryInfoWithFilter","parameters":[{"name":"ownerId","in":"query","description":"Owner Id","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"description":"AFC APs filter criteria","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqAfcApsFilterCriteria"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqAfcApsInfoElement"}}}}},"security":[{"Bearer":[]}]}},"/applications/usage/summary":{"post":{"tags":["Application"],"summary":"List the application usage summary","description":"List a page of application usage summary by filter.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_list_the_application_usage_summary"},"operationId":"listApplicationUsageSummary","parameters":[{"name":"page","in":"query","description":"Page number, min = 1","required":false,"schema":{"type":"integer","format":"int32","default":1,"minimum":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 500","required":false,"schema":{"type":"integer","format":"int32","default":10,"maximum":500,"minimum":1}},{"name":"sortField","in":"query","description":"The sort field","required":false,"schema":{"$ref":"#/components/schemas/XiqAppUsageSummarySortField"}},{"name":"order","in":"query","description":"The sort order (ascending by default)","required":false,"schema":{"$ref":"#/components/schemas/XiqSortOrder","default":"ASC"}},{"name":"name","in":"query","description":"Application or Category Name","required":false,"schema":{"type":"string"}},{"name":"async","in":"query","description":"Whether to enable async mode","required":false,"schema":{"type":"boolean","default":false}}],"requestBody":{"description":"Request body for Application Usage Summary Filter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqAppUsageSummaryFilter"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqAppUsageSummary"}}}}},"security":[{"Bearer":[]}]}},"/applications/usage/summary/export":{"post":{"tags":["Application"],"summary":"Export the application usage summary","description":"Export of application usage summary by filter.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_export_the_application_usage_summary"},"operationId":"exportApplicationUsageSummary","parameters":[{"name":"sortField","in":"query","description":"The sort field","required":false,"schema":{"$ref":"#/components/schemas/XiqAppUsageSummarySortField"}},{"name":"order","in":"query","description":"The sort order (ascending by default)","required":false,"schema":{"$ref":"#/components/schemas/XiqSortOrder","default":"ASC"}},{"name":"name","in":"query","description":"Application or Category Name","required":false,"schema":{"type":"string"}},{"name":"async","in":"query","description":"Whether to enable async mode","required":false,"schema":{"type":"boolean","default":false}}],"requestBody":{"description":"Request body for Application Usage Summary Filter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqAppUsageSummaryFilter"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqAppUsageSummaryExport"}}}}},"security":[{"Bearer":[]}]}},"/ap/spectrum/":{"post":{"tags":["afc-endpoint"],"operationId":"getAfcSpectrumPerAp","parameters":[{"name":"IsEmptyList","in":"query","required":true,"schema":{"type":"boolean"}}],"requestBody":{"description":"get afc spectrum per AP request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqGetAfcSpectrumForApRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/XiqAfcAvailableSpectrum"}}}}}},"security":[{"Bearer":[]}]}},"/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","default":"TIMESTAMP"}},{"name":"order","in":"query","description":"The sort order (ascending by default)","required":false,"schema":{"$ref":"#/components/schemas/XiqSortOrder","default":"ASC"}},{"name":"async","in":"query","description":"Whether to enable async mode","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqAlertReport"}}}}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/XiqAlert"}}}}}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/XiqAlertWebhookSubscription"}}}}}},"security":[{"Bearer":[]}]},"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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqAlertWebhookSubscription"}}}}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqDeleteBulkAlertSubscriptionWebhookResponse"}}}}},"security":[{"Bearer":[]}]}},"/alert-subscriptions/servicenow":{"get":{"tags":["Alert"],"summary":"List ServiceNow subscriptions","description":"List all ServiceNow subscriptions.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_list_alert_servicenow_subscriptions"},"operationId":"listServiceNowSubscriptions","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/XiqAlertServiceNowSubscription"}}}}}},"security":[{"Bearer":[]}]},"post":{"tags":["Alert"],"summary":"Create ServiceNow subscription","description":"Create ServiceNow subscription.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_create_an_alert_servicenow_subscription"},"operationId":"createServiceNowSubscription","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqCreateAlertServiceNowSubscriptionRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqAlertServiceNowSubscription"}}}}},"security":[{"Bearer":[]}]}},"/alert-subscriptions/servicenow/:delete":{"post":{"tags":["Alert"],"summary":"Delete alert ServiceNow subscription in bulk","description":"Delete alert ServiceNow subscription by a list of provided IDs.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_bulk_delete_alert_servicenow_subscriptions"},"operationId":"deleteBulkAlertSubscriptionServiceNow","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"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqDeleteBulkAlertSubscriptionServiceNowResponse"}}}}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/XiqAlertEmailSubscription"}}}}}},"security":[{"Bearer":[]}]},"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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqAlertEmailSubscription"}}}}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqDeleteBulkAlertSubscriptionEmailResponse"}}}}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqListAlertPolicies"}}}}},"security":[{"Bearer":[]}]},"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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqAlertPolicy"}}}}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqAlertRule"}}}}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqAlertRule"}}}}},"security":[{"Bearer":[]}]}},"/airrm/ap/radioInfo/":{"post":{"tags":["airrm-endpoint"],"summary":"Get Devices Radio Information","description":"Get radio information for devices by serial number or AIRRM ID","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_devices_radio_info"},"operationId":"getDevicesRadioInfo","requestBody":{"description":"Get radio information for devices by serial number or AIRRM ID","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqDeviceRadioInfoRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XIQAirrmGetDevicesRadioInfoResponse"}}}}},"security":[{"Bearer":[]}]}},"/afc/rm-devices-page":{"post":{"tags":["afc-endpoint"],"summary":"[LRO] RM AFC Device Page","description":"AFC Device List with pagination.","operationId":"rmDeviceList_1","parameters":[{"name":"page","in":"query","description":"Page number, min = 1","required":false,"schema":{"type":"integer","format":"int32","default":1,"minimum":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 100","required":false,"schema":{"type":"integer","format":"int32","default":10,"maximum":100,"minimum":1}},{"name":"keyword","in":"query","description":"The keyword to search","required":false,"schema":{"type":"string"}},{"name":"sortField","in":"query","description":"The sort field","required":false,"schema":{"$ref":"#/components/schemas/XiqRmDeviceSortField"}},{"name":"order","in":"query","description":"The sort order (ascending by default)","required":false,"schema":{"$ref":"#/components/schemas/XiqSortOrder","default":"ASC"}},{"name":"includeUnassigned","in":"query","description":"Whether to include unassigned devices","required":false,"schema":{"type":"boolean","default":false}}],"requestBody":{"description":"The site IDs to filter devices","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqRmAfcDeviceListRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqRmAfcDevice"}}}}},"security":[{"Bearer":[]}]}},"/afc/recalculateSite/{id}":{"post":{"tags":["afc-endpoint"],"operationId":"recalculateSite","parameters":[{"name":"id","in":"path","description":"The device id for the site","required":true,"schema":{"type":"integer","format":"int64"},"example":348802884142797}],"responses":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/afc/mobileapp/apcandidates":{"post":{"tags":["afc-endpoint"],"summary":"List of AP candidates that may be used as anchors","description":"List of AP candidates that may be used as anchors","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_afc_mobileapp_candidates"},"operationId":"getMobileappApcandidates","requestBody":{"description":"Get mobile app ap candidates per BSSIDs request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqAfcMobileappScanInfo"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqMobileappAnchorCandidatesResponse"}}}}},"security":[{"Bearer":[]}]}},"/afc/filter-metadata":{"post":{"tags":["afc-endpoint"],"summary":"RM AFC Device Metadata Page","description":"AFC Device metadata api.","operationId":"getAfcGridFilterMetadata","parameters":[{"name":"includeUnassigned","in":"query","description":"Whether to include unassigned devices","required":false,"schema":{"type":"boolean","default":false}}],"requestBody":{"description":"Request body for Afc Health Grid Filter Metadata","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqDashboardFilter"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqRmAfcGridFilterMetadata"}}}}},"security":[{"Bearer":[]}]}},"/afc/export":{"post":{"tags":["afc-endpoint"],"summary":"[LRO] RM AFC Device export","description":"AFC Device List export.","operationId":"rmDeviceListExport","parameters":[{"name":"page","in":"query","description":"Page number, min = 1","required":false,"schema":{"type":"integer","format":"int32","default":1,"minimum":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 100","required":false,"schema":{"type":"integer","format":"int32","default":10,"maximum":100,"minimum":1}},{"name":"keyword","in":"query","description":"The keyword to search","required":false,"schema":{"type":"string"}},{"name":"sortField","in":"query","description":"The sort field","required":false,"schema":{"$ref":"#/components/schemas/XiqRmDeviceSortField"}},{"name":"order","in":"query","description":"The sort order (ascending by default)","required":false,"schema":{"$ref":"#/components/schemas/XiqSortOrder","default":"ASC"}},{"name":"timezoneOffset","in":"query","description":"timezone offset","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"includeUnassigned","in":"query","description":"Whether to include unassigned devices","required":false,"schema":{"type":"boolean","default":false}}],"requestBody":{"description":"The site IDs to filter devices","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqRmAfcDeviceListRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqAfcMetricReport"}}}}},"security":[{"Bearer":[]}]}},"/afc/aps/reportFtm":{"post":{"tags":["afc-endpoint"],"operationId":"requestAfcFtmData","requestBody":{"description":"list of APs to request FTM data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqReportFtmDataRequest"}}},"required":true},"responses":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/acct-api-token":{"get":{"tags":["Administration"],"summary":"List API Access tokens","description":"List a page of API Access tokens.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_list_api_access_tokens"},"operationId":"listApiAccessTokens","parameters":[{"name":"page","in":"query","description":"Page number, min = 1","required":false,"schema":{"type":"integer","format":"int32","default":1,"minimum":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 100","required":false,"schema":{"type":"integer","format":"int32","default":10,"maximum":100,"minimum":1}},{"name":"order","in":"query","description":"The sort order (descending by default)","required":false,"schema":{"$ref":"#/components/schemas/XiqSortOrder","default":"DESC"}},{"name":"keyword","in":"query","description":"The keyword - application name or grantor","required":false,"schema":{"type":"string"}},{"name":"sortField","in":"query","description":"The sort field","required":false,"schema":{"$ref":"#/components/schemas/XiqApiAccessTokenSortField"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqApiAccessToken"}}}}},"security":[{"Bearer":[]}]},"post":{"tags":["Administration"],"summary":"Create an API Access token","description":"Create a new API access token","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_create_api_access_tokens"},"operationId":"createApiAccessToken","parameters":[{"name":"clientId","in":"query","description":"The client ID","required":true,"schema":{"type":"string"}},{"name":"tokenExpireInDay","in":"query","description":"The expire time in days","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqCreateApiAccessTokenResponse"}}}}},"security":[{"Bearer":[]}]}},"/account/viq/import":{"post":{"tags":["Account"],"summary":"[LRO] Import VIQ data","description":"This is used import VIQ details from a file","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_viq_import"},"operationId":"importViq","parameters":[{"name":"timeoutInSeconds","in":"query","description":"The maximum import duration","required":false,"schema":{"type":"integer","format":"int64","default":1800}},{"name":"resendUserNotifications","in":"query","description":"Resend Cloud PPSK/RADIUS password through email/SMS","required":false,"schema":{"type":"boolean","default":false}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"importFile":{"type":"string","format":"binary","description":"Select a file to import. Accepted formats are: .tar.gz and .tar"}},"required":["importFile"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqViqImportResponse"}}}}},"security":[{"Bearer":[]}]}},"/account/viq/export":{"post":{"tags":["Account"],"summary":"[LRO] Export VIQ data","description":"This is used to Export VIQ data. ","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_viq_export"},"operationId":"exportViq","parameters":[{"name":"timeoutInSeconds","in":"query","description":"The maximum export duration","required":false,"schema":{"type":"integer","format":"int64","default":1800}},{"name":"excludeDeviceFirmware","in":"query","description":"Whether exclude device firmwares from VIQ export file or not","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqViqExportResponse"}}}}},"security":[{"Bearer":[]}]}},"/account/viq/:reset":{"post":{"tags":["Account"],"summary":"Reset VIQ","description":"Reset VIQ in ExtremeCloud IQ.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_viq_reset"},"operationId":"resetViq","responses":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqLoginResponse"}}}}},"security":[{"Bearer":[]}]}},"/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"},"operationId":"getVlanProfile","parameters":[{"name":"id","in":"path","description":"The VLAN profile ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqVlanProfile"}}}}},"security":[{"Bearer":[]}]},"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"},"operationId":"deleteVlanProfile","parameters":[{"name":"id","in":"path","description":"The VLAN profile ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]},"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"},"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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqVlanProfile"}}}}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqUser"}}}}},"security":[{"Bearer":[]}]},"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":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]},"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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqUser"}}}}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqExternalUser"}}}}},"security":[{"Bearer":[]}]},"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":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]},"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":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/ng-reports/scheduled/{reportScheduleId}":{"patch":{"tags":["NG Reports (Scheduled)"],"summary":"Enable or Disable Report Schedule","description":"Enables or disables a report schedule based on the provided flag.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_enable_or_disable_report_schedule"},"operationId":"enableDisableReportSchedule","parameters":[{"name":"reportScheduleId","in":"path","description":"The report schedule ID","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"enableSchedule","in":"query","description":"Flag to enable or disable the report schedule","required":true,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/acct-api-token/{id}":{"delete":{"tags":["Administration"],"summary":"Delete API Access token by ID","description":"Delete an existing API Access token by the specified ID.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#delete_acct_api_access_token_by_id"},"operationId":"deleteApiAccessToken","parameters":[{"name":"id","in":"path","description":"The API Access token ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]},"patch":{"tags":["Administration"],"summary":"Update API Access token by ID","description":"Update API Access token by ID","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_update_api_access_tokens"},"operationId":"updateApiAccessToken","parameters":[{"name":"id","in":"path","description":"The API Access Token ID.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"description":"The payload of the update API Access Token request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqUpdateApiAccessTokenRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqApiAccessToken"}}}}},"security":[{"Bearer":[]}]}},"/users/reports/{id}":{"get":{"tags":["User"],"summary":"Download the  report","description":"Download report of Users","operationId":"downloadUsersReport","parameters":[{"name":"id","in":"path","description":"The report ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string","format":"byte"}}}}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqUser"}}}}},"security":[{"Bearer":[]}]}},"/usergroups/:unique":{"get":{"tags":["Configuration - User Management"],"summary":"List unique user group names","description":"List unique user group names.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_list_unique_user_group_names"},"operationId":"listUniqueUserGroupNames","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/XiqUserGroupName"}}}}}},"security":[{"Bearer":[]}]}},"/user-profile-assignments/{id}":{"get":{"tags":["Configuration - Policy"],"summary":"Get user profile assignment by ID","description":"Get user profile assignment details for the specified ID.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_user_profile_assignment_by_id"},"operationId":"getUserProfileAssignment","parameters":[{"name":"id","in":"path","description":"The user profile assignment ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqUserProfileAssignment"}}}}},"security":[{"Bearer":[]}]},"delete":{"tags":["Configuration - Policy"],"summary":"Delete an user profile assignment by ID","description":"Delete an existing user profile assignment by ID.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_delete_user_profile_assignment_configuration"},"operationId":"deleteUserProfileAssignment","parameters":[{"name":"id","in":"path","description":"The user profile ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/user-folder-preferences":{"get":{"tags":["Use Folder Preferences"],"summary":"Query user folder preferences","description":"Returns matched preferences.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_userFolderPreferences"},"operationId":"queryUserFolderPreferences","parameters":[{"name":"folderId","in":"query","description":"The folder identifier","required":true,"schema":{"type":"integer","format":"int64","minimum":0}},{"name":"type","in":"query","description":"The types of preferences to retrieve (e.g. FLOOR_THRESHOLDS)","required":true,"schema":{"type":"array","items":{"type":"string"},"maxItems":2147483647,"minItems":1}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":{"oneOf":[{"$ref":"#/components/schemas/XiqClientDensityThresholds"},{"$ref":"#/components/schemas/XiqCoChannelInterferenceThresholds"},{"$ref":"#/components/schemas/XiqCoverageOverlapThresholds"},{"$ref":"#/components/schemas/XiqLayerOpacityPreferences"},{"$ref":"#/components/schemas/XiqRssiThresholds"},{"$ref":"#/components/schemas/XiqSnrThresholds"}]}}}}}},"security":[{"Bearer":[]}]}},"/ucp/{id}/engines/installed":{"get":{"tags":["Universal Compute Platform"],"summary":"Get UCP Engines by ID","description":"Get UCP Engine details for the specified device ID.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_ucp_engines_installed"},"operationId":"getUcpEngines","parameters":[{"name":"id","in":"path","description":"The UCP device ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqUcpEngines"}}}}},"security":[{"Bearer":[]}]}},"/thread/topology":{"get":{"tags":["Thread"],"summary":"Get thread network topology","description":"Get thread routers, neighboring routers and end-devices","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_thread_network_topology"},"operationId":"getThreadNetworkTopology","parameters":[{"name":"networkConfigIds","in":"query","description":"Thread network config id","required":true,"schema":{"type":"array","items":{"type":"integer","format":"int64"}}},{"name":"routerFields","in":"query","description":"The thread router fields to return","required":false,"schema":{"type":"array","items":{"type":"string","enum":["DEVICE_ID","SERIAL_NUMBER","EUI64","EXT_MAC","RLOC16","GLOBAL_IPV6","TX_POWER","REGION","THREAD_PLATFORM","DEVICE_ROLE","ROUTER_INTERFACE","VETH0","NETWORK_DATA","THREAD_MLE_LINK_MODE","THREAD_VERSION","LEADER_SERVICE","BORDER_ROUTER_SERVICE","BACKBONE_BORDER_ROUTER_SERVICE","BORDER_AGENT_SERVICE","COMMISSIONER_SERVICE","NAT64_SERVICE","NETWORK_CONFIG","OWNER_ID","ORG_ID","ID","CREATE_TIME","UPDATE_TIME","ACTIVE_CLIENTS","HOSTNAME","LAST_REPORTED","THREAD_CONNECTED"]}}},{"name":"routerViews","in":"query","description":"The views to return thread router fields","required":false,"schema":{"type":"array","items":{"type":"string","enum":["BASIC","DETAIL","FULL"]}}},{"name":"clientViews","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":"clientFields","in":"query","description":"The client fields to return","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/XiqClientField"}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqThreadNetworkTopology"}}}}},"security":[{"Bearer":[]},{"OAuth2_PKCE":[]}]}},"/thread/routers":{"get":{"tags":["Thread"],"summary":"List thread routers","description":"List thread routers with pagination.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_thread_routers"},"operationId":"getThreadRouters","parameters":[{"name":"ids","in":"query","description":"The thread router IDs","required":true,"schema":{"type":"array","items":{"type":"integer","format":"int64"}}},{"name":"page","in":"query","description":"Page number, min = 1","required":false,"schema":{"type":"integer","format":"int32","default":1,"minimum":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 100","required":false,"schema":{"type":"integer","format":"int32","default":10,"maximum":100,"minimum":1}},{"name":"sortField","in":"query","description":"The sort field","required":false,"schema":{"type":"string","description":"All available thread router sort fields","enum":["SERIAL_NUMBER","EUI64","EXT_MAC","RLOC16","GLOBAL_IPV6","TX_POWER","REGION","THREAD_PLATFORM","DEVICE_ROLE","ROUTER_INTERFACE_NAME","ROUTER_INTERFACE_IS_ACTIVE","ROUTER_INTERFACE_IS_BROADCAST","ROUTER_INTERFACE_IS_LOOPBACK","ROUTER_INTERFACE_IS_POINT_TO_POINT","ROUTER_INTERFACE_IS_RUNNING","ROUTER_INTERFACE_IS_ARP","ROUTER_INTERFACE_IS_PROMISC","ROUTER_INTERFACE_IS_ALL_MULTI","ROUTER_INTERFACE_IS_MULTICAST","ROUTER_INTERFACE_IS_DYNAMIC","ROUTER_INTERFACE_MTU","ROUTER_INTERFACE_HW_MAC","ROUTER_INTERFACE_IPV4","ROUTER_INTERFACE_IPV4_MASK","ROUTER_INTERFACE_IPV4_BROADCAST","VETH0_INTERFACE_NAME","VETH0_IS_ACTIVE","VETH0_IS_BROADCAST","VETH0_IS_LOOPBACK","VETH0_IS_POINT_TO_POINT","VETH0_IS_RUNNING","VETH0_IS_ARP","VETH0_IS_PROMISC","VETH0_IS_ALL_MULTI","VETH0_IS_MULTICAST","VETH0_IS_DYNAMIC","VETH0_MTU","VETH0_HW_MAC","VETH0_IPV4","VETH0_IPV4_MASK","VETH0_IPV4_BROADCAST","NETWORK_DATA_LENGTH","NETWORK_DATA_MAX_LENGTH","RX_ON_WHEN_IDLE","FULL_THREAD_DEVICE","FULL_NETWORK_DATA","THREAD_VERSION","BUILD_VERSION","API_VERSION","RCP_VERSION","LEADER_PARTITION_ID","LEADER_WEIGHTING","LEADER_FULL_NETWORK_DATA_VERSION","LEADER_STABLE_NETWORK_DATA_VERSION","BORDER_ROUTER_STATE","BORDER_NAT64_LOCAL_PREFIX","BORDER_NAT64_FAVORED_PREFIX","BORDER_NAT64_FAVORED_PREFERENCE","BORDER_NAT64_0MR_LOCAL_PREFIX","BORDER_NAT64_0MR_FAVORED_PREFIX","BORDER_NAT64_0MR_FAVORED_PREFERENCE","BORDER_NAT64_640N_LINK_LOCAL_PREFIX","BORDER_NAT64_640N_LINK_FAVORED_PREFIX","BORDER_NAT64_640N_LINK_FAVORED_PREFERENCE","BACKBONE_BORDER_ROUTER_STATE","BORDER_AGENT_STATE","BORDER_AGENT_UDP_PORT","COMMISSIONER_STATE","NAT64_PREFIX_MANAGER_STATE","NAT64_TRANSLATOR_STATE","NAT64_TRANSLATOR_CIDR","HOSTNAME"]}},{"name":"sortOrder","in":"query","description":"The sort order (ascending by default)","required":false,"schema":{"$ref":"#/components/schemas/XiqSortOrder","default":"ASC"}},{"name":"views","in":"query","description":"The views to return thread router fields","required":false,"schema":{"type":"array","items":{"type":"string","enum":["BASIC","DETAIL","FULL"]}}},{"name":"fields","in":"query","description":"The thread router fields to return","required":false,"schema":{"type":"array","items":{"type":"string","enum":["DEVICE_ID","SERIAL_NUMBER","EUI64","EXT_MAC","RLOC16","GLOBAL_IPV6","TX_POWER","REGION","THREAD_PLATFORM","DEVICE_ROLE","ROUTER_INTERFACE","VETH0","NETWORK_DATA","THREAD_MLE_LINK_MODE","THREAD_VERSION","LEADER_SERVICE","BORDER_ROUTER_SERVICE","BACKBONE_BORDER_ROUTER_SERVICE","BORDER_AGENT_SERVICE","COMMISSIONER_SERVICE","NAT64_SERVICE","NETWORK_CONFIG","OWNER_ID","ORG_ID","ID","CREATE_TIME","UPDATE_TIME","ACTIVE_CLIENTS","HOSTNAME","LAST_REPORTED","THREAD_CONNECTED"]}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqThreadRouter"}}}}},"security":[{"Bearer":[]},{"OAuth2_PKCE":[]}]}},"/thread/networks":{"get":{"tags":["Thread"],"summary":"Get active thread networks","description":"Get thread networks with atleast one device","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_thread_networks"},"operationId":"getThreadNetworks","parameters":[{"name":"page","in":"query","description":"Page number, min = 1","required":false,"schema":{"type":"integer","format":"int32","default":1,"minimum":1}},{"name":"folderId","in":"query","description":"Thread network config folder id","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 100","required":false,"schema":{"type":"integer","format":"int32","default":10,"maximum":100,"minimum":1}},{"name":"fields","in":"query","description":"The thread network config fields to return","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ID","CHANNEL","CHANNEL_MASK","EXT_PAN_ID","MESH_LOCAL_PREFIX","NETWORK_KEY","NETWORK_NAME","PAN_ID","PSKC","OBTAIN_NETWORK_KEY_ENABLED","NATIVE_COMMISSIONING_ENABLED","ROUTERS_ENABLED","EXTERNAL_COMMISSIONING_ENABLED","BEACONS_ENABLED","COMMERCIAL_COMMISSIONING_ENABLED","AUTONOMOUS_ENROLLMENT_ENABLED","NETWORK_KEY_PROVISIONING_ENABLED","NON_CCM_ROUTERS_ENABLED","ACTIVE_TIMESTAMP"]}}},{"name":"views","in":"query","description":"The views to return thread network config fields","required":false,"schema":{"type":"array","items":{"type":"string","enum":["BASIC","FULL"]}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqThreadNetworks"}}}}},"security":[{"Bearer":[]},{"OAuth2_PKCE":[]}]}},"/subscriptions/webhook/export":{"get":{"tags":["Notification"],"summary":"Export all webhook subscriptions to CSV","description":"Export all webhook subscriptions to a CSV file.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_export_webhook_subscriptions"},"operationId":"exportToCsv_5","parameters":[{"name":"order","in":"query","required":false,"schema":{"$ref":"#/components/schemas/XiqSortOrder"}},{"name":"keyword","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string","format":"byte"}}}}},"security":[{"Bearer":[]}]}},"/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":{"type":"integer","format":"int32","default":1,"minimum":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 100","required":false,"schema":{"type":"integer","format":"int32","default":10,"maximum":100,"minimum":1}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqSsid"}}}}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/XiqSmsTemplate"}}}}}},"security":[{"Bearer":[]}]}},"/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":{"type":"integer","format":"int32","default":1,"minimum":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 100","required":false,"schema":{"type":"integer","format":"int32","default":10,"maximum":100,"minimum":1}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqInternalRadiusDevice"}}}}},"security":[{"Bearer":[]}]}},"/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":{"type":"integer","format":"int32","default":1,"minimum":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 100","required":false,"schema":{"type":"integer","format":"int32","default":10,"maximum":100,"minimum":1}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqInternalRadiusDevice"}}}}},"security":[{"Bearer":[]}]}},"/radio-operating-modes/{productType}":{"get":{"tags":["Configuration - Policy"],"summary":"Get Radio Operating Modes by product type","description":"Modern AP hardware types include dual or triple band radios.\n        A limited subset of band combinations are supported.\n        Operating mode defines the supported band combinations per radio.    \n        Access Points with fixed band radios use GENERIC operating mode.  \n        SERVICE_2_5_6:   wifi0-2.4Ghz, wifi1-5Ghz, wifi2-6Ghz\n        SENSOR_SERVICE_5_6: wifi0-Tri-band sensor, wifi1-5Ghz, wifi2-6Ghz\n        SERVICE_5L_5H_6: wifi0-5G Low, wifi1-5G High, wifi2-6Ghz\n        SENSOR_SERVICE_5_2: wifi0-Tri-band sensor, wifi1-5GHz, wifi2-2.4Ghz\n        SERVICE_5L_5H_2: wifi0-5G Low, wifi1-5G High, wifi2-2.4Ghz\n        SERVICE_2_5H_5L: wifi2-2.4Ghz, wifi1-5G High, wifi0-5G Low\n        SERVICE_6L_5_6H: wifi0-6G Low, wifi1-5GHz, wifi2-6Ghz.\n        SERVICE_6H_5_6L: wifi0-6G High, wifi1-5GHz, wifi2-6Ghz Low.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_radio_operating_mode"},"operationId":"getRadioOperatingModes","parameters":[{"name":"productType","in":"path","description":"Product Type/Model","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/XiqRadioOperatingModes"}}}}}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqPacketCapture"}}}}},"security":[{"Bearer":[]}]},"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":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK","content":{"application/octet-stream":{"schema":{"type":"string","format":"byte"}}}}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqOperationObject"}}}}},"security":[{"Bearer":[]}]},"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":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/ng-reports/scheduled/runs/{reportRunId}/recipients":{"get":{"tags":["NG Reports (Scheduled)"],"summary":"Get Recipients for Report Run","description":"Retrieves all recipients for a given report run.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_recipients_for_report_run"},"operationId":"getRecipientsForReportRun","parameters":[{"name":"reportRunId","in":"path","description":"The report run ID","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"keyword","in":"query","description":"The keyword to search","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqRecipientsForReportRun"}}}}},"security":[{"Bearer":[]}]}},"/ng-reports/scheduled/reports/download":{"get":{"tags":["NG Reports (Scheduled)"],"summary":"Download or Preview Scheduled Report File","description":"Downloads or previews a scheduled report file in PDF or XLSX format.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_download_or_preview_scheduled_report_file"},"operationId":"downloadScheduledReportFile","parameters":[{"name":"reportRunId","in":"query","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"fileFormat","in":"query","required":true,"schema":{"$ref":"#/components/schemas/XiqReportFileFormat"}},{"name":"preview","in":"query","description":"Param to view in Preview mode, (supported only when fileFormat = PDF)","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string","format":"byte"}}}}},"security":[{"Bearer":[]}]}},"/ng-reports/scheduled/pci-compliance":{"get":{"tags":["NG Reports (Scheduled)"],"summary":"Get PCI Compliance Reports","description":"Retrieves all PCI compliance reports with optional keyword filtering.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_pci_compliance_reports"},"operationId":"getPciComplianceReports","parameters":[{"name":"keyword","in":"query","description":"Keyword to search report file name and recipient emails","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqNgCannedReport"}}}}},"security":[{"Bearer":[]}]}},"/ng-reports/scheduled/network-summary":{"get":{"tags":["NG Reports (Scheduled)"],"summary":"Get Network Summary Reports","description":"Retrieves all network summary reports with optional keyword filtering.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_network_summary_reports"},"operationId":"getNetworkSummaryReports","parameters":[{"name":"keyword","in":"query","description":"Keyword to search report file name and recipient emails","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqNgCannedReport"}}}}},"security":[{"Bearer":[]}]}},"/ng-reports/scheduled/custom/{reportScheduleId}/runs":{"get":{"tags":["NG Reports (Scheduled)"],"summary":"Get report runs for a schedule","description":"Fetch all report runs for a specific schedule ID and optional frequencies.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_report_runs_for_a_schedule"},"operationId":"getReportRunsForSchedule","parameters":[{"name":"reportScheduleId","in":"path","description":"The report schedule ID","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"frequency","in":"query","description":"Optional list of schedule frequencies to filter by","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/XiqScheduleFrequency"}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/XiqReportRunsResponse"}}}}}},"security":[{"Bearer":[]}]}},"/ng-reports/information":{"get":{"tags":["NG Reports (Ondemand)"],"summary":"Information about QoE-Diagnostics Metrics","description":" Gives information about metrics, there functionality and applicable filters","externalDocs":{"description":"API reference for QoE diagnostics metric information","url":"https://extremecloudiq.com/api-docs/api-reference.html#_qoe_diagnostics_information"},"operationId":"qOeDiagnosticsHelp","parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/XiqQoeDiagnosticsSummary"}}}}}},"security":[{"Bearer":[]}]}},"/ng-reports/information/{metrics}":{"get":{"tags":["NG Reports (Ondemand)"],"summary":"Information about QoE-Diagnostics Metrics","description":" Gives information about metrics, there functionality and applicable filters","externalDocs":{"description":"API reference for QoE diagnostics metric information","url":"https://extremecloudiq.com/api-docs/api-reference.html#_qoe_diagnostics_information"},"operationId":"qOeDiagnosticsHelp_1","parameters":[{"name":"metrics","in":"path","description":"metrics","required":true,"schema":{"$ref":"#/components/schemas/XiqQoeDiagnosticsMetrics"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/XiqQoeDiagnosticsSummary"}}}}}},"security":[{"Bearer":[]}]}},"/ng-reports/download/reports/{id}":{"get":{"tags":["NG Reports (Ondemand)"],"summary":"Download the Reports by ID","description":"Download reports of Metrics","externalDocs":{"description":"API reference for download reports and supported metrics","url":"https://extremecloudiq.com/api-docs/api-reference.html#_download_the_reports_by_id"},"operationId":"downloadReport","parameters":[{"name":"id","in":"path","description":"The report ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Report downloaded successfully","content":{"application/json":{"schema":{"type":"string","format":"byte"}}}},"404":{"description":"Report not found","content":{"application/json":{"schema":{"type":"string","format":"byte"}}}},"400":{"description":"Invalid Report Id","content":{"application/json":{"schema":{"type":"string","format":"byte"}}}}},"security":[{"Bearer":[]}]}},"/network-scorecard/wifiHealth/{locationId}":{"get":{"tags":["Network Scorecard"],"summary":"Get the overall wifi health score","description":"Get the wifi health score over the period","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_wi_fis_overall_health_for_given_location"},"operationId":"getWifiHealth","parameters":[{"name":"locationId","in":"path","description":"The location folder 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":false,"schema":{"type":"integer","format":"int64"}},{"name":"endTime","in":"query","description":"The end time to query, epoch time in milliseconds since 1/1/1970","required":false,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WifiHealth"}}}}},"security":[{"Bearer":[]}]}},"/network-scorecard/servicesHealth/{locationId}":{"get":{"tags":["Network Scorecard"],"summary":"Get the overall services health score","description":"Get the  health score over the period","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_services_overall_health_for_given_location"},"operationId":"getServicesHealth","parameters":[{"name":"locationId","in":"path","description":"The location folder 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":false,"schema":{"type":"integer","format":"int64"}},{"name":"endTime","in":"query","description":"The end time to query, epoch time in milliseconds since 1/1/1970","required":false,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServicesHealth"}}}}},"security":[{"Bearer":[]}]}},"/network-scorecard/networkHealth/{locationId}":{"get":{"tags":["Network Scorecard"],"summary":"Get the overall network health score","description":"Get the network health score over the period","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_networks_overall_health_for_given_location"},"operationId":"getNetworkHealth","parameters":[{"name":"locationId","in":"path","description":"The location folder 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":false,"schema":{"type":"integer","format":"int64"}},{"name":"endTime","in":"query","description":"The end time to query, epoch time in milliseconds since 1/1/1970","required":false,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NetworkHealth"}}}}},"security":[{"Bearer":[]}]}},"/network-scorecard/deviceHealth/{locationId}":{"get":{"tags":["Network Scorecard"],"summary":"Get the overall device health score","description":"Get the devices health score over the period","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_devices_overall_health_for_given_location"},"operationId":"getDeviceHealth","parameters":[{"name":"locationId","in":"path","description":"The location folder 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":false,"schema":{"type":"integer","format":"int64"}},{"name":"endTime","in":"query","description":"The end time to query, epoch time in milliseconds since 1/1/1970","required":false,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceHealth"}}}}},"security":[{"Bearer":[]}]}},"/network-scorecard/clientHealth/{locationId}":{"get":{"tags":["Network Scorecard"],"summary":"Get the overall client health score","description":"Get the clients health score over the period","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_clients_overall_health_for_given_location"},"operationId":"getClientHealth","parameters":[{"name":"locationId","in":"path","description":"The location folder 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":false,"schema":{"type":"integer","format":"int64"}},{"name":"endTime","in":"query","description":"The end time to query, epoch time in milliseconds since 1/1/1970","required":false,"schema":{"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"}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientHealth"}}}}},"security":[{"Bearer":[]}]}},"/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":{"type":"integer","format":"int32","default":1,"minimum":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 100","required":false,"schema":{"type":"integer","format":"int32","default":10,"maximum":100,"minimum":1}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqSsid"}}}}},"security":[{"Bearer":[]}]}},"/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":{"type":"integer","format":"int32","default":1,"minimum":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 100","required":false,"schema":{"type":"integer","format":"int32","default":10,"maximum":100,"minimum":1}},{"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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqSmsLog"}}}}},"security":[{"Bearer":[]}]}},"/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":{"type":"integer","format":"int32","default":1,"minimum":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 100","required":false,"schema":{"type":"integer","format":"int32","default":10,"maximum":100,"minimum":1}},{"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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqEmailLog"}}}}},"security":[{"Bearer":[]}]}},"/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":{"type":"integer","format":"int32","default":1,"minimum":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 100","required":false,"schema":{"type":"integer","format":"int32","default":10,"maximum":100,"minimum":1}},{"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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqCredentialLog"}}}}},"security":[{"Bearer":[]}]}},"/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":{"type":"integer","format":"int32","default":1,"minimum":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 100","required":false,"schema":{"type":"integer","format":"int32","default":10,"maximum":100,"minimum":1}},{"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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqAuthLog"}}}}},"security":[{"Bearer":[]}]}},"/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":{"type":"integer","format":"int32","default":1,"minimum":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 500","required":false,"schema":{"type":"integer","format":"int32","default":10,"maximum":500,"minimum":1}},{"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","default":"DESC"}},{"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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqAuditLog"}}}}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string","format":"byte"}}}}},"security":[{"Bearer":[]}]}},"/logs/audit/full-descriptions/{id}":{"get":{"tags":["Log"],"summary":"Get audit log full descriptions","description":"Get audit log full descriptions by ID.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_audit_log_full_descriptions"},"operationId":"getAuditLogFullDescriptions","parameters":[{"name":"id","in":"path","description":"The audit log full description ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqAuditLogFullDescriptions"}}}}},"security":[{"Bearer":[]}]}},"/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":{"type":"integer","format":"int32","default":1,"minimum":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 100","required":false,"schema":{"type":"integer","format":"int32","default":10,"maximum":100,"minimum":1}},{"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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqAccountingLog"}}}}},"security":[{"Bearer":[]}]}},"/locations/wall/type/references/{id}":{"get":{"tags":["Location"],"summary":"Find references of a wall type","description":"Find all floors a/o sites referencing a wall type by its ID","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_find_wall_type_reference"},"operationId":"findWallTypeReferences","parameters":[{"name":"id","in":"path","description":"The Wall Type ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/XiqWallTypeReference"}}}}}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/XiqLocation"}}}}}},"security":[{"Bearer":[]}]}},"/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":{"type":"integer","format":"int32","default":1,"minimum":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 100","required":false,"schema":{"type":"integer","format":"int32","default":10,"maximum":100,"minimum":1}},{"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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqLocationTreeMap"}}}}},"security":[{"Bearer":[]}]}},"/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":{"type":"integer","format":"int32","default":1,"minimum":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 100","required":false,"schema":{"type":"integer","format":"int32","default":10,"maximum":100,"minimum":1}},{"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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqLocationTreeDevice"}}}}},"security":[{"Bearer":[]}]}},"/locations/folder/{folderId}/zones":{"get":{"tags":["Location"],"summary":"Get all zones in folder","description":"Retrieve the list of zones in folder by folder ID.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_zones_in_folder"},"operationId":"getZonesInFolder","parameters":[{"name":"folderId","in":"path","description":"The Folder ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/XiqZone"}}}}}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqHiqStatus"}}}}},"security":[{"Bearer":[]}]}},"/geo-view":{"get":{"tags":["Geo View"],"summary":"Get GeoView Data","operationId":"getGeoViewData","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/GeoViewNode"}}}}}},"security":[]}},"/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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EssentialsElocLastKnownLocation"}}}}},"security":[{"Bearer":[]}]}},"/essentials/eloc/clients/location/path-in-interval-on-floor":{"get":{"tags":["Essentials - ExtremeLocation"],"summary":"Get the path of the client in the specified interval","description":"Get the path of the client on the floor plan in the specified interval.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_the_path_of_the_client"},"operationId":"getClientPath","parameters":[{"name":"parentId","in":"query","description":"Location Id of the floor's parent","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"floorId","in":"query","description":"Location Id of the floor","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"clientMac","in":"query","description":"The mac address of the client","required":true,"schema":{"type":"string"}},{"name":"startDate","in":"query","description":"Start date for the path ('yyyy-MM-dd HH:mm' format)","required":true,"schema":{"type":"string"},"example":"2026-01-01 00:00"},{"name":"endDate","in":"query","description":"End date for the path ('yyyy-MM-dd HH:mm' format)","required":true,"schema":{"type":"string"},"example":"2026-01-01 23:59"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EssentialsElocClientPathPoint"}}}}}},"security":[{"Bearer":[]}]}},"/essentials/eloc/clients/location/last-known-location-in-interval-on-floor":{"get":{"tags":["Essentials - ExtremeLocation"],"summary":"Get the last known location of the client in the specified interval","description":"Get the last known location of the client on the floor plan in the specified interval.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_locations_of_all_connected_clients_on_a_floor"},"operationId":"getClientLastKnownLocationInInterval","parameters":[{"name":"parentId","in":"query","description":"Location Id of the floor's parent","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"floorId","in":"query","description":"Location Id of the floor","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"clientMac","in":"query","description":"The mac address of the client","required":true,"schema":{"type":"string"}},{"name":"interval","in":"query","description":"Interval for the last known location","required":true,"schema":{"$ref":"#/components/schemas/XiqClientLocationSearchInterval"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EssentialsElocLastKnownLocation"}}}}},"security":[{"Bearer":[]}]}},"/essentials/eloc/clients/location/density-map-data":{"get":{"tags":["Essentials - ExtremeLocation"],"summary":"Get the client density map data","description":"Get the density map of clients on the floor plan for a specific date, structured per hour.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_client_density_map_data"},"operationId":"getClientDensityMapData","parameters":[{"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"}},{"name":"date","in":"query","description":"Date for the density map ('yyyy-MM-dd' format)","required":true,"schema":{"type":"string"},"example":"2026-01-01"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/EssentialsElocHourlyDensityMap"}}}}}},"security":[{"Bearer":[]}]}},"/essentials/eloc/clients/location/current-on-floor":{"get":{"tags":["Essentials - ExtremeLocation"],"summary":"Get the current location of the client","description":"Get the current location of the client on the floor plan.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_current_location_of_the_client"},"operationId":"getClientCurrentLocation","parameters":[{"name":"parentId","in":"query","description":"Location Id of the floor's parent","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"floorId","in":"query","description":"Location Id of the floor","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"clientMac","in":"query","description":"The mac address of the client","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EssentialsElocCurrentLocation"}}}}},"security":[{"Bearer":[]}]}},"/essentials/eloc/clients/location/current-of-all-on-floor":{"get":{"tags":["Essentials - ExtremeLocation"],"summary":"Get all connected clients on a floor","description":"Get the locations of all connected clients on a floor.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_location_of_all_connected_clients_on_a_floor"},"operationId":"getCurrentLocationOfAllClientsOnFloor","parameters":[{"name":"parentId","in":"query","description":"Location Id of the floor's parent","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"floorId","in":"query","description":"Location Id of the floor","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EssentialsElocConnectedClientLocation"}}}}}},"security":[{"Bearer":[]}]}},"/endusers/client/locked-list":{"get":{"tags":["Configuration - User Management"],"summary":"List locked clients","description":"List a page of clients that are locked due to too many failed authentication attempts.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_list_locked_clients"},"operationId":"lockedClients","parameters":[{"name":"page","in":"query","description":"Page number, min = 1","required":false,"schema":{"type":"integer","format":"int32","default":1,"minimum":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 100","required":false,"schema":{"type":"integer","format":"int32","default":10,"maximum":100,"minimum":1}},{"name":"sortField","in":"query","description":"The sort field","required":false,"schema":{"$ref":"#/components/schemas/XiqLockedClientSortField"}},{"name":"sortOrder","in":"query","description":"The sort order (ascending by default)","required":false,"schema":{"$ref":"#/components/schemas/XiqSortOrder","default":"ASC"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqLockedClient"}}}}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/XiqEmailTemplate"}}}}}},"security":[{"Bearer":[]}]}},"/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":{"type":"integer","format":"int32","default":1,"minimum":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 100","required":false,"schema":{"type":"integer","format":"int32","default":10,"maximum":100,"minimum":1}},{"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","default":"ASC"}},{"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","default":["REAL"],"items":{"$ref":"#/components/schemas/XiqDeviceType"}}},{"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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqDevice"}}}}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqDeviceResponse"}}}}},"security":[{"Bearer":[]}]},"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":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/XiqDeviceLevelSsidStatus"}}}}}},"security":[{"Bearer":[]}]}},"/devices/{id}/monitor/refresh/status":{"get":{"tags":["Device"],"summary":"Monitor refresh a device status ","description":"Monitor refresh a specific device status.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_monitor_refresh_status_one_device"},"operationId":"monitorRefreshDeviceStatus","parameters":[{"name":"id","in":"path","description":"The device ID","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"taskKey","in":"query","description":"Monitor refresh task key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqDeviceMonitorRefreshStatusResponse"}}}}},"security":[{"Bearer":[]}]}},"/devices/{id}/iot":{"get":{"tags":["Device"],"summary":"Get the device IoT Wireless Interface settings","description":"Get the device IoT profile Wireless Interface settings by device ID.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_device_iot"},"operationId":"getDeviceIot","parameters":[{"name":"id","in":"path","description":"The device ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqDeviceIotInterfaceSettingsEntry"}}}}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/XiqDeviceWifiInterface"}}}}}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqDeviceInstallationReport"}}}}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqDeviceIbeacon"}}}}},"security":[{"Bearer":[]}]}},"/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 minutes, min = 10","required":false,"schema":{"type":"integer","format":"int64","default":10,"minimum":10}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/XiqDeviceCpuMemoryUsage"}}}}}},"security":[{"Bearer":[]}]}},"/devices/{id}/geolocation":{"get":{"tags":["Device"],"summary":"Get Geolocation for a device","description":"Get the Geolocation info for a specific device.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_geolocation_for_one_device"},"operationId":"getDeviceGeolocation","parameters":[{"name":"id","in":"path","description":"The device ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqDeviceGeolocation"}}}}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}}},"security":[{"Bearer":[]}]}},"/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":{"type":"integer","format":"int32","default":1,"minimum":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 100","required":false,"schema":{"type":"integer","format":"int32","default":10,"maximum":100,"minimum":1}},{"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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqDeviceAlarm"}}}}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqDeviceStats"}}}}},"security":[{"Bearer":[]}]}},"/devices/rm-devices-stack/{stackId}":{"get":{"tags":["Device"],"summary":"Get Stack Member Info for a given stack id","description":"Retrieve information about stack members.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_rm_stack_member_info"},"operationId":"getStackMemberInfo","parameters":[{"name":"stackId","in":"path","description":"The stack ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/XiqRmStackMemberInfo"}}}}}},"security":[{"Bearer":[]}]}},"/devices/reports/{id}":{"get":{"tags":["Device"],"summary":"Download the Export CSV file","description":"Download the Export CSV file for Device Status","operationId":"downloadExportCsvFile","parameters":[{"name":"id","in":"path","description":"The report ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string","format":"byte"}}}}},"security":[{"Bearer":[]}]}},"/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":{"type":"integer","format":"int32","default":1,"minimum":1}},{"name":"limit","in":"query","description":"Number of Records, min = 1, max = 50","required":false,"schema":{"type":"integer","format":"int32","default":10,"maximum":50,"minimum":1}},{"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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqRadioEntity"}}}}},"security":[{"Bearer":[]}]}},"/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":{"type":"integer","format":"int32","default":1,"minimum":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 100","required":false,"schema":{"type":"integer","format":"int32","default":10,"maximum":100,"minimum":1}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqDevice"}}}}},"security":[{"Bearer":[]}]}},"/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":{"type":"integer","format":"int32","default":1,"minimum":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 100","required":false,"schema":{"type":"integer","format":"int32","default":10,"maximum":100,"minimum":1}},{"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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqDigitalTwinProducts"}}}}},"security":[{"Bearer":[]}]}},"/deployments/{deploymentId}/status":{"get":{"tags":["Configuration - Deployment"],"summary":"[LRO] Get firmware deployment status by ID","description":"Get firmware upgrade schedule status for a site based on deployment ID.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_firmware_deployment_status_by_id"},"operationId":"getDeploymentByIdStatus","parameters":[{"name":"deploymentId","in":"path","description":"The deployment 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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqDeploymentByIdStatusResponse"}}}}},"security":[{"Bearer":[]}]}},"/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":{"type":"array","items":{"type":"integer","format":"int64"},"uniqueItems":true}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/XiqDeploymentStatus"}}}}}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqDeploymentOverview"}}}}},"security":[{"Bearer":[]}]}},"/dashboard/wireless/usage-capacity/reports/{id}":{"get":{"tags":["Dashboard Wireless Usage and Capacity"],"summary":"Download the  report","description":"Download report of Metrics","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_download_usage_capacity_report"},"operationId":"downloadUsageAndCapacityReport","parameters":[{"name":"id","in":"path","description":"The report ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string","format":"byte"}}}}},"security":[{"Bearer":[]}]}},"/dashboard/wireless/device-health/reports/{id}":{"get":{"tags":["Dashboard Wireless Device Health"],"summary":"Download the  report","description":"Download report of Metrics","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_download_device_health_report"},"operationId":"downloadDeviceHealthReport","parameters":[{"name":"id","in":"path","description":"The report ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string","format":"byte"}}}}},"security":[{"Bearer":[]}]}},"/dashboard/wireless/device-health/reboot/summary":{"get":{"tags":["Dashboard Wireless Device Health"],"summary":"Device reboot summary for wireless device","description":"Returns the device reboot summary of wireless device based on the provided filters.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_reboot_summary_for_wireless_device"},"operationId":"getDeviceRebootSummary","parameters":[{"name":"page","in":"query","description":"Page number, min = 1","required":false,"schema":{"type":"integer","format":"int32","default":1,"minimum":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 100","required":false,"schema":{"type":"integer","format":"int32","default":10,"maximum":100,"minimum":1}},{"name":"deviceId","in":"query","description":"The device Id","required":false,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqDeviceRebootSummary"}}}}},"security":[{"Bearer":[]}]}},"/dashboard/wireless/client-health/reports/{id}":{"get":{"tags":["Dashboard Wireless Client Health"],"summary":"Download the report","description":"Download report of Metrics","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_download_client_health_report"},"operationId":"downloadClientHealthReport","parameters":[{"name":"id","in":"path","description":"The report ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string","format":"byte"}}}}},"security":[{"Bearer":[]}]}},"/dashboard/reports/{id}":{"get":{"tags":["Dashboard"],"summary":"Download the  report","description":"Download report of Metrics","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_download_the_dashboard_report"},"operationId":"downloadSiteWithIssueReport","parameters":[{"name":"id","in":"path","description":"The report ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string","format":"byte"}}}}},"security":[{"Bearer":[]}]}},"/dashboard/device-types":{"get":{"tags":["Dashboard"],"summary":"Get all diagnostics device types","description":"Returns all available diagnostics device types (unspecified, wired, wireless, or all).","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_all_dashboard_device_types"},"operationId":"getAllDiagnosticsDeviceTypes","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}}},"security":[{"Bearer":[]}]}},"/d360/wireless/interfaces-stats":{"get":{"tags":["D360"],"summary":"Get Wifi Information","description":"Returns the information related to wifi0, wifi1 and wifi2.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_wifi_information"},"operationId":"getWirelessWifi","parameters":[{"name":"deviceId","in":"query","description":"The unique identifier of the wireless device","required":true,"schema":{"type":"integer","format":"int64"},"example":12345},{"name":"startTime","in":"query","description":"Start time in milliseconds (epoch time)","required":true,"schema":{"type":"integer","format":"int64"},"example":1708243200000},{"name":"endTime","in":"query","description":"End time in milliseconds (epoch time)","required":true,"schema":{"type":"integer","format":"int64"},"example":1708246800000},{"name":"selectedTime","in":"query","description":"Selected time in milliseconds (epoch time). Optional parameter.","required":false,"schema":{"type":"integer","format":"int64"},"example":1708245000000}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqWirelessInterfacesStats"}}}}},"security":[{"Bearer":[]}]}},"/d360/wireless/interfaces-graph":{"get":{"tags":["D360"],"summary":"Get Wireless Interface Graph","description":"List a list of wireless interfaces metrics for Graphing API.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_interface_graph"},"operationId":"getWirelessInterfaceGraph","parameters":[{"name":"deviceId","in":"query","description":"The device ID","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"startTime","in":"query","description":"The start time","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"endTime","in":"query","description":"The end time","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"channel","in":"query","description":"The channel utilization type","required":true,"schema":{"$ref":"#/components/schemas/XiqRmChannelFilterType"}},{"name":"source","in":"query","description":"The source type as channel utilization or connected clients (By default both are shown)","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/XiqRmSourceFilterType"}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/XiqWirelessInterfaceGraph"}}}}}},"security":[{"Bearer":[]}]}},"/d360/wired/queue-grid":{"get":{"tags":["D360"],"summary":"Wired QOS queue grid","description":"Returns all QOS queue statistics for a wired device","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_wired_queue_grid"},"operationId":"getWiredQueueGrid","parameters":[{"name":"deviceId","in":"query","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,"minimum":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 100","required":false,"schema":{"type":"integer","format":"int32","default":10,"maximum":100,"minimum":1}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqWiredPortQosState"}}}}},"security":[{"Bearer":[]}]}},"/d360/ssid-metadata":{"get":{"tags":["D360"],"summary":"Get SSID Metadata","description":"Returns the SSID metadata for surrounding APs","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_ssid_metadata"},"operationId":"getSsidMetadata","parameters":[{"name":"deviceId","in":"query","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"startTime","in":"query","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"endTime","in":"query","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqSsidMetadata"}}}}},"security":[{"Bearer":[]}]}},"/d360/overview/devices-summary":{"get":{"tags":["D360"],"summary":"List the summary of device details","description":"List the summary of device details.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_summary"},"operationId":"getDeviceSummary_1","parameters":[{"name":"deviceId","in":"query","description":"The device ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqD360DeviceSummary"}}}}},"security":[{"Bearer":[]}]}},"/d360/event/graph":{"get":{"tags":["D360"],"summary":"Get Client Grid Filter Metadata","description":"Retrieve a time-series graph of event metrics. Each timestamp includes\nan array of event types with their respective counts. Only selected filters will be included in the response.\n","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_event_graph"},"operationId":"getEventsGraph","parameters":[{"name":"deviceId","in":"query","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"startTime","in":"query","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"endTime","in":"query","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"filter","in":"query","description":"The Enum for graph filter type","required":false,"schema":{"type":"array","items":{"type":"string","enum":["CRITICAL","MAJOR","MINOR","INFO","ACTIVE","CLEAR","ALL","WARNING"]}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventGraphResponse"}}}}},"security":[{"Bearer":[]}]}},"/d360/device/stats":{"get":{"tags":["D360"],"summary":"Get Device Stats","description":"Gives the device Stats","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_device_stats"},"operationId":"getDeviceStats_1","parameters":[{"name":"deviceId","in":"query","description":"The device ID","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"startTime","in":"query","description":"The start time","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"endTime","in":"query","description":"The end time","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/XiqD360DeviceStats"}}}}}},"security":[{"Bearer":[]}]}},"/d360/device/metadata":{"get":{"tags":["D360"],"summary":"Get Device MetaData","description":"Gives the device information along with placement co-ordinates and floor map","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_metadata"},"operationId":"getDeviceMetaData","parameters":[{"name":"deviceId","in":"query","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqDeviceMetaData"}}}}},"security":[{"Bearer":[]}]}},"/d360/device/issues":{"get":{"tags":["D360"],"summary":"Get Device Issues","description":"Returns the information related to device issues","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_device_issues"},"operationId":"getDeviceIssues","parameters":[{"name":"deviceId","in":"query","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"startTime","in":"query","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"endTime","in":"query","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqDeviceIssues"}}}}},"security":[{"Bearer":[]}]}},"/d360/device/interfaces":{"get":{"tags":["D360"],"summary":"Get Wifi Interfaces Per Device Information","description":"Returns the information related to wifi0, wifi1, and wifi2 interfaces available per device model.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_wifi_information_interface_per_device"},"operationId":"getWifiInterfacePerDevice","parameters":[{"name":"deviceModel","in":"query","description":"The Enum for device model","required":true,"schema":{"type":"string","enum":["AP_650","AP_650X","AP_4000","AP_4000U","AP_302W","AP_510C","AP_510CX","AP_410C","AP_460C","AP_305C","AP_305CX","AP_460S6C","AP_460S12C","AP_5010","AP_5010U","AP_5050U","AP_5050D","AP_3000","AP_3000X","AP_5020"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqWirelessIntPerDevice"}}}}},"security":[{"Bearer":[]}]}},"/d360/client/stats":{"get":{"tags":["D360"],"summary":"Get Client Stats Information","description":"Returns the information related to Client Stats.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_stats"},"operationId":"getClientStats","parameters":[{"name":"deviceId","in":"query","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"startTime","in":"query","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"endTime","in":"query","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"selectedTime","in":"query","required":false,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqClientStats"}}}}},"security":[{"Bearer":[]}]}},"/d360/client/grid/metadata":{"get":{"tags":["D360"],"summary":"Get Client Grid Filter Metadata","description":"Returns the metadata for the client grid","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_client_grid_metadata"},"operationId":"getClientGridMetadata","parameters":[{"name":"deviceId","in":"query","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"startTime","in":"query","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"endTime","in":"query","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqD360ClientGridMetadata"}}}}},"security":[{"Bearer":[]}]}},"/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":{"type":"integer","format":"int32","default":1,"minimum":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 100","required":false,"schema":{"type":"integer","format":"int32","default":10,"maximum":100,"minimum":1}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqCwp"}}}}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/XiqCountry"}}}}}}}},"/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":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"boolean"}}}}}}},"/countries/{countryAlpha2Code}/states":{"get":{"tags":["Misc"],"summary":"Get state list by country code","description":"Get list of states or provinces in a country with country alpha2 code.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_state_list_by_country_code"},"operationId":"getStateListByCountryCode","parameters":[{"name":"countryAlpha2Code","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/XiqCountryState"}}}}}}}},"/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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqWirelessViewsTypeResponse"}}}}},"security":[{"Bearer":[]}]}},"/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","default":"TWENTY_FOUR_HOURS"}},{"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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqWirelessTimeToConnectResponse"}}}}},"security":[{"Bearer":[]}]}},"/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","default":"TWENTY_FOUR_HOURS"}},{"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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqWirelessQualityIndexResponse"}}}}},"security":[{"Bearer":[]}]}},"/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","default":"TWENTY_FOUR_HOURS"}},{"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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqWirelessConnectivityPerformanceResponse"}}}}},"security":[{"Bearer":[]}]}},"/copilot/connectivity/wireless/locations/time-to-connect":{"get":{"tags":["Copilot - Connectivity Experience"],"operationId":"getWirelessTimeToConnectByLocation","parameters":[{"name":"buildingId","in":"query","description":"The location identifier for building","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","default":"TWENTY_FOUR_HOURS"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqWirelessTimeToConnectResponse"}}}}},"security":[{"Bearer":[]}]}},"/copilot/connectivity/wireless/locations/quality-index":{"get":{"tags":["Copilot - Connectivity Experience"],"operationId":"getWirelessQualityIndexByLocation","parameters":[{"name":"buildingId","in":"query","description":"The location identifier for building","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","default":"TWENTY_FOUR_HOURS"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqWirelessQualityIndexByLocationResponse"}}}}},"security":[{"Bearer":[]}]}},"/copilot/connectivity/wireless/locations/performance":{"get":{"tags":["Copilot - Connectivity Experience"],"operationId":"getWirelessPerformanceByLocation","parameters":[{"name":"buildingId","in":"query","description":"The location identifier for building","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","default":"TWENTY_FOUR_HOURS"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqWirelessConnectivityPerformanceResponse"}}}}},"security":[{"Bearer":[]}]}},"/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":{"type":"integer","format":"int32","default":1,"minimum":1}},{"name":"limit","in":"query","description":"Number of Records, min = 1, max = 100","required":false,"schema":{"type":"integer","format":"int32","default":10,"maximum":100,"minimum":1}},{"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","default":"DESC"}},{"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","default":"TWENTY_FOUR_HOURS"}},{"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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqCopilotWirelessEvent"}}}}},"security":[{"Bearer":[]}]}},"/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":{"type":"integer","format":"int32","default":1,"minimum":1}},{"name":"limit","in":"query","description":"Number of Records, min = 1, max = 100","required":false,"schema":{"type":"integer","format":"int32","default":10,"maximum":100,"minimum":1}},{"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","default":"QUALITY_INDEX"}},{"name":"sortOrder","in":"query","description":"The sorting order","required":false,"schema":{"$ref":"#/components/schemas/XiqSortOrder","default":"ASC"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqConnectivityExperienceData"}}}}},"security":[{"Bearer":[]}]}},"/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":{"type":"integer","format":"int32","default":1,"minimum":1}},{"name":"limit","in":"query","description":"Number of Records, min = 1, max = 100","required":false,"schema":{"type":"integer","format":"int32","default":10,"maximum":100,"minimum":1}},{"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","default":"DESC"}},{"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","default":"TWENTY_FOUR_HOURS"}},{"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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqCopilotWirelessEvent"}}}}},"security":[{"Bearer":[]}]}},"/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","default":"TWENTY_FOUR_HOURS"}},{"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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqWirelessAppsResponse"}}}}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqWiredQualityIndexResponse"}}}}},"security":[{"Bearer":[]}]}},"/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","default":"LOCATION"}},{"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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqWiredHardwareByLocationResponse"}}}}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqWiredHardwareResponse"}}}}},"security":[{"Bearer":[]}]}},"/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","default":"QUALITY_INDEX"}},{"name":"sortOrder","in":"query","description":"The sorting order","required":false,"schema":{"$ref":"#/components/schemas/XiqSortOrder","default":"ASC"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqConnectivityExperienceData"}}}}},"security":[{"Bearer":[]}]}},"/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","default":"INTERFACE_ERRORS"}},{"name":"sortOrder","in":"query","description":"The sorting order","required":false,"schema":{"$ref":"#/components/schemas/XiqSortOrder","default":"ASC"}},{"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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqWiredEventEntity"}}}}},"security":[{"Bearer":[]}]}},"/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","default":"QUALITY_INDEX"}},{"name":"sortOrder","in":"query","description":"The sorting order","required":false,"schema":{"$ref":"#/components/schemas/XiqSortOrder","default":"ASC"}},{"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","default":"TWENTY_FOUR_HOURS"}},{"name":"qualityIndex","in":"query","description":"The quality index value","required":false,"schema":{"$ref":"#/components/schemas/XiqQualityIndex"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqConnectivityExperienceData"}}}}},"security":[{"Bearer":[]}]}},"/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","default":"TWENTY_FOUR_HOURS"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqConnectivityDetailsByClientTypeResponse"}}}}},"security":[{"Bearer":[]}]}},"/copilot/assurance-scans/overview":{"get":{"tags":["Copilot - Anomalies"],"operationId":"getAssuranceScansOverviewData","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqAssuranceScansOverviewResponse"}}}}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqWifiEfficiencyStatsResponse"}}}}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqWifiEfficiencyClientListResponse"}}}}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqWifiCapacityStatsResponse"}}}}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqWifiCapacityClientListResponse"}}}}},"security":[{"Bearer":[]}]}},"/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","default":"TIME"}},{"name":"sortOrder","in":"query","description":"The sorting order","required":false,"schema":{"$ref":"#/components/schemas/XiqSortOrder","default":"ASC"}},{"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":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string","format":"binary"}}}}},"security":[{"Bearer":[]}]}},"/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"}},{"name":"offsetTime","in":"query","description":"The offset value","required":false,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqPortEfficiencyStatsResponse"}}}}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqPortEfficiencySpeedDuplexStatsResponse"}}}}},"security":[{"Bearer":[]}]}},"/copilot/anomalies/poeflapping/trends":{"get":{"tags":["Copilot - Anomalies"],"operationId":"getPoeFlappingTrends","parameters":[{"name":"anomalyId","in":"query","description":"The anomaly id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqPoeTrendGraphsResponse"}}}}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqPoeFlappingStatsResponse"}}}}},"security":[{"Bearer":[]}]}},"/copilot/anomalies/poeflapping/lldp-cdp-info":{"get":{"tags":["Copilot - Anomalies"],"operationId":"getLldpCdpInfo","parameters":[{"name":"anomalyType","in":"query","description":"The anomaly Type","required":true,"schema":{"$ref":"#/components/schemas/XiqAnomalyType"}},{"name":"anomalyId","in":"query","description":"The anomaly ID","required":true,"schema":{"type":"string"}},{"name":"deviceId","in":"query","description":"The device ID","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"lastDetectedTime","in":"query","description":"The last detected timestamp of anomaly","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqCopilotLldpCdpInfo"}}}}},"security":[{"Bearer":[]}]}},"/copilot/anomalies/notifications":{"get":{"tags":["Copilot - Anomalies"],"operationId":"getAnomaliesNotifications","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqAnomaliesNotificationsResponse"}}}}},"security":[{"Bearer":[]}]}},"/copilot/anomalies/missing-vlan/count":{"get":{"tags":["Copilot - Anomalies"],"operationId":"getMissingVlanAnomaliesCount","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":"vlanIds","in":"query","description":"The Vlan ids","required":true,"schema":{"type":"array","items":{"type":"integer","format":"int32"}}},{"name":"siteIds","in":"query","description":"The Site ids","required":true,"schema":{"type":"array","items":{"type":"integer","format":"int64"}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqMissingVlanAnomaliesCountResponse"}}}}},"security":[{"Bearer":[]}]}},"/copilot/anomalies/locations":{"get":{"tags":["Copilot - Anomalies"],"operationId":"listAnomalyLocations","parameters":[{"name":"anomalyType","in":"query","description":"Anomaly type","required":false,"schema":{"$ref":"#/components/schemas/XiqAnomalyType","default":"POE_STABILITY"}},{"name":"page","in":"query","description":"Page number, min = 1","required":false,"schema":{"type":"integer","format":"int32","default":1,"minimum":1}},{"name":"limit","in":"query","description":"Number of Records, min = 1, max = 100","required":false,"schema":{"type":"integer","format":"int32","default":10,"maximum":100,"minimum":1}},{"name":"sortField","in":"query","description":"sort by field","required":false,"schema":{"$ref":"#/components/schemas/XiqAnomalySortField","default":"TIME"}},{"name":"sortOrder","in":"query","description":"The sorting order","required":false,"schema":{"$ref":"#/components/schemas/XiqSortOrder","default":"ASC"}},{"name":"excludeMuted","in":"query","description":"exclude muted","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqCopilotPagedXiqAnomalyLocationEntity"}}}}},"security":[{"Bearer":[]}]}},"/copilot/anomalies/hardware-health/stats":{"get":{"tags":["Copilot - Anomalies"],"operationId":"getHardwareHealthStats","parameters":[{"name":"anomalyId","in":"query","description":"The anomaly id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqHardwareHealthStatsResponse"}}}}},"security":[{"Bearer":[]}]}},"/copilot/anomalies/hardware-health/cpu-mem-stats":{"get":{"tags":["Copilot - Anomalies"],"operationId":"getHardwareHealthCpuMemStats","parameters":[{"name":"deviceId","in":"query","description":"The device id","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"statsField","in":"query","description":"Field selector","required":true,"schema":{"$ref":"#/components/schemas/XiqAnomalyHhStatsType"}},{"name":"timestamp","in":"query","description":"The timestamp","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqHardwareHealthCpuMemStatsResponse"}}}}},"security":[{"Bearer":[]}]}},"/copilot/anomalies/hardware-health/client-list":{"get":{"tags":["Copilot - Anomalies"],"operationId":"getHardwareHealthClientList","parameters":[{"name":"deviceId","in":"query","description":"The device id","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"timestamp","in":"query","description":"The timestamp","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqHardwareHealthClientListResponse"}}}}},"security":[{"Bearer":[]}]}},"/copilot/anomalies/excluded-vlans-list":{"get":{"tags":["Copilot - Anomalies"],"operationId":"getMissingVlanExcludedVlanList","parameters":[{"name":"page","in":"query","description":"Page number, min =1","required":false,"schema":{"type":"integer","format":"int32","default":1,"minimum":1}},{"name":"limit","in":"query","description":"Number of Records, min = 1, max = 100","required":false,"schema":{"type":"integer","format":"int32","default":10,"maximum":100,"minimum":1}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqCopilotMissingVlanPagedXiqMissingVlanExcludedVlanList"}}}}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqDfsRecurenceCountStatsResponse"}}}}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqDfsRecurenceChannelStatsResponse"}}}}},"security":[{"Bearer":[]}]}},"/copilot/anomalies/devices-with-locations":{"get":{"tags":["Copilot - Anomalies"],"operationId":"getCopilotDevicesWithLocations","parameters":[{"name":"page","in":"query","description":"Page number, min = 1","required":false,"schema":{"type":"integer","format":"int32","default":1,"minimum":1}},{"name":"limit","in":"query","description":"Number of Records, min = 1, max = 100","required":false,"schema":{"type":"integer","format":"int32","default":10,"maximum":100,"minimum":1}},{"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","default":"TIME"}},{"name":"sortOrder","in":"query","description":"The sorting order","required":false,"schema":{"$ref":"#/components/schemas/XiqSortOrder","default":"ASC"}},{"name":"searchKey","in":"query","description":"The search key","required":false,"schema":{"type":"string","default":""}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqCopilotPagedXiqAnomalyDeviceWithLocation"}}}}},"security":[{"Bearer":[]}]}},"/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","default":"POE_STABILITY"}},{"name":"locationIds","in":"query","description":"The location IDs","required":true,"schema":{"type":"array","items":{"type":"integer","format":"int64"}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqAnomalyDevicesByLocationResponse"}}}}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqCopilotAnomaliesByCategory"}}}}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqAtpPacketCountsResponse"}}}}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqAtpDeviceStatsResponse"}}}}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqClient"}}}}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/XiqClientUsage"}}}}}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqClientSummary"}}}}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqClient"}}}}},"security":[{"Bearer":[]}]},"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":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/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":{"type":"integer","format":"int32","default":1,"minimum":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 100","required":false,"schema":{"type":"integer","format":"int32","default":10,"maximum":100,"minimum":1}},{"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","default":"ASC"}},{"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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqClient"}}}}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"integer","format":"int64"}}}}},"security":[{"Bearer":[]}]}},"/client-details/topology/client-trail/{macAddress}":{"get":{"tags":["Client - Details"],"operationId":"getConnectionTrail","parameters":[{"name":"macAddress","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqClientConnectionTrailResponse"}}}}},"security":[{"Bearer":[]}]}},"/client-details/overview/info/{clientId}":{"get":{"tags":["Client - Details"],"summary":"Get Client Details Info","description":"Get Client Details Info","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_client_details_info"},"operationId":"getClientDetailsInfo","parameters":[{"name":"clientId","in":"path","description":"The client 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"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqClientDetail"}}}}},"security":[{"Bearer":[]}]}},"/client-details/overview/chart-data/{clientId}":{"get":{"tags":["Client - Details"],"summary":"Get Client chart data","description":"Get Client chart data","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_client_connectivity_experience"},"operationId":"getClientChartData","parameters":[{"name":"clientId","in":"path","description":"The client 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":"precision","in":"query","description":"The precision in milliseconds since 1/1/1970","required":false,"schema":{"type":"integer","format":"int64","default":600000}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqClientChartDataList"}}}}},"security":[{"Bearer":[]}]}},"/client-details/client-trail/roaming-trail/grid/{clientId}":{"get":{"tags":["Client - Details"],"summary":"Get roaming trail grid","description":"get roaming trail grid","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_roaming_trail_grid"},"operationId":"getRoamingTrail","parameters":[{"name":"clientId","in":"path","description":"The client 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":"precision","in":"query","description":"The precision in milliseconds since 1/1/1970","required":false,"schema":{"type":"integer","format":"int64","default":600000}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqRoamingTrialList"}}}}},"security":[{"Bearer":[]}]}},"/client-details/client-trail/roaming-trail/count/{clientId}":{"get":{"tags":["Client - Details"],"summary":"Get roaming trail count","description":"get roaming trail count","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_roaming_trail_count"},"operationId":"getRoamingCount","parameters":[{"name":"clientId","in":"path","description":"The client 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":"precision","in":"query","description":"The precision in milliseconds since 1/1/1970","required":false,"schema":{"type":"integer","format":"int64","default":600000}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqRoamingTrialCount"}}}}},"security":[{"Bearer":[]}]}},"/client-details/client-trail/connectivity-experience/{clientId}":{"get":{"tags":["Client - Details"],"summary":"Get connectivity experience grid","description":"get connectivity experience grid","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_connectivity_experience_grid"},"operationId":"getConnectivityExperienceGrid","parameters":[{"name":"clientId","in":"path","description":"The client 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":"precision","in":"query","description":"The precision in milliseconds since 1/1/1970","required":false,"schema":{"type":"integer","format":"int64","default":600000}},{"name":"keyword","in":"query","description":"The case-insensitive keyword to search","required":false,"schema":{"type":"string","default":""}},{"name":"includeWired","in":"query","description":"Include Wired client","required":false,"schema":{"type":"boolean","default":false}},{"name":"onlyWired","in":"query","description":"Return only Wired","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqConnectivityExperienceList"}}}}},"security":[{"Bearer":[]}]}},"/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":{"type":"integer","format":"int32","default":1,"minimum":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 100","required":false,"schema":{"type":"integer","format":"int32","default":10,"maximum":100,"minimum":1}},{"name":"certType","in":"query","description":"The certificate type","required":false,"schema":{"$ref":"#/components/schemas/XiqCertificateType"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqCertificate"}}}}},"security":[{"Bearer":[]}]}},"/backup/history/grid":{"get":{"tags":["Account"],"summary":"List backup history grid","description":"List backup history grid","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_list_backup_history_grid"},"operationId":"listBackupHistory","parameters":[{"name":"page","in":"query","description":"Page number, min = 1","required":false,"schema":{"type":"integer","format":"int32","default":1,"minimum":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 10","required":false,"schema":{"type":"integer","format":"int32","default":10,"maximum":10,"minimum":1}},{"name":"keyword","in":"query","description":"The keyword to search - Display name","required":false,"schema":{"type":"string"}},{"name":"order","in":"query","description":"The sort order (descending by default) - on backup date","required":false,"schema":{"$ref":"#/components/schemas/XiqSortOrder","default":"DESC"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqBackupHistory"}}}}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"string"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"401":{"description":"UNAUTHORIZED","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}},"403":{"description":"Access denied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqError"}}}}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqApiTokenInfo"}}}}},"security":[{"Bearer":[]}]}},"/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":{"type":"integer","format":"int32","default":1,"minimum":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 100","required":false,"schema":{"type":"integer","format":"int32","default":10,"maximum":100,"minimum":1}},{"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","default":"ASC"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqApplication"}}}}},"security":[{"Bearer":[]}]}},"/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":{"type":"integer","format":"int32","maximum":100,"minimum":1}},{"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":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/XiqApplicationTopClientsUsage"}}}}}},"security":[{"Bearer":[]}]}},"/applications/usage/summary/meta-data":{"get":{"tags":["Application"],"summary":"Application usage summary meta data","description":"List the application usage summary meta data","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_list_the_application_usage_summary_meta_data"},"operationId":"listAppUsageSummaryMetaData","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqAppUsageSummaryMetaData"}}}}},"security":[{"Bearer":[]}]}},"/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":{"type":"integer","format":"int32","maximum":100,"minimum":1}},{"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":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/XiqTopApplicationsUsage"}}}}}},"security":[{"Bearer":[]}]}},"/applications/reports/{id}":{"get":{"tags":["Application"],"summary":"Download the Export CSV file","description":"Download the Export CSV file for Application Usage Summary","operationId":"downloadExportCsvFile_1","parameters":[{"name":"id","in":"path","description":"The report ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string","format":"byte"}}}}},"security":[{"Bearer":[]}]}},"/ap/afc/v2/floorReport/{deviceId}":{"get":{"tags":["afc-endpoint"],"operationId":"getRmAfcGeolocaitonFloorReport","parameters":[{"name":"deviceId","in":"path","description":"device Id","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqGetAfcGeolocationFloorReportResponse"}}}}},"security":[{"Bearer":[]}]}},"/ap/afc/interface/details/{sn}":{"get":{"tags":["afc-endpoint"],"summary":"Get Afc Summary Data","description":"Get Afc data per site ","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_basic_info"},"operationId":"getApsAfcInfo","parameters":[{"name":"sn","in":"path","description":"The Serial Number of the AP","required":true,"schema":{"type":"string"},"example":"AP-1234567890"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqAfcApDetail"}}}}},"security":[{"Bearer":[]}]}},"/ap/afc/floorReport/{deviceId}":{"get":{"tags":["afc-endpoint"],"operationId":"getAfcGeolocaitonFloorReport","parameters":[{"name":"deviceId","in":"path","description":"Owner Id","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqGetAfcGeolocationFloorReportResponse"}}}}},"security":[{"Bearer":[]}]}},"/ap/afc/diagnostics/{id}":{"get":{"tags":["afc-endpoint"],"operationId":"getApsAfcDiagnostics","parameters":[{"name":"ownerId","in":"query","description":"Owner Id","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"id","in":"path","description":"The device id of the AP","required":true,"schema":{"type":"integer","format":"int64"},"example":348802884147994}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqAfcApDiagnostics"}}}}},"security":[{"Bearer":[]}]}},"/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":{"type":"integer","format":"int32","default":1,"minimum":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 100","required":false,"schema":{"type":"integer","format":"int32","default":10,"maximum":100,"minimum":1}},{"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":"floorId","in":"query","description":"The floor id to filter","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"buildingId","in":"query","description":"The building 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","default":"TIMESTAMP"}},{"name":"order","in":"query","description":"The sort order (descending by default)","required":false,"schema":{"$ref":"#/components/schemas/XiqSortOrder","default":"DESC"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqAlert"}}}}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string","format":"byte"}}}}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/XiqAlertGroupCount"}}}}}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/XiqAlertSite"}}}}}},"security":[{"Bearer":[]}]}},"/airrm/site/{airrmId}":{"get":{"tags":["airrm-endpoint"],"summary":"Get Site Device Regulatory Config and AFC Spectrum","description":"Get AFC spectrum regulatory configuration for all devices in a site","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_site_device_regulatory_config_afc_spectrum"},"operationId":"getSiteDeviceRegulatoryConfigAfcSpectrum","parameters":[{"name":"airrmId","in":"path","description":"The AIRRM site ID","required":true,"schema":{"type":"integer","format":"int64"},"example":123}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XIQAirrmGetSiteDeviceRegulatoryConfigAfcSpectrumResponse"}}}}},"security":[{"Bearer":[]}]}},"/airrm/radio/apInfo/{radioMac}":{"get":{"tags":["airrm-endpoint"],"summary":"Get Device AP Information","description":"Get device AP information by radio MAC address","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_device_ap_info"},"operationId":"getDeviceApInfo","parameters":[{"name":"radioMac","in":"path","description":"The radio MAC address","required":true,"schema":{"type":"string","minLength":1},"example":"00:11:22:33:44:55"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XIQAirrmGetDeviceApInfoResponse"}}}}},"security":[{"Bearer":[]}]}},"/airrm/device/{serialNumber}":{"get":{"tags":["airrm-endpoint"],"summary":"Get Device Regulatory Config and AFC Spectrum","description":"Get AFC spectrum and regulatory configuration for a specific device","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_device_regulatory_config_afc_spectrum"},"operationId":"getDeviceRegulatoryConfigAfcSpectrum","parameters":[{"name":"serialNumber","in":"path","description":"The device serial number","required":true,"schema":{"type":"string","minLength":1},"example":"AP123456789"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XIQAirrmGetDeviceRegulatoryConfigAfcSpectrumResponse"}}}}},"security":[{"Bearer":[]}]}},"/afcserver":{"get":{"tags":["afc-endpoint"],"summary":"Get Afc Server list and their status","description":"Get all Afc Servers data","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_basic_info"},"operationId":"listAfcServers","parameters":[{"name":"ownerId","in":"query","description":"Owner Id","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqListAfcServers"}}}}},"security":[{"Bearer":[]}]}},"/afcserver/{server_id}":{"get":{"tags":["afc-endpoint"],"summary":"Get Afc Server data","description":"Get Afc Server data","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_basic_info"},"operationId":"getAfcServer","parameters":[{"name":"server_id","in":"path","description":"The Id of the server","required":true,"schema":{"type":"integer","format":"int64"},"example":1234567890}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqAfcServer"}}}}},"security":[{"Bearer":[]}]}},"/afcserver/statistics/{server_id}":{"get":{"tags":["afc-endpoint"],"summary":"Get AFC server Statistics","description":"Get AFC server Statistics","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_afc_server_statistics"},"operationId":"getAfcServerStatistics","parameters":[{"name":"server_id","in":"path","description":"The Id of the server","required":true,"schema":{"type":"integer","format":"int64"},"example":1234567890},{"name":"startTime","in":"query","description":"Query Start Time","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"endTime","in":"query","description":"Query End Time","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"precision","in":"query","description":"precision specified in seconds","required":false,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqAfcServersStatistics"}}}}},"security":[{"Bearer":[]}]}},"/afc/reports/{id}":{"get":{"tags":["afc-endpoint"],"summary":"Download the  report","description":"Download report of Metrics","operationId":"downloadHealthReport","parameters":[{"name":"id","in":"path","description":"The report ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string","format":"byte"}}}}},"security":[{"Bearer":[]}]}},"/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":{"type":"integer","format":"int32","default":1,"minimum":1}},{"name":"limit","in":"query","description":"Page Size, min = 1, max = 100","required":false,"schema":{"type":"integer","format":"int32","default":10,"maximum":100,"minimum":1}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedXiqActiveDirectoryServer"}}}}},"security":[{"Bearer":[]}]}},"/acct-api-token/export":{"get":{"tags":["Administration"],"summary":"Export all API access tokens to CSV","description":"Export all API access tokens to a CSV file.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_export_api_access_tokens"},"operationId":"exportToCsv_6","parameters":[{"name":"order","in":"query","description":"The sort order (descending by default)","required":false,"schema":{"$ref":"#/components/schemas/XiqSortOrder","default":"DESC"}},{"name":"keyword","in":"query","description":"The keyword - application name or grantor","required":false,"schema":{"type":"string"}},{"name":"sortField","in":"query","description":"The sort field","required":false,"schema":{"$ref":"#/components/schemas/XiqApiAccessTokenSortField"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string","format":"byte"}}}}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqViq"}}}}},"security":[{"Bearer":[]}]}},"/account/viq/export-import-status":{"get":{"tags":["Account"],"summary":"Get running export/import status ","description":"This is used check the live status of VIQ export or import","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_viq_export_import_status"},"operationId":"exportImportStatus","parameters":[{"name":"viqOperationType","in":"query","description":"Select the type of operation to get status ","required":true,"schema":{"$ref":"#/components/schemas/XiqViqOperationType"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqViqExportImportStatusResponse"}}}}},"security":[{"Bearer":[]}]}},"/account/viq/download":{"get":{"tags":["Account"],"summary":"Download VIQ data file and logs","description":"This is used to download the VIQ export data or export/import logs","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_viq_download"},"operationId":"downloadViqReport","parameters":[{"name":"reportName","in":"query","description":"The report full name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string","format":"byte"}}}}},"security":[{"Bearer":[]}]}},"/account/viq/backup/status":{"get":{"tags":["Account"],"summary":"Get VIQ Backup Status","description":"Returns IDLE, IN_PROGRESS, COMPLETED or FAILED. Safe to call during an active backup.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_viq_backup_status"},"operationId":"get_viq_backup_status","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqBackupStatus"}}}}},"security":[{"Bearer":[]}]}},"/account/vhm/status":{"get":{"tags":["Account"],"summary":"Get Vhm Status","description":"Get an existing Vhm Status.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_vhm_status"},"operationId":"getVhmStatus","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqVhmStatus"}}}}},"security":[{"Bearer":[]}]}},"/account/vhm/setting":{"get":{"tags":["Account"],"summary":"Get Vhm Setting","description":"Get an existing Vhm Settings.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_vhm_setting"},"operationId":"getVhmSetting","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqVhmSettingInfo"}}}}},"security":[{"Bearer":[]}]}},"/account/third-party-applications":{"get":{"tags":["Account"],"summary":"List Third Party Applications","description":"List a page of Third Party Applications.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_get_third_party_applications"},"operationId":"getApiAccessTokens","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/XiqThirdPartyApplication"}}}}}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XiqAccount"}}}}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/XiqExternalAccount"}}}}}},"security":[{"Bearer":[]}]}},"/subscriptions/webhook/:delete":{"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":"ids","in":"query","description":"The Webhook subscription IDs","required":true,"schema":{"type":"array","items":{"type":"integer","format":"int64"}}}],"responses":{"202":{"description":"Accepted"}},"security":[{"Bearer":[]}]}},"/rtts/{id}":{"delete":{"tags":["rtts-endpoint"],"operationId":"DeleteRttsSession","parameters":[{"name":"ownerId","in":"query","description":"Owner Id","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"id","in":"path","description":"The session id","required":true,"schema":{"type":"string"},"example":1234567890}],"responses":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/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":{"202":{"description":"Accepted"}},"security":[{"Bearer":[]}]}},"/ng-reports/scheduled/runs":{"delete":{"tags":["NG Reports (Scheduled)"],"summary":"Delete report runs","description":"Bulk delete report runs by IDs.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_delete_report_runs"},"operationId":"deleteReportRuns","parameters":[{"name":"reportRunsIds","in":"query","description":"List of report run IDs to delete","required":true,"schema":{"type":"array","items":{"type":"integer","format":"int64"}}}],"responses":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/network-services/{id}":{"delete":{"tags":["Configuration - Network"],"summary":"Delete Network Services","description":"Delete specific Network Services.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_delete_network_services"},"operationId":"deleteNetworkService","parameters":[{"name":"id","in":"path","description":"The Network Service ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/locations/folder/zone/{id}":{"delete":{"tags":["Location"],"summary":"Delete a zone by ID","description":"Delete a zone for the specified ID.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_delete_zone"},"operationId":"deleteZone","parameters":[{"name":"id","in":"path","description":"The Zone ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"204":{"description":"No Content"}},"security":[{"Bearer":[]}]}},"/locations/floor/{floorId}/label/{labelId}":{"delete":{"tags":["Location"],"summary":"Deletes one floor map label","description":"Deletes one floor map label, given by its id, on condition it references the floor given by its id.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_delete_one_label"},"operationId":"deleteFloorMapLabel","parameters":[{"name":"floorId","in":"path","description":"The Floor ID","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"labelId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/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":{"204":{"description":"No Content"}},"security":[{"Bearer":[]}]}},"/floor/afc/details/{id}":{"delete":{"tags":["afc-endpoint"],"operationId":"deleteFloorAfcDetails","parameters":[{"name":"ownerId","in":"query","description":"Owner Id","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/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":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/certificates/{id}":{"delete":{"tags":["Configuration - Certificate"],"summary":"Delete Certificate by ID","description":"Delete the existing Certificate by the ID.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_delete_certificate"},"operationId":"deleteCertificate","parameters":[{"name":"id","in":"path","description":"The Certificate ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/backup/history/delete":{"delete":{"tags":["Account"],"summary":"Backup History Delete","description":"Delete Backup History by backup files.","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_backup_history_delete"},"operationId":"deleteBackup","parameters":[{"name":"backupFiles","in":"query","description":"The list of backup files (comma-separated) that need to be deleted.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}},"/acct-api-token/:delete":{"delete":{"tags":["Administration"],"summary":"Bulk Delete API Access token by ID","description":"Bulk Delete API Access token by ID","externalDocs":{"description":"API Reference","url":"https://extremecloudiq.com/api-docs/api-reference.html#_delete_api_access_tokens"},"operationId":"bulkDeleteApiAccessToken","parameters":[{"name":"ids","in":"query","description":"The API Access Token IDs","required":true,"schema":{"type":"array","items":{"type":"integer","format":"int64"}}}],"responses":{"200":{"description":"OK"}},"security":[{"Bearer":[]}]}}},"components":{"schemas":{"XiqDateTimeType":{"type":"object","properties":{"day_of_month":{"type":"integer","format":"int32","description":"The day of month"},"month":{"type":"integer","format":"int32","description":"The month"},"year":{"type":"integer","format":"int32","description":"The year"},"hour_of_day":{"type":"integer","format":"int32","description":"The 24-hour format hour of day"},"minute_of_hour":{"type":"integer","format":"int32","description":"The minute of the hour"}},"required":["day_of_month","hour_of_day","minute_of_hour","month","year"]},"XiqDateTimeUnitType":{"type":"string","enum":["MINUTE","HOUR","DAY","WEEK"]},"XiqDeliverySettings":{"type":"object","properties":{"email_template_id":{"type":"integer","format":"int64","description":"The Email Template ID"},"sms_template_id":{"type":"integer","format":"int64","description":"The SMS Template ID "}}},"XiqExpirationActionType":{"type":"string","enum":["SHOW_MESSAGE","REJECT_ACCESS"]},"XiqExpirationSettings":{"type":"object","properties":{"expiration_type":{"$ref":"#/components/schemas/XiqExpirationType","description":"The for one of the account experation types."},"valid_during_dates":{"$ref":"#/components/schemas/XiqValidDuringDateSettings","description":"The settings for Valid During Dates option or null for other settings."},"valid_for_time_period":{"$ref":"#/components/schemas/XiqValidForTimePeriodSettings","description":"The settings for Valid For Time Period option or null for other settings."},"valid_daily":{"$ref":"#/components/schemas/XiqValidDailySettings","description":"The settings for Valid Daily option or null for other settings."},"expiration_action":{"$ref":"#/components/schemas/XiqExpirationActionType","description":"The Expiration Action to take, null if the account is never expired."},"post_expiration_action":{"$ref":"#/components/schemas/XiqPostExpirationAction","description":"The type of action to take after the account expiration."}}},"XiqExpirationType":{"type":"string","enum":["NEVER_EXPIRE","VALID_DURING_DATES","VALID_FOR_TIME_PERIOD","DAILY"]},"XiqPasswordCharacterType":{"type":"string","enum":["INCLUDE_ALL_CHARACTER_TYPE_ENABLED","INCLUDE_ANY_CHARACTER_TYPES_ENABLED","INCLUDE_ONLY_ONE_CHARACTER_TYPE_ENABLED"]},"XiqPasswordDbLocation":{"type":"string","enum":["CLOUD","LOCAL"]},"XiqPasswordSettings":{"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","description":"The psk generation method"},"password_character_types":{"$ref":"#/components/schemas/XiqPasswordCharacterType","description":"Password generation using letters, numbers, and/or special characters"},"password_length":{"type":"integer","format":"int32","description":"The maximun password string length"}},"required":["password_character_types","password_length","psk_generation_method"]},"XiqPasswordType":{"type":"string","enum":["PPSK","RADIUS"]},"XiqPcgType":{"type":"string","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","format":"int32","description":"The after expiration scheduled time to delete or null to not delete.."},"delete_after_unit":{"$ref":"#/components/schemas/XiqDateTimeUnitType","description":"The after expiration scheduled time unit."}}},"XiqPskGenerationMethod":{"type":"string","enum":["PASSWORD_ONLY","USER_STRING_PASSWORD"]},"XiqUpdateUserGroupRequest":{"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","description":"The access key storage location"},"ppsk_use_only":{"type":"boolean","description":"Whether it's for PPSK use only"},"password_type":{"$ref":"#/components/schemas/XiqPasswordType","description":"The access key type"},"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","format":"int32","description":"The maximum number of clients per private PSK"},"pcg_use_only":{"type":"boolean","description":"Whether it's for PCG use only"},"pcg_type":{"$ref":"#/components/schemas/XiqPcgType","description":"The private client group type for pcgUseOnly"},"enable_cwp_reg":{"type":"boolean","description":"Whether to enable CWP registration setting"},"password_settings":{"$ref":"#/components/schemas/XiqPasswordSettings","description":"The password settings ID"},"expiration_settings":{"$ref":"#/components/schemas/XiqExpirationSettings","description":"The password expiration settings"},"delivery_settings":{"$ref":"#/components/schemas/XiqDeliverySettings","description":"The password delivery settings"}},"required":["delivery_settings","expiration_settings","name","password_db_location","password_settings","password_type"]},"XiqValidDailySettings":{"type":"object","properties":{"daily_start_hour":{"type":"integer","format":"int32","description":"The 24-hour format start hour of the day"},"daily_start_minute":{"type":"integer","format":"int32","description":"The minute of the hour"},"daily_end_hour":{"type":"integer","format":"int32","description":"The 24-hour format end hour of day the end"},"daily_end_minute":{"type":"integer","format":"int32","description":"The minute of the hour"}},"required":["daily_end_hour","daily_end_minute","daily_start_hour","daily_start_minute"]},"XiqValidDuringDateSettings":{"type":"object","properties":{"start_date_time":{"$ref":"#/components/schemas/XiqDateTimeType","description":"The start date and time"},"end_date_time":{"$ref":"#/components/schemas/XiqDateTimeType","description":"The end date and time"},"time_zone":{"type":"string","description":"The date/time timezone"}},"required":["end_date_time","start_date_time","time_zone"]},"XiqValidForTimePeriodSettings":{"type":"object","properties":{"valid_time_period_after":{"$ref":"#/components/schemas/XiqValidTimePeriodAfterType","description":"The valid time period after Id creation or first login."},"after_id_creation_settings":{"$ref":"#/components/schemas/XiqValidTimePeriodAfterIdCreation","description":"The settings for the valid time period after ID Creation option or null for the other option"},"after_first_login_settings":{"$ref":"#/components/schemas/XiqValidTimePeriodAfterFirstLogin","description":"The settings for the valid time period after First Login option or null for the other option"}},"required":["valid_time_period_after"]},"XiqValidTimePeriodAfterFirstLogin":{"type":"object","properties":{"valid_time_period":{"type":"integer","format":"int32","description":"The valid time period after the first login"},"valid_time_period_unit":{"$ref":"#/components/schemas/XiqDateTimeUnitType","description":"The time period unit"},"first_login_within":{"type":"integer","format":"int32","description":"The first time the access key must be used"},"first_login_within_unit":{"$ref":"#/components/schemas/XiqDateTimeUnitType","description":"The access key must use time unit"}},"required":["first_login_within","first_login_within_unit","valid_time_period","valid_time_period_unit"]},"XiqValidTimePeriodAfterIdCreation":{"type":"object","properties":{"valid_time_period":{"type":"integer","format":"int32","description":"The valid time period after account creation"},"valid_time_period_unit":{"$ref":"#/components/schemas/XiqDateTimeUnitType","description":"The time period unit"}},"required":["valid_time_period","valid_time_period_unit"]},"XiqValidTimePeriodAfterType":{"type":"string","enum":["ID_CREATION","FIRST_LOGIN"]},"XiqUserGroup":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"The unique identifier"},"create_time":{"type":"string","format":"date-time","description":"The create time in UTC (ISO 8601 format)"},"update_time":{"type":"string","format":"date-time","description":"The last update time in UTC (ISO 8601 format)"},"org_id":{"type":"integer","format":"int64","description":"The organization identifier, valid when enabling HIQ feature"},"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","description":"The access key storage location"},"password_type":{"$ref":"#/components/schemas/XiqPasswordType","description":"The access key type"},"pcg_use_only":{"type":"boolean","description":" Whether it's for PCG use only"},"pcg_type":{"$ref":"#/components/schemas/XiqPcgType","description":"The private client group type for pcgUseOnly"},"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","description":"The password settings"},"expiration_settings":{"$ref":"#/components/schemas/XiqExpirationSettings","description":"The password expiration settings"},"delivery_settings":{"$ref":"#/components/schemas/XiqDeliverySettings","description":"The password delivery settings"},"user_count":{"type":"integer","format":"int32","description":"The user count"},"ssids":{"type":"array","description":"The ssids","items":{"type":"string"}}},"required":["create_time","delivery_settings","expiration_settings","id","name","password_db_location","password_settings","password_type","predefined","ssids","update_time","user_count"]},"XiqUpdateUserProfileRequest":{"type":"object","properties":{"name":{"type":"string","description":"The user profile name"},"vlan_profile_id":{"type":"integer","format":"int64","description":"The VLAN profile id"}}},"XiqClassification":{"type":"object","description":"The payload of common object - classification","properties":{"id":{"type":"integer","format":"int64","description":"The unique identifier"},"create_time":{"type":"string","format":"date-time","description":"The create time in UTC (ISO 8601 format)"},"update_time":{"type":"string","format":"date-time","description":"The last update time in UTC (ISO 8601 format)"},"classification_type":{"$ref":"#/components/schemas/XiqClassificationType","description":"Classification type"},"match":{"type":"boolean","description":"Contains or not contains)"},"classification_id":{"type":"integer","format":"int64","description":"The ID of location, cloud config group, IP address, IP subnet or IP range."},"value":{"type":"string","description":"The MAC address in format 'AABBCCDDEEFF' without separators. Accepted formats: (1) OUI only — first 6 hex characters (e.g., 'AABBCC'), (2) Full MAC address — 12 hex characters (e.g., 'AABBCCDDEEFF').","example":"AABBCCDDEEFF"}},"required":["classification_id","classification_type","create_time","id","match","update_time","value"]},"XiqClassificationRule":{"type":"object","description":"The payload of common object - classification assignment","properties":{"id":{"type":"integer","format":"int64","description":"The unique identifier"},"create_time":{"type":"string","format":"date-time","description":"The create time in UTC (ISO 8601 format)"},"update_time":{"type":"string","format":"date-time","description":"The last update time in UTC (ISO 8601 format)"},"org_id":{"type":"integer","format":"int64","description":"The organization identifier, valid when enabling HIQ feature"},"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"}}},"required":["create_time","id","name","update_time"]},"XiqClassificationType":{"type":"string","description":"The classification type for VLAN assignment. LOCATION: Classify based on device location (e.g., floor, building). CLOUD_CONFIG_GROUP: Classify based on cloud configuration groups. IP_ADDRESS: Classify based on specific IP addresses. IP_SUBNET: Classify based on IP subnet ranges (e.g., 192.168.1.0/24). IP_RANGE: Classify based on IP address ranges (e.g., 192.168.1.1-192.168.1.100).","enum":["LOCATION","CLOUD_CONFIG_GROUP","IP_ADDRESS","IP_SUBNET","IP_RANGE"]},"XiqUserProfile":{"type":"object","description":"The payload of User Profile","properties":{"id":{"type":"integer","format":"int64","description":"The unique identifier"},"create_time":{"type":"string","format":"date-time","description":"The create time in UTC (ISO 8601 format)"},"update_time":{"type":"string","format":"date-time","description":"The last update time in UTC (ISO 8601 format)"},"name":{"type":"string","description":"The user profile name"},"vlan_profile":{"$ref":"#/components/schemas/XiqVlanProfile","description":"The VLAN profile"}},"required":["create_time","id","name","update_time"]},"XiqVlanObjectClassifiedEntry":{"type":"object","description":"The payload of VLAN object classified entry","properties":{"id":{"type":"integer","format":"int64","description":"The unique identifier"},"create_time":{"type":"string","format":"date-time","description":"The create time in UTC (ISO 8601 format)"},"update_time":{"type":"string","format":"date-time","description":"The last update time in UTC (ISO 8601 format)"},"org_id":{"type":"integer","format":"int64","description":"The organization identifier, valid when enabling HIQ feature"},"vlan_id":{"type":"integer","format":"int32","description":"The VLAN ID","maximum":4094,"minimum":1},"classification_rule":{"$ref":"#/components/schemas/XiqClassificationRule","description":"The classification rule"}},"required":["create_time","id","update_time","vlan_id"]},"XiqVlanProfile":{"type":"object","description":"The payload of common object - VLAN profile","properties":{"id":{"type":"integer","format":"int64","description":"The unique identifier"},"create_time":{"type":"string","format":"date-time","description":"The create time in UTC (ISO 8601 format)"},"update_time":{"type":"string","format":"date-time","description":"The last update time in UTC (ISO 8601 format)"},"org_id":{"type":"integer","format":"int64","description":"The organization identifier, valid when enabling HIQ feature"},"name":{"type":"string","description":"The VLAN profile name"},"default_vlan_id":{"type":"integer","format":"int32","description":"The default VLAN ID","maximum":4094,"minimum":1},"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"}}},"required":["create_time","default_vlan_id","enable_classification","id","name","update_time"]},"XiqMulticastRule":{"type":"object","properties":{"ip":{"type":"string","description":"IP address/CIDR of listening interface.","minLength":1}},"required":["ip"]},"XiqTunnelConcentratorRequest":{"type":"object","properties":{"name":{"type":"string","description":" The Tunnel Concentrator Service name","minLength":1},"description":{"type":"string","description":" The Tunnel Concentrator Service description","minLength":1},"redundant":{"type":"boolean","description":"Indicates if redundant Tunnel Concentrators (primary and backup) are configured "},"primary_tc":{"type":"integer","format":"int64","description":" The Primary Tunnel Concentrator device ID"},"backup_tc":{"type":"integer","format":"int64","description":"The Backup Tunnel Concentrator device ID"},"primary_listening_interface":{"type":"integer","format":"int32","description":"Primary Listening Interface ID.","maximum":4,"minimum":1},"backup_listening_interface":{"type":"integer","format":"int32","description":"Backup Listening Interface ID.","maximum":4,"minimum":1},"primary_bridging_interface":{"type":"integer","format":"int32","description":"Primary Bridging Interface ID.","maximum":4,"minimum":1},"backup_bridging_interface":{"type":"integer","format":"int32","description":"Backup Bridging Interface ID.","maximum":4,"minimum":1},"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":{"type":"integer","format":"int32","description":"The VLAN ID for the primary listening interface","maximum":4094,"minimum":1},"backup_vlan":{"type":"integer","format":"int32","description":"The VLAN ID for the backup listening interface","maximum":4094,"minimum":1},"primary_tagged":{"type":"boolean","description":"Indicates if primary VLAN is tagged."},"backup_tagged":{"type":"boolean","description":"Indicates if backup VLAN is tagged"},"tunnel_address":{"type":"string","description":"IP address/CIDR of listening interface.","minLength":1,"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])$"},"router_id":{"type":"integer","format":"int32","description":"Virtual Router group ID"},"gateway":{"type":"string","description":"The TunnelConcentrator optional gateway ip address"},"native_vlan":{"type":"integer","format":"int32","description":"Specifies which VLAN ID is transmitted untagged on the bridged interface.","maximum":4094,"minimum":1},"block_non_essential_broadcast":{"type":"boolean","description":"Indicates if Tunnel Concentrator will block non essential broadcast"},"arp_proxy":{"type":"boolean","description":"Indicates if arp proxy is enabled"},"internal_mgmt_vlan":{"type":"integer","format":"int32","description":"Internal management VLAN ID","maximum":4094,"minimum":1},"keep_alive_interval":{"type":"integer","format":"int32","description":"Keep-alive interval in seconds","maximum":60,"minimum":1},"keep_alive_retries":{"type":"integer","format":"int32","description":"Keep-alive retry count","maximum":10,"minimum":1},"multicast_rules":{"type":"array","description":"Multicast rules","items":{"$ref":"#/components/schemas/XiqMulticastRule"}}},"required":["description","name","native_vlan","primary_bridging_interface","primary_listening_interface","primary_tagged","primary_tc","primary_vlan","tunnel_address"]},"XiqTunnelConcentrator":{"type":"object","description":"The payload of Tunnel Concentrator","properties":{"id":{"type":"integer","format":"int64","description":"The unique identifier"},"create_time":{"type":"string","format":"date-time","description":"The create time in UTC (ISO 8601 format)"},"update_time":{"type":"string","format":"date-time","description":"The last update time in UTC (ISO 8601 format)"},"name":{"type":"string","description":" The Tunnel Concentrator Service name","minLength":1},"description":{"type":"string","description":" The Tunnel Concentrator Service description","minLength":1},"redundant":{"type":"boolean","description":"Indicates if redundant Tunnel Concentrators (primary and backup) are configured "},"primary_tc":{"type":"integer","format":"int64","description":" The Primary Tunnel Concentrator device ID"},"backup_tc":{"type":"integer","format":"int64","description":"The Backup Tunnel Concentrator device ID"},"primary_listening_interface":{"type":"integer","format":"int32","description":"Primary Listening Interface ID.","maximum":6,"minimum":1},"backup_listening_interface":{"type":"integer","format":"int32","description":"Backup Listening Interface ID.","maximum":6,"minimum":1},"primary_bridging_interface":{"type":"integer","format":"int32","description":"Primary Bridging Interface ID.","maximum":6,"minimum":1},"backup_bridging_interface":{"type":"integer","format":"int32","description":"Backup Bridging Interface ID.","maximum":6,"minimum":1},"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":{"type":"integer","format":"int32","description":"The VLAN ID for the primary listening interface","maximum":4094,"minimum":1},"backup_vlan":{"type":"integer","format":"int32","description":"The VLAN ID for the backup listening interface","maximum":4094,"minimum":1},"primary_tagged":{"type":"boolean","description":"Indicates if primary VLAN is tagged."},"backup_tagged":{"type":"boolean","description":"Indicates if backup VLAN is tagged"},"tunnel_address":{"type":"string","description":"IP address/CIDR of listening interface.","minLength":1,"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])$"},"router_id":{"type":"integer","format":"int32","description":"Virtual Router group ID"},"gateway":{"type":"string","description":"The TunnelConcentrator optional gateway ip address"},"native_vlan":{"type":"integer","format":"int32","description":"Specifies which VLAN ID is transmitted untagged on the bridged interface.","maximum":4094,"minimum":1},"block_non_essential_broadcast":{"type":"boolean","description":"Indicates if Tunnel Concentrator will block non essential broadcast"},"arp_proxy":{"type":"boolean","description":"Indicates if arp proxy is enabled"},"internal_mgmt_vlan":{"type":"integer","format":"int32","description":"Internal management VLAN ID","maximum":4094,"minimum":1},"keep_alive_interval":{"type":"integer","format":"int32","description":"Keep-alive interval in seconds","maximum":60,"minimum":1},"keep_alive_retries":{"type":"integer","format":"int32","description":"Keep-alive retry count","maximum":10,"minimum":1},"multicast_rules":{"type":"array","description":"Multicast rules","items":{"$ref":"#/components/schemas/XiqMulticastRule"}}},"required":["create_time","description","id","name","native_vlan","primary_bridging_interface","primary_listening_interface","primary_tagged","primary_tc","primary_vlan","tunnel_address","update_time"]},"XiqUpdateThirdPartyApiConnectionRequest":{"type":"object","properties":{"api_token":{"type":"string","description":"The api token."}}},"XiqThirdPartyApiConnection":{"type":"object","description":"The 3rd party API connections data model","properties":{"api_token":{"type":"string","description":"The api token."},"created_at":{"type":"integer","format":"int64","description":"The api token create time."}}},"XiqSubscriptionMessageType":{"type":"string","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"]},"XiqSubscriptionStatus":{"type":"string","enum":["ENABLED","DISABLED"]},"XiqUpdateWebhookSubscriptionRequest":{"type":"object","description":"The payload to update webhook subscription","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 subscription message type.","example":"LOCATION_AP_CENTRIC"},"status":{"$ref":"#/components/schemas/XiqSubscriptionStatus","description":"The webhook subscription status."}},"required":["application","message_type","status","url"]},"XiqSubscriptionDataType":{"type":"string","enum":["LOCATION","AUDIT_LOG","GDPR_LOG","CREDENTIAL_LOG","ACCOUNTING_LOG","AUTHENTICATION_LOG","EMAIL_LOG","SMS_LOG"]},"XiqWebhookSubscription":{"type":"object","description":"The webhook subscription data model","properties":{"id":{"type":"integer","format":"int64","description":"The unique identifier"},"create_time":{"type":"string","format":"date-time","description":"The create time in UTC (ISO 8601 format)"},"update_time":{"type":"string","format":"date-time","description":"The last update time in UTC (ISO 8601 format)"},"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","description":"The webhook subscription data type."},"message_type":{"$ref":"#/components/schemas/XiqSubscriptionMessageType","description":"The webhook subscription message type."},"status":{"$ref":"#/components/schemas/XiqSubscriptionStatus","description":"The webhook subscription status."}},"required":["application","create_time","data_type","id","message_type","secret","status","update_time","url"]},"XiqSetSsidModeWepRequest":{"type":"object","description":"The request for setting the SSID to be WEP mode.","properties":{"key_management":{"$ref":"#/components/schemas/XiqSsidWepKeyManagement","description":"The key management type, WEP or WEP_8021X","example":"WEP_8021X"},"encryption_method":{"$ref":"#/components/schemas/XiqSsidWepEncryptionMethod","description":"The encryption method type, WEP104 or WEP40","example":"WEP104"},"authentication_method":{"$ref":"#/components/schemas/XiqSsidWepAuthenticationMethod","description":"The authentication method type, OPEN or SHARED"},"default_key":{"$ref":"#/components/schemas/XiqSsidWepDefaultKey","description":"The default key, FIRST, SECOND,THIRD, OR FOURTH","example":"FIRST"},"key_type":{"$ref":"#/components/schemas/XiqSsidKeyType","description":"The key type, ASCII or HEX","example":"ASCII"},"key_value":{"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","maxLength":13,"minLength":5},"key_value2":{"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","maxLength":13,"minLength":5},"key_value3":{"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","maxLength":13,"minLength":5},"key_value4":{"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","maxLength":13,"minLength":5},"radius_server_group_id":{"type":"integer","format":"int64","description":"The RADIUS server group ID if using WEP_8021x as the key management"}},"required":["encryption_method","key_management"]},"XiqSsidKeyType":{"type":"string","enum":["ASCII","HEX"]},"XiqSsidWepAuthenticationMethod":{"type":"string","enum":["OPEN","SHARED"]},"XiqSsidWepDefaultKey":{"type":"string","enum":["FIRST","SECOND","THIRD","FOURTH"]},"XiqSsidWepEncryptionMethod":{"type":"string","enum":["WEP40","WEP104"]},"XiqSsidWepKeyManagement":{"type":"string","enum":["WEP","WEP_8021X"]},"XiqSetSsidModePskRequest":{"type":"object","description":"The request for setting the SSID to be PSK mode.","properties":{"key_management":{"$ref":"#/components/schemas/XiqSsidPskKeyManagement","description":"The key management: WPA3_PSK, WPA2_PSK, WPA_PSK,AUTO_PSK"},"encryption_method":{"$ref":"#/components/schemas/XiqSsidPskEncryptionMethod","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"},"anti_logging_threshold":{"type":"integer","format":"int32","description":"The anti logging threshold"},"key_type":{"$ref":"#/components/schemas/XiqSsidKeyType","description":"The PSK key type, ASCII or HEX"},"key_value":{"type":"string","description":"The PSK key value, minimum 8 characters long","maxLength":2147483647,"minLength":8},"sae_group":{"$ref":"#/components/schemas/XiqSsidSaeGroup","description":"The SAE group: ALL, ECC, or FFC, must be selected when the key management is WPA3"},"transition_mode":{"type":"boolean","description":"Indicates the transition mode if key management is WPA3"}},"required":["encryption_method","key_management","key_type","key_value"]},"XiqSsidPskEncryptionMethod":{"type":"string","enum":["CCMP","TKIP","AUTO_TKIP_CCMP"]},"XiqSsidPskKeyManagement":{"type":"string","enum":["WPA_PSK","WPA2_PSK","WPA3_PSK","AUTO_PSK"]},"XiqSsidSaeGroup":{"type":"string","enum":["ALL","ECC","FFC"]},"XiqSetSsidModePpskRequest":{"type":"object","description":"The request for setting the SSID to be PPSK mode.","properties":{"key_management":{"$ref":"#/components/schemas/XiqSsidPpskKeyManagement","description":"The key management: WPA2_PSK, WPA_PSK,AUTO_PSK"},"encryption_method":{"$ref":"#/components/schemas/XiqSsidPskEncryptionMethod","description":"The encryption method: for WPA2_PSK or WPA_PSK, please use CCMP or TKIP, for AUTO_PSK, please use AUTO_TKIP_CCMP"},"user_group_ids":{"type":"array","description":"The user group IDs to be attached to the SSID, cannot be empty","items":{"type":"integer","format":"int64"}},"enable_max_clients_per_ppsk":{"type":"boolean","description":"Flag for enabling the max clients per PPSK"},"max_clients_per_ppsk":{"type":"integer","format":"int32","description":"The max clients (0-15) per PPSK if enabled enable_max_clients_per_ppsk flag, 0 means unlimited","maximum":15,"minimum":0},"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":{"type":"integer","format":"int32","description":"Set the max MAC binding numbers per private PSK, Min:1, Max:5","maximum":5,"minimum":1},"ppsk_server_id":{"type":"integer","format":"int64","description":"The PPSK server device ID"}},"required":["enable_mac_bind","enable_max_clients_per_ppsk","encryption_method","key_management","user_group_ids"]},"XiqSsidPpskKeyManagement":{"type":"string","enum":["WPA_PSK","WPA2_PSK","AUTO_PSK"]},"XiqSetSsidModeDot1xRequest":{"type":"object","description":"The request for setting the SSID to be 802.1x mode.","properties":{"key_management":{"$ref":"#/components/schemas/XiqSsidDot1xKeyManagement","description":"The key management: WPA_8021X, WPA2_8021X, WPA3_8021X or AUTO_8021X","example":"WPA3_8021X"},"encryption_method":{"$ref":"#/components/schemas/XiqSsidDot1xEncryptionMethod","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"},"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","format":"int64","description":"The RADIUS server group ID if not using ExtremeCloud IQ Authentication Service"},"user_group_ids":{"type":"array","description":"The user group IDs if using ExtremeCloud IQ Authentication Service","items":{"type":"integer","format":"int64"}},"enable_uztna":{"type":"boolean","description":"Flag for using Authentication with ExtremeCloud Universal ZTNA or not"}},"required":["enable_idm","encryption_method","key_management"]},"XiqSsidDot1xEncryptionMethod":{"type":"string","enum":["CCMP","TKIP","AUTO_TKIP_CCMP","AES192"]},"XiqSsidDot1xKeyManagement":{"type":"string","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":{"type":"object","description":"The payload of config for the SSID advanced settings.","properties":{"id":{"type":"integer","format":"int64","description":"The unique identifier"},"create_time":{"type":"string","format":"date-time","description":"The create time in UTC (ISO 8601 format)"},"update_time":{"type":"string","format":"date-time","description":"The last update time in UTC (ISO 8601 format)"},"enable802_dot11mc":{"type":"boolean"}},"required":["create_time","id","update_time"]},"XiqSiteAfcSchedule":{"type":"object","properties":{"owner_id":{"type":"integer","format":"int64"},"folder_id":{"type":"integer","format":"int64"},"site_time_zone":{"type":"string"},"site_schedule":{"type":"integer","format":"int64"},"is_default_schedule":{"type":"boolean","writeOnly":true},"default_schedule":{"type":"boolean"}}},"XiqRadiusProxyFormatType":{"type":"string","enum":["NAI","NT","SPN","AUTO"]},"XiqUpdateRadsecProxyRealm":{"type":"object","description":"The RADSEC proxy realm for RADSEC proxy","properties":{"name":{"type":"string","description":"The RADSEC proxy realm name"},"enable_strip_realm_name":{"type":"boolean","description":"The flag for enabling strip realm name"},"external_radius_server_object_ids":{"type":"array","description":"The list of associated external RADIUS server object IDs","items":{"type":"integer","format":"int64"},"minItems":1}},"required":["external_radius_server_object_ids"]},"XiqUpdateRadsecProxyRequest":{"type":"object","description":"The payload to update a new RADSEC proxy","properties":{"name":{"type":"string","description":"The RADSEC proxy name"},"description":{"type":"string","description":"The RADSEC proxy description"},"format_type":{"$ref":"#/components/schemas/XiqRadiusProxyFormatType","description":"The format type of RADSEC proxy"},"enable_inject_operator_name_attribute":{"type":"boolean","description":"The flag for enable inject operator name attribute"},"operator_name":{"type":"string","description":"The RADSEC proxy operator name"},"realms":{"type":"array","description":"The realms of RADSEC proxy","items":{"$ref":"#/components/schemas/XiqUpdateRadsecProxyRealm"}}}},"XiqRadsecProxy":{"type":"object","description":"The configuration of RADSEC proxy","properties":{"id":{"type":"integer","format":"int64","description":"The unique identifier"},"create_time":{"type":"string","format":"date-time","description":"The create time in UTC (ISO 8601 format)"},"update_time":{"type":"string","format":"date-time","description":"The last update time in UTC (ISO 8601 format)"},"org_id":{"type":"integer","format":"int64","description":"The organization identifier, valid when enabling HIQ feature"},"name":{"type":"string","description":"The RADSEC proxy name"},"description":{"type":"string","description":"The RADSEC proxy description"},"format_type":{"$ref":"#/components/schemas/XiqRadiusProxyFormatType","description":"The format type of RADSEC proxy"},"enable_inject_operator_name_attribute":{"type":"boolean","description":"The flag for enable inject operator name attribute"},"operator_name_type":{"type":"string","description":"The operator name type of RADSEC proxy","enum":["WBAID"]},"operator_name":{"type":"string","description":"The RADSEC proxy operator name"},"realms":{"type":"array","description":"The realms of RADSEC proxy","items":{"$ref":"#/components/schemas/XiqRadsecProxyRealm"}}},"required":["create_time","format_type","id","name","operator_name","operator_name_type","update_time"]},"XiqRadsecProxyRealm":{"type":"object","description":"The RADSEC proxy realm configuration","properties":{"id":{"type":"integer","format":"int64","description":"The RADIUS proxy realm ID"},"name":{"type":"string","description":"The RADIUS proxy realm name"},"enable_strip_realm_name":{"type":"boolean","description":"The flag for enable strip realm name"},"external_radius_server_object_ids":{"type":"array","description":"The list of associated external RADIUS servers","items":{"type":"integer","format":"int64"},"minItems":1}},"required":["external_radius_server_object_ids"]},"XiqInternalRadiusServerAuthenticationMethod":{"type":"string","enum":["TLS","PEAP","TTLS","LEAP","MD5"]},"XiqInternalRadiusServerAuthenticationMethodGroup":{"type":"string","enum":["TLS_PEAP_TTLS_LEAP_MD5","TLS_PEAP_TTLS_LEAP","TLS_PEAP","TLS_TTLS","TLS","LEAP"]},"XiqRadiusClient":{"type":"object","description":"The associate RADIUS client for RADIUS proxy","properties":{"id":{"type":"integer","format":"int64","description":"The RADIUS client ID"},"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","format":"int64","description":"The associate L3 address profile ID"}}},"XiqUpdateInternalRadiusServerRequest":{"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","description":"The authentication group"},"default_authentication_method":{"$ref":"#/components/schemas/XiqInternalRadiusServerAuthenticationMethod","description":"The default authentication method"},"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":{"type":"integer","format":"int32","default":1812,"description":"Port for the authentication, must enable authentication. Max:65535, Min:1","maximum":65535,"minimum":1},"active_session_limit":{"type":"integer","format":"int32","default":0,"description":"Active session limit, must enable accounting setting. Max:15, Min:0","maximum":15,"minimum":0},"active_session_age_timeout":{"type":"integer","format":"int32","default":30,"description":"Active session age timeout in seconds, must enable accounting setting. Max:300000000, Min:0","maximum":300000000,"minimum":30},"ca_certificate_id":{"type":"integer","format":"int64","description":"The CA certificate ID, which could be fetched from endpoint: '/certificates' and pick up with type 'CA'"},"server_certificate_id":{"type":"integer","format":"int64","description":"The Server certificate ID, which could be fetched from endpoint: '/certificates' and pick up with type 'CERT'"},"server_key_id":{"type":"integer","format":"int64","description":"The Server key ID, which could be fetched from endpoint: '/certificates' and pick up with type 'KEY'"},"clients":{"type":"array","description":"The RADIUS clients of RADIUS proxy, which could be fetched form endpoint: '/radius-proxy'","items":{"$ref":"#/components/schemas/XiqRadiusClient"}}},"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"]},"XiqExternalUserDirectory":{"type":"object","description":"The setting for external user directory, AD or LDAP","properties":{"ldap_retry_interval":{"type":"integer","format":"int32","default":600,"description":"Retry the previously unresponsive primary server after the specified seconds","maximum":200000000,"minimum":60},"local_check_interval":{"type":"integer","format":"int32","default":300,"description":"Time to user local cache if none of the external servers are reachable in seconds","maximum":3600,"minimum":30},"remote_check_interval":{"type":"integer","format":"int32","default":30,"description":"Try the next backup server after specified seconds","maximum":3600,"minimum":10},"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":{"type":"integer","format":"int32","default":86400,"description":"Retain Cache for","maximum":2592000,"minimum":3600},"user_group_attribute":{"type":"string","default":"memberOf","description":"The user group attribute, use string such as: 'memberOf'","example":"memberOf"},"external_user_directory_type":{"$ref":"#/components/schemas/XiqExternalUserDirectoryType","description":"The external user directory type"},"entries":{"type":"array","description":"The external user directory server entries","items":{"$ref":"#/components/schemas/XiqExternalUserDirectoryEntry"},"minItems":1}},"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"]},"XiqExternalUserDirectoryEntry":{"type":"object","description":"The payload of common object - External User Directory Entry","properties":{"default_server_id":{"type":"integer","format":"int64","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' "},"server_role":{"$ref":"#/components/schemas/XiqServerRole","description":"The server role, Primary or Backup"}},"required":["default_server_id","server_role"]},"XiqExternalUserDirectoryType":{"type":"string","enum":["OPEN_LDAP","ACTIVE_DIRECTORY"]},"XiqInternalRadiusServer":{"type":"object","description":"The configuration of internal RADIUS server object","properties":{"id":{"type":"integer","format":"int64","description":"The unique identifier"},"create_time":{"type":"string","format":"date-time","description":"The create time in UTC (ISO 8601 format)"},"update_time":{"type":"string","format":"date-time","description":"The last update time in UTC (ISO 8601 format)"},"org_id":{"type":"integer","format":"int64","description":"The organization identifier, valid when enabling HIQ feature"},"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","description":"The authentication group"},"default_authentication_method":{"$ref":"#/components/schemas/XiqInternalRadiusServerAuthenticationMethod","description":"The default authentication method"},"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":{"type":"integer","format":"int32","default":1812,"description":"Port for the authentication, must enable authentication. Max:65535, Min:1","maximum":65535,"minimum":1},"active_session_limit":{"type":"integer","format":"int32","default":0,"description":"Active session limit, must enable accounting setting. Max:15, Min:0","maximum":15,"minimum":0},"active_session_age_timeout":{"type":"integer","format":"int32","default":30,"description":"Active session age timeout in seconds, must enable accounting setting. Max:300000000, Min:0","maximum":300000000,"minimum":30},"external_user_directory":{"$ref":"#/components/schemas/XiqExternalUserDirectory","description":"The external user directory, LDAP or AD settings"},"ca_certificate_id":{"type":"integer","format":"int64","description":"The CA certificate ID"},"server_certificate_id":{"type":"integer","format":"int64","description":"The Server certificate ID"},"server_key_id":{"type":"integer","format":"int64","description":"The Server key ID"},"device_ids":{"type":"array","description":"The list of device ID associated with the internal RADIUS server","items":{"type":"integer","format":"int64"}},"clients":{"type":"array","description":"The RADIUS clients of RADIUS proxy","items":{"$ref":"#/components/schemas/XiqRadiusClient"}}},"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"]},"XiqServerRole":{"type":"string","enum":["PRIMARY","BACKUP1","BACKUP2","BACKUP3"]},"XiqRadiusServerType":{"type":"string","enum":["ACCOUNTING","AUTHENTICATION","BOTH"]},"XiqUpdateExternalRadiusServerRequest":{"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":{"type":"integer","format":"int32","default":1812,"description":"The authentication port for the external RADIUS server (1 ~ 65535)","maximum":65535,"minimum":1},"accounting_port":{"type":"integer","format":"int32","default":1813,"description":"The accounting port for the external RADIUS server (1 ~ 65535)","maximum":65535,"minimum":1},"server_type":{"$ref":"#/components/schemas/XiqRadiusServerType","description":"The port type of the RADIUS server, can only be either ACCOUNTING, AUTHENTICATION, or BOTH","example":"BOTH"},"ip_addr":{"type":"string","description":"The IP address or hostname of the RADIUS server"},"enable_peer_discovery":{"type":"boolean","description":"Indicates whether the RADIUS server allows devices to connect automatically without manually defining their IP address or hostname."},"trust_pilot_id":{"type":"integer","format":"int64","description":"The Certificate Bundle trust pilot ID."}},"required":["accounting_port","authentication_port","name","server_type"]},"XiqUpdateRadiusClient":{"type":"object","description":"The associate RADIUS client for RADIUS proxy","properties":{"id":{"type":"integer","format":"int64","description":"The RADIUS client ID, using an existing ID or leave empty to create a new one"},"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","format":"int64","description":"The associate L3 address profile ID"}}},"XiqUpdateRadiusProxyRealm":{"type":"object","description":"The associate RADIUS proxy realm for RADIUS proxy","properties":{"id":{"type":"integer","format":"int64","description":"The RADIUS proxy realm ID, using an existing ID or leave empty to create a new one"},"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","format":"int64","description":"The associate RADIUS client object ID"}}},"XiqUpdateRadiusProxyRequest":{"type":"object","description":"The payload to update RADIUS proxy","properties":{"name":{"type":"string","description":"The RADIUS proxy name"},"description":{"type":"string","description":"The RADIUS proxy description"},"format_type":{"$ref":"#/components/schemas/XiqRadiusProxyFormatType","description":"The format type of RADIUS proxy"},"retry_count":{"type":"integer","format":"int32","description":"The retry count of RADIUS proxy"},"retry_delay":{"type":"integer","format":"int32","description":"The retry delay of RADIUS proxy"},"dead_time":{"type":"integer","format":"int32","description":"The dead time of RADIUS proxy"},"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":{"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"},"maxItems":2147483647,"minItems":2}}},"XiqRadiusProxy":{"type":"object","description":"The configuration of RADIUS proxy","properties":{"id":{"type":"integer","format":"int64","description":"The unique identifier"},"create_time":{"type":"string","format":"date-time","description":"The create time in UTC (ISO 8601 format)"},"update_time":{"type":"string","format":"date-time","description":"The last update time in UTC (ISO 8601 format)"},"org_id":{"type":"integer","format":"int64","description":"The organization identifier, valid when enabling HIQ feature"},"name":{"type":"string","description":"The RADIUS proxy name"},"description":{"type":"string","description":"The RADIUS proxy description"},"format_type":{"$ref":"#/components/schemas/XiqRadiusProxyFormatType","description":"The format type of RADIUS proxy"},"retry_count":{"type":"integer","format":"int32","description":"The retry count of RADIUS proxy"},"retry_delay":{"type":"integer","format":"int32","description":"The retry delay of RADIUS proxy"},"dead_time":{"type":"integer","format":"int32","description":"The dead time of RADIUS proxy"},"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"}}},"required":["create_time","id","update_time"]},"XiqRadiusProxyRealm":{"type":"object","description":"The associate RADIUS proxy realm for RADIUS proxy","properties":{"id":{"type":"integer","format":"int64","description":"The RADIUS proxy realm ID"},"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","format":"int64","description":"The associate RADIUS client object ID"}}},"XiqUpdateRadiusClientObjectRequest":{"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":{"type":"integer","format":"int32","description":"The retry interval, 60 - 100000000 seconds","maximum":100000000,"minimum":60},"accounting_interim_update_interval":{"type":"integer","format":"int32","description":"The accounting interim update interval, 60 - 100000000 seconds","maximum":100000000,"minimum":60}},"required":["accounting_interim_update_interval","enable_inject_operator_name_attribute","enable_message_authenticator_attribute","enable_permit_dynamic_authorization_message_change","name","retry_interval"]},"XiqRadioMode":{"type":"string","enum":["B_G","G_N","A","A_N","AC","AX_2_4_GHZ","AX_5_GHZ","AX_6_GHZ","BE_2_4_GHZ","BE_5_GHZ","BE_6_GHZ"]},"XiqUpdateRadioProfileRequest":{"type":"object","properties":{"name":{"type":"string","description":"The radio profile name"},"description":{"type":"string","description":"The radio profile description."},"transmission_power":{"type":"integer","format":"int32","description":"The transmission power floor in the range of 1-20 dBm or null for Auto.","maximum":20,"minimum":1},"max_transmit_power":{"type":"integer","format":"int32","description":"The maximum transmit power in the range of 10-20 dBm.","maximum":20,"minimum":10},"transmission_power_floor":{"type":"integer","format":"int32","description":"The transmission power floor in the range of 2-20 dBm.","maximum":20,"minimum":2},"transmission_power_max_drop":{"type":"integer","format":"int32","description":"The transmission power max drop in the range of 0-18 dB.","maximum":18,"minimum":0},"max_clients":{"type":"integer","format":"int32","description":"The maximum number of clients in the range of 1-255.","maximum":255,"minimum":1},"enable_client_transmission_power":{"type":"boolean","description":"Whether or not client transmission power control (802.11h) is enabled."},"client_transmission_power":{"type":"integer","format":"int32","description":"The client transmission power (in the range of 1-20 dBm) if it is enabled.","maximum":20,"minimum":1},"radio_mode":{"$ref":"#/components/schemas/XiqRadioMode","description":"The supported radio modes."},"enable_ofdma":{"type":"boolean","description":"Whether to enable Orthogonal Frequency Division Multiple Access (802.11ax) for multiple-user access by subdividing a channel."},"afc_power_mode":{"type":"string","description":"The AFC 6GHz power mode. -- \"SP\" (Standard Power), \"LPI\" (Low Power)"}}},"XiqRadioProfile":{"type":"object","description":"The payload of Radio Profile","properties":{"id":{"type":"integer","format":"int64","description":"The unique identifier"},"create_time":{"type":"string","format":"date-time","description":"The create time in UTC (ISO 8601 format)"},"update_time":{"type":"string","format":"date-time","description":"The last update time in UTC (ISO 8601 format)"},"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","format":"int32","description":"The transmission power floor from 1 up to 20 dBm or null for Auto."},"max_transmit_power":{"type":"integer","format":"int32","description":"The maximum transmit power from 10 up to 20 dBm."},"transmission_power_floor":{"type":"integer","format":"int32","description":"The transmission power floor from 2 up to 20 dBm."},"transmission_power_max_drop":{"type":"integer","format":"int32","description":"The transmission power max drop from 0 up to 18 dB."},"max_clients":{"type":"integer","format":"int32","description":"The maximum number of clients from 1 up to 255."},"enable_client_transmission_power":{"type":"boolean","description":"Whether or not client transmission power control (802.11h) is enabled."},"client_transmission_power":{"type":"integer","format":"int32","description":"The client transmission power from 1 up to 20 dBm if it is enabled."},"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","description":"The supported radio modes."},"neighborhood_analysis_id":{"type":"integer","format":"int64","description":"The neighborhood analysis Id."},"channel_selection_id":{"type":"integer","format":"int64","description":"The channel selection Id."},"radio_usage_optimization_id":{"type":"integer","format":"int64","description":"The radio usage optimization Id."},"miscellaneous_settings_id":{"type":"integer","format":"int64","description":"The miscellaneous settings Id"},"presence_server_settings_id":{"type":"integer","format":"int64","description":"The presence server settings Id."},"sensor_scan_settings_id":{"type":"integer","format":"int64","description":"The sensor scan settings Id."},"afc_power_mode":{"type":"string","description":"The power mode for 6 GHZ radio profiles for supporting APs"}},"required":["create_time","id","update_time"]},"XiqUpdateRpWmmQosSettingsRequest":{"type":"object","properties":{"arbitration_interframe_space":{"type":"integer","format":"int32","description":"The Arbitration Interframe space, in the range of 1 to 15.","maximum":15,"minimum":1},"min_contention_window":{"type":"integer","format":"int32","description":"The Minimum Contention window, in the range of 1 to 15.","maximum":15,"minimum":1},"max_contention_window":{"type":"integer","format":"int32","description":"The Maximum Contention window, in the range of 1 to 15.","maximum":15,"minimum":1},"transmission_opportunity_limit":{"type":"integer","format":"int32","description":"The Transmission Opportunity limit, in the range of 0 to 8192.","maximum":8192,"minimum":0},"enable_no_ack":{"type":"boolean","description":"Whether to enable No Acknowledgment"}}},"XiqRpWmmQosSettings":{"type":"object","description":"The payload of config for the radio profile","properties":{"id":{"type":"integer","format":"int64","description":"The unique identifier"},"create_time":{"type":"string","format":"date-time","description":"The create time in UTC (ISO 8601 format)"},"update_time":{"type":"string","format":"date-time","description":"The last update time in UTC (ISO 8601 format)"},"access_category":{"type":"string","description":"The media categories, including \"VOICE\", \"VIDEO\", \"BEST_EFFORT\", and \"BACKGROUND\""},"arbitration_interframe_space":{"type":"integer","format":"int32","description":"The Arbitration Interframe space from 1 up to 15."},"min_contention_window":{"type":"integer","format":"int32","description":"The Minimum Contention window from 1 up to 15."},"max_contention_window":{"type":"integer","format":"int32","description":"The Maximum Contention window from 1 up to 15."},"transmission_opportunity_limit":{"type":"integer","format":"int32","description":"The Transmission Opportunity limit from 0 up to 8192."},"enable_no_ack":{"type":"boolean","description":"Whether to enable No Acknowledgment"}},"required":["create_time","id","update_time"]},"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":{"type":"object","description":"The payload of config for the radio profile","properties":{"id":{"type":"integer","format":"int64","description":"The unique identifier"},"create_time":{"type":"string","format":"date-time","description":"The create time in UTC (ISO 8601 format)"},"update_time":{"type":"string","format":"date-time","description":"The last update time in UTC (ISO 8601 format)"},"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"}},"required":["create_time","id","update_time"]},"XiqUpdateRpRadioUsageOptimizationRequest":{"type":"object","properties":{"preamble":{"type":"string","description":"The preamble data length -- \"AUTO\" or \"LONG\""},"beacon_period":{"type":"integer","format":"int32","description":"The amount of time between beacons in the range from 40 to 3500.","maximum":3500,"minimum":40},"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","format":"int32","description":"Switch to Wireless Backhaul after the number of seconds (1 to 5) after the wired link fails","maximum":5,"minimum":1},"wired_backhaul_revert_hold_time":{"type":"integer","format":"int32","description":"Revert Back to Wired Backhaul after the number of seconds (1 to 300) after the wired link is established","maximum":300,"minimum":1},"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":{"type":"integer","format":"int32","description":"The allowed percentage distribution of 2.4 and 5.0 GHz clients for \"BALANCE\" steering mode.","maximum":100,"minimum":1},"ignore_initial_client_connection_number":{"type":"integer","format":"int32","description":"The number of connection attempts from 2.4 GHz clients to ignore before responding for URGE_5G steering mode.","maximum":100,"minimum":1},"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","format":"int32","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.","maximum":99,"minimum":1},"rf_interference_per_device":{"type":"integer","format":"int32","description":"The RF Interference threshold value for \"AIRTIME_BASED\" load balancing. Ignore probe and association requests per device when RF Interference exceeds the threshold.","maximum":99,"minimum":1},"average_airtime_per_client":{"type":"integer","format":"int32","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.","maximum":5,"minimum":1},"anchor_period":{"type":"integer","format":"int32","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","maximum":600,"minimum":10},"neighbor_query_interval":{"type":"integer","format":"int32","description":"In both client load balancing modes, query neighbors about client load every in the range of 1 to 600 seconds","maximum":600,"minimum":1},"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","format":"int32","description":"The signal to noise threshold in the range of 1 to 100 for Weak Signal Probe Request Suppression.","maximum":100,"minimum":1},"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","format":"int32","description":"The Safety Net Time Period in the range of 5 to 300 seconds.","maximum":300,"minimum":5},"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","format":"int32","description":"The Number of Connection Attempts in the range of 1 to 10","maximum":10,"minimum":1},"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","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":{"type":"integer","format":"int32","description":"The numerical identifier of the basic service sets (802.11ax ) to identify overlapping basic service sets (OBSSs).","maximum":63,"minimum":1},"enable_target_weak_time":{"type":"boolean","description":"Whether to enable Target Weak Time."}}},"XiqRpMacOuiProfile":{"type":"object","description":"The payload of config for the radio profile","properties":{"id":{"type":"integer","format":"int64","description":"The unique identifier"},"create_time":{"type":"string","format":"date-time","description":"The create time in UTC (ISO 8601 format)"},"update_time":{"type":"string","format":"date-time","description":"The last update time in UTC (ISO 8601 format)"},"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"}},"required":["create_time","id","update_time"]},"XiqRpRadioUsageOptimization":{"type":"object","description":"The payload of config for the radio profile","properties":{"id":{"type":"integer","format":"int64","description":"The unique identifier"},"create_time":{"type":"string","format":"date-time","description":"The create time in UTC (ISO 8601 format)"},"update_time":{"type":"string","format":"date-time","description":"The last update time in UTC (ISO 8601 format)"},"preamble":{"type":"string","description":"The preamble data length -- \"AUTO\" or \"LONG\""},"beacon_period":{"type":"integer","format":"int32","description":"The amount of time between beacons from 40 up to 3500."},"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","format":"int32","description":"Switch to Wireless Backhaul after 1 up to 5 seconds after the wired link fails"},"wired_backhaul_revert_hold_time":{"type":"integer","format":"int32","description":"Revert Back to Wired Backhaul after 1 up to 300 seconds after the wired link is established"},"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","format":"int32","description":"The number of connection attempts from 1 to 100 for 2.4 GHz clients to ignore before responding for URGE_5G steering mode."},"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","format":"int32","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."},"rf_interference_per_device":{"type":"integer","format":"int32","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."},"average_airtime_per_client":{"type":"integer","format":"int32","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."},"anchor_period":{"type":"integer","format":"int32","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"},"neighbor_query_interval":{"type":"integer","format":"int32","description":"In both client load balancing modes, query neighbors about client load every 1 up to 600 seconds"},"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","format":"int32","description":"The signal to noise threshold from 1 up to 100 for Weak Signal Probe Request Suppression."},"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","format":"int32","description":"The Safety Net Time Period from 5 up to 300 seconds."},"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","format":"int32","description":"The Number of Connection Attempts from 1 up to 10"},"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","format":"int32","description":"Whether to enable BSS Coloring (802.11ax ) to identify overlapping basic service sets (OBSSs)."},"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","format":"int32","description":"The percentage distribution from 1 up to 100 for 2.4 and 5.0 GHz clients for \"BALANCE\" steering mode."}},"required":["create_time","id","update_time"]},"XiqUpdateRpNeighborhoodAnalysisRequest":{"type":"object","properties":{"enable_background_scan":{"type":"boolean","description":"Whether background scan of neighboring devices is enabled"},"background_scan_interval":{"type":"integer","format":"int32","default":3,"description":"The background scan interval in the range of 1 to 1440 minutes","maximum":1440,"minimum":1},"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":{"type":"object","description":"The payload of neighborhood analysis config for the radio profile","properties":{"id":{"type":"integer","format":"int64","description":"The unique identifier"},"create_time":{"type":"string","format":"date-time","description":"The create time in UTC (ISO 8601 format)"},"update_time":{"type":"string","format":"date-time","description":"The last update time in UTC (ISO 8601 format)"},"enable_background_scan":{"type":"boolean","description":"Whether to enable background scanning of neighboring devices"},"background_scan_interval":{"type":"integer","format":"int32","description":"The background scan interval from 1 up to 1440 minutes"},"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"}},"required":["create_time","id","update_time"]},"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":{"type":"integer","format":"int32","description":"The Outdoor Deployment for signal distance from 300 to 10000 meters","maximum":10000,"minimum":300}}},"XiqRpMiscellaneousSettings":{"type":"object","description":"The payload of config for the radio profile","properties":{"id":{"type":"integer","format":"int64","description":"The unique identifier"},"create_time":{"type":"string","format":"date-time","description":"The create time in UTC (ISO 8601 format)"},"update_time":{"type":"string","format":"date-time","description":"The last update time in UTC (ISO 8601 format)"},"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","format":"int32","description":"The Outdoor Deployment for signal distance from 300 to 10000 meters"},"wmm_qos_settings":{"type":"array","description":"The WMM QoS settings for various media types","items":{"$ref":"#/components/schemas/XiqRpWmmQosSettings"}}},"required":["create_time","id","update_time"]},"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":{"type":"integer","format":"int32","description":"The number of channel selections or AUTO for default selection.","maximum":165,"minimum":1},"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":{"type":"integer","format":"int32","description":"The number of channel models to limit.","maximum":4,"minimum":3},"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","format":"int32","description":"The maximum number of connected clients to avoid switching","maximum":100,"minimum":0},"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","format":"int32","description":"The RF interference threshold for channel switching.","maximum":80,"minimum":10},"crc_error_threshold":{"type":"integer","format":"int32","description":"The CRC error threshold for channel switching.","maximum":80,"minimum":10}}},"XiqRpChannelSelection":{"type":"object","description":"The payload of config for the radio profile","properties":{"id":{"type":"integer","format":"int64","description":"The unique identifier"},"create_time":{"type":"string","format":"date-time","description":"The create time in UTC (ISO 8601 format)"},"update_time":{"type":"string","format":"date-time","description":"The last update time in UTC (ISO 8601 format)"},"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","format":"int32","description":"The number of channel selections from 1 up to 165 or AUTO for default selection."},"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":{"type":"integer","format":"int32","description":"The number of channel models to limit.","maximum":4,"minimum":3},"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","format":"int32","description":"The maximum number of connected clients from 0 up to 100 to avoid switching"},"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","format":"int32","description":"The RF interference threshold from 10 up to 80 for channel switching."},"crc_error_threshold":{"type":"integer","format":"int32","description":"The CRC error threshold from 10 up to 80 for channel switching."}},"required":["create_time","id","update_time"]},"XiqKeyBasedPcgUserBaseInfo":{"type":"object","description":"The user's base info","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"}},"required":["email","name","user_group_name"]},"XiqUpdateKeyBasedPcgUsersRequest":{"type":"object","description":"The payload of replace Key-based Private Client Group users request","properties":{"users":{"type":"array","description":"The Key-based PCG users","items":{"$ref":"#/components/schemas/XiqKeyBasedPcgUserBaseInfo"}}},"required":["users"]},"XiqRecipientCnsInfo":{"type":"object","properties":{"email":{"type":"string","description":"The recipient email address"},"notifier_id":{"type":"integer","format":"int64","description":"Unique identifier generated by CNS(Common Notification Service) for an email recipient. When a recipient is subscribed to a report, the UI verifies the email with CNS. If the recipient does not exist, CNS creates a new entry and generates this Notifier ID, which is required by the Report Service for validation. This field is mandatory to prevent non-verified or non-existent email addresses from being subscribed via xAPI. The Notifier ID for an email can be found in the CNS Swagger. Refer to the CNS Swagger UI for the applicable environment: https://<cns-url>/notification/swagger-ui/index.html#/ example(non-prod) - https://g2-eu-cns.qa.xcloudiq.com/notification/swagger-ui/index.html#/"}}},"XiqDiagnosticsBands":{"type":"string","enum":["TWO_GHZ","FIVE_GHZ","SIX_GHZ","OTHERS"]},"XiqQoeDiagnosticsMetrics":{"type":"string","enum":["MAX_CONCURRENT_CLIENTS","UNIQUE_CLIENTS_BY_SSID","UNIQUE_WIFI_CLIENTS","CLIENT_QUALITY_SCORE","CLIENT_SESSIONS","CLIENT_AIRTIME_USAGE","WIRELESS_CLIENTS_BY_OS","UNIQUE_CLIENTS_BY_OS","TRAFFIC_VOLUME_PER_APP","DEVICES_BY_CLIENTS","SWITCH_SUMMARY","UNIQUE_CLIENT_BY_SSID_PIE_CHART","TRAFFIC_VOLUME_PER_APP_PIE_CHART"]},"XiqReportFileFormat":{"type":"string","enum":["PDF","XLSX","ZIP"]},"XiqScheduleFrequency":{"type":"string","enum":["DAILY","WEEKLY","MONTHLY"]},"XiqUpdateCustomReportRequest":{"type":"object","properties":{"metrics":{"type":"array","description":"List of metrics to include in the report (e.g., MAX_CONCURRENT_CLIENTS).","items":{"$ref":"#/components/schemas/XiqQoeDiagnosticsMetrics"},"minItems":1},"report_name":{"type":"string","description":"The name of the report.","minLength":1},"report_description":{"type":"string","description":"A short description of the report."},"site_ids":{"type":"array","description":"List of site IDs the report will cover.","items":{"type":"integer","format":"int64"}},"building_ids":{"type":"array","description":"List of building IDs the report will cover.","items":{"type":"integer","format":"int64"}},"floor_ids":{"type":"array","description":"List of floor IDs the report will cover.","items":{"type":"integer","format":"int64"}},"ssids":{"type":"array","description":"List of SSIDs to be included in the report.","items":{"type":"string"}},"bands":{"type":"array","description":"List of bands (e.g., 2.4GHz, 5GHz) to be covered in the report.","items":{"$ref":"#/components/schemas/XiqDiagnosticsBands"}},"recipients":{"type":"array","description":"List of recipient email to send the report.","items":{"$ref":"#/components/schemas/XiqRecipientCnsInfo"}},"schedules":{"type":"array","description":"List of schedules (e.g., daily, weekly, etc.).","items":{"$ref":"#/components/schemas/XiqUpdateReportScheduleRequest"},"minItems":1},"file_format":{"type":"array","description":"The file format(s) of the report (e.g., PDF, CSV).","items":{"$ref":"#/components/schemas/XiqReportFileFormat"},"minItems":1}},"required":["file_format","metrics","report_name","schedules"]},"XiqUpdateReportScheduleRequest":{"type":"object","properties":{"report_schedule_id":{"type":"integer","format":"int64","description":"Unique ID of the schedule"},"frequency_type":{"$ref":"#/components/schemas/XiqScheduleFrequency","description":"The frequency type of the scheduled report (e.g., DAILY, WEEKLY, etc.)."},"schedule_time":{"type":"string","default":"23:59","description":"The scheduled time in HH:MM format (e.g., 08:00). Defaults to 23:59 if not provided."},"schedule_timezone":{"type":"string","default":"UTC","description":"The timezone of the scheduled report. Defaults to UTC if not provided."},"schedule_days":{"type":"array","description":"Days on which the report is scheduled (e.g., [0] for Sunday).","items":{"type":"integer","format":"int32"},"minItems":1},"enable_schedule":{"type":"boolean","description":"Whether the schedule is enabled or not."}},"required":["frequency_type","schedule_days"]},"XiqCustomReportResponse":{"type":"object","properties":{"report_id":{"type":"integer","format":"int64","description":"Unique ID of the report"},"report_name":{"type":"string","description":"The name of the actual report."},"report_description":{"type":"string","description":"A short description of the report."},"metrics":{"type":"array","description":"List of metrics to include in the report (e.g., MAX_CONCURRENT_CLIENTS).","items":{"$ref":"#/components/schemas/XiqQoeDiagnosticsMetrics"}},"site_ids":{"type":"array","description":"List of site IDs the report will cover.","items":{"type":"integer","format":"int64"}},"building_ids":{"type":"array","description":"List of building IDs the report will cover.","items":{"type":"integer","format":"int64"}},"floor_ids":{"type":"array","description":"List of floor IDs the report will cover.","items":{"type":"integer","format":"int64"}},"ssids":{"type":"array","description":"List of SSIDs to be included in the report.","items":{"type":"string"}},"bands":{"type":"array","description":"List of bands (e.g., 2.4GHz, 5GHz) to be included in the report.","items":{"$ref":"#/components/schemas/XiqDiagnosticsBands"}},"recipients":{"type":"array","description":"List of recipient email to send the report.","items":{"$ref":"#/components/schemas/XiqRecipientCnsInfo"}},"schedules":{"type":"array","description":"List of schedules (e.g., daily, weekly, etc.).","items":{"$ref":"#/components/schemas/XiqReportSchedule"}},"file_format":{"type":"array","description":"The file format(s) of the report (e.g., PDF, CSV).","items":{"$ref":"#/components/schemas/XiqReportFileFormat"}}},"required":["file_format","metrics","schedules"]},"XiqReportSchedule":{"type":"object","properties":{"report_schedule_id":{"type":"integer","format":"int64","description":"The unique ID of the scheduled report."},"frequency_type":{"$ref":"#/components/schemas/XiqScheduleFrequency","description":"The frequency type of the scheduled report (e.g., DAILY, WEEKLY, etc.)."},"schedule_time":{"type":"string","description":"The scheduled time in HH:MM:SS format (e.g., 08:00:00)."},"schedule_timezone":{"type":"string","description":"The timezone of the scheduled report."},"schedule_days":{"type":"array","description":"Days on which the report is scheduled (e.g., [0] for Sunday).","items":{"type":"integer","format":"int32"}},"enable_schedule":{"type":"boolean","description":"Whether the schedule is enabled or not."}}},"XiqNetworkPolicyType":{"type":"string","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","description":"The network policy type"}}},"XiqNetworkPolicy":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"The unique identifier"},"create_time":{"type":"string","format":"date-time","description":"The create time in UTC (ISO 8601 format)"},"update_time":{"type":"string","format":"date-time","description":"The last update time in UTC (ISO 8601 format)"},"org_id":{"type":"integer","format":"int64","description":"The organization identifier, valid when enabling HIQ feature"},"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.","enum":["NetworkAccessAndSwitching","BranchRouting","WirelessAccess","Switching","NetworkAccessAndSwitchingAndBR","NetworkAccessAndBranchRouting","SwitchingAndBranchRouting"]}},"required":["create_time","id","name","predefined","type","update_time"]},"XiqUpdateMacObjectRequest":{"type":"object","properties":{"name":{"type":"string","description":"The product model"},"description":{"type":"string","description":"The product description"},"value":{"type":"string","description":"The MAC octets."},"mac_address_end":{"type":"string","description":"The MAC address end, only available for \"MAC_RANGE\" type."}}},"XiqMacObject":{"type":"object","description":"The MAC Object.","properties":{"id":{"type":"integer","format":"int64","description":"The unique identifier"},"create_time":{"type":"string","format":"date-time","description":"The create time in UTC (ISO 8601 format)"},"update_time":{"type":"string","format":"date-time","description":"The last update time in UTC (ISO 8601 format)"},"org_id":{"type":"integer","format":"int64","description":"The organization identifier, valid when enabling HIQ feature"},"name":{"type":"string","description":"The MAC object name"},"description":{"type":"string","description":"The MAC object description."},"predefined":{"type":"boolean","description":"Whether the MAC Oui is predefined"},"value":{"type":"string","description":"The MAC octets in hexadecimal format without separators. For MAC_OUI: 6 characters (e.g., '001DA2'). For MAC_ADDRESS or MAC_RANGE: 12 characters (e.g., 'AABBCCDDEEFF').","example":"AABBCCDDEEFF"},"mac_type":{"$ref":"#/components/schemas/XiqMacObjectType","description":"The MAC object type e.g, \"MAC_OUI\", \"MAC_RANGE\" or \"MAC_ADDRESS\""},"defender_defined":{"type":"boolean","description":"Whether defender is defined"},"mac_address_end":{"type":"string","description":"The MAC address end in hexadecimal format without separators (12 characters), only available for \"MAC_RANGE\".","example":"FFFFFFFFFFFF"}},"required":["create_time","id","update_time"]},"XiqMacObjectType":{"type":"string","enum":["MAC_OUI","MAC_RANGE","MAC_ADDRESS"]},"XiqLoggingType":{"type":"string","enum":["OFF","DROPPED_PACKETS","SESSION_INITIATION","SESSION_TERMINATION","BOTH"]},"XiqMacFirewallAction":{"type":"string","enum":["PERMIT","DENY"]},"XiqMacFirewallPolicyRequest":{"type":"object","description":"The MAC Firewall policy.","properties":{"name":{"type":"string","description":"The MAC firewall policy name"},"description":{"type":"string","description":"The MAC firewall policy description."},"rules":{"type":"array","description":"List of MAC Firewall Rules","items":{"$ref":"#/components/schemas/XiqMacFirewallRuleRequest"}}}},"XiqMacFirewallRuleRequest":{"type":"object","properties":{"action":{"$ref":"#/components/schemas/XiqMacFirewallAction","description":"The MAC Firewall Action."},"source_mac":{"type":"integer","format":"int64","description":"Source MAC address for MAC Firewall Rule."},"destination_mac":{"type":"integer","format":"int64","description":" Destination MAC address for MAC Firewall Rule."},"logging_type":{"$ref":"#/components/schemas/XiqLoggingType","description":"The logging Type for MAC Firewall Rule."}}},"XiqMacFirewall":{"type":"object","description":"MAC Firewall policy.","properties":{"id":{"type":"integer","format":"int64","description":"The unique identifier"},"create_time":{"type":"string","format":"date-time","description":"The create time in UTC (ISO 8601 format)"},"update_time":{"type":"string","format":"date-time","description":"The last update time in UTC (ISO 8601 format)"},"org_id":{"type":"integer","format":"int64","description":"The organization identifier, valid when enabling HIQ feature"},"name":{"type":"string","description":"The MAC Firewall policy name"},"description":{"type":"string","description":"The MAC Firewall policy description."},"rules":{"type":"array","description":"List of MAC Firewall Rules.","items":{"$ref":"#/components/schemas/XiqMacFirewallRule"}},"predefined":{"type":"boolean","description":"Flag to describe whether the application is predefined or customized."}},"required":["create_time","id","update_time"]},"XiqMacFirewallRule":{"type":"object","description":"MAC Firewall Rule","properties":{"id":{"type":"integer","format":"int64","description":"The unique identifier"},"create_time":{"type":"string","format":"date-time","description":"The create time in UTC (ISO 8601 format)"},"update_time":{"type":"string","format":"date-time","description":"The last update time in UTC (ISO 8601 format)"},"org_id":{"type":"integer","format":"int64","description":"The organization identifier, valid when enabling HIQ feature"},"action":{"$ref":"#/components/schemas/XiqMacFirewallAction","description":"The MAC Firewall Action."},"source_mac":{"$ref":"#/components/schemas/XiqMacObject","description":"Source MAC for MAC Firewall Rule."},"destination_mac":{"$ref":"#/components/schemas/XiqMacObject","description":"Destination MAC for MAC Firewall Rule."},"logging_type":{"$ref":"#/components/schemas/XiqLoggingType","description":" The MAC Firewall logging type."}},"required":["create_time","id","update_time"]},"XiqUpdateLocationRequest":{"type":"object","properties":{"parent_id":{"type":"integer","format":"int64","description":"The parent location ID"},"name":{"type":"string","description":"The location name"}},"required":["name","parent_id"]},"XiqLocation":{"type":"object","description":"The hierarchical location for Site_Group/Site/Building/Floor","properties":{"id":{"type":"integer","format":"int64","description":"The unique identifier"},"create_time":{"type":"string","format":"date-time","description":"The create time in UTC (ISO 8601 format)"},"update_time":{"type":"string","format":"date-time","description":"The last update time in UTC (ISO 8601 format)"},"org_id":{"type":"integer","format":"int64","description":"The organization identifier, valid when enabling HIQ feature"},"parent_id":{"type":"integer","format":"int64","description":"The parent location ID"},"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"}}},"required":["create_time","id","name","type","unique_name","update_time"]},"XiqUpdateTypeRequest":{"type":"object","properties":{"name":{"type":"string","description":"The Wall type name","maxLength":254,"minLength":1},"attenuation":{"type":"number","format":"double","description":"The Wall type attenuation","maximum":999,"minimum":-999},"color":{"type":"string","description":"The Wall type color","minLength":1,"pattern":"^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{8})$"}},"required":["attenuation","color","name"]},"XiqWallType":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"The Wall type id"},"name":{"type":"string","description":"The Wall type name"},"attenuation":{"type":"number","format":"double","description":"The Wall type attenuation"},"color":{"type":"string","description":"The Wall type color"},"owner_id":{"type":"integer","format":"int64","description":"The Owner ID"},"org_id":{"type":"integer","format":"int64","description":"The Org ID"},"predefined":{"type":"boolean","description":"Is the Wall type is predefined"}},"required":["attenuation","color","id","name","org_id","owner_id","predefined"]},"XiqAddress":{"type":"object","description":"The address for a site or building.","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"}},"required":["address","city"]},"XiqUpdateSiteRequest":{"type":"object","properties":{"parent_id":{"type":"integer","format":"int64","description":"The parent site group ID"},"name":{"type":"string","description":"The site name"},"address":{"$ref":"#/components/schemas/XiqAddress","description":"The address for the site"},"country_code":{"type":"integer","format":"int32","description":"The site country code. Get the list of country codes from /countries XAPI."},"latitude":{"type":"number","format":"double","description":"The latitude coordinate for the site"},"longitude":{"type":"number","format":"double","description":"The longitude coordinate for the site"}},"required":["country_code","name"]},"XiqSite":{"type":"object","description":"The site location information.","properties":{"id":{"type":"integer","format":"int64","description":"The unique identifier"},"create_time":{"type":"string","format":"date-time","description":"The create time in UTC (ISO 8601 format)"},"update_time":{"type":"string","format":"date-time","description":"The last update time in UTC (ISO 8601 format)"},"org_id":{"type":"integer","format":"int64","description":"The organization identifier, valid when enabling HIQ feature"},"parent_id":{"type":"integer","format":"int64","description":"The parent site group ID"},"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","description":"The address for the site"},"country_code":{"type":"integer","format":"int32","description":"The country code for the site"},"created_by":{"type":"integer","format":"int64","description":"The user ID used to create the site"},"latitude":{"type":"number","format":"double","description":"The latitude coordinate for the site"},"longitude":{"type":"number","format":"double","description":"The longitude coordinate for the site"}},"required":["country_code","create_time","id","name","type","unique_name","update_time"]},"XiqUpdateZoneRequest":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"The Zone ID"},"name":{"type":"string","description":"The Zone name","minLength":1},"color":{"type":"string","description":"The Zone color","minLength":1},"zone_vertical_align":{"$ref":"#/components/schemas/XiqZoneVerticalAlign","description":"The Zone vertical alignment"},"visible":{"type":"boolean","description":"The visibility of the zone"},"coordinates":{"type":"array","description":"The Zone coordinates","items":{"$ref":"#/components/schemas/XiqZonePoint"}}},"required":["color","coordinates","id","name","visible","zone_vertical_align"]},"XiqUpdateZonesRequest":{"type":"object","properties":{"folder_id":{"type":"integer","format":"int64","description":"The Folder ID"},"zones":{"type":"array","description":"The list of zones to update","items":{"$ref":"#/components/schemas/XiqUpdateZoneRequest"},"minItems":1}},"required":["folder_id","zones"]},"XiqZonePoint":{"type":"object","properties":{"x":{"type":"number","format":"double","description":"The X coordinate of the zone point"},"y":{"type":"number","format":"double","description":"The Y coordinate of the zone point"}},"required":["x","y"]},"XiqZoneVerticalAlign":{"type":"string","enum":["TOP","BOTTOM"]},"XiqZone":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"The Zone ID"},"name":{"type":"string","description":"The Zone name","minLength":1},"color":{"type":"string","description":"The Zone color","minLength":1},"folder_id":{"type":"integer","format":"int64","description":"The Folder ID"},"zone_vertical_align":{"$ref":"#/components/schemas/XiqZoneVerticalAlign","description":"The Zone vertical alignment"},"visible":{"type":"boolean","description":"The visibility of the zone"},"coordinates":{"type":"array","description":"The Zone coordinates","items":{"$ref":"#/components/schemas/XiqZonePoint"}},"owner_id":{"type":"integer","format":"int64","description":"The Owner ID"},"org_id":{"type":"integer","format":"int64","description":"The Org ID"}},"required":["color","folder_id","id","name","org_id","visible","zone_vertical_align"]},"XiqMeasurementUnit":{"type":"string","enum":["FEET","METERS"]},"XiqRfEnvironmentType":{"type":"string","enum":["AUTO_ESTIMATE","OFFICE","OUTDOOR_FREE_SPACE","OBSTRUCTED_IN_BUILDING","OUTDOOR_SUBURBAN","WAREHOUSE","OUTDOOR_DENSE_URBAN"]},"XiqUpdateFloorRequest":{"type":"object","properties":{"parent_id":{"type":"integer","format":"int64","description":"The parent location ID"},"name":{"type":"string","description":"The floor name"},"environment":{"$ref":"#/components/schemas/XiqRfEnvironmentType","description":"The floor RF environment"},"db_attenuation":{"type":"number","format":"double","description":"The floor attenuation in dBs"},"measurement_unit":{"$ref":"#/components/schemas/XiqMeasurementUnit","description":"The measurement unit in feet/meters"},"installation_height":{"type":"number","format":"double","description":"The installation height"},"map_size_width":{"type":"number","format":"double","description":"The floor map width"},"map_size_height":{"type":"number","format":"double","description":"The floor map height"},"map_name":{"type":"string","description":"The floor map name"}},"required":["db_attenuation","installation_height","map_size_height","map_size_width","measurement_unit","name","parent_id"]},"XiqFloor":{"type":"object","description":"The Floor information on the floorplan.","properties":{"id":{"type":"integer","format":"int64","description":"The unique identifier"},"create_time":{"type":"string","format":"date-time","description":"The create time in UTC (ISO 8601 format)"},"update_time":{"type":"string","format":"date-time","description":"The last update time in UTC (ISO 8601 format)"},"org_id":{"type":"integer","format":"int64","description":"The organization identifier, valid when enabling HIQ feature"},"parent_id":{"type":"integer","format":"int64","description":"The parent building ID"},"name":{"type":"string","description":"The floor name"},"unique_name":{"type":"string","description":"The floor unique name"},"environment":{"$ref":"#/components/schemas/XiqRfEnvironmentType","description":"The floor RF environment"},"db_attenuation":{"type":"number","format":"double","description":"The floor attenuation in dBs"},"measurement_unit":{"$ref":"#/components/schemas/XiqMeasurementUnit","description":"The measurement unit in feet/meters"},"installation_height":{"type":"number","format":"double","description":"The installation height"},"map_size_width":{"type":"number","format":"double","description":"The floormap width"},"map_size_height":{"type":"number","format":"double","description":"The floormap height"},"map_name":{"type":"string","description":"The floormap name"}},"required":["create_time","db_attenuation","environment","id","installation_height","measurement_unit","name","parent_id","unique_name","update_time"]},"XiqFloorMapLabel":{"type":"object","description":"Floor Map Label information.","properties":{"id":{"type":"integer","format":"int64","description":"The Floor Map Label, its id"},"floor_id":{"type":"integer","format":"int64","description":"The Floor, its id"},"x":{"type":"number","format":"double","description":"The Floor Map Label, its x coordinate on the map"},"y":{"type":"number","format":"double","description":"The Floor Map Label, its y coordinate on the map"},"text":{"type":"string","description":"The Floor Map Label, its text."},"visible":{"type":"boolean","description":"Visible?"}},"required":["id","text","x","y"]},"XiqUpdateBuildingRequest":{"type":"object","properties":{"parent_id":{"type":"integer","format":"int64","description":"The parent location ID"},"name":{"type":"string","description":"The building name"},"address":{"$ref":"#/components/schemas/XiqAddress","description":"The street address"},"latitude":{"type":"number","format":"double","description":"The latitude coordinate for the building"},"longitude":{"type":"number","format":"double","description":"The longitude coordinate for the building"}},"required":["address","name","parent_id"]},"XiqBuilding":{"type":"object","description":"The Building information on the floorplan.","properties":{"id":{"type":"integer","format":"int64","description":"The unique identifier"},"create_time":{"type":"string","format":"date-time","description":"The create time in UTC (ISO 8601 format)"},"update_time":{"type":"string","format":"date-time","description":"The last update time in UTC (ISO 8601 format)"},"org_id":{"type":"integer","format":"int64","description":"The organization identifier, valid when enabling HIQ feature"},"parent_id":{"type":"integer","format":"int64","description":"The parent location ID"},"name":{"type":"string","description":"The building name"},"address":{"$ref":"#/components/schemas/XiqAddress","description":"The building street address"},"latitude":{"type":"number","format":"double","description":"The latitude coordinate for the building"},"longitude":{"type":"number","format":"double","description":"The longitude coordinate for the building"}},"required":["create_time","id","name","parent_id","update_time"]},"XiqLdapProtocolType":{"type":"string","enum":["LDAP","LDAPS"]},"XiqLdapServerVerificationMode":{"type":"string","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","format":"int64","description":"The L3 address profile ID"},"protocol_type":{"$ref":"#/components/schemas/XiqLdapProtocolType","description":"LDAP server protocol type"},"enable_strip_realm_name":{"type":"boolean","description":"enable strip realm name or not"},"destination_port":{"type":"integer","format":"int32","description":"The LDAP server destination port (1 ~ 65535)","minimum":1},"verification_mode":{"$ref":"#/components/schemas/XiqLdapServerVerificationMode","description":"The LDAP server verification mode"},"ca_certificate_id":{"type":"integer","format":"int64","description":"The CA certificate ID, refer to XiqCertificate"},"client_certificate_id":{"type":"integer","format":"int64","description":"The client certificate ID, refer to XiqCertificate"},"client_key_id":{"type":"integer","format":"int64","description":"The client key ID, refer to XiqCertificate"}}},"XiqLdapServer":{"type":"object","description":"The common object - LDAP server","properties":{"id":{"type":"integer","format":"int64","description":"The unique identifier"},"create_time":{"type":"string","format":"date-time","description":"The create time in UTC (ISO 8601 format)"},"update_time":{"type":"string","format":"date-time","description":"The last update time in UTC (ISO 8601 format)"},"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","format":"int64","description":"The L3 address profile ID"},"protocol_type":{"$ref":"#/components/schemas/XiqLdapProtocolType","description":"The LDAP server protocol type"},"enable_strip_realm_name":{"type":"boolean","description":"Enable strip realm name or not"},"destination_port":{"type":"integer","format":"int32","description":"The LDAP server destination port"},"verification_mode":{"$ref":"#/components/schemas/XiqLdapServerVerificationMode","description":"The LDAP server verification mode"},"ca_certificate_id":{"type":"integer","format":"int64","description":"The CA certificate ID"},"client_certificate_id":{"type":"integer","format":"int64","description":"The client certificate ID"},"client_key_id":{"type":"integer","format":"int64","description":"The client key ID"},"client_key_password":{"type":"string","description":"The LDAP server client key password"}},"required":["create_time","id","name","update_time"]},"XiqAddressProfileClassifiedEntry":{"type":"object","description":"The address profile classified entries.","properties":{"class_asgn_id":{"type":"integer","format":"int64","description":"The classification assignment id value."},"value":{"type":"string","description":"The classified entry value."},"description":{"type":"string","description":"The classified entry description."},"netmask":{"type":"string","description":"The classified entry netmask"},"ip_address_end":{"type":"string","description":"The classified entry IP address end."},"wildcard_mask":{"type":"string","description":"The classified entry wildcard mask."}}},"XiqUpdateL3AddressProfileRequest":{"type":"object","properties":{"name":{"type":"string","description":"The L3 Address profile name"},"description":{"type":"string","description":"The L3 Address profile description"},"enable_classification":{"type":"boolean","description":"The flag to enable classification entries on host name address profile"},"classified_entries":{"type":"array","description":"The host name address profile classified entries","items":{"$ref":"#/components/schemas/XiqAddressProfileClassifiedEntry"}},"ip_address_end":{"type":"string","description":"The classified entry IP address end, only available for \"IP_RANGE\" address type"},"netmask":{"type":"string","description":"The classified entry IP address end, only available for \"IP_SUBNET\" address type"},"wildcard_mask":{"type":"string","description":"The wildcard address profile mask value, only available for \"WILDCARD\" address type"}},"required":["name"]},"XiqHostNameAddressProfile":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"The unique identifier"},"create_time":{"type":"string","format":"date-time","description":"The create time in UTC (ISO 8601 format)"},"update_time":{"type":"string","format":"date-time","description":"The last update time in UTC (ISO 8601 format)"},"org_id":{"type":"integer","format":"int64","description":"The organization identifier, valid when enabling HIQ feature"},"predefined":{"type":"boolean","description":"Flag to describe whether the application is predefined or customised"},"name":{"type":"string","description":"Address profile name"},"description":{"type":"string","description":"Address profile description"},"value":{"type":"string","description":"Address profile value"},"enable_classification":{"type":"boolean","description":"The flag to enable classification on L3 address profile"},"address_type":{"$ref":"#/components/schemas/XiqL3AddressType","description":"Address type"},"classified_entries":{"type":"array","description":"The address profile classified entries","items":{"$ref":"#/components/schemas/XiqAddressProfileClassifiedEntry"}}},"required":["address_type","create_time","id","name","update_time"]},"XiqIpAddressProfile":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"The unique identifier"},"create_time":{"type":"string","format":"date-time","description":"The create time in UTC (ISO 8601 format)"},"update_time":{"type":"string","format":"date-time","description":"The last update time in UTC (ISO 8601 format)"},"org_id":{"type":"integer","format":"int64","description":"The organization identifier, valid when enabling HIQ feature"},"predefined":{"type":"boolean","description":"Flag to describe whether the application is predefined or customised"},"name":{"type":"string","description":"Address profile name"},"description":{"type":"string","description":"Address profile description"},"value":{"type":"string","description":"Address profile value"},"enable_classification":{"type":"boolean","description":"The flag to enable classification on L3 address profile"},"address_type":{"$ref":"#/components/schemas/XiqL3AddressType","description":"Address type"},"classified_entries":{"type":"array","description":"The address profile classified entries","items":{"$ref":"#/components/schemas/XiqAddressProfileClassifiedEntry"}}},"required":["address_type","create_time","id","name","update_time"]},"XiqIpRangeAddressProfile":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"The unique identifier"},"create_time":{"type":"string","format":"date-time","description":"The create time in UTC (ISO 8601 format)"},"update_time":{"type":"string","format":"date-time","description":"The last update time in UTC (ISO 8601 format)"},"org_id":{"type":"integer","format":"int64","description":"The organization identifier, valid when enabling HIQ feature"},"predefined":{"type":"boolean","description":"Flag to describe whether the application is predefined or customised"},"name":{"type":"string","description":"Address profile name"},"description":{"type":"string","description":"Address profile description"},"value":{"type":"string","description":"Address profile value"},"enable_classification":{"type":"boolean","description":"The flag to enable classification on L3 address profile"},"address_type":{"$ref":"#/components/schemas/XiqL3AddressType","description":"Address type"},"classified_entries":{"type":"array","description":"The address profile classified entries","items":{"$ref":"#/components/schemas/XiqAddressProfileClassifiedEntry"}},"ip_address_end":{"type":"string","description":"The classified entry IP address end."}},"required":["address_type","create_time","id","name","update_time"]},"XiqL3AddressProfileResponse":{"type":"object","description":"The response for creating an address profile","properties":{"ip_address_profile":{"$ref":"#/components/schemas/XiqIpAddressProfile"},"wildcard_address_profile":{"$ref":"#/components/schemas/XiqWildcardAddressProfile"},"wildcard_host_name_address_profile":{"$ref":"#/components/schemas/XiqWildcardHostNameAddressProfile"},"subnet_address_profile":{"$ref":"#/components/schemas/XiqSubnetAddressProfile"},"ip_range_address_profile":{"$ref":"#/components/schemas/XiqIpRangeAddressProfile"},"host_name_address_profile":{"$ref":"#/components/schemas/XiqHostNameAddressProfile"}}},"XiqL3AddressType":{"type":"string","enum":["IP_ADDRESS","IP_SUBNET","IP_RANGE","HOST_NAME","WILDCARD_HOST_NAME","WILDCARD"]},"XiqSubnetAddressProfile":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"The unique identifier"},"create_time":{"type":"string","format":"date-time","description":"The create time in UTC (ISO 8601 format)"},"update_time":{"type":"string","format":"date-time","description":"The last update time in UTC (ISO 8601 format)"},"org_id":{"type":"integer","format":"int64","description":"The organization identifier, valid when enabling HIQ feature"},"predefined":{"type":"boolean","description":"Flag to describe whether the application is predefined or customised"},"name":{"type":"string","description":"Address profile name"},"description":{"type":"string","description":"Address profile description"},"value":{"type":"string","description":"Address profile value"},"enable_classification":{"type":"boolean","description":"The flag to enable classification on L3 address profile"},"address_type":{"$ref":"#/components/schemas/XiqL3AddressType","description":"Address type"},"classified_entries":{"type":"array","description":"The address profile classified entries","items":{"$ref":"#/components/schemas/XiqAddressProfileClassifiedEntry"}},"netmask":{"type":"string","description":"The Subnet address netmask."}},"required":["address_type","create_time","id","name","update_time"]},"XiqWildcardAddressProfile":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"The unique identifier"},"create_time":{"type":"string","format":"date-time","description":"The create time in UTC (ISO 8601 format)"},"update_time":{"type":"string","format":"date-time","description":"The last update time in UTC (ISO 8601 format)"},"org_id":{"type":"integer","format":"int64","description":"The organization identifier, valid when enabling HIQ feature"},"predefined":{"type":"boolean","description":"Flag to describe whether the application is predefined or customised"},"name":{"type":"string","description":"Address profile name"},"description":{"type":"string","description":"Address profile description"},"value":{"type":"string","description":"Address profile value"},"enable_classification":{"type":"boolean","description":"The flag to enable classification on L3 address profile"},"address_type":{"$ref":"#/components/schemas/XiqL3AddressType","description":"Address type"},"classified_entries":{"type":"array","description":"The address profile classified entries","items":{"$ref":"#/components/schemas/XiqAddressProfileClassifiedEntry"}},"wildcard_mask":{"type":"string","description":"The wildcard address profile mask value."}},"required":["address_type","create_time","id","name","update_time"]},"XiqWildcardHostNameAddressProfile":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"The unique identifier"},"create_time":{"type":"string","format":"date-time","description":"The create time in UTC (ISO 8601 format)"},"update_time":{"type":"string","format":"date-time","description":"The last update time in UTC (ISO 8601 format)"},"org_id":{"type":"integer","format":"int64","description":"The organization identifier, valid when enabling HIQ feature"},"predefined":{"type":"boolean","description":"Flag to describe whether the application is predefined or customised"},"name":{"type":"string","description":"Address profile name"},"description":{"type":"string","description":"Address profile description"},"value":{"type":"string","description":"Address profile value"},"enable_classification":{"type":"boolean","description":"The flag to enable classification on L3 address profile"},"address_type":{"$ref":"#/components/schemas/XiqL3AddressType","description":"Address type"},"classified_entries":{"type":"array","description":"The address profile classified entries","items":{"$ref":"#/components/schemas/XiqAddressProfileClassifiedEntry"}}},"required":["address_type","create_time","id","name","update_time"]},"XiqIpFirewallAction":{"type":"string","enum":["PERMIT","DENY","TRAFFIC_DROP","NAT","REDIRECT"]},"XiqIpFirewallPolicyRequest":{"type":"object","description":"The IP Firewall policy.","properties":{"name":{"type":"string","description":"The IP firewall policy name"},"description":{"type":"string","description":"The IP firewall policy description."},"rules":{"type":"array","description":"List of IP Firewall Rules.....","items":{"$ref":"#/components/schemas/XiqIpFirewallRuleRequest"}}}},"XiqIpFirewallRuleRequest":{"type":"object","properties":{"action":{"$ref":"#/components/schemas/XiqIpFirewallAction","description":"The IP Firewall Action."},"service_id":{"type":"integer","format":"int64","description":"Application or Network Service ID for IP Firewall Rule."},"source_ip_id":{"type":"integer","format":"int64","description":"Source IP for IP Firewall Rule."},"destination_ip_id":{"type":"integer","format":"int64","description":"Destination IP for IP Firewall Rule."},"logging_type":{"$ref":"#/components/schemas/XiqLoggingType","description":"The logging Type for IP Firewall Rule."}}},"XiqApplication":{"type":"object","description":"The Application Model","properties":{"id":{"type":"integer","format":"int64","description":"The unique identifier"},"create_time":{"type":"string","format":"date-time","description":"The create time in UTC (ISO 8601 format)"},"update_time":{"type":"string","format":"date-time","description":"The last update time in UTC (ISO 8601 format)"},"org_id":{"type":"integer","format":"int64","description":"The organization identifier, valid when enabling HIQ feature"},"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","format":"int64","description":"The category ID of application"},"category_name":{"type":"string","description":"The category name of application"},"detection_rules":{"type":"array","description":"The application detection rules","items":{"$ref":"#/components/schemas/XiqApplicationDetectionRule"}}},"required":["create_time","id","update_time"]},"XiqApplicationDetectionProtocol":{"type":"string","enum":["HTTP","HTTPS"]},"XiqApplicationDetectionRule":{"type":"object","description":"The Application Detection Rule","properties":{"value":{"type":"string","description":"The value of detection rule type"},"protocol":{"$ref":"#/components/schemas/XiqApplicationDetectionProtocol","description":"The protocol of detection rule"},"type":{"$ref":"#/components/schemas/XiqApplicationDetectionType","description":"The type of detection rule"}}},"XiqApplicationDetectionType":{"type":"string","enum":["HOST_NAME","SERVER_IP_ADDRESS","PORT_NUMBER"]},"XiqApplicationService":{"type":"object","description":"Application service","properties":{"application":{"$ref":"#/components/schemas/XiqApplication","description":"Application"},"service_type":{"type":"string","description":"Service Type.","enum":["NETWORK","APPLICATION"]}}},"XiqIpFirewall":{"type":"object","description":"IP Firewall policy.","properties":{"id":{"type":"integer","format":"int64","description":"The unique identifier"},"create_time":{"type":"string","format":"date-time","description":"The create time in UTC (ISO 8601 format)"},"update_time":{"type":"string","format":"date-time","description":"The last update time in UTC (ISO 8601 format)"},"org_id":{"type":"integer","format":"int64","description":"The organization identifier, valid when enabling HIQ feature"},"name":{"type":"string","description":"The IP Firewall policy name"},"description":{"type":"string","description":"The IP Firewall policy description."},"rules":{"type":"array","description":"List of IP Firewall Rules.","items":{"$ref":"#/components/schemas/XiqIpFirewallRule"}},"predefined":{"type":"boolean","description":"Flag to describe whether the application is predefined or customized."}},"required":["create_time","id","update_time"]},"XiqIpFirewallRule":{"type":"object","description":"IP Firewall Rule","properties":{"id":{"type":"integer","format":"int64","description":"The unique identifier"},"create_time":{"type":"string","format":"date-time","description":"The create time in UTC (ISO 8601 format)"},"update_time":{"type":"string","format":"date-time","description":"The last update time in UTC (ISO 8601 format)"},"org_id":{"type":"integer","format":"int64","description":"The organization identifier, valid when enabling HIQ feature"},"action":{"$ref":"#/components/schemas/XiqIpFirewallAction","description":"The IP Firewall Action."},"network_service":{"$ref":"#/components/schemas/XiqNetworkService","description":"The IP Firewall Action."},"application_service":{"$ref":"#/components/schemas/XiqApplicationService","description":"The IP Firewall Action."},"source_ip":{"$ref":"#/components/schemas/XiqL3AddressProfile","description":"Source IP for IP Firewall Rule."},"destination_ip":{"$ref":"#/components/schemas/XiqL3AddressProfile","description":"Destination IP for IP Firewall Rule."},"logging_type":{"$ref":"#/components/schemas/XiqLoggingType","description":" The IP Firewall logging type."}},"required":["create_time","id","update_time"]},"XiqL3AddressProfile":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"The unique identifier"},"create_time":{"type":"string","format":"date-time","description":"The create time in UTC (ISO 8601 format)"},"update_time":{"type":"string","format":"date-time","description":"The last update time in UTC (ISO 8601 format)"},"org_id":{"type":"integer","format":"int64","description":"The organization identifier, valid when enabling HIQ feature"},"predefined":{"type":"boolean","description":"Flag to describe whether the application is predefined or customised"},"name":{"type":"string","description":"Address profile name"},"description":{"type":"string","description":"Address profile description"},"value":{"type":"string","description":"Address profile value"},"enable_classification":{"type":"boolean","description":"The flag to enable classification on L3 address profile"},"address_type":{"$ref":"#/components/schemas/XiqL3AddressType","description":"Address type"},"classified_entries":{"type":"array","description":"The address profile classified entries","items":{"$ref":"#/components/schemas/XiqAddressProfileClassifiedEntry"}}},"required":["address_type","create_time","id","name","update_time"]},"XiqNetworkAlgType":{"type":"string","enum":["NONE","FTP","TFTP","SIP","DNS","HTTP"]},"XiqNetworkIpProtocol":{"type":"string","enum":["TCP","UDP","SVP","CUSTOM"]},"XiqNetworkService":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"The unique identifier"},"create_time":{"type":"string","format":"date-time","description":"The create time in UTC (ISO 8601 format)"},"update_time":{"type":"string","format":"date-time","description":"The last update time in UTC (ISO 8601 format)"},"org_id":{"type":"integer","format":"int64","description":"The organization identifier, valid when enabling HIQ feature"},"name":{"type":"string","description":"The Network Service name"},"description":{"type":"string","description":"The Network Service description"},"ip_protocol":{"$ref":"#/components/schemas/XiqNetworkIpProtocol","description":"IP Protocol, only for custom Application."},"protocol_number":{"type":"integer","format":"int32","description":"The Network Protocol Number"},"port_number":{"type":"integer","format":"int32","description":"The Network Port Number"},"alg_type":{"$ref":"#/components/schemas/XiqNetworkAlgType","description":"Application Layer Gateway (ALG) type, only for custom Application."},"service_type":{"type":"string","description":"The Service Type.","enum":["NETWORK","APPLICATION"]}},"required":["create_time","id","service_type","update_time"]},"XiqHttpServer":{"type":"object","properties":{"url":{"type":"string","description":"The HTTP server URL.","maxLength":256,"minLength":0},"interval":{"type":"integer","format":"int32","description":"The HTTP server interval, in seconds.","maximum":60,"minimum":1},"enable_deduplication":{"type":"boolean","description":"Enable to remove BLE scan duplicates entries within the specified time interval."}}},"XiqIotApplicationId":{"type":"string","enum":["THREAD_GATEWAY"]},"XiqIotApplicationSupported":{"type":"string","enum":["SINGLE","MULTI"]},"XiqIotProfileRequest":{"type":"object","properties":{"name":{"type":"string","description":"The IoT profile name","minLength":1},"app_id":{"$ref":"#/components/schemas/XiqIotApplicationId","description":"The supported IoT applications."},"thread_gateway":{"$ref":"#/components/schemas/XiqIotProfileThreadGateway","description":"Thread Gateway application settings."},"app_supported":{"$ref":"#/components/schemas/XiqIotApplicationSupported","description":"The supported IoT profile type."},"ble_beacon":{"$ref":"#/components/schemas/XiqIotpMaBleBeacon","description":"BLE Beacon"},"ble_scan":{"$ref":"#/components/schemas/XiqIotpMaBleScan","description":"BLE Scan"}},"required":["app_id","app_supported","name"]},"XiqIotProfileThreadGateway":{"type":"object","properties":{"short_pan_id":{"type":"string","description":"The Personal Area Network (PAN) ID. (4 hex digits). FFFF is reserved.","maxLength":4,"minLength":4,"pattern":"^[0-9a-fA-F]+$"},"ext_pan_id":{"type":"string","description":"The Extended Personal Area Network (PAN) ID. (16 hex digits)","maxLength":16,"minLength":16,"pattern":"^[0-9a-fA-F]+$"},"master_key":{"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)","maxLength":32,"minLength":32,"pattern":"^[0-9a-fA-F]+$"},"network_name":{"type":"string","description":"A human-readable name for the network, up to 16 bytes in length.","maxLength":16,"minLength":1},"channel":{"type":"integer","format":"int32","description":"802.15.4 channel number, 11-26","minimum":0},"comm_credentials":{"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).","maxLength":255,"minLength":6,"pattern":"^.{6,255}$"},"comm_timeout":{"type":"integer","format":"int32","description":"After this timeout the Commissioner will shutdown. The default is 120 sec. but the max is approximately 23 days.","maximum":2000000,"minimum":1},"enable_nat64":{"type":"boolean","description":"Enable NAT64 functions including the translator and the prefix publishing."},"enable_dns_search_domain":{"type":"boolean","description":"Enable adding DNS search domain to unqualified host lookups forwarded by upstream DNS (in the thread border router)."},"white_list":{"type":"array","items":{"$ref":"#/components/schemas/XiqIotpTgWhiteListEntry"}},"default_user_profile_id":{"type":"integer","format":"int64","description":"The default user-profile ID."}},"required":["channel","ext_pan_id","master_key","network_name","short_pan_id"]},"XiqIotpMaBleBeacon":{"type":"object","properties":{"applications":{"type":"array","description":"Collection of BLE Beacon applications","items":{"$ref":"#/components/schemas/XiqIotpMaBleBeaconApplication"}}}},"XiqIotpMaBleBeaconAppType":{"type":"string","enum":["IBEACON","EDDYSTONE_URL"]},"XiqIotpMaBleBeaconApplication":{"type":"object","properties":{"measured_rss":{"type":"integer","format":"int32","description":"BLE Beacon application measured Received Signal Strength value, in dBm.","maximum":15,"minimum":-120},"advertise_interval":{"type":"integer","format":"int32","description":"BLE Beacon application advertisement interval value in ms.","maximum":10240,"minimum":100},"tx_power":{"type":"integer","format":"int32","description":"// The BLE Beacon transmit power, in dBm.","maximum":3,"minimum":-16},"major":{"type":"integer","format":"int32","description":"BLE Beacon application major value, for BLE Beacon applications of type IBEACON.","maximum":65535,"minimum":0},"minor":{"type":"integer","format":"int32","description":"BLE Beacon application minor value, for BLE Beacon applications of type IBEACON.","maximum":65535,"minimum":0},"uuid":{"type":"string","description":"BLE Beacon application UUID, for BLE Beacon applications of type IBEACON.","pattern":"^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"},"url":{"type":"string","description":"BLE Beacon Eddystone URL, for BLE Beacon applications of type EDDYSTONE_URL.","maxLength":34,"minLength":0},"app_type":{"$ref":"#/components/schemas/XiqIotpMaBleBeaconAppType","description":"The BLE Beacon application type."}},"required":["app_type"]},"XiqIotpMaBleScan":{"type":"object","properties":{"destination":{"$ref":"#/components/schemas/XiqIotpMaBleScanDestination","description":"The BLE Scan destination settings."},"applications":{"type":"array","description":"Collection of BLE Scan applications","items":{"$ref":"#/components/schemas/XiqIotpMaBleScanApplication"}}}},"XiqIotpMaBleScanAppType":{"type":"string","enum":["IBEACON","EDDYSTONE_URL","GENERIC"]},"XiqIotpMaBleScanApplication":{"type":"object","properties":{"min_rss":{"type":"integer","format":"int32","description":"BLE Scan application minimum Received Signal Strength value, in dBm.","maximum":20,"minimum":-120},"uuid":{"type":"string","description":"BLE Scan iBeacon application UUID, for BLE Scan applications of type IBEACON.","pattern":"^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"},"vendors":{"type":"array","description":"Collection of BLE Scan vendor filters for Generic Scan applications, for BLE Scan applications of type GENERIC.","items":{"$ref":"#/components/schemas/XiqIotpMaBleScanVendor"}},"app_type":{"$ref":"#/components/schemas/XiqIotpMaBleScanAppType","description":"The BLE Scan application type."}},"required":["app_type"]},"XiqIotpMaBleScanDestination":{"type":"object","properties":{"interval":{"type":"integer","format":"int32","description":"The XIQ report interval, in seconds.","maximum":60,"minimum":1},"http_server":{"$ref":"#/components/schemas/XiqHttpServer","description":"The BLE Scan destination HTTP server URL."}}},"XiqIotpMaBleScanVendor":{"type":"object","properties":{"vendor_type":{"$ref":"#/components/schemas/XiqIotpMaBleScanVendorType","description":"BLE Scan Vendor type."},"vendor_name":{"type":"string","description":"Custom Vendor name, for CUSTOM Vendor type."},"company_id":{"type":"integer","format":"int32","description":"Custom Vendor company ID, for CUSTOM Vendor type.","maximum":65535,"minimum":-1}}},"XiqIotpMaBleScanVendorType":{"type":"string","enum":["ANY","CHORUS","CUSTOM"]},"XiqIotpTgWhiteListEntry":{"type":"object","properties":{"long_eui":{"type":"string","description":"The factory-assigned IEEE EUI-64. (16 hex digits) or * to match any joiner. FFFFFFFFFFFFFFFF is reserved.","pattern":"^([*]|[0-9a-fA-F]{16})$"},"pskd":{"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.","maxLength":32,"minLength":6,"pattern":"^[0-9ABCDEFGHJKLMNPRSTUVWXY]+$"}},"required":["long_eui","pskd"]},"XiqIotProfile":{"type":"object","description":"The payload of IoT Profile","properties":{"id":{"type":"integer","format":"int64","description":"The unique identifier"},"create_time":{"type":"string","format":"date-time","description":"The create time in UTC (ISO 8601 format)"},"update_time":{"type":"string","format":"date-time","description":"The last update time in UTC (ISO 8601 format)"},"name":{"type":"string","description":"The IoT profile name","minLength":1},"app_id":{"$ref":"#/components/schemas/XiqIotApplicationId","description":"IoT application identifiers."},"thread_gateway":{"$ref":"#/components/schemas/XiqIotProfileThreadGateway","description":"Thread Gateway application settings."},"app_supported":{"$ref":"#/components/schemas/XiqIotApplicationSupported","description":"IoT profile supported type."},"ble_beacon":{"$ref":"#/components/schemas/XiqIotpMaBleBeacon","description":"BLE Beacon"},"ble_scan":{"$ref":"#/components/schemas/XiqIotpMaBleScan","description":"BLE Scan"}},"required":["create_time","id","name","update_time"]},"XiqHotspotCellularNetwork":{"type":"object","properties":{"mcc":{"type":"string","description":"Mobile Country Code (MCC).","pattern":"^\\d{3}$"},"mnc":{"type":"string","description":"MCC","pattern":"^\\d{2,3}$"},"description":{"type":"string","description":"MCC"}},"required":["mcc","mnc"]},"XiqHotspotEapMethod":{"type":"string","enum":["EAP_TTLS_PAP","EAP_TTLS_CHAP","EAP_TTLS_MSCHAP","EAP_TTLS_MSCHAPV2","EAP_TLS","EAP_SIM"]},"XiqHotspotLocalizedName":{"type":"object","properties":{"name":{"type":"string","description":"A language specific name, up to 252 byte UTF-8 string.","maxLength":252,"minLength":1},"language":{"type":"string","description":"Language code (3B abbreviation) found at: http://www.loc.gov/standards/iso639-2/ISO-639-2_utf-8.txt.","maxLength":3,"minLength":3,"pattern":"^[a-z]{3}$"}},"required":["name"]},"XiqHotspotNaiEncodingType":{"type":"string","enum":["RFC_4282","UTF_8"]},"XiqHotspotNaiRealm":{"type":"object","properties":{"name":{"type":"string","description":"The Network Access Identifier (NAI) Realm name"},"description":{"type":"string","description":"The NAI Realm description."},"eap_methods":{"type":"array","description":"The list of Extensible Authentication Protocol (EAP) methods.","items":{"$ref":"#/components/schemas/XiqHotspotEapMethod"}},"encoding_type":{"$ref":"#/components/schemas/XiqHotspotNaiEncodingType","description":"The NAI realm encoding type."}},"required":["name"]},"XiqHotspotRoamingConsortium":{"type":"object","properties":{"consortium_id":{"type":"string","description":"IEEE-assigned Organizational Identifier (OI).","pattern":"^[0-9A-Fa-f]{6,30}$"},"description":{"type":"string","description":"Description of Roaming Consortium OI."}},"required":["consortium_id"]},"XiqHotspotServiceProviderIconFile":{"type":"object","properties":{"file_directory_name":{"type":"string","description":"Hotspot Service Provider profile icon file directory name.","maxLength":32,"minLength":1},"file":{"type":"string","description":"Hotspot Service Provider profile icon file.","maxLength":32,"minLength":1},"language":{"type":"string","description":"Hotspot Service Provider profile icon file language.","maxLength":255,"minLength":1}},"required":["file","file_directory_name"]},"XiqHotspotServiceProviderOsuMethod":{"type":"string","enum":["OMA_DM","SOAP_XML_SPP"]},"XiqHotspotServiceProviderProfileRequest":{"type":"object","properties":{"name":{"type":"string","description":"The Hotspot Service Provider profile name."},"description":{"type":"string","description":"The Hotspot Service Provider profile description."},"friendly_names":{"type":"array","description":"List of friendly names.","items":{"$ref":"#/components/schemas/XiqHotspotLocalizedName"}},"descriptions":{"type":"array","description":"List of Hotspot profile descriptions","items":{"$ref":"#/components/schemas/XiqHotspotLocalizedName"}},"icon_files":{"type":"array","description":"The list of localized icon files for the service provider.","items":{"$ref":"#/components/schemas/XiqHotspotServiceProviderIconFile"}},"nai_realms":{"type":"array","description":"List of Network Access Identification (NAI) realms. A NAI realm is a FQDN of a service provider.","items":{"$ref":"#/components/schemas/XiqHotspotNaiRealm"}},"roaming_consortiums":{"type":"array","description":"List of Roaming Consortium identifiers.","items":{"$ref":"#/components/schemas/XiqHotspotRoamingConsortium"}},"cellular_networks":{"type":"array","description":"List of 3rd Generation Partnership Project (3GPP) cellular networks.","items":{"$ref":"#/components/schemas/XiqHotspotCellularNetwork"}},"osu_uri":{"type":"string","description":"The online signup (OSU) server URI."},"osu_methods":{"type":"array","description":"Encoded OSU methods and their priorities. Priority is given by the index/position in the array.","items":{"$ref":"#/components/schemas/XiqHotspotServiceProviderOsuMethod"}},"osu_nai":{"type":"string","description":"Network Access Identifier (NAI) used as client identity during EAP authentication."}}},"XiqHotspotServiceProviderProfile":{"type":"object","description":"The payload of Hotspot Service Provider profile","properties":{"id":{"type":"integer","format":"int64","description":"The unique identifier"},"create_time":{"type":"string","format":"date-time","description":"The create time in UTC (ISO 8601 format)"},"update_time":{"type":"string","format":"date-time","description":"The last update time in UTC (ISO 8601 format)"},"name":{"type":"string","description":"The Hotspot Service Provider profile name."},"friendly_names":{"type":"array","description":"List of friendly names.","items":{"$ref":"#/components/schemas/XiqHotspotLocalizedName"}},"descriptions":{"type":"array","description":"List of Hotspot profile descriptions","items":{"$ref":"#/components/schemas/XiqHotspotLocalizedName"}},"icon_files":{"type":"array","description":"The list of localized icon files for the service provider.","items":{"$ref":"#/components/schemas/XiqHotspotServiceProviderIconFile"}},"nai_realms":{"type":"array","description":"List of Network Access Identification (NAI) realms. A NAI realm is a FQDN of a service provider.","items":{"$ref":"#/components/schemas/XiqHotspotNaiRealm"}},"roaming_consortiums":{"type":"array","description":"List of Roaming Consortium identifiers.","items":{"$ref":"#/components/schemas/XiqHotspotRoamingConsortium"}},"cellular_networks":{"type":"array","description":"List of 3rd Generation Partnership Project (3GPP) cellular networks.","items":{"$ref":"#/components/schemas/XiqHotspotCellularNetwork"}},"osu_uri":{"type":"string","description":"The online signup (OSU) server URI."},"osu_methods":{"type":"array","description":"Encoded OSU methods and their priorities. Priority is given by the index/position in the array.","items":{"$ref":"#/components/schemas/XiqHotspotServiceProviderOsuMethod"}},"osu_nai":{"type":"string","description":"Network Access Identifier (NAI) used as client identity during EAP authentication."}},"required":["create_time","id","name","update_time"]},"XiqHotspotAccessNetworkType":{"type":"string","enum":["PRIVATE","PRIVATE_WITH_GUEST","CHARGEABLE_PUBLIC","FREE_PUBLIC","PERSONAL_DEVICE","EMERGENCY","TEST","WILDCARD"]},"XiqHotspotConnectionCapability":{"type":"object","properties":{"protocol":{"$ref":"#/components/schemas/XiqHotspotConnectionCapabilityProtocol","description":"IP protocol number available from [IANA Protocol Numbers](https://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml)."},"port_number":{"type":"integer","format":"int32","description":"The port number.","maximum":65535,"minimum":0},"status":{"$ref":"#/components/schemas/XiqHotspotConnectionCapabilityStatus","description":"The Hotspot Connection Capability status."}},"required":["port_number","protocol","status"]},"XiqHotspotConnectionCapabilityProtocol":{"type":"string","enum":["ESP","ICMP","TCP","UDP"]},"XiqHotspotConnectionCapabilityStatus":{"type":"string","enum":["CLOSED","OPEN","UNKNOWN"]},"XiqHotspotIpv4AvailabilityType":{"type":"string","enum":["NOT_AVAILABLE","PUBLIC","PORT_RESTRICTED","SINGLE_NAT","DOUBLE_NAT","PORT_RESTRICTED_SINGLE_NAT","PORT_RESTRICTED_DOUBLE_NAT","UNKNOWN"]},"XiqHotspotIpv6AvailabilityType":{"type":"string","enum":["NOT_AVAILABLE","AVAILABLE","UNKNOWN"]},"XiqHotspotOnlineSignup":{"type":"object","properties":{"network_auth_type":{"$ref":"#/components/schemas/XiqHotspotOsuNetworkAuthType","description":"The Network Authentication type for Hotspot profiles."},"redirection_url":{"type":"string","description":"The redirection URL, when the Network Authentication type is CWP.","maxLength":256,"minLength":0},"ssid_id":{"type":"integer","format":"int64","description":"OSU SSID ID, when the Network Authentication type is ONLINE_SIGN_UP. The authentication mode must be open or OSEN."}},"required":["network_auth_type"]},"XiqHotspotOsuNetworkAuthType":{"type":"string","enum":["ACCEPTANCE_TERMS","ONLINE_SIGN_UP","CWP"]},"XiqHotspotProfileRequest":{"type":"object","properties":{"name":{"type":"string","description":"The Hotspot profile name"},"hessid":{"type":"string","description":"Homogenous Extended Service Set Identifier (HESSID) for a Hotspot 2.0 network.","pattern":"^([0-9a-fA-F]{2}[:]){5}([0-9a-fA-F]{2})$"},"domain_name":{"type":"string","description":"The domain name of the entity or organization operating the IEEE 802.11 access network.","maxLength":255,"minLength":0},"operator_names":{"type":"array","description":"Localized names for the Hotspot operator.","items":{"$ref":"#/components/schemas/XiqHotspotLocalizedName"}},"venue":{"$ref":"#/components/schemas/XiqHotspotVenue","description":"Venue information helps client devices understand the type and nature of the location where the Wi-Fi network is deployed."},"access_network_type":{"$ref":"#/components/schemas/XiqHotspotAccessNetworkType","description":"The Hotspot profile Access Network type."},"dgaf":{"type":"boolean","description":"Downstream Group Address Forwarding (DGAF). Forward all downlink wireless broadcast ARP and multicast packets."},"ipv4_availability":{"$ref":"#/components/schemas/XiqHotspotIpv4AvailabilityType","description":"The IPv4 address availability type."},"ipv6_availability":{"$ref":"#/components/schemas/XiqHotspotIpv6AvailabilityType","description":"The IPv6 address availability type."},"wan_metrics":{"$ref":"#/components/schemas/XiqHotspotWanMetrics","description":"Hotspot WAN (Wide Area Network) metrics."},"connection_capabilities":{"type":"array","description":"The connection capability informs client devices about available network services.","items":{"$ref":"#/components/schemas/XiqHotspotConnectionCapability"}},"qos_map":{"$ref":"#/components/schemas/XiqHotspotQosMap","description":"Quality of Service (QoS) map for Hotspot profile."},"gas_comeback_delay":{"type":"integer","format":"int32","description":"Generic Advertisement Service (GAS) comeback message delay time. The unit is Time Unit (TU) 1 TU = 1024 microseconds. When GAS delay is 0, there is no delay.","maximum":65535,"minimum":0},"anqp_domain_id":{"type":"integer","format":"int32","description":"The Access Network Query protocol (ANQP) domain ID.","maximum":65535,"minimum":0},"online_signup":{"$ref":"#/components/schemas/XiqHotspotOnlineSignup","description":"The Hotspot profile Online Signup settings."},"nai_realms":{"type":"array","description":"The list of Network Access Identification (NAI) realms.","items":{"$ref":"#/components/schemas/XiqHotspotNaiRealm"}},"roaming_consortiums":{"type":"array","description":"The list of Roaming Consortium network providers.","items":{"$ref":"#/components/schemas/XiqHotspotRoamingConsortium"}},"cellular_networks":{"type":"array","description":"List of 3rd Generation Partnership Project (3GPP) cellular networks.","items":{"$ref":"#/components/schemas/XiqHotspotCellularNetwork"}},"service_provider_ids":{"type":"array","description":"The list of Hotspot Service Provider IDs.","items":{"type":"integer","format":"int64"}}}},"XiqHotspotQosAhClassToDscpRange":{"type":"object","properties":{"ah_class":{"type":"integer","format":"int32","description":"Extreme QoS class value.","maximum":7,"minimum":0},"dscp_range_start":{"type":"integer","format":"int32","description":"Start value for DSCP range.","maximum":63,"minimum":0},"dscp_range_end":{"type":"integer","format":"int32","description":"End value for DSCP range.","maximum":63,"minimum":0}},"required":["ah_class","dscp_range_end","dscp_range_start"]},"XiqHotspotQosDscpException":{"type":"object","properties":{"ah_class":{"type":"integer","format":"int32","description":"Extreme QoS class value.","maximum":7,"minimum":0},"dscp_value":{"type":"integer","format":"int32","description":"Value for DSCP range.","maximum":63,"minimum":0}},"required":["ah_class","dscp_value"]},"XiqHotspotQosMap":{"type":"object","properties":{"dscp_ranges":{"type":"array","description":"A list of ah-class to DSCP range.","items":{"$ref":"#/components/schemas/XiqHotspotQosAhClassToDscpRange"}},"dscp_exceptions":{"type":"array","description":"The list of exceptions to the mapping of ah-class to DSCP values.","items":{"$ref":"#/components/schemas/XiqHotspotQosDscpException"}}}},"XiqHotspotVenue":{"type":"object","properties":{"venue_group":{"$ref":"#/components/schemas/XiqHotspotVenueGroup","description":"The venue group ID categorizes the general type of location."},"venue_type":{"$ref":"#/components/schemas/XiqHotspotVenueType","description":"The venue type ID further specifies the particular kind of location within the general venue group."},"names":{"type":"array","description":"Localized names for the venue.","items":{"$ref":"#/components/schemas/XiqHotspotLocalizedName"}}}},"XiqHotspotVenueGroup":{"type":"string","enum":["UNSPECIFIED","ASSEMBLY","BUSINESS","EDUCATIONAL","FACTORY_AND_INDUSTRIAL","INSTITUTIONAL","MERCANTILE","RESIDENTIAL","STORAGE","UTILITY_AND_MISCELLANEOUS","VEHICULAR","OUTDOOR"]},"XiqHotspotVenueType":{"type":"string","enum":["UNSPECIFIED","ARENA","STADIUM","PASSENGER_TERMINAL","AMPHITHEATRE","AMUSEMENT_PARK","PLACE_OF_WORSHIP","CONVENTION_CENTRE","LIBRARY","MUSEUM","RESTAURANT","THEATRE","BAR","COFFEE_SHOP","ZOO_OR_AQUARIUM","EMERGENCY_COORDINATION_CENTRE","DOCTOR_OR_DENTIST_OFFICE","BANK","FIRE_STATION","POLICE_STATION","POST_OFFICE","PROFESSIONAL_OFFICE","RESEARCH_AND_DEVELOPMENT_FACILITY","ATTORNEY_OFFICE","SCHOOL_PRIMARY","SCHOOL_SECONDARY","UNIVERSITY_OR_COLLEGE","FACTORY","HOSPITAL","LONG_TERM_CARE_FACILITY","ALCOHOL_AND_DRUG_REHABILITATION_CENTRE","GROUP_HOME","PRISON_OR_JAIL","RETAIL_STORE","GROCERY_MARKET","AUTOMOTIVE_SERVICE_STATION","SHOPPING_MALL","GAS_STATION","PRIVATE_RESIDENCE","HOTEL_OR_MOTEL","DORMITORY","BOARDING_HOUSE","AUTOMOBILE_OR_TRUCK","AIRPLANE","BUS","FERRY","SHIP_OR_BOAT","TRAIN","MOTOR_BIKE","MUNI_MESH_NETWORK","CITY_PARK","REST_AREA","TRAFFIC_CONTROL","BUS_STOP","KIOSK"]},"XiqHotspotWanLinkStatus":{"type":"string","enum":["DOWN","UP","TEST"]},"XiqHotspotWanMetrics":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/XiqHotspotWanLinkStatus","description":"The WAN metric status."},"downlink_speed":{"type":"integer","format":"int32","description":"The downlink speed for the WAN network, in kbps (where 0 is unknown).","maximum":4194304,"minimum":0},"uplink_speed":{"type":"integer","format":"int32","description":"The downlink speed for the WAN network, in kbps (where 0 is unknown).","maximum":4194304,"minimum":0}},"required":["downlink_speed","status","uplink_speed"]},"XiqHotspotProfile":{"type":"object","description":"The payload of Hotspot profile","properties":{"id":{"type":"integer","format":"int64","description":"The unique identifier"},"create_time":{"type":"string","format":"date-time","description":"The create time in UTC (ISO 8601 format)"},"update_time":{"type":"string","format":"date-time","description":"The last update time in UTC (ISO 8601 format)"},"name":{"type":"string","description":"The Hotspot profile name"},"hessid":{"type":"string","description":"Homogenous Extended Service Set Identifier (HESSID) for a Hotspot 2.0 network.","pattern":"^(|([0-9a-fA-F]{2}[:]){5}([0-9a-fA-F]{2}))$"},"domain_name":{"type":"string","description":"The domain name of the entity or organization operating the IEEE 802.11 access network.","maxLength":255,"minLength":0},"operator_names":{"type":"array","description":"Localized names for the Hotspot operator.","items":{"$ref":"#/components/schemas/XiqHotspotLocalizedName"}},"venue":{"$ref":"#/components/schemas/XiqHotspotVenue","description":"Venue information helps client devices understand the type and nature of the location where the Wi-Fi network is deployed."},"access_network_type":{"$ref":"#/components/schemas/XiqHotspotAccessNetworkType","description":"The Hotspot profile Access Network type."},"dgaf":{"type":"boolean","description":"Downstream Group Address Forwarding (DGAF). Forward all downlink wireless broadcast ARP and multicast packets."},"ipv4_availability":{"$ref":"#/components/schemas/XiqHotspotIpv4AvailabilityType","description":"The IPv4 address availability type."},"ipv6_availability":{"$ref":"#/components/schemas/XiqHotspotIpv6AvailabilityType","description":"The IPv6 address availability type."},"wan_metrics":{"$ref":"#/components/schemas/XiqHotspotWanMetrics","description":"Hotspot WAN (Wide Area Network) metrics."},"connection_capabilities":{"type":"array","description":"The connection capability informs client devices about available network services.","items":{"$ref":"#/components/schemas/XiqHotspotConnectionCapability"}},"qos_map":{"$ref":"#/components/schemas/XiqHotspotQosMap","description":"Quality of Service (QoS) map for Hotspot profile."},"gas_comeback_delay":{"type":"integer","format":"int32","description":"Generic Advertisement Service (GAS) comeback message delay time. The unit is Time Unit (TU) 1 TU = 1024 microseconds. When GAS delay is 0, there is no delay.","maximum":65535,"minimum":0},"anqp_domain_id":{"type":"integer","format":"int32","description":"The Access Network Query protocol (ANQP) domain ID.","maximum":65535,"minimum":0},"online_signup":{"$ref":"#/components/schemas/XiqHotspotOnlineSignup","description":"The Hotspot profile Online Signup settings."},"nai_realms":{"type":"array","description":"The list of Network Access Identification (NAI) realms.","items":{"$ref":"#/components/schemas/XiqHotspotNaiRealm"}},"roaming_consortiums":{"type":"array","description":"The list of Roaming Consortium network providers.","items":{"$ref":"#/components/schemas/XiqHotspotRoamingConsortium"}},"cellular_networks":{"type":"array","description":"List of 3rd Generation Partnership Project (3GPP) cellular networks.","items":{"$ref":"#/components/schemas/XiqHotspotCellularNetwork"}},"service_providers":{"type":"array","description":"The list of supported hotspot service providers.","items":{"$ref":"#/components/schemas/XiqHotspotServiceProviderProfile"}}},"required":["create_time","domain_name","id","name","update_time"]},"XiqHiqContext":{"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","format":"int64"}},"creating_org_id":{"type":"integer","format":"int64","description":"The organization ID for creating new data"}},"required":["creating_org_id","reading_org_ids"]},"XiqAfcFloorDetails":{"type":"object","properties":{"floor_id":{"type":"integer","format":"int64"},"floor_height":{"type":"number","format":"float"},"floor_height_accuracy":{"type":"integer","format":"int64"},"ap_height":{"type":"number","format":"float"},"ap_height_accuracy":{"type":"integer","format":"int64"},"id":{"type":"integer","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"},"vlan_override":{"type":"integer","format":"int32","description":"VLAN ID override assigned to the user (range 1-4094, Optional)","maximum":4094,"minimum":1}}},"XiqEndUser":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"The unique identifier"},"create_time":{"type":"string","format":"date-time","description":"The create time in UTC (ISO 8601 format)"},"update_time":{"type":"string","format":"date-time","description":"The last update time in UTC (ISO 8601 format)"},"org_id":{"type":"integer","format":"int64","description":"The organization identifier, valid when enabling HIQ feature"},"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","format":"int64","description":"The user group ID"},"user_group_name":{"type":"string","description":"The user group name"},"approval_type":{"type":"string","description":"The approval type"},"expired_time":{"type":"integer","format":"int64","description":"The password expired time"},"vlan_override":{"type":"integer","format":"int32","description":"VLAN ID override assigned to the user (range 1-4094, Optional)","maximum":4094,"minimum":1}},"required":["approval_type","create_time","email_address","expired_time","id","name","phone_number","update_time","user_group_id","user_group_name","user_name"]},"XiqDeviceRadioOperatingMode":{"type":"object","description":"The request for configuring radio operating mode at device-level and setting radio profiles","properties":{"radio_operating_mode":{"$ref":"#/components/schemas/XiqRadioBands","description":"The Radio Operating Mode Key"},"wireless_interfaces":{"type":"array","description":"A list of wireless interfaces.","items":{"$ref":"#/components/schemas/XiqDeviceWirelessInterfaceEntry"}}}},"XiqDeviceWirelessInterfaceEntry":{"type":"object","description":"The request for configuring radio operating mode at device-level and setting radio profiles","properties":{"name":{"$ref":"#/components/schemas/XiqWirelessIfName","description":"The Wireless Interface name e.g. wifi0, wifi1, wifi2"},"radio_profile_id":{"type":"integer","format":"int64","description":"The radio profile ID"}},"required":["name"]},"XiqRadioBands":{"type":"string","enum":["GENERIC","SERVICE_2_5_6","SENSOR_SERVICE_5_6","SERVICE_5L_5H_6","SENSOR_SERVICE_5_2","SERVICE_5L_5H_2","SERVICE_6L_5_6H","SERVICE_2_5H_5L","SERVICE_6H_5_6L"]},"XiqWirelessIfName":{"type":"string","enum":["WIFI0","WIFI1","WIFI2"]},"XiqAfcCoordinatesSource":{"type":"string","enum":["GPS","GEO","APP"]},"XiqAfcMobileappCoordinates":{"type":"object","properties":{"latitude":{"type":"number","format":"double","description":"Latitude expressed as a floating point number"},"longitude":{"type":"number","format":"double","description":"Longitude expressed as a floating point number"},"ts":{"type":"integer","format":"int64","description":"Timestamp of the acquired geolocation (milliseconds from epoch)"},"source":{"$ref":"#/components/schemas/XiqAfcCoordinatesSource","description":"Source of coordinates"}}},"XiqMobileappGpsSettingsRequest":{"type":"object","properties":{"gps_anchor":{"type":"boolean","description":"Use this AP as GPS anchor to derive geo-coordinates of other APs on the floor"},"distance":{"type":"number","format":"double","description":"Distance between AP and the phone hosting the mobile APP in meters.","maximum":10000,"minimum":0},"cep":{"type":"number","format":"double","description":"Circular error probability, CEP68 is based on Android OS.","maximum":10000,"minimum":0},"coordinates":{"$ref":"#/components/schemas/XiqAfcMobileappCoordinates","description":"The Location provided by MobileApp"}}},"XiqDeviceLocationAssignment":{"type":"object","description":"Device location assignment","properties":{"location_id":{"type":"integer","format":"int64","description":"The assigned location ID, it must be FLOOR type"},"x":{"type":"number","format":"double","description":"The horizontal value in the floor map"},"y":{"type":"number","format":"double","description":"The vertical value in the floor map"},"latitude":{"type":"number","format":"double","description":"The latitude in the geography"},"longitude":{"type":"number","format":"double","description":"The longitude in the geography"}},"required":["location_id"]},"XiqFtmSettingsRequest":{"type":"object","properties":{"wgs84_override":{"type":"boolean","description":"World Geodetic System 1984 (WGS84) override."},"wgs84":{"$ref":"#/components/schemas/XiqWgs84","description":"World Geodetic System 1984 (WGS84) settings."},"zsubelement_override":{"type":"boolean","description":"Z-subelement override."},"zsubelement":{"$ref":"#/components/schemas/XiqZsubelement","description":"Z-subelement settings"},"civic_address_override":{"type":"boolean","description":"Civic Address override."},"civic_address":{"type":"string","description":"Civic Address as hex encoded RFC4776 formatted string."}},"required":["civic_address_override","wgs84_override","zsubelement_override"]},"XiqWgs84":{"type":"object","description":"The payload of WGS84 Settings","properties":{"latitude":{"type":"number","format":"double","description":"Degrees of latitude. Positive values indicate latitudes north of the equator; negative values indicate latitudes south of the equator. "},"longitude":{"type":"number","format":"double","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."},"altitude":{"type":"number","format":"double","description":"Meters above sea level."}},"required":["altitude","latitude","longitude"]},"XiqZsubelement":{"type":"object","description":"The payload of Z-subelement Settings","properties":{"expected_to_move":{"type":"boolean","description":"Is the device expected to move?"},"floor_number":{"type":"integer","format":"int32","description":"Floor number where the device is installed."},"above_floor":{"$ref":"#/components/schemas/XiqZsubelementAboveFloor","description":"Above floor settings."}},"required":["expected_to_move","floor_number"]},"XiqZsubelementAboveFloor":{"type":"object","description":"Z-subelement Above Floor","properties":{"height":{"type":"number","format":"double","description":"Height above floor in meters"},"height_uncertainty":{"type":"number","format":"double","description":"Height uncertainty in meters"}},"required":["height","height_uncertainty"]},"XiqFtmSettings":{"type":"object","description":"The payload of FTM Settings","properties":{"id":{"type":"integer","format":"int64","description":"The unique identifier"},"create_time":{"type":"string","format":"date-time","description":"The create time in UTC (ISO 8601 format)"},"update_time":{"type":"string","format":"date-time","description":"The last update time in UTC (ISO 8601 format)"},"wgs84_override":{"type":"boolean","description":"World Geodetic System 1984 (WGS84) override"},"wgs84":{"$ref":"#/components/schemas/XiqWgs84","description":"World Geodetic System 1984 (WGS84) settings."},"zsubelement_override":{"type":"boolean","description":"Z Subelement override."},"zsubelement":{"$ref":"#/components/schemas/XiqZsubelement","description":"Z Subelement settings"},"civic_address_override":{"type":"boolean","description":"Civic Address override."},"civic_address":{"type":"string","description":"Civic Address as hex encoded RFC4776 formatted string."}},"required":["civic_address_override","create_time","id","update_time","wgs84_override","zsubelement_override"]},"XiqDeviceClientMonitor":{"type":"object","description":"Device location info","properties":{"client_monitor_profile_id":{"type":"integer","format":"int64","description":"The assigned client monitor profile ID"},"enable":{"type":"boolean","description":"The timestamp when the device assigned to the location"}}},"XiqChangeDevicesIbeaconRequest":{"type":"object","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.","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","format":"int64"}},"enabled":{"type":"boolean","description":"Whether to enable the device beacon.  Default to true for newly enabled device."},"major":{"type":"integer","format":"int32","description":"Identification of a subset of beacons in a geographical venue. Default to 1 for newly enabled device.","maximum":65535,"minimum":0},"minor":{"type":"integer","format":"int32","description":"Identification of a beacon in a specific location. Default to 1 for newly enabled device.","maximum":65535,"minimum":0},"power":{"type":"integer","format":"int32","description":"The transmission power in dBm. Default to -59 for newly enabled device.","maximum":127,"minimum":-127},"enable_monitoring":{"type":"boolean","description":"Whether to enable monitoring, this field has been deprecated but remains for backwards compatability, renamed to 'enable_ble_scan_ibeacon'."},"enable_ble_scan_ibeacon":{"type":"boolean","description":"Whether to enable BLE Scan iBeacon monitoring."},"enable_ble_scan_generic":{"type":"boolean","description":"Whether to enable BLE Scan Generic monitoring."},"enable_cloud_reporting":{"type":"boolean","description":"Whether the device BLE Scan Cloud Reporting is enabled. Default to true for newly enabled device."},"enable_batch_reporting":{"type":"boolean","description":"Whether the device BLE Scan Batch Reporting is enabled. Default to false for newly enabled device."}},"required":["device_ids"]},"XiqDeployDeviceFilter":{"type":"object","description":"The filter to get matched devices/sites","properties":{"ids":{"type":"array","description":"The device ID list","items":{"type":"integer","format":"int64"}},"site_ids":{"type":"array","description":"The site ID list","items":{"type":"integer","format":"int64"}}}},"XiqDeploymentPolicy":{"type":"object","description":"Push configuration and upgrade firmware policy","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_upgrade_versions":{"type":"array","items":{"$ref":"#/components/schemas/XiqFirmwareUpgradeVersion"}},"firmware_activate_option":{"$ref":"#/components/schemas/XiqFirmwareActivateOption"}}},"XiqFirmwareActivateOption":{"type":"object","description":"The firmware activate option (Only one of them can be enabled)","properties":{"activation_delay_seconds":{"type":"integer","format":"int64","description":"Activate after the given seconds"},"activation_time":{"type":"integer","format":"int64","description":"Activate at the following time according to the system clock on the updated device"},"enable_activate_at_next_reboot":{"type":"boolean","description":"Activate at next reboot (requires rebooting manually)"}}},"XiqFirmwareUpgradePolicy":{"type":"object","description":"The firmware upgrade policy","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)"}}},"XiqFirmwareUpgradeVersion":{"type":"object","description":"Upgrade to the specific firmware version","properties":{"firmware_id":{"type":"integer","format":"int64","description":"The device compatible firmware metadata ID"},"device_id":{"type":"integer","format":"int64","description":"The device ID"},"product_type":{"type":"string","description":"The product type"}},"required":["firmware_id"]},"XiqScheduleDetails":{"type":"object","description":"Deployment Schedule details","properties":{"start_time":{"type":"integer","format":"int64","description":"The start time"}},"required":["start_time"]},"XiqUpdateFirmwareUpgradeRequest":{"type":"object","description":"The request to update the deployment configuration details.","properties":{"schedule":{"$ref":"#/components/schemas/XiqScheduleDetails"},"devices":{"$ref":"#/components/schemas/XiqDeployDeviceFilter"},"policy":{"$ref":"#/components/schemas/XiqDeploymentPolicy"}}},"XiqDeploymentScheduleActionResponse":{"type":"object","description":"Scheduled Deployment Action Response","properties":{"status":{"type":"string","description":"success value"}}},"XiqCredentialDistributionGroupUpdateRequest":{"type":"object","properties":{"name":{"type":"string","description":"Name of the credential distribution group."},"enable_email_approval":{"type":"boolean","description":"Flag indicating whether email approval is enabled (true) or disabled (false)."},"enable_user_limitation":{"type":"boolean","description":"Flag indicating whether user limitation is enabled (true) or disabled (false)."},"employee_group_type":{"$ref":"#/components/schemas/XiqEmployeeGroupType","description":"Employee Group Json Type"},"employee_groups":{"type":"array","description":"Array of member groups.","items":{"$ref":"#/components/schemas/XiqEmployeeGroupUpdate"}},"restrict_number":{"type":"integer","format":"int32","description":"Number restriction.","minimum":0},"user_group_ids":{"type":"array","description":"Array of user group IDs.","items":{"type":"integer","format":"int64"}}},"required":["employee_group_type","enable_email_approval","enable_user_limitation","name"]},"XiqEmployeeGroupType":{"type":"string","enum":["ADMIN","AD","MANAGE"]},"XiqEmployeeGroupUpdate":{"type":"object","description":" The Employee Group of Credential Distribution Group ","properties":{"name":{"type":"string","description":"The employee group name"},"id":{"type":"integer","format":"int64","description":"The employee group id"}}},"XiqCdgUserGroups":{"type":"object","description":" The User Group of Credential Distribution Group ","properties":{"id":{"type":"integer","format":"int64","description":"The unique identifier"},"create_time":{"type":"string","format":"date-time","description":"The create time in UTC (ISO 8601 format)"},"update_time":{"type":"string","format":"date-time","description":"The last update time in UTC (ISO 8601 format)"},"org_id":{"type":"integer","format":"int64","description":"The organization identifier, valid when enabling HIQ feature"},"owner_id":{"type":"integer","format":"int64","description":"The owner ID"},"name":{"type":"string","description":"The User Group Name"},"json_type":{"type":"string","description":"JSON Type"},"description":{"type":"string","description":"The user group description"},"password_rule_settings_id":{"type":"integer","format":"int64","description":"The password rule settings id"},"delivery_policy_settings_id":{"type":"integer","format":"int64","description":"The delivery policy settings id"},"time_expiration_settings_id":{"type":"integer","format":"int64","description":"The time expiration settings id"},"user_count":{"type":"integer","format":"int32","description":"The user count"},"ssids":{"type":"array","description":"The list of SSIDs","items":{"type":"string"}},"group_type":{"type":"string","description":"The user group type"},"pcg_use_only":{"type":"boolean","description":"Whether PCG use only is enabled"},"ppsk_use_only":{"type":"boolean","description":"Whether PPSK use only is enabled"},"enable_pcg_filter":{"type":"boolean","description":"Whether PCG filter is enabled"},"enable_self_reg":{"type":"boolean","description":"Whether self reg is enabled"},"enable_renew":{"type":"boolean","description":"Whether renew is enabled"}},"required":["create_time","id","update_time"]},"XiqCredentialDistributionGroupUpdate":{"type":"object","description":" The Credential Distribution Group ","properties":{"id":{"type":"integer","format":"int64","description":"The unique identifier"},"create_time":{"type":"string","format":"date-time","description":"The create time in UTC (ISO 8601 format)"},"update_time":{"type":"string","format":"date-time","description":"The last update time in UTC (ISO 8601 format)"},"org_id":{"type":"integer","format":"int64","description":"The organization identifier, valid when enabling HIQ feature"},"owner_id":{"type":"integer","format":"int64","description":"The owner ID of the Credential Distribution group"},"group_type":{"type":"string","description":"The Group type"},"enable_email_approval":{"type":"boolean","description":"Whether email approval is enabled"},"enable_user_limitation":{"type":"boolean","description":"Whether user limitation is enabled"},"employee_group_type":{"$ref":"#/components/schemas/XiqEmployeeGroupType","description":"The Employee group type"},"employee_groups":{"type":"array","description":"The member employee groups","items":{"$ref":"#/components/schemas/XiqEmployeeGroupUpdate"}},"name":{"type":"string","description":"The name of the credential distribution group"},"restrict_number":{"type":"string","description":"Restriction on number of credentials per employee"},"user_groups":{"type":"array","description":"The UserGroups","items":{"$ref":"#/components/schemas/XiqCdgUserGroups"}}},"required":["create_time","id","update_time"]},"XiqActionType":{"type":"string","enum":["MUTE","UNMUTE","PINNED","UNPINNED","DISMISSED"]},"XiqAnomalyType":{"type":"string","enum":["POE_STABILITY","DFS_RECURRENCE","ADVERSE_TRAFFIC","PORT_EFFICIENCY","WIFI_CAPACITY","WIFI_EFFICIENCY","HARDWARE_HEALTH","MISSING_VLAN"]},"XiqUpdateActionAnomalyDetails":{"type":"object","description":"Anomaly Action Filter","properties":{"building_id":{"type":"integer","format":"int64","description":"The building ID"},"location_id":{"type":"integer","format":"int64","description":"The location ID"},"anomaly_id":{"type":"string","description":"The anomaly ID"},"anomaly_type":{"$ref":"#/components/schemas/XiqAnomalyType","description":"The anomaly Type"}},"required":["anomaly_type","building_id"]},"XiqUpdateAnomaliesAndDevicesRequest":{"type":"object","description":"Update Copilot Anomalies and Devices","properties":{"anomaly_details":{"type":"array","description":"The anomaly details","items":{"$ref":"#/components/schemas/XiqUpdateActionAnomalyDetails"}},"action_type":{"$ref":"#/components/schemas/XiqActionType","description":"The action type"}},"required":["action_type","anomaly_details"]},"XiqAnomaliesUpdateActionRequest":{"type":"object","description":"Copilot Anomalies Update Action Request","properties":{"anomaly_type":{"$ref":"#/components/schemas/XiqAnomalyType","description":"The Anomaly type"},"action_type":{"$ref":"#/components/schemas/XiqActionType","description":"The Action type"},"building_id":{"type":"integer","format":"int64","description":"The location id"}}},"XiqCopilotAnomaliesActionResponse":{"type":"object","description":"Copilot Anomalies Success Response","properties":{"success":{"type":"boolean","description":"success value"}}},"XiqAnomaliesDeviceUpdateActionRequest":{"type":"object","description":"Copilot Anomalies Devices Update Action Request","properties":{"anomaly_type":{"$ref":"#/components/schemas/XiqAnomalyType","description":"The Anomaly type"},"action_type":{"$ref":"#/components/schemas/XiqActionType","description":"The Action type"},"location_id":{"type":"integer","format":"int64","description":"The location id"},"anomaly_id":{"type":"string","description":"The anomaly Id"}}},"XiqAnomaliesFeedbackRequest":{"type":"object","description":"Copilot Anomalies Feedback Request","properties":{"anomaly_type":{"$ref":"#/components/schemas/XiqAnomalyType","description":"The anomaly type"},"anomaly_id":{"type":"string","description":"The anomaly Id"},"feedback_type":{"$ref":"#/components/schemas/XiqFeedbackType","description":"The feedback type"},"feedback":{"type":"string","description":"The feedback description"}}},"XiqFeedbackType":{"type":"string","enum":["LIKE","DISLIKE"]},"XiqClientMacAddressAlias":{"type":"object","description":"The client MAC address and associated alias","properties":{"mac_address":{"type":"string","description":"The MAC address of the client","maxLength":16,"minLength":12},"alias":{"type":"string","description":"The alias of the client","maxLength":255,"minLength":0}},"required":["mac_address"]},"XiqClientMonitorParameters":{"type":"object","description":"This represents the client monitor parameters for a problem type","properties":{"trigger_times":{"type":"integer","format":"int32","description":"The trigger times, min = 1, max = 10","maximum":10,"minimum":1},"report_interval":{"type":"integer","format":"int32","description":"The report interval, min = 30, max = 3600 seconds","maximum":3600,"minimum":30}}},"XiqUpdateClientMonitorProfileRequest":{"type":"object","properties":{"name":{"type":"string","description":"The client monitor profile name","maxLength":32,"minLength":1},"description":{"type":"string","description":"The client monitor profile description","maxLength":64,"minLength":0},"association":{"$ref":"#/components/schemas/XiqClientMonitorParameters","description":"The client monitor parameters for association type problems"},"authentication":{"$ref":"#/components/schemas/XiqClientMonitorParameters","description":"The client monitor parameters for authentication type problems"},"networking":{"$ref":"#/components/schemas/XiqClientMonitorParameters","description":"The client monitor parameters for networking type problems"}}},"XiqClientMonitorProfile":{"type":"object","description":"The payload of client monitor profile","properties":{"id":{"type":"integer","format":"int64","description":"The unique identifier"},"create_time":{"type":"string","format":"date-time","description":"The create time in UTC (ISO 8601 format)"},"update_time":{"type":"string","format":"date-time","description":"The last update time in UTC (ISO 8601 format)"},"org_id":{"type":"integer","format":"int64","description":"The organization identifier, valid when enabling HIQ feature"},"name":{"type":"string","description":"The client monitor profile name"},"description":{"type":"string","description":"The client monitor profile description"},"predefined":{"type":"boolean","description":"Whether the client monitor profile is predefined or user-customized."},"association":{"$ref":"#/components/schemas/XiqClientMonitorParameters","description":"The client monitor parameters for association type problems"},"authentication":{"$ref":"#/components/schemas/XiqClientMonitorParameters","description":"The client monitor parameters for authentication type problems"},"networking":{"$ref":"#/components/schemas/XiqClientMonitorParameters","description":"The client monitor parameters for networking type problems"}},"required":["create_time","id","name","predefined","update_time"]},"XiqUpdateClassificationRequest":{"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","format":"int64","description":"The ID of location, cloud config group, IP address, IP subnet or IP range."}},"required":["classification_type","classification_type_id","match"]},"XiqUpdateClassificationRuleRequest":{"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"}}},"required":["classifications","name"]},"XiqUpdateCertificateBundleRequest":{"type":"object","description":"The payload to update a new Certificate Bundle","properties":{"name":{"type":"string","description":"The Certificate Bundle name"},"description":{"type":"string","description":"The Certificate Bundle description"},"certificate_ids":{"type":"array","description":"The Certificate Bundle certificate IDs.","items":{"type":"integer","format":"int64"}}}},"XiqCertificate":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"The unique identifier"},"create_time":{"type":"string","format":"date-time","description":"The create time in UTC (ISO 8601 format)"},"update_time":{"type":"string","format":"date-time","description":"The last update time in UTC (ISO 8601 format)"},"cert_type":{"$ref":"#/components/schemas/XiqCertificateType","description":"The Certificate type"},"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","format":"int64","description":"The certificate file size"}},"required":["create_time","encrypted","file_size","id","name","update_time"]},"XiqCertificateBundle":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"The unique identifier"},"create_time":{"type":"string","format":"date-time","description":"The create time in UTC (ISO 8601 format)"},"update_time":{"type":"string","format":"date-time","description":"The last update time in UTC (ISO 8601 format)"},"name":{"type":"string","description":"The Certificate Bundle name."},"description":{"type":"string","description":"The Certificate Bundle description."},"bundle_type":{"type":"string","description":"The Certificate Bundle type.","enum":["TRUST_POINT","CA"]},"certificates":{"type":"array","description":"The Certificate Bundle list of certificates.","items":{"$ref":"#/components/schemas/XiqCertificate"}}},"required":["certificates","create_time","id","update_time"]},"XiqCertificateType":{"type":"string","enum":["CERT","KEY","CA"]},"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","format":"int64"}}}},"XiqCloudConfigGroup":{"type":"object","description":"The CCG","properties":{"id":{"type":"integer","format":"int64","description":"The unique identifier"},"create_time":{"type":"string","format":"date-time","description":"The create time in UTC (ISO 8601 format)"},"update_time":{"type":"string","format":"date-time","description":"The last update time in UTC (ISO 8601 format)"},"org_id":{"type":"integer","format":"int64","description":"The organization identifier, valid when enabling HIQ feature"},"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","format":"int64","description":"The zone ID"},"zone_location_id":{"type":"integer","format":"int64","description":"The zone location ID"},"device_ids":{"type":"array","description":"The device IDs selected for this Ccg.","items":{"type":"integer","format":"int64"}}},"required":["create_time","id","name","predefined","update_time"]},"XiqUpdateAlertWebhookSubscriptionRequest":{"type":"object","description":"The alert webhook subscription update","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","format":"int64"}}},"required":["alert_policy_ids"]},"XiqAlertWebhookSubscription":{"type":"object","description":"The alert webhook subscription data model","properties":{"id":{"type":"integer","format":"int64","description":"The unique identifier"},"create_time":{"type":"string","format":"date-time","description":"The create time in UTC (ISO 8601 format)"},"update_time":{"type":"string","format":"date-time","description":"The last update time in UTC (ISO 8601 format)"},"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","format":"int64"}}},"required":["create_time","id","is_enabled","is_subscribe_all","secret","update_time","url"]},"XiqUpdateAlertServiceNowSubscriptionRequest":{"type":"object","description":"The payload of update ServiceNow subscription.","properties":{"servicenow_account_email":{"type":"string","description":"The servicenow email address."},"is_enabled":{"type":"boolean","description":"Enable/disable servicenow notification."},"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","format":"int64"}}},"required":["alert_policy_ids"]},"XiqAlertServiceNowSubscription":{"type":"object","description":"The alert email subscription data model","properties":{"id":{"type":"integer","format":"int64","description":"The unique identifier"},"create_time":{"type":"string","format":"date-time","description":"The create time in UTC (ISO 8601 format)"},"update_time":{"type":"string","format":"date-time","description":"The last update time in UTC (ISO 8601 format)"},"servicenow_account_email":{"type":"string"},"is_enabled":{"type":"boolean"},"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","format":"int64"}}},"required":["create_time","id","is_subscribe_all","update_time"]},"XiqUpdateAlertEmailSubscriptionRequest":{"type":"object","description":"The alert email subscription update","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","format":"int64"}}},"required":["alert_policy_ids"]},"XiqAlertEmailSubscription":{"type":"object","description":"The alert email subscription data model","properties":{"id":{"type":"integer","format":"int64","description":"The unique identifier"},"create_time":{"type":"string","format":"date-time","description":"The create time in UTC (ISO 8601 format)"},"update_time":{"type":"string","format":"date-time","description":"The last update time in UTC (ISO 8601 format)"},"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","format":"int64"}}},"required":["create_time","email","id","is_email_verified","is_enabled","is_subscribe_all","update_time"]},"XiqUpdateAlertRuleRequest":{"type":"object","properties":{"description":{"type":"string","description":"This is a description for the alert rule."},"severity_id":{"type":"integer","format":"int64","description":"The severity identifier. The currently supported severity IDs are 1 for critical, 2 for warning, and 3 for info."},"trigger_type":{"type":"string","description":"The configured trigger type of the rule."},"duration":{"type":"integer","format":"int32","description":"Has value when trigger_type is \"DEFERRED\". The deferred duration, in seconds."},"time_window":{"type":"integer","format":"int32","description":"Has value when trigger_type is \"REPEATED\". The time window to count the number of repeated messages, in seconds."},"count":{"type":"integer","format":"int32","description":"Has value when trigger_type is \"REPEATED\". The lower bound of the number of messages required to trigger this rule."},"threshold":{"type":"number","format":"double","description":"Has value when type is \"METRIC\". The threshold for the message."},"operator":{"type":"string","description":"Has value when message_metadata_type is \"METRIC\". The operator to compare against the threshold."}}},"XiqAlertRule":{"type":"object","description":"The state for a configured alert rule","properties":{"id":{"type":"integer","format":"int64","description":"The unique identifier"},"message_metadata_id":{"type":"integer","format":"int64","description":"The identifier for the unique message type that corresponds to this rule."},"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","format":"int64","description":"The severity identifier. The currently supported severity IDs are 1 for critical, 2 for warning, and 3 for info."},"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","format":"int32","description":"Has value when trigger_type is \"DEFERRED\". The deferred duration, in seconds."},"time_window":{"type":"integer","format":"int32","description":"Has value when trigger_type is \"REPEATED\". The time window to count the number of repeated messages, in seconds."},"count":{"type":"integer","format":"int32","description":"Has value when trigger_type is \"REPEATED\". The lower bound of the number of messages required to trigger this rule."},"threshold":{"type":"number","format":"double","description":"Has value when type is \"METRIC\". The threshold for the message."},"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."}},"required":["id","is_enabled","message_metadata_id","severity_id","trigger_type"]},"XiqAlertPolicyFilter":{"type":"object","description":"The update and create request of alert policy","properties":{"name":{"type":"string","description":"The policy name."},"site_ids":{"type":"array","description":"The site ID list.","items":{"type":"integer","format":"int64"}}},"required":["site_ids"]},"XiqAlertEventRulesByCategory":{"type":"object","description":"The Alert Event Rule Model","properties":{"category_id":{"type":"integer","format":"int64","description":"The unique identifier of category ID."},"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"}}},"required":["category_id","category_name","rules"]},"XiqAlertMetricRulesByMetricset":{"type":"object","description":"The Alert Metric Rule Model","properties":{"metricset_id":{"type":"integer","format":"int64","description":"The unique identifier of the metricset."},"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"}}},"required":["metricset_id","metricset_name","rules"]},"XiqAlertPolicy":{"type":"object","description":"The Alert Policy Model","properties":{"id":{"type":"integer","format":"int64","description":"The unique identifier"},"owner_id":{"type":"integer","format":"int64","description":"The owner ID"},"org_id":{"type":"integer","format":"int64","description":"The organization identifier, valid when enabling HIQ feature"},"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"}}},"required":["id"]},"XiqAlertRuleOverview":{"type":"object","description":"The Alert Rule Overview Model","properties":{"id":{"type":"integer","format":"int64","description":"The unique identifier of rule."},"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."}},"required":["enabled","id","name"]},"XiqAlertSite":{"type":"object","description":"The Alert Policy Site Model","properties":{"site_id":{"type":"integer","format":"int64","description":"The unique identifier of site"},"site_name":{"type":"string","description":"The site name of the alert policy site"}},"required":["site_id"]},"XiqUpdateVhmSettingRequest":{"type":"object","properties":{"enable_ssh":{"type":"boolean","description":"Flag indicating Ssh Availability."},"enable_supplemental_cli":{"type":"boolean","description":"Flag indicating Supplemental CLI."},"enable_wireless_onboarding":{"type":"boolean","description":"Flag indicating AP Out-of-the-box Wireless Onboarding."},"enable_password_for_exos_voss":{"type":"boolean","description":"Flag to enable device management settings for Switch Engine (EXOS) / Fabric Engine (VOSS) switches."},"enable_auto_config_push":{"type":"boolean","description":"Flag to enable auto config push."},"enable_site_isolation":{"type":"boolean","description":"Flag to enable site isolation."},"enable_legacy_uztna_proxy":{"type":"boolean","description":"Flag to enable legacy UZTNA proxy."}}},"XiqVhmSetting":{"type":"object","description":"The VHM Setting.","properties":{"id":{"type":"integer","format":"int64","description":"The unique identifier"},"create_time":{"type":"string","format":"date-time","description":"The create time in UTC (ISO 8601 format)"},"update_time":{"type":"string","format":"date-time","description":"The last update time in UTC (ISO 8601 format)"},"org_id":{"type":"integer","format":"int64","description":"The organization identifier, valid when enabling HIQ feature"},"enable_ssh":{"type":"boolean","description":"Flag indicating Ssh Availability."},"enable_supplemental_cli":{"type":"boolean","description":"Flag indicating Supplemental CLI."},"enable_wireless_onboarding":{"type":"boolean","description":"Flag indicating AP Out-of-the-box Wireless Onboarding."},"enable_password_for_exos_voss":{"type":"boolean","description":"Flag to enable device management settings for Switch Engine (EXOS) / Fabric Engine (VOSS) switches."},"enable_auto_config_push":{"type":"boolean","description":"Flag to enable auto config push."},"enable_site_isolation":{"type":"boolean","description":"Flag to enable site isolation."},"enable_legacy_uztna_proxy":{"type":"boolean","description":"Flag to enable legacy UZTNA proxy."}},"required":["create_time","id","update_time"]},"XiqCreateVlanObjectClassifiedEntryRequest":{"type":"object","properties":{"vlan_id":{"type":"integer","format":"int32","description":"The VLAN ID"},"classification_rule_id":{"type":"integer","format":"int64","description":"The classification rule ID"}},"required":["classification_rule_id","vlan_id"]},"XiqCreateVlanProfileRequest":{"type":"object","properties":{"name":{"type":"string","description":"The VLAN profile name"},"default_vlan_id":{"type":"integer","format":"int32","description":"The default VLAN ID"},"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"}}},"required":["default_vlan_id","enable_classification","name"]},"XiqVlanProfileFilter":{"type":"object","description":"The filter to get matched VLAN profiles","properties":{"ids":{"type":"array","description":"The VLAN profile ID list","items":{"type":"integer","format":"int64"}}}},"XiqCreateUserRequest":{"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","format":"int32","description":"The idle timeout in minutes."},"user_role":{"$ref":"#/components/schemas/XiqUserRole","description":"The user administrative role"},"location_ids":{"type":"array","description":"The location IDs to assign. Null or empty list will assign Admin default locations.","items":{"type":"integer","format":"int64"}},"access_scope":{"type":"integer","format":"int32","description":"The user has access on all sites / the authorized sites. 0: VIQ_SCOPE, 1: SITE_SCOPE."},"viq_access_control":{"type":"integer","format":"int32","description":"The permissions for Site Scope user on Global Scope resources. 0: READ_WRITE, 1: READ_ONLY."}},"required":["display_name","idle_timeout","login_name","user_role"]},"XiqUserRole":{"type":"string","enum":["ADMINISTRATOR","OPERATOR","MONITOR","HELP_DESK","GUEST_MANAGEMENT","OBSERVER","INSTALLER","APPLICATION_OPERATOR"]},"XiqUser":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"The unique identifier"},"create_time":{"type":"string","format":"date-time","description":"The create time in UTC (ISO 8601 format)"},"update_time":{"type":"string","format":"date-time","description":"The last update time in UTC (ISO 8601 format)"},"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","description":"The user administrative role."},"idle_timeout":{"type":"integer","format":"int32","description":"The idle timeout in minutes, the minimum value is 5 minutes and the maximum value is 4 hours"},"last_login_time":{"type":"string","format":"date-time","description":"The last login time"},"org_id":{"type":"integer","format":"int64","description":"The HIQ organization ID if it is HIQ user"},"location_ids":{"type":"array","description":"The assigned location IDs.","items":{"type":"integer","format":"int64"}},"access_scope":{"type":"integer","format":"int32","description":"The user has access on all sites / the authorized sites. 0: VIQ_SCOPE, 1: SITE_SCOPE."},"viq_access_control":{"type":"integer","format":"int32","description":"The permissions for Site Scope user on Global Scope resources. 0: READ_WRITE, 1: READ_ONLY."}},"required":["create_time","id","login_name","update_time"]},"RmUserFilterRequest":{"type":"object","description":"Request body for User Filter","properties":{"site_ids":{"type":"array","description":"List of site ids","items":{"type":"integer","format":"int64"}}}},"RmUserTypeDistribution":{"type":"object","description":"The User type distribution and total connected users","properties":{"ppsk":{"type":"integer","format":"int32","description":"Percentage of users authenticated via PPSK"},"radius":{"type":"integer","format":"int32","description":"Percentage of users authenticated via RADIUS"},"others":{"type":"integer","format":"int32","description":"Percentage of users authenticated via other methods"},"total_connected_users":{"type":"integer","format":"int32","description":"Total number of connected users"}}},"RmUserGridRequest":{"type":"object","description":"User Grid Request","properties":{"source":{"type":"array","description":"The source list","items":{"type":"string"}},"site_ids":{"type":"array","description":"The site IDs","items":{"type":"integer","format":"int64"}},"status":{"type":"boolean","description":"The status"}}},"PagedRmUsersGridResponse":{"type":"object","properties":{"page":{"type":"integer","format":"int32","description":"The current page number"},"count":{"type":"integer","format":"int32","description":"The element count of the current page"},"total_pages":{"type":"integer","format":"int32","description":"The total page number based on request page size"},"total_count":{"type":"integer","format":"int64","description":"The total element count"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/RmUsersGridResponse"}}},"required":["count","page","total_count","total_pages"]},"RmUsersGridResponse":{"type":"object","description":"The User Grid Response","properties":{"status":{"type":"boolean","description":"The connection status of user"},"site":{"type":"string","description":"The site where the user is located"},"building":{"type":"string","description":"The building where the user is located"},"floor":{"type":"string","description":"The floor where the user is located"},"user_name":{"type":"string","description":"The Name of the user"},"email":{"type":"string","description":"The Email address of the user"},"group":{"type":"string","description":"Group to which the user belongs"},"wireless_clients":{"type":"integer","format":"int32","description":"The number of wireless clients"},"wired_clients":{"type":"integer","format":"int32","description":"The number of wired clients"},"data_usage":{"type":"integer","format":"int64","description":"Total data usage in bytes"},"source":{"type":"string","description":"'Source of the session (e.g., RADIUS, SAML)'"},"session_duration":{"type":"integer","format":"int64","description":"Duration of the session in seconds"},"expiration":{"type":"integer","format":"int64","description":"Time in seconds until the session expires"},"location_id":{"type":"integer","format":"int64","description":"The location ID"},"user_id":{"type":"integer","format":"int64","description":"The User ID"}}},"RmMetricReport":{"type":"object","description":"ExtremeCloud IQ Xiq report","properties":{"id":{"type":"string","description":"The reportId"}},"required":["id"]},"RmUsersGridFilterMetadata":{"type":"object","description":"The list of values for user grid filters","properties":{"sources":{"type":"array","description":"List of unique session sources","items":{"type":"string"}}}},"XiqGrantExternalUserRequest":{"type":"object","properties":{"login_name":{"type":"string","description":"Login name, i.e. username or login Email"},"user_role":{"$ref":"#/components/schemas/XiqUserRole","description":"The user administrative role"},"org_id":{"type":"integer","format":"int64","description":"The HIQ organization ID if it is HIQ user, otherwise leave it as empty"},"location_ids":{"type":"array","description":"The location IDs to assign. Null or empty list will assign Admin default locations.","items":{"type":"integer","format":"int64"}},"access_scope":{"type":"integer","format":"int32","description":"The user has access on all sites / the authorized sites. 0: VIQ_SCOPE, 1: SITE_SCOPE."},"viq_access_control":{"type":"integer","format":"int32","description":"The permissions for Site Scope user on Global Scope resources. 0: READ_WRITE, 1: READ_ONLY."}},"required":["login_name","user_role"]},"XiqExternalUser":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"The unique identifier"},"create_time":{"type":"string","format":"date-time","description":"The create time in UTC (ISO 8601 format)"},"update_time":{"type":"string","format":"date-time","description":"The last update time in UTC (ISO 8601 format)"},"login_name":{"type":"string","description":"Login name, i.e. username or login Email"},"user_role":{"$ref":"#/components/schemas/XiqUserRole","description":"The user administrative role."},"org_id":{"type":"integer","format":"int64","description":"The HIQ organization ID if it is HIQ user."},"location_ids":{"type":"array","description":"The assigned location IDs.","items":{"type":"integer","format":"int64"}},"grantee_id":{"type":"integer","format":"int64","description":"The home VIQ user ID of external user."},"access_scope":{"type":"integer","format":"int32","description":"The user has access on all sites / the authorized sites. 0: VIQ_SCOPE, 1: SITE_SCOPE."},"viq_access_control":{"type":"integer","format":"int32","description":"The permissions for Site Scope user on Global Scope resources. 0: READ_WRITE, 1: READ_ONLY."}},"required":["create_time","id","login_name","update_time","user_role"]},"RmUserDataUsage":{"type":"object","description":"Returns data usage in bytes for each user.","properties":{"users":{"type":"array","description":"Percentage of users authenticated via PPSK","items":{"$ref":"#/components/schemas/RmUsers"}}}},"RmUsers":{"type":"object","description":"Data usage per user.","properties":{"user_name":{"type":"string","description":"Name or identifier of the user"},"data_usage":{"type":"number","format":"float","description":"Data usage in bytes"},"user_id":{"type":"integer","format":"int64","description":"The User ID"}}},"XiqCreateUserGroupRequest":{"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","description":"The access key storage location"},"ppsk_use_only":{"type":"boolean","description":"Whether it's for PPSK use only"},"password_type":{"$ref":"#/components/schemas/XiqPasswordType","description":"The access key type"},"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","format":"int32","description":"The maximum number of clients per private PSK"},"pcg_use_only":{"type":"boolean","description":"Whether it's for PCG use only"},"pcg_type":{"$ref":"#/components/schemas/XiqPcgType","description":"The private client group type for pcgUseOnly"},"enable_cwp_reg":{"type":"boolean","description":"Whether to enable CWP registration setting"},"password_settings":{"$ref":"#/components/schemas/XiqPasswordSettings","description":"The password settings ID"},"expiration_settings":{"$ref":"#/components/schemas/XiqExpirationSettings","description":"The password expiration settings"},"delivery_settings":{"$ref":"#/components/schemas/XiqDeliverySettings","description":"The password delivery settings"}},"required":["delivery_settings","expiration_settings","name","password_db_location","password_settings","password_type"]},"XiqCreateUserProfileRequest":{"type":"object","properties":{"name":{"type":"string","description":"The user profile name"},"vlan_profile_id":{"type":"integer","format":"int64","description":"The VLAN profile id"}},"required":["name","vlan_profile_id"]},"XiqAttachMacFirewallPolicyToUserProfileRequest":{"type":"object","properties":{"policy_id":{"type":"integer","format":"int64","description":"Mac Firewall Policy ID"},"traffic":{"$ref":"#/components/schemas/XiqTraffic","description":"Contains or not contains"}},"required":["policy_id","traffic"]},"XiqTraffic":{"type":"string","enum":["INBOUND","OUTBOUND"]},"XiqAttachIpFirewallPolicyToUserProfileRequest":{"type":"object","properties":{"policy_id":{"type":"integer","format":"int64","description":"IP Firewall Policy ID"},"traffic":{"$ref":"#/components/schemas/XiqTraffic","description":"Contains or not contains"}},"required":["policy_id","traffic"]},"XiqAttributeType":{"type":"string","enum":["TUNNEL","STANDARD","CUSTOM"]},"XiqCreateUserProfileAssignmentRequest":{"type":"object","properties":{"name":{"type":"string","description":"The user profile name"},"description":{"type":"string","description":"The user profile assignment description"},"folder_ids":{"type":"array","description":"The location folder Id list","items":{"type":"integer","format":"int64"}},"assignment_radius_attribute":{"$ref":"#/components/schemas/XiqUserProfileAssignmentRadiusAttribute","description":"The User Profile Assignment Radius Attribute"}}},"XiqUserProfileAssignmentRadiusAttribute":{"type":"object","description":"The User Profile Assignment Radius Attribute.","properties":{"attribute_type":{"$ref":"#/components/schemas/XiqAttributeType","description":"The attribute type name"},"attribute_values":{"type":"string","description":"The Attribute type value"}}},"XiqOsObject":{"type":"object","description":"The OS object.","properties":{"id":{"type":"integer","format":"int64","description":"The unique identifier"},"create_time":{"type":"string","format":"date-time","description":"The create time in UTC (ISO 8601 format)"},"update_time":{"type":"string","format":"date-time","description":"The last update time in UTC (ISO 8601 format)"},"name":{"type":"string","description":"The OS object name."}},"required":["create_time","id","update_time"]},"XiqRecurrenceType":{"type":"string","enum":["EVERYDAY","WEEKDAY_RANGE"]},"XiqSchedule":{"type":"object","description":"The OS object.","properties":{"description":{"type":"string","description":"Schedule description."},"schedule_type":{"$ref":"#/components/schemas/XiqScheduleType","description":"Schedule type e.g ONE_TYPE or RECURRING ."},"start_date":{"type":"string","format":"date","description":"The start date of the schedule.","example":"2020-07-06"},"end_date":{"type":"string","format":"date","description":"The end date of the schedule.","example":"2020-07-06"},"start_time":{"type":"string","format":"time","description":"The start time of the schedule.","example":"00:00"},"end_time":{"type":"string","format":"time","description":"The end time of the schedule.","example":"23:45"},"recurrence_type":{"$ref":"#/components/schemas/XiqRecurrenceType","description":"RecurrenceType for schedule e.g EVERYDAY, WEEKDAY_RANGE."},"weekday_from":{"$ref":"#/components/schemas/XiqWeekday","description":"Week day of schedule e.g MONDAY."},"weekday_to":{"$ref":"#/components/schemas/XiqWeekday","description":"Week day of schedule e.g MONDAY."},"start_time2":{"type":"string","format":"time","description":"The start time of the schedule.","example":"00:00"},"end_time2":{"type":"string","format":"time","description":"The end time of the schedule.","example":"23:45"}}},"XiqScheduleType":{"type":"string","enum":["ONE_TIME","RECURRING"]},"XiqUserProfileAssignment":{"type":"object","description":"The payload of User Profile Assignment","properties":{"id":{"type":"integer","format":"int64","description":"The unique identifier"},"create_time":{"type":"string","format":"date-time","description":"The create time in UTC (ISO 8601 format)"},"update_time":{"type":"string","format":"date-time","description":"The last update time in UTC (ISO 8601 format)"},"org_id":{"type":"integer","format":"int64","description":"The organization identifier, valid when enabling HIQ feature"},"name":{"type":"string","description":"The user profile name"},"description":{"type":"string","description":"The user profile assignment description"},"authorisation_policy":{"type":"string","description":"The Authorization policy name"},"folder_ids":{"type":"array","description":"The location folder Id list","items":{"type":"integer","format":"int64"}},"assignment_radius_attribute":{"$ref":"#/components/schemas/XiqUserProfileAssignmentRadiusAttribute","description":"The User Profile Assignment Radius Attribute"},"user_group":{"type":"array","description":"The set of User groups.","items":{"$ref":"#/components/schemas/XiqUserGroup"}},"mac_object_profiles":{"type":"array","description":"The set of Mac object profiles.","items":{"$ref":"#/components/schemas/XiqMacObject"}},"os_object_dhcp":{"type":"array","description":"The set of OS DHCP objects.","items":{"$ref":"#/components/schemas/XiqOsObject"}},"os_object_https":{"type":"array","description":"The set of OS HTTP objects.","items":{"$ref":"#/components/schemas/XiqOsObject"}},"schedules":{"type":"array","description":"The set of OS HTTP objects.","items":{"$ref":"#/components/schemas/XiqSchedule"}}},"required":["create_time","id","update_time"]},"XiqWeekday":{"type":"string","enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"]},"XiqClientDensityThresholds":{"allOf":[{"$ref":"#/components/schemas/XiqUserFolderPreferences"},{"type":"object","properties":{"data":{"$ref":"#/components/schemas/XiqClientDensityThresholdsInfo","description":"Client density thresholds data."}}}],"description":"Client density threshold preferences object","required":["data"]},"XiqClientDensityThresholdsInfo":{"type":"object","description":"Client density threshold preferences","properties":{"excellent":{"type":"integer","format":"int64","description":"Low client density","example":0,"minimum":0},"good":{"type":"integer","format":"int64","description":"Medium-low client density","example":50},"medium":{"type":"integer","format":"int64","description":"Medium client density","example":75},"poor":{"type":"integer","format":"int64","description":"High client density","example":100}},"required":["excellent","good","medium","poor"]},"XiqCoChannelInterferenceThresholds":{"allOf":[{"$ref":"#/components/schemas/XiqUserFolderPreferences"},{"type":"object","properties":{"data":{"$ref":"#/components/schemas/XiqCoChannelInterferenceThresholdsInfo","description":"Co channel interference thresholds data."}}}],"description":"Co channel interference threshold preferences object","required":["data"]},"XiqCoChannelInterferenceThresholdsInfo":{"type":"object","description":"Co channel threshold values","properties":{"excellent":{"type":"integer","format":"int64","description":"excellent co channel interference threshold","example":-90,"minimum":-90},"good":{"type":"integer","format":"int64","description":"good co channel interference threshold","example":-72},"medium":{"type":"integer","format":"int64","description":"medium co channel interference threshold","example":-67},"poor":{"type":"integer","format":"int64","description":"poor co channel interference threshold","example":-30,"maximum":-30}},"required":["excellent","good","medium","poor"]},"XiqCoverageOverlapThresholds":{"allOf":[{"$ref":"#/components/schemas/XiqUserFolderPreferences"},{"type":"object","properties":{"data":{"$ref":"#/components/schemas/XiqCoverageOverlapThresholdsInfo","description":"RSSI thresholds data."}}}],"description":"Coverage overlap threshold preferences object","required":["data"]},"XiqCoverageOverlapThresholdsInfo":{"type":"object","description":"Coverage overlap threshold preferences","properties":{"excellent":{"type":"integer","format":"int64","description":"excellent coverage overlap threshold","example":-30,"maximum":-30},"good":{"type":"integer","format":"int64","description":"good coverage overlap threshold","example":-67},"medium":{"type":"integer","format":"int64","description":"medium coverage overlap threshold","example":-72},"poor":{"type":"integer","format":"int64","description":"poor coverage overlap threshold","example":-90,"minimum":-90}},"required":["excellent","good","medium","poor"]},"XiqLayerOpacityInfo":{"type":"object","description":"Layer opacity data","properties":{"walls":{"type":"integer","format":"int64","description":"Walls layer opacity","example":100,"maximum":100,"minimum":0},"devices":{"type":"integer","format":"int64","description":"Devices layer opacity","example":100,"maximum":100,"minimum":0},"grid":{"type":"integer","format":"int64","description":"Grid layer opacity","example":100,"maximum":100,"minimum":0},"heatmap":{"type":"integer","format":"int64","description":"Heatmap layer opacity","example":85,"maximum":100,"minimum":0},"background":{"type":"integer","format":"int64","description":"Background layer opacity","example":100,"maximum":100,"minimum":0},"clients":{"type":"integer","format":"int64","description":"Clients layer opacity","example":100,"maximum":100,"minimum":0},"zones":{"type":"integer","format":"int64","description":"Zones layer opacity","example":50,"maximum":100,"minimum":0},"labels":{"type":"integer","format":"int64","description":"Labels layer opacity","example":100,"maximum":100,"minimum":0}},"required":["background","clients","devices","grid","heatmap","labels","walls","zones"]},"XiqLayerOpacityPreferences":{"allOf":[{"$ref":"#/components/schemas/XiqUserFolderPreferences"},{"type":"object","properties":{"data":{"$ref":"#/components/schemas/XiqLayerOpacityInfo","description":"Layer opacity data"}}}],"description":"Layer opacity preferences","required":["data"]},"XiqRssiThresholds":{"allOf":[{"$ref":"#/components/schemas/XiqUserFolderPreferences"},{"type":"object","properties":{"data":{"$ref":"#/components/schemas/XiqRssiThresholdsInfo","description":"RSSI thresholds data."}}}],"description":"RSSI threshold preferences object","required":["data"]},"XiqRssiThresholdsInfo":{"type":"object","description":"RSSI threshold preferences","properties":{"excellent":{"type":"integer","format":"int64","description":"excellent rssi threshold","example":-30,"maximum":-30},"good":{"type":"integer","format":"int64","description":"good rssi threshold","example":-67},"medium":{"type":"integer","format":"int64","description":"medium rssi threshold","example":-72},"poor":{"type":"integer","format":"int64","description":"poor rssi threshold","example":-90,"minimum":-90}},"required":["excellent","good","medium","poor"]},"XiqSnrThresholds":{"allOf":[{"$ref":"#/components/schemas/XiqUserFolderPreferences"},{"type":"object","properties":{"data":{"$ref":"#/components/schemas/XiqSnrThresholdsInfo","description":"SNR thresholds data."}}}],"description":"RSSI threshold preferences object","required":["data"]},"XiqSnrThresholdsInfo":{"type":"object","description":"SNR threshold values","properties":{"excellent":{"type":"integer","format":"int64","description":"excellent snr threshold","example":60,"maximum":60},"good":{"type":"integer","format":"int64","description":"good snr threshold","example":30},"medium":{"type":"integer","format":"int64","description":"medium snr threshold","example":20},"poor":{"type":"integer","format":"int64","description":"poor snr threshold","example":0,"minimum":0}},"required":["excellent","good","medium","poor"]},"XiqUserFolderPreferences":{"type":"object","description":"User preferences values object","discriminator":{"propertyName":"type"},"properties":{"type":{"type":"string","description":"The type of values"}}},"XiqSwitchInspectorPanelDiagnosticsResponse":{"type":"object","description":"Response body for the Switch Inspector Panel Diagnostics widget","properties":{"device_health_issues":{"type":"integer","format":"int64","description":"The number of Device Health issues"},"usage_capacity_issues":{"type":"integer","format":"int64","description":"The number of Usage and Capacity issues"},"client_health_issues":{"type":"integer","format":"int64","description":"The number of Client Health issues"}}},"XiqCreateWebhookSubscriptionRequest":{"type":"object","description":"The payload to create webhook subscription","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 subscription message type.","example":"LOCATION_AP_CENTRIC"},"status":{"$ref":"#/components/schemas/XiqSubscriptionStatus","description":"The webhook subscription status."}},"required":["application","message_type","status","url"]},"XiqAttachUPAssignmentEntry":{"type":"object","description":"To attach the User Profile Assignment and User Profile Id's to SSID.","properties":{"user_profile_id":{"type":"integer","format":"int64","description":"The User Profile ID."},"user_profile_assignment_id":{"type":"integer","format":"int64","description":"The User Profile Assignment ID."}}},"XiqAttachUPAssignmentRequest":{"type":"object","properties":{"user_profile_assignment_rules":{"type":"array","description":"The User Profile Assignment and User Profile Id's to attach to SSID","items":{"$ref":"#/components/schemas/XiqAttachUPAssignmentEntry"}},"enable_user_profile_assignment":{"type":"boolean","description":"The flag to enable User Profile Assignment"},"enable_radius_attribute_user_profile_assignment":{"type":"boolean","description":"The flag to enable Radius Attribute User Profile Assignment"},"attribute_type":{"$ref":"#/components/schemas/XiqAttributeType","description":"The SSID attribute type"},"attribute_key":{"type":"integer","format":"int32","description":"The SSID attribute key"},"default_radius_client_object_id":{"type":"integer","format":"int64","description":"The default RADIUS client object ID"}}},"XiqAttachClientMonitorProfileRequest":{"type":"object","properties":{"client_monitor_profile_id":{"type":"integer","format":"int64","description":"The client monitor profile"}}},"XiqAfcInputInfo":{"type":"object","properties":{"serial_number":{"type":"string"},"coordinates":{"$ref":"#/components/schemas/XiqApCoordinates"},"elevation":{"$ref":"#/components/schemas/XiqElevation"},"ellipse":{"$ref":"#/components/schemas/XiqEllipse"},"environment":{"type":"string","enum":["INDOOR","OUTDOOR","UNDERSEAT"]}}},"XiqApCoordinates":{"type":"object","properties":{"latitude":{"type":"number","format":"double"},"longitude":{"type":"number","format":"double"},"timestamp":{"type":"integer","format":"int64"}}},"XiqElevation":{"type":"object","properties":{"height":{"type":"number","format":"float"},"height_reference":{"type":"string","enum":["AGL","AMSL"]},"uncertainty":{"type":"integer","format":"int32"}}},"XiqEllipse":{"type":"object","properties":{"major_axis":{"type":"number","format":"double"},"minor_axis":{"type":"number","format":"double"},"orientation":{"type":"number","format":"double"}}},"XiqGetAfcSpectrumForSiteApsRequest":{"type":"object","properties":{"owner_id":{"type":"integer","format":"int64"},"site_name":{"type":"string"},"region":{"type":"string","enum":["US","CA","UNRECOGNIZED"]},"input_info":{"type":"array","items":{"$ref":"#/components/schemas/XiqAfcInputInfo"}}}},"XiqAfcAvailableSpectrum":{"type":"object","properties":{"request_id":{"type":"string"},"available_channel_info":{"type":"array","items":{"$ref":"#/components/schemas/XiqAvailableChannelInfo"}},"availability_expire_time":{"type":"string"}}},"XiqAvailableChannelInfo":{"type":"object","properties":{"global_operating_class":{"type":"integer","format":"int32"},"channel_cfi":{"type":"array","items":{"type":"integer","format":"int32"}},"max_eirp":{"type":"array","items":{"type":"number","format":"double"}}}},"RttsSessionDevices":{"type":"object","properties":{"device_ids":{"type":"array","items":{"type":"string"}},"client_macs":{"type":"array","items":{"type":"string"}},"packet_type":{"type":"string","enum":["ALL","DATA","MGT","UNRECOGNIZED"]}}},"XiqRttsSessionResponse":{"type":"object","properties":{"session_id":{"type":"string"},"failed_ids":{"type":"string"}}},"RttsSupportedDevicesRequest":{"type":"object","properties":{"floor_ids":{"type":"array","description":"List of floor Ids","items":{"type":"integer","format":"int64"}},"building_ids":{"type":"array","description":"List of building ids","items":{"type":"integer","format":"int64"}},"site_ids":{"type":"array","description":"List of site Ids","items":{"type":"integer","format":"int64"}}}},"RttsSupportedDevice":{"type":"object","description":"Details of a device supported by RTTS","properties":{"device_id":{"type":"integer","format":"int64","description":"The Device Id"},"host_name":{"type":"string","description":"The HostName of the device"},"serial_number":{"type":"string","description":"Serial Number of Device"}}},"XiqCreateRadsecProxyRealm":{"type":"object","description":"The RADSEC proxy realm for RADSEC proxy","properties":{"name":{"type":"string","description":"The RADSEC proxy realm name"},"enable_strip_realm_name":{"type":"boolean","description":"The flag for enabling strip realm name"},"external_radius_server_object_ids":{"type":"array","description":"The list of associated external RADIUS server object IDs","items":{"type":"integer","format":"int64"},"minItems":1}},"required":["external_radius_server_object_ids"]},"XiqCreateRadsecProxyRequest":{"type":"object","description":"The payload to create a new RADSEC proxy","properties":{"name":{"type":"string","description":"The RADSEC proxy name"},"description":{"type":"string","description":"The RADSEC proxy description"},"format_type":{"$ref":"#/components/schemas/XiqRadiusProxyFormatType","description":"The format type of RADSEC proxy"},"enable_inject_operator_name_attribute":{"type":"boolean","description":"The flag for enable inject operator name attribute"},"operator_name_type":{"type":"string","description":"The operator name type of RADSEC proxy","enum":["WBAID"]},"operator_name":{"type":"string","description":"The RADSEC proxy operator name"},"realms":{"type":"array","description":"The RADIUS realms of RADIUS proxy","items":{"$ref":"#/components/schemas/XiqCreateRadsecProxyRealm"}}},"required":["format_type","name","operator_name","operator_name_type"]},"XiqCreateInternalRadiusServerRequest":{"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","description":"The authentication group"},"default_authentication_method":{"$ref":"#/components/schemas/XiqInternalRadiusServerAuthenticationMethod","description":"The default authentication method"},"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":{"type":"integer","format":"int32","default":1812,"description":"Port for the authentication, must enable authentication. Max:65535, Min:1","maximum":65535,"minimum":1},"active_session_limit":{"type":"integer","format":"int32","default":0,"description":"Active session limit, must enable accounting setting. Max:15, Min:0","maximum":15,"minimum":0},"active_session_age_timeout":{"type":"integer","format":"int32","default":1800,"description":"Active session age timeout in seconds, must enable accounting setting. Max:300000000, Min:30","maximum":300000000,"minimum":30},"external_user_directory":{"$ref":"#/components/schemas/XiqExternalUserDirectory","description":"The external user directory, LDAP or AD settings"},"ca_certificate_id":{"type":"integer","format":"int64","description":"The CA certificate ID, which could be fetched from endpoint: '/certificates' and pick up with type 'CA'"},"server_certificate_id":{"type":"integer","format":"int64","description":"The Server certificate ID, which could be fetched from endpoint: '/certificates' and pick up with type 'CERT'"},"server_key_id":{"type":"integer","format":"int64","description":"The Server key ID, which could be fetched from endpoint: '/certificates' and pick up with type 'KEY'"},"device_ids":{"type":"array","description":"The list of device ID associated with the internal RADIUS server","items":{"type":"integer","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"}}},"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"]},"XiqCreateExternalRadiusServerRequest":{"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":{"type":"integer","format":"int32","default":1812,"description":"The authentication port for the external RADIUS server (1 ~ 65535)","maximum":65535,"minimum":1},"accounting_port":{"type":"integer","format":"int32","default":1813,"description":"The accounting port for the external RADIUS server (1 ~ 65535)","maximum":65535,"minimum":1},"server_type":{"$ref":"#/components/schemas/XiqRadiusServerType","description":"The port type of the RADIUS server, can only be either ACCOUNTING, AUTHENTICATION, or BOTH","example":"BOTH"},"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."},"enable_peer_discovery":{"type":"boolean","description":"Indicates whether the RADIUS server allows devices to connect automatically without manually defining their IP address or hostname."},"access_type":{"$ref":"#/components/schemas/XiqRadiusAccessType","description":"The access type of the External RADIUS server, an External RADIUS server with type 'SECURE' is a RADSEC server. This field cannot be changed after it is set."},"trust_pilot_id":{"type":"integer","format":"int64","description":"The Certificate Bundle trust pilot ID."}},"required":["accounting_port","authentication_port","enable_a3","name","server_type"]},"XiqRadiusAccessType":{"type":"string","enum":["STANDARD","SECURE"]},"XiqExternalRadiusServer":{"type":"object","description":"The configuration of external RADIUS server object","properties":{"id":{"type":"integer","format":"int64","description":"The unique identifier"},"create_time":{"type":"string","format":"date-time","description":"The create time in UTC (ISO 8601 format)"},"update_time":{"type":"string","format":"date-time","description":"The last update time in UTC (ISO 8601 format)"},"org_id":{"type":"integer","format":"int64","description":"The organization identifier, valid when enabling HIQ feature"},"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","format":"int32","description":"The authentication port for the external RADIUS server (1 ~ 65535)"},"accounting_port":{"type":"integer","format":"int32","description":"The accounting port for the external RADIUS server (1 ~ 65535)"},"server_type":{"$ref":"#/components/schemas/XiqRadiusServerType","description":"The port type of the RADIUS server, can only be either ACCOUNTING, AUTHENTICATION, or BOTH","example":"BOTH"},"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."},"enable_peer_discovery":{"type":"boolean","description":"Indicates whether the RADIUS server allows devices to connect automatically without manually defining their IP address or hostname."},"access_type":{"$ref":"#/components/schemas/XiqRadiusAccessType","description":"The access type of the External RADIUS server, an External RADIUS server with type 'SECURE' is a RADSEC server. This field cannot be changed after it is set."},"trust_pilot":{"$ref":"#/components/schemas/XiqCertificateBundle","description":"The Certificate Bundle trust pilot."}},"required":["accounting_port","authentication_port","create_time","enable_a3","id","name","server_type","update_time"]},"XiqCreateRadiusClient":{"type":"object","description":"The associate RADIUS client for RADIUS proxy","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","format":"int64","description":"The associate L3 address profile ID"}}},"XiqCreateRadiusProxyRealm":{"type":"object","description":"The associate RADIUS proxy realm for RADIUS proxy","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","format":"int64","description":"The associate RADIUS client object ID"}}},"XiqCreateRadiusProxyRequest":{"type":"object","description":"The payload to create a new RADIUS proxy","properties":{"name":{"type":"string","description":"The RADIUS proxy name"},"description":{"type":"string","description":"The RADIUS proxy description"},"format_type":{"$ref":"#/components/schemas/XiqRadiusProxyFormatType","description":"The format type of RADIUS proxy"},"retry_count":{"type":"integer","format":"int32","description":"The retry count of RADIUS proxy"},"retry_delay":{"type":"integer","format":"int32","description":"The retry delay of RADIUS proxy"},"dead_time":{"type":"integer","format":"int32","description":"The dead time of RADIUS proxy"},"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":{"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"},"maxItems":2147483647,"minItems":2},"device_ids":{"type":"array","description":"The device IDS to assign RADIUS proxy","items":{"type":"integer","format":"int64"},"minItems":1}},"required":["dead_time","device_ids","format_type","name","realms","retry_count","retry_delay"]},"XiqCreateRadiusClientObjectRequest":{"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":{"type":"integer","format":"int32","description":"The retry interval, 60 - 100000000 seconds","maximum":100000000,"minimum":60},"accounting_interim_update_interval":{"type":"integer","format":"int32","description":"The accounting interim update interval, 60 - 100000000 seconds","maximum":100000000,"minimum":60},"entries":{"type":"array","description":"The list of RADIUS client object entries","items":{"$ref":"#/components/schemas/XiqRadiusClientObjectEntry"},"maxItems":2147483647,"minItems":1}},"required":["accounting_interim_update_interval","enable_inject_operator_name_attribute","enable_message_authenticator_attribute","enable_permit_dynamic_authorization_message_change","entries","name","retry_interval"]},"XiqRadiusClientObjectEntry":{"type":"object","description":"The entry of RADIUS client object","properties":{"server_role":{"$ref":"#/components/schemas/XiqServerRole","description":"The entry server role: Primary, Backup1, Backup2, ..."},"server_type":{"$ref":"#/components/schemas/XiqRadiusClientObjectType","description":"The entry server type: INTERNAL_RADIUS_SERVER, EXTERNAL_RADIUS_SERVER, INTERNAL_RADIUS_PROXY"},"radius_server_id":{"type":"integer","format":"int64","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"}},"required":["radius_server_id","server_role","server_type"]},"XiqRadiusClientObjectType":{"type":"string","enum":["EXTERNAL_RADIUS_SERVER","INTERNAL_RADIUS_SERVER","INTERNAL_RADIUS_PROXY"]},"XiqRadiusClientObject":{"type":"object","description":"The RADIUS client object configuration","properties":{"id":{"type":"integer","format":"int64","description":"The unique identifier"},"create_time":{"type":"string","format":"date-time","description":"The create time in UTC (ISO 8601 format)"},"update_time":{"type":"string","format":"date-time","description":"The last update time in UTC (ISO 8601 format)"},"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":{"type":"integer","format":"int32","description":"The retry interval, 60 - 100000000 seconds","maximum":100000000,"minimum":60},"accounting_interim_update_interval":{"type":"integer","format":"int32","description":"The accounting interim update interval, 60 - 100000000 seconds","maximum":100000000,"minimum":60},"entries":{"type":"array","description":"The list of RADIUS client object entries","items":{"$ref":"#/components/schemas/XiqRadiusClientObjectEntry"},"maxItems":2147483647,"minItems":1}},"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"]},"XiqCreateRadioProfileRequest":{"type":"object","properties":{"name":{"type":"string","description":"The radio profile name"},"description":{"type":"string","description":"The radio profile description."},"transmission_power":{"type":"integer","format":"int32","description":"The transmission power floor in the range of 1-20 dBm or null for Auto.","maximum":20,"minimum":1},"max_transmit_power":{"type":"integer","format":"int32","description":"The maximum transmit power in the range of 10-20 dBm.","maximum":20,"minimum":10},"transmission_power_floor":{"type":"integer","format":"int32","description":"The transmission power floor in the range of 2-20 dBm.","maximum":20,"minimum":2},"transmission_power_max_drop":{"type":"integer","format":"int32","description":"The transmission power max drop in the range of 0-18 dB.","maximum":18,"minimum":0},"max_clients":{"type":"integer","format":"int32","description":"The maximum number of clients in the range of 1-255.","maximum":255,"minimum":1},"enable_client_transmission_power":{"type":"boolean","description":"Whether or not client transmission power control (802.11h) is enabled."},"client_transmission_power":{"type":"integer","format":"int32","description":"The client transmission power (in the range of 1-20 dBm) if it is enabled.","maximum":20,"minimum":1},"radio_mode":{"$ref":"#/components/schemas/XiqRadioMode","description":"The supported radio modes."},"enable_ofdma":{"type":"boolean","description":"Whether to enable Orthogonal Frequency Division Multiple Access (802.11ax) for multiple-user access by subdividing a channel."},"afc_power_mode":{"type":"string","description":"The AFC 6GHz power mode. -- \"SP\" (Standard Power), \"LPI\" (Low Power)"}},"required":["name"]},"XiqCreateRpMacOuiProfileRequest":{"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"}},"required":["name","value"]},"XiqInitKeyBasedPcgNetworkPolicyRequest":{"type":"object","description":"The request to create Key-based Private Client Group","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"}}},"required":["policy_name","ssid_name","users"]},"XiqKeyBasedPcg":{"type":"object","description":"The response of key based PCG data","properties":{"id":{"type":"integer","format":"int64","description":"The unique identifier"},"create_time":{"type":"string","format":"date-time","description":"The create time in UTC (ISO 8601 format)"},"update_time":{"type":"string","format":"date-time","description":"The last update time in UTC (ISO 8601 format)"},"org_id":{"type":"integer","format":"int64","description":"The organization identifier, valid when enabling HIQ feature"},"policy_id":{"type":"integer","format":"int64","description":"The network policy ID"},"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"}}},"required":["create_time","enabled","id","policy_id","policy_name","ssid_name","update_time"]},"XiqKeyBasedPcgUser":{"type":"object","description":"The key based PCG user detailed info","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","format":"int64","description":"The user ID"},"create_time":{"type":"string","format":"date-time","description":"The create timestamp"},"update_time":{"type":"string","format":"date-time","description":"The create timestamp"},"org_id":{"type":"integer","format":"int64","description":"The organization ID"}},"required":["create_time","email","id","name","update_time","user_group_name"]},"XiqCreateKeyBasedPcgUsersRequest":{"type":"object","description":"The payload of add Key-based Private Client Group users request","properties":{"users":{"type":"array","description":"The key based PCG users","items":{"$ref":"#/components/schemas/XiqKeyBasedPcgUserBaseInfo"}}},"required":["users"]},"XiqCreateKeyBasedPcgUsersResponse":{"type":"object","description":"The response of add Key-based Private Client Group users request","properties":{"policy_id":{"type":"integer","format":"int64","description":"The network policy ID"},"status":{"type":"string","description":"The status response"},"users":{"type":"array","description":"The XIQ key based PCG users","items":{"$ref":"#/components/schemas/XiqKeyBasedPcgUser"}}},"required":["policy_id","status"]},"XiqPcgAssignPortsRequest":{"type":"object","description":"The payload to assign ports for AP150W or AP302W)","properties":{"port_assignments":{"type":"array","description":"The port assignment list","items":{"$ref":"#/components/schemas/XiqPcgPortAssignment"}}},"required":["port_assignments"]},"XiqPcgPortAssignment":{"type":"object","description":"The PCG port assignment entry","properties":{"device_id":{"type":"integer","format":"int64","description":"The device ID of AP150W or AP302W"},"eth1_user_id":{"type":"integer","format":"int64","description":"The eth1 user ID, get available users from \"/pcgs/key-based/network-policy-{policyId}/users\""},"eth2_user_id":{"type":"integer","format":"int64","description":"The eth2 user ID, get available users from \"/pcgs/key-based/network-policy-{policyId}/users\""},"eth3_user_id":{"type":"integer","format":"int64","description":"The eth3 user ID, get available users from \"/pcgs/key-based/network-policy-{policyId}/users\""}},"required":["device_id"]},"XiqPcgAssignPortsResponse":{"type":"object","description":"The response of assign ports for AP150W or AP302W","properties":{"policy_id":{"type":"integer","format":"int64","description":"The network policy ID"},"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"}}},"required":["pcg_port_assignment_entries","policy_id","policy_name"]},"XiqPcgPortAssignmentEntry":{"type":"object","description":"The PCG port assignment entry","properties":{"id":{"type":"integer","format":"int64","description":"The unique identifier"},"create_time":{"type":"string","format":"date-time","description":"The create time in UTC (ISO 8601 format)"},"update_time":{"type":"string","format":"date-time","description":"The last update time in UTC (ISO 8601 format)"},"org_id":{"type":"integer","format":"int64","description":"The organization identifier, valid when enabling HIQ feature"},"device_id":{"type":"integer","format":"int64","description":"The device ID of AP150W or AP302W"},"eth1_user_id":{"type":"integer","format":"int64","description":"The eth1 user ID, get available users from \"/pcgs/key-based/network-policy-{policyId}/users\""},"eth2_user_id":{"type":"integer","format":"int64","description":"The eth2 user ID, get available users from \"/pcgs/key-based/network-policy-{policyId}/users\""},"eth3_user_id":{"type":"integer","format":"int64","description":"The eth3 user ID, get available users from \"/pcgs/key-based/network-policy-{policyId}/users\""}},"required":["create_time","device_id","id","update_time"]},"XiqOnboardKeyBasedPcgRequest":{"type":"object","description":"The payload to create Key Based PCG data(from exist network policy and SSID)","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","format":"int64"}}},"required":["enabled","ssid_name","user_ids"]},"XiqOnboardKeyBasedPcgResponse":{"type":"object","description":"The response of key based pcg onboard","properties":{"policy_id":{"type":"integer","format":"int64","description":"The network policy ID"},"ssid_name":{"type":"string","description":"The SSID name"},"status":{"type":"string","description":"The status response"}},"required":["policy_id","ssid_name","status"]},"XiqCaptureBandSelection":{"type":"string","enum":["ALL","2.4GHZ","5GHZ","6GHZ"]},"XiqCaptureDirectionSelection":{"type":"string","enum":["BOTH","OUT","IN"]},"XiqCaptureFilter":{"type":"object","description":"The filter criteria for packet capture","properties":{"mac_addr":{"type":"array","description":"List of the client MAC addresses used for packet capturing","items":{"type":"string"}},"ip_addr":{"type":"array","description":"List of  the client IP addresses used to filter the packets","items":{"type":"string"}},"protocol":{"$ref":"#/components/schemas/XiqPolicyRuleProtocolType","description":"Protocol type to filter by"},"protocol_number":{"type":"integer","format":"int32","description":"The protocol number if protocol is \"USER_DEFINED\"","maximum":255,"minimum":0},"port":{"type":"integer","format":"int32","description":"The port for packet capture"},"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."}}},"XiqCaptureIdentifierType":{"type":"string","enum":["AP_SERIAL_NUMBER","DEVICE_IDS","LOCATION"]},"XiqCaptureLocation":{"type":"object","description":"This represents the options for location packet capture.","properties":{"direction":{"$ref":"#/components/schemas/XiqCaptureDirectionSelection","description":"The capture traffic direction"},"radio":{"$ref":"#/components/schemas/XiqCaptureRadioSelection","description":"The wireless radio to capture. Set to ALL for all radios."},"wired_interface":{"$ref":"#/components/schemas/XiqCaptureWiredSelection","description":"The name of the wired interface to capture. Set to ALL for all interfaces."},"wireless_band":{"$ref":"#/components/schemas/XiqCaptureBandSelection","description":"The wireless band to capture. Set to ALL for all bands."},"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"}}}},"XiqCaptureRadioSelection":{"type":"string","enum":["ALL","RADIO1","RADIO2","RADIO3","RADIO4"]},"XiqCaptureResult":{"type":"object","description":"This represents the packet capture result on an AP's interface. A packet capture session may involve multiple APs on multiple interfaces.","properties":{"id":{"type":"integer","format":"int64","description":"The unique identifier"},"org_id":{"type":"integer","format":"int64","description":"The organization identifier, valid when enabling HIQ feature"},"start_time":{"type":"string","format":"date-time","description":"The packet capture start time"},"end_time":{"type":"string","format":"date-time","description":"The packet capture end time"},"device_id":{"type":"integer","format":"int64","description":"The device identifier"},"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","format":"int64","description":"The location ID"},"locations":{"type":"array","description":"The detailed location","items":{"$ref":"#/components/schemas/XiqLocationLegend"}},"status":{"$ref":"#/components/schemas/XiqPacketCaptureStatus","description":"The status of the packet capture result"},"error_message":{"type":"string","description":"The error message (may be empty)."},"error_code":{"type":"string","description":"The error code (message key) identifying the type of error (may be empty)."},"storage":{"$ref":"#/components/schemas/XiqStorage","description":"The packet capture file storage"}}},"XiqCaptureWiredSelection":{"type":"string","enum":["ALL","ETH0","ETH1","ETH2","ETH3"]},"XiqCloudSharkStorage":{"type":"object","description":"The packet capture file name and URL in CloudShark.","properties":{"file_name":{"type":"string","description":"File name in CloudShark"},"file_url":{"type":"string","description":"File URL in CloudShark"}}},"XiqDestinationType":{"type":"string","enum":["CLOUD","CLOUD_SHARK"]},"XiqLocationLegend":{"type":"object","description":"The simple location information","properties":{"id":{"type":"integer","format":"int64","description":"The location ID"},"name":{"type":"string","description":"The location name"}}},"XiqPacketCapture":{"type":"object","description":"This represents the packet capture session","properties":{"id":{"type":"integer","format":"int64","description":"The unique identifier"},"start_time":{"type":"string","format":"date-time","description":"The packet capture start time"},"end_time":{"type":"string","format":"date-time","description":"The packet capture end time"},"org_id":{"type":"integer","format":"int64","description":"The organization identifier, valid when enabling HIQ feature"},"name":{"type":"string","description":"The packet capture session name. If the name is null or empty, it will be auto generated."},"duration":{"type":"integer","format":"int32","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.","maximum":604800,"minimum":0},"capture_id_type":{"$ref":"#/components/schemas/XiqCaptureIdentifierType","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."},"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","format":"int64"}},"location_id":{"type":"integer","format":"int64","description":"The assigned location ID, it must be FLOOR type"},"destination":{"$ref":"#/components/schemas/XiqDestinationType","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."},"filter":{"$ref":"#/components/schemas/XiqCaptureFilter","description":"This represents the properties of filters used for the packet capture."},"capture_if":{"$ref":"#/components/schemas/XiqCaptureLocation","description":"This represents the options for location packet capture."},"status":{"$ref":"#/components/schemas/XiqPacketCaptureStatus","description":"The status of the packet capture session"},"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."}}},"XiqPacketCaptureStatus":{"type":"string","enum":["INITIAL","ACTIVE","SUCCESS","PARTIAL_SUCCESS","FAILED"]},"XiqPolicyRuleProtocolType":{"type":"string","enum":["ANY","USER_DEFINED","ICMP","ICMPV6","TCP","UDP","GRE","IPSEC_ESP","IPSEC_AH"]},"XiqStorage":{"type":"object","description":"The packet capture file storage","properties":{"cloud_storage":{"type":"string","description":"XIQ cloud storage location after a packet capture is completed."},"cloud_shark_storage":{"$ref":"#/components/schemas/XiqCloudSharkStorage","description":"CloudShark file info when destination is CloudShark"}}},"XiqWiredFilterType":{"type":"string","enum":["DHCP","RADIUS","LLDP","ARP","MDNS"]},"XiqWirelessFilterType":{"type":"string","enum":["MANAGEMENT","CONTROL","DATA","EAPOL","BEACONS","PROBES"]},"XiqCaptureStopRequest":{"type":"object","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.","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","format":"int64"}}}},"XiqGetDeviceInfobyNosRequest":{"type":"object","properties":{"endpoint":{"type":"string","description":"The url name"},"method":{"$ref":"#/components/schemas/XiqHttpMethod","description":"The http method sent"},"json_body":{"type":"array","description":"body for POST request","items":{"type":"string"}}},"required":["endpoint","method"]},"XiqHttpMethod":{"type":"string","enum":["GET","POST","DELETE","PATCH"]},"XiqGetDeviceInfoByNos":{"type":"object","properties":{"status_code":{"type":"integer","format":"int32","description":"The url name"},"status_message":{"type":"string","description":"The http method sent"},"body":{"type":"string","description":"body for POST request"}},"required":["status_code","status_message"]},"XiqQoeDiagnosticsConnTypes":{"type":"string","enum":["UNKNOWN","WIRELESS","WIRED","THREAD"]},"XiqQoeDiagnosticsDeviceTypes":{"type":"string","enum":["WIRED","WIRELESS"]},"XiqQoeDiagnosticsTimeSeriesFilters":{"type":"object","description":"metrics","properties":{"metrics":{"$ref":"#/components/schemas/XiqQoeDiagnosticsMetrics","description":"The metrics to be used for the diagnostics"},"site_ids":{"type":"array","description":"The list of Site Ids","items":{"type":"integer","format":"int64"}},"floor_ids":{"type":"array","description":"The list of Floor Ids","items":{"type":"integer","format":"int64"}},"building_ids":{"type":"array","description":"The list of Building Ids","items":{"type":"integer","format":"int64"}},"bands":{"type":"array","description":"List of bands","items":{"$ref":"#/components/schemas/XiqDiagnosticsBands"}},"contypes":{"type":"array","description":"List of Connection Types","items":{"$ref":"#/components/schemas/XiqQoeDiagnosticsConnTypes"}},"devicetypes":{"type":"array","description":"List of device types","items":{"$ref":"#/components/schemas/XiqQoeDiagnosticsDeviceTypes"}},"vlan_ids":{"type":"array","description":"The list of vlan Ids","items":{"type":"integer","format":"int32"}},"device_ids":{"type":"array","description":"The list of device Ids","items":{"type":"integer","format":"int64"}},"ssids":{"type":"array","description":"The list of ssids","items":{"type":"string"}},"user_names":{"type":"array","description":"The list of usernames","items":{"type":"string"}},"client_macs":{"type":"array","description":"The list of client MACs","items":{"type":"string"}},"port_nums":{"type":"array","description":"The list of port numbers","items":{"type":"integer","format":"int64"}},"app_ids":{"type":"array","description":"The list of application Ids","items":{"type":"integer","format":"int64"}},"channel_nums":{"type":"array","description":"The list of channel numbers","items":{"type":"integer","format":"int32"}},"admin_roles":{"type":"array","description":"The list of Admin Roles","items":{"type":"integer","format":"int64"}},"start_time":{"type":"integer","format":"int64","description":"Start Time in epoch milliseconds"},"end_time":{"type":"integer","format":"int64","description":"End Time in epoch milliseconds"},"async":{"type":"boolean","default":false,"description":"LRO Call"},"page":{"type":"integer","format":"int32","description":"page Value"},"limit":{"type":"integer","format":"int32","description":"limit Value"},"os_types":{"type":"array","items":{"type":"string"}},"is_ssid_selected":{"type":"boolean","default":true,"description":"is ssid filter applied"},"is_band_selected":{"type":"boolean","default":true,"description":"is band filter applied"}},"required":["async","building_ids","end_time","floor_ids","metrics","site_ids","start_time"]},"XiqDiagnosticsTimeRange":{"type":"object","description":"Time Range ","properties":{"start_time":{"type":"integer","format":"int64","description":"Start Time in epoch milliseconds"},"end_time":{"type":"integer","format":"int64","description":"End Time in epoch milliseconds"}}},"XiqOsEntry":{"type":"object","properties":{"os":{"type":"string"},"value":{"type":"integer","format":"int64"}}},"XiqQoeDiagnosticsOsRowData":{"type":"object","properties":{"timestamp":{"type":"integer","format":"int64"},"os_data":{"type":"array","items":{"$ref":"#/components/schemas/XiqOsEntry"}}}},"XiqQoeDiagnosticsResponse":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/XiqQoeDiagnosticsMetrics","description":"Metrics name"},"metrics_group":{"type":"string","description":"Metrics Group","enum":["GROUP_DEVICES","GROUP_CLIENTS","GROUP_APPLICATIONS_USAGE"]},"time_range":{"$ref":"#/components/schemas/XiqDiagnosticsTimeRange"},"data":{"type":"array","items":{"type":"object","additionalProperties":{}}},"os_row_data":{"type":"array","items":{"$ref":"#/components/schemas/XiqQoeDiagnosticsOsRowData"}},"session_row_data":{"type":"array","items":{"$ref":"#/components/schemas/XiqQoeDiagnosticsSessionRowData"}}},"required":["data","metrics_group","name","time_range"]},"XiqQoeDiagnosticsSessionRowData":{"type":"object","properties":{"timestamp":{"type":"integer","format":"int64"},"session_data":{"type":"array","items":{"$ref":"#/components/schemas/XiqSessionEntry"}}}},"XiqSessionEntry":{"type":"object","properties":{"site_name":{"type":"string"},"value":{"type":"integer","format":"int64"}}},"XiqQoeDiagnosticsTableDataFilters":{"type":"object","description":"metrics","properties":{"metrics":{"$ref":"#/components/schemas/XiqQoeDiagnosticsMetrics","description":"metrics"},"site_ids":{"type":"array","description":"The list of Site Ids","items":{"type":"integer","format":"int64"}},"floor_ids":{"type":"array","description":"The list of Floor Ids","items":{"type":"integer","format":"int64"}},"building_ids":{"type":"array","description":"The list of Building Ids","items":{"type":"integer","format":"int64"}},"bands":{"type":"array","description":"List of bands","items":{"$ref":"#/components/schemas/XiqDiagnosticsBands"}},"contypes":{"type":"array","description":"List of Connection Types","items":{"$ref":"#/components/schemas/XiqQoeDiagnosticsConnTypes"}},"devicetypes":{"type":"array","description":"List of device types","items":{"$ref":"#/components/schemas/XiqQoeDiagnosticsDeviceTypes"}},"vlan_ids":{"type":"array","description":"The list of vlan Ids","items":{"type":"integer","format":"int32"}},"device_ids":{"type":"array","description":"The list of device Ids","items":{"type":"integer","format":"int64"}},"ssids":{"type":"array","description":"The list of ssids","items":{"type":"string"}},"user_names":{"type":"array","description":"The list of usernames","items":{"type":"string"}},"client_macs":{"type":"array","description":"The list of client MACs","items":{"type":"string"}},"port_nums":{"type":"array","description":"The list of port numbers","items":{"type":"integer","format":"int64"}},"app_ids":{"type":"array","description":"The list of application Ids","items":{"type":"integer","format":"int64"}},"channel_nums":{"type":"array","description":"The list of channel numbers","items":{"type":"integer","format":"int32"}},"admin_roles":{"type":"array","description":"The list of Admin Roles","items":{"type":"integer","format":"int64"}},"start_time":{"type":"integer","format":"int64","description":"Start Time in epoch milliseconds"},"end_time":{"type":"integer","format":"int64","description":"End Time in epoch milliseconds"},"sort_field":{"type":"string","default":"TIME_STAMP","description":"Sort Field","enum":["TIME_STAMP","MAC","HOSTNAME","SESSION_DURATION","CONNECTED_TIME","DISCONNECTED_TIME","TOTAL_DATA_USAGE","RELATIVE_TIME","TOTAL_POWER_USAGE","IDLE_POWER","MAX_POWER","AVG_POWER","APPLICATION_USAGE","PERCENTAGE_CHANNEL_UTILIZATION","PERCENTAGE_AIRTIME_UTILIZATION","ERROR_TIMESTAMP","NETWORK_USAGE","RETRY_COUNT","FAILED_ROAM_DATE_AND_TIME","LAST_AP_HOSTNAME","FROM_AP_HOSTNAME","TO_AP_HOSTNAME","FAILURE_TIME_STAMP","PORT_SPEED","DEVICE_DOWN_DATE_AND_TIME","DOWN_TIME","LOGIN_DATE_AND_TIME","LOGIN_DURATION","AUTHENTICATION_DATE_TIME","USB_POWER_CONSUMED","ALERT_DATE_TIME","DFS_CHANNEL_CHANGE_DATE_AND_TIME","ACSP_CHANGE_DATE_AND_TIME","DATE_AND_TIME","PERCENTAGE_CONGESTION"]},"sort_order":{"$ref":"#/components/schemas/XiqSortOrder","default":"ASC","description":"Sort Order"},"page_no":{"type":"integer","format":"int32","default":1,"description":"page no"},"limit":{"type":"integer","format":"int32","default":1,"description":"limit"},"export_data":{"type":"boolean","default":false,"description":"export data"},"search_parameter":{"type":"string","description":"search parameter"},"async":{"type":"boolean","default":false,"description":"LRO Call"},"os_types":{"type":"array","items":{"type":"string"}},"is_ssid_selected":{"type":"boolean","default":true,"description":"is ssid filter applied"},"is_band_selected":{"type":"boolean","default":true,"description":"is band filter applied"}},"required":["building_ids","end_time","floor_ids","metrics","site_ids","sort_field","sort_order","start_time"]},"XiqSortOrder":{"type":"string","enum":["ASC","DESC"]},"PagedMapStringObject":{"type":"object","properties":{"page":{"type":"integer","format":"int32","description":"The current page number"},"count":{"type":"integer","format":"int32","description":"The element count of the current page"},"total_pages":{"type":"integer","format":"int32","description":"The total page number based on request page size"},"total_count":{"type":"integer","format":"int64","description":"The total element count"},"data":{"type":"array","description":"The data in the current page","items":{"type":"object","additionalProperties":{}}}},"required":["count","page","total_count","total_pages"]},"XiqRecipientIdsRequest":{"type":"object","properties":{"recipient_ids":{"type":"array","description":"List of recipient IDs","items":{"type":"integer","format":"int64"}}}},"XiqCustomReportRequest":{"type":"object","properties":{"metrics":{"type":"array","description":"List of metrics to include in the report (e.g., MAX_CONCURRENT_CLIENTS).","items":{"$ref":"#/components/schemas/XiqQoeDiagnosticsMetrics"},"minItems":1},"report_name":{"type":"string","description":"The name of the report.","minLength":1},"report_description":{"type":"string","description":"A short description of the report."},"site_ids":{"type":"array","description":"List of site IDs the report will cover.","items":{"type":"integer","format":"int64"}},"building_ids":{"type":"array","description":"List of building IDs the report will cover.","items":{"type":"integer","format":"int64"}},"floor_ids":{"type":"array","description":"List of floor IDs the report will cover.","items":{"type":"integer","format":"int64"}},"ssids":{"type":"array","description":"List of SSIDs to be included in the report.","items":{"type":"string"}},"bands":{"type":"array","description":"List of bands (e.g., 2.4GHz, 5GHz) to be covered in the report.","items":{"$ref":"#/components/schemas/XiqDiagnosticsBands"}},"recipients":{"type":"array","description":"List of recipient email to send the report.","items":{"$ref":"#/components/schemas/XiqRecipientCnsInfo"}},"schedules":{"type":"array","description":"List of schedules (e.g., daily, weekly, etc.).","items":{"$ref":"#/components/schemas/XiqReportScheduleRequest"},"minItems":1},"file_format":{"type":"array","description":"The file format(s) of the report (e.g., PDF, CSV).","items":{"$ref":"#/components/schemas/XiqReportFileFormat"},"minItems":1}},"required":["file_format","metrics","report_name","schedules"]},"XiqReportScheduleRequest":{"type":"object","properties":{"frequency_type":{"$ref":"#/components/schemas/XiqScheduleFrequency","description":"The frequency type of the scheduled report (e.g., DAILY, WEEKLY, etc.)."},"schedule_time":{"type":"string","default":"23:59","description":"The scheduled time in HH:MM format (e.g., 08:00)."},"schedule_timezone":{"type":"string","default":"UTC","description":"The timezone of the scheduled report."},"schedule_days":{"type":"array","description":"Days on which the report is scheduled (e.g., [0] for Sunday).","items":{"type":"integer","format":"int32"},"minItems":1},"enable_schedule":{"type":"boolean","default":true,"description":"Whether the schedule is enabled or not."}},"required":["frequency_type","schedule_days"]},"XiqQoeMetadataUsersFilter":{"type":"object","properties":{"site_ids":{"type":"array","description":"The list of Site Ids","items":{"type":"integer","format":"int64"}},"building_ids":{"type":"array","description":"The list of Building Ids","items":{"type":"integer","format":"int64"}},"floor_ids":{"type":"array","description":"The list of Floor Ids","items":{"type":"integer","format":"int64"}}}},"XiqQoeDiagnosticsSsidMetadataFilter":{"type":"object","description":"Request body for Alert Diagnostics Filter","properties":{"site_ids":{"type":"array","description":"List of site ids","items":{"type":"integer","format":"int64"}},"building_ids":{"type":"array","description":"List of building ids","items":{"type":"integer","format":"int64"}},"floor_ids":{"type":"array","description":"List of floor ids","items":{"type":"integer","format":"int64"}},"start_time":{"type":"integer","format":"int64","description":"start time in epoch milliseconds"},"end_time":{"type":"integer","format":"int64","description":"end time in epoch milliseconds"}}},"XiqQoeDiagnosticsChannelMetadataFilter":{"type":"object","description":"Request body for Alert Diagnostics Filter","properties":{"site_ids":{"type":"array","description":"List of site ids","items":{"type":"integer","format":"int64"}},"building_ids":{"type":"array","description":"List of building ids","items":{"type":"integer","format":"int64"}},"floor_ids":{"type":"array","description":"List of floor ids","items":{"type":"integer","format":"int64"}},"ssids":{"type":"array","description":"List of ssids","items":{"type":"string"}},"bands":{"type":"array","description":"List of band","items":{"$ref":"#/components/schemas/XiqDiagnosticsBands"}}}},"XiqQoeMetadataDeviceFilter":{"type":"object","description":"The Request Body Device Metadata ","properties":{"site_ids":{"type":"array","description":"The list of Site Ids","items":{"type":"integer","format":"int64"}},"building_ids":{"type":"array","description":"The list of Building Ids","items":{"type":"integer","format":"int64"}},"floor_ids":{"type":"array","description":"The list of Floor Ids","items":{"type":"integer","format":"int64"}},"ssids":{"type":"array","description":"The list of ssids","items":{"type":"string"}},"bands":{"type":"array","description":"The list of bands","items":{"$ref":"#/components/schemas/XiqDiagnosticsBands"}},"channels":{"type":"array","description":"The list of channels","items":{"type":"integer","format":"int32"}},"os_types":{"type":"array","description":"The list of os_types","items":{"type":"string"}}}},"XiqDevice":{"type":"object","description":"The Device for QoE Diagnostics Filtering","properties":{"id":{"type":"integer","format":"int64","description":"The Device Id"},"hostname":{"type":"string","description":"The Device Hostname"}}},"XiqQoeMetadataClientFilter":{"type":"object","properties":{"site_ids":{"type":"array","description":"The list of Site Ids","items":{"type":"integer","format":"int64"}},"building_ids":{"type":"array","description":"The list of Building Ids","items":{"type":"integer","format":"int64"}},"floor_ids":{"type":"array","description":"The list of Floor Ids","items":{"type":"integer","format":"int64"}},"usernames":{"type":"array","description":"The list of usernames","items":{"type":"string"}}}},"XiqClient":{"type":"object","description":"The Client associate to ExtremeCloud IQ device","properties":{"id":{"type":"integer","format":"int64","description":"The unique identifier"},"create_time":{"type":"string","format":"date-time","description":"The create time in UTC (ISO 8601 format)"},"update_time":{"type":"string","format":"date-time","description":"The last update time in UTC (ISO 8601 format)"},"org_id":{"type":"integer","format":"int64","description":"The organization identifier, valid when enabling HIQ feature"},"location_id":{"type":"integer","format":"int64","description":"The location ID"},"device_id":{"type":"integer","format":"int64","description":"The device ID"},"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","format":"date-time","description":"The online time for the client"},"offline_time":{"type":"string","format":"date-time","description":"The offline time for the client"},"vlan":{"type":"integer","format":"int32","description":"The associate VLAN"},"connection_type":{"type":"integer","format":"int32","description":"The connection type"},"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","format":"int32","description":"The associated device function"},"device_mac_address":{"type":"string","description":"The associated device mac address"},"device_name":{"type":"string","description":"The associated device name"},"auth":{"type":"integer","format":"int32","description":"The authentication type"},"channel":{"type":"integer","format":"int32","description":"The channel value"},"client_health":{"type":"integer","format":"int32","description":"The health score of client"},"application_health":{"type":"integer","format":"int32","description":"The health score of application"},"radio_health":{"type":"integer","format":"int32","description":"The health score of radio"},"network_health":{"type":"integer","format":"int32","description":"The health score of network"},"radio_type":{"type":"integer","format":"int32","description":"The radio type. Represented by an integer code for each standard:<br> 1 - 2.4G<br> 2 - 5G<br> 3 - WIRED<br> 4 - 6G<br> 5 - THREAD"},"encryption_method":{"type":"integer","format":"int32","description":"The encryption method, represented by an integer code for each encryption type:<br>-1 - N/A (Not applicable)<br>0 - AES (Advanced Encryption Standard)<br>1 - TKIP (Temporal Key Integrity Protocol)<br>2 - WEP (Wired Equivalent Privacy)<br>3 - NON (No encryption)<br>4 - CCMP (Counter Mode with Cipher Block Chaining Message Authentication Code Protocol)<br>5 - KEYGUARD (Keyguard encryption)<br>6 - WEP128 (128-bit WEP encryption)<br>7 - WEP64 (64-bit WEP encryption)<br>8 - WAPI (WLAN Authentication and Privacy Infrastructure)<br>9 - GCMP256 (256-bit Galois/Counter Mode Protocol)<br>10 - NONE (No encryption)<br>11 - PAP (Password Authentication Protocol)<br>12 - MsCHAP (Microsoft Challenge Handshake Authentication Protocol)<br>13 - EAP-MD5 (Extensible Authentication Protocol - MD5)<br>14 - EAP-TLS (Extensible Authentication Protocol - Transport Layer Security)<br>15 - PEAP (Protected Extensible Authentication Protocol)<br>16 - TTLS (Tunneled Transport Layer Security)<br>17 - TTLS-INNER-TUNNEL (Inner tunnel for TTLS)<br>18 - PEAP-INNER-TUNNEL (Inner tunnel for PEAP)<br>19 - EAP-FAST (Extensible Authentication Protocol - Flexible Authentication via Secure Tunneling)<br>20 - EAP-LEAP (Lightweight Extensible Authentication Protocol)<br>21 - EAP-RSA (Extensible Authentication Protocol - RSA)<br>22 - EAP-SIM (Extensible Authentication Protocol - SIM)<br>23 - EAP-AKA (Extensible Authentication Protocol - AKA)<br>24 - EAP-TEAP (Extensible Authentication Protocol - Tunneled EAP)"},"mac_protocol":{"type":"string","description":"The MAC protocol of the client:<br>'N/A'<br>'802.11a'<br>'802.11b'<br>'802.11g'<br>'802.11na'<br>'802.11ng'<br>'802.11ac'<br>'802.11ax-2.4g'<br>'802.11ax-5g'<br>'802.3'<br>'802.11ax-6g'<br>'802.15.4'<br>'802.11be-2g'<br>'802.11be-5g'<br>'802.11be-6g'"},"interface_name":{"type":"string","description":"The interface name"},"bssid":{"type":"string","description":"The bssid"},"rssi":{"type":"integer","format":"int32","description":"The RSSI"},"snr":{"type":"integer","format":"int32","description":"The SNR"},"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"},"th_rloc16":{"type":"string","description":"The thread client Rloc16"},"th_child_id":{"type":"integer","format":"int32","description":"The thread client child ID"},"th_timeout":{"type":"integer","format":"int64","description":"The thread client timeout"},"th_supervision_interval":{"type":"integer","format":"int32","description":"The thread client Super vision interval"},"th_netdata_version":{"type":"integer","format":"int32","description":"The thread client netdata version"},"th_csl_synced":{"type":"boolean","description":"The thread client CSL synced"},"th_ip_addresses":{"type":"array","description":"The thread client IP addresses","items":{"$ref":"#/components/schemas/XiqThreadIpv6Setting"}},"th_router_last_reported":{"type":"string","format":"date-time","description":"The last reported datetime by thread router"},"thread_connected":{"type":"boolean","description":"Is client connected to thread network"},"make":{"type":"string","description":"The Manufacturer of the client associated device"},"os_version":{"type":"string","description":"The OS version of the client associated device"},"connected_to":{"type":"string","description":"The device name which client is connected to"},"connection_duration":{"type":"integer","format":"int64","description":"The client's connection duration"},"captive_web_portal":{"type":"string","description":"Captive Web Portal"}},"required":["create_time","id","update_time"]},"XiqQoeDiagnosticsBandMetadataFilter":{"type":"object","description":"Request body for Alert Diagnostics Filter","properties":{"site_ids":{"type":"array","description":"List of site ids","items":{"type":"integer","format":"int64"}},"building_ids":{"type":"array","description":"List of building ids","items":{"type":"integer","format":"int64"}},"floor_ids":{"type":"array","description":"List of floor ids","items":{"type":"integer","format":"int64"}},"ssids":{"type":"array","description":"List of ssids","items":{"type":"string"}},"start_time":{"type":"integer","format":"int64","description":"start time in epoch milliseconds"},"end_time":{"type":"integer","format":"int64","description":"end time in epoch milliseconds"}}},"XiqQoeMetadataApplicationFilter":{"type":"object","properties":{"site_ids":{"type":"array","description":"The list of Site Ids","items":{"type":"integer","format":"int64"}},"building_ids":{"type":"array","description":"The list of Building Ids","items":{"type":"integer","format":"int64"}},"floor_ids":{"type":"array","description":"The list of Floor Ids","items":{"type":"integer","format":"int64"}},"usernames":{"type":"array","description":"The list of usernames","items":{"type":"string"}},"client_macs":{"type":"array","description":"The list of client MAC addresses","items":{"type":"string"}}}},"XiqNgMode":{"type":"string","enum":["SNAPSHOT","AGG_SNAPSHOT"]},"XiqXlsxNgReportsDataFilters":{"type":"object","description":"update action request","properties":{"metrics":{"type":"array","description":"The list of metrics","items":{"$ref":"#/components/schemas/XiqQoeDiagnosticsMetrics"}},"site_ids":{"type":"array","description":"The list of Site Ids","items":{"type":"integer","format":"int64"}},"floor_ids":{"type":"array","description":"The list of Floor Ids","items":{"type":"integer","format":"int64"}},"building_ids":{"type":"array","description":"The list of Building Ids","items":{"type":"integer","format":"int64"}},"bands":{"type":"array","description":"List of bands","items":{"$ref":"#/components/schemas/XiqDiagnosticsBands"}},"contypes":{"type":"array","description":"List of Connection Types","items":{"$ref":"#/components/schemas/XiqQoeDiagnosticsConnTypes"}},"devicetypes":{"type":"array","description":"List of device types","items":{"$ref":"#/components/schemas/XiqQoeDiagnosticsDeviceTypes"}},"vlan_ids":{"type":"array","description":"The list of vlan Ids","items":{"type":"integer","format":"int32"}},"device_ids":{"type":"array","description":"The list of device Ids","items":{"type":"integer","format":"int64"}},"ssids":{"type":"array","description":"The list of ssids","items":{"type":"string"}},"user_names":{"type":"array","description":"The list of usernames","items":{"type":"string"}},"client_macs":{"type":"array","description":"The list of client MACs","items":{"type":"string"}},"port_nums":{"type":"array","description":"The list of port numbers","items":{"type":"integer","format":"int64"}},"app_ids":{"type":"array","description":"The list of application Ids","items":{"type":"integer","format":"int64"}},"channel_nums":{"type":"array","description":"The list of channel numbers","items":{"type":"integer","format":"int32"}},"admin_roles":{"type":"array","description":"The list of Admin Roles","items":{"type":"integer","format":"int64"}},"start_time":{"type":"integer","format":"int64","description":"Start Time in epoch millis"},"end_time":{"type":"integer","format":"int64","description":"End Time in epoch millis"},"export_data":{"type":"boolean","default":false,"description":"export data"},"search_parameter":{"type":"string","description":"search parameter"},"async":{"type":"boolean","default":false,"description":"LRO Call"},"mode":{"$ref":"#/components/schemas/XiqNgMode","description":"Mode"},"download_type":{"type":"string","description":"download Type","enum":["CSV","XLSX","PDF"]},"limit":{"type":"integer","format":"int32","description":"limit of records"},"page":{"type":"integer","format":"int32","description":"page number"},"time_offset":{"type":"integer","format":"int32","description":"time offset"},"os_types":{"type":"array","items":{"type":"string"}},"is_ssid_selected":{"type":"boolean","default":true,"description":"is ssid filter applied"},"is_band_selected":{"type":"boolean","default":true,"description":"is band filter applied"}},"required":["building_ids","end_time","floor_ids","site_ids","start_time"]},"NgMetricsReport":{"type":"object","description":"ExtremeCloud IQ  report","properties":{"id":{"type":"string","description":"The  reportId"}},"required":["id"]},"XiqNetworkServiceRequest":{"type":"object","properties":{"name":{"type":"string","description":"The network service name."},"description":{"type":"string","description":"The network service name."},"ip_protocol":{"$ref":"#/components/schemas/XiqNetworkIpProtocol","description":"IP Protocol, only for custom Application."},"protocol_number":{"type":"integer","format":"int32","description":"The Network Protocol Number"},"port_number":{"type":"integer","format":"int32","description":"The Network Port Number"},"alg_type":{"$ref":"#/components/schemas/XiqNetworkAlgType","description":"Application Layer Gateway (ALG) type, only for custom Application."}}},"XiqCreateNetworkPolicyRequest":{"type":"object","properties":{"name":{"type":"string","description":"The network policy name"},"description":{"type":"string","description":"The network policy description"},"type":{"$ref":"#/components/schemas/XiqNetworkPolicyType","description":"The network policy type"}},"required":["name","type"]},"XiqCreateMacObjectRequest":{"type":"object","properties":{"name":{"type":"string","description":"The product model"},"description":{"type":"string","description":"The product description"},"value":{"type":"string","description":"The MAC octets."},"mac_type":{"$ref":"#/components/schemas/XiqMacObjectType","description":"Mac Object type"},"mac_address_end":{"type":"string","description":"The MAC address end, only available for \"MAC_RANGE\" type."}},"required":["mac_type","name","value"]},"XiqAuditLogSortField":{"type":"string","description":"All fields used to sort the audit logs","enum":["TIMESTAMP"]},"XiqAuditLogCategory":{"type":"string","enum":["ADMIN","SYSTEM","DEPLOYMENT","CONFIG","MONITOR","ALARM"]},"XiqAuditLogReport":{"type":"object","description":"ExtremeCloud IQ Audit Log report","properties":{"id":{"type":"integer","format":"int64","description":"The audit log reportId"}},"required":["id"]},"XiqLoginRequest":{"type":"object","properties":{"username":{"type":"string","description":"The login username"},"password":{"type":"string","description":"The login password"},"rate_limit":{"$ref":"#/components/schemas/XiqRateLimitPolicy","description":"The rate limit policy for the session"}},"required":["password","username"]},"XiqRateLimitPolicy":{"type":"object","properties":{"hour":{"type":"integer","format":"int64","description":"The sustained request quota per hour. Defines the baseline traffic capacity.","example":7500,"minimum":1},"second":{"type":"integer","format":"int64","description":"The maximum burst allowance per second. If omitted, no short-term throttling is applied.","example":100,"minimum":1}},"required":["hour"]},"XiqLoginResponse":{"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","format":"int32","description":"The lifetime in seconds of the access token"}},"required":["access_token","expires_in","token_type"]},"XiqError":{"type":"object","properties":{"error_code":{"type":"string","description":"The error code"},"error_id":{"type":"string","description":"The error ID for internal troubleshooting"},"error_message":{"type":"string","description":"The error detail message"},"error_message_code":{"type":"string","description":"The error message code"},"error_message_description":{"type":"string","description":"The error detail message description"},"error_params":{"type":"object","additionalProperties":{"type":"string"},"description":"Additional error parameters"}},"required":["error_code","error_id","error_message","error_message_description"]},"XiqCreateLocationRequest":{"type":"object","properties":{"parent_id":{"type":"integer","format":"int64","description":"The parent location ID"},"name":{"type":"string","description":"The location name"}},"required":["name","parent_id"]},"XiqCreateTypeRequest":{"type":"object","properties":{"name":{"type":"string","description":"The Wall type name","maxLength":254,"minLength":1},"attenuation":{"type":"number","format":"double","description":"The Wall type attenuation","maximum":999,"minimum":-999},"color":{"type":"string","description":"The Wall type color","minLength":1,"pattern":"^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{8})$"}},"required":["attenuation","color","name"]},"XiqCreateSiteRequest":{"type":"object","properties":{"parent_id":{"type":"integer","format":"int64","description":"The parent site group ID"},"name":{"type":"string","description":"The site name"},"address":{"$ref":"#/components/schemas/XiqAddress","description":"The address for the site"},"country_code":{"type":"integer","format":"int32","description":"The site country code. Get the list of country codes from /countries XAPI."},"latitude":{"type":"number","format":"double","description":"The latitude coordinate for the site"},"longitude":{"type":"number","format":"double","description":"The longitude coordinate for the site"}},"required":["country_code","name"]},"XiqEkahauFloorToFloorAssociation":{"type":"object","description":"Association between an Ekahau floor and XIQ floor","properties":{"floor_name":{"type":"string","description":"The name of the Ekahau floor to import into the parent building"},"parent_building_id":{"type":"integer","format":"int64","description":"The parent building ID"}},"required":["floor_name","parent_building_id"]},"XiqEkahauFloorToOutdoorSiteAssociation":{"type":"object","description":"Association between an Ekahau floor and XIQ outdoor site","properties":{"floor_name":{"type":"string","description":"The name of the Ekahau floor to import as an outdoor site into the parent site group"},"parent_site_group_id":{"type":"integer","format":"int64","description":"The parent site group ID"},"country_code":{"type":"integer","format":"int32","description":"The country code for the resulting outdoor site"}},"required":["country_code","parent_site_group_id"]},"XiqEkahauFloorImportResult":{"type":"object","description":"Result of importing an Ekahau floor","properties":{"name":{"type":"string","description":"Name of the imported floor"},"status":{"$ref":"#/components/schemas/XiqEkahauFloorImportStatus","description":"Resulting status of the floor import"},"issues":{"$ref":"#/components/schemas/XiqEkahauImportIssues","description":"Any issues related to the import of this floor, eg: why it failed, why an AP was discarded, etc."}},"required":["issues","name","status"]},"XiqEkahauFloorImportStatus":{"type":"string","enum":["SUCCESS","FAILURE"]},"XiqEkahauImportDetails":{"type":"object","description":"Information about an Ekahau import","properties":{"results":{"type":"array","description":"Details for this import","items":{"$ref":"#/components/schemas/XiqEkahauFloorImportResult"}}},"required":["results"]},"XiqEkahauImportIssue":{"type":"object","description":"An issue that was encountered while importing data from an Ekahau archive.","properties":{"error_code":{"type":"string","description":"Error code identifying this issue."},"error_message":{"type":"string","description":"Error message describing this issue."},"error_parameters":{"type":"object","additionalProperties":{"type":"string"},"description":"Parameter name -> Parameter value."}},"required":["error_code","error_message"]},"XiqEkahauImportIssues":{"type":"object","description":"Any issues related to the import of this floor, eg: why it failed, why an AP was discarded, etc.","properties":{"floor":{"$ref":"#/components/schemas/XiqEkahauImportIssue","description":"Issues related to the floor."},"background":{"$ref":"#/components/schemas/XiqEkahauImportIssue","description":"Issues related to the background."},"custom_ap_configurations":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/XiqEkahauImportIssue"}},"description":"If the floor was imported but issues occurred while importing custom AP configurations they will be listed here."},"discarded_aps":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/XiqEkahauImportIssue"},"description":"If the floor was imported but some of the APs were discarded they will be listed here."},"discarded_walls":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/XiqEkahauImportIssue"},"description":"If the floor was imported but some of the walls were discarded they will be listed here."}}},"XiqCreateZoneRequest":{"type":"object","properties":{"name":{"type":"string","description":"The Zone name","minLength":1},"color":{"type":"string","description":"The Zone color","minLength":1},"folder_id":{"type":"integer","format":"int64","description":"The Folder ID"},"visible":{"type":"boolean","default":true,"description":"The visibility of the zone"},"zone_vertical_align":{"$ref":"#/components/schemas/XiqZoneVerticalAlign","description":"The Zone vertical alignment"},"coordinates":{"type":"array","description":"The Zone coordinates","items":{"$ref":"#/components/schemas/XiqZonePoint"}}},"required":["color","coordinates","folder_id","name","zone_vertical_align"]},"XiqCreateFloorRequest":{"type":"object","properties":{"parent_id":{"type":"integer","format":"int64","description":"The parent building ID"},"name":{"type":"string","description":"The floor name"},"environment":{"$ref":"#/components/schemas/XiqRfEnvironmentType","description":"The floor RF environment"},"db_attenuation":{"type":"number","format":"double","description":"The floor attenuation in dBs"},"measurement_unit":{"$ref":"#/components/schemas/XiqMeasurementUnit","description":"The measurement unit in feet/meters"},"installation_height":{"type":"number","format":"double","description":"The installation height"},"map_size_width":{"type":"number","format":"double","description":"The floor map width"},"map_size_height":{"type":"number","format":"double","description":"The floor map height"},"map_name":{"type":"string","description":"The floor map name"}},"required":["db_attenuation","installation_height","map_size_height","map_size_width","measurement_unit","name","parent_id"]},"XiqCreateBuildingRequest":{"type":"object","properties":{"parent_id":{"type":"integer","format":"int64","description":"The parent location ID"},"name":{"type":"string","description":"The building name"},"address":{"$ref":"#/components/schemas/XiqAddress","description":"The street address"},"latitude":{"type":"number","format":"double","description":"The latitude coordinate for the building"},"longitude":{"type":"number","format":"double","description":"The longitude coordinate for the building"}},"required":["address","name","parent_id"]},"XiqCountryCode":{"type":"string","enum":["4","8","12","16","20","24","10","28","32","51","533","36","40","31","44","48","50","52","112","56","84","204","60","64","68","70","72","76","92","96","100","854","108","116","120","124","132","136","140","148","152","156","170","174","178","180","184","188","191","196","203","384","208","262","212","214","218","818","222","226","232","233","231","238","234","242","246","250","254","258","266","270","268","276","288","292","300","304","308","312","316","320","831","324","624","328","332","336","340","344","348","352","356","360","364","368","372","833","376","380","388","4014","832","400","398","404","296","410","414","417","418","428","422","426","430","434","438","440","442","446","450","454","458","462","466","470","474","478","480","484","583","498","492","496","499","504","508","104","516","524","528","540","554","558","562","566","408","578","512","586","585","275","591","598","600","604","608","616","620","630","634","807","638","642","643","646","659","662","670","882","674","682","686","688","690","694","702","703","705","90","706","710","724","144","729","740","748","752","756","760","158","762","834","764","626","768","776","780","788","792","795","796","784","800","804","826","840","858","850","860","548","862","704","876","887","894","716"]},"XiqInitializeLocationRequest":{"type":"object","properties":{"organization":{"type":"string","description":"The organization name."},"country":{"$ref":"#/components/schemas/XiqCountryCode","description":"The organization country code."}},"required":["country","organization"]},"XiqCreateLdapServerRequest":{"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","format":"int64","description":"The L3 address profile ID"},"protocol_type":{"$ref":"#/components/schemas/XiqLdapProtocolType","description":"LDAP server protocol type"},"enable_strip_realm_name":{"type":"boolean","description":"enable strip realm name or not"},"destination_port":{"type":"integer","format":"int32","description":"The LDAP server destination port (1 ~ 65535)","minimum":1},"verification_mode":{"$ref":"#/components/schemas/XiqLdapServerVerificationMode","description":"The LDAP server verification mode"},"ca_certificate_id":{"type":"integer","format":"int64","description":"The CA certificate ID, refer to XiqCertificate"},"client_certificate_id":{"type":"integer","format":"int64","description":"The client certificate ID, refer to XiqCertificate"},"client_key_id":{"type":"integer","format":"int64","description":"The client key ID, refer to XiqCertificate"},"client_key_password":{"type":"string","description":"The LDAP server client key password"}},"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"]},"XiqCreateL3AddressProfileRequest":{"type":"object","properties":{"name":{"type":"string","description":"The L3 Address profile name"},"description":{"type":"string","description":"The L3 Address profile description"},"value":{"type":"string","description":"The L3 Address profile value"},"address_type":{"$ref":"#/components/schemas/XiqL3AddressType","description":"Address type"},"enable_classification":{"type":"boolean","description":"The flag to enable classification entries on host name address profile"},"classified_entries":{"type":"array","description":"The host name address profile classified entries","items":{"$ref":"#/components/schemas/XiqAddressProfileClassifiedEntry"}},"ip_address_end":{"type":"string","description":"The classified entry IP address end, only available for \"IP_RANGE\" address type"},"netmask":{"type":"string","description":"The classified entry IP address end, only available for \"IP_SUBNET\" address type"},"wildcard_mask":{"type":"string","description":"The wildcard address profile mask value, only available for \"WILDCARD\" address type"}},"required":["address_type","name","value"]},"XiqCreateOrganizationRequest":{"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"}},"required":["name"]},"XiqOrganization":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"The unique identifier"},"create_time":{"type":"string","format":"date-time","description":"The create time in UTC (ISO 8601 format)"},"update_time":{"type":"string","format":"date-time","description":"The last update time in UTC (ISO 8601 format)"},"org_id":{"type":"integer","format":"int64","description":"The organization identifier, valid when enabling HIQ feature"},"name":{"type":"string","description":"The organization name"},"type":{"$ref":"#/components/schemas/XiqOrganizationType","description":"The organization type"},"color":{"type":"string","description":"The tagged color for the organization"}},"required":["create_time","id","name","type","update_time"]},"XiqOrganizationType":{"type":"string","enum":["REGULAR","PRIVATE"]},"XiqAfcFloorDetailsCreateRequest":{"type":"object","properties":{"floor_id":{"type":"integer","format":"int64"},"floor_height":{"type":"number","format":"float"},"floor_height_accuracy":{"type":"integer","format":"int64"},"ap_height":{"type":"number","format":"float"},"ap_height_accuracy":{"type":"integer","format":"int64"}}},"XiqCreateEndUserRequest":{"type":"object","properties":{"user_group_id":{"type":"integer","format":"int64","description":"The user group ID"},"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"},"vlan_override":{"type":"integer","format":"int32","description":"VLAN ID override assigned to the user (range 1-4094, Optional)","maximum":4094,"minimum":1}},"required":["user_group_id","user_name"]},"XiqRegenerateEndUserPasswordResponse":{"type":"object","description":"The newly generated password for the end user","properties":{"password":{"type":"string","description":"The new password of the end user"}},"required":["password"]},"XiqUnlockClientsRequest":{"type":"object","properties":{"client_macs":{"type":"array","description":"List of client MAC addresses to be unlocked","items":{"type":"string"}}}},"XiqThreadStopCommissionerRequest":{"type":"object","description":"The request to stop the thread commissioner on an iot interface of a device.","properties":{"device_id":{"type":"integer","format":"int64","description":"The device id"},"interface_name":{"type":"string","description":"The IoT interface on which to stop the Commissioner."}},"required":["device_id"]},"XiqThreadStartCommissionerRequest":{"type":"object","description":"The request to start the thread commissioner on an iot interface of a device.","properties":{"device_id":{"type":"integer","format":"int64","description":"The device id"},"comm_timeout":{"type":"integer","format":"int32","description":"After this timeout the Commissioner will shutdown. The default is 120 sec. but the max is approximately 23 days.","maximum":2000000,"minimum":1},"interface_name":{"type":"string","description":"The IoT interface on which to start the Commissioner."}},"required":["device_id"]},"XiqUpdateDeviceLevelSsidStatus":{"type":"object","description":"The request for disable/enable device level ssid.","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","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"},"minItems":1},"enabled":{"type":"boolean","description":"To disable or enable the given device level SSIDs on the wifi interfaces."}},"required":["enabled","if_names","ssid_ids"]},"XiqDeviceLevelSsid":{"type":"object","description":"The ssid/passphrase for device level ssid to override","properties":{"ssid_id":{"type":"integer","format":"int64","description":"The SSID ID to override, cannot be null."},"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."}},"required":["ssid_id"]},"XiqDeviceMonitorRefreshResponse":{"type":"object","description":"The request for on demand refresh information.","properties":{"task_key":{"type":"string","description":"The device monitor refresh task key"}},"required":["task_key"]},"XiqBounceDevicePortRequest":{"type":"object","description":"The request for bouncing port of a single device. Includes EXOS, VOSS devices and SR switches","properties":{"device_id":{"type":"integer","format":"int64","description":"The device id"},"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)"}}},"XiqBounceDevicePortData":{"type":"object","description":"The data required for bounce port response","properties":{"status":{"type":"integer","format":"int32","description":"The status value"},"request_id":{"type":"integer","format":"int64","description":"The requestId of the response"},"results":{"type":"array","description":"The list of results","items":{"$ref":"#/components/schemas/XiqBounceDevicePortOperationResult"}}}},"XiqBounceDevicePortOperationResult":{"type":"object","description":"The list required for bounce port response","properties":{"status":{"type":"integer","format":"int32","description":"The status value"},"message":{"type":"string","description":"The message"}}},"XiqBounceDevicePortResponse":{"type":"object","description":"The response for bounce port","properties":{"data":{"$ref":"#/components/schemas/XiqBounceDevicePortData","description":"The data helper class for response"}}},"XiqChangeStatusToManageResponse":{"type":"object","description":"The change status to manage","properties":{"device_id":{"type":"integer","format":"int64","description":"The device ID"},"device_status":{"type":"string","description":"The device status"},"host_name":{"type":"string","description":"The device host name"},"admin_state":{"type":"string","description":"The device admin state"},"message":{"type":"string","description":"The message"}}},"XiqCliOutput":{"type":"object","description":"The CLI output","properties":{"cli":{"type":"string","description":"The CLI sent to the device"},"response_code":{"$ref":"#/components/schemas/XiqCliResponseCode","description":"The CLI response code"},"output":{"type":"string","description":"The CLI output"}},"required":["cli","response_code"]},"XiqCliResponseCode":{"type":"string","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","description":"The response for sending CLIs to devices","properties":{"device_cli_outputs":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/XiqCliOutput"}},"description":"device ID -> CLI outputs"}}},"XiqRmDeviceActionValidationRequest":{"type":"object","description":"The payload to devices","properties":{"device_ids":{"type":"array","description":"The device ID","items":{"type":"integer","format":"int64"}}}},"XiqRmDeviceAction":{"type":"string","enum":["ASSIGN_LOCATION","GET_TECH_DATA","REBOOT","RESET_TO_DEFAULT","CLEAR_AUDIT_MISMATCH","CHANGE_MGT_STATUS","ASSIGN_COUNTRY_CODE","CHANGE_TO_OS_WING","CHANGE_DEVICE_MODE","START_STOP_THREAD_COMMISSIONER","LOCATE_DEVICE","SSH_ACCESS","PROXY_WEB_FOR_SWITCHING","VLAN_PROBE","SPECTRUM_INTELLIGENCE","RADIUS_TEST","FIRMWARE_UPGRADE","ASSIGN_NETWORK_POLICY","ADD_TO_CLOUD_CONFIG_GROUP","REVERT_DEVICE_TO_TEMPLATE","CHANGE_OS","UPDATE_DEVICE","CONFIGURE_DEVICE","SHOW_AFC_SPECTRUM","UPDATE_AFC_SPECTRUM","DERIVE_GPS_LOCATION","SEND_AP_RANGE_INFO","DELETE_DEVICE","PACKET_CAPTURE","AFC_GEOLOCATION_REPORT","OPEN_SITE_ENGINE","ENHANCED_DISCOVERY","CONFIGURE","DIAGNOSTICS_SHOW_VERSION","DIAGNOSTICS_SHOW_RUNNING_CONFIG","DIAGNOSTICS_SHOW_STARTUP_CONFIG","DIAGNOSTICS_SHOW_AMRP_TUNNEL","DIAGNOSTICS_SHOW_AFC_DATA_EXCHANGE","DIAGNOSTICS_SHOW_GRE_TUNNEL","DIAGNOSTICS_SHOW_IKE_EVENT","DIAGNOSTICS_SHOW_IKE_SA","DIAGNOSTICS_SHOW_IP_ROUTES","DIAGNOSTICS_SHOW_LOG","DIAGNOSTICS_SHOW_MAC_ROUTES","DIAGNOSTICS_SHOW_DNXP_NEIGHBORS","DIAGNOSTICS_SHOW_ROAMING_CACHE","DIAGNOSTICS_SHOW_DNXP_CACHE","DIAGNOSTICS_SHOW_ARP_CACHE","DIAGNOSTICS_SHOW_CPU","DIAGNOSTICS_SHOW_MEMORY","DIAGNOSTICS_SHOW_IPSEC_SA","DIAGNOSTICS_SHOW_IPSEC_TUNNEL","DIAGNOSTICS_PING","DIAGNOSTICS_SHOW_TUNNEL_CLIENTS","ACTIVATE_COPILOT_LICENSE","REVOKE_COPILOT_LICENSE","CONFIGURE_IQC","CONFIGURE_FABRIC","APPLIANCE_UI","INITIATE_DIAGNOSTICS"]},"XiqRmDeviceActionValidationResponse":{"type":"object","properties":{"supported_actions":{"type":"array","description":"List of supported actions for the device","items":{"$ref":"#/components/schemas/XiqRmDeviceAction"}}}},"XiqThreadStopCommissionerByBuildingsRequest":{"type":"object","description":"The request to stop the thread commissioner on devices under buildings.","properties":{"building_ids":{"type":"array","description":"The building id list","items":{"type":"integer","format":"int64"},"minItems":1},"ext_pan_id":{"type":"string","description":"The extPanID for IoT profile to filter out devices to stop the Commissioner.","maxLength":16,"minLength":16,"pattern":"^[0-9a-fA-F]+$"},"owner_id":{"type":"integer","format":"int64","description":"The Owner ID"}},"required":["building_ids","owner_id"]},"XiqFailureCommissionerDevice":{"type":"object","description":"A device where the commissioner operation failed.","properties":{"device_id":{"type":"integer","format":"int64","description":"The device ID"},"serial_number":{"type":"string","description":"The device serial number"},"error":{"type":"string","description":"The error message or code"}}},"XiqSuccessCommissionerDevice":{"type":"object","description":"A device where the commissioner operation completed successfully.","properties":{"device_id":{"type":"integer","format":"int64","description":"The device ID"},"serial_number":{"type":"string","description":"The device serial number"}}},"XiqThreadStopCommissionerByBuildingsResponse":{"type":"object","description":"The response for stopping the thread commissioner on devices under buildings.","properties":{"success_devices":{"type":"array","description":"The devices where the commissioner stopped successfully.","items":{"$ref":"#/components/schemas/XiqSuccessCommissionerDevice"}},"failure_devices":{"type":"array","description":"The devices where the commissioner failed to stop.","items":{"$ref":"#/components/schemas/XiqFailureCommissionerDevice"}}}},"XiqThreadStartCommissionerByBuildingsRequest":{"type":"object","description":"The request to start the thread commissioner on devices under buildings.","properties":{"building_ids":{"type":"array","description":"The building id list","items":{"type":"integer","format":"int64"},"minItems":1},"comm_timeout":{"type":"integer","format":"int32","description":"After this timeout the Commissioner will shutdown. The default is 120 sec. but the max is approximately 23 days.","maximum":2000000,"minimum":1},"ext_pan_id":{"type":"string","description":"The extPanID for IoT profile to filter out devices to start the Commissioner.","maxLength":16,"minLength":16,"pattern":"^[0-9a-fA-F]+$"},"owner_id":{"type":"integer","format":"int64","description":"The Owner ID"}},"required":["building_ids","owner_id"]},"XiqThreadStartCommissionerByBuildingsResponse":{"type":"object","description":"The response for starting the thread commissioner on devices under buildings.","properties":{"success_devices":{"type":"array","description":"The devices where the commissioner started successfully.","items":{"$ref":"#/components/schemas/XiqSuccessCommissionerDevice"}},"failure_devices":{"type":"array","description":"The devices where the commissioner failed to start.","items":{"$ref":"#/components/schemas/XiqFailureCommissionerDevice"}}}},"XiqDeviceAdminState":{"type":"string","enum":["NEW","BOOTSTRAP","STAGED","MANAGED","UNMANAGED"]},"XiqRmDeviceCategoryRequest":{"type":"string","enum":["WIRED","WIRELESS","TPME","APPLIANCES"]},"XiqRmDeviceSortField":{"type":"string","description":"RM Device List Sort fields","enum":["HOSTNAME","MAC","SN","CONNECTION_STATUS","OS","PRODUCT_TYPE","UPTIME"]},"XiqDeviceType":{"type":"string","enum":["REAL","DIGITAL_TWIN","SIMULATED"]},"XiqConstantValue":{"type":"string","enum":["VAUTO","V10","V100","V1000","V10000","V100000","V44","V155","V622","V2500","V5000","V20000","V25000","V40000","V50000"]},"XiqDataUnit":{"type":"string","enum":["KBPS","MBPS","GBPS"]},"XiqEthUplinkSpeed":{"type":"string","enum":["ETH0","ETH1"]},"XiqRmDeviceEthUplinkSpeedFilter":{"type":"object","description":"Eth Uplink Speed Filter","properties":{"eth_uplink_speed":{"$ref":"#/components/schemas/XiqEthUplinkSpeed","description":"The Eth Uplink Speed"},"filter_type":{"$ref":"#/components/schemas/XiqRmDeviceNumberEnumFilter","description":"The filter type"},"constant_value":{"$ref":"#/components/schemas/XiqConstantValue","description":"The constant value"},"data_unit":{"$ref":"#/components/schemas/XiqDataUnit","description":"The data unit of eth speed"}}},"XiqRmDeviceIconsFilter":{"type":"object","description":"Filter criteria for device icons","properties":{"anchor_ap":{"type":"boolean","description":"Filter by Anchor AP status"},"locally_managed":{"type":"boolean","description":"Filter by Locally Managed status"},"device_update_unsuccessful":{"type":"boolean","description":"Filter by Device Update Unsuccessful status"},"provisioned_device":{"type":"boolean","description":"Filter by Provisioned Device status"},"configuration_roll_back":{"type":"boolean","description":"Filter by Configuration Rollback status"},"undetermined":{"type":"boolean","description":"Filter by Undetermined status"},"configured_at_device_level":{"type":"boolean","description":"Filter by Configured at Device Level status"},"switch_stack":{"type":"boolean","description":"Filter by Switch Stack status"},"switch_stack_warning":{"type":"boolean","description":"Filter by Switch Stack Warning status"},"radsec_proxy_server":{"type":"boolean","description":"Filter by RadSec Proxy Server status"},"sensor_mode_interface":{"type":"boolean","description":"Filter by Sensor Mode Interface status"},"spectrum_intelligence":{"type":"boolean","description":"Filter by Spectrum Intelligence status"},"fabric_attach":{"type":"boolean","description":"Filter by Fabric Attach status"},"fabric_attach_issue":{"type":"boolean","description":"Filter by Fabric Attach Issue status"},"digital_twin":{"type":"boolean","description":"Filter by Digital Twin status"},"managed_by_extreme_iot":{"type":"boolean","description":"Filter by Managed by Extreme IoT status"},"configuration_pending":{"type":"boolean","description":"Filter by Configuration Pending status"}}},"XiqRmDeviceListRequest":{"type":"object","description":"Request body for RM Device List","properties":{"site_ids":{"type":"array","description":"List of site ids to filter","items":{"type":"integer","format":"int64"}},"sns":{"type":"array","description":"List of device serial numbers to filter","items":{"type":"string"}},"mac_addresses":{"type":"array","description":"List of device MAC addresses to filter","example":["001122334455","AABBCCDDEEFF"],"items":{"type":"string"}},"hostnames":{"type":"array","description":"List of device host names to filter","items":{"type":"string"}},"default_gateway_ips":{"type":"array","description":"List of device default gateway IPs to filter","example":["192.168.1.1","10.0.0.1"],"items":{"type":"string"}},"product_types":{"type":"array","description":"List of device product types to filter","items":{"type":"string"}},"firmware_versions":{"type":"array","description":"List of device firmware versions to filter","items":{"type":"string"}},"country_codes":{"type":"array","description":"List of country codes to filter","items":{"type":"integer","format":"int32"}},"managed_by":{"type":"array","description":"List of entities managing the device to filter","items":{"type":"string"}},"display_managed_by":{"type":"array","description":"List of display values for 'Managed By' shown only in EP1","items":{"type":"string"}},"network_policies":{"type":"array","description":"List of network policies to filter","items":{"type":"string"}},"eth_uplink_speed_filters":{"type":"array","description":"Filter by Eth uplink speed filter","items":{"$ref":"#/components/schemas/XiqRmDeviceEthUplinkSpeedFilter"}},"device_icons_filter":{"$ref":"#/components/schemas/XiqRmDeviceIconsFilter","description":"Filter by device icons"}}},"XiqRmDeviceNumberEnumFilter":{"type":"string","enum":["GT","GTE","LT","LTE","EQ","NEQ","BTW"]},"XiqCopilotLicenseStatus":{"type":"string","enum":["ACTIVE","EXPIRED","UNLICENSED","NONE","NA","TRIAL"]},"PagedXiqRmDevice":{"type":"object","properties":{"page":{"type":"integer","format":"int32","description":"The current page number"},"count":{"type":"integer","format":"int32","description":"The element count of the current page"},"total_pages":{"type":"integer","format":"int32","description":"The total page number based on request page size"},"total_count":{"type":"integer","format":"int64","description":"The total element count"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqRmDevice"}}},"required":["count","page","total_count","total_pages"]},"XiqDeviceLicenseTier":{"type":"string","enum":["NOT_APPLICABLE","TIER_A","TIER_B","TIER_C","TIER_D","UNKNOWN","NONE","TIER_3RD"]},"XiqRmDevice":{"type":"object","description":"Generic ExtremeCloud IQ RM Device List","properties":{"id":{"type":"integer","format":"int64","description":"The unique identifier"},"create_time":{"type":"string","format":"date-time","description":"The create time in UTC (ISO 8601 format)"},"update_time":{"type":"string","format":"date-time","description":"The last update time in UTC (ISO 8601 format)"},"org_id":{"type":"integer","format":"int64","description":"The organization identifier, valid when enabling HIQ feature"},"connected":{"type":"boolean","description":"The device connection status"},"hostname":{"type":"string","description":"The device hostname"},"healthy_clients":{"type":"integer","format":"int32","description":"The associated active client count for the device"},"unhealthy_clients":{"type":"integer","format":"int32","description":"The associated inactive client count for the device"},"system_up_time":{"type":"integer","format":"int64","description":"The device uptime in milliseconds","example":1770280794349},"updated_on":{"type":"integer","format":"int64","description":"The last device updated time"},"mac_address":{"type":"string","description":"The device MAC address in format XXXXXXXXXXXX","example":"001122334455"},"serial_number":{"type":"string","description":"The device serial number, valid for all non-HAC devices"},"device_ip":{"type":"string","description":"The device IPv4 address","example":"10.16.172.199"},"default_gateway":{"type":"string","description":"The device default gateway","example":"10.16.172.199"},"software_version":{"type":"string","description":"The device OS software version"},"product_type":{"type":"string","description":"The product type, such as AP_230, BR_100, NX9600, etc."},"ipv6_address":{"type":"string","description":"The device IPv6 address","example":"0:0:0:0:0:0:0:0"},"device_admin_state":{"$ref":"#/components/schemas/XiqDeviceAdminState","description":"The device admin state"},"sim_type":{"$ref":"#/components/schemas/XiqDeviceType","description":"The device type - REAL or SIMULATED"},"country_code":{"type":"integer","format":"int32","description":"The assigned country code on the device"},"managed_by":{"type":"string","description":"The managed application for the device"},"display_managed_by":{"type":"string","description":"Display label used in EP1. This field represents the controller hostname for controller-managed devices and the Managed By value for other devices."},"channel_wifi0":{"type":"string","description":"Channel for wifi0"},"power_wifi0":{"type":"string","description":"Power for wifi0"},"radio_wifi0":{"type":"string","description":"Radio for wifi0"},"channel_wifi1":{"type":"string","description":"Channel for wifi1"},"power_wifi1":{"type":"string","description":"Power for wifi1"},"radio_wifi1":{"type":"string","description":"Radio for wifi1"},"channel_wifi2":{"type":"string","description":"Channel for wifi2"},"power_wifi2":{"type":"string","description":"Power for wifi2"},"radio_wifi2":{"type":"string","description":"Radio for wifi2"},"config_mismatch":{"type":"boolean","description":"Config audit status(MATCHED(false) or UNMATCHED(true))"},"locations":{"$ref":"#/components/schemas/XiqRmDeviceLocationDetails","description":"The Location details for the device"},"device_category":{"$ref":"#/components/schemas/XiqRmDeviceCategory","description":"The RM device category type"},"has_management_ip_issue":{"type":"boolean","description":"Flag to indicate device with management IP issue"},"has_default_gateway_issue":{"type":"boolean","description":"Flag to indicate device with default gateway issue"},"has_firmware_version_issue":{"type":"boolean","description":"Flag to indicate device with firmware version issue"},"stack_size":{"type":"string","format":"byte","description":"The number of devices in the stack (0 for standalone devices)"},"stack_id":{"type":"integer","format":"int64","description":"The stack id (only for stack members)"},"xiq_rm_device_icons":{"$ref":"#/components/schemas/XiqRmDeviceIcons","description":" The display icons of the device"},"device_license_tier":{"$ref":"#/components/schemas/XiqDeviceLicenseTier","description":"The license tier of the device"},"device_license_type":{"type":"string","description":"The license type of the device","enum":["LEGACY","NAVIGATOR","PILOT","COPILOT","NONE","NA","TRIAL","NOT_REQUIRED","GRACEPERIOD","UNLICENSED","STANDARD","ADVANCED","NOT_LICENSED"]},"network_policy_id":{"type":"integer","format":"int64","description":"The network policy ID associated with the device"},"network_policy_name":{"type":"string","description":"The network policy name associated with the device"},"os":{"type":"string","description":"The OS Name"},"device_template_name":{"type":"string","description":"The device template name"},"cloud_config_groups":{"type":"array","description":"The device cloud config groups","items":{"type":"string"}},"eth0_uplink_speed":{"type":"string","description":"Value for Eth0 uplink speed. Represents the negotiated or configured speed of the Eth0 interface.","enum":["SPEED_AUTO","SPEED_10M","SPEED_100M","SPEED_1000M","SPEED_10000M","SPEED_100000M","SPEED_44M","SPEED_155M","SPEED_622M"],"example":"SPEED_1000M"},"eth1_uplink_speed":{"type":"string","description":"Value for Eth1 uplink speed. Represents the negotiated or configured speed of the Eth1 interface.","enum":["SPEED_AUTO","SPEED_10M","SPEED_100M","SPEED_1000M","SPEED_10000M","SPEED_100000M","SPEED_44M","SPEED_155M","SPEED_622M"],"example":"SPEED_1000M"},"controller_id":{"type":"integer","format":"int64","description":"The controller ID"},"primary_controller_address":{"type":"string","description":"The primary controller Address"},"secondary_controller_address":{"type":"string","description":"The secondary controller Address"},"copilot_license_status":{"$ref":"#/components/schemas/XiqCopilotLicenseStatus","description":"The copilot license status of the device"},"device_family":{"type":"string","description":"Device family or category (e.g.\"AP\", \"UCP\", \"SWITCH\", \"XIQ_SE\", \"TPME\", \"THIRDPARTY\", \"TUNNELCONCENTRATOR\", \"CONTROLLER\")"}},"required":["create_time","id","update_time"]},"XiqRmDeviceCategory":{"type":"string","enum":["WIRED","WIRELESS","TPME_SNMP_DISCOVERED","APPLIANCES","UNKNOWN"]},"XiqRmDeviceIcons":{"type":"object","description":"The icons for device","properties":{"afc_status":{"type":"string","description":"Afc status"},"provisioned_device":{"type":"boolean","description":"Provisioned device"},"config_rolled_back":{"type":"boolean","description":"Configuration Rollback"},"device_type":{"$ref":"#/components/schemas/XiqDeviceType","description":"Device type"},"undetermined":{"type":"boolean","description":"Undetermined device type"},"configured_at_device_level":{"type":"boolean","description":"Configured at Device Level"},"device_update_unsuccessful":{"type":"boolean","description":"Device Update Unsuccessful"},"managed_by_extreme_iot":{"type":"boolean","description":"Managed by ExtremeIoT"},"thread_commissioner_running":{"type":"boolean","description":"Thread Commissioner Running"},"monitoring_unassociated_clients":{"type":"boolean","description":"Monitoring Unassociated Clients"},"switch_stack":{"type":"boolean","description":"Switch stack"},"switch_stack_warning":{"type":"boolean","description":"Switch stack warning"},"radsec_proxy_server":{"type":"boolean","description":"RadSec Proxy Server"},"rogue_ap_mitigation_on":{"type":"boolean","description":"Rogue AP Mitigation On"},"sensor_mode":{"type":"boolean","description":"Sensor Mode"},"swap":{"type":"boolean","description":"Swap"},"spectrum_intelligence":{"type":"boolean","description":"Spectrum Intelligence"},"vpn_server":{"$ref":"#/components/schemas/XiqRmVpnStatus","description":"VPN Server"},"vpn_client":{"$ref":"#/components/schemas/XiqRmVpnStatus","description":"VPN Client"},"locally_managed":{"type":"boolean","description":"Locally managed"},"extreme_cluster_appliance":{"type":"boolean","description":"Extreme Cluster Appliance"},"fabric_attach":{"type":"boolean","description":"Fabric Attach"},"fabric_attach_error":{"type":"boolean","description":"Fabric Attach Error"},"config_pending":{"type":"boolean","description":"Config pending"},"anchor":{"type":"boolean","description":"Anchor"},"no_connection":{"type":"boolean","description":"No Connection"}}},"XiqRmDeviceLocationDetails":{"type":"object","description":"The detailed location information","properties":{"site":{"type":"string","description":"The site where the device is located"},"site_id":{"type":"integer","format":"int64","description":"Site ID"},"building":{"type":"string","description":"The building where the device is located"},"building_id":{"type":"integer","format":"int64","description":"Building ID"},"floor":{"type":"string","description":"The floor where the device is located"},"floor_id":{"type":"integer","format":"int64","description":"Floor ID"}}},"XiqRmVpnStatus":{"type":"string","enum":["UP","DOWN","UP_DOWN"]},"XiqDeviceCategory":{"type":"string","enum":["WIRED","WIRELESS"]},"XiqRmDeviceListExport":{"type":"object","description":"Report ID for downloading Export CSV file","properties":{"id":{"type":"string","description":"The reportId"}},"required":["id"]},"XiqRmSiteIdsRequest":{"type":"object","description":"Request body for site id filter","properties":{"site_ids":{"type":"array","description":"List of site ids to filter","items":{"type":"integer","format":"int64"}}}},"XiqCountryCodeName":{"type":"object","properties":{"country_code":{"type":"integer","format":"int32"},"country_name":{"type":"string"}}},"XiqRmDeviceMetadataResponse":{"type":"object","description":"RM Metadata Response Class","properties":{"default_gateway":{"type":"array","description":"The device default gateway","items":{"type":"string"}},"software_version":{"type":"array","description":"The device OS software version","items":{"type":"string"}},"product_type":{"type":"object","additionalProperties":{"type":"string"},"description":"The product type map, eg. Key - AP_350, Value(displayed on UI) - AP350"},"device_admin_state":{"type":"array","description":"The device admin state","items":{"$ref":"#/components/schemas/XiqDeviceAdminState"}},"country_code":{"type":"array","description":"The assigned country code on the device","items":{"type":"integer","format":"int32"}},"managed_by":{"type":"array","description":"The managed application for the device","items":{"type":"string"}},"display_managed_by":{"type":"object","additionalProperties":{"type":"string"},"description":"The display managed by map"},"sim_type":{"type":"array","description":"The device type - REAL or SIMULATED","items":{"$ref":"#/components/schemas/XiqDeviceType"}},"country_code_name":{"type":"array","description":"The assigned country name on the device","items":{"$ref":"#/components/schemas/XiqCountryCodeName"}},"network_policy":{"type":"array","description":"The network policy applied to the device","items":{"type":"string"}},"uplink_speeds":{"type":"array","description":"The Eth0 and Eth1 port speed","items":{"type":"string"}},"serial_number":{"type":"array","description":"The serial number of the device","items":{"type":"string"}},"copilot_license_statuses":{"type":"array","description":"The Copilot license status of the device","items":{"$ref":"#/components/schemas/XiqCopilotLicenseStatus"}},"anchor_ap":{"type":"array","description":"Distinct values present for the Anchor AP icon filter in the matched device set.","items":{"type":"boolean"}},"locally_managed":{"type":"array","description":"Distinct values present for the Locally Managed icon filter in the matched device set.","items":{"type":"boolean"}},"afc_status":{"type":"array","description":"Distinct AFC status values present in the matched device set (e.g., AVAILABLE, PENDING).","items":{"type":"string"}},"device_update_unsuccessful":{"type":"array","description":"Distinct values present for the Device Update Unsuccessful icon filter in the matched device set.","items":{"type":"boolean"}},"provisioned_device":{"type":"array","description":"Distinct values present for the Provisioned Device icon filter in the matched device set.","items":{"type":"boolean"}},"configuration_roll_back":{"type":"array","description":"Distinct values present for the Configuration Roll Back icon filter in the matched device set.","items":{"type":"boolean"}},"undetermined":{"type":"array","description":"Distinct values present for the Undetermined icon filter in the matched device set.","items":{"type":"boolean"}},"configured_at_device_level":{"type":"array","description":"Distinct values present for the Configured At Device Level icon filter in the matched device set.","items":{"type":"boolean"}},"monitoring_unassociated_clients":{"type":"array","description":"Distinct values present for the Monitoring Unassociated Clients icon filter in the matched device set.","items":{"type":"boolean"}},"switch_stack":{"type":"array","description":"Distinct values present for the Switch Stack icon filter in the matched device set.","items":{"type":"boolean"}},"switch_stack_warning":{"type":"array","description":"Distinct values present for the Switch Stack Warning icon filter in the matched device set.","items":{"type":"boolean"}},"radsec_proxy_server":{"type":"array","description":"Distinct values present for the Radsec Proxy Server icon filter in the matched device set.","items":{"type":"boolean"}},"sensor_mode_interface":{"type":"array","description":"Distinct values present for the Sensor Mode Interface icon filter in the matched device set.","items":{"type":"boolean"}},"spectrum_intelligence":{"type":"array","description":"Distinct values present for the Spectrum Intelligence icon filter in the matched device set.","items":{"type":"boolean"}},"vpn_server":{"type":"array","description":"Distinct VPN Server status values present in the matched device set (e.g., UP, DOWN, UP_DOWN).","items":{"type":"string"}},"vpn_client":{"type":"array","description":"Distinct VPN Client status values present in the matched device set (e.g., UP, DOWN, UP_DOWN).","items":{"type":"string"}},"fabric_attach":{"type":"array","description":"Distinct values present for the Fabric Attach icon filter in the matched device set.","items":{"type":"boolean"}},"fabric_attach_issue":{"type":"array","description":"Distinct values present for the Fabric Attach Issue icon filter in the matched device set.","items":{"type":"boolean"}},"digital_twin":{"type":"array","description":"Distinct values present for the Digital Twin icon filter in the matched device set.","items":{"type":"boolean"}},"managed_by_extreme_iot":{"type":"array","description":"Distinct values present for the Managed By Extreme IoT icon filter in the matched device set.","items":{"type":"boolean"}},"swap_for_real_device":{"type":"array","description":"Distinct values present for the Swap for Real Device icon filter in the matched device set.","items":{"type":"boolean"}},"configuration_pending":{"type":"array","description":"Distinct values present for the Configuration Pending icon filter in the matched device set.","items":{"type":"boolean"}},"connected":{"type":"array","description":"Distinct values present for the connected icon filter in the matched device set.","items":{"type":"boolean"}},"config_mismatch":{"type":"array","description":"Distinct values present for the Configuration mismatch icon filter in the matched device set.","items":{"type":"boolean"}}}},"XiqRmDeviceConnectionStatus":{"type":"object","properties":{"total_devices":{"type":"integer","format":"int64","description":"The total devices."},"connected_devices":{"type":"integer","format":"int64","description":"The connected devices."},"disconnected_devices":{"type":"integer","format":"int64","description":"The disconnected devices."},"total_managed_devices":{"type":"integer","format":"int64","description":"The total managed devices."},"connected_managed_devices":{"type":"integer","format":"int64","description":"The connected managed devices."},"disconnected_managed_devices":{"type":"integer","format":"int64","description":"The disconnected managed devices."},"total_unmanaged_devices":{"type":"integer","format":"int64","description":"The total unmanaged devices."},"connected_unmanaged_devices":{"type":"integer","format":"int64","description":"The connected unmanaged devices."},"disconnected_unmanaged_devices":{"type":"integer","format":"int64","description":"The disconnected unmanaged devices."},"total_simulated_devices":{"type":"integer","format":"int64","description":"The total simulated devices."}}},"XiqChangeDevicesOsModeRequest":{"type":"object","description":"The request for change the device(s) OS mode.","properties":{"device_ids":{"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","format":"int64"},"maxItems":2147483647,"minItems":1},"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"}},"required":["device_ids","target_os"]},"XiqDeviceFilter":{"type":"object","description":"The filter to get matched devices","properties":{"ids":{"type":"array","description":"The device ID list","items":{"type":"integer","format":"int64"}}}},"XiqAssignDevicesNetworkPolicyRequest":{"type":"object","description":"Device network policy assignment for multiple devices","properties":{"devices":{"$ref":"#/components/schemas/XiqDeviceFilter"},"network_policy_id":{"type":"integer","format":"int64","description":"The assigned network policy"}},"required":["devices","network_policy_id"]},"XiqDeviceLocation":{"type":"object","description":"Device location info","properties":{"location_id":{"type":"integer","format":"int64","description":"The assigned location ID, it must NOT be BUILDING type"},"create_time":{"type":"string","format":"date-time","description":"The timestamp when the device assigned to the location"},"update_time":{"type":"string","format":"date-time","description":"The timestamp when the location info was last updated"},"org_id":{"type":"integer","format":"int64","description":"The organization identifier, valid when enabling HIQ feature"},"parent_id":{"type":"integer","format":"int64","description":"The parent location ID"},"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","format":"double","description":"The horizontal value in the floor map"},"y":{"type":"number","format":"double","description":"The vertical value in the floor map"},"latitude":{"type":"number","format":"double","description":"The latitude in the geography"},"longitude":{"type":"number","format":"double","description":"The longitude in the geography"}},"required":["create_time","location_name","location_type","location_unique_name","update_time"]},"XiqAssignDevicesLocationRequest":{"type":"object","description":"Device location assignment for multiple devices","properties":{"devices":{"$ref":"#/components/schemas/XiqDeviceFilter"},"device_location":{"$ref":"#/components/schemas/XiqDeviceLocationAssignment","description":"The assigned device location"}},"required":["device_location","devices"]},"XiqAssignDevicesCountryCodeRequest":{"type":"object","description":"Device country-code assignment for multiple devices","properties":{"devices":{"$ref":"#/components/schemas/XiqDeviceFilter","description":"The devices to assign the country code."},"country_code":{"$ref":"#/components/schemas/XiqCountryCode","description":"The country code."}},"required":["country_code","devices"]},"XiqAssignDevicesClientMonitorRequest":{"type":"object","description":"Device location assignment for multiple devices","properties":{"devices":{"$ref":"#/components/schemas/XiqDeviceFilter"},"client_monitor":{"$ref":"#/components/schemas/XiqDeviceClientMonitor","description":"The assigned device location"}},"required":["client_monitor","devices"]},"XiqRmDeviceActionSupportMetadataRequest":{"type":"object","properties":{"product_types":{"type":"array","description":"The device product type","example":["AP_302W","AP_4020","VSP_4900_24P"],"items":{"type":"string"}}}},"XiqRmDeviceActionSupportMetadata":{"type":"object","description":"The metadata for device action support","properties":{"device_action":{"$ref":"#/components/schemas/XiqRmDeviceAction","description":"The RM device action"},"supported_wireless_product_types":{"type":"array","description":"The wireless device models supported","example":["AP_302W","AP_305C","AP_4020","AP_4060"],"items":{"type":"string"}},"supported_wired_product_types":{"type":"array","description":"The wired device models supported","example":["VSP_4900_24P","X440_G2_24t_10_G4","SwitchEngine_5520_24T","FabricEngine_5520_24T"],"items":{"type":"string"}}}},"XiqRmDeviceActionSupportMetadataResponse":{"type":"object","description":"The response for device action support metadata","properties":{"action_supported_metadata":{"type":"array","description":"The list of action support metadata","items":{"$ref":"#/components/schemas/XiqRmDeviceActionSupportMetadata"}}}},"XiqSshActiveSessionsRequest":{"type":"object","description":"The request to filter active SSH sessions.","properties":{"device_ids":{"type":"array","description":"The device ids","items":{"type":"integer","format":"int64"}}}},"XiqSshActiveSessionsResponse":{"type":"object","description":"Response model for active SSH sessions on a device.","properties":{"device_id":{"type":"integer","format":"int64","description":"The device ID."},"host_name":{"type":"string","description":"The device name."},"serial_number":{"type":"string","description":"The device serial number."},"site_name":{"type":"string","description":"The site name of device."},"start_time":{"type":"integer","format":"int64","description":"The start time of ssh session."},"time_out":{"type":"integer","format":"int64","description":"The time out for ssh session."},"percentage_progress":{"type":"integer","format":"int32","description":"The percentage ssh session timeout in mins."},"session_id":{"type":"string","description":"The session ID for the active ssh access of device"}}},"XiqDevicesResetToDefaultRequest":{"type":"object","description":"The request to reset devices to default.","properties":{"device_ids":{"type":"array","description":"The device ids","items":{"type":"integer","format":"int64"},"minItems":1}},"required":["device_ids"]},"XiqDellDevices":{"type":"object","description":"Dell devices to onboard","properties":{"sn_to_st":{"type":"object","additionalProperties":{"type":"string"},"description":"Serial number -> Service tag"}},"required":["sn_to_st"]},"XiqDigitalTwinDevice":{"type":"object","description":"The Digital Twin device to onboard.","properties":{"make":{"$ref":"#/components/schemas/XiqDigitalTwinMake","description":"The Digital Twin device make."},"model":{"$ref":"#/components/schemas/XiqDigitalTwinModel","description":"The Digital Twin device model."},"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"}}},"required":["make","model","os_version"]},"XiqDigitalTwinDevices":{"type":"object","description":"Digital Twin devices to onboard","properties":{"dts":{"type":"array","description":"The Digital Twin devices to onboard.","items":{"$ref":"#/components/schemas/XiqDigitalTwinDevice"},"maxItems":1,"minItems":1}}},"XiqDigitalTwinFeatLicense":{"type":"string","enum":["PRD_5000_PRMR","PRD_5000_MACSEC","PRD_5320_10G_4P","PRD_5320_10G_8P","PRD_7000_PRMR","PRD_7000_MACSEC"]},"XiqDigitalTwinMake":{"type":"string","enum":["SWITCH_ENGINE","FABRIC_ENGINE"]},"XiqDigitalTwinModel":{"type":"string","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","enum":["DT_5520_VIM_4X","DT_5520_VIM_4XE","DT_5520_VIM_4YE","DT_5720_VIM_2CE","DT_5720_VIM_6YE"]},"XiqExosDevices":{"type":"object","description":"ExtremeXOS (EXOS) devices to onboard","properties":{"sns":{"type":"array","description":"The serial numbers","items":{"type":"string"}}},"required":["sns"]},"XiqExtremeDevices":{"type":"object","description":"Extreme/Aerohive devices to onboard","properties":{"sns":{"type":"array","description":"The serial numbers","items":{"type":"string"}}},"required":["sns"]},"XiqOnboardDeviceRequest":{"type":"object","description":"The payload to onboard devices","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"}}},"XiqVossDevices":{"type":"object","description":"VSP Operating System Software (VOSS) devices to onboard","properties":{"sns":{"type":"array","description":"The serial numbers","items":{"type":"string"}}},"required":["sns"]},"XiqWingDevices":{"type":"object","description":"ExtremeWireless (WiNG) devices to onboard","properties":{"sn_to_mac":{"type":"object","additionalProperties":{"type":"string"},"description":"Serial number -> MAC address"}},"required":["sn_to_mac"]},"XiqFailureOnboardDevice":{"type":"object","description":"The failure onboard device","properties":{"serial_number":{"type":"string","description":"The serial number"},"error":{"$ref":"#/components/schemas/XiqOnboardError","description":"The onboard error code"}},"required":["serial_number"]},"XiqOnboardDeviceResponse":{"type":"object","description":"The response for onboard devices","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"}}}},"XiqOnboardError":{"type":"string","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","REACH_MAX_CAP","NETWORK_POLICY_NOT_FOUND","VERSION_NOT_SUPPORTED","VERSION_DEPRECATED"]},"XiqSuccessOnboardDevice":{"type":"object","description":"The success onboard device","properties":{"serial_number":{"type":"string","description":"The serial number"},"device_id":{"type":"integer","format":"int64","description":"The device ID"}},"required":["device_id","serial_number"]},"XiqSendCliRequest":{"type":"object","description":"The request for sending CLIs to devices","properties":{"devices":{"$ref":"#/components/schemas/XiqDeviceFilter","description":"The selected target devices"},"clis":{"type":"array","description":"The one or multiple CLIs to send","items":{"type":"string"}}},"required":["clis","devices"]},"XiqAdvancedOnboardDeviceRequest":{"type":"object","description":"The payload to advanced onboard devices","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"}}},"XiqDellDevice":{"type":"object","description":"Dell device to onboard","properties":{"serial_number":{"type":"string","description":"The serial number"},"service_tag":{"type":"string","description":"The service tag"},"location":{"$ref":"#/components/schemas/XiqDeviceLocationAssignment","description":"The assigned device location"},"network_policy_id":{"type":"integer","format":"int64","description":"The assigned network policy"},"hostname":{"type":"string","description":"The device hostname"}},"required":["location","serial_number","service_tag"]},"XiqDigitalTwinOnboardDevice":{"type":"object","description":"The Digital Twin device to onboard.","properties":{"digital_twin_device":{"$ref":"#/components/schemas/XiqDigitalTwinDevice","description":"The Digital Twin device"},"location":{"$ref":"#/components/schemas/XiqDeviceLocationAssignment","description":"The assigned device location"},"network_policy_id":{"type":"integer","format":"int64","description":"The assigned network policy"},"hostname":{"type":"string","description":"The device hostname"}},"required":["digital_twin_device","location"]},"XiqExosDevice":{"type":"object","description":"ExtremeXOS (EXOS) device to onboard","properties":{"serial_number":{"type":"string","description":"The serial number"},"location":{"$ref":"#/components/schemas/XiqDeviceLocationAssignment","description":"The assigned device location"},"network_policy_id":{"type":"integer","format":"int64","description":"The assigned network policy"},"hostname":{"type":"string","description":"The device hostname"}},"required":["location","serial_number"]},"XiqExtremeDevice":{"type":"object","description":"Extreme/Aerohive device to onboard","properties":{"serial_number":{"type":"string","description":"The serial number"},"location":{"$ref":"#/components/schemas/XiqDeviceLocationAssignment","description":"The assigned device location"},"network_policy_id":{"type":"integer","format":"int64","description":"The assigned network policy"},"hostname":{"type":"string","description":"The device hostname"}},"required":["location","serial_number"]},"XiqVossDevice":{"type":"object","description":"VSP Operating System Software (VOSS) device to onboard","properties":{"serial_number":{"type":"string","description":"The serial number"},"location":{"$ref":"#/components/schemas/XiqDeviceLocationAssignment","description":"The assigned device location"},"network_policy_id":{"type":"integer","format":"int64","description":"The assigned network policy"},"hostname":{"type":"string","description":"The device hostname"}},"required":["location","serial_number"]},"XiqWingDevice":{"type":"object","description":"ExtremeWireless (WiNG) device to onboard","properties":{"serial_number":{"type":"string","description":"The serial number"},"mac_address":{"type":"string","description":"The mac address"},"location":{"$ref":"#/components/schemas/XiqDeviceLocationAssignment","description":"The assigned device location"},"network_policy_id":{"type":"integer","format":"int64","description":"The assigned network policy"},"hostname":{"type":"string","description":"The device hostname"}},"required":["location","mac_address","serial_number"]},"XiqAdvancedOnboardDeviceResponse":{"type":"object","description":"The response for advanced onboard devices","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"}}}},"XiqDeploymentRequest":{"type":"object","description":"The configuration/firmware update deployment request to devices.","properties":{"schedule":{"$ref":"#/components/schemas/XiqScheduleDetails"},"devices":{"$ref":"#/components/schemas/XiqDeployDeviceFilter"},"policy":{"$ref":"#/components/schemas/XiqDeploymentPolicy"}}},"XiqDeploymentResponse":{"type":"object","description":"The configuration deployment response","properties":{"deployment_id":{"type":"integer","format":"int64","description":"The scheduled deployment ID"},"deployment_status":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/XiqDeploymentStatus"},"description":"Devices config deployment status map "}}},"XiqDeploymentStatus":{"type":"object","description":"The configuration deployment status","properties":{"is_finished":{"type":"boolean","description":"Indicates whether the last deployment is finished"},"current_progress":{"type":"integer","format":"int32","description":"The current deploy progress if not finished, range from 0 to 100"},"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","format":"int64","description":"The last deployed time (Only valid when in_progress = false)"},"status_message":{"type":"string","description":"The status message"},"is_pending_config":{"type":"boolean","description":"Indicates whether is pending config status or not"},"is_config_rolled_back":{"type":"boolean","description":"Indicates whether the configuration is rolled back"}},"required":["is_finished"]},"XiqFirmwareMetadatasRequest":{"type":"object","description":"The request to get device firmware metadatas","properties":{"device_ids":{"type":"array","description":"The device IDs","items":{"type":"integer","format":"int64"}},"product_types":{"type":"array","description":"The product types","items":{"type":"string"}}}},"XiqDeviceFirmwareMetadata":{"type":"object","description":"The device compatible firmware metadata","properties":{"firmware_id":{"type":"integer","format":"int64","description":"The firmware metadata ID"},"create_time":{"type":"string","format":"date-time","description":"The create time"},"update_time":{"type":"string","format":"date-time","description":"The last update time"},"firmware_name":{"type":"string","description":"The firmware name"},"firmware_type":{"type":"string","description":"The firmware type"},"scope":{"type":"string","description":"The firmware availability scope"},"version":{"type":"string","description":"The firmware version"},"date":{"type":"string","description":"The firmware release date"},"firmware_size":{"type":"string","description":"The firmware size"},"display_version":{"type":"string","description":"The firmware display version"},"supported_platforms":{"type":"string","description":"The platforms supported by the firmware"},"md5":{"type":"string","description":"The firmware md5 hash"}},"required":["create_time","firmware_id","update_time"]},"XiqFirmwareMetadatasResponse":{"type":"object","description":"Get device firmware metadatas response","properties":{"firmware_metadatas":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/XiqDeviceFirmwareMetadata"}}}}},"XiqFilterType":{"type":"string","enum":["GT","GTE","LT","LTE","EQ","NEQ","BTW","BLANK","NOT_BLANK"]},"XiqNumberFilter":{"type":"object","description":"Number Filter","properties":{"column_name":{"type":"string","description":"The column name"},"filter_type":{"$ref":"#/components/schemas/XiqFilterType","description":"The filter type"},"value":{"type":"integer","format":"int64","description":"The value"},"min":{"type":"integer","format":"int64","description":"The minimum value"},"max":{"type":"integer","format":"int64","description":"The maximum value"}}},"XiqUsageAndCapacityGridFilter":{"type":"object","description":"Request body for Usage and Capacity Filter","properties":{"site_ids":{"type":"array","description":"List of site ids","items":{"type":"integer","format":"int64"}},"device_ids":{"type":"array","description":"List of device ids","items":{"type":"integer","format":"int64"}},"building_ids":{"type":"array","description":"List of building ids","items":{"type":"integer","format":"int64"}},"buildings":{"type":"array","description":"List of buildings","items":{"type":"string"}},"floors":{"type":"array","description":"List of floors","items":{"type":"string"}},"has_usage_capacity_issues":{"type":"boolean","description":"Flag to filter usage capacity issues"},"number_filters":{"type":"array","description":"List of number filters","items":{"$ref":"#/components/schemas/XiqNumberFilter"}},"has_packet_loss_issues":{"type":"boolean","description":"Flag to filter packet loss issues"},"has_retries_issues":{"type":"boolean","description":"Flag to filter retry issues"}}},"PagedXiqUsageCapacityGridResponse":{"type":"object","properties":{"page":{"type":"integer","format":"int32","description":"The current page number"},"count":{"type":"integer","format":"int32","description":"The element count of the current page"},"total_pages":{"type":"integer","format":"int32","description":"The total page number based on request page size"},"total_count":{"type":"integer","format":"int64","description":"The total element count"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqUsageCapacityGridResponse"}}},"required":["count","page","total_count","total_pages"]},"XiqUsageCapacityGridResponse":{"type":"object","description":"The usage & capacity grid of wireless devices","properties":{"hostname":{"type":"string","description":"Hostname of the device"},"device_ip":{"type":"string","description":"The IP address of the device"},"site":{"type":"string","description":"The site where the device is located"},"building":{"type":"string","description":"The building where the device is located"},"floor":{"type":"string","description":"The floor where the device is located"},"mac_address":{"type":"string","description":"MAC address of the device"},"wifi0_retry_score":{"type":"integer","format":"int64","description":"Retry score for wifi0"},"wifi1_retry_score":{"type":"integer","format":"int64","description":"Retry score for wifi1"},"wifi2_retry_score":{"type":"integer","format":"int64","description":"Retry score for wifi2"},"wifi0_packet_loss":{"type":"integer","format":"int64","description":"Packet loss score in APs"},"wifi1_packet_loss":{"type":"integer","format":"int64","description":"Packet loss score in APs"},"wifi2_packet_loss":{"type":"integer","format":"int64","description":"Packet loss score in APs"},"eth0_unicast_score":{"type":"integer","format":"int64","description":"Unicast score for Eth0 interface"},"eth0_broadcast_score":{"type":"integer","format":"int64","description":"Broadcast score for Eth0 interface"},"eth0_multicast_score":{"type":"integer","format":"int64","description":"Multicast score for Eth0 interface"},"eth1_unicast_score":{"type":"integer","format":"int64","description":"Unicast score for Eth1 interface"},"eth1_broadcast_score":{"type":"integer","format":"int64","description":"Broadcast score for Eth1 interface"},"eth1_multicast_score":{"type":"integer","format":"int64","description":"Multicast score for Eth1 interface"},"wifi0_interference_score":{"type":"integer","format":"int64","description":"Interference score for wifi0"},"wifi1_interference_score":{"type":"integer","format":"int64","description":"Interference score for wifi1"},"wifi2_interference_score":{"type":"integer","format":"int64","description":"Interference score for wifi2"},"wifi0_noise":{"type":"integer","format":"int64","description":"Noise score for wifi0"},"wifi1_noise":{"type":"integer","format":"int64","description":"Noise score for wifi1"},"wifi2_noise":{"type":"integer","format":"int64","description":"Noise score for wifi2"},"device_id":{"type":"integer","format":"int64","description":"The device id"},"packet_loss":{"type":"integer","format":"int64","description":"The device id"},"link_error2_dot4_g":{"type":"integer","format":"int64","description":"Link Error for wifi0"},"link_error5g":{"type":"integer","format":"int64","description":"Link Error for wifi1"},"link_error6g":{"type":"integer","format":"int64","description":"Link Error for wifi2"},"healthy_clients":{"type":"integer","format":"int32","description":"The associated active client count for the device"},"unhealthy_clients":{"type":"integer","format":"int32","description":"The associated inactive client count for the device"},"has_usage_capacity_issue":{"type":"boolean","description":"Flag to indicate if device has usage capacity issue"},"radio_2dot4g_utilization_score":{"type":"integer","format":"int64","description":"Channel Utilization score for 2.4 GHz radio"},"radio_5g_utilization_score":{"type":"integer","format":"int64","description":"Channel Utilization score for 5 GHz radio"},"radio_6g_utilization_score":{"type":"integer","format":"int64","description":"Channel Utilization score for 6 GHz radio"}}},"XiqMetricReport":{"type":"object","description":"ExtremeCloud IQ Xiq report","properties":{"id":{"type":"string","description":"The reportId"}},"required":["id"]},"XiqDashboardFilter":{"type":"object","description":"Request body for Alert Diagnostics Filter","properties":{"site_ids":{"type":"array","description":"List of site ids","items":{"type":"integer","format":"int64"}}}},"XiqWirelessUsageCapacityExcessiveUtilization":{"type":"object","description":"The count of wireless devices having excessive channel utilization.","properties":{"total_ap_count":{"type":"integer","format":"int64","description":"The counts of All APs with excessive utilization"},"radio2_dot4g_utilization_issue_ap_count":{"type":"integer","format":"int64","description":"The counts of APs with excessive utilization on 2.4 GHz radio"},"radio5g_utilization_issue_ap_count":{"type":"integer","format":"int64","description":"The counts of APs with excessive utilization on 5 GHz radio"},"radio6g_utilization_issue_ap_count":{"type":"integer","format":"int64","description":"The counts of APs with excessive utilization on 6 GHz radio"}}},"XiqCountApWithExcessiveRetriesResponse":{"type":"object","description":"The count of wireless devices having excessive retries.","properties":{"excessive_retires_ap_count":{"type":"integer","format":"int64","description":"The counts of APs with excessive retries"}}},"XiqCountApWithPacketLossExcessiveResponse":{"type":"object","description":"The count of wireless devices having excessive packet loss.","properties":{"excessive_packet_loss_ap_count":{"type":"integer","format":"int64","description":"The counts of APs with excessive packet loss"}}},"XiqDeviceSummary":{"type":"object","description":"Count of total wireless devices and total devices with health issues","properties":{"wireless_devices":{"type":"integer","format":"int64","description":"Total count of devices"},"wireless_unhealthy_devices":{"type":"integer","format":"int64","description":"Total count of unhealthy devices"}}},"XiqDevicePoeUsageIssuesCount":{"type":"object","description":"Count of wireless devices having poe usage issues","properties":{"poe_usage_issue_device_count":{"type":"integer","format":"int32","description":"Count of wireless devices having poe usage issues"}}},"XiqDeviceMemoryUsageIssueCount":{"type":"object","description":"Count of wireless devices having memory usage issues","properties":{"memory_usage_issue_device_count":{"type":"integer","format":"int32","description":"Count of wireless devices having memory usage issues"}}},"XiqDeviceCpuUsageIssueCount":{"type":"object","description":"Count of wireless devices having CPU usage issues (CPU usage >= 95%)","properties":{"cpu_usage_issue_device_count":{"type":"integer","format":"int64","description":"Count of devices with CPU usage"}}},"XiqWirelessDeviceHealthSortField":{"type":"string","enum":["HOSTNAME","SITE","CPU_USAGE_PERCENTAGE","MEMORY_USAGE_PERCENTAGE","TOTAL_ETH0_SCORE","TOTAL_ETH1_SCORE"]},"XiqWirelessDeviceHealthGridFilter":{"type":"object","description":"Request body for Wireless Device Health Grid Filter","properties":{"site_ids":{"type":"array","description":"List of site ids","items":{"type":"integer","format":"int64"}},"device_ids":{"type":"array","description":"List of device ids","items":{"type":"integer","format":"int64"}},"has_device_health_issues":{"type":"boolean","description":"Flag to filter device health issue"},"has_poe_issues":{"type":"boolean","description":"Flag to filter poe issue"},"number_filter":{"type":"array","description":"Object of CPU Usage Percentage","items":{"$ref":"#/components/schemas/XiqNumberFilter"}}}},"PagedXiqDeviceHealthGridResponse":{"type":"object","properties":{"page":{"type":"integer","format":"int32","description":"The current page number"},"count":{"type":"integer","format":"int32","description":"The element count of the current page"},"total_pages":{"type":"integer","format":"int32","description":"The total page number based on request page size"},"total_count":{"type":"integer","format":"int64","description":"The total element count"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqDeviceHealthGridResponse"}}},"required":["count","page","total_count","total_pages"]},"XiqDeviceHealthGridResponse":{"type":"object","description":"The device health grid","properties":{"hostname":{"type":"string","description":"The hostname of the device"},"device_ip":{"type":"string","description":"The IP address of the device"},"site":{"type":"string","description":"The site where the device is located"},"building":{"type":"string","description":"The building where the device is located"},"floor":{"type":"string","description":"The floor where the device is located"},"cpu_usage_percentage":{"type":"integer","format":"int64","description":"Percentage of CPU utilisation"},"memory_usage_percentage":{"type":"integer","format":"int64","description":"Percentage of memory utilisation"},"poe_usage_indicator":{"type":"boolean","description":"Indicates whether PoE usage is within acceptable limits (device has adequate power supply)"},"channel_change_count":{"type":"integer","format":"int64","description":"The count for channel change for the device"},"wifi_reboots_count":{"type":"integer","format":"int64","description":"The count for Wi-Fi reboots for the device"},"eth0_unicast_score":{"type":"integer","format":"int64","description":"Unicast score for Eth0 interface"},"eth0_broadcast_score":{"type":"integer","format":"int64","description":"Broadcast score for Eth0 interface"},"eth0_multicast_score":{"type":"integer","format":"int64","description":"Multicast score for Eth0 interface"},"eth1_unicast_score":{"type":"integer","format":"int64","description":"Unicast score for Eth1 interface"},"eth1_broadcast_score":{"type":"integer","format":"int64","description":"Broadcast score for Eth1 interface"},"eth1_multicast_score":{"type":"integer","format":"int64","description":"Multicast score for Eth1 interface"},"device_id":{"type":"integer","format":"int64","description":"The device id"},"has_device_health_issue":{"type":"boolean","description":"Flag to indicate if device has device health issue"}}},"XiqCreateWirelessClientHealthCriteria":{"type":"object","properties":{"assoc_param_slow":{"type":"number","format":"double","description":"The association parameter slow"},"assoc_unit_slow":{"type":"string","description":"The association unit slow"},"auth_param_slow":{"type":"number","format":"double","description":"The authentication parameter slow"},"auth_unit_slow":{"type":"string","description":"The authentication unit slow"},"dhcp_param_slow":{"type":"number","format":"double","description":"The DHCP parameter slow"},"dhcp_unit_slow":{"type":"string","description":"The DHCP unit slow"},"roams_param_slow":{"type":"number","format":"double","description":"The roaming parameter slow"},"roams_unit_slow":{"type":"string","description":"The roaming unit slow"},"rssi_param":{"type":"number","format":"double","description":"The RSSI parameter"},"rssi_unit":{"type":"string","description":"The RSSI unit"},"snr_param":{"type":"number","format":"double","description":"The SNR parameter"},"snr_unit":{"type":"string","description":"The SNR unit"},"onboard_param":{"type":"number","format":"double","description":"The onboarding parameter"},"onboard_unit":{"type":"string","description":"The onboarding unit"},"time_range":{"type":"integer","format":"int32","description":"The time range in days"}}},"XiqCreateWirelessDashboardCriteriaParamRequest":{"type":"object","description":"Create wireless diagnostics criteria param request","properties":{"device_health_criteria":{"$ref":"#/components/schemas/XiqCreateWirelessDeviceHealthCriteria"},"client_health_criteria":{"$ref":"#/components/schemas/XiqCreateWirelessClientHealthCriteria"},"usage_capacity_criteria":{"$ref":"#/components/schemas/XiqCreateWirelessUsageCapacityCriteria"}}},"XiqCreateWirelessDeviceHealthCriteria":{"type":"object","properties":{"cpu_utilization":{"type":"number","format":"double","description":"The CPU utilization"},"memory_utilization":{"type":"number","format":"double","description":"The memory utilization"},"poe":{"type":"number","format":"double","description":"The power over ethernet"},"wired_port_multicast":{"type":"number","format":"double","description":"The wired port multicast"},"wired_port_broadcast":{"type":"number","format":"double","description":"The wired port broadcast"}}},"XiqCreateWirelessUsageCapacityCriteria":{"type":"object","properties":{"channel_utilization":{"type":"number","format":"double","description":"channel utilization "},"lnk_err":{"type":"number","format":"double","description":"The link error 2.4 GHz"},"retries":{"type":"number","format":"double","description":"The retries 2.4 GHz"},"pkt_loss":{"type":"number","format":"double","description":"The packet loss"},"interference":{"type":"number","format":"double","description":"The interference"},"noise":{"type":"number","format":"double","description":"The noise"},"noise_unit":{"type":"string","description":"The noise unit"}}},"XiqCreateWirelessDashboardCriteriaParamResponse":{"type":"object","description":"The wireless diagnostics criteria param response","properties":{"client_health_criteria_param":{"$ref":"#/components/schemas/XiqWirelessClientHealthCriteriaParam","description":"The client health criteria param"},"device_health_criteria_param":{"$ref":"#/components/schemas/XiqWirelessDeviceHealthCriteriaParam","description":"The device health criteria param"},"usage_capacity_criteria_param":{"$ref":"#/components/schemas/XiqWirelessUsageCapacityCriteriaParam","description":"The usage capacity criteria param"}}},"XiqWirelessClientHealthCriteriaParam":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"The unique identifier of the criteria param"},"owner_id":{"type":"integer","format":"int64","description":"The unique identifier of the owner"},"org_id":{"type":"integer","format":"int64","description":"The unique identifier of the organization"},"assoc_reln_slow":{"type":"string","description":"The association relation slow"},"assoc_param_slow":{"type":"number","format":"double","description":"The association parameter slow"},"assoc_unit_slow":{"type":"string","description":"The association unit slow"},"auth_reln_slow":{"type":"string","description":"The authentication relation slow"},"auth_param_slow":{"type":"number","format":"double","description":"The authentication parameter slow"},"auth_unit_slow":{"type":"string","description":"The authentication unit slow"},"dhcp_reln_slow":{"type":"string","description":"The DHCP relation slow"},"dhcp_param_slow":{"type":"number","format":"double","description":"The DHCP parameter slow"},"dhcp_unit_slow":{"type":"string","description":"The DHCP unit slow"},"roams_reln_slow":{"type":"string","description":"The roaming relation slow"},"roams_param_slow":{"type":"number","format":"double","description":"The roaming parameter slow"},"roams_unit_slow":{"type":"string","description":"The roaming unit slow"},"rssi_reln":{"type":"string","description":"The RSSI relation"},"rssi_param":{"type":"number","format":"double","description":"The RSSI parameter"},"rssi_unit":{"type":"string","description":"The RSSI unit"},"snr_reln":{"type":"string","description":"The SNR relation"},"snr_param":{"type":"number","format":"double","description":"The SNR parameter"},"snr_unit":{"type":"string","description":"The SNR unit"},"onboard_reln":{"type":"string","description":"The onboarding relation"},"onboard_param":{"type":"number","format":"double","description":"The onboarding parameter"},"onboard_unit":{"type":"string","description":"The onboarding unit"},"time_range":{"type":"integer","format":"int32","description":"time range in days"}}},"XiqWirelessDeviceHealthCriteriaParam":{"type":"object","description":"The criteria for a wireless device health","properties":{"id":{"type":"integer","format":"int64","description":"The unique identifier"},"owner_id":{"type":"integer","format":"int64","description":"The owner ID"},"org_id":{"type":"integer","format":"int64","description":"The organization identifier, valid when enabling HIQ feature"},"cpu_utilization":{"type":"number","format":"double","description":"The CPU utilization"},"cpu_utilization_reln":{"type":"string","description":"The CPU utilization relation"},"memory_utilization":{"type":"number","format":"double","description":"The memory utilization"},"memory_utilization_reln":{"type":"string","description":"The memory utilization relation"},"poe":{"type":"number","format":"double","description":"The power over ethernet"},"wired_port_multicast":{"type":"number","format":"double","description":"The wired port multicast"},"wired_port_multicast_reln":{"type":"string","description":"The wired port multicast relation"},"wired_port_broadcast":{"type":"number","format":"double","description":"The wired port broadcast"},"wired_port_broadcast_reln":{"type":"string","description":"The wired port broadcast relation"}},"required":["id"]},"XiqWirelessUsageCapacityCriteriaParam":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"The unique identifier of the criteria param"},"owner_id":{"type":"integer","format":"int64","description":"The unique identifier of the owner"},"org_id":{"type":"integer","format":"int64","description":"The unique identifier of the organization"},"radio_24":{"type":"number","format":"double","description":"The radio 2.4 GHz"},"radio_24_reln":{"type":"string","description":"The radio 2.4 GHz relation"},"radio_5":{"type":"number","format":"double","description":"The radio 5 GHz"},"radio_5_reln":{"type":"string","description":"The radio 5 GHz relation"},"radio_6":{"type":"number","format":"double","description":"The radio 6 GHz"},"radio_6_reln":{"type":"string","description":"The radio 6 GHz relation"},"lnk_err_24":{"type":"number","format":"double","description":"The link error 2.4 GHz"},"lnk_err_24_reln":{"type":"string","description":"The link error 2.4 GHz relation"},"lnk_err_5":{"type":"number","format":"double","description":"The link error 5 GHz"},"lnk_err_5_reln":{"type":"string","description":"The link error 5 GHz relation"},"lnk_err_6":{"type":"number","format":"double","description":"The link error 6 GHz"},"lnk_err_6_reln":{"type":"string","description":"The link error 6 GHz relation"},"retries_24":{"type":"number","format":"double","description":"The retries 2.4 GHz"},"retries_24_reln":{"type":"string","description":"The retries 2.4 GHz relation"},"retries_5":{"type":"number","format":"double","description":"The retries 5 GHz"},"retries_5_reln":{"type":"string","description":"The retries 5 GHz relation"},"retries_6":{"type":"number","format":"double","description":"The retries 6 GHz"},"retries_6_reln":{"type":"string","description":"The retries 6 GHz relation"},"pkt_loss_5":{"type":"number","format":"double","description":"The packet loss"},"pkt_loss_5_reln":{"type":"string","description":"The packet loss relation"},"pkt_loss_24":{"type":"number","format":"double","description":"The packet loss"},"pkt_loss_24_reln":{"type":"string","description":"The packet loss relation"},"pkt_loss_6":{"type":"number","format":"double","description":"The packet loss"},"pkt_loss_6_reln":{"type":"string","description":"The packet loss relation"},"interference_5":{"type":"number","format":"double","description":"The interference"},"interference_5_reln":{"type":"string","description":"The interference relation"},"interference_24":{"type":"number","format":"double","description":"The interference"},"interference_24_reln":{"type":"string","description":"The interference relation"},"interference_6":{"type":"number","format":"double","description":"The interference"},"interference_6_reln":{"type":"string","description":"The interference relation"},"noise_24":{"type":"number","format":"double","description":"The noise"},"noise_24_reln":{"type":"string","description":"The noise relation"},"noise_24_unit":{"type":"string","description":"The noise unit"},"noise_5":{"type":"number","format":"double","description":"The noise"},"noise_5_reln":{"type":"string","description":"The noise relation"},"noise_5_unit":{"type":"string","description":"The noise unit"},"noise_6":{"type":"number","format":"double","description":"The noise"},"noise_6_reln":{"type":"string","description":"The noise relation"},"noise_6_unit":{"type":"string","description":"The noise unit"}}},"XiqClientHealthRoamingIssues":{"type":"object","description":"Count of wireless clients with roaming issues","properties":{"total_clients":{"type":"integer","format":"int64","description":"The total number of clients"},"roaming_issues":{"type":"integer","format":"int64","description":"The number of failed or slow roams (where slow is defined as >= 3000 milli-seconds)"}}},"XiqIssueClientRoaming":{"type":"object","description":"Wireless clients issue roaming","properties":{"date_time":{"type":"integer","format":"int64","description":"The time and date in milliseconds (epoch time) when the issue when issue occurred","example":1708243200000},"issue_type":{"type":"string","description":"The type of issue","enum":["ROAMING_ISSUE"],"example":"ROAMING_ISSUE"},"roaming_time":{"type":"integer","format":"int32","description":"The roaming time in milliseconds, can be empty","example":1500},"device_name":{"type":"string","description":"The device name to which client was connected"}}},"XiqIssueClientIpAddress":{"type":"object","description":"Wireless clients issue ipAddress","properties":{"date_time":{"type":"integer","format":"int64","description":"The date and time when the issue occurred","example":1682345600000},"issue_type":{"type":"string","description":"The type of issue.","enum":["ASSOCIATION","AUTHENTICATION","IPADDRESS","ROAMING"]},"device_name":{"type":"string","description":"The device name to which client was connected"},"slowness_duration":{"type":"integer","format":"int32","description":"dhcp slowness duration in seconds","example":120}}},"XiqIssueClientAuth":{"type":"object","description":"Wireless clients issue authentication","properties":{"date_time":{"type":"integer","format":"int64","description":"The time and date when the issue occurred (epoch milliseconds)","example":1622548800000},"reason_code":{"type":"string","description":"The reason why the problem occurred.","enum":["USER_NOT_FOUND","INVALID_CREDENTIAL","INVALID_DOMAIN","INCORRECT_EAP_TYPE","INVALID_CERTIFICATE","RADIUS_SERVER_REJECT","RADIUS_SERVER_UNREACHABLE","ACTIVE_DIRECTORY_DOMAIN_NOT_JOINED","PASSPHRASE_MISMATCH","PPSK_SESSION_LIMIT_EXCEEDED","PPSK_MAC_BIND_FAILURE","USER_PROFILE_NOT_ALLOWED","INVALID_VLAN_USER_PROFILE_ID","PPSK_REJECTED_BY_GUEST_ACCESS","_802_DOT_1X_REJECTED_BY_GUEST_ACCESS","GUEST_ACCESS_UNREACHABLE","CLIENT_AP_VLAN_MISMATCH","PORT_BASED_INTERFACE_CHECK_ISSUE"]},"device_name":{"type":"string","description":"The device name to which client was connected"},"slowness_duration":{"type":"integer","format":"int32","description":"auth slow duration in seconds","example":120}}},"XiqIssueClientAssociation":{"type":"object","description":"Wireless clients issue association","properties":{"date_time":{"type":"integer","format":"int64","description":"The time and date when the issue when issue occurred in epoch milliseconds","example":1622548800000},"reason_code":{"type":"string","description":"The reason why the problem occurred.","enum":["MAXIMUM_CLIENT_COUNT_EXCEEDED","CLIENT_DENIED_BY_SECURITY_POLICY","CLIENT_CAPABILITIES_MISMATCH","AUTHENTICATION_ALGORITHM_UNSUPPORTED"]},"device_name":{"type":"string","description":"The device name to which client was connected"},"slowness_duration":{"type":"integer","format":"int32","description":"The duration of slowness in seconds"}}},"XiqClientConnectionStatus":{"type":"string","enum":["CONNECTED","DISCONNECTED","UNKNOWN"]},"XiqClientHealthSortField":{"type":"string","enum":["OPERATING_SYSTEM","FREQUENCY","SSID","CONNECTION_STATUS","ALIAS","CLIENT_MAC","CATEGORY_ASSIGNMENT","USER_PROFILE","CLIENT_IP","CONNECTED_DEVICE_MAC","ENCRYPTION","IPV4","IPV6","VLAN","RSSI","SNR","AIR_TIME","CLIENT_DEVICE_ID","RX_CLIENT_RETIRES","TX_CLIENT_RETIRES","AUTHENTICATION","CLIENT_TYPE"]},"XiqClientGridFilter":{"type":"object","description":"Request body for Client Grid Filter","properties":{"site_ids":{"type":"array","description":"The site ids","items":{"type":"integer","format":"int64"}},"device_ids":{"type":"array","description":"The device ids","items":{"type":"integer","format":"int64"}},"number_filter":{"type":"array","description":"The health status","items":{"$ref":"#/components/schemas/XiqNumberFilter"}},"alias":{"type":"array","description":"The aliases","items":{"type":"string"}},"auth_methods":{"type":"array","description":"The authentication methods","items":{"type":"string"}},"encryption_methods":{"type":"array","description":"The encryption methods","items":{"type":"string"}},"operating_systems":{"type":"array","description":"The operating systems","items":{"type":"string"}},"ssids":{"type":"array","description":"The SSIDs","items":{"type":"string"}},"user_profiles":{"type":"array","description":"The user profile names","items":{"type":"string"}},"frequency":{"type":"array","description":"The frequency","items":{"type":"string"}},"category_assignments":{"type":"array","description":"The category assignments","items":{"type":"string"}},"has_authentication_issues":{"type":"boolean","description":"Flag to check authentication issues"},"has_association_issues":{"type":"boolean","description":"Flag to check association issues"},"has_ip_address_issues":{"type":"boolean","description":"Flag to check ip address issues"},"has_roaming_issues":{"type":"boolean","description":"Flag to check roaming issues"},"is_client_unhealthy":{"type":"boolean","description":"Flag to check unhealthy clients"},"client_type":{"type":"array","description":"The client types","items":{"type":"string"}}}},"PagedXiqClientHealthGridResponse":{"type":"object","properties":{"page":{"type":"integer","format":"int32","description":"The current page number"},"count":{"type":"integer","format":"int32","description":"The element count of the current page"},"total_pages":{"type":"integer","format":"int32","description":"The total page number based on request page size"},"total_count":{"type":"integer","format":"int64","description":"The total element count"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqClientHealthGridResponse"}}},"required":["count","page","total_count","total_pages"]},"XiqClientHealthGridResponse":{"type":"object","description":"The client health grid","properties":{"client_hostname":{"type":"string","description":"The hostname of the client"},"client_ip":{"type":"string","format":"ipv4 or ipv6","description":"The IP address of the client","example":"h:h:h:h:h:h:h:h"},"site":{"type":"string","description":"The site where the client is located"},"building":{"type":"string","description":"The building where the client is located"},"floor":{"type":"string","description":"The floor where the client is located"},"has_association_issues":{"type":"boolean","description":"The indicator of association issues"},"has_authentication_issues":{"type":"boolean","description":"The indicator of authentication issues"},"has_ip_address_issues":{"type":"boolean","description":"The indicator of IP address issues"},"snr":{"type":"integer","format":"int32","description":"Signal-to-noise ratio of the client's connection in dB (decibels)","example":40},"rssi":{"type":"integer","format":"int32","description":"Received signal strength indicator of the client's connection in dBm (decibels-milliwatts)","example":-60},"air_time":{"type":"integer","format":"int32","description":"The air time used by the client as a percentage (0-100%), calculated as average airtime ((Rx airtime + Tx airtime)/2)","example":75},"frequency":{"type":"string","description":"The frequency band used by the client (e.g., 2.4 GHz, 5 GHz, 6 GHz)"},"has_roaming_issues":{"type":"boolean","description":"The indicator of roaming issues experienced by the client"},"ipv4":{"type":"string","format":"ipv4","description":"The IPv4 address assigned to the client","example":"192.168.1.1"},"connected_device_mac":{"type":"string","description":"The MAC address in format 'AABBCCDDEEFF' without separators. Accepted formats: (1) OUI only — first 6 hex characters (e.g., 'AABBCC'), (2) Full MAC address — 12 hex characters (e.g., 'AABBCCDDEEFF').","example":"AABBCCDDEEFF"},"ssid":{"type":"string","description":"The SSID of the network"},"vlan":{"type":"integer","format":"int64","description":"The VLAN ID"},"username":{"type":"string","description":"The username of the client"},"authentication":{"type":"string","description":"The authentication method used"},"encryption":{"type":"string","description":"The encryption method used"},"user_profile":{"type":"string","description":"The user profile assigned to the client"},"alias":{"type":"string","description":"The alias of the client"},"category_assignment":{"type":"string","description":"The category assignment of the client"},"ipv6":{"type":"string","format":"ipv6","description":"The IPv6 address assigned to the client","example":"h:h:h:h:h:h:h:h"},"slowness":{"type":"integer","format":"int32","description":"The slowness value of the IP Address in milliseconds","example":100},"client_device_id":{"type":"integer","format":"int64","description":"The client device ID"},"device_id":{"type":"integer","format":"int64","description":"The device ID"},"roaming_time":{"type":"integer","format":"int32","description":"The roaming time in milliseconds","example":5000},"association_duration":{"type":"integer","format":"int32","description":"The association duration in milliseconds","example":3600000},"dhcp_ip_assignation_time":{"type":"integer","format":"int32","description":"The DHCP IP assignation time in milliseconds","example":2000},"authentication_response_time":{"type":"integer","format":"int32","description":"The authentication response time in milliseconds","example":1500},"rx_client_retries":{"type":"integer","format":"int32","description":"The number of RX client retries","example":3},"tx_client_retries":{"type":"integer","format":"int32","description":"The number of TX client retries","example":2},"ipv4_warning":{"type":"boolean","description":"The number of association issues"},"air_time_warning":{"type":"boolean","description":"The number of association issues"},"association_issues":{"type":"integer","format":"int32","description":"The number of association issues"},"authentication_issues":{"type":"integer","format":"int32","description":"The number of authentication issues"},"ip_address_issues":{"type":"integer","format":"int32","description":"The number of IP address issues"},"roaming_issues":{"type":"integer","format":"int32","description":"The number of roaming issues experienced by the client"},"client_type":{"type":"string","description":"Client type","enum":["WIRELESS","THREAD"]},"is_mlo":{"type":"boolean","description":"boolean to determine mlo ot not"},"mlo_bands":{"type":"array","description":"supports mlo bands","items":{"type":"string"}},"mlo_mode":{"type":"string","description":"MLO (Multi-Link Operation) mode","enum":["STR","eMLSR","MLSR","eMLMR","NSTR"]},"rtts_supported":{"type":"boolean","description":"Indicates if RTTS is supported"},"connected_device_hostname":{"type":"string","description":"Connected Device Hostname"},"connection_status":{"$ref":"#/components/schemas/XiqClientConnectionStatus","description":"The current connection status of the client"},"last_session_start_time":{"type":"integer","format":"int32","description":"The start time of the last session (int64 epoch in milliseconds)","example":1622548800000},"operating_system":{"type":"string","description":"The operating system of the client device"},"client_mac":{"type":"string","description":"The MAC address in format 'AABBCCDDEEFF' without separators. Accepted formats: (1) OUI only — first 6 hex characters (e.g., 'AABBCC'), (2) Full MAC address — 12 hex characters (e.g., 'AABBCCDDEEFF').","example":"AABBCCDDEEFF"}}},"XiqClientHealthFrequencyDistribution":{"type":"object","description":"Wireless clients count with frequency distribution","properties":{"total_clients":{"type":"integer","format":"int64","description":"The total number of clients"},"wired":{"type":"integer","format":"int64","description":"The number of clients using the wired frequency band"},"thread":{"type":"integer","format":"int64","description":"The number of clients using the thread frequency band"},"clients_2dot4_g_hz":{"type":"integer","format":"int64","description":"The number of clients using the 2.4 GHz frequency band"},"clients_5_g_hz":{"type":"integer","format":"int64","description":"The number of clients using the 5 GHz frequency band"},"clients_6_g_hz":{"type":"integer","format":"int64","description":"The number of clients using the 6 GHz frequency band"}}},"XiqWirelessClientHealthGridFilterMetadata":{"type":"object","properties":{"connection_status":{"type":"array","description":"The unique identifier of the filter metadata","items":{"type":"string"}},"frequency":{"type":"array","description":"The unique identifier of the filter metadata","items":{"type":"string"}},"ssid":{"type":"array","description":"The unique identifier of the filter metadata","items":{"type":"string"}},"os":{"type":"array","description":"The unique identifier of the filter metadata","items":{"type":"string"}},"authentication":{"type":"array","description":"The unique identifier of the filter metadata","items":{"type":"string"}},"encryption":{"type":"array","description":"The unique identifier of the filter metadata","items":{"type":"string"}},"user_profile":{"type":"array","description":"The unique identifier of the filter metadata","items":{"type":"string"}},"category_assignment":{"type":"array","description":"The unique identifier of the filter metadata","items":{"type":"string"}},"client_type":{"type":"array","description":"unique identifier of the filter metadata","items":{"type":"string"}}}},"XiqClientHealthConnectivityIssues":{"type":"object","description":"Wireless clients count with connectivity issues","properties":{"total_clients":{"type":"integer","format":"int64","description":"The total number of clients"},"association_failures":{"type":"integer","format":"int64","description":"The number of failed or slow associations (where slow is defined as >= 5 seconds)"},"authentication_failures":{"type":"integer","format":"int64","description":"The number of failed or slow authentications (where slow is defined as >= 5 seconds)"},"ip_address_issues":{"type":"integer","format":"int64","description":"The number of DHCP issues, including private IP address assignments or slow responses (where slow is defined as >= 5 seconds)"}}},"XiqWiredUsageCapacityThroughputRequest":{"type":"object","description":"Request body for Wired Usage and Capacity - Wired Throughput widget","properties":{"site_ids":{"type":"array","description":"List of site IDs to filter wired throughput data","items":{"type":"integer","format":"int64"}}}},"XiqWiredUsageCapacityThroughputResponse":{"type":"object","description":"Response body for Wired Usage and Capacity - Wired Throughput widget","properties":{"total_packets_count":{"type":"integer","format":"int64","description":"Total number of packets"},"unicast_utilization_percentage":{"type":"integer","format":"int32","description":"Percentage of unicast packets from total number of packets"},"multicast_utilization_percentage":{"type":"integer","format":"int32","description":"Percentage of multicast packets from total number of packets"},"broadcast_utilization_percentage":{"type":"integer","format":"int32","description":"Percentage of broadcast packets from total number of packets"}}},"XiqWiredUsageCapacityCongestionResponse":{"type":"object","description":"Response body for Wired Usage and Capacity - Wired Congestion widget","properties":{"total_queue_tx_packets":{"type":"integer","format":"int64","description":"Total number of transmitted packets on all QOS queues"},"total_queue_congestion_packets":{"type":"integer","format":"int64","description":"Total number of packets dropped due to congestion on all QOS queues"},"total_congestion_percentage":{"type":"integer","format":"int64","description":"Percentage of packets dropped due to congestion vs total number of transmitted packets on all QOS queues"}}},"XiqWiredUsageCapacityUsageUtilizationRequest":{"type":"object","description":"Request body for Wired Usage and Capacity - Usage Utilization widget","properties":{"site_ids":{"type":"array","description":"List of site IDs to filter usage utilization data","items":{"type":"integer","format":"int64"}}}},"XiqWiredUsageCapacityUsageUtilizationResponse":{"type":"object","description":"Response body for Wired Usage and Capacity - Usage Utilization widget","properties":{"total_bandwidth_utilized":{"type":"integer","format":"int64","description":"Total utilized bandwidth in Bytes"}}},"XiqWiredUsageAndCapacitySortField":{"type":"string","enum":["UNSPECIFIED","DEVICE_HOSTNAME","DEVICE_IP","SITE","TOTAL_CLIENTS_COUNT","TOTAL_ISSUE_CLIENTS_COUNT","TOTAL_BANDWIDTH_UTILIZED","TOTAL_THROUGHPUT_RX","TOTAL_THROUGHPUT_TX","TOTAL_UNICAST_PACKETS","TOTAL_MULTICAST_PACKETS","TOTAL_BROADCAST_PACKETS","TOTAL_QUEUE_TX_PKTS","TOTAL_QUEUE_CONGESTION_PKTS"]},"XiqWiredUsageAndCapacityFilterType":{"type":"string","enum":["UNSPECIFIED","TOTAL_QUEUE_CONGESTION_PKTS"]},"XiqWiredUsageCapacityGridRequest":{"type":"object","description":"Request body for Wired Usage and Capacity grid","properties":{"site_ids":{"type":"array","description":"List of site IDs to filter usage and capacity grid","items":{"type":"integer","format":"int64"}},"device_ids":{"type":"array","description":"List of device IDs to filter usage and capacity grid","items":{"type":"integer","format":"int64"}},"filter_field":{"type":"array","description":"The filters available for usage and capacity grid","items":{"$ref":"#/components/schemas/XiqWiredUsageAndCapacityFilterType"}}}},"PagedXiqWiredUsageCapacityGridResponse":{"type":"object","properties":{"page":{"type":"integer","format":"int32","description":"The current page number"},"count":{"type":"integer","format":"int32","description":"The element count of the current page"},"total_pages":{"type":"integer","format":"int32","description":"The total page number based on request page size"},"total_count":{"type":"integer","format":"int64","description":"The total element count"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqWiredUsageCapacityGridResponse"}}},"required":["count","page","total_count","total_pages"]},"XiqWiredUsageCapacityGridResponse":{"type":"object","description":"Response body for Wired Usage and Capacity grid","properties":{"device_id":{"type":"integer","format":"int64","description":"The unique device identifier"},"device_hostname":{"type":"string","description":"The hostname of the device"},"device_ip":{"type":"string","description":"The IP address of the device"},"is_stack":{"type":"boolean","description":"Indicates whether the device is a stack or not"},"site":{"type":"string","description":"Site location of the device"},"building":{"type":"string","description":"The building where the device is located"},"floor":{"type":"string","description":"The floor where the device is located"},"total_clients_count":{"type":"integer","format":"int64","description":"Total number of clients of the device"},"total_issue_clients_count":{"type":"integer","format":"int64","description":"Total number of clients with issues of the device"},"total_bandwidth_utilized":{"type":"integer","format":"int64","description":"Total utilized bandwidth in Bytes"},"total_throughput_rx":{"type":"integer","format":"int64","description":"Total Rx throughput in packets per second"},"total_throughput_tx":{"type":"integer","format":"int64","description":"Total Tx throughput in packets per second"},"total_unicast_pkts":{"type":"integer","format":"int32","description":"The percentage of unicast packets from total number of packets"},"total_multicast_pkts":{"type":"integer","format":"int32","description":"The percentage of multicast packets from total number of packets"},"total_broadcast_pkts":{"type":"integer","format":"int32","description":"The percentage of broadcast packets from total number of packets"},"total_queue_tx_pkts":{"type":"integer","format":"int64","description":"Total number of transmitted packets on all QOS queues"},"total_queue_congestion_pkts":{"type":"integer","format":"int64","description":"Total number of packets dropped due to congestion on all QOS queues"},"total_packets_count":{"type":"integer","format":"int64","description":"Total number of unicast, multicast and broadcast packets"}}},"XiqWiredDeviceHealthTemperatureStatusResponse":{"type":"object","description":"Response body for the Wired Device Health Temperature Status","properties":{"devices":{"type":"array","description":"The list contains a single element for standalone devices and multiple elements for each member of a stack","items":{"$ref":"#/components/schemas/XiqWiredDeviceHealthTemperatureStatusResponseEntry"}}}},"XiqWiredDeviceHealthTemperatureStatusResponseEntry":{"type":"object","description":"The description of the temperature status response for a device","properties":{"slot_number":{"type":"string","format":"byte","description":"The slot number of the device (0 for standalone)"},"temperature":{"type":"integer","format":"int32","description":"The temperature of the device"}}},"XiqWiredDeviceHealthTempRequest":{"type":"object","description":"Request body for the Wired Device Health Temperature Issues widget","properties":{"site_ids":{"type":"array","description":"List of site IDs to filter wired devices","items":{"type":"integer","format":"int64"}}}},"XiqWiredDeviceHealthTempResponse":{"type":"object","description":"Response body for the Wired Device Health Temperature Issues widget","properties":{"temperature_issue_device_count":{"type":"integer","format":"int64","description":"The total number of devices with temperature issues"}}},"XiqWiredDeviceHealthSummaryRequest":{"type":"object","description":"Request body for the Wired Device Health Summary widget","properties":{"site_ids":{"type":"array","description":"List of site IDs to filter wired devices","items":{"type":"integer","format":"int64"}}}},"XiqWiredDeviceHealthSummaryResponse":{"type":"object","description":"Response body for the Wired Device Health Summary widget","properties":{"wired_devices":{"type":"integer","format":"int64","description":"The total number of wired devices"},"wired_unhealthy_devices":{"type":"integer","format":"int64","description":"The total number of wired devices with health issues"}}},"XiqWiredDeviceHealthPsuStatus":{"type":"object","description":"The PSU status","properties":{"psu_description":{"type":"string","description":"The PSU description"},"psu_status":{"type":"string","description":"The PSU status"}}},"XiqWiredDeviceHealthPsuStatusResponse":{"type":"object","description":"Response body for the Wired Device Health PSU Status","properties":{"devices":{"type":"array","description":"The list contains a single element for standalone devices and multiple elements for each member of a stack","items":{"$ref":"#/components/schemas/XiqWiredDeviceHealthPsuStatusResponseEntry"}}}},"XiqWiredDeviceHealthPsuStatusResponseEntry":{"type":"object","description":"The description of the PSU status response for a device","properties":{"slot_number":{"type":"string","format":"byte","description":"The slot number of the device (0 for standalone)"},"psu_status_error":{"type":"string","format":"byte","description":"The number of PSUs that are not operating correctly"},"psu_total":{"type":"string","format":"byte","description":"The total number of PSUs"},"psu_units":{"type":"array","description":"The list of PSUs with their corresponding status","items":{"$ref":"#/components/schemas/XiqWiredDeviceHealthPsuStatus"}}}},"XiqWiredDeviceHealthPsuRequest":{"type":"object","description":"Request body for the Wired Device Health PSU Issues widget","properties":{"site_ids":{"type":"array","description":"List of site IDs to filter wired devices","items":{"type":"integer","format":"int64"}}}},"XiqWiredDeviceHealthPsuResponse":{"type":"object","description":"Response body for the Wired Device Health PSU Issues widget","properties":{"psu_status_issue_device_count":{"type":"integer","format":"int64","description":"The total number of devices with PSU issues"}}},"XiqWiredDeviceHealthPoeUsageStatusResponse":{"type":"object","description":"Response body for the Wired Device Health PoE Usage Status","properties":{"devices":{"type":"array","description":"The list contains a single element for standalone devices and multiple elements for each member of a stack","items":{"$ref":"#/components/schemas/XiqWiredDeviceHealthPoeUsageStatusResponseEntry"}}}},"XiqWiredDeviceHealthPoeUsageStatusResponseEntry":{"type":"object","description":"The description of the PoE status response for a device","properties":{"slot_number":{"type":"string","format":"byte","description":"The slot number of the device (0 for standalone)"},"poe_usage":{"type":"integer","format":"int32","description":"The PoE usage percentage of the device"}}},"XiqWiredDeviceHealthPoeRequest":{"type":"object","description":"Request body for the Wired Device Health PoE Usage Issues widget","properties":{"site_ids":{"type":"array","description":"List of site IDs to filter wired devices","items":{"type":"integer","format":"int64"}}}},"XiqWiredDeviceHealthPoeResponse":{"type":"object","description":"Response body for the Wired Device Health PoE Usage Issues widget","properties":{"poe_usage_issue_device_count":{"type":"integer","format":"int64","description":"The total number of devices with PoE usage issues"}}},"XiqWiredDeviceHealthMemRequest":{"type":"object","description":"Request body for the Wired Device Health Memory Usage Issues widget","properties":{"site_ids":{"type":"array","description":"List of site IDs to filter wired devices","items":{"type":"integer","format":"int64"}}}},"XiqWiredDeviceHealthMemResponse":{"type":"object","description":"Response body for the Wired Device Health Memory Usage Issues widget","properties":{"memory_usage_issue_device_count":{"type":"integer","format":"int64","description":"The total number of wired devices with memory usage issues"}}},"XiqWiredDeviceHealthSortField":{"type":"string","enum":["UNSPECIFIED","HOSTNAME","SITE","CPU","MEM","TEMP","POE","FAN","PSU"]},"XiqWiredDeviceHealthFilterField":{"type":"string","enum":["UNSPECIFIED","CPU","MEM","TEMP","POE","FAN","PSU","HEALTH"]},"XiqWiredDeviceHealthGridRequest":{"type":"object","description":"Request body for the Wired Device Health grid","properties":{"site_ids":{"type":"array","description":"List of site IDs to filter the Wired Device Health grid","items":{"type":"integer","format":"int64"}},"device_ids":{"type":"array","description":"List of device IDs to filter the Wired Device Health grid","items":{"type":"integer","format":"int64"}},"filter_field":{"type":"array","description":"The filters available for the Wired Device Health grid","items":{"$ref":"#/components/schemas/XiqWiredDeviceHealthFilterField"}}}},"PagedXiqWiredDeviceHealthGridResponse":{"type":"object","properties":{"page":{"type":"integer","format":"int32","description":"The current page number"},"count":{"type":"integer","format":"int32","description":"The element count of the current page"},"total_pages":{"type":"integer","format":"int32","description":"The total page number based on request page size"},"total_count":{"type":"integer","format":"int64","description":"The total element count"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqWiredDeviceHealthGridResponse"}}},"required":["count","page","total_count","total_pages"]},"XiqWiredDeviceHealthGridResponse":{"type":"object","description":"Response body for the Wired Device Health grid","properties":{"device_id":{"type":"integer","format":"int64","description":"The id of the device"},"stack_size":{"type":"string","format":"byte","description":"The number of devices in the stack (0 for standalone devices)"},"device_hostname":{"type":"string","description":"The hostname of the device"},"device_ip":{"type":"string","description":"The IP address of the device"},"site":{"type":"string","description":"The site where the device is located"},"building":{"type":"string","description":"The building where the device is located"},"floor":{"type":"string","description":"The floor where the device is located"},"cpu_usage":{"type":"string","format":"byte","description":"CPU usage percentage of the device"},"memory_usage":{"type":"string","format":"byte","description":"Memory usage percentage of the device"},"temperature":{"type":"integer","format":"int32","description":"The temperature of the device"},"temperature_error_slots":{"type":"string","format":"byte","description":"Indicates the number of the stack slots that have temperature errors/if a standalone device has temperature errors"},"poe_usage":{"type":"string","format":"byte","description":"The PoE usage percentage of the device"},"poe_error_slots":{"type":"string","format":"byte","description":"Indicates the number of the stack slots that have PoE errors/if a standalone device has PoE errors"},"fan_error_slots":{"type":"string","format":"byte","description":"Indicates the number of the stack slots that have fan errors/if a standalone device has fan errors"},"psu_error_slots":{"type":"string","format":"byte","description":"Indicates the number of the stack slots that have PSU errors/if a standalone device has PSU errors"}}},"XiqWiredDeviceHealthFanStatus":{"type":"object","description":"The fan status","properties":{"fan_description":{"type":"string","description":"The fan description"},"fan_status":{"type":"string","description":"The fan status"}}},"XiqWiredDeviceHealthFanStatusResponse":{"type":"object","description":"Response body for the Wired Device Health Fan Status","properties":{"devices":{"type":"array","description":"The list contains a single element for standalone devices and multiple elements for each member of a stack","items":{"$ref":"#/components/schemas/XiqWiredDeviceHealthFanStatusResponseEntry"}}}},"XiqWiredDeviceHealthFanStatusResponseEntry":{"type":"object","description":"The description of the fan status response for a device","properties":{"slot_number":{"type":"string","format":"byte","description":"The slot number of the device (0 for standalone)"},"fan_status_error":{"type":"string","format":"byte","description":"The number of fans that are not operating correctly"},"fan_total":{"type":"string","format":"byte","description":"The total number of fans"},"fan_units":{"type":"array","description":"The list of fans with their corresponding status","items":{"$ref":"#/components/schemas/XiqWiredDeviceHealthFanStatus"}}}},"XiqWiredDeviceHealthFanRequest":{"type":"object","description":"Request body for the Wired Device Health Fan Issues widget","properties":{"site_ids":{"type":"array","description":"List of site IDs to filter wired devices","items":{"type":"integer","format":"int64"}}}},"XiqWiredDeviceHealthFanResponse":{"type":"object","description":"Response body for the Wired Device Health Fan Issues widget","properties":{"fan_status_issue_device_count":{"type":"integer","format":"int64","description":"The total number of devices with Fan issues"}}},"XiqWiredDeviceHealthCpuRequest":{"type":"object","description":"Request body for the Wired Device Health CPU Usage Issues widget","properties":{"site_ids":{"type":"array","description":"List of site IDs to filter wired devices","items":{"type":"integer","format":"int64"}}}},"XiqWiredDeviceHealthCpuResponse":{"type":"object","description":"Response body for the Wired Device Health CPU Usage Issues widget","properties":{"cpu_usage_issue_device_count":{"type":"integer","format":"int64","description":"The total number of wired devices with CPU usage issues"}}},"XiqWiredClientHealthTrafficAnomaliesRequest":{"type":"object","properties":{"site_ids":{"type":"array","description":"The site ids","items":{"type":"integer","format":"int64"}},"device_ids":{"type":"array","description":"The device ids","items":{"type":"integer","format":"int64"}}}},"XiqWiredClientHealthTrafficAnomaliesResponse":{"type":"object","properties":{"total_clients":{"type":"integer","format":"int64","description":"The total number of clients"},"anomalies":{"type":"integer","format":"int64","description":"The number of clients with traffic anomalies"},"healthy":{"type":"integer","format":"int64","description":"The number of healthy client that do not have traffic anomalies"}}},"XiqWiredClientHealthPortErrorsRequest":{"type":"object","properties":{"site_ids":{"type":"array","description":"The site ids","items":{"type":"integer","format":"int64"}},"device_ids":{"type":"array","description":"The device ids","items":{"type":"integer","format":"int64"}}}},"XiqWiredClientHealthPortErrorsResponse":{"type":"object","properties":{"total_clients":{"type":"integer","format":"int64","description":"The total number of clients"},"port_errors":{"type":"integer","format":"int64","description":"The number of clients with port errors"},"healthy":{"type":"integer","format":"int64","description":"The number of healthy client that do not have port errors"}}},"XiqWiredClientHealthPortCongestionRequest":{"type":"object","properties":{"site_ids":{"type":"array","description":"The site ids","items":{"type":"integer","format":"int64"}},"device_ids":{"type":"array","description":"The device ids","items":{"type":"integer","format":"int64"}}}},"XiqWiredClientHealthPortCongestionResponse":{"type":"object","properties":{"total_clients":{"type":"integer","format":"int64","description":"The total number of clients"},"congestion":{"type":"integer","format":"int64","description":"The number of clients with port congestion issues"},"healthy":{"type":"integer","format":"int64","description":"The number of healthy client that do not have port congestion issues"}}},"XiqWiredClientHealthIpConnectivityIssuesRequest":{"type":"object","properties":{"site_ids":{"type":"array","description":"The site ids","items":{"type":"integer","format":"int64"}},"device_ids":{"type":"array","description":"The device ids","items":{"type":"integer","format":"int64"}}}},"XiqWiredClientHealthIpConnectivityIssuesResponse":{"type":"object","properties":{"total_clients":{"type":"integer","format":"int64","description":"The total number of clients"},"unassigned_ip":{"type":"integer","format":"int64","description":"The number of clients with unassigned IPs"},"self_assigned_ip":{"type":"integer","format":"int64","description":"The number of clients with self assigned IPs"},"valid_ip":{"type":"integer","format":"int64","description":"The number of clients with valid IPs"}}},"XiqWiredClientHealthSortField":{"type":"string","enum":["UNSPECIFIED","CONNECTION_STATUS","CLIENT_HOSTNAME","SITE","BUILDING","FLOOR","IPV4","IPV6","PORT_NUMBER","PORT_NUMBER_SWITCH_NAME","VLAN","OPERATING_SYSTEM","MAC","USERNAME","INSTANT_PORT_PROFILE","TOTAL_CONGESTION","TOTAL_UNICAST","TOTAL_MULTICAST","TOTAL_BROADCAST","TOTAL_PORT_ERRORS"]},"XiqWiredClientHealthFilter":{"type":"string","enum":["IP_CONNECTIVITY_ISSUES_UNASSIGNED_IP","IP_CONNECTIVITY_ISSUES_SELF_ASSIGNED_IP","IP_CONNECTIVITY_ISSUES_VALID_IP","PORT_CONGESTION_UNHEALTHY","PORT_CONGESTION_HEALTHY","TRAFFIC_ANOMALIES_UNHEALTHY","TRAFFIC_ANOMALIES_HEALTHY","PORT_ERRORS_UNHEALTHY","PORT_ERRORS_HEALTHY","CLIENT_UNHEALTHY"]},"XiqWiredClientHealthGridRequest":{"type":"object","description":"Request body for Wired Client Grid","properties":{"site_ids":{"type":"array","description":"The site ids","items":{"type":"integer","format":"int64"}},"device_ids":{"type":"array","description":"The device ids","items":{"type":"integer","format":"int64"}},"filter_field":{"type":"array","description":"The filters available for client health grid","items":{"$ref":"#/components/schemas/XiqWiredClientHealthFilter"}}}},"PagedXiqWiredClientHealthGridResponse":{"type":"object","properties":{"page":{"type":"integer","format":"int32","description":"The current page number"},"count":{"type":"integer","format":"int32","description":"The element count of the current page"},"total_pages":{"type":"integer","format":"int32","description":"The total page number based on request page size"},"total_count":{"type":"integer","format":"int64","description":"The total element count"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqWiredClientHealthGridResponse"}}},"required":["count","page","total_count","total_pages"]},"XiqWiredClientHealthGridResponse":{"type":"object","description":"Response for Wired Client Grid","properties":{"connection_status":{"$ref":"#/components/schemas/XiqClientConnectionStatus","description":"The current connection status of the client"},"client_hostname":{"type":"string","description":"The hostname of the client"},"client_ip":{"type":"string","format":"ipv4","description":"The IP address of the client","example":"10.16.172.199"},"site":{"type":"string","description":"The site where the client is located"},"building":{"type":"string","description":"The building where the client is located"},"floor":{"type":"string","description":"The floor where the client is located"},"ipv4":{"type":"string","format":"ipv4","description":"The IPv4 address assigned to the client","example":"10.16.172.199"},"ipv6":{"type":"string","format":"ipv6","description":"The IPv6 address assigned to the client","example":"0:0:0:0:0:0:0:0"},"port_number":{"type":"string","description":"The port number on which the device is connected"},"switch_name":{"type":"string","description":"The switch name of the connected device"},"vlan":{"type":"integer","format":"int32","description":"The VLAN"},"operating_system":{"type":"string","description":"The operating system of the client device"},"mac":{"type":"string","description":"The MAC address of the client device in format XXXXXXXXXXXX","example":"001122334455"},"username":{"type":"string","description":"The username of the client"},"instant_port_profile":{"type":"string","description":"The Instant Port Profile type assignment to client"},"total_congestion_packets":{"type":"integer","format":"int64","description":"The total congestion packets"},"total_unicast_packets_percentage":{"type":"integer","format":"int32","description":"The total unicast packets percentage","example":75.25,"maximum":100,"minimum":0},"total_multicast_packets_percentage":{"type":"integer","format":"int32","description":"The total multicast packets percentage","example":75.25,"maximum":100,"minimum":0},"total_broadcast_packets_percentage":{"type":"integer","format":"int32","description":"The total broadcast packets percentage","example":75.25,"maximum":100,"minimum":0},"total_port_errors":{"type":"integer","format":"int64","description":"The total port errors"},"has_ip_address_issues":{"type":"boolean","description":"Indicates if there are IP address issues (related to UI tooltip)"},"has_port_congestions":{"type":"boolean","description":"Indicates if there are port congestions (related to UI tooltip)"},"has_traffic_anomalies":{"type":"boolean","description":"Indicates if there are traffic anomalies (related to UI tooltip)"},"has_port_errors":{"type":"boolean","description":"Indicates if there are port errors (related to UI tooltip)"},"device_id":{"type":"integer","format":"int64","description":"The device to which client is connected"},"client_id":{"type":"integer","format":"int64","description":"The client ID"},"is_ap_eth_client":{"type":"boolean","description":"Indicates if it is a AP eth connected client"}}},"XiqUsageAndCapacityDashboard":{"type":"object","description":"The usage and capacity diagnostic data for total devices, wired devices like AP, and wireless devices like switch.","properties":{"total_usage_and_capacity_issues":{"type":"integer","format":"int64","description":"Total count of usage and capacity issues"},"wired_usage_and_capacity_issues":{"type":"integer","format":"int64","description":"Count of wired devices like switch with usage and capacity issues"},"wireless_usage_and_capacity_issues":{"type":"integer","format":"int64","description":"Count of wireless devices like APs with usage and capacity issues"}}},"PagedXiqSiteDashboardResponse":{"type":"object","properties":{"page":{"type":"integer","format":"int32","description":"The current page number"},"count":{"type":"integer","format":"int32","description":"The element count of the current page"},"total_pages":{"type":"integer","format":"int32","description":"The total page number based on request page size"},"total_count":{"type":"integer","format":"int64","description":"The total element count"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqSiteDashboardResponse"}}},"required":["count","page","total_count","total_pages"]},"XiqAlertDashboard":{"type":"object","description":"The diagnostic alert counts for critical, warning, information, and unacknowledged alerts.","properties":{"critical":{"type":"integer","format":"int64","description":"Count of critical alerts"},"warning":{"type":"integer","format":"int64","description":"Count of warning alerts"},"information":{"type":"integer","format":"int64","description":"Count of informational alerts"},"total_unacknowledged":{"type":"integer","format":"int64","description":"Total count of unacknowledged alerts"}}},"XiqAssetDashboard":{"type":"object","description":"The asset diagnostic data for total, offline, wired, and wireless offline devices.","properties":{"total_devices":{"type":"integer","format":"int64","description":"Total count of devices"},"total_offline_devices":{"type":"integer","format":"int64","description":"Total count of offline devices"},"wired_offline_devices":{"type":"integer","format":"int64","description":"Count of wired offline devices"},"wireless_offline_devices":{"type":"integer","format":"int64","description":"Count of wireless offline devices"}}},"XiqClientHealthDashboard":{"type":"object","description":"The client health diagnostic data for total clients, unhealthy clients, wired, and wireless unhealthy clients.","properties":{"total_clients":{"type":"integer","format":"int64","description":"Total count of clients"},"total_unhealthy_clients":{"type":"integer","format":"int64","description":"Total count of unhealthy clients"},"wired_unhealthy_clients":{"type":"integer","format":"int64","description":"Count of wired unhealthy clients"},"wireless_unhealthy_clients":{"type":"integer","format":"int64","description":"Count of wireless unhealthy clients"}}},"XiqDeviceHealthDashboard":{"type":"object","description":"The device health diagnostic data for total, unhealthy, wired, and wireless unhealthy devices.","properties":{"total_devices":{"type":"integer","format":"int64","description":"Total count of devices"},"total_unhealthy_devices":{"type":"integer","format":"int64","description":"Total count of unhealthy devices"},"wired_unhealthy_devices":{"type":"integer","format":"int64","description":"Count of wired unhealthy devices"},"wireless_unhealthy_devices":{"type":"integer","format":"int64","description":"Count of wireless unhealthy devices"}}},"XiqSiteDashboardResponse":{"type":"object","description":"The diagnostics information for each site.","properties":{"site_name":{"type":"string","description":"The name of the site with diagnostics"},"building_name":{"type":"string","description":"The name of the building with diagnostics"},"floor_name":{"type":"string","description":"The name of the floor with diagnostics"},"alert_dashboard":{"$ref":"#/components/schemas/XiqAlertDashboard","description":"Alerts diagnostics of the site"},"asset_dashboard":{"$ref":"#/components/schemas/XiqAssetDashboard","description":"Assets diagnostics of the site"},"client_health_dashboard":{"$ref":"#/components/schemas/XiqClientHealthDashboard","description":"Client Health diagnostics of the site"},"device_health_dashboard":{"$ref":"#/components/schemas/XiqDeviceHealthDashboard","description":"Device Health diagnostics of the site"},"usage_and_capacity_dashboard":{"$ref":"#/components/schemas/XiqUsageAndCapacityDashboard","description":"Usage and Capacity diagnostics of the site"}}},"XiqD360Filter":{"type":"object","description":"Request body for Surrounding aps filter","properties":{"number_filters":{"type":"array","description":"List of number filters","items":{"$ref":"#/components/schemas/XiqD360NumberFilter"}},"ssids":{"type":"array","description":"List of ssids","items":{"type":"string"}}}},"XiqD360FilterType":{"type":"string","enum":["GT","GTE","LT","LTE","EQ","NEQ","BTW","BLANK","NOT_BLANK"]},"XiqD360NumberFilter":{"type":"object","description":"Number Filter","properties":{"column_name":{"type":"string","description":"The column name"},"filter_type":{"$ref":"#/components/schemas/XiqD360FilterType","description":"The filter type"},"value":{"type":"integer","format":"int64","description":"The value"},"min":{"type":"integer","format":"int64","description":"The minimum value"},"max":{"type":"integer","format":"int64","description":"The maximum value"}}},"PagedXiqSurroundingAps":{"type":"object","properties":{"page":{"type":"integer","format":"int32","description":"The current page number"},"count":{"type":"integer","format":"int32","description":"The element count of the current page"},"total_pages":{"type":"integer","format":"int32","description":"The total page number based on request page size"},"total_count":{"type":"integer","format":"int64","description":"The total element count"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqSurroundingAps"}}},"required":["count","page","total_count","total_pages"]},"XiqSurroundingAps":{"type":"object","properties":{"mac":{"type":"string","description":"The value of mac address"},"ssid":{"type":"string","description":"The value of ssid"},"channel_width":{"type":"string","description":"The value of channelwidth"},"rssi":{"type":"integer","format":"int32","description":"The value of rssi"},"mode":{"type":"string","description":"The mode"},"ap_type":{"type":"integer","format":"int64","description":"The value of apType"},"is_extreme_device":{"type":"string","description":"The value of isExtremeDevice"},"channel_utilization":{"type":"integer","format":"int64","description":"The value of channelUtilization"},"channel_crc_rate":{"type":"string","description":"The value of channelCrcRate"},"client_num":{"type":"integer","format":"int64","description":"The value of number of clients"}}},"XiqD360ClientGridFilterRequest":{"type":"object","description":"D360 Client Grid Filter Request","properties":{"number_filter":{"type":"array","description":"The health status","items":{"$ref":"#/components/schemas/XiqD360NumberFilter"}},"alias":{"type":"array","description":"The aliases","items":{"type":"string"}},"auth_methods":{"type":"array","description":"The authentication methods","items":{"type":"string"}},"encryption_methods":{"type":"array","description":"The encryption methods","items":{"type":"string"}},"operating_systems":{"type":"array","description":"The operating systems","items":{"type":"string"}},"ssids":{"type":"array","description":"The SSIDs","items":{"type":"string"}},"user_profiles":{"type":"array","description":"The user profile names","items":{"type":"string"}},"frequency":{"type":"array","description":"The frequency","items":{"type":"string"}},"category_assignments":{"type":"array","description":"The category assignments","items":{"type":"string"}},"client_type":{"type":"array","description":"The client type","items":{"type":"string"}}}},"PagedXiqClientStatsGridRow":{"type":"object","properties":{"page":{"type":"integer","format":"int32","description":"The current page number"},"count":{"type":"integer","format":"int32","description":"The element count of the current page"},"total_pages":{"type":"integer","format":"int32","description":"The total page number based on request page size"},"total_count":{"type":"integer","format":"int64","description":"The total element count"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqClientStatsGridRow"}}},"required":["count","page","total_count","total_pages"]},"XiqClientStatsGridRow":{"type":"object","description":"The D360 client grid","properties":{"connection_status":{"type":"boolean","description":"The current connection status of the client"},"client_hostname":{"type":"string","description":"The hostname of the client"},"client_ip":{"type":"string","format":"ipv4 or ipv6","description":"The IP address of the client","example":"2001:db8:85a3::8a2e:370:7334"},"site":{"type":"string","description":"The site where the client is located"},"building":{"type":"string","description":"The building where the client is located"},"floor":{"type":"string","description":"The floor where the client is located"},"association_issues":{"type":"integer","format":"int64","description":"The number of association issues"},"authentication_issues":{"type":"integer","format":"int64","description":"The number of authentication issues"},"ip_address_issues":{"type":"integer","format":"int64","description":"The number of IP address issues"},"snr":{"type":"integer","format":"int32","description":"Signal-to-noise ratio of the client's connection in dB (decibels)","example":40},"rssi":{"type":"integer","format":"int32","description":"Received signal strength indicator of the client's connection in dBm (decibels-milliwatts)","example":-65},"channel_utilization_score":{"type":"integer","format":"int32","description":"The percentage of channel utilization (0-100%)","example":75},"frequency":{"type":"string","description":"The frequency band used by the client (e.g., 2.4 GHz, 5 GHz, 6 GHz)"},"roaming_issues":{"type":"integer","format":"int64","description":"The number of roaming issues experienced by the client"},"ipv4":{"type":"string","format":"ipv4","description":"The IPv4 address assigned to the client","example":"192.168.1.1"},"connected_device_mac":{"type":"string","format":"string","description":"The MAC address of the connected device (accepted formats: 12 hex characters without delimiters, or colon-separated or hyphen-separated)","example":"001122334455"},"ssid":{"type":"string","description":"The SSID of the network"},"vlan":{"type":"integer","format":"int64","description":"The VLAN ID"},"username":{"type":"string","description":"The username of the client"},"authentication":{"type":"string","description":"The authentication method used"},"encryption":{"type":"string","description":"The encryption method used"},"user_profile":{"type":"string","description":"The user profile assigned to the client"},"alias":{"type":"string","description":"The alias of the client"},"category_assignment":{"type":"string","description":"The category assignment of the client"},"ipv6":{"type":"string","format":"ipv6","description":"The IPv6 address assigned to the client","example":"2001:db8:85a3::8a2e:370:7334"},"client_device_id":{"type":"integer","format":"int64","description":"The client device ID"},"device_id":{"type":"integer","format":"int64","description":"The device ID"},"client_type":{"type":"string","description":"the client type"},"is_mlo":{"type":"boolean","description":"boolean to determine mlo ot not"},"mlo_bands":{"type":"array","description":"supports mlo bands","items":{"type":"string"}},"mlo_mode":{"type":"string","description":"mlo mode"},"last_session_start_time":{"type":"integer","format":"int64","description":"The start time of the last session (int64 epoch in milliseconds)","example":1622548800000},"operating_system":{"type":"string","description":"The operating system of the client device"},"client_mac":{"type":"string","format":"string","description":"The MAC address of the connected device (accepted formats: 12 hex characters without delimiters, or colon-separated or hyphen-separated)","example":"001122334455"}}},"XiqClientGraphData":{"type":"object","properties":{"timestamp":{"type":"integer","format":"int64","description":"The client graph timestamp"},"unique_clients":{"type":"integer","format":"int64","description":"The client graph value for unique clients"},"connected_clients":{"type":"integer","format":"int64","description":"The client graph value for connected clients"},"poor_health_clients":{"type":"integer","format":"int64","description":"The client graph value for poor clients"}}},"XiqCredentialDistributionGroupCreateRequest":{"type":"object","properties":{"name":{"type":"string","description":"Name of the credential distribution group."},"enable_email_approval":{"type":"boolean","description":"Flag indicating whether email approval is enabled (true) or disabled (false)."},"enable_user_limitation":{"type":"boolean","description":"Flag indicating whether user limitation is enabled (true) or disabled (false)."},"employee_group_type":{"$ref":"#/components/schemas/XiqEmployeeGroupType","description":"Employee Group Json Type"},"employee_groups":{"type":"array","description":"Array of member groups.","items":{"$ref":"#/components/schemas/XiqEmployeeGroup"}},"restrict_number":{"type":"integer","format":"int32","description":"Number restriction.","minimum":0},"user_group_ids":{"type":"array","description":"Array of user group IDs.","items":{"type":"integer","format":"int64"}}},"required":["employee_group_type","enable_email_approval","enable_user_limitation","name"]},"XiqEmployeeGroup":{"type":"object","description":" The Employee Group of Credential Distribution Group ","properties":{"name":{"type":"string","description":"The employee group name"}}},"XiqCredentialDistributionGroup":{"type":"object","description":" The Credential Distribution Group ","properties":{"id":{"type":"integer","format":"int64","description":"The unique identifier"},"create_time":{"type":"string","format":"date-time","description":"The create time in UTC (ISO 8601 format)"},"update_time":{"type":"string","format":"date-time","description":"The last update time in UTC (ISO 8601 format)"},"org_id":{"type":"integer","format":"int64","description":"The organization identifier, valid when enabling HIQ feature"},"owner_id":{"type":"integer","format":"int64","description":"The owner ID of the Credential Distribution group"},"group_type":{"type":"string","description":"The Group type"},"enable_email_approval":{"type":"boolean","description":"Whether email approval is enabled"},"enable_user_limitation":{"type":"boolean","description":"Whether user limitation is enabled"},"employee_group_type":{"$ref":"#/components/schemas/XiqEmployeeGroupType","description":"The Employee group type"},"employee_groups":{"type":"array","description":"The member employee groups","items":{"$ref":"#/components/schemas/XiqEmployeeGroup"}},"name":{"type":"string","description":"The name of the credential distribution group"},"restrict_number":{"type":"string","description":"Restriction on number of credentials per employee"},"user_groups":{"type":"array","description":"The UserGroups","items":{"$ref":"#/components/schemas/XiqCdgUserGroups"}}},"required":["create_time","id","update_time"]},"XiqExcludedVlanActionType":{"type":"string","enum":["ADD","UPDATE","DELETE"]},"XiqMissingVlanExcludedVlanDetails":{"type":"object","description":" The list of vlan and site ids ","properties":{"vlan_ids":{"type":"array","items":{"type":"integer","format":"int32"}},"site_ids":{"type":"array","items":{"type":"integer","format":"int64"}}}},"XiqMissingVlanExcludedVlanDetailsListRequest":{"type":"object","description":" The Excluded Vlan details list ","properties":{"excluded_vlan_details":{"type":"array","description":"The excluded Vlan Details","items":{"$ref":"#/components/schemas/XiqMissingVlanExcludedVlanDetails"}},"old_vlan_id":{"type":"integer","format":"int32","description":"The existing Vlan ID"},"action_type":{"$ref":"#/components/schemas/XiqExcludedVlanActionType","description":"The action type"},"dismiss":{"type":"boolean","description":"To dismiss or not"}},"required":["action_type","dismiss"]},"XiqUpdateMissingVlanExcludedVlanResponse":{"type":"object","description":"Update Missing Vlan Excluded Vlan Response","properties":{"success":{"type":"boolean","description":"success value"}}},"XiqDisconnectClientsByMacRequest":{"type":"object","description":"The client MAC address disconnect request.","properties":{"mac_addresses":{"type":"array","description":"The MAC address of the client to disconnect","items":{"type":"string"},"maxItems":10,"minItems":1}},"required":["mac_addresses"]},"XiqClientMonitorProfileRequest":{"type":"object","properties":{"name":{"type":"string","description":"The client monitor profile name","maxLength":32,"minLength":1},"description":{"type":"string","description":"The client monitor profile description","maxLength":64,"minLength":0},"association":{"$ref":"#/components/schemas/XiqClientMonitorParameters","description":"The client monitor parameters for association type problems"},"authentication":{"$ref":"#/components/schemas/XiqClientMonitorParameters","description":"The client monitor parameters for authentication type problems"},"networking":{"$ref":"#/components/schemas/XiqClientMonitorParameters","description":"The client monitor parameters for networking type problems"}},"required":["name"]},"XiqCreateClassificationRequest":{"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","format":"int64","description":"The ID of location, cloud config group, IP address, IP subnet or IP range."}},"required":["classification_type","classification_type_id","match"]},"XiqCreateClassificationRuleRequest":{"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"}}},"required":["classifications","name"]},"XiqConvertOptionType":{"type":"string","enum":["CERTIFICATE","KEY"]},"XiqCreateCertificateBundleRequest":{"type":"object","description":"The payload to create a new Certificate Bundle","properties":{"name":{"type":"string","description":"The Certificate Bundle name"},"description":{"type":"string","description":"The Certificate Bundle description"},"bundle_type":{"type":"string","description":"The Certificate Bundle type","enum":["TRUST_POINT","CA"]},"certificate_ids":{"type":"array","description":"The Certificate Bundle certificate IDs.","items":{"type":"integer","format":"int64"}}},"required":["bundle_type","certificate_ids","name"]},"XiqCreateCloudConfigGroupRequest":{"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","format":"int64"}}},"required":["name"]},"XiqCheckPermissionRequest":{"type":"object","properties":{"uri":{"type":"string","description":"The request HTTP URI"},"method":{"type":"string","description":"The request HTTP method"}},"required":["method","uri"]},"XiqCheckPermissionResponse":{"type":"object","properties":{"permissions":{"type":"array","description":"The permission list","items":{"$ref":"#/components/schemas/XiqPermission"}},"roles":{"type":"array","description":"The role list","items":{"type":"string"},"uniqueItems":true}},"required":["permissions","roles"]},"XiqPermission":{"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"}},"required":["category","description","name"]},"XiqGenerateApiTokenRequest":{"type":"object","properties":{"expire_time":{"type":"integer","format":"int64","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."},"description":{"type":"string","description":"The token description"},"permissions":{"type":"array","description":"The token permissions","items":{"type":"string"}},"rate_limit":{"$ref":"#/components/schemas/XiqRateLimitPolicy","description":"The rate limit policy for the API token"}},"required":["permissions"]},"XiqGenerateApiTokenResponse":{"type":"object","properties":{"access_token":{"type":"string","description":"The API access token"},"create_time":{"type":"string","format":"date-time","description":"The create timestamp"},"expire_time":{"type":"string","format":"date-time","description":"The expire timestamp, if null means no expiration"},"creator_id":{"type":"integer","format":"int64","description":"The user ID who created the API token"},"customer_id":{"type":"integer","format":"int64","description":"The customer ID who owns the API token"},"description":{"type":"string","description":"The description for the API token"},"permissions":{"type":"array","description":"The permissions for the API token","items":{"type":"string"}}},"required":["access_token","create_time","creator_id","customer_id","permissions"]},"XiqAfcApManualSpectrum":{"type":"object","properties":{"ids":{"type":"array","items":{"type":"integer","format":"int64"}}}},"XiqAfcApsFilterCriteria":{"type":"object","description":"Request body for filtering AFC AP summary queries ","properties":{"site_ids":{"type":"array","description":"List of siteIds","items":{"type":"integer","format":"int64"}}}},"XiqAfcApsInfoElement":{"type":"object","properties":{"total_devices":{"type":"integer","format":"int32"},"afc_status":{"$ref":"#/components/schemas/XiqAfcStatusSummary"},"geo_location":{"$ref":"#/components/schemas/XiqAfcGeolocationSummary"},"spectrum_mismatch":{"$ref":"#/components/schemas/XiqSpectrumMismatchSummary"}}},"XiqAfcGeolocationSummary":{"type":"object","properties":{"total_available":{"type":"integer","format":"int32"},"total_unavailable":{"type":"integer","format":"int32"}}},"XiqAfcStatusSummary":{"type":"object","properties":{"total_available":{"type":"integer","format":"int32"},"total_pending":{"type":"integer","format":"int32"},"total_grace_period":{"type":"integer","format":"int32"}}},"XiqSpectrumMismatchSummary":{"type":"object","properties":{"total_backup":{"type":"integer","format":"int32"},"total_radio_off":{"type":"integer","format":"int32"},"total_reduced":{"type":"integer","format":"int32"}}},"XiqAppUsageSummarySortField":{"type":"string","enum":["USAGE","PERCENTAGE_USAGE","CLIENTS","USERS","APPLICATION_NAME","CATEGORY_NAME"]},"XiqAppDataUnit":{"type":"string","enum":["BYTES","KB","MB","GB"]},"XiqAppUsageSummaryFilter":{"type":"object","description":"Request body for Application Usage Summary Filter","properties":{"site_ids":{"type":"array","description":"Filter by Site Ids","items":{"type":"integer","format":"int64"}},"application_name":{"type":"array","description":"Filter by application name","items":{"type":"string"}},"category_name":{"type":"array","description":"Filter by category (application group) name","items":{"type":"string"}},"number_filter":{"type":"array","description":"Filter by number filter","items":{"$ref":"#/components/schemas/XiqAppUsageSummaryNumberFilter"}}}},"XiqAppUsageSummaryNumberEnumFilter":{"type":"string","enum":["GT","GTE","LT","LTE","EQ","NEQ","BTW","BLANK","NOT_BLANK"]},"XiqAppUsageSummaryNumberFilter":{"type":"object","description":"Number Filter","properties":{"column_name":{"type":"string","description":"The column name"},"filter_type":{"$ref":"#/components/schemas/XiqAppUsageSummaryNumberEnumFilter","description":"The filter type"},"value":{"type":"number","format":"double","description":"The value"},"min":{"type":"number","format":"double","description":"The minimum value"},"max":{"type":"number","format":"double","description":"The maximum value"},"data_unit":{"$ref":"#/components/schemas/XiqAppDataUnit","description":"The data unit of App usage"}}},"PagedXiqAppUsageSummary":{"type":"object","properties":{"page":{"type":"integer","format":"int32","description":"The current page number"},"count":{"type":"integer","format":"int32","description":"The element count of the current page"},"total_pages":{"type":"integer","format":"int32","description":"The total page number based on request page size"},"total_count":{"type":"integer","format":"int64","description":"The total element count"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqAppUsageSummary"}}},"required":["count","page","total_count","total_pages"]},"XiqAppUsageSummary":{"type":"object","description":"The Application Usage Summary Model","properties":{"application_name":{"type":"string","description":"The application name"},"category_name":{"type":"string","description":"The category name of application"},"usage":{"type":"integer","format":"int64","description":"The application summary usage"},"percentage_usage":{"type":"number","format":"double","description":"The application summary percentage usage"},"clients":{"type":"integer","format":"int64","description":"The total number of clients"},"users":{"type":"integer","format":"int64","description":"The total number of users"}}},"XiqAppUsageSummaryExport":{"type":"object","description":"Report ID for downloading Export CSV file","properties":{"id":{"type":"string","description":"The reportId"}},"required":["id"]},"XiqGetAfcSpectrumForApRequest":{"type":"object","properties":{"owner_id":{"type":"integer","format":"int64"},"site_name":{"type":"string"},"region":{"type":"string","enum":["US","CA","UNRECOGNIZED"]},"input_info":{"type":"array","items":{"$ref":"#/components/schemas/XiqAfcInputInfo"}}}},"XiqAlertSortField":{"type":"string","description":"All available device sort fields<br/><br/>TIMESTAMP = Last Detected<br/> SOURCE = Source Name","enum":["TIMESTAMP","SOURCE"]},"XiqAlertReport":{"type":"object","description":"ExtremeCloud IQ Alert report","properties":{"id":{"type":"integer","format":"int64","description":"The alert reportId"}},"required":["id"]},"XiqAcknowledgeAlertsRequest":{"type":"object","description":"The acknowledge alert","properties":{"alert_ids":{"type":"array","description":"The alert ID list.","items":{"type":"string"}}},"required":["alert_ids"]},"XiqAlert":{"type":"object","description":"The Alert Model","properties":{"id":{"type":"string","description":"The unique identifier"},"owner_id":{"type":"integer","format":"int64","description":"The owner ID"},"timestamp":{"type":"string","format":"date-time","description":"The alert create time"},"org_id":{"type":"integer","format":"int64","description":"The organization identifier, valid when enabling HIQ feature"},"message_metadata_id":{"type":"integer","format":"int64","description":"The message metadata id"},"message_metadata_type":{"type":"string","description":"The message metadata type"},"message_metadata_name":{"type":"string","description":"The message metadata name"},"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","format":"int64","description":"The severity Id of the alert"},"category_id":{"type":"integer","format":"int64","description":"The alert category Id"},"source":{"$ref":"#/components/schemas/XiqAlertSource","description":"The alert source info"},"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","format":"int64","description":"The site id of alert"},"site_name":{"type":"string","description":"The site name of alert"},"alert_policy_id":{"type":"integer","format":"int64","description":"The policy id of alert"},"alert_policy_name":{"type":"string","description":"The policy name of alert"},"alert_rule_id":{"type":"integer","format":"int64","description":"The rule id of alert"},"acknowledged_username":{"type":"string","description":"The user's email who acknowledged"},"floor_id":{"type":"integer","format":"int64","description":"The floor id of alert"},"floor_name":{"type":"string","description":"The floor name of alert"},"building_id":{"type":"integer","format":"int64","description":"The buiding id of alert"},"building_name":{"type":"string","description":"The building name of alert"}},"required":["id","tags","timestamp"]},"XiqAlertSource":{"type":"object","properties":{"source_type_id":{"type":"integer","format":"int64","description":"The alert source type ID"},"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"}}},"XiqAlertTag":{"type":"object","description":"The Alert Tag Model","properties":{"id":{"type":"integer","format":"int64","description":"The unique identifier for the tag metadata"},"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."}},"required":["id"]},"XiqCreateAlertWebhookSubscriptionRequest":{"type":"object","description":"The alert webhook subscription create","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","format":"int64"}}},"required":["alert_policy_ids","is_subscribe_all","url"]},"XiqDeleteBulkAlertSubscriptionRequest":{"type":"object","description":"Delete bulk alert subscription request","properties":{"ids":{"type":"array","description":"The subscription ID list.","items":{"type":"integer","format":"int64"}}},"required":["ids"]},"XiqBulkDeleteWebhookSubscriptionResult":{"type":"object","description":"The result of bulk detele webhook susbscriptions","properties":{"id":{"type":"integer","format":"int64"},"url":{"type":"string"}}},"XiqBulkOperationResult":{"type":"string","enum":["SUCCESS","PARTIAL_SUCCESS"]},"XiqDeleteBulkAlertSubscriptionWebhookResponse":{"type":"object","description":"The result of bulk detele webhook susbscriptions","properties":{"result":{"$ref":"#/components/schemas/XiqBulkOperationResult"},"reason":{"type":"string"},"unresolved_deletions":{"type":"array","items":{"$ref":"#/components/schemas/XiqBulkDeleteWebhookSubscriptionResult"}}}},"XiqCreateAlertServiceNowSubscriptionRequest":{"type":"object","description":"The payload of create ServiceNow subscription.","properties":{"servicenow_account_email":{"type":"string"},"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","format":"int64"}}},"required":["alert_policy_ids","is_subscribe_all"]},"XiqBulkDeleteServiceNowSubscriptionResult":{"type":"object","description":"The result of bulk detele ServiceNow susbscriptions.","properties":{"id":{"type":"integer","format":"int64"},"email":{"type":"string"}}},"XiqDeleteBulkAlertSubscriptionServiceNowResponse":{"type":"object","description":"The result of a bulk delete for alert ServiceNow subscriptions.","properties":{"result":{"$ref":"#/components/schemas/XiqBulkOperationResult"},"reason":{"type":"string"},"unresolved_deletions":{"type":"array","items":{"$ref":"#/components/schemas/XiqBulkDeleteServiceNowSubscriptionResult"}}}},"XiqCreateAlertEmailSubscriptionRequest":{"type":"object","description":"The alert email subscription create","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","format":"int64"}}},"required":["alert_policy_ids","email","is_subscribe_all"]},"XiqBulkDeleteEmailSubscriptionResult":{"type":"object","description":"The result of bulk detele email susbscriptions","properties":{"id":{"type":"integer","format":"int64"},"email":{"type":"string"}}},"XiqDeleteBulkAlertSubscriptionEmailResponse":{"type":"object","description":"The result of bulk delete email susbscriptions","properties":{"result":{"$ref":"#/components/schemas/XiqBulkOperationResult"},"reason":{"type":"string"},"unresolved_deletions":{"type":"array","items":{"$ref":"#/components/schemas/XiqBulkDeleteEmailSubscriptionResult"}}}},"XiqDeviceRadioInfoRequest":{"type":"object","properties":{"serial_number":{"type":"string"},"airrm_id":{"type":"integer","format":"int64"}}},"XIQAirrmDeviceRadioInfo":{"type":"object","properties":{"serial_number":{"type":"string"},"device_id":{"type":"integer","format":"int64"},"ap_mac":{"type":"string"},"radio_info":{"type":"array","items":{"$ref":"#/components/schemas/XIQAirrmRadioInfo"}}}},"XIQAirrmGetDevicesRadioInfoResponse":{"type":"object","properties":{"device_radio_info":{"type":"array","items":{"$ref":"#/components/schemas/XIQAirrmDeviceRadioInfo"}}}},"XIQAirrmRadioInfo":{"type":"object","properties":{"radio_mode":{"type":"string","enum":["_11bg","_11a","_11an","_11ng","_11ac","_11ax_2g","_11ax_5g","_11ax_6g","_11be_2g","_11be_5g","_11be_6g"]},"channel_width":{"type":"integer","format":"int32"},"radio_mac":{"type":"string"}}},"XiqRmAfcDeviceListRequest":{"type":"object","description":"Request body for RM Device List","properties":{"site_ids":{"type":"array","description":"List of site ids to filter","items":{"type":"integer","format":"int64"}},"sns":{"type":"array","description":"List of device serial numbers to filter","items":{"type":"string"}},"mac_addresses":{"type":"array","description":"List of device MAC addresses to filter","items":{"type":"string"}},"hostnames":{"type":"array","description":"List of device host names to filter","items":{"type":"string"}},"power_mode":{"type":"array","description":"List of device of power mode","items":{"type":"string"}},"product_types":{"type":"array","description":"List of device product types to filter","items":{"type":"string"}},"wifi_radio":{"type":"array","description":"List of device firmware versions to filter","items":{"type":"string"}},"geo_location":{"type":"array","description":"List of country codes to filter","items":{"type":"string"}},"afc_status":{"type":"array","description":"List of entities managing the device to filter","items":{"type":"string"}}}},"PagedXiqRmAfcDevice":{"type":"object","properties":{"page":{"type":"integer","format":"int32","description":"The current page number"},"count":{"type":"integer","format":"int32","description":"The element count of the current page"},"total_pages":{"type":"integer","format":"int32","description":"The total page number based on request page size"},"total_count":{"type":"integer","format":"int64","description":"The total element count"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqRmAfcDevice"}}},"required":["count","page","total_count","total_pages"]},"XiqAfcWifiRadioSettings":{"type":"object","properties":{"afc_data_radio":{"type":"string"},"afc_data_status":{"type":"string"},"afc_data_channel":{"type":"integer","format":"int32"},"afc_data_power":{"type":"integer","format":"int32"},"afc_data_power_mode":{"type":"string"},"afc_data_radio_status":{"type":"integer","format":"int32"},"afc_data_expected_channel":{"type":"integer","format":"int32"},"afc_data_expected_power":{"type":"integer","format":"int32"},"afc_data_expire":{"type":"integer","format":"int64"}}},"XiqRmAfcDevice":{"type":"object","description":"Generic ExtremeCloud IQ RM Device List","properties":{"hostname":{"type":"string","description":"The device hostname"},"mac_address":{"type":"string","description":"The device MAC address"},"serial_number":{"type":"string","description":"The device serial number, valid for all non-HAC devices"},"product_type":{"type":"string","description":"The product type, such as AP_230, BR_100, NX9600, etc."},"xiq_rm_device_icons":{"$ref":"#/components/schemas/XiqRmDeviceIcons","description":" The display icons of the device"},"device_license_tier":{"$ref":"#/components/schemas/XiqDeviceLicenseTier","description":"The license tier of the device"},"device_license_type":{"type":"string","description":"The license type of the device","enum":["LEGACY","NAVIGATOR","PILOT","COPILOT","NONE","NA","TRIAL","NOT_REQUIRED","GRACEPERIOD","UNLICENSED","STANDARD","ADVANCED","NOT_LICENSED"]},"xiq_afc_wifi_radio_settings":{"type":"array","description":"wifi radio afc setting","items":{"$ref":"#/components/schemas/XiqAfcWifiRadioSettings"}},"locations":{"$ref":"#/components/schemas/XiqRmDeviceLocationDetails","description":"The location legend details for the device"},"geo_location":{"type":"array","description":"The geo-location values","items":{"type":"string"}},"device_id":{"type":"integer","format":"int64","description":"The device ID"},"ip_address":{"type":"string","description":"The IP address of the device"},"config_mismatch":{"type":"boolean","description":"Config audit status(MATCHED(false) or UNMATCHED(true))"},"connected":{"type":"boolean","description":"The device connection status"},"is_mobile_data_persistent":{"type":"boolean"}}},"XiqAfcMobileappScanInfo":{"type":"object","properties":{"owner_id":{"type":"integer","format":"int64","description":"The ownerId"},"bssid_list":{"type":"array","description":"Base radio BSSIDs reported by the mobile application scan","items":{"type":"string"}}}},"XiqAfcMobileappAnchorCandidate":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"The device ID"},"serial_number":{"type":"string","description":"The serial number"},"name":{"type":"string","description":"The device name"},"mac_address":{"type":"string","description":"The device MAC address"},"make":{"type":"string","description":"The product make, such as: WiNG, Aerohive, Extreme etc"},"product_type":{"type":"string","description":"The product type, such as: AP_5050U, AP5050D, AP5020 etc."},"location":{"type":"string","description":"The location of the device, including floor name"},"bssid":{"type":"string","description":"The base radio BSSID"},"gps_anchor":{"type":"boolean","description":"The AP used as GPS anchor to derive geo-coordinates of other APs on the floor"},"coordinates":{"$ref":"#/components/schemas/XiqAfcMobileappCoordinates","description":"The Location provided by Mobileapp"},"neighbors":{"type":"integer","format":"int32","description":"The number of neighboring APs"}}},"XiqMobileappAnchorCandidatesResponse":{"type":"object","description":"The response for mobile app gps settings","properties":{"candidates":{"type":"array","description":"List of AP candidates that may be used as anchors","items":{"$ref":"#/components/schemas/XiqAfcMobileappAnchorCandidate"}}}},"XiqRmAfcGridFilterMetadata":{"type":"object","properties":{"product_type":{"type":"array","description":"The unique identifier of the filter metadata","items":{"type":"string"}},"wifi_radio":{"type":"array","description":"The unique identifier of the filter metadata","items":{"type":"string"}},"power_mode":{"type":"array","description":"The unique identifier of the filter metadata","items":{"type":"string"}},"geo_location":{"type":"array","description":"The unique identifier of the filter metadata","items":{"type":"string"}},"afc_status":{"type":"array","description":"afc statis","items":{"type":"string"}}}},"XiqAfcMetricReport":{"type":"object","description":"ExtremeCloud IQ Xiq report","properties":{"id":{"type":"string","description":"The reportId"}},"required":["id"]},"XiqReportFtmDataRequest":{"type":"object","properties":{"owner_id":{"type":"integer","format":"int64"},"ids":{"type":"array","items":{"type":"integer","format":"int64"}}}},"XiqCreateApiAccessTokenResponse":{"type":"object","properties":{"owner_id":{"type":"integer","format":"int64","description":"The owner Id"},"vhm_id":{"type":"string","description":"The VHM ID"},"vpc_url":{"type":"string","description":"The VPC URL"},"access_token":{"type":"string","description":"The Access Token"},"expiration":{"type":"integer","format":"int64","description":"The expiration time"},"refresh_token":{"type":"string","description":"The refresh token"}}},"XiqViqImportResponse":{"type":"object","description":"ExtremeCloud IQ Viq Import report","properties":{"log_file_name":{"type":"string","description":"The import log file name"},"import_status":{"type":"string","description":"The import status"}},"required":["import_status","log_file_name"]},"XiqViqExportResponse":{"type":"object","description":"ExtremeCloud IQ Viq Export report","properties":{"export_file_name":{"type":"string","description":"The exported file name"},"log_file_name":{"type":"string","description":"The export log file name"},"export_status":{"type":"string","description":"The export status"}},"required":["export_file_name","export_status","log_file_name"]},"XiqUpdateVlanObjectClassifiedEntryRequest":{"type":"object","properties":{"vlan_id":{"type":"integer","format":"int32","description":"The VLAN ID"},"classification_rule_id":{"type":"integer","format":"int64","description":"The classification rule ID"}},"required":["classification_rule_id","vlan_id"]},"XiqUpdateVlanProfileRequest":{"type":"object","properties":{"name":{"type":"string","description":"The VLAN profile name"},"default_vlan_id":{"type":"integer","format":"int32","description":"The default VLAN ID"},"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"}}},"required":["default_vlan_id","enable_classification","name"]},"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","format":"int32","description":"The idle timeout in minutes."},"user_role":{"$ref":"#/components/schemas/XiqUserRole","description":"The user administrative role"},"location_ids":{"type":"array","description":"The location IDs to reassign.","items":{"type":"integer","format":"int64"}},"access_scope":{"type":"integer","format":"int32","description":"The user has access on all sites / the authorized sites. 0: VIQ_SCOPE, 1: SITE_SCOPE."},"viq_access_control":{"type":"integer","format":"int32","description":"The permissions for Site Scope user on Global Scope resources. 0: READ_WRITE, 1: READ_ONLY."}}},"XiqUpdateExternalUserRequest":{"type":"object","properties":{"user_role":{"$ref":"#/components/schemas/XiqUserRole","description":"The user administrative role."},"org_id":{"type":"integer","format":"int64","description":"The HIQ organization ID if it is HIQ user, otherwise leave it as empty."},"location_ids":{"type":"array","description":"The location IDs to assign.","items":{"type":"integer","format":"int64"}},"access_scope":{"type":"integer","format":"int32","description":"The user has access on all sites / the authorized sites. 0: VIQ_SCOPE, 1: SITE_SCOPE."},"viq_access_control":{"type":"integer","format":"int32","description":"The permissions for Site Scope user on Global Scope resources. 0: READ_WRITE, 1: READ_ONLY."}}},"XiqPatchAlertServiceNowSubscriptionRequest":{"type":"object","description":"The payload of ServiceNow subscription.","properties":{"servicenow_account_email":{"type":"string","description":"The servicenow email address."},"is_enabled":{"type":"boolean","description":"Enable/disable servicenow notification."},"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","format":"int64"}}}},"XiqUpdateApiAccessTokenRequest":{"type":"object","properties":{"token_expire_in_day":{"type":"integer","format":"int32","description":"The number of days in which token will expire "}},"required":["token_expire_in_day"]},"XiqApiAccessToken":{"type":"object","description":" The API Access Token ","properties":{"id":{"type":"integer","format":"int64","description":"The unique identifier"},"create_time":{"type":"string","format":"date-time","description":"The create time in UTC (ISO 8601 format)"},"update_time":{"type":"string","format":"date-time","description":"The last update time in UTC (ISO 8601 format)"},"application":{"type":"string","description":"The application name"},"access_token":{"type":"string","description":"The Access Token"},"grantor":{"type":"string","description":"The Grantor of the token"},"generated_on":{"type":"string","format":"date-time","description":"The create time"},"expiration":{"type":"integer","format":"int64","description":"The expiration time"},"refresh_token":{"type":"string","description":"The refresh token"},"client_id":{"type":"string","description":"The client ID"}},"required":["create_time","id","update_time"]},"PagedXiqVlanProfile":{"type":"object","properties":{"page":{"type":"integer","format":"int32","description":"The current page number"},"count":{"type":"integer","format":"int32","description":"The element count of the current page"},"total_pages":{"type":"integer","format":"int32","description":"The total page number based on request page size"},"total_count":{"type":"integer","format":"int64","description":"The total element count"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqVlanProfile"}}},"required":["count","page","total_count","total_pages"]},"PagedXiqUser":{"type":"object","properties":{"page":{"type":"integer","format":"int32","description":"The current page number"},"count":{"type":"integer","format":"int32","description":"The element count of the current page"},"total_pages":{"type":"integer","format":"int32","description":"The total page number based on request page size"},"total_count":{"type":"integer","format":"int64","description":"The total element count"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqUser"}}},"required":["count","page","total_count","total_pages"]},"PagedXiqExternalUser":{"type":"object","properties":{"page":{"type":"integer","format":"int32","description":"The current page number"},"count":{"type":"integer","format":"int32","description":"The element count of the current page"},"total_pages":{"type":"integer","format":"int32","description":"The total page number based on request page size"},"total_count":{"type":"integer","format":"int64","description":"The total element count"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqExternalUser"}}},"required":["count","page","total_count","total_pages"]},"PagedXiqUserGroup":{"type":"object","properties":{"page":{"type":"integer","format":"int32","description":"The current page number"},"count":{"type":"integer","format":"int32","description":"The element count of the current page"},"total_pages":{"type":"integer","format":"int32","description":"The total page number based on request page size"},"total_count":{"type":"integer","format":"int64","description":"The total element count"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqUserGroup"}}},"required":["count","page","total_count","total_pages"]},"XiqUserGroupName":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"The unique identifier"},"name":{"type":"string","description":"The user group name"}},"required":["id","name"]},"PagedXiqUserProfile":{"type":"object","properties":{"page":{"type":"integer","format":"int32","description":"The current page number"},"count":{"type":"integer","format":"int32","description":"The element count of the current page"},"total_pages":{"type":"integer","format":"int32","description":"The total page number based on request page size"},"total_count":{"type":"integer","format":"int64","description":"The total element count"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqUserProfile"}}},"required":["count","page","total_count","total_pages"]},"PagedXiqUserProfileAssignment":{"type":"object","properties":{"page":{"type":"integer","format":"int32","description":"The current page number"},"count":{"type":"integer","format":"int32","description":"The element count of the current page"},"total_pages":{"type":"integer","format":"int32","description":"The total page number based on request page size"},"total_count":{"type":"integer","format":"int64","description":"The total element count"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqUserProfileAssignment"}}},"required":["count","page","total_count","total_pages"]},"XiqUcpEngine":{"type":"object","description":"The payload of UCP Engine","properties":{"name":{"type":"string","description":"The name of the UCP engine","minLength":1},"description":{"type":"string","description":"The description of the UCP engine","minLength":1},"instances":{"type":"array","description":"List of instances installed","items":{"$ref":"#/components/schemas/XiqUcpEngineInstance"}},"instance_count":{"type":"integer","format":"int32","description":"Count of the number of instances for the engine"},"max_instances":{"type":"integer","format":"int32","description":"The maximum number of instances allowed for the engine"},"type":{"type":"string","description":"The type of engine image"},"upgradable":{"type":"boolean","description":"If the engine is upgradable"},"image_name":{"type":"string","description":"Name of the image for the engine","minLength":1}},"required":["description","image_name","instance_count","max_instances","name","upgradable"]},"XiqUcpEngineInstance":{"type":"object","description":"The payload of UCP Engine Instance","properties":{"name":{"type":"string","description":"The name of the instance","minLength":1},"display_name":{"type":"string","description":"The display name of the instance","minLength":1}},"required":["display_name","name"]},"XiqUcpEngines":{"type":"object","description":"The payload of UCP installed engines","properties":{"engines":{"type":"array","description":"The UCP Engine List","items":{"$ref":"#/components/schemas/XiqUcpEngine"}}},"required":["engines"]},"PagedXiqTunnelConcentrator":{"type":"object","properties":{"page":{"type":"integer","format":"int32","description":"The current page number"},"count":{"type":"integer","format":"int32","description":"The element count of the current page"},"total_pages":{"type":"integer","format":"int32","description":"The total page number based on request page size"},"total_count":{"type":"integer","format":"int64","description":"The total element count"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqTunnelConcentrator"}}},"required":["count","page","total_count","total_pages"]},"XiqClientView":{"type":"string","description":"The logic collections of client fields<br/><br/><b>BASIC:</b> ID, ORG_ID, HOSTNAME, MAC_ADDRESS, IP_ADDRESS, IPV6_ADDRESS, OS_TYPE, DEVICE_ID,CONNECTED, ONLINE_TIME, OFFLINE_TIME, CONNECTION_TYPE, SSID, PORT<br/><b>FULL:</b> All fields<br/><b>STATUS:</b> ID, CONNECTED, ONLINE_TIME, OFFLINE_TIME<br/><b>DETAIL:</b> 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, MAC_PROTOCOL<br/><b>LOCATION:</b> ID, LOCATION_ID, LOCATIONS<br/><b>METRICS:</b> ID, CLIENT_HEALTH, APPLICATION_HEALTH, NETWORK_HEALTH, RADIO_HEALTH<br/><b>IOT:</b> ID, MOBILITY, CATEGORY, DESCRIPTION","enum":["BASIC","FULL","STATUS","DETAIL","LOCATION","METRICS","IOT","THREAD"]},"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","TH_RLOC16","TH_CHILD_ID","TH_TIMEOUT","TH_SUPERVISION_INTERVAL","TH_NETDATA_VERSION","TH_CSL_SYNCED","TH_IP_ADDRESSES","TH_ROUTER_LAST_REPORTED","THREAD_CONNECTED","MAC_PROTOCOL","MAKE","OS_VERSION","CONNECTED_TO","CONNECTION_DURATION","CAPTIVE_WEB_PORTAL"]},"XiqThreadBackboneBorderRouterService":{"type":"object","properties":{"state":{"type":"string"}}},"XiqThreadBorderAgentService":{"type":"object","properties":{"state":{"type":"string"},"udp_port":{"type":"integer","format":"int32"}}},"XiqThreadBorderRouterService":{"type":"object","properties":{"state":{"type":"string"},"nat64_local_prefix":{"type":"string"},"nat64_favored_prefix":{"type":"string"},"nat64_favored_preference":{"type":"string"},"nat64_omr_local_prefix":{"type":"string"},"nat64_omr_favored_prefix":{"type":"string"},"nat64_omr_favored_preference":{"type":"string"},"nat64_onlink_local_prefix":{"type":"string"},"nat64_onlink_favored_prefix":{"type":"string"},"nat64_onlink_favored_preference":{"type":"string"}}},"XiqThreadCommissionerService":{"type":"object","properties":{"state":{"type":"string"}}},"XiqThreadIpv6Setting":{"type":"object","properties":{"address":{"type":"string"},"scope":{"type":"string"},"cast":{"type":"string"},"type":{"type":"string"}}},"XiqThreadLeaderService":{"type":"object","properties":{"partition_id":{"type":"integer","format":"int64"},"weighting":{"type":"integer","format":"int32"},"full_network_data_version":{"type":"integer","format":"int32"},"stable_network_data_version":{"type":"integer","format":"int32"}}},"XiqThreadMleLinkMode":{"type":"object","properties":{"rx_on_when_idle":{"type":"boolean"},"full_thread_device":{"type":"boolean"},"full_network_data":{"type":"boolean"}}},"XiqThreadNat64Service":{"type":"object","properties":{"prefix_manager_state":{"type":"string"},"translator_state":{"type":"string"},"translator_cidr":{"type":"string"}}},"XiqThreadNetDataPrefix":{"type":"object","properties":{"prefix":{"type":"string"},"route_preference":{"type":"string"},"added_by_rloc16":{"type":"string"},"added_by_ext_mac":{"type":"string"},"preferred":{"type":"boolean"},"slaac":{"type":"boolean"},"dhcp":{"type":"boolean"},"configure":{"type":"boolean"},"default_route":{"type":"boolean"},"on_mesh":{"type":"string"},"stable":{"type":"boolean"},"nd_dns":{"type":"boolean"},"dp":{"type":"boolean"}}},"XiqThreadNetDataRoute":{"type":"object","properties":{"prefix":{"type":"string"},"nat64":{"type":"boolean"},"stable":{"type":"boolean"},"route_preference":{"type":"string"},"added_by_rloc16":{"type":"string"},"added_by_ext_mac":{"type":"string"}}},"XiqThreadNetDataService":{"type":"object","properties":{"enterprise_number":{"type":"integer","format":"int64"},"service_data":{"type":"string"},"server_data":{"type":"string"},"stable":{"type":"boolean"},"added_by_rloc16":{"type":"string"},"added_by_ext_mac":{"type":"string"}}},"XiqThreadNetworkConfig":{"type":"object","description":"The thread network configuration and security policy","properties":{"id":{"type":"integer","format":"int64","description":"The unique identifier"},"channel":{"type":"integer","format":"int32","description":"The network channel"},"channel_mask":{"type":"string","description":"The network channel mask"},"ext_pan_id":{"type":"string","description":"The unique extended pan id"},"mesh_local_prefix":{"type":"string","description":"The mesh local prefix"},"network_key":{"type":"string","description":"The thread network key"},"network_name":{"type":"string","description":"The thread network name"},"pan_id":{"type":"string","description":"The pan id"},"pskc":{"type":"string","description":"The Pre-Shared Key for the Commissioner"},"obtain_network_key_enabled":{"type":"boolean"},"native_commissioning_enabled":{"type":"boolean"},"routers_enabled":{"type":"boolean"},"external_commissioning_enabled":{"type":"boolean"},"beacons_enabled":{"type":"boolean"},"commercial_commissioning_enabled":{"type":"boolean"},"autonomous_enrollment_enabled":{"type":"boolean"},"network_key_provisioning_enabled":{"type":"boolean"},"non_ccm_routers_enabled":{"type":"boolean"},"active_timestamp":{"type":"integer","format":"int32"}}},"XiqThreadNetworkData":{"type":"object","properties":{"length":{"type":"integer","format":"int32"},"max_length":{"type":"integer","format":"int32"},"net_data_on_mesh_prefixes":{"type":"array","items":{"$ref":"#/components/schemas/XiqThreadNetDataPrefix"}},"net_data_routes":{"type":"array","items":{"$ref":"#/components/schemas/XiqThreadNetDataRoute"}},"net_data_services":{"type":"array","items":{"$ref":"#/components/schemas/XiqThreadNetDataService"}}}},"XiqThreadNetworkInterface":{"type":"object","properties":{"interface_name":{"type":"string"},"is_active":{"type":"boolean"},"is_broadcast":{"type":"boolean"},"is_loopback":{"type":"boolean"},"is_point_to_point":{"type":"boolean"},"is_running":{"type":"boolean"},"is_arp":{"type":"boolean"},"is_promisc":{"type":"boolean"},"is_all_multi":{"type":"boolean"},"is_multicast":{"type":"boolean"},"is_dynamic":{"type":"boolean"},"mtu":{"type":"integer","format":"int32"},"hw_mac_address":{"type":"string"},"ipv4":{"type":"string"},"ipv4_mask":{"type":"string"},"ipv4_broadcast":{"type":"string"},"ipv6_settings":{"type":"array","items":{"$ref":"#/components/schemas/XiqThreadIpv6Setting"}}}},"XiqThreadNetworkTopology":{"type":"object","description":"The thread network topology","properties":{"neighbors":{"type":"array","items":{"$ref":"#/components/schemas/XiqThreadRouterNeighbor"}},"routers":{"type":"array","items":{"$ref":"#/components/schemas/XiqThreadRouter"}},"clients":{"type":"array","items":{"$ref":"#/components/schemas/XiqClient"}}}},"XiqThreadRouter":{"type":"object","description":"The Thread Router associate to ExtremeCloud IQ device","properties":{"id":{"type":"integer","format":"int64","description":"The unique identifier"},"create_time":{"type":"string","format":"date-time","description":"The create time in UTC (ISO 8601 format)"},"update_time":{"type":"string","format":"date-time","description":"The last update time in UTC (ISO 8601 format)"},"org_id":{"type":"integer","format":"int64","description":"The organization identifier, valid when enabling HIQ feature"},"owner_id":{"type":"integer","format":"int64","description":"The owner id"},"device_id":{"type":"integer","format":"int64","description":"The device unique identifier"},"serial_number":{"type":"string","description":"The device serial number"},"eui64":{"type":"string","description":"The Extended Unique Identifier"},"ext_mac":{"type":"string","description":"The Extended Mac Address"},"rloc16":{"type":"string","description":"The router RLOC16"},"global_ipv6":{"type":"string","description":"The global IPv6 address"},"tx_power":{"type":"integer","format":"int32","description":"The transmit power"},"region":{"type":"string","description":"The device region"},"thread_platform":{"type":"string","description":"The thread platform"},"device_role":{"type":"string","description":"The thread device role/state"},"router_interface":{"$ref":"#/components/schemas/XiqThreadNetworkInterface","description":"The thread router network interface"},"veth0":{"$ref":"#/components/schemas/XiqThreadNetworkInterface","description":"The thread veth0 network interface"},"network_data":{"$ref":"#/components/schemas/XiqThreadNetworkData","description":"The thread network data"},"thread_mle_link_mode":{"$ref":"#/components/schemas/XiqThreadMleLinkMode","description":"The thread MLE Link Mode configuration"},"thread_version":{"$ref":"#/components/schemas/XiqThreadVersion","description":"The thread version"},"leader_service":{"$ref":"#/components/schemas/XiqThreadLeaderService","description":"The thread leader service"},"border_router_service":{"$ref":"#/components/schemas/XiqThreadBorderRouterService","description":"The thread border router service"},"backbone_border_router_service":{"$ref":"#/components/schemas/XiqThreadBackboneBorderRouterService","description":"The thread backbone border router service"},"border_agent_service":{"$ref":"#/components/schemas/XiqThreadBorderAgentService","description":"The thread backbone agent service"},"commissioner_service":{"$ref":"#/components/schemas/XiqThreadCommissionerService","description":"The commissioner service"},"nat64_service":{"$ref":"#/components/schemas/XiqThreadNat64Service","description":"The nat64 service on border router"},"network_config":{"$ref":"#/components/schemas/XiqThreadNetworkConfig","description":"The thread network configuration"},"active_clients":{"type":"integer","format":"int32","description":"The count of active connected clients"},"hostname":{"type":"string","description":"The device hostname"},"last_reported":{"type":"string","format":"date-time","description":"The last reported datetime"},"thread_connected":{"type":"boolean","description":"Is router connected to thread network"}},"required":["create_time","id","update_time"]},"XiqThreadRouterNeighbor":{"type":"object","description":"The Thread Router neighbors associate to ExtremeCloud IQ device","properties":{"parent_device_id":{"type":"integer","format":"int64"},"child_device_id":{"type":"integer","format":"int64"},"connection_status":{"type":"integer","format":"int32"},"last_reported_time":{"type":"integer","format":"int64"}}},"XiqThreadVersion":{"type":"object","properties":{"thread_version":{"type":"string"},"build_version":{"type":"string"},"api_version":{"type":"string"},"rcp_version":{"type":"string"}}},"PagedXiqThreadRouter":{"type":"object","properties":{"page":{"type":"integer","format":"int32","description":"The current page number"},"count":{"type":"integer","format":"int32","description":"The element count of the current page"},"total_pages":{"type":"integer","format":"int32","description":"The total page number based on request page size"},"total_count":{"type":"integer","format":"int64","description":"The total element count"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqThreadRouter"}}},"required":["count","page","total_count","total_pages"]},"XiqThreadNetworks":{"type":"object","description":"Active thread networks","properties":{"networks":{"type":"array","items":{"$ref":"#/components/schemas/XiqThreadNetworkConfig"}}}},"PagedXiqWebhookSubscription":{"type":"object","properties":{"page":{"type":"integer","format":"int32","description":"The current page number"},"count":{"type":"integer","format":"int32","description":"The element count of the current page"},"total_pages":{"type":"integer","format":"int32","description":"The total page number based on request page size"},"total_count":{"type":"integer","format":"int64","description":"The total element count"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqWebhookSubscription"}}},"required":["count","page","total_count","total_pages"]},"PagedXiqSsid":{"type":"object","properties":{"page":{"type":"integer","format":"int32","description":"The current page number"},"count":{"type":"integer","format":"int32","description":"The element count of the current page"},"total_pages":{"type":"integer","format":"int32","description":"The total page number based on request page size"},"total_count":{"type":"integer","format":"int64","description":"The total element count"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqSsid"}}},"required":["count","page","total_count","total_pages"]},"XiqRadiusClientProfile":{"type":"object","description":"The RADIUS client profile.","properties":{"default_radius_client_object_id":{"type":"integer","format":"int64","description":"The default RADIUS client object ID."},"enable_classification":{"type":"boolean","description":"The flag to enable classification entries on RADIUS client profile."},"classified_entries":{"type":"array","description":"The RADIUS client profile classified entries.","items":{"$ref":"#/components/schemas/XiqRadiusClientProfileEntry"}}}},"XiqRadiusClientProfileEntry":{"type":"object","description":"The RADIUS client profile entry.","properties":{"classification_assignment_id":{"type":"integer","format":"int64","description":"The classification assignment ID for RADIUS client profile entry."},"radius_client_object_id":{"type":"integer","format":"int64","description":"The RADIUS client object ID for RADIUS client profile entry."}}},"XiqSsid":{"type":"object","description":"The SSID","properties":{"id":{"type":"integer","format":"int64","description":"The unique identifier"},"create_time":{"type":"string","format":"date-time","description":"The create time in UTC (ISO 8601 format)"},"update_time":{"type":"string","format":"date-time","description":"The last update time in UTC (ISO 8601 format)"},"org_id":{"type":"integer","format":"int64","description":"The organization identifier, valid when enabling HIQ feature"},"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","format":"int64","description":"The SSID advanced settings ID."},"enable_user_profile_assignment":{"type":"boolean","description":"The flag to enable User Profile Assignment."},"enable_radius_attribute_user_profile_assignment":{"type":"boolean","description":"The flag to enable Radius Attribute User Profile Assignment."},"attribute_type":{"$ref":"#/components/schemas/XiqAttributeType","description":"The SSID attribute type."},"attribute_key":{"type":"integer","format":"int32","description":"The SSID attribute key."},"access_security":{"$ref":"#/components/schemas/XiqSsidAccessSecurity","description":"The SSID access security."},"radius_client_profile":{"$ref":"#/components/schemas/XiqRadiusClientProfile","description":"The RADIUS client profile."},"default_user_profile":{"type":"integer","format":"int64","description":"The default User Profile ID."},"vendor_id":{"type":"integer","format":"int64","description":"The vendor id, when the Attribute type is CUSTOM."},"user_profile_assignment_rules":{"type":"array","description":"The SSID user profile assignment rules.","items":{"$ref":"#/components/schemas/XiqUserProfileAssignmentRule"}}},"required":["broadcast_name","create_time","id","name","predefined","update_time"]},"XiqSsidAccessSecurity":{"type":"object","description":"The SSID access security.","properties":{"key_type":{"$ref":"#/components/schemas/XiqSsidKeyType","description":"The key type e.g, ASCII or HEX."},"key_value":{"type":"string","description":"The schedule type name."},"sae_group":{"$ref":"#/components/schemas/XiqSsidSaeGroup","description":"The SAE group."},"anti_logging_threshold":{"type":"integer","format":"int64","description":"The anti-logging threshold value representing the maximum number of failed authentication attempts before triggering anti-logging protection.","example":5,"maximum":64,"minimum":2},"transition_mode":{"type":"boolean","description":"The flag for enabling transition mode."},"security_type":{"type":"string","description":"The security type."},"key_management":{"$ref":"#/components/schemas/XiqSsidKeyManagement","description":"The SSID key management value."},"encryption_method":{"$ref":"#/components/schemas/XiqSsidEncryptionMethod","description":"The SSID encryption method."}}},"XiqSsidEncryptionMethod":{"type":"string","enum":["CCMP","TKIP","AUTO_TKIP_CCMP","WEP40","WEP104","AES192"]},"XiqSsidKeyManagement":{"type":"string","enum":["WPA_PSK","WPA2_PSK","WPA3_PSK","AUTO_PSK","WPA_8021X","WPA2_8021X","WPA3_8021X","AUTO_8021X","WEP","WEP_8021"]},"XiqUserProfileAssignmentRule":{"type":"object","description":"The SSID user profile assignment rules.","properties":{"user_profile":{"$ref":"#/components/schemas/XiqUserProfile","description":"The User Profile of User Profile Assignment rule."},"user_profile_assignment":{"$ref":"#/components/schemas/XiqUserProfileAssignment","description":"The User Profile Assignment."},"enable_by_cwp":{"type":"boolean","description":"The flag for enableBypassCwp."}}},"XiqSmsTemplate":{"type":"object","description":"The password or PPSK notification template for user groups.","properties":{"id":{"type":"integer","format":"int64","description":"The unique identifier"},"create_time":{"type":"string","format":"date-time","description":"The create time in UTC (ISO 8601 format)"},"update_time":{"type":"string","format":"date-time","description":"The last update time in UTC (ISO 8601 format)"},"org_id":{"type":"integer","format":"int64","description":"The organization identifier, valid when enabling HIQ feature"},"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 security type"}},"required":["create_time","id","name","password_type","predefined","update_time"]},"PagedXiqRadsecProxy":{"type":"object","properties":{"page":{"type":"integer","format":"int32","description":"The current page number"},"count":{"type":"integer","format":"int32","description":"The element count of the current page"},"total_pages":{"type":"integer","format":"int32","description":"The total page number based on request page size"},"total_count":{"type":"integer","format":"int64","description":"The total element count"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqRadsecProxy"}}},"required":["count","page","total_count","total_pages"]},"PagedXiqInternalRadiusServer":{"type":"object","properties":{"page":{"type":"integer","format":"int32","description":"The current page number"},"count":{"type":"integer","format":"int32","description":"The element count of the current page"},"total_pages":{"type":"integer","format":"int32","description":"The total page number based on request page size"},"total_count":{"type":"integer","format":"int64","description":"The total element count"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqInternalRadiusServer"}}},"required":["count","page","total_count","total_pages"]},"PagedXiqInternalRadiusDevice":{"type":"object","properties":{"page":{"type":"integer","format":"int32","description":"The current page number"},"count":{"type":"integer","format":"int32","description":"The element count of the current page"},"total_pages":{"type":"integer","format":"int32","description":"The total page number based on request page size"},"total_count":{"type":"integer","format":"int64","description":"The total element count"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqInternalRadiusDevice"}}},"required":["count","page","total_count","total_pages"]},"XiqInternalRadiusDevice":{"type":"object","description":"The configuration of internal RADIUS device object","properties":{"id":{"type":"integer","format":"int64","description":"The unique identifier"},"create_time":{"type":"string","format":"date-time","description":"The create time in UTC (ISO 8601 format)"},"update_time":{"type":"string","format":"date-time","description":"The last update time in UTC (ISO 8601 format)"},"org_id":{"type":"integer","format":"int64","description":"The organization identifier, valid when enabling HIQ feature"},"radius_server_id":{"type":"integer","format":"int64","description":"The RADIUS server id"},"radius_server_name":{"type":"string","description":"The RADIUS server name"},"host_name":{"type":"string","description":"The RADIUS server device hostname"}},"required":["create_time","host_name","id","radius_server_id","radius_server_name","update_time"]},"PagedXiqExternalRadiusServer":{"type":"object","properties":{"page":{"type":"integer","format":"int32","description":"The current page number"},"count":{"type":"integer","format":"int32","description":"The element count of the current page"},"total_pages":{"type":"integer","format":"int32","description":"The total page number based on request page size"},"total_count":{"type":"integer","format":"int64","description":"The total element count"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqExternalRadiusServer"}}},"required":["count","page","total_count","total_pages"]},"PagedXiqRadiusProxy":{"type":"object","properties":{"page":{"type":"integer","format":"int32","description":"The current page number"},"count":{"type":"integer","format":"int32","description":"The element count of the current page"},"total_pages":{"type":"integer","format":"int32","description":"The total page number based on request page size"},"total_count":{"type":"integer","format":"int64","description":"The total element count"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqRadiusProxy"}}},"required":["count","page","total_count","total_pages"]},"PagedXiqRadiusClientObject":{"type":"object","properties":{"page":{"type":"integer","format":"int32","description":"The current page number"},"count":{"type":"integer","format":"int32","description":"The element count of the current page"},"total_pages":{"type":"integer","format":"int32","description":"The total page number based on request page size"},"total_count":{"type":"integer","format":"int64","description":"The total element count"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqRadiusClientObject"}}},"required":["count","page","total_count","total_pages"]},"PagedXiqRadioProfile":{"type":"object","properties":{"page":{"type":"integer","format":"int32","description":"The current page number"},"count":{"type":"integer","format":"int32","description":"The element count of the current page"},"total_pages":{"type":"integer","format":"int32","description":"The total page number based on request page size"},"total_count":{"type":"integer","format":"int64","description":"The total element count"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqRadioProfile"}}},"required":["count","page","total_count","total_pages"]},"PagedXiqRpMacOuiProfile":{"type":"object","properties":{"page":{"type":"integer","format":"int32","description":"The current page number"},"count":{"type":"integer","format":"int32","description":"The element count of the current page"},"total_pages":{"type":"integer","format":"int32","description":"The total page number based on request page size"},"total_count":{"type":"integer","format":"int64","description":"The total element count"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqRpMacOuiProfile"}}},"required":["count","page","total_count","total_pages"]},"XiqDeviceInterfaceRadioMode":{"type":"object","description":"Wirelss Interfaces.","properties":{"name":{"$ref":"#/components/schemas/XiqWirelessIfName","description":"The wireless interface name"},"band":{"type":"string","description":"The default radio band","enum":["BAND24","BAND5","BAND5LOW","BAND5HIGH","BAND6","BAND6LOW","BAND6HIGH","BANDNONE"]},"default_radio_mode":{"$ref":"#/components/schemas/XiqRadioMode","description":"The default Radio Mode"}}},"XiqRadioOperatingModes":{"type":"object","properties":{"key":{"$ref":"#/components/schemas/XiqRadioBands","description":"The Radio Operating Mode Key"},"wireless_interfaces_list":{"type":"array","description":"Wireless Interface list","items":{"$ref":"#/components/schemas/XiqDeviceInterfaceRadioMode"}}}},"PagedXiqKeyBasedPcgUser":{"type":"object","properties":{"page":{"type":"integer","format":"int32","description":"The current page number"},"count":{"type":"integer","format":"int32","description":"The element count of the current page"},"total_pages":{"type":"integer","format":"int32","description":"The total page number based on request page size"},"total_count":{"type":"integer","format":"int64","description":"The total element count"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqKeyBasedPcgUser"}}},"required":["count","page","total_count","total_pages"]},"XiqGetPortAssignmentDetailsResponse":{"type":"object","description":"The response of port assignment details for AP150W","properties":{"policy_id":{"type":"integer","format":"int64","description":"The network policy ID"},"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"}}},"required":["policy_id","policy_name"]},"XiqPcgPortAssignmentEntryDetail":{"type":"object","description":"The PCG port assignment entry detail","properties":{"id":{"type":"integer","format":"int64","description":"The unique identifier"},"create_time":{"type":"string","format":"date-time","description":"The create time in UTC (ISO 8601 format)"},"update_time":{"type":"string","format":"date-time","description":"The last update time in UTC (ISO 8601 format)"},"org_id":{"type":"integer","format":"int64","description":"The organization identifier, valid when enabling HIQ feature"},"device":{"$ref":"#/components/schemas/XiqPcgPortAssignmentEntryDeviceMeta","description":"The device meta info"},"eth1":{"$ref":"#/components/schemas/XiqPcgPortAssignmentEntryEthUserMeta","description":"The eth1 user meta info"},"eth2":{"$ref":"#/components/schemas/XiqPcgPortAssignmentEntryEthUserMeta","description":"The eth2 user meta info"},"eth3":{"$ref":"#/components/schemas/XiqPcgPortAssignmentEntryEthUserMeta","description":"The eth3 user meta info"}},"required":["create_time","id","update_time"]},"XiqPcgPortAssignmentEntryDeviceMeta":{"type":"object","description":"The PCG port assignment entry device info","properties":{"id":{"type":"integer","format":"int64","description":"The unique identifier"},"create_time":{"type":"string","format":"date-time","description":"The create time in UTC (ISO 8601 format)"},"update_time":{"type":"string","format":"date-time","description":"The last update time in UTC (ISO 8601 format)"},"org_id":{"type":"integer","format":"int64","description":"The organization identifier, valid when enabling HIQ feature"},"mac_address":{"type":"string","description":"The mac address"},"serial_number":{"type":"string","description":"The serial number"},"product_type":{"type":"string","description":"The product type"}},"required":["create_time","id","mac_address","product_type","serial_number","update_time"]},"XiqPcgPortAssignmentEntryEthUserMeta":{"type":"object","description":"The PCG port assignment entry of eth user info","properties":{"id":{"type":"integer","format":"int64","description":"The unique identifier"},"create_time":{"type":"string","format":"date-time","description":"The create time in UTC (ISO 8601 format)"},"update_time":{"type":"string","format":"date-time","description":"The last update time in UTC (ISO 8601 format)"},"org_id":{"type":"integer","format":"int64","description":"The organization identifier, valid when enabling HIQ feature"},"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"}}},"required":["create_time","id","name","password","ssids","update_time","user_group_name","user_type"]},"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":{"type":"object","properties":{"page":{"type":"integer","format":"int32","description":"The current page number"},"count":{"type":"integer","format":"int32","description":"The element count of the current page"},"total_pages":{"type":"integer","format":"int32","description":"The total page number based on request page size"},"total_count":{"type":"integer","format":"int64","description":"The total element count"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqPacketCapture"}}},"required":["count","page","total_count","total_pages"]},"XiqOperationMetadata":{"type":"object","description":"The metadata of Long Running Operation (LRO)","properties":{"status":{"$ref":"#/components/schemas/XiqOperationStatus","description":"The current operation status"},"cancelable":{"type":"boolean","description":"Indicates if the operation can be canceled in the current status"},"percentage":{"type":"integer","format":"int32","description":"The progress in percentage ranges from 0 to 100 (it's not guaranteed to be accurate)","maximum":100,"minimum":0},"step":{"type":"string","description":"The optional step name for multiple steps operations when the operation is running"},"create_time":{"type":"string","format":"date-time","description":"The operation's create time, which is the time when the operation is in PENDING status"},"update_time":{"type":"string","format":"date-time","description":"The operation's last update time"},"start_time":{"type":"string","format":"date-time","description":"The operation's start time, which is the time when the operation is in RUNNING status"},"end_time":{"type":"string","format":"date-time","description":"The operation's end time, which is the time when the operation is done"},"expires_in":{"type":"integer","format":"int64","description":"The number of seconds remaining until the operation expires and is to be deleted."}},"required":["cancelable","create_time","expires_in","status","update_time"]},"XiqOperationObject":{"type":"object","description":"Long Running Operation (LRO) model","properties":{"id":{"type":"string","description":"The unique identifier of the operation"},"metadata":{"$ref":"#/components/schemas/XiqOperationMetadata","description":"The metadata of the operation "},"done":{"type":"boolean","description":"Whether the operation is done"},"response":{"description":"The API response of the operation if the status is SUCCEEDED"},"error":{"$ref":"#/components/schemas/XiqError","description":"The error detail if the status is FAILED or CANCELED"}},"required":["done","id","metadata"]},"XiqOperationStatus":{"type":"string","enum":["PENDING","RUNNING","CANCELING","SUCCEEDED","FAILED","CANCELED"]},"XiqRecipientsForReportSchedule":{"type":"object","properties":{"report_id":{"type":"integer","format":"int64","description":"Unique ID of the report"},"report_name":{"type":"string","description":"The report name"},"recipients":{"type":"array","description":"The list of report recipients","items":{"$ref":"#/components/schemas/XiqReportRecipientInfo"}}}},"XiqReportRecipientInfo":{"type":"object","description":"Report Recipient information","properties":{"recipient_id":{"type":"integer","format":"int64","description":"Unique ID of the recipient"},"recipient_email":{"type":"string","description":"The recipient email"}}},"XiqRecipientsForReportRun":{"type":"object","properties":{"report_run_id":{"type":"integer","format":"int64","description":"Unique ID of the report run"},"report_id":{"type":"integer","format":"int64","description":"Unique ID of the report"},"report_name":{"type":"string","description":"The report name"},"recipients":{"type":"array","description":"The list of report recipients","items":{"$ref":"#/components/schemas/XiqReportRecipientInfo"}}}},"XiqNgCannedReport":{"type":"object","properties":{"report_id":{"type":"integer","format":"int64","description":"Report Id"},"report_schedule_id":{"type":"integer","format":"int64","description":"Report Schedule Id"},"enable_schedule":{"type":"boolean","description":"Status of report Schedule"},"report_runs":{"type":"array","description":"List of report runs","items":{"$ref":"#/components/schemas/XiqNgCannedReportRuns"}}}},"XiqNgCannedReportRuns":{"type":"object","description":"Report Runs","properties":{"report_run_id":{"type":"integer","format":"int64","description":"Report Run Id"},"report_run_timestamp":{"type":"integer","format":"int64","description":"Report Run Timestamp"},"recipients_count":{"type":"integer","format":"int32","description":"Report recipient count"},"report_name":{"type":"string","description":"Report Name"}}},"PagedXiqCustomReportSchedule":{"type":"object","properties":{"page":{"type":"integer","format":"int32","description":"The current page number"},"count":{"type":"integer","format":"int32","description":"The element count of the current page"},"total_pages":{"type":"integer","format":"int32","description":"The total page number based on request page size"},"total_count":{"type":"integer","format":"int64","description":"The total element count"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqCustomReportSchedule"}}},"required":["count","page","total_count","total_pages"]},"XiqCustomReportSchedule":{"type":"object","description":"Generic ExtremeCloud IQ Scheduled Custom Report model","properties":{"report_schedule_id":{"type":"integer","format":"int64","description":"Unique ID of the scheduled report"},"report_id":{"type":"integer","format":"int64","description":"Unique ID of the report"},"report_name":{"type":"string","description":"Name of the actual report"},"report_description":{"type":"string","description":"Short description of the report"},"recipients_count":{"type":"integer","format":"int32","description":"Number of recipients for the report"},"frequency":{"$ref":"#/components/schemas/XiqScheduleFrequency","description":"The frequency of the scheduled report"},"enable_schedule":{"type":"boolean","description":"Whether the schedule is enabled or not"}}},"XiqReportRunsResponse":{"type":"object","properties":{"report_run_id":{"type":"integer","format":"int64"},"report_run_timestamp":{"type":"integer","format":"int64"},"report_name":{"type":"string"},"report_id":{"type":"integer","format":"int64"}}},"XiqQoeDiagnosticsSummary":{"type":"object","properties":{"metrics":{"$ref":"#/components/schemas/XiqQoeDiagnosticsMetrics","description":"Metrics"},"description":{"type":"string","description":"Description for the metrics"},"filters_supported":{"type":"array","description":"Filters applicable for the metrics","items":{"type":"string"}},"metrics_group":{"type":"string","description":"Metrics Grouping","enum":["GROUP_DEVICES","GROUP_CLIENTS","GROUP_APPLICATIONS_USAGE"]}}},"PagedXiqNetworkService":{"type":"object","properties":{"page":{"type":"integer","format":"int32","description":"The current page number"},"count":{"type":"integer","format":"int32","description":"The element count of the current page"},"total_pages":{"type":"integer","format":"int32","description":"The total page number based on request page size"},"total_count":{"type":"integer","format":"int64","description":"The total element count"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqNetworkService"}}},"required":["count","page","total_count","total_pages"]},"WifiHealth":{"type":"object","properties":{"overall_score":{"type":"integer","format":"int32","description":"The overall health score"},"snr_score":{"type":"integer","format":"int32","description":"The health score of snr"},"channel_utilization_score":{"type":"integer","format":"int32","description":"The health score of utilization"},"association_per_radio_score":{"type":"integer","format":"int32","description":"The health score of association"}}},"ServicesHealth":{"type":"object","properties":{"overall_score":{"type":"integer","format":"int32","description":"The overall health score"},"network_services_score":{"type":"integer","format":"int32","description":"The health score of network services"},"authentication_services_score":{"type":"integer","format":"int32","description":"The health score of authentication services"},"management_services_score":{"type":"integer","format":"int32","description":"The health score of management services"}}},"NetworkHealth":{"type":"object","properties":{"overall_score":{"type":"integer","format":"int32","description":"The overall health score"},"internet_availability_score":{"type":"integer","format":"int64","description":"The overall internet availability score"},"internet_performance":{"type":"integer","format":"int64","description":"The internet performance value in milli-seconds"},"network_usage":{"type":"integer","format":"int64","description":"The network usage value in MB"}}},"DeviceHealth":{"type":"object","description":"The devices health score over the period","properties":{"score":{"type":"integer","format":"int32","description":"The overall health score"},"device_availability_score":{"type":"integer","format":"int32","description":"The device availability score"},"device_hardware_health_score":{"type":"integer","format":"int32","description":" The device hardware health score"},"config_and_firmware_score":{"type":"integer","format":"int32","description":"The config and firmware score"}}},"ClientHealth":{"type":"object","properties":{"overall_score":{"type":"integer","format":"int32","description":"The overall health score"},"wifi_health_score":{"type":"integer","format":"int32","description":"The health score of Wi-Fi"},"network_health_score":{"type":"integer","format":"int32","description":"The health score of network"},"application_health_score":{"type":"integer","format":"int32","description":"The health score of application"}}},"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<br/><br/>BASIC: ID, ORG_ID, NAME, TYPE<br/>FULL: All fields<br/>","enum":["BASIC","FULL"]},"PagedXiqNetworkPolicy":{"type":"object","properties":{"page":{"type":"integer","format":"int32","description":"The current page number"},"count":{"type":"integer","format":"int32","description":"The element count of the current page"},"total_pages":{"type":"integer","format":"int32","description":"The total page number based on request page size"},"total_count":{"type":"integer","format":"int64","description":"The total element count"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqNetworkPolicy"}}},"required":["count","page","total_count","total_pages"]},"PagedXiqMacObject":{"type":"object","properties":{"page":{"type":"integer","format":"int32","description":"The current page number"},"count":{"type":"integer","format":"int32","description":"The element count of the current page"},"total_pages":{"type":"integer","format":"int32","description":"The total page number based on request page size"},"total_count":{"type":"integer","format":"int64","description":"The total element count"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqMacObject"}}},"required":["count","page","total_count","total_pages"]},"PagedXiqMacFirewall":{"type":"object","properties":{"page":{"type":"integer","format":"int32","description":"The current page number"},"count":{"type":"integer","format":"int32","description":"The element count of the current page"},"total_pages":{"type":"integer","format":"int32","description":"The total page number based on request page size"},"total_count":{"type":"integer","format":"int64","description":"The total element count"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqMacFirewall"}}},"required":["count","page","total_count","total_pages"]},"PagedXiqSmsLog":{"type":"object","properties":{"page":{"type":"integer","format":"int32","description":"The current page number"},"count":{"type":"integer","format":"int32","description":"The element count of the current page"},"total_pages":{"type":"integer","format":"int32","description":"The total page number based on request page size"},"total_count":{"type":"integer","format":"int64","description":"The total element count"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqSmsLog"}}},"required":["count","page","total_count","total_pages"]},"XiqSmsLog":{"type":"object","description":"ExtremeCloud IQ SMS Log","properties":{"id":{"type":"integer","format":"int64","description":"The SMS log id"},"user_id":{"type":"integer","format":"int64","description":"The user id"},"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","description":"The SMS status"},"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","format":"int64","description":"The org id"},"timestamp":{"type":"integer","format":"int64","description":"The audit log timestamp"}},"required":["id"]},"XiqSmsLogStatus":{"type":"string","enum":["SEND_OUT","COMPLETE","SUCCESS","FAIL"]},"PagedXiqEmailLog":{"type":"object","properties":{"page":{"type":"integer","format":"int32","description":"The current page number"},"count":{"type":"integer","format":"int32","description":"The element count of the current page"},"total_pages":{"type":"integer","format":"int32","description":"The total page number based on request page size"},"total_count":{"type":"integer","format":"int64","description":"The total element count"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqEmailLog"}}},"required":["count","page","total_count","total_pages"]},"XiqEmailLog":{"type":"object","description":"ExtremeCloud IQ Email Log","properties":{"id":{"type":"integer","format":"int64","description":"The Email log id"},"username":{"type":"string","description":"The username"},"org_id":{"type":"integer","format":"int64","description":"The org id"},"timestamp":{"type":"integer","format":"int64","description":"The email log timestamp"},"user_id":{"type":"integer","format":"int64","description":"The user id"},"customer_id":{"type":"string","description":"The customer id"},"approver_email":{"type":"string","description":"The approver Email"},"status":{"type":"string","description":"The email log status"}},"required":["id"]},"PagedXiqCredentialLog":{"type":"object","properties":{"page":{"type":"integer","format":"int32","description":"The current page number"},"count":{"type":"integer","format":"int32","description":"The element count of the current page"},"total_pages":{"type":"integer","format":"int32","description":"The total page number based on request page size"},"total_count":{"type":"integer","format":"int64","description":"The total element count"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqCredentialLog"}}},"required":["count","page","total_count","total_pages"]},"XiqCredentialLog":{"type":"object","description":"ExtremeCloud IQ Credential Log","properties":{"id":{"type":"integer","format":"int64","description":"The Credential log id"},"username":{"type":"string","description":"The username"},"vhm_id":{"type":"string","description":"The vhm id"},"org_id":{"type":"integer","format":"int64","description":"The org id"},"timestamp":{"type":"integer","format":"int64","description":"The credential log timestamp"}},"required":["id"]},"PagedXiqAuthLog":{"type":"object","properties":{"page":{"type":"integer","format":"int32","description":"The current page number"},"count":{"type":"integer","format":"int32","description":"The element count of the current page"},"total_pages":{"type":"integer","format":"int32","description":"The total page number based on request page size"},"total_count":{"type":"integer","format":"int64","description":"The total element count"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqAuthLog"}}},"required":["count","page","total_count","total_pages"]},"XiqAuthLog":{"type":"object","description":"ExtremeCloud IQ Auth Log","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","format":"int64","description":"The authentication date"},"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","format":"int64","description":"The org id"},"timestamp":{"type":"integer","format":"int64","description":"The audit log timestamp"}},"required":["id"]},"PagedXiqAuditLog":{"type":"object","properties":{"page":{"type":"integer","format":"int32","description":"The current page number"},"count":{"type":"integer","format":"int32","description":"The element count of the current page"},"total_pages":{"type":"integer","format":"int32","description":"The total page number based on request page size"},"total_count":{"type":"integer","format":"int64","description":"The total element count"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqAuditLog"}}},"required":["count","page","total_count","total_pages"]},"XiqAuditLog":{"type":"object","description":"ExtremeCloud IQ Audit Log","properties":{"id":{"type":"integer","format":"int64","description":"The audit log id"},"category":{"$ref":"#/components/schemas/XiqAuditLogCategory","description":"The audit category"},"user_id":{"type":"integer","format":"int64","description":"The user id"},"code":{"type":"integer","format":"int32","description":"The audit log code"},"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","format":"int64","description":"The org id"},"timestamp":{"type":"integer","format":"int64","description":"The audit log timestamp"},"description":{"type":"string","description":"The audit log summary"},"full_description_id":{"type":"integer","format":"int64","description":"The audit log full description ID"}},"required":["id"]},"XiqAuditLogFullDescriptions":{"type":"object","description":"ExtremeCloud IQ Audit Log full descriptions","properties":{"id":{"type":"integer","format":"int64","description":"The audit log full description ID"},"timestamp":{"type":"integer","format":"int64","description":"The full description timestamp"},"device_id":{"type":"integer","format":"int64","description":"The device ID"},"description":{"type":"string","description":"The audit log full description"}},"required":["id"]},"PagedXiqAccountingLog":{"type":"object","properties":{"page":{"type":"integer","format":"int32","description":"The current page number"},"count":{"type":"integer","format":"int32","description":"The element count of the current page"},"total_pages":{"type":"integer","format":"int32","description":"The total page number based on request page size"},"total_count":{"type":"integer","format":"int64","description":"The total element count"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqAccountingLog"}}},"required":["count","page","total_count","total_pages"]},"XiqAccountingLog":{"type":"object","description":"ExtremeCloud IQ Accounting Log","properties":{"id":{"type":"integer","format":"int64","description":"The Accounting log id"},"username":{"type":"string","description":"The username"},"org_id":{"type":"integer","format":"int64","description":"The org id"},"timestamp":{"type":"integer","format":"int64","description":"The email log timestamp"},"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","format":"int64","description":"The acct start time"},"acct_stop_time":{"type":"integer","format":"int64","description":"The acct stop time"},"acct_session_time":{"type":"integer","format":"int64","description":"The acct session time"},"acct_authentic":{"type":"string","description":"The acct authentic"},"connect_info":{"type":"string","description":"The connect info"},"acct_input_octets":{"type":"integer","format":"int64","description":"The acct input octets"},"acct_output_octets":{"type":"integer","format":"int64","description":"The acct output octets"},"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","format":"int64","description":"The acct start delay"},"acct_stop_delay":{"type":"integer","format":"int64","description":"The acct stop delay"},"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","format":"int32","description":"The attribute num"},"event_time":{"type":"integer","format":"int64","description":"The event time"},"usage":{"type":"integer","format":"int64","description":"The usage"}},"required":["id"]},"XiqWallTypeReference":{"type":"object","properties":{"folder_id":{"type":"integer","format":"int64","description":"The folder ID"},"path":{"type":"string","description":"The path"}}},"PagedXiqLocationTreeMap":{"type":"object","properties":{"page":{"type":"integer","format":"int32","description":"The current page number"},"count":{"type":"integer","format":"int32","description":"The element count of the current page"},"total_pages":{"type":"integer","format":"int32","description":"The total page number based on request page size"},"total_count":{"type":"integer","format":"int64","description":"The total element count"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqLocationTreeMap"}}},"required":["count","page","total_count","total_pages"]},"XiqLocationTreeMap":{"type":"object","description":"The map on the location hierarchy.","properties":{"map_name":{"type":"string","description":"The background map name."},"width":{"type":"number","format":"double","description":"The x-dimension of the map in pixels."},"height":{"type":"number","format":"double","description":"The y-dimension of the map in pixels."},"data":{"type":"string","description":"The base-64 encoded string of the map."}},"required":["data","map_name"]},"PagedXiqLocationTreeDevice":{"type":"object","properties":{"page":{"type":"integer","format":"int32","description":"The current page number"},"count":{"type":"integer","format":"int32","description":"The element count of the current page"},"total_pages":{"type":"integer","format":"int32","description":"The total page number based on request page size"},"total_count":{"type":"integer","format":"int64","description":"The total element count"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqLocationTreeDevice"}}},"required":["count","page","total_count","total_pages"]},"XiqLocationTreeDevice":{"type":"object","description":"The device on the location hierarchy.","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","format":"int64","description":"The location ID of the device on the location hierarchy."},"map_name":{"type":"string","description":"The associated background map for the device."},"x":{"type":"number","format":"double","description":"The x-position of the device relative to the horizontal scale in meter."},"y":{"type":"number","format":"double","description":"The y-position of the device relative to the vertical scale in meter."},"scale_x":{"type":"number","format":"double","description":"The horizontal scale for the background map in meter."},"scale_y":{"type":"number","format":"double","description":"The vertical scale for the background map in meter."}},"required":["device_name","mac_address"]},"PagedXiqSite":{"type":"object","properties":{"page":{"type":"integer","format":"int32","description":"The current page number"},"count":{"type":"integer","format":"int32","description":"The element count of the current page"},"total_pages":{"type":"integer","format":"int32","description":"The total page number based on request page size"},"total_count":{"type":"integer","format":"int64","description":"The total element count"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqSite"}}},"required":["count","page","total_count","total_pages"]},"PagedXiqFloor":{"type":"object","properties":{"page":{"type":"integer","format":"int32","description":"The current page number"},"count":{"type":"integer","format":"int32","description":"The element count of the current page"},"total_pages":{"type":"integer","format":"int32","description":"The total page number based on request page size"},"total_count":{"type":"integer","format":"int64","description":"The total element count"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqFloor"}}},"required":["count","page","total_count","total_pages"]},"PagedXiqBuilding":{"type":"object","properties":{"page":{"type":"integer","format":"int32","description":"The current page number"},"count":{"type":"integer","format":"int32","description":"The element count of the current page"},"total_pages":{"type":"integer","format":"int32","description":"The total page number based on request page size"},"total_count":{"type":"integer","format":"int64","description":"The total element count"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqBuilding"}}},"required":["count","page","total_count","total_pages"]},"PagedXiqLdapServer":{"type":"object","properties":{"page":{"type":"integer","format":"int32","description":"The current page number"},"count":{"type":"integer","format":"int32","description":"The element count of the current page"},"total_pages":{"type":"integer","format":"int32","description":"The total page number based on request page size"},"total_count":{"type":"integer","format":"int64","description":"The total element count"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqLdapServer"}}},"required":["count","page","total_count","total_pages"]},"PagedXiqIpFirewall":{"type":"object","properties":{"page":{"type":"integer","format":"int32","description":"The current page number"},"count":{"type":"integer","format":"int32","description":"The element count of the current page"},"total_pages":{"type":"integer","format":"int32","description":"The total page number based on request page size"},"total_count":{"type":"integer","format":"int64","description":"The total element count"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqIpFirewall"}}},"required":["count","page","total_count","total_pages"]},"PagedXiqIotProfile":{"type":"object","properties":{"page":{"type":"integer","format":"int32","description":"The current page number"},"count":{"type":"integer","format":"int32","description":"The element count of the current page"},"total_pages":{"type":"integer","format":"int32","description":"The total page number based on request page size"},"total_count":{"type":"integer","format":"int64","description":"The total element count"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqIotProfile"}}},"required":["count","page","total_count","total_pages"]},"PagedXiqHotspotServiceProviderProfile":{"type":"object","properties":{"page":{"type":"integer","format":"int32","description":"The current page number"},"count":{"type":"integer","format":"int32","description":"The element count of the current page"},"total_pages":{"type":"integer","format":"int32","description":"The total page number based on request page size"},"total_count":{"type":"integer","format":"int64","description":"The total element count"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqHotspotServiceProviderProfile"}}},"required":["count","page","total_count","total_pages"]},"PagedXiqHotspotProfile":{"type":"object","properties":{"page":{"type":"integer","format":"int32","description":"The current page number"},"count":{"type":"integer","format":"int32","description":"The element count of the current page"},"total_pages":{"type":"integer","format":"int32","description":"The total page number based on request page size"},"total_count":{"type":"integer","format":"int64","description":"The total element count"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqHotspotProfile"}}},"required":["count","page","total_count","total_pages"]},"XiqHiqStatus":{"type":"object","properties":{"enabled":{"type":"boolean","description":"HIQ is enabled or not"}},"required":["enabled"]},"GeoViewNode":{"type":"object","description":"Geo View Node","properties":{"folder_id":{"type":"integer","format":"int64","description":"Folder ID"},"folder_name":{"type":"string","description":"Folder Name"},"folder_type":{"type":"string","description":"Folder Type"},"total_children":{"type":"integer","format":"int64","description":"Total Children"},"total_unhealthy_children":{"type":"integer","format":"int64","description":"Total Unhealthy Children"},"folders":{"type":"array","description":"List of Children","items":{"description":"Geo View Node"}}}},"EssentialsElocLastKnownLocation":{"type":"object","description":"The client's last known location on the floor plan","properties":{"timestamp":{"type":"string","description":"The located client's last known timestamp in format of date, time and abbreviated timezone"},"x":{"type":"number","format":"double","description":"The located client's last known horizontal value on the floor plan"},"y":{"type":"number","format":"double","description":"The located client's last known vertical value on the floor plan"}}},"EssentialsElocClientPathPoint":{"type":"object","description":"A point in the client's path on the floor plan","properties":{"x":{"type":"number","format":"double","description":"X coordinate on the floor plan"},"y":{"type":"number","format":"double","description":"Y coordinate on the floor plan"},"timestamp":{"type":"string","description":"Timestamp of the point (ISO 8601)"}}},"XiqClientLocationSearchInterval":{"type":"string","enum":["TODAY","YESTERDAY","SEVEN_DAYS","THIRTY_DAYS","NINETY_DAYS"]},"EssentialsElocDensityMapCell":{"type":"object","description":"A cell in the client density map","properties":{"x":{"type":"number","format":"double","description":"X coordinate of the cell"},"y":{"type":"number","format":"double","description":"Y coordinate of the cell"},"client_count":{"type":"integer","format":"int32","description":"Number of clients in the cell"}}},"EssentialsElocHourlyDensityMap":{"type":"object","description":"Density map for a specific hour","properties":{"cells":{"type":"array","description":"Density map cells for this hour","items":{"$ref":"#/components/schemas/EssentialsElocDensityMapCell"}}}},"EssentialsElocCurrentLocation":{"type":"object","description":"The current location of the client on the floor plan","properties":{"timestamp":{"type":"string","description":"The client's current timestamp (ISO 8601)"},"x":{"type":"number","format":"double","description":"X coordinate on the floor plan"},"y":{"type":"number","format":"double","description":"Y coordinate on the floor plan"}}},"EssentialsElocConnectedClientLocation":{"type":"object","description":"A connected client on a floor","properties":{"mac_address":{"type":"string","description":"Client MAC address"},"display_name":{"type":"string","description":"Client display name"},"timestamp":{"type":"string","description":"Timestamp of the location (ISO 8601)"},"x":{"type":"number","format":"double","description":"X coordinate on the floor plan"},"y":{"type":"number","format":"double","description":"Y coordinate on the floor plan"}}},"PagedXiqEndUser":{"type":"object","properties":{"page":{"type":"integer","format":"int32","description":"The current page number"},"count":{"type":"integer","format":"int32","description":"The element count of the current page"},"total_pages":{"type":"integer","format":"int32","description":"The total page number based on request page size"},"total_count":{"type":"integer","format":"int64","description":"The total element count"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqEndUser"}}},"required":["count","page","total_count","total_pages"]},"XiqLockedClientSortField":{"type":"string","enum":["LOCKED_AT"]},"PagedXiqLockedClient":{"type":"object","properties":{"page":{"type":"integer","format":"int32","description":"The current page number"},"count":{"type":"integer","format":"int32","description":"The element count of the current page"},"total_pages":{"type":"integer","format":"int32","description":"The total page number based on request page size"},"total_count":{"type":"integer","format":"int64","description":"The total element count"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqLockedClient"}}},"required":["count","page","total_count","total_pages"]},"XiqHmIdName":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"The HM ID"},"name":{"type":"string","description":"The HM name"}}},"XiqLockedClient":{"type":"object","properties":{"client_name":{"type":"string","description":"The client name"},"client_mac":{"type":"string","description":"The client mac address"},"ssid":{"type":"string","description":"The ssid"},"user_name":{"type":"string","description":"The user name"},"hm_id_names":{"type":"array","description":"The HM ID and name list","items":{"$ref":"#/components/schemas/XiqHmIdName"}},"locked_at":{"type":"integer","format":"int64","description":"The timestamp when the client was locked"},"device_id":{"type":"integer","format":"int64","description":"The device ID of the client"}}},"XiqEmailTemplate":{"type":"object","description":"The password or ppsk notification template for user groups.","properties":{"id":{"type":"integer","format":"int64","description":"The unique identifier"},"create_time":{"type":"string","format":"date-time","description":"The create time in UTC (ISO 8601 format)"},"update_time":{"type":"string","format":"date-time","description":"The last update time in UTC (ISO 8601 format)"},"org_id":{"type":"integer","format":"int64","description":"The organization identifier, valid when enabling HIQ feature"},"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 security type"}},"required":["create_time","id","name","password_type","predefined","update_time"]},"XiqDeviceSortField":{"type":"string","description":"All available device sort fields<br/><br/>MAC = Device MAC Address<br/>SN = Device Serial Number","enum":["MAC","SN"]},"XiqDeviceView":{"type":"string","description":"The logic collections of device fields<br/><br/>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<br>FULL: All fields<br/>STATUS: ID, DEVICE_ADMIN_STATE, CONNECTED<br/>LOCATION: ID, LOCATION_ID, LOCATIONS<br>CLIENT: ID, ACTIVE_CLIENTS<br/>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, IMAGES_NAMES, MGT_VLAN, VISIBLE","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","IMAGES_NAMES","MGT_VLAN","VISIBLE","SUBSCRIPTION_LICENSE"]},"XiqDeviceNullField":{"type":"string","enum":["LOCATION_ID","NETWORK_POLICY_ID"]},"PagedXiqDevice":{"type":"object","properties":{"page":{"type":"integer","format":"int32","description":"The current page number"},"count":{"type":"integer","format":"int32","description":"The element count of the current page"},"total_pages":{"type":"integer","format":"int32","description":"The total page number based on request page size"},"total_count":{"type":"integer","format":"int64","description":"The total element count"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqDevice"}}},"required":["count","page","total_count","total_pages"]},"XiqDeviceFunction":{"type":"string","enum":["AP","ROUTER","ROUTER_AS_L2_VPN_GATEWAY","ROUTER_AS_L3_VPN_GATEWAY","SWITCH","SWITCH_HAC","SWITCH_DELL","L2_VPN_GATEWAY","L3_VPN_GATEWAY","IQ_CONTROLLER"]},"XiqDeviceLldpCdpInfo":{"type":"object","description":"The LLDP/CDP information","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."},"management_ip":{"type":"string","description":"The management IP."},"port_description":{"type":"string","description":"The port description."}}},"XiqDeviceResponse":{"type":"object","description":"Generic ExtremeCloud IQ Device model","properties":{"id":{"type":"integer","format":"int64","description":"The unique identifier"},"create_time":{"type":"string","format":"date-time","description":"The create time in UTC (ISO 8601 format)"},"update_time":{"type":"string","format":"date-time","description":"The last update time in UTC (ISO 8601 format)"},"org_id":{"type":"integer","format":"int64","description":"The organization identifier, valid when enabling HIQ feature"},"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","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."},"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","description":"The device admin state"},"connected":{"type":"boolean","description":"The device connection status"},"last_connect_time":{"type":"string","format":"date-time","description":"The device last connect time"},"network_policy_name":{"type":"string","description":"The network policy name for the device"},"network_policy_id":{"type":"integer","format":"int64","description":"The network policy ID for the device"},"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","format":"int32","description":"The ipv6 netmask for the device"},"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","format":"int32","description":"The active client count for the device"},"location_id":{"type":"integer","format":"int64","description":"The location ID for the device"},"locations":{"type":"array","description":"The detailed location","items":{"$ref":"#/components/schemas/XiqLocationLegendDetails"}},"country_code":{"type":"integer","format":"int32","description":"The assigned country code on the device"},"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","format":"int64","description":"The device uptime"},"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"},"mgt_vlan":{"type":"integer","format":"int32","description":"Management VLAN"},"images_names":{"type":"array","description":"List of images assigned to this device","items":{"type":"string"}},"visible":{"type":"boolean","description":"The visible status of a device in a floor."},"subscription_license":{"type":"string","description":"The Subscription License of the device."}},"required":["create_time","id","update_time"]},"XiqFolderType":{"type":"string","description":"Folder type","enum":["SITE","BUILDING","FLOOR","GENERIC"],"example":"SITE"},"XiqLocationLegendDetails":{"type":"object","description":"The simple location information","properties":{"id":{"type":"integer","format":"int64","description":"The location ID"},"name":{"type":"string","description":"The location name"},"folder_type":{"$ref":"#/components/schemas/XiqFolderType","description":"Folder type","example":"SITE"}}},"XiqDeviceLevelSsidStatus":{"type":"object","description":"The SSID status","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"}},"required":["wifi0_enabled","wifi1_enabled"]},"XiqDeviceMonitorRefreshStatusResponse":{"type":"object","description":"The request for on demand refresh information.","properties":{"status":{"type":"string","description":"The device monitor refresh status","enum":["INVALID","FINISHED","UNFINISHED","TASK_NOT_EXIST","UNKNOWN","UNRECOGNIZED"]},"task_key":{"type":"string","description":"The device monitor refresh task key"},"percentage":{"type":"integer","format":"int32","description":"The device monitor refresh percentage"}},"required":["percentage","status","task_key"]},"XiqDeviceIotInterfaceSettingsEntry":{"type":"object","description":"The payload of device IoT Interface settings","properties":{"enabled":{"type":"boolean","description":"Whether IoT is enabled with Interface settings."},"iot_profile":{"$ref":"#/components/schemas/XiqIotProfile","description":"IoT profile"}}},"XiqDeviceWifiInterface":{"type":"object","description":"Get the device WiFi interface stats","properties":{"frequency":{"type":"string","description":"The WiFi frequency."},"ssid_count":{"type":"integer","format":"int32","description":"The number of SSID assigned on this wireless interface."},"client_count":{"type":"integer","format":"int64","description":"The number of clients associated to this wireless interface."},"neighbor_clients":{"type":"integer","format":"int64","description":"The number of neighboring clients."},"channel_util":{"type":"integer","format":"int32","description":"The channel utilization."},"channel":{"type":"integer","format":"int32","description":"The channel associated."},"channel_width":{"type":"integer","format":"int32","description":"The channel width."},"tx_utilization":{"type":"integer","format":"int64","description":"The total tx utilization."},"rx_utilization":{"type":"integer","format":"int64","description":"The total rx utilization."},"tx_byte_count":{"type":"integer","format":"int64","description":"The total tx byte count."},"rx_byte_count":{"type":"integer","format":"int64","description":"The total rx byte count."},"noise_floor":{"type":"integer","format":"int64","description":"The noise floor."},"crc_error_frame":{"type":"integer","format":"int64","description":"The crc error frame count."},"tx_retry_frame":{"type":"integer","format":"int64","description":"The tx retry frame"},"rx_retry_frame":{"type":"integer","format":"int64","description":"The rx retry fram."},"unicast_tx_packet_count":{"type":"integer","format":"int64","description":"The unicast tx packet count."},"unicast_rx_packet_count":{"type":"integer","format":"int64","description":"The unicast rx packet count."},"broadcast_tx_packet_count":{"type":"integer","format":"int64","description":"The broadcast tx packet count."},"broadcast_rx_packet_count":{"type":"integer","format":"int64","description":"The broadcast rx packet count."},"tx_air_time":{"type":"integer","format":"int64","description":"The tx air time."},"rx_air_time":{"type":"integer","format":"int64","description":"The rx air time."},"total_utilization":{"type":"integer","format":"int64","description":"The total utilization."},"scan_avg_interference":{"type":"integer","format":"int32","description":"The average interference."},"mac_address":{"type":"string","description":"The bssid."},"power":{"type":"integer","format":"int32","description":"The radio power."},"rx_errors":{"type":"integer","format":"int64","description":"The rx errors."},"tx_errors":{"type":"integer","format":"int64","description":"The tx errors."},"interface_name":{"type":"string","description":"The interface name."},"radio_profile_name":{"type":"string","description":"The ExtremecloudIQ radio profile name."}}},"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"}},"installation_time":{"type":"string","format":"date-time"},"installed_by":{"type":"string"},"image_file_details":{"type":"array","items":{"$ref":"#/components/schemas/XiqImageFileDetails"}}}},"XiqImageFileDetails":{"type":"object","properties":{"file_name":{"type":"string"},"complete_url":{"type":"string"}}},"XiqDeviceIbeacon":{"type":"object","description":"The device iBeacon settings.","properties":{"device_id":{"type":"integer","format":"int64","description":"The device ID."},"enabled":{"type":"boolean","description":"Whether the device beacon is enabled."},"major":{"type":"integer","format":"int32","description":"Identification of a subset of beacons in a geographical venue.","maximum":65635,"minimum":0},"minor":{"type":"integer","format":"int32","description":"Identification of a beacon in a specific location.","maximum":65635,"minimum":0},"power":{"type":"integer","format":"int32","description":"The transmission power in dBm.","maximum":127,"minimum":-128},"enable_monitoring":{"type":"boolean","description":"Whether to enable monitoring, this field has been deprecated but remains for backwards compatability, renamed to 'enable_ble_scan_ibeacon'."},"enable_ble_scan_ibeacon":{"type":"boolean","description":"Whether to enable BLE Scan iBeacon monitoring."},"enable_ble_scan_generic":{"type":"boolean","description":"Whether to enable BLE Scan Generic monitoring."},"enable_cloud_reporting":{"type":"boolean","description":"Whether the device BLE Scan Cloud Reporting is enabled. Default to true for newly enabled device."},"enable_batch_reporting":{"type":"boolean","description":"Whether the device BLE Scan Batch Reporting is enabled. Default to false for newly enabled device."}},"required":["device_id"]},"XiqDeviceCpuMemoryUsage":{"type":"object","description":"Get time series of the average device cpu and memory usage","properties":{"average_cpu":{"type":"integer","format":"int32","description":"The device average cpu usage"},"average_memory":{"type":"integer","format":"int32","description":"The device average memory usage"},"timestamp":{"type":"integer","format":"int64","description":"The timestamp for data aggregate"}}},"XiqDeviceGeolocation":{"type":"object","description":"Device geolocation info","properties":{"latitude":{"type":"number","format":"double","description":"The latitude of the AP"},"longitude":{"type":"number","format":"double","description":"The longitude of the AP"},"height":{"type":"number","format":"double","description":"The height above sea level of the AP"},"major_axis":{"type":"number","format":"double","description":"The major axis of the AP"},"minor_axis":{"type":"number","format":"double","description":"The minor axis of the AP"},"orientation":{"type":"number","format":"double","description":"The orientation of the AP"},"last_reported":{"type":"integer","format":"int64","description":"The last updated time of the geolocation"}},"required":["height","last_reported","longitude","orientation"]},"PagedXiqDeviceAlarm":{"type":"object","properties":{"page":{"type":"integer","format":"int32","description":"The current page number"},"count":{"type":"integer","format":"int32","description":"The element count of the current page"},"total_pages":{"type":"integer","format":"int32","description":"The total page number based on request page size"},"total_count":{"type":"integer","format":"int64","description":"The total element count"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqDeviceAlarm"}}},"required":["count","page","total_count","total_pages"]},"XiqDeviceAlarm":{"type":"object","description":"The device alarm view","properties":{"entity_id":{"type":"integer","format":"int64","description":"The device ID"},"timestamp":{"type":"integer","format":"int64","description":"The timestamp for alarm created"},"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"}}},"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"}}},"XiqRmStackMemberInfo":{"type":"object","properties":{"hostname":{"type":"string","description":"The stack member name."},"serial_number":{"type":"string","description":"The stack member serial number."},"ip_address":{"type":"string","description":"The stack member IP address."},"mac_address":{"type":"string","description":"The stack member MAC address."},"product_type":{"type":"string","description":"The stack member product type."}}},"PagedXiqRadioEntity":{"type":"object","properties":{"page":{"type":"integer","format":"int32","description":"The current page number"},"count":{"type":"integer","format":"int32","description":"The element count of the current page"},"total_pages":{"type":"integer","format":"int32","description":"The total page number based on request page size"},"total_count":{"type":"integer","format":"int64","description":"The total element count"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqRadioEntity"}}},"required":["count","page","total_count","total_pages"]},"XiqRadio":{"type":"object","description":"ExtremeCloud IQ Radio Information associated to a device","properties":{"name":{"type":"string","description":"the radio name"},"channel_number":{"type":"integer","format":"int32","description":"the channel number"},"channel_width":{"type":"string","description":"The channel width.","enum":["MHZ_20","MHZ_40","MHZ_80","MHZ_160","MHZ_320"],"example":"MHZ_20"},"mode":{"type":"string","description":"The radio mode indicating the WiFi standard and frequency band.","enum":["_11bg","_11a","_11an","_11ng","_11ac","_11ax_2g","_11ax_5g","_11ax_6g","_11be_2g","_11be_5g","_11be_6g"],"example":"_11ax_5g"},"mac_address":{"type":"string","description":"The radio MAC address in format XXXXXXXXXXXX","example":"001122334455"},"power":{"type":"integer","format":"int32","description":"The radio transmission power in dBm."},"frequency":{"type":"string","description":"WiFi frequency band","enum":["2.4GHz","5GHz","6GHz"]},"clients":{"type":"array","description":"the clients and SSID details","items":{"$ref":"#/components/schemas/XiqWirelessClient"}},"wlans":{"type":"array","description":"the radios WLAN details","items":{"$ref":"#/components/schemas/XiqWirelessWlan"}}},"required":["channel_width","mode","name"]},"XiqRadioEntity":{"type":"object","description":"ExtremeCloud IQ Radio Information per device","properties":{"device_id":{"type":"integer","format":"int64","description":"the device ID"},"radios":{"type":"array","description":"the radio information associated to device","items":{"$ref":"#/components/schemas/XiqRadio"}}},"required":["device_id"]},"XiqSsidAccessSecurityType":{"type":"string","enum":["OPEN","ENHANCED_OPEN","PPSK","PSK","WEP","TYPE_802DOT1X"]},"XiqSsidStatus":{"type":"string","enum":["OPEN","CLOSED"]},"XiqWirelessClient":{"type":"object","description":"ExtremeCloud IQ BSS and Network Data","properties":{"network_policy_name":{"type":"string","description":"The Network Policy Name"},"ssid":{"type":"string","description":"The SSID"},"ssid_status":{"$ref":"#/components/schemas/XiqSsidStatus","description":"The SSID status"},"ssid_security_type":{"$ref":"#/components/schemas/XiqSsidAccessSecurityType","description":"The SSID access security type"}}},"XiqWirelessWlan":{"type":"object","description":"ExtremeCloud IQ BSS and Network Data","properties":{"network_policy_name":{"type":"string","description":"The Network Policy Name"},"ssid":{"type":"string","description":"The SSID"},"ssid_status":{"$ref":"#/components/schemas/XiqSsidStatus","description":"The SSID status"},"ssid_security_type":{"$ref":"#/components/schemas/XiqSsidAccessSecurityType","description":"The SSID access security type"},"bssid":{"type":"string","description":"The BSSID in MAC address format XXXXXXXXXXXX","example":"001122334455"}}},"PagedXiqDigitalTwinProducts":{"type":"object","properties":{"page":{"type":"integer","format":"int32","description":"The current page number"},"count":{"type":"integer","format":"int32","description":"The element count of the current page"},"total_pages":{"type":"integer","format":"int32","description":"The total page number based on request page size"},"total_count":{"type":"integer","format":"int64","description":"The total element count"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqDigitalTwinProducts"}}},"required":["count","page","total_count","total_pages"]},"XiqDigitalTwinProducts":{"type":"object","description":"The Digital Twin product information.","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"}}},"required":["make","model","os_versions"]},"PagedXiqDeploymentDetailsResponse":{"type":"object","properties":{"page":{"type":"integer","format":"int32","description":"The current page number"},"count":{"type":"integer","format":"int32","description":"The element count of the current page"},"total_pages":{"type":"integer","format":"int32","description":"The total page number based on request page size"},"total_count":{"type":"integer","format":"int64","description":"The total element count"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqDeploymentDetailsResponse"}}},"required":["count","page","total_count","total_pages"]},"XiqDeploymentDetailsResponse":{"type":"object","description":"The deployment","properties":{"deployment_id":{"type":"integer","format":"int64","description":"The deployment ID"},"schedule":{"$ref":"#/components/schemas/XiqScheduleDetails","description":"The schedule details"},"devices":{"$ref":"#/components/schemas/XiqDevices","description":"The device and site IDs"},"policy":{"$ref":"#/components/schemas/XiqDeploymentsPolicyResponse","description":"The policy details"},"schedule_status":{"$ref":"#/components/schemas/XiqScheduleStatus","description":"The schedule status"},"overview":{"$ref":"#/components/schemas/XiqDeploymentOverviewDetails","description":"The overview details"}}},"XiqDeploymentOverviewDetails":{"type":"object","description":"The configuration deployment overview","properties":{"total_devices":{"type":"integer","format":"int32","description":"The total device count"},"in_progress_devices":{"type":"integer","format":"int32","description":"The device count with in progress deployment"},"total_progress":{"type":"integer","format":"int32","description":"The total progress, range from 0 to 100"}}},"XiqDeploymentsPolicyResponse":{"type":"object","description":"The deployment policy","properties":{"enable_complete_configuration_update":{"type":"boolean","description":"True if update complete configuration, otherwise update delta configuration."},"firmware_upgrade_policy":{"$ref":"#/components/schemas/XiqFirmwareUpgradePolicy","description":"The firmware upgrade policy"},"firmware_upgrade_versions":{"type":"array","description":"The firmware upgrade versions","items":{"$ref":"#/components/schemas/XiqFirmwareUpgradeVersion"}},"firmware_activate_option":{"$ref":"#/components/schemas/XiqFirmwareActivateOption","description":"The firmware activate option"}}},"XiqDevices":{"type":"object","description":"The device details response","properties":{"ids":{"type":"array","description":"The device ids","items":{"type":"integer","format":"int64"}},"site_ids":{"type":"array","description":"The site ids","items":{"type":"integer","format":"int64"}}}},"XiqScheduleStatus":{"type":"string","enum":["SCHEDULED","IN_PROGRESS","ABORTED","COMPLETED","FAILED","TIME_OUT"]},"XiqDeploymentByIdStatusResponse":{"type":"object","description":"The deployment details status response","properties":{"schedule_status":{"$ref":"#/components/schemas/XiqScheduleStatus","description":"The schedule status"},"schedule_time":{"type":"integer","format":"int64","description":"The scheduled time"},"created_time":{"type":"integer","format":"int64","description":"The created time"},"updated_time":{"type":"integer","format":"int64","description":"The updated time"},"site_info":{"type":"array","description":"The site information tagged to devices","items":{"$ref":"#/components/schemas/XiqSiteInfo"}},"deployment_status":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/XiqDeploymentStatus"},"description":"The deployment status"},"overview":{"$ref":"#/components/schemas/XiqDeploymentOverviewDetails","description":"The overview details"}}},"XiqSiteInfo":{"type":"object","description":"The schedule response","properties":{"site_id":{"type":"integer","format":"int64","description":"The site ID"},"device_ids":{"type":"array","description":"The device IDs","items":{"type":"integer","format":"int64"}},"overview":{"$ref":"#/components/schemas/XiqDeploymentOverviewDetails","description":"The overview details"}}},"XiqDeploymentOverview":{"type":"object","description":"The configuration deployment overview","properties":{"in_progress_devices":{"type":"integer","format":"int32","description":"The device count with in progress deployment"},"total_progress":{"type":"integer","format":"int32","description":"The total progress, range from 0 to 100"}},"required":["in_progress_devices","total_progress"]},"PagedXiqDeviceRebootSummary":{"type":"object","properties":{"page":{"type":"integer","format":"int32","description":"The current page number"},"count":{"type":"integer","format":"int32","description":"The element count of the current page"},"total_pages":{"type":"integer","format":"int32","description":"The total page number based on request page size"},"total_count":{"type":"integer","format":"int64","description":"The total element count"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqDeviceRebootSummary"}}},"required":["count","page","total_count","total_pages"]},"XiqDeviceRebootSummary":{"type":"object","description":"Wireless clients issue association","properties":{"date_time":{"type":"integer","format":"int64","description":"The time and date when the reboot occurred"},"description":{"type":"string","description":"The reason why the reboot occurred."}}},"XiqWirelessDashboardCriteriaParamResponse":{"type":"object","description":"The wireless diagnostics criteria param response","properties":{"client_health_criteria_param":{"$ref":"#/components/schemas/XiqWirelessClientHealthCriteriaParam","description":"The client health criteria param"},"device_health_criteria_param":{"$ref":"#/components/schemas/XiqWirelessDeviceHealthCriteriaParam","description":"The device health criteria param"},"usage_capacity_criteria_param":{"$ref":"#/components/schemas/XiqWirelessUsageCapacityCriteriaParam","description":"The usage capacity criteria param"}}},"XiqChannelUtilizationDetails":{"type":"object","properties":{"interference_percentage":{"type":"integer","format":"int32","description":"The interference percentage (0-100)"},"tx_retries_percentage":{"type":"integer","format":"int32","description":"The TX retries percentage (0-100)"},"rx_retries_percentage":{"type":"integer","format":"int32","description":"The RX retries percentage (0-100)"}}},"XiqWirelessInterfacesStats":{"type":"object","properties":{"wifi0":{"$ref":"#/components/schemas/XiqWirelessWifi","description":"The unique identifier of the wireless interface"},"wifi1":{"$ref":"#/components/schemas/XiqWirelessWifi","description":"The unique identifier of the wireless interface"},"wifi2":{"$ref":"#/components/schemas/XiqWirelessWifi2","description":"The unique identifier of the wireless interface"}}},"XiqWirelessWifi":{"type":"object","properties":{"ssid_count":{"type":"integer","format":"int32","description":"The count of SSIDs"},"ssids":{"type":"array","description":"The list of SSIDs","items":{"type":"string"}},"number_of_clients":{"type":"integer","format":"int64","description":"The total number of clients"},"channel_utilization":{"type":"integer","format":"int32","description":"The channel utilization as a percentage (0-100)."},"channel":{"type":"integer","format":"int32","description":"The value for channel"},"channel_width":{"type":"integer","format":"int32","description":"The channel width in MHz. Possible values: 20, 40, 80, 160, 320."},"load_balancing":{"type":"boolean","description":"The value for load balancing"},"band_steering":{"type":"boolean","description":"The value for band steering"},"channel_utilization_details":{"$ref":"#/components/schemas/XiqChannelUtilizationDetails","description":"The value for Channel Utilization Details"}}},"XiqWirelessWifi2":{"type":"object","properties":{"ssid_count":{"type":"integer","format":"int32","description":"The count of SSIDs"},"ssids":{"type":"array","description":"The list of SSIDs","items":{"type":"string"}},"number_of_clients":{"type":"integer","format":"int64","description":"The total number of clients"},"channel_utilization":{"type":"integer","format":"int32","description":"The value for channel utilization"},"channel":{"type":"integer","format":"int32","description":"The value for channel"},"channel_width":{"type":"integer","format":"int32","description":"The channel width in MHz. Possible values: 20, 40, 80, 160, 320."},"load_balancing":{"type":"boolean","description":"The value for load balancing"},"band_steering":{"type":"boolean","description":"The value for band steering"},"channel_utilization_details":{"$ref":"#/components/schemas/XiqChannelUtilizationDetails","description":"The value for Channel Utilization Details"},"xiq_ap_afc_status":{"type":"string","description":"The value for afc status","enum":["PENDING","GRACE_PERIOD","AVAILABLE","NA"]}}},"XiqRmChannelFilterType":{"type":"string","enum":["WIFI0","WIFI1","WIFI2"]},"XiqRmSourceFilterType":{"type":"string","enum":["CHANNEL_UTILIZATION","CONNECTED_CLIENTS"]},"XiqWirelessInterfaceGraph":{"type":"object","properties":{"timestamp":{"type":"integer","format":"int64","description":"The graph metric timestamp"},"channel_utilization":{"type":"integer","format":"int64","description":"The channel utilization"},"connected_clients":{"type":"integer","format":"int64","description":"The channel utilization percentage"}}},"PagedXiqWiredPortQosState":{"type":"object","properties":{"page":{"type":"integer","format":"int32","description":"The current page number"},"count":{"type":"integer","format":"int32","description":"The element count of the current page"},"total_pages":{"type":"integer","format":"int32","description":"The total page number based on request page size"},"total_count":{"type":"integer","format":"int64","description":"The total element count"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqWiredPortQosState"}}},"required":["count","page","total_count","total_pages"]},"XiqWiredPortQosState":{"type":"object","description":"QOS queue statistics of the interface","properties":{"port_name":{"type":"string","description":"The interface name"},"queue_stats":{"type":"array","description":"QOS queue statistics of the interface","items":{"$ref":"#/components/schemas/XiqWiredQueueStats"}}}},"XiqWiredQueueStats":{"type":"object","description":"QOS queue statistics","properties":{"qos_queue":{"type":"integer","format":"int64","description":"QOS queue value"},"cong_pkts":{"type":"integer","format":"int64","description":"Number of packets dropped due to congestion on the QOS queue"},"tx_pkts":{"type":"integer","format":"int64","description":"Number of packets transmitted on the QOS queue"}}},"XiqSsidMetadata":{"type":"object","properties":{"ssids":{"type":"array","description":"The list of SSIDs","items":{"type":"string"}}}},"XiqD360DeviceSummary":{"type":"object","properties":{"connected_status":{"type":"boolean","description":"The connected status of the device"},"active_since":{"type":"integer","format":"int64","description":"The timestamp when the device became active. Unix timestamp in milliseconds since epoch.","example":1622548800000},"device_health_issues":{"type":"integer","format":"int32"},"usage_and_capacity_issues":{"type":"integer","format":"int32"},"client_health_issues":{"type":"integer","format":"int32"},"device_details":{"$ref":"#/components/schemas/XiqDeviceDetails"},"system_information":{"$ref":"#/components/schemas/XiqDeviceSystemInformation"}}},"XiqDeviceDetails":{"type":"object","description":"The device details","properties":{"system_name":{"type":"string","description":"The system name of the device.","example":"AP-Office-01"},"ip_address":{"type":"string","description":"Management IP address. Supports IPv4 (e.g., 192.0.2.1) or IPv6 (e.g., 2001:db8::1). Prefer canonical presentation; use separate fields or oneOf if you need strict validation.","example":"192.0.2.1"},"model":{"type":"string","description":"The device model name or number.","example":"AP-220"},"sys_up_time":{"type":"string","description":"System uptime duration. Represented in seconds (integer) or as an ISO-8601 duration string (e.g., PT1H). Preferred representation: seconds.","example":3600},"os_version":{"type":"string","description":"The operating system version of the device.","example":"v3.2.1"},"location":{"type":"string","description":"The physical location of the device.","example":"Data Center Rack 4B"},"system_mac":{"type":"string","description":"List of device MAC addresses to filter. Each MAC may be 12 hex characters (no separators) or use colon/dash delimiters.","example":["001122334455","AABBCCDDEEFF"]},"serial_number":{"type":"string","description":"The serial number of the device.","example":"SN123456789"},"system_description":{"type":"string","description":"A detailed description of the device system.","example":"Main office AP providing Wi-Fi on 2.4GHz and 5GHz bands"},"software_version":{"type":"string","description":"The software version running on the device.","example":"3.2.1"},"installation_time":{"type":"string","format":"date-time","description":"The timestamp when the device was installed.","example":"2023-11-05T14:48:00Z"},"device_license_tier":{"$ref":"#/components/schemas/XiqDeviceLicenseTier","description":"The license tier of the device"},"device_license_type":{"type":"string","description":"The license type of the device","enum":["LEGACY","NAVIGATOR","PILOT","COPILOT","NONE","NA","TRIAL","NOT_REQUIRED","GRACEPERIOD","UNLICENSED","STANDARD","ADVANCED","NOT_LICENSED"]}}},"XiqDeviceSystemInformation":{"type":"object","properties":{"host_name":{"type":"string","description":"The name of the host"},"network_policy":{"type":"string","description":"The network policy applied to the device"},"ssids":{"type":"array","description":"The SSID of the network","items":{"type":"string"}},"device_model":{"type":"string","description":"The model of the device","example":"XIQ-AP2000"},"function":{"$ref":"#/components/schemas/XiqDeviceFunction"},"device_template":{"type":"string","description":"The configuration template applied to the device","example":"Default-Office-Template"},"configuration_type":{"type":"string","description":"The device configuration type. Possible values: DEFAULT (factory default), TEMPLATE (applied from a template), CUSTOM (user-configured).","enum":["DEFAULT","TEMPLATE","CUSTOM"],"example":"TEMPLATE"},"serial_number":{"type":"string","description":"The serial number of the device","example":"SN123456789"},"iq_engine":{"type":"string","description":"The IQ engine version or type used by the device","example":"v2.1.0"},"device_status":{"$ref":"#/components/schemas/XiqDeviceAdminState"},"mgt0_ipv4_address":{"type":"string","description":"Management IPv4 address","example":"192.168.1.1"},"mgt0_ipv6_address":{"type":"string","description":"Management IPv6 address","example":"2001:db8::1"},"ipv4_subnet_mask":{"type":"string","description":"The IPv4 subnet mask in dotted-decimal notation.","example":"255.255.255.0"},"ipv6_subnet_mask":{"type":"string","description":"The IPv6 subnet mask or prefix length. Accepted formats: numeric prefix length (e.g., \"64\") or CIDR notation with an IPv6 network (e.g., \"2001:db8::/64\").","example":"2001:db8::/64"},"ipv4_default_gateway":{"type":"string","description":"The IPv4 default gateway address","example":"192.168.1.1"},"ipv6_default_gateway":{"type":"string","description":"The IPv6 default gateway address","example":"2001:db8::1"},"mgt0_macaddress":{"type":"string","description":"The MAC address of the management interface in six hex byte pairs (colon or hyphen separated).","example":"01:23:45:67:89:ab"},"dns":{"type":"string","description":"The DNS server address(es). Either a single IPv4 or IPv6 address, or a comma-separated list of addresses. Spaces around commas are allowed.","example":"192.168.1.1, 2001:db8::1"},"ntp":{"type":"string","description":"The NTP server address(es). Either a single hostname or IP (IPv4/IPv6), or a comma-separated list of addresses. Spaces around commas are allowed.","example":"time.nist.gov, 192.168.1.1"}}},"EventCount":{"type":"object","description":"Event count for a specific type","properties":{"event_name":{"type":"string","description":"The name of the event type","enum":["CRITICAL","MAJOR","MINOR","INFO","ACTIVE","CLEAR","ALL","WARNING"]},"count":{"type":"integer","format":"int64","description":"Number of events of this type at the timestamp"}}},"EventGraphResponse":{"type":"object","properties":{"timestamped_events_list":{"type":"array","items":{"$ref":"#/components/schemas/TimestampedEvents"}}}},"TimestampedEvents":{"type":"object","description":"Event metrics for a specific timestamp","properties":{"timestamp":{"type":"integer","format":"int64","description":"The timestamp of the event metric (Unix epoch in ms)"},"events":{"type":"array","description":"List of event types and their counts","items":{"$ref":"#/components/schemas/EventCount"}}}},"XiqD360DeviceStats":{"type":"object","properties":{"device_hostname":{"type":"string"},"device_ip":{"type":"string"},"site":{"type":"string"},"building":{"type":"string"},"floor":{"type":"string"},"cpu_usage_percentage":{"type":"integer","format":"int64"},"memory_usage_percentage":{"type":"integer","format":"int64"},"poe_usage_indicator":{"type":"boolean"},"channel_change":{"type":"integer","format":"int64"},"wifi_reboots":{"type":"integer","format":"int64"},"eth0_unicast_score":{"type":"integer","format":"int64"},"eth0_broadcast_score":{"type":"integer","format":"int64"},"eth0_multicast_score":{"type":"integer","format":"int64"},"eth1_unicast_score":{"type":"integer","format":"int64"},"eth1_broadcast_score":{"type":"integer","format":"int64"},"eth1_multicast_score":{"type":"integer","format":"int64"}}},"XiqDeviceData":{"type":"object","description":"The folder path info","properties":{"folder_id":{"type":"integer","format":"int64"},"device_mac_address":{"type":"string"},"device_type":{"type":"string"},"device_function":{"type":"string"},"host_name":{"type":"string"},"device_model":{"type":"string"},"image_base_url":{"type":"string"},"image_file_name":{"type":"string"},"image_width":{"type":"integer","format":"int32"},"image_height":{"type":"integer","format":"int32"},"connected_since":{"type":"integer","format":"int64"},"serial_number":{"type":"string"},"metric_height":{"type":"number","format":"double"},"metric_width":{"type":"number","format":"double"},"xaxis":{"type":"number","format":"double"},"yaxis":{"type":"number","format":"double"}},"required":["connected_since","device_function","device_mac_address","device_model","device_type","folder_id","host_name","image_base_url","image_file_name","image_height","image_width","metric_height","metric_width","serial_number"]},"XiqDeviceMetaData":{"type":"object","properties":{"xiq_device_data":{"$ref":"#/components/schemas/XiqDeviceData","description":"Device Meta Data information"},"xiq_device_path":{"$ref":"#/components/schemas/XiqDevicePath","description":"Device Folder Information"},"xiq_network_policy":{"$ref":"#/components/schemas/XiqNetworkPolicyInfo","description":"Network Policy Information"}}},"XiqDevicePath":{"type":"object","description":"Device Path Informatio","properties":{"folder_path_info":{"type":"array","description":"Folder Path Information","items":{"$ref":"#/components/schemas/XiqFolderPathInfo"}}},"required":["folder_path_info"]},"XiqFolderPathInfo":{"type":"object","description":"The folder path info","properties":{"folder_id":{"type":"integer","format":"int64","description":"folder Id"},"parent_id":{"type":"integer","format":"int64","description":"parent Id"},"name":{"type":"string","description":"folder name"},"folder_type":{"type":"string","description":"folder type"}},"required":["folder_id","folder_type","name","parent_id"]},"XiqNetworkPolicyInfo":{"type":"object","description":"Network Policy Information","properties":{"policy_id":{"type":"integer","format":"int64"},"policy_name":{"type":"string"}},"required":["policy_id","policy_name"]},"XiqDeviceIssues":{"type":"object","description":"The device details","properties":{"authentication_failures":{"type":"integer","format":"int64","description":"The count of authentication failures"},"association_failures":{"type":"integer","format":"int64","description":"The count of association issues"},"ip_address_issues":{"type":"integer","format":"int64","description":"The count of IP address issues"},"excessive_packet_loss_ap_count":{"type":"integer","format":"int64","description":"The total count of number of packets lost"},"excessive_packet_loss_ap_count_5g":{"type":"integer","format":"int64","description":"The total count of number of packets lost (in 5g band)"},"excessive_packet_loss_ap_count_6g":{"type":"integer","format":"int64","description":"The total count of number of packets lost (in 6g band)"},"total_clients":{"type":"integer","format":"int64","description":"The total clients of the device"},"excessive_packet_loss_ap_count_2dot4g":{"type":"integer","format":"int64","description":"The count of number of packets lost (in 2.4g band)"}}},"XiqWifiInterfaceType":{"type":"string","enum":["WIFI0","WIFI1","WIFI2"]},"XiqWirelessIntPerDevice":{"type":"object","properties":{"wifi_interface_type_list":{"type":"array","description":"The list of Wifi Interface Stats","items":{"$ref":"#/components/schemas/XiqWifiInterfaceType"}}}},"XiqClientStats":{"type":"object","properties":{"total_clients":{"type":"integer","format":"int64","description":"Total clients within selected time range."},"poor_health_clients":{"type":"integer","format":"int64","description":"Number of poor health clients"},"unique_clients":{"type":"integer","format":"int64","description":"Number of fair health clients"}}},"XiqD360ClientGridMetadata":{"type":"object","properties":{"alias":{"type":"array","items":{"type":"string"}},"auth_methods":{"type":"array","items":{"type":"string"}},"encryption_methods":{"type":"array","items":{"type":"string"}},"operating_systems":{"type":"array","items":{"type":"string"}},"ssids":{"type":"array","items":{"type":"string"}},"user_profiles":{"type":"array","items":{"type":"string"}},"frequency":{"type":"array","items":{"type":"string"}},"category_assignments":{"type":"array","items":{"type":"string"}},"client_type":{"type":"array","items":{"type":"string"}}}},"PagedXiqCwp":{"type":"object","properties":{"page":{"type":"integer","format":"int32","description":"The current page number"},"count":{"type":"integer","format":"int32","description":"The element count of the current page"},"total_pages":{"type":"integer","format":"int32","description":"The total page number based on request page size"},"total_count":{"type":"integer","format":"int64","description":"The total element count"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqCwp"}}},"required":["count","page","total_count","total_pages"]},"XiqCwp":{"type":"object","description":"The Captive Web Portal Entity.","properties":{"id":{"type":"integer","format":"int64","description":"The unique identifier"},"create_time":{"type":"string","format":"date-time","description":"The create time in UTC (ISO 8601 format)"},"update_time":{"type":"string","format":"date-time","description":"The last update time in UTC (ISO 8601 format)"},"org_id":{"type":"integer","format":"int64","description":"The organization identifier, valid when enabling HIQ feature"},"name":{"type":"string","description":"The CWP name"}},"required":["create_time","id","update_time"]},"PagedXiqCredentialDistributionGroupUpdate":{"type":"object","properties":{"page":{"type":"integer","format":"int32","description":"The current page number"},"count":{"type":"integer","format":"int32","description":"The element count of the current page"},"total_pages":{"type":"integer","format":"int32","description":"The total page number based on request page size"},"total_count":{"type":"integer","format":"int64","description":"The total element count"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqCredentialDistributionGroupUpdate"}}},"required":["count","page","total_count","total_pages"]},"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":{"type":"integer","format":"int32","description":"The country ISO numeric code.","maximum":999,"minimum":1},"internal_country_codes":{"type":"array","description":"Extreme IQ internal country codes.","items":{"type":"integer","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."}}},"XiqCountryState":{"type":"object","properties":{"country_code":{"type":"string","description":"The country ISO 2-letter code."},"code":{"type":"string","description":"The state or province code."},"name":{"type":"string","description":"The state or province name."}}},"XiqWirelessViewsListType":{"type":"string","enum":["SSID","OS"]},"XiqWirelessViewsTypeResponse":{"type":"object","description":"Copilot Wireless getViews Response","properties":{"views_list_entities":{"type":"array","description":"the wireless getViews entities data","items":{"type":"string"}}}},"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":{"type":"object","description":"ExtremeCloud IQ Connectivity Experience data","properties":{"timestamp":{"type":"integer","format":"int64","description":"The timestamp"},"quality_index":{"type":"integer","format":"int32","description":"The quality index"},"total_clients":{"type":"integer","format":"int32","description":"The total clients"},"time_to_connect_score":{"type":"integer","format":"int32","description":"The time to connect score"},"above_assoc_threshold":{"type":"integer","format":"int32","description":"The above association threshold"},"above_auth_threshold":{"type":"integer","format":"int32","description":"The above authentication threshold"},"above_dhcp_threshold":{"type":"integer","format":"int32","description":"The above dhcp threshold"},"time_to_assoc":{"type":"integer","format":"int32","description":"The time to associate"},"time_to_auth":{"type":"integer","format":"int32","description":"The time to authenticate"},"time_to_dhcp":{"type":"integer","format":"int32","description":"The time to dhcp"},"performance_score":{"type":"integer","format":"int32","description":"The performance score"}},"required":["timestamp"]},"XiqWirelessTimeToConnectResponse":{"type":"object","description":"Copilot Wireless TimeToConnect Response","properties":{"quality_index_graph":{"type":"array","description":"the wireless timeToConnect entities data","items":{"$ref":"#/components/schemas/XiqWirelessTimeToConnectEntity"}}}},"XiqWirelessQualityIndexResponse":{"type":"object","description":"Copilot Wireless Quality Index Response","properties":{"time_to_connect_score":{"type":"integer","format":"int32","description":"the time to connect score"},"quality_index":{"type":"integer","format":"int32","description":"the quality index"},"performance_score":{"type":"integer","format":"int32","description":"the performance score"}}},"XiqWirelessConnectivityPerformanceResponse":{"type":"object","description":"Copilot Wireless Performance Response","properties":{"quality_index_graph":{"type":"array","description":"The wireless performance entities data","items":{"$ref":"#/components/schemas/XiqWirelessPerformanceEntity"}}}},"XiqWirelessPerformanceEntity":{"type":"object","description":"ExtremeCloud IQ Connectivity Experience Performance data","properties":{"timestamp":{"type":"integer","format":"int64","description":"The timestamp"},"quality_index":{"type":"integer","format":"int32","description":"The quality index"},"total_clients":{"type":"integer","format":"int32","description":"The total clients"},"time_to_connect_score":{"type":"integer","format":"int32","description":"The time to connect score"},"performance_score":{"type":"integer","format":"int32","description":"The performance score"},"snr":{"type":"integer","format":"int32","description":"The average snr"},"retries_data":{"$ref":"#/components/schemas/XiqWirelessPerformanceRetriesEntity","description":"The retries data"}},"required":["timestamp"]},"XiqWirelessPerformanceRetriesEntity":{"type":"object","description":"ExtremeCloud IQ Connectivity Experience Wireless Performance Retries Details","properties":{"rx_retry":{"type":"number","format":"double","description":"The rx retries"},"tx_retry":{"type":"number","format":"double","description":"The tx retries"},"above_retry_threshold":{"type":"number","format":"double","description":"The above retry threshold"}}},"XiqWirelessQualityIndexByLocationResponse":{"type":"object","description":"Copilot Wireless Quality Index By Location Response","properties":{"time_to_connect_score":{"type":"integer","format":"int32","description":"the time to connect score"},"quality_index":{"type":"integer","format":"int32","description":"the quality index"},"performance_score":{"type":"integer","format":"int32","description":"the performance score"},"total_clients":{"type":"integer","format":"int32","description":"the performance score"}}},"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":{"type":"object","properties":{"page":{"type":"integer","format":"int32","description":"The current page number"},"count":{"type":"integer","format":"int32","description":"The element count of the current page"},"total_pages":{"type":"integer","format":"int32","description":"The total page number based on request page size"},"total_count":{"type":"integer","format":"int64","description":"The total element count"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqCopilotWirelessEvent"}}},"required":["count","page","total_count","total_pages"]},"XiqCopilotWirelessEvent":{"type":"object","description":"ExtremeCloud IQ Connectivity Experience Client Details","properties":{"average_value":{"type":"number","format":"double","description":"The average duration to associate/authenticate"},"maximum_value":{"type":"number","format":"double","description":"The maximum duration to associate/authenticate"},"mac":{"type":"string","description":"The mac address"},"os_type":{"type":"string","description":"The os type"},"threshold":{"type":"number","format":"double","description":"The threshold for association/authentication"},"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":"The retries data"}},"required":["client_id","mac"]},"XiqWirelessEventRetriesEntity":{"type":"object","description":"ExtremeCloud IQ Connectivity Experience Wireless Events Retries Details","properties":{"avg_rx_retry":{"type":"number","format":"double","description":"The average duration of rxRetry"},"max_rx_retry":{"type":"number","format":"double","description":"The maximum duration of rxRetry"},"avg_tx_retry":{"type":"number","format":"double","description":"The average duration of txRetry"},"max_tx_retry":{"type":"number","format":"double","description":"The maximum duration of txRetry"},"rx_retry_threshold":{"type":"number","format":"double","description":"The threshold value of rxRetry"},"tx_retry_threshold":{"type":"number","format":"double","description":"The threshold value of txRetry"}}},"XiqSortField":{"type":"string","enum":["NAME","QUALITY_INDEX"]},"PagedXiqConnectivityExperienceData":{"type":"object","properties":{"page":{"type":"integer","format":"int32","description":"The current page number"},"count":{"type":"integer","format":"int32","description":"The element count of the current page"},"total_pages":{"type":"integer","format":"int32","description":"The total page number based on request page size"},"total_count":{"type":"integer","format":"int64","description":"The total element count"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqConnectivityExperienceData"}}},"required":["count","page","total_count","total_pages"]},"XiqClientType":{"type":"string","enum":["WIRELESS","WIRED","UNSPECIFIED"]},"XiqConnectivityExperienceData":{"type":"object","description":"ExtremeCloud IQ Connectivity Experience data","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","format":"int32","description":"the quality index"},"quality_index_value":{"$ref":"#/components/schemas/XiqQualityIndex","description":"the quality index value"},"client_type":{"$ref":"#/components/schemas/XiqClientType","description":"the client type"},"trend_indicator":{"$ref":"#/components/schemas/XiqTrendIndicator","description":"the quality index trend indicator"},"quality_index_graph":{"type":"array","description":"the quality index graph","items":{"$ref":"#/components/schemas/XiqDataPoint"}}},"required":["client_type","name","quality_index","quality_index_graph","quality_index_value","trend_indicator"]},"XiqDataPoint":{"type":"object","description":"ExtremeCloud IQ Data Point","properties":{"timestamp":{"type":"integer","format":"int64","description":"The timestamp"},"value":{"type":"number","description":"The data point value"}},"required":["timestamp"]},"XiqQualityIndex":{"type":"string","enum":["LOW","MEDIUM","HIGH","UNSPECIFIED"]},"XiqTrendIndicator":{"type":"string","enum":["UP","DOWN","EQUAL","NA"]},"XiqWirelessAppsResponse":{"type":"object","description":"Copilot Wireless Apps Response","properties":{"total_clients":{"type":"integer","format":"int32","description":"the total clients"},"most_active_app":{"type":"string","description":"the most active app"},"most_active_user":{"type":"string","description":"the most active user"},"total_apps":{"type":"integer","format":"int32","description":"the total apps"},"total_users":{"type":"integer","format":"int32","description":"the total users"}}},"XiqWiredViewType":{"type":"string","enum":["LOCATION"]},"XiqWiredQualityIndexResponse":{"type":"object","description":"Copilot Wired Quality Index Response","properties":{"hardware_score":{"type":"integer","format":"int32","description":"the hardware score"},"quality_index":{"type":"integer","format":"int32","description":"the quality index"}}},"XiqWiredHardwareByLocationResponse":{"type":"object","description":"Copilot Wired Hardware By Location Response","properties":{"quality_index_graph":{"type":"array","description":"the wired hardware entities data","items":{"$ref":"#/components/schemas/XiqWiredHardwareEntity"}},"total_affected_ports":{"type":"integer","format":"int32","description":"the total affected ports"},"total_ports":{"type":"integer","format":"int32","description":"the total ports"}}},"XiqWiredHardwareEntity":{"type":"object","description":"ExtremeCloud IQ Connectivity Experience data","properties":{"quality_index":{"type":"integer","format":"int32","description":"the quality index"},"timestamp":{"type":"integer","format":"int64","description":"the timestamp"},"total_switches":{"type":"integer","format":"int32","description":"the total number of switches"},"affected_ratio":{"type":"integer","format":"int32","description":"the affected ratio"},"affected":{"type":"number","format":"double","description":"the affected percentage"}},"required":["timestamp"]},"XiqWiredHardwareResponse":{"type":"object","description":"Copilot Wired Hardware Response","properties":{"quality_index_graph":{"type":"array","description":"the wired hardware entities data","items":{"$ref":"#/components/schemas/XiqWiredHardwareEntity"}}}},"XiqCopilotEventsWiredSortField":{"type":"string","enum":["INTERFACE_ERRORS"]},"XiqCopilotWiredEventsScoreType":{"type":"string","enum":["PORT_ERRORS"]},"PagedXiqWiredEventEntity":{"type":"object","properties":{"page":{"type":"integer","format":"int32","description":"The current page number"},"count":{"type":"integer","format":"int32","description":"The element count of the current page"},"total_pages":{"type":"integer","format":"int32","description":"The total page number based on request page size"},"total_count":{"type":"integer","format":"int64","description":"The total element count"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqWiredEventEntity"}}},"required":["count","page","total_count","total_pages"]},"XiqWiredEventEntity":{"type":"object","description":"ExtremeCloud IQ Connectivity Experience data","properties":{"device_id":{"type":"string","description":"the device id"},"hostname":{"type":"string","description":"the host name"},"interface_errors":{"type":"number","format":"double","description":"the interface errors ratio"},"maximum_errors":{"type":"number","format":"double","description":"the maximum errors ratio"},"mgmt_ip":{"type":"string","description":"the management ip"},"port":{"type":"string","description":"the port"},"serial_number":{"type":"string","description":"the device serial number"}}},"XiqConnectivityDetailsByClientTypeResponse":{"type":"object","description":"Connectivity Details by Client Type","properties":{"sites_by_wireless":{"$ref":"#/components/schemas/XiqSitesByWirelessEntity","description":"The sites by wireless"},"sites_by_wired":{"$ref":"#/components/schemas/XiqSitesByWiredEntity","description":"The sites by wired"}}},"XiqSitesByWiredEntity":{"type":"object","description":"Copilot Sites by Wired","properties":{"low_quality_score_count":{"type":"integer","format":"int32","description":"Locations count with low severity"},"medium_quality_score_count":{"type":"integer","format":"int32","description":"Locations count with medium severity"},"high_quality_score_count":{"type":"integer","format":"int32","description":"Locations count with high severity"},"total_locations_count":{"type":"integer","format":"int32","description":"Total Locations count by severity"}}},"XiqSitesByWirelessEntity":{"type":"object","description":"Copilot Sites by Wireless","properties":{"low_quality_score_count":{"type":"integer","format":"int32","description":"Locations count with low severity"},"medium_quality_score_count":{"type":"integer","format":"int32","description":"Locations count with medium severity"},"high_quality_score_count":{"type":"integer","format":"int32","description":"Locations count with high severity"},"total_locations_count":{"type":"integer","format":"int32","description":"Total Locations count by severity"}}},"XiqAnomaliesCountVoEntity":{"type":"object","description":"ExtremeCloud IQ Count Entity","properties":{"timestamp":{"type":"integer","format":"int64","description":"The timestamp"},"total_anomalies_count":{"type":"integer","format":"int64","description":"The total anomalies count"},"wifi_efficiency_count":{"type":"integer","format":"int64","description":"The wifi efficiency count"},"wifi_capacity_count":{"type":"integer","format":"int64","description":"The wifi capacity count"},"poe_count":{"type":"integer","format":"int64","description":"The poe flapping count"},"pe_count":{"type":"integer","format":"int64","description":"The port efficiency count"},"dfs_count":{"type":"integer","format":"int64","description":"The dfs recurrece count"},"mb_cast_count":{"type":"integer","format":"int64","description":"The multibroadcast count"},"hardware_health_count":{"type":"integer","format":"int64","description":"The hardware health count"},"missing_vlan_count":{"type":"integer","format":"int64","description":"The missing vlan anomaly count"}},"required":["timestamp"]},"XiqAssuranceScansOverviewResponse":{"type":"object","description":"Copilot AssuranceScans Overview","properties":{"aggregated_scans_count":{"type":"integer","format":"int64","description":"The aggregated scans count"},"anomalies_count_vos":{"type":"array","description":"the channel stats data","items":{"$ref":"#/components/schemas/XiqAnomaliesCountVoEntity"}}}},"XiqSessionsDataEntity":{"type":"object","description":"ExtremeCloud IQ Sessions Data","properties":{"timestamp":{"type":"integer","format":"int64","description":"The timestamp"},"data_rate_failure_percent":{"type":"number","format":"double","description":"The data rate failure percent "},"client_count":{"type":"integer","format":"int32","description":"The client count"},"normal_failure_percent":{"type":"integer","format":"int32","description":"The normal failure percent"}},"required":["timestamp"]},"XiqWifiEfficiencyStatsResponse":{"type":"object","description":"Copilot Wifi Efficiency Stats","properties":{"total_client_sessions":{"type":"integer","format":"int64","description":"The total client sessions"},"show_tx_data":{"type":"boolean","description":"The show tx data"},"sessions_data":{"type":"array","description":"The sessions data","items":{"$ref":"#/components/schemas/XiqSessionsDataEntity"}}}},"XiqAnomalyHealthType":{"type":"string","enum":["NONE","GOOD","MEDIUM","POOR"]},"XiqClientStatsEntity":{"type":"object","description":"ExtremeCloud IQ Client List Stats","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","format":"int32","description":"The average SNR"},"avg_tx_rate":{"type":"integer","format":"int32","description":"The average TX rate"},"avg_rx_rate":{"type":"integer","format":"int32","description":"The average RX rate"},"client_id":{"type":"integer","format":"int64","description":"The client id"},"avg_rssi":{"type":"integer","format":"int32","description":" The average RSSI "},"health_score":{"$ref":"#/components/schemas/XiqAnomalyHealthType","description":" The health score"}}},"XiqWifiEfficiencyClientListResponse":{"type":"object","description":"Copilot Wifi Efficiency Client List","properties":{"client_stats_entities":{"type":"array","description":"the anomaly devices data","items":{"$ref":"#/components/schemas/XiqClientStatsEntity"}}}},"XiqDeviceStatsEntity":{"type":"object","description":"ExtremeCloud IQ Device Stats Entity","properties":{"timestamp":{"type":"integer","format":"int64","description":"The timestamp"},"avg_interference_utilization":{"type":"integer","format":"int32","description":"The average interference utilization "},"avg_tx_utilization":{"type":"integer","format":"int32","description":"The Average Tx Utilization"},"avg_rx_utilization":{"type":"integer","format":"int32","description":"The Average Rx Utilization"},"avg_total_channel_utilization":{"type":"integer","format":"int32","description":"The Average Total Channel Utilization "},"avg_num_clients":{"type":"integer","format":"int32","description":"The Average Number of Clients"},"normal_interference":{"type":"integer","format":"int32","description":"The normal interference "}},"required":["timestamp"]},"XiqWifiCapacityStatsResponse":{"type":"object","description":"Copilot Wifi Capacity Stats","properties":{"device_stats":{"type":"array","description":"The device stats","items":{"$ref":"#/components/schemas/XiqDeviceStatsEntity"}}}},"XiqWifiCapacityClientListResponse":{"type":"object","description":"Copilot Wifi Capacity Client List","properties":{"client_wifi_stats":{"type":"array","description":"the anomaly devices data","items":{"$ref":"#/components/schemas/XiqClientStatsEntity"}}}},"XiqAnomalySeverity":{"type":"string","enum":["NONE","LOW","MEDIUM","HIGH"]},"XiqAnomalySortField":{"type":"string","enum":["LOCATION","SEVERITY","TIME","CATEGORY","ANOMALY_TYPE","DEVICE_NAME","MUTED"]},"XiqDuplexDataRateEntity":{"type":"object","description":"ExtremeCloud IQ Duplex DataRate","properties":{"timestamp":{"type":"integer","format":"int64","description":"The timestamp"},"duplex_mode":{"type":"integer","format":"int32","description":"The duplex mode"},"datarate_mode":{"type":"integer","format":"int32","description":"The data rate mode"}},"required":["timestamp"]},"XiqPortEfficiencyStatsResponse":{"type":"object","description":"Copilot Port Efficiency Stats","properties":{"duplex_data_rate_entities":{"type":"array","description":"the duplex data rate data","items":{"$ref":"#/components/schemas/XiqDuplexDataRateEntity"}}}},"XiqPortEfficiencySpeedDuplexStatsResponse":{"type":"object","description":"Copilot Port Efficiency Speed Duplex Stats","properties":{"speed_duplex_entities":{"type":"array","description":"the speed duplex data","items":{"$ref":"#/components/schemas/XiqSpeedDuplexEntity"}}}},"XiqSpeedDuplexEntity":{"type":"object","description":"ExtremeCloud IQ Speed Duplex","properties":{"timestamp":{"type":"integer","format":"int64","description":"The timestamp"},"speed_value":{"type":"integer","format":"int32","description":"The speed value"},"duplex_value":{"type":"integer","format":"int32","description":"The duplex value"}},"required":["timestamp"]},"XiqPoeTrendGraphsResponse":{"type":"object","description":"Copilot PoeFlapping Trend Graphs","properties":{"trend_graph_entities":{"type":"array","description":"the anomaly devices data","items":{"$ref":"#/components/schemas/XiqTrendGraphEntity"}}}},"XiqTrendGraphEntity":{"type":"object","description":"ExtremeCloud IQ Trend Graphs for PoE","properties":{"timestamp":{"type":"integer","format":"int64","description":"The timestamp"},"power_mode":{"type":"string","description":"The power mode"}},"required":["timestamp"]},"XiqFlapCountEntity":{"type":"object","description":"ExtremeCloud IQ FlapCount Point","properties":{"timestamp":{"type":"integer","format":"int64","description":"The timestamp"},"flap_count":{"type":"number","description":"The flap count"},"sub_optimal_count":{"type":"integer","format":"int32","description":"The sub-optimal count"},"optimal_time_spent":{"type":"number","format":"double","description":"The time spent"}},"required":["timestamp"]},"XiqPoeFlappingStatsResponse":{"type":"object","description":"Copilot PoeFlapping Stats","properties":{"summary":{"type":"string","description":"the anomaly location"},"flap_count_entities":{"type":"array","description":"the anomaly devices data","items":{"$ref":"#/components/schemas/XiqFlapCountEntity"}}}},"XiqAffectedDownlinkDevice":{"type":"object","description":"Copilot Anomaly Affected Downlink Devices Info","properties":{"host_name":{"type":"string","description":"The host name of affected downlink device"},"product_type":{"type":"string","description":"The model of affected downlink device"},"interface_name":{"type":"string","description":"The interface name of affected downlink device"},"port_id":{"type":"string","description":"The port ID of affected downlink device"},"last_detected_time":{"type":"integer","format":"int64","description":"The last detected timestamp"}}},"XiqCopilotLldpCdpInfo":{"type":"object","description":"Copilot Anomalies LLdp-Cdp Info Response","properties":{"lldp_cdp_info":{"$ref":"#/components/schemas/XiqPowerSourceEquipment","description":"The LLDP-CDP info of anomalous access points"}}},"XiqPowerSourceEquipment":{"type":"object","description":"Copilot LLdp-Cdp Info For Anomalous Access Points","properties":{"is_lldp_cdp_enabled":{"type":"boolean","description":"Check if lldp-cdp enabled on anomalous accesspoints"},"uplink_switch_system_name":{"type":"string","description":"Uplink switch system name"},"uplink_switch_system_id":{"type":"string","description":"Uplink switch model"},"location_name":{"type":"string","description":"The location name for anomalous access points with lldp-cdp info not enabled"},"floor_name":{"type":"string","description":"The location name for anomalous access points with lldp-cdp info not enabled"},"affected_downlink_devices":{"type":"array","description":"The list of affected downlink devices","items":{"$ref":"#/components/schemas/XiqAffectedDownlinkDevice"}},"unaffected_downlink_devices":{"type":"array","description":"The list of unaffected downlink devices","items":{"$ref":"#/components/schemas/XiqUnaffectedDownlinkDevice"}},"uplink_switch_device_id":{"type":"integer","format":"int64","description":" The uplink device id"}}},"XiqUnaffectedDownlinkDevice":{"type":"object","description":"Copilot Anomaly Unaffected Downlink Devices Info","properties":{"host_name":{"type":"string","description":"The host name of unaffected downlink device"},"product_type":{"type":"string","description":"The model of unaffected downlink device"},"interface_name":{"type":"string","description":"The interface name of unaffected downlink device"},"port_id":{"type":"string","description":"The port ID of unaffected downlink device"}}},"XiqAnomaliesNotificationsResponse":{"type":"object","description":"Copilot Anomalies Notification Response","properties":{"total_anomaly_count":{"type":"integer","format":"int64","description":"The total anomaly count"},"location_entity":{"type":"array","description":"the anomaly location","items":{"$ref":"#/components/schemas/XiqAnomalyLocationEntity"}}}},"XiqAnomalyLocationEntity":{"type":"object","description":"Copilot Anomaly Locations data","properties":{"location_type":{"$ref":"#/components/schemas/XiqLocationType","description":"the location type"},"location_ids":{"type":"array","description":"the location id","items":{"type":"integer","format":"int64"}},"building_id":{"type":"integer","format":"int64","description":"the building id"},"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","description":"the severity"},"severity_id":{"type":"integer","format":"int32","description":"the severity id"},"summary":{"type":"string","description":"the anomaly summary"},"affected_device_count":{"type":"integer","format":"int32","description":"the affected number of devices"},"last_detected_time":{"type":"integer","format":"int64","description":"the last detected time"},"anomaly_type":{"$ref":"#/components/schemas/XiqAnomalyType","description":"the anomaly type"}}},"XiqLocationType":{"type":"string","enum":["SITE","BUILDING","FLOOR"]},"XiqMissingVlanAnomaliesCountResponse":{"type":"object","description":"Copilot Missing vlan anomalies count details","properties":{"total_anomalies_count":{"type":"integer","format":"int32"},"anomalies_count_by_site":{"type":"array","items":{"$ref":"#/components/schemas/XiqMissingVlanSiteAnomalyCountDetails"}}}},"XiqMissingVlanSiteAnomalyCountDetails":{"type":"object","description":"Missing vlan site anomaly count details","properties":{"site_id":{"type":"integer","format":"int64"},"site_name":{"type":"string"},"anomalies_count":{"type":"integer","format":"int32"}}},"XiqAnomalyAffectedCount":{"type":"object","description":"Copilot Anomalies Affected count","properties":{"total_anomaly_count":{"type":"integer","format":"int32","description":"The total anomaly count"},"affected_location_count":{"type":"integer","format":"int32","description":"The affected location count"},"affected_devices_count":{"type":"integer","format":"int32","description":"The affected devices count"}},"required":["affected_devices_count","affected_location_count","total_anomaly_count"]},"XiqCopilotPagedXiqAnomalyLocationEntity":{"type":"object","properties":{"page":{"type":"integer","format":"int32","description":"The current page number"},"count":{"type":"integer","format":"int32","description":"The element count of the current page"},"total_pages":{"type":"integer","format":"int32","description":"The total page number based on request page size"},"total_count":{"type":"integer","format":"int64","description":"The total element count"},"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","description":"The Copilot Anomalies Affected count"}},"required":["count","page","total_count","total_pages"]},"XiqHardwareHealthDeviceStatsEntity":{"type":"object","description":"ExtremeCloud IQ Data Point","properties":{"timestamp":{"type":"integer","format":"int64","description":"The Timestamp"},"avg_cpu_utilization":{"type":"number","description":"Avg Cpu Utilization"},"avg_memory_utilization":{"type":"number","description":"Avg Memory Utilization"},"avg_client_count":{"type":"integer","format":"int32","description":"Avg Client Count"},"unit_temperature":{"type":"number","description":"Unit Temperature"},"poe_power_mode":{"type":"string","description":"Poe PowerMode"}},"required":["timestamp"]},"XiqHardwareHealthPacketCountsEntity":{"type":"object","description":"ExtremeCloud IQ Data Point","properties":{"timestamp":{"type":"integer","format":"int64","description":"The timestamp"},"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"},"throughput":{"type":"number","description":"Throughput"}},"required":["timestamp"]},"XiqHardwareHealthRebootStatsEntity":{"type":"object","description":"ExtremeCloud IQ Data Point","properties":{"timestamp":{"type":"integer","format":"int64","description":"Timestamp"},"reboot_code":{"type":"number","description":"Reboot Code"}},"required":["timestamp"]},"XiqHardwareHealthStatsResponse":{"type":"object","description":"Copilot Hardware Health Stats","properties":{"hd_device_stats_entities":{"type":"array","description":"the anomaly devices data","items":{"$ref":"#/components/schemas/XiqHardwareHealthDeviceStatsEntity"}},"hd_packet_counts_entities":{"type":"array","description":"the anomaly devices data","items":{"$ref":"#/components/schemas/XiqHardwareHealthPacketCountsEntity"}},"hd_reboot_stats_entities":{"type":"array","description":"the anomaly devices data","items":{"$ref":"#/components/schemas/XiqHardwareHealthRebootStatsEntity"}}}},"XiqAnomalyHhStatsType":{"type":"string","enum":["CPU_STATS","MEMORY_STATS"]},"XiqHardwareHealthCpuMemStatsResponse":{"type":"object","description":"Copilot Hardware Health Cpu Memory Stats","properties":{"cpu_mem_stats":{"type":"array","items":{"$ref":"#/components/schemas/XiqHhCpuMemStatsEntity"}}}},"XiqHhCpuMemStatsEntity":{"type":"object","description":"ExtremeCloud IQ Hardware Health CPU & Memory Stats","properties":{"timestamp":{"type":"integer","format":"int64","description":"Timestamp"},"stats_ten_secs":{"type":"string","description":"Stats for 10 secs"},"stats_twenty_secs":{"type":"string","description":"Stats for 20 secs"},"stats_thirty_secs":{"type":"string","description":"Stats for 30 secs"}},"required":["timestamp"]},"XiqHardwareHealthClientListResponse":{"type":"object","description":"Copilot Hardware Health Client List Stats","properties":{"hh_client_stats":{"type":"array","items":{"$ref":"#/components/schemas/XiqHhClientStatsEntity"}}}},"XiqHhClientStatsEntity":{"type":"object","description":"ExtremeCloud IQ Hardware Health Client List Stats","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","format":"int32","description":"The average SNR"},"client_id":{"type":"integer","format":"int64","description":"The client id"},"health_score":{"$ref":"#/components/schemas/XiqAnomalyHealthType","description":" The health score"}}},"XiqCopilotMissingVlanPagedXiqMissingVlanExcludedVlanList":{"type":"object","properties":{"page":{"type":"integer","format":"int32","description":"The current page number"},"count":{"type":"integer","format":"int32","description":"The element count of the current page"},"total_pages":{"type":"integer","format":"int32","description":"The total page number based on request page size"},"total_count":{"type":"integer","format":"int64","description":"The total element count"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqMissingVlanExcludedVlanList"}}},"required":["count","page","total_count","total_pages"]},"XiqCopilotMissingVlanSiteDetails":{"type":"object","description":"The list of excluded vlan's site details","properties":{"site_id":{"type":"integer","format":"int64"},"site_name":{"type":"string"}}},"XiqMissingVlanExcludedVlanList":{"type":"object","description":"The list of excluded vlan details with site details","properties":{"vlan_id":{"type":"integer","format":"int64"},"missing_vlan_site_details":{"type":"array","items":{"$ref":"#/components/schemas/XiqCopilotMissingVlanSiteDetails"}}}},"XiqDfsChannelChangesEntity":{"type":"object","description":"ExtremeCloud IQ Count Stats","properties":{"timestamp":{"type":"integer","format":"int64","description":"The timestamp"},"count":{"type":"integer","format":"int32","description":"The count"}},"required":["timestamp"]},"XiqDfsRecurenceCountStatsResponse":{"type":"object","description":"Copilot DfsRecurrence Count Stats","properties":{"dfs_channel_changes_entities":{"type":"array","description":"the count stats data","items":{"$ref":"#/components/schemas/XiqDfsChannelChangesEntity"}},"normal":{"type":"integer","format":"int32","description":"The normal count"}}},"XiqDfsChannelStatsEntity":{"type":"object","description":"ExtremeCloud IQ Channel Stats","properties":{"timestamp":{"type":"integer","format":"int64","description":"The timestamp"},"channel_number":{"type":"integer","format":"int32","description":"The channel number"}},"required":["timestamp"]},"XiqDfsRecurenceChannelStatsResponse":{"type":"object","description":"Copilot DfsRecurrence Channel Stats","properties":{"dfs_channel_stats_entities":{"type":"array","description":"the channel stats data","items":{"$ref":"#/components/schemas/XiqDfsChannelStatsEntity"}},"min_channel":{"type":"integer","format":"int32","description":"The min channel"},"max_channel":{"type":"integer","format":"int32","description":"The max channel"}}},"XiqAnomalyDeviceWithLocation":{"type":"object","description":"Copilot Anomaly details with Location","properties":{"building_id":{"type":"integer","format":"int64","description":"The building ID"},"location_name":{"type":"string","description":"The location name"},"muted":{"type":"boolean","description":"To filter muted anomalies"},"severity":{"$ref":"#/components/schemas/XiqAnomalySeverity","description":"The severity of anomaly"},"anomaly_type":{"$ref":"#/components/schemas/XiqAnomalyType","description":"The anomaly type"},"last_detected_time":{"type":"integer","format":"int64","description":"The last detected time of anomaly"},"device_id":{"type":"integer","format":"int64","description":"The device ID"},"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","description":"The wired or wireless category"},"interface_name":{"type":"string","description":"The interface name"},"location_id":{"type":"integer","format":"int64","description":"The location ID"},"anomaly_id":{"type":"string","description":"The anomaly ID"},"frequency":{"type":"string","description":"The frequency"},"channel_number":{"type":"integer","format":"int32","description":"The channel number"},"channel_mode":{"type":"string","description":"The channel mode"},"recommended_action":{"type":"string","description":"The recommended action"},"issue":{"type":"string","description":"The issue"},"current_poe_mode":{"type":"string","description":"The current poe mode"},"device_status":{"type":"boolean","description":"The device status"},"anomaly_subtypes":{"type":"string","description":"The Anomaly Subtypes"},"missing_vlan_info":{"$ref":"#/components/schemas/XiqMissingVlanInfo","description":"The Missing Vlan Info"}},"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"]},"XiqCopilotPagedXiqAnomalyDeviceWithLocation":{"type":"object","properties":{"page":{"type":"integer","format":"int32","description":"The current page number"},"count":{"type":"integer","format":"int32","description":"The element count of the current page"},"total_pages":{"type":"integer","format":"int32","description":"The total page number based on request page size"},"total_count":{"type":"integer","format":"int64","description":"The total element count"},"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","description":"The Copilot Anomalies Affected count"}},"required":["count","page","total_count","total_pages"]},"XiqMissingVlanAffectedDeviceEntity":{"type":"object","description":"The Missing Vlan affected devices","properties":{"ap_name":{"type":"string"},"ap_device_id":{"type":"string"},"upstream_switch_interface":{"type":"string"},"interface_name":{"type":"string"},"missing_vlans":{"type":"array","items":{"type":"integer","format":"int32"}}}},"XiqMissingVlanInfo":{"type":"object","description":"The Missing Vlan Info","properties":{"lldp_enabled":{"type":"boolean"},"upstream_switch_name":{"type":"string"},"floor_name":{"type":"string"},"affected_device_entity":{"type":"array","items":{"$ref":"#/components/schemas/XiqMissingVlanAffectedDeviceEntity"}}}},"XiqAnomalyDeviceEntity":{"type":"object","description":"Copilot Anomaly Device data","properties":{"device_id":{"type":"integer","format":"int64","description":"the device id"},"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","description":"the severity"},"summary":{"type":"string","description":"the anomaly summary"},"last_detected_time":{"type":"integer","format":"int64","description":"the last detected time"},"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","format":"int32","description":"the channel number"},"frequency":{"type":"string","description":"the frequency"},"location_id":{"type":"integer","format":"int64","description":"the location id"}}},"XiqAnomalyDevicesByLocationResponse":{"type":"object","description":"Copilot Anomaly Devices","properties":{"location_entity":{"$ref":"#/components/schemas/XiqAnomalyLocationEntity","description":"the anomaly location"},"devices":{"type":"array","description":"the anomaly devices data","items":{"$ref":"#/components/schemas/XiqAnomalyDeviceEntity"}}}},"XiqAnomaliesSeverityEntity":{"type":"object","description":"Copilot Anomalies By Severity","properties":{"low_severity_anomalies_count":{"type":"integer","format":"int32","description":"Anomalies count with low severity"},"medium_severity_anomalies_count":{"type":"integer","format":"int32","description":"Anomalies count with medium severity"},"high_severity_anomalies_count":{"type":"integer","format":"int32","description":"Anomalies count with high severity"},"anomalies_count_by_severity":{"type":"integer","format":"int32","description":"Total Anomalies count by severity"}}},"XiqAnomaliesSiteEntity":{"type":"object","description":"Copilot Anomalies By Site","properties":{"building_id":{"type":"integer","format":"int64","description":"the location type"},"location_name":{"type":"string","description":"the location type"},"anomalies_count_by_location":{"type":"integer","format":"int32","description":"the location type"}}},"XiqAnomaliesTypeEntity":{"type":"object","description":"Copilot Anomalies By Type","properties":{"anomaly_type":{"$ref":"#/components/schemas/XiqAnomalyType","description":"Anomalies count with low severity"},"anomalies_count_by_type":{"type":"integer","format":"int32","description":"Anomalies count with low severity"}}},"XiqCopilotAnomaliesByCategory":{"type":"object","description":"Copilot Anomalies Data by Category","properties":{"anomalies_by_location":{"type":"array","description":"The total anomalies by location","items":{"$ref":"#/components/schemas/XiqAnomaliesSiteEntity"}},"anomalies_by_severity":{"$ref":"#/components/schemas/XiqAnomaliesSeverityEntity","description":"The total anomalies by severity"},"anomalies_by_type":{"type":"array","description":"The total anomalies by type","items":{"$ref":"#/components/schemas/XiqAnomaliesTypeEntity"}}}},"XiqAtpPacketCountsEntity":{"type":"object","description":"ExtremeCloud IQ Data Point","properties":{"timestamp":{"type":"integer","format":"int64","description":"The timestamp"},"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"}},"required":["timestamp"]},"XiqAtpPacketCountsResponse":{"type":"object","description":"Copilot Atp Device Packet Counts","properties":{"summary":{"type":"string","description":"the anomaly location"},"atp_packet_counts_entities":{"type":"array","description":"the anomaly device data","items":{"$ref":"#/components/schemas/XiqAtpPacketCountsEntity"}}}},"XiqAtpDeviceStatsEntity":{"type":"object","description":"ExtremeCloud IQ Data Point","properties":{"timestamp":{"type":"integer","format":"int64","description":"The timestamp"},"avg_cpu":{"type":"number","description":"Avg Cpu"},"avg_memory":{"type":"number","description":"Avg Memory"},"avg_client_count":{"type":"integer","format":"int32","description":"Avg Client Count"}},"required":["timestamp"]},"XiqAtpDeviceStatsResponse":{"type":"object","description":"Copilot Atp Device Stats","properties":{"summary":{"type":"string","description":"the anomaly location"},"atp_device_stats_entities":{"type":"array","description":"the anomaly devices data","items":{"$ref":"#/components/schemas/XiqAtpDeviceStatsEntity"}}}},"XiqClientUsage":{"type":"object","description":"The client usage over the period","properties":{"client_id":{"type":"integer","format":"int64","description":"The client ID"},"usage":{"type":"integer","format":"int64","description":"The client total usage"}}},"XiqClientSummary":{"type":"object","description":"The summary for clients","properties":{"connected_wireless_client_count":{"type":"integer","format":"int64","description":"The connected wireless client count"},"detected_wired_client_count":{"type":"integer","format":"int64","description":"The detected wired client count"},"connected_thread_client_count":{"type":"integer","format":"int64","description":"The connected thread client count"}}},"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","TH_RLOC16","CLIENT_MAC","RSSI","DEVICE_MAC"]},"PagedXiqClient":{"type":"object","properties":{"page":{"type":"integer","format":"int32","description":"The current page number"},"count":{"type":"integer","format":"int32","description":"The element count of the current page"},"total_pages":{"type":"integer","format":"int32","description":"The total page number based on request page size"},"total_count":{"type":"integer","format":"int64","description":"The total element count"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqClient"}}},"required":["count","page","total_count","total_pages"]},"PagedXiqClientMonitorProfile":{"type":"object","properties":{"page":{"type":"integer","format":"int32","description":"The current page number"},"count":{"type":"integer","format":"int32","description":"The element count of the current page"},"total_pages":{"type":"integer","format":"int32","description":"The total page number based on request page size"},"total_count":{"type":"integer","format":"int64","description":"The total element count"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqClientMonitorProfile"}}},"required":["count","page","total_count","total_pages"]},"XiqClientConnectionTrailResponse":{"type":"object","properties":{"links":{"type":"array","items":{"$ref":"#/components/schemas/XiqTopologyViewLink"}},"nodes":{"type":"array","items":{"$ref":"#/components/schemas/XiqTopologyViewNode"}},"baseline":{"type":"boolean"},"user_initiated":{"type":"boolean"},"created_at":{"type":"integer","format":"int64"},"zoom":{"type":"number","format":"double"},"pan":{"$ref":"#/components/schemas/XiqPosition"},"neighbors":{"type":"array","items":{"$ref":"#/components/schemas/XiqNeighborAp"}}}},"XiqNeighborAp":{"type":"object","properties":{"device_id":{"type":"integer","format":"int64"},"hostname":{"type":"string"},"ip_address":{"type":"string"},"mac_address":{"type":"string"},"rssi":{"type":"integer","format":"int64"},"connection_failure_reason":{"type":"string","enum":["OTHER","ABORT_FROM_OS","DEASSOC_FROM_AP","DEAUTH_FROM_AP","INTERNAL_TERMINATION","INVALID_CAPABILITIES","ASSOC_FAILURE_802_11","AUTH_FAILURE_802_11","TX_RX_FAILURE_REASON"]}}},"XiqPosition":{"type":"object","properties":{"x":{"type":"number","format":"double"},"y":{"type":"number","format":"double"}}},"XiqTopologyStackMemberInfo":{"type":"object","properties":{"stack_member_id":{"type":"integer","format":"int64"},"device_id":{"type":"integer","format":"int64"},"serial_number":{"type":"string"},"unit_number":{"type":"integer","format":"int32"},"member_type":{"type":"string"},"poe_info":{"$ref":"#/components/schemas/XiqTopologyViewNodePoeInfo"}}},"XiqTopologyUnknownDevice":{"type":"object","properties":{"mac_address":{"type":"string"},"hostname":{"type":"string"},"type":{"type":"string"},"ip_address":{"type":"string"}}},"XiqTopologyViewLink":{"type":"object","properties":{"source":{"type":"integer","format":"int64"},"source_port_id":{"type":"string"},"source_lag":{"type":"string"},"destination":{"type":"integer","format":"int64"},"destination_port_id":{"type":"string"},"destination_lag":{"type":"string"},"index":{"type":"integer","format":"int32"},"connected":{"type":"boolean"},"connection_mode":{"type":"string","enum":["LLDP","CLIENT","UNKNOWNDEVICE","MESH","VGVA","FAKEGATEWAY"]}}},"XiqTopologyViewNode":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"hostname":{"type":"string"},"mac_address":{"type":"string"},"ip_address":{"type":"string"},"port_number":{"type":"string"},"radio_info":{"type":"string"},"health_score":{"type":"integer","format":"int32"},"client_count":{"type":"integer","format":"int64"},"last_node":{"type":"boolean"},"topology_start_node":{"type":"boolean"},"connected":{"type":"boolean"},"vlan_info":{"$ref":"#/components/schemas/XiqTopologyViewNodeVlanInfo"},"type":{"type":"string","enum":["WIRELESS_CLIENT","WIRED_CLIENT","UNKNOWN","AP","MESHAP","PORTALAP","SWITCH","ROUTER","VAASL2VG","VAASL3VG","GATEWAY","STACK","APASROUTER","XMCSERVER"]},"critical_alarms":{"type":"integer","format":"int64"},"not_current_location_node":{"type":"boolean"},"unknown_device":{"$ref":"#/components/schemas/XiqTopologyUnknownDevice"},"wired_interface_name":{"type":"string"},"connected_port":{"type":"string"},"stack_member_info":{"type":"array","items":{"$ref":"#/components/schemas/XiqTopologyStackMemberInfo"}},"make":{"type":"string"},"position":{"$ref":"#/components/schemas/XiqPosition"},"poe_info":{"$ref":"#/components/schemas/XiqTopologyViewNodePoeInfo"},"product_type":{"type":"string"},"is_locally_managed":{"type":"boolean"},"sim_type":{"type":"string"}}},"XiqTopologyViewNodePoeInfo":{"type":"object","properties":{"power_state":{"type":"object","additionalProperties":{"type":"string"}},"unit_power_available":{"type":"number","format":"double"},"unit_power_consumed":{"type":"number","format":"double"},"unit_power_threshold":{"type":"number","format":"double"},"poe_power_available":{"type":"number","format":"double"},"poe_power_consumed":{"type":"number","format":"double"},"poe_power_threshold":{"type":"number","format":"double"}}},"XiqTopologyViewNodeVlanInfo":{"type":"object","properties":{"mgmt_vlan":{"type":"integer","format":"int32"},"native_vlan":{"type":"integer","format":"int32"},"access_port_vlans":{"type":"array","items":{"type":"integer","format":"int32"}},"trunk_port_vlans":{"type":"array","items":{"type":"integer","format":"int32"}},"user_profile_vlans":{"type":"array","items":{"type":"integer","format":"int32"}}}},"XiqClientDetail":{"type":"object","description":"The Client Details Info","properties":{"device_connected":{"type":"boolean","description":"The device connected value"},"device_id":{"type":"integer","format":"int64","description":"The device ID"},"os_type":{"type":"string","description":"The client Os Type"},"ip_address":{"type":"string","description":"The client Ip Address"},"mac_address":{"type":"string","description":"The client mac Address"},"device_location_names":{"type":"string","description":"The location hierarchical tree"},"device_location_id":{"type":"integer","format":"int64","description":"The location ID"},"alias":{"type":"string","description":"The client alias name"},"user":{"type":"string","description":"The user name"},"connection_to":{"type":"string","description":"The Ap hostname"},"connection_time":{"type":"integer","format":"int64","description":"The connection Time"},"vlan":{"type":"integer","format":"int32","description":"The vlan"},"cwp_used":{"type":"integer","format":"int32","description":"The Captive Web Portal used"},"user_profile":{"type":"string","description":"The user profile name"},"ssid":{"type":"string","description":"The SSID"},"radio":{"type":"string","description":"The Radio Info (2G,5G,6G)"},"wifi_protocol":{"type":"string","description":"The wifi Protocol"},"channel":{"type":"integer","format":"int32","description":"The channel value"},"client_hostname":{"type":"string","description":"The Client hostName"},"client_type":{"type":"string","description":"Client type"},"rtts_supported":{"type":"boolean","description":"Whether the client supports RTTS"},"device_managed_by":{"type":"string","description":"The device is managed by Cloud, Controller, XIQ-SE, TPME, etc."}}},"XiqClientChartData":{"type":"object","description":"The Client Signal Data","properties":{"timestamp":{"type":"integer","format":"int64","description":"The timestamp detect in epoch format (milliseconds)"},"rssi":{"type":"integer","format":"int32","description":"The RSSI"},"snr":{"type":"integer","format":"int32","description":"The SNR"},"noise_floor":{"type":"integer","format":"int64","description":"The Noise floor"},"rssi_from_device":{"type":"integer","format":"int32","description":"The RSSI from device"},"roam_details":{"$ref":"#/components/schemas/XiqClientChartRoamDetails","description":"The roam details"}}},"XiqClientChartDataList":{"type":"object","description":"The Client Signal Data List","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/XiqClientChartData"}}}},"XiqClientChartRoamDetails":{"type":"object","description":"The Client Roam Trail data","properties":{"device_name_from":{"type":"string","description":"The Ap name From"},"device_name_to":{"type":"string","description":"The Ap name To"},"device_mac_from":{"type":"string","description":"The Ap mac address From"},"device_mac_to":{"type":"string","description":"The Ap mac address To"},"roam_duration":{"type":"integer","format":"int32","description":"The roam duration in milliseconds"},"status_action":{"type":"string","description":"The Status of roam action (Completed, Failed)"}}},"XiqRoamingTrial":{"type":"object","description":"Get roaming trial","properties":{"timestamp":{"type":"integer","format":"int64","description":"Client Start trial in epoch format (milliseconds)"},"device_name_from":{"type":"string","description":"The Ap name From"},"device_name_to":{"type":"string","description":"The Ap name To"},"device_mac_from":{"type":"string","description":"The Ap mac address From"},"device_mac_to":{"type":"string","description":"The Ap mac address To"},"roam_duration":{"type":"integer","format":"int32","description":"The roam duration in milliseconds"},"status_action":{"type":"string","description":"The Status of roam action (Completed, Failed)","enum":["COMPLETED","FAILED","DISCONNECT"]},"data":{"type":"array","description":"The List of client roaming Trail details","items":{"$ref":"#/components/schemas/XiqRoamingTrialDetail"}}}},"XiqRoamingTrialDetail":{"type":"object","description":"Get roaming trial details data","properties":{"channel_from":{"type":"integer","format":"int32","description":"The channel From"},"channel_to":{"type":"integer","format":"int32","description":"The channel To"},"rssi_from":{"type":"integer","format":"int32","description":"The RSSI From"},"rssi_to":{"type":"integer","format":"int32","description":"The RSSI To"},"snr_from":{"type":"integer","format":"int32","description":"The SNR From"},"snr_to":{"type":"integer","format":"int32","description":"The SNR To"},"radio_type_from":{"type":"string","description":"The RadioType From"},"radio_type_to":{"type":"string","description":"The RadioType To"},"status":{"type":"string","description":"The operation progress","enum":["ASSOC_FAILED","DHCP_FAILED","GW_FAILED","AUTH_FAILED","DNS_FAILED","ROAMING_STARTED","ROAMING_COMPLETED","ROAMING_FAILED","DISCONNECT"]},"reason":{"type":"string","description":"Reason if operation failed"}}},"XiqRoamingTrialList":{"type":"object","description":"Get connectivity experience list","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/XiqRoamingTrial"}}}},"XiqRoamingTrialCount":{"type":"object","description":"Get roaming trial counts","properties":{"roam_completed":{"type":"integer","format":"int64","description":"The roam completed count"},"roam_failed":{"type":"integer","format":"int64","description":"The roam failed count"},"slow_roam_count":{"type":"integer","format":"int64","description":"Slow roam count"}}},"XiqConnectivityExperience":{"type":"object","description":"Get connectivity experience","properties":{"start_timestamp":{"type":"integer","format":"int64","description":"Client Start trial in epoch format (milliseconds)"},"device_name":{"type":"string","description":"The Ap name"},"device_id":{"type":"integer","format":"int64","description":"The Ap ID"},"ssid":{"type":"string","description":"The SSID"},"association_duration":{"type":"integer","format":"int64","description":"The association duration in epoch format (milliseconds)"},"auth_method":{"type":"string","description":"Authentication Protocol"},"authentication_response_time":{"type":"integer","format":"int32","description":"Time of the response in epoch format (milliseconds)"},"authentication_status":{"type":"string","description":"authentication status in default PASS"},"dhcp_server_ip":{"type":"string","description":"Dhcp server address"},"dhcp_server_response_time":{"type":"integer","format":"int32","description":"Time of the response in epoch format (milliseconds)"},"dhcp_ip_address_obtained":{"type":"string","description":"Dhcp address ip obtained (in old api clientIp)"},"default_gateway_ip":{"type":"string","description":"Default gateway server address"},"default_gateway_round_trip_delay_time":{"type":"integer","format":"int32","description":"Time of the delay trip in epoch format (milliseconds)"},"dns_server_ip":{"type":"string","description":"Dns server address"},"dns_server_response_time":{"type":"integer","format":"int32","description":"Time of the response in epoch format (milliseconds)"},"association_circle_status":{"type":"string","description":"The circle Association status (Available status  SUCCESS, INVALID, DISABLED, ERROR, NA)","enum":["SUCCESS","INVALID","DISABLED","ERROR","NA"]},"auth_circle_status":{"type":"string","description":"The circle Authentication status (Available status  SUCCESS, INVALID, DISABLED, ERROR, NA)","enum":["SUCCESS","INVALID","DISABLED","ERROR","NA"]},"dhcp_circle_status":{"type":"string","description":"The circle Dhcp Status (Available status  SUCCESS, INVALID, DISABLED, ERROR, NA)","enum":["SUCCESS","INVALID","DISABLED","ERROR","NA"]},"dns_circle_status":{"type":"string","description":"The circle Dns Status (Available status  SUCCESS, INVALID, DISABLED, ERROR, NA)","enum":["SUCCESS","INVALID","DISABLED","ERROR","NA"]},"gateway_circle_status":{"type":"string","description":"The circle Gateway ARP Status (Available status  SUCCESS, INVALID, DISABLED, ERROR, NA)","enum":["SUCCESS","INVALID","DISABLED","ERROR","NA"]},"avg_snr":{"type":"integer","format":"int32","description":"Average SNR in dB"},"avg_rssi":{"type":"integer","format":"int32","description":"Average RSSI in dBm"},"client_ip":{"type":"string","description":"Client IP address"}}},"XiqConnectivityExperienceList":{"type":"object","description":"Get connectivity experience list","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/XiqConnectivityExperience"}}}},"PagedXiqClassificationRule":{"type":"object","properties":{"page":{"type":"integer","format":"int32","description":"The current page number"},"count":{"type":"integer","format":"int32","description":"The element count of the current page"},"total_pages":{"type":"integer","format":"int32","description":"The total page number based on request page size"},"total_count":{"type":"integer","format":"int64","description":"The total element count"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqClassificationRule"}}},"required":["count","page","total_count","total_pages"]},"PagedXiqCertificate":{"type":"object","properties":{"page":{"type":"integer","format":"int32","description":"The current page number"},"count":{"type":"integer","format":"int32","description":"The element count of the current page"},"total_pages":{"type":"integer","format":"int32","description":"The total page number based on request page size"},"total_count":{"type":"integer","format":"int64","description":"The total element count"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqCertificate"}}},"required":["count","page","total_count","total_pages"]},"PagedXiqCertificateBundle":{"type":"object","properties":{"page":{"type":"integer","format":"int32","description":"The current page number"},"count":{"type":"integer","format":"int32","description":"The element count of the current page"},"total_pages":{"type":"integer","format":"int32","description":"The total page number based on request page size"},"total_count":{"type":"integer","format":"int64","description":"The total element count"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqCertificateBundle"}}},"required":["count","page","total_count","total_pages"]},"XiqCloudConfigGroupSortField":{"type":"string","enum":["NAME","DESCRIPTION","ZONE_NAME","READ_ONLY"]},"PagedXiqCloudConfigGroup":{"type":"object","properties":{"page":{"type":"integer","format":"int32","description":"The current page number"},"count":{"type":"integer","format":"int32","description":"The element count of the current page"},"total_pages":{"type":"integer","format":"int32","description":"The total page number based on request page size"},"total_count":{"type":"integer","format":"int64","description":"The total element count"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqCloudConfigGroup"}}},"required":["count","page","total_count","total_pages"]},"PagedXiqBackupHistory":{"type":"object","properties":{"page":{"type":"integer","format":"int32","description":"The current page number"},"count":{"type":"integer","format":"int32","description":"The element count of the current page"},"total_pages":{"type":"integer","format":"int32","description":"The total page number based on request page size"},"total_count":{"type":"integer","format":"int64","description":"The total element count"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqBackupHistory"}}},"required":["count","page","total_count","total_pages"]},"XiqBackupHistory":{"type":"object","properties":{"backup_date":{"type":"integer","format":"int64","description":"The backup date."},"backup_units":{"type":"string","description":"The units of the backup."},"owner_id":{"type":"integer","format":"int64","description":"The owner ID."},"backup_file_name":{"type":"string","description":"The filename of the backup entry."},"backup_version":{"type":"string","description":"The version of the backup."},"backup_file_suffix":{"type":"string","description":"The suffix of the backup file."},"version_matched":{"type":"boolean","description":"If this flag is true, it indicates that backup can be restored."}}},"XiqApiTokenInfo":{"type":"object","properties":{"user_name":{"type":"string","description":"The login username"},"user_id":{"type":"integer","format":"int64","description":"The login user ID"},"role":{"type":"string","description":"The role of login user"},"owner_id":{"type":"integer","format":"int64","description":"The home ownerId of login user"},"data_center":{"type":"string","description":"The home data center of login user"},"scopes":{"type":"array","description":"The login user permissions","items":{"type":"string"}},"issued_at":{"type":"string","format":"date-time","description":"The time at which the JWT was issued"},"expiration_time":{"type":"string","format":"date-time","description":"The expiration time on or after which the JWT MUST NOT be accepted for processing"},"expires_in":{"type":"integer","format":"int64","description":"The expires in seconds"}},"required":["data_center","issued_at","owner_id","role","scopes","user_id","user_name"]},"XiqApplicationSortField":{"type":"string","enum":["NAME","CATEGORY"]},"PagedXiqApplication":{"type":"object","properties":{"page":{"type":"integer","format":"int32","description":"The current page number"},"count":{"type":"integer","format":"int32","description":"The element count of the current page"},"total_pages":{"type":"integer","format":"int32","description":"The total page number based on request page size"},"total_count":{"type":"integer","format":"int64","description":"The total element count"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqApplication"}}},"required":["count","page","total_count","total_pages"]},"XiqApplicationTopClientsUsage":{"type":"object","description":"The Top N Clients Usage per Application","properties":{"application_id":{"type":"integer","format":"int64","description":"The application ID"},"client_id":{"type":"integer","format":"int64","description":"The TOP N client ID"},"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","format":"int64","description":"The TOP N client usage"}}},"XiqAppUsageSummaryMetaData":{"type":"object","description":"The Application Usage Summary Meta Data Model","properties":{"application_names":{"type":"array","description":"The list of application names","items":{"type":"string"}},"category_names":{"type":"array","description":"The list of category names","items":{"type":"string"}}}},"XiqTopApplicationsUsage":{"type":"object","description":"The Top N Applications Usage","properties":{"id":{"type":"integer","format":"int64","description":"The application ID"},"name":{"type":"string","description":"The application name"},"clients":{"type":"integer","format":"int64","description":"The associated unique client count"},"users":{"type":"integer","format":"int64","description":"The associated unique user count"},"usage":{"type":"integer","format":"int64","description":"The application usage"}}},"XiqGetAfcGeolocationFloorReportResponse":{"type":"object","properties":{"floor_report":{"type":"string"}}},"XiqAfcApDetail":{"type":"object","properties":{"status":{"type":"string","enum":["PENDING","GRACE_PERIOD","AVAILABLE","NA"]},"expire":{"type":"integer","format":"int64"},"received":{"type":"integer","format":"int64"},"reason":{"type":"string"},"spectrum":{"$ref":"#/components/schemas/XiqAfcAvailableSpectrum"},"band_width":{"type":"integer","format":"int64"}}},"XiqAfcApDiagnostics":{"type":"object","properties":{"afc_spectrum_details":{"type":"string"}}},"PagedXiqAlert":{"type":"object","properties":{"page":{"type":"integer","format":"int32","description":"The current page number"},"count":{"type":"integer","format":"int32","description":"The element count of the current page"},"total_pages":{"type":"integer","format":"int32","description":"The total page number based on request page size"},"total_count":{"type":"integer","format":"int64","description":"The total element count"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqAlert"}}},"required":["count","page","total_count","total_pages"]},"XiqAlertGroupQuery":{"type":"string","enum":["SEVERITY","CATEGORY","ALERT_TYPE"]},"XiqAlertGroupCount":{"type":"object","description":"The Alert Group Count Model","properties":{"group_id":{"type":"integer","format":"int64","description":"The group unique identifier"},"group_name":{"type":"string","description":"The group name"},"count":{"type":"integer","format":"int64","description":"The count of group"}},"required":["count","group_id"]},"XiqAlertPolicyType":{"type":"string","enum":["GLOBAL","SITE"]},"XiqListAlertPolicies":{"type":"object","description":"The List Alert Policy Response Model","properties":{"global_policy":{"$ref":"#/components/schemas/XiqAlertPolicy","description":"The global alert policy"},"site_policies":{"type":"array","description":"The site alert policy List","items":{"$ref":"#/components/schemas/XiqAlertPolicy"}}}},"XIQAirrmAfcChannelInfo":{"type":"object","properties":{"channel_width":{"type":"integer","format":"int32"},"channels":{"type":"array","items":{"type":"integer","format":"int32"}},"max_power":{"type":"array","items":{"type":"number","format":"double"}}}},"XIQAirrmAfcSpectrum":{"type":"object","properties":{"expired_time":{"type":"string"},"afc_channel_info":{"type":"array","items":{"$ref":"#/components/schemas/XIQAirrmAfcChannelInfo"}}}},"XIQAirrmDeviceRegulatoryConfigAfcSpectrum":{"type":"object","properties":{"serial_number":{"type":"string"},"response":{"$ref":"#/components/schemas/XIQAirrmGetDeviceRegulatoryConfigAfcSpectrumResponse"}}},"XIQAirrmGetDeviceRegulatoryConfigAfcSpectrumResponse":{"type":"object","properties":{"ap_mode":{"type":"string"},"country_code":{"type":"integer","format":"int32"},"antenna_info":{"type":"string","enum":["INDOOR","OUTDOOR","UNDERSEAT"]},"regulatory_configurations":{"type":"array","items":{"$ref":"#/components/schemas/XIQAirrmRegulatoryConfiguration"}},"afc_spectrum":{"$ref":"#/components/schemas/XIQAirrmAfcSpectrum"}}},"XIQAirrmGetSiteDeviceRegulatoryConfigAfcSpectrumResponse":{"type":"object","properties":{"responses":{"type":"array","items":{"$ref":"#/components/schemas/XIQAirrmDeviceRegulatoryConfigAfcSpectrum"}}}},"XIQAirrmRegulatoryConfiguration":{"type":"object","properties":{"radio_mode":{"type":"string","enum":["_11bg","_11a","_11an","_11ng","_11ac","_11ax_2g","_11ax_5g","_11ax_6g","_11be_2g","_11be_5g","_11be_6g"]},"channel_width":{"type":"integer","format":"int32"},"channel_numbers":{"type":"array","items":{"type":"integer","format":"int32"}},"tx_powers":{"type":"array","items":{"type":"number","format":"double"}},"power_mode":{"type":"string","enum":["LPI","SP"]}}},"XIQAirrmGetDeviceApInfoResponse":{"type":"object","properties":{"device_radio_info":{"$ref":"#/components/schemas/XIQAirrmDeviceRadioInfo"}}},"XiqAfcServer":{"type":"object","properties":{"state":{"$ref":"#/components/schemas/XiqAfcServerState"},"server_url":{"type":"string"},"region":{"type":"string"},"server_id":{"type":"integer","format":"int64"}}},"XiqAfcServerState":{"type":"string","enum":["CONNECTED","DNS_ERROR","UNREACHABLE","CONNECTION_REFUSED","INVALID_CERT","REVOKED_CERT","NOT_FOUND","HTTP_ERROR","INVALID_RESPONSE","CONNECTION_RESET","READ_TIMEOUT","UNKNOWN_ERROR"]},"XiqListAfcServers":{"type":"object","properties":{"servers":{"type":"array","items":{"$ref":"#/components/schemas/XiqAfcServer"}}}},"XiqAfcServerStatistics":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"The unique identifier"},"create_time":{"type":"string","format":"date-time","description":"The create time in UTC (ISO 8601 format)"},"update_time":{"type":"string","format":"date-time","description":"The last update time in UTC (ISO 8601 format)"},"connection_state":{"type":"string"},"timestamp":{"type":"integer","format":"int64"}},"required":["create_time","id","update_time"]},"XiqAfcServersStatistics":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/XiqAfcServerStatistics"}}}},"PagedXiqActiveDirectoryServer":{"type":"object","properties":{"page":{"type":"integer","format":"int32","description":"The current page number"},"count":{"type":"integer","format":"int32","description":"The element count of the current page"},"total_pages":{"type":"integer","format":"int32","description":"The total page number based on request page size"},"total_count":{"type":"integer","format":"int64","description":"The total element count"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqActiveDirectoryServer"}}},"required":["count","page","total_count","total_pages"]},"XiqActiveDirectoryServer":{"type":"object","description":"The configuration of Active Directory Server","properties":{"id":{"type":"integer","format":"int64","description":"The unique identifier"},"create_time":{"type":"string","format":"date-time","description":"The create time in UTC (ISO 8601 format)"},"update_time":{"type":"string","format":"date-time","description":"The last update time in UTC (ISO 8601 format)"},"org_id":{"type":"integer","format":"int64","description":"The organization identifier, valid when enabling HIQ feature"},"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","description":"The base DN fetch mode of active directory server"},"connection_setup_device_id":{"type":"integer","format":"int64","description":"The connection setup device ID for active directory server"},"l3_address_profile_id":{"type":"integer","format":"int64","description":"The associate L3 address profile ID for active directory server"}},"required":["create_time","id","update_time"]},"XiqActiveDirectoryServerBaseDnFetchMode":{"type":"string","enum":["AUTO","MANUAL"]},"XiqApiAccessTokenSortField":{"type":"string","enum":["GRANTOR","EXPIRATION","GENERATEDON"]},"PagedXiqApiAccessToken":{"type":"object","properties":{"page":{"type":"integer","format":"int32","description":"The current page number"},"count":{"type":"integer","format":"int32","description":"The element count of the current page"},"total_pages":{"type":"integer","format":"int32","description":"The total page number based on request page size"},"total_count":{"type":"integer","format":"int64","description":"The total element count"},"data":{"type":"array","description":"The data in the current page","items":{"$ref":"#/components/schemas/XiqApiAccessToken"}}},"required":["count","page","total_count","total_pages"]},"XiqEntitlementType":{"type":"string","enum":["EVALUATION","PERMANENT","RENEW","UNKNOWN"]},"XiqLicenseMode":{"type":"string","enum":["BUY","PLANNER","EVAL","MSP","UNKNOWN"]},"XiqLicenseStatus":{"type":"string","enum":["BUY","PLAN","EVAL","EXPIRED","INVALID","MIGRATED"]},"XiqViq":{"type":"object","properties":{"devices":{"type":"integer","format":"int32","description":"Total # of all licensed devices"},"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","format":"int64","description":"The owner account ID"},"licenses":{"type":"array","description":"The license list","items":{"$ref":"#/components/schemas/XiqViqLicense"}},"partner_id":{"type":"string","description":"The partner ID"},"partner_email":{"type":"string","description":"The partner email"}}},"XiqViqLicense":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"The unique identifier"},"create_time":{"type":"string","format":"date-time","description":"The create time in UTC (ISO 8601 format)"},"update_time":{"type":"string","format":"date-time","description":"The last update time in UTC (ISO 8601 format)"},"status":{"$ref":"#/components/schemas/XiqLicenseStatus","description":"The VIQ license status"},"active_date":{"type":"string","format":"date-time","description":"The active date"},"expire_date":{"type":"string","format":"date-time","description":"The expire date"},"entitlement_key":{"type":"string","description":"The entitlement key"},"entitlement_type":{"$ref":"#/components/schemas/XiqEntitlementType","description":"The entitlement key type"},"mode":{"$ref":"#/components/schemas/XiqLicenseMode","description":"The license mode"},"devices":{"type":"integer","format":"int32","description":"The device number"},"activated":{"type":"integer","format":"int32","description":"The activated device number"},"available":{"type":"integer","format":"int32","description":"The available device number"},"license_type":{"type":"string","description":"The Gemalto license type"}},"required":["create_time","id","update_time"]},"XiqViqOperationType":{"type":"string","enum":["EXPORT","IMPORT"]},"XiqViqExportImportStatusResponse":{"type":"object","description":"ExtremeCloud IQ Viq Export Import Status ","properties":{"user_name":{"type":"string","description":"Name of the user"},"vhm_id":{"type":"string","description":"VHM ID of the user"},"operation":{"type":"string","description":"Type of operation"},"status":{"type":"string","description":"Current status of operation"},"total_finish_percentage":{"type":"integer","format":"int64","description":"Total finish percentage"},"export_file_name":{"type":"string","description":"The exported file name"},"log_file_name":{"type":"string","description":"The export log file name"},"export_time":{"type":"integer","format":"int64","description":"The last backed up time."},"start_time":{"type":"integer","format":"int64","description":"The start time."},"end_time":{"type":"integer","format":"int64","description":"The end time."},"remain_time":{"type":"integer","format":"int64","description":"The remaining time."},"viq_task_progresses":{"type":"array","items":{"$ref":"#/components/schemas/XiqViqTaskProgress"}}},"required":["export_file_name","log_file_name"]},"XiqViqTaskProgress":{"type":"object","properties":{"task_name":{"type":"string","description":"Current task name"},"finish_percentage":{"type":"integer","format":"int64","description":"Current task finish percentage"},"detail":{"type":"string","description":"Detail of current task"},"status":{"type":"string","description":"Status of current task"}}},"XiqDefaultDevicePassword":{"type":"object","description":"The default device password","properties":{"password":{"type":"string","description":"The default device password"}},"required":["password"]},"XiqBackupStatus":{"type":"object","description":"The VIQ Backup Status","properties":{"status":{"type":"string","description":"IDLE | IN_PROGRESS | COMPLETED | FAILED"},"last_backup_initiated":{"type":"integer","format":"int64","description":"Epoch millis when the last/current backup was initiated"},"last_backup_completed":{"type":"integer","format":"int64","description":"Epoch millis when the last backup completed"}}},"XiqVhmStatus":{"type":"object","description":"The VHM Status","properties":{"vhm_name":{"type":"string","description":"The VHM account name."},"current_status":{"type":"string","description":"The VIQ Current status."}}},"XiqVhmSettingInfo":{"type":"object","description":"The VHM Setting.","properties":{"id":{"type":"integer","format":"int64","description":"The unique identifier"},"create_time":{"type":"string","format":"date-time","description":"The create time in UTC (ISO 8601 format)"},"update_time":{"type":"string","format":"date-time","description":"The last update time in UTC (ISO 8601 format)"},"org_id":{"type":"integer","format":"int64","description":"The organization identifier, valid when enabling HIQ feature"},"vhm_name":{"type":"string","description":"The VHM account name."},"current_status":{"type":"string","description":"The VIQ Current status."},"backed_up_on":{"type":"integer","format":"int64","description":"The last backup time in milliseconds."},"enable_copilot":{"type":"boolean","description":"Flag indicating whether Co-Pilot should be enabled (true) or disabled (false)."},"enable_ssh":{"type":"boolean","description":"Flag indicating Ssh Availability."},"enable_supplemental_cli":{"type":"boolean","description":"Flag indicating Supplemental CLI."},"enable_wireless_onboarding":{"type":"boolean","description":"Flag indicating AP Out-of-the-box Wireless Onboarding."},"enable_password_for_exos_voss":{"type":"boolean","description":"Flag to enable device management settings for Switch Engine (EXOS) / Fabric Engine (VOSS) switches."},"enable_auto_config_push":{"type":"boolean","description":"Flag to enable auto config push."},"enable_site_isolation":{"type":"boolean","description":"Flag to enable site isolation."},"enable_legacy_uztna_proxy":{"type":"boolean","description":"Flag to enable legacy UZTNA proxy."}},"required":["create_time","id","update_time"]},"XiqThirdPartyApplication":{"type":"object","description":"The Third party application","properties":{"client_id":{"type":"string","description":"The client ID"},"redirect_url":{"type":"string","description":"The redirect URL"},"name":{"type":"string","description":"The third party application name"},"description":{"type":"string","description":"The description of the application"},"state":{"type":"string","description":"The state of the application"}}},"XiqAccount":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"The unique identifier"},"create_time":{"type":"string","format":"date-time","description":"The create time in UTC (ISO 8601 format)"},"update_time":{"type":"string","format":"date-time","description":"The last update time in UTC (ISO 8601 format)"},"name":{"type":"string","description":"Account name"},"account_type":{"$ref":"#/components/schemas/XiqAccountType","description":"Account type"},"account_mode":{"$ref":"#/components/schemas/XiqAccountMode","description":"Account mode"},"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"}},"required":["account_mode","account_type","create_time","data_center","id","name","quota","update_time"]},"XiqAccountMode":{"type":"string","enum":["COPILOT","CONNECT"]},"XiqAccountType":{"type":"string","enum":["INTERNAL","CUSTOMER","HIQ","PARTNER"]},"XiqExternalAccount":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"The unique identifier"},"create_time":{"type":"string","format":"date-time","description":"The create time in UTC (ISO 8601 format)"},"update_time":{"type":"string","format":"date-time","description":"The last update time in UTC (ISO 8601 format)"},"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"}},"required":["active","alias","create_time","data_center","id","name","update_time"]},"XiqDeleteKeyBasedPcgUsersRequest":{"type":"object","description":"The payload of delete Key Based Private Client Group users request","properties":{"user_ids":{"type":"array","description":"The user ID list","items":{"type":"integer","format":"int64"}}},"required":["user_ids"]}},"securitySchemes":{"Bearer":{"type":"http","description":"A JWT token is required to access APIs. JWT token can be obtained by providing correct username and password from <strong>Login</strong> API.","scheme":"bearer","bearerFormat":"JWT"}}}}