openapi: 3.0.3 info: title: ExtremeCloud IQ API description: |- ExtremeCloud IQ™ API allows customers and partners to create solutions for the management, monitoring, and provisioning of any ExtremeCloud IQ™ environment. All related resources and documentation are available at [ExtremeCloud IQ Developer Portal](https://developer.extremecloudiq.com/). Please check [Get Started and Tutorial](https://developer.extremecloudiq.com/documentation/) to understand how to use the APIs. Get the [latest OpenAPI definition](https://github.com/extremenetworks/ExtremeCloudIQ-OpenAPI/blob/main/xcloudiq-openapi.yaml) from [ExtremeCloud IQ OpenAPI GitHub repository](https://github.com/extremenetworks/ExtremeCloudIQ-OpenAPI). Please have a valid [ExtremeCloud IQ](https://extremecloudiq.com/) account before getting started. If you don't have one, please [register a new account](https://www.extremenetworks.com/cloud-networking/). termsOfService: https://www.extremenetworks.com/company/legal/terms-of-use/ contact: name: Extreme Networks Support url: https://www.extremenetworks.com/support email: support@extremenetworks.com license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html version: 25.9.0-36 servers: - url: https://api.extremecloudiq.com description: ExtremeCloud IQ REST API Server externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html tags: - name: Authentication description: User login & logout - name: Authorization description: API token and permissions - name: Operation description: Long-Running Operations (LRO) management for asynchronous APIs - name: Account description: ExtremeCloud IQ Account - name: User description: Local and external user management in ExtremeCloud IQ account - name: HIQ description: Hierarchical ExtremeCloud IQ - name: Location description: Hierarchical locations and floor plan - name: Device description: 'Supported device platforms: Cloud Engine, IQ Engine, WiNG, VOSS, EXOS...' - name: Network Policy description: Unified configuration management for wireless and wired network devices - name: Network Scorecard description: The network scorecard containing device, client, network, Wi-Fi, services health of the selected location. - name: Client description: The clients associate to the devices of ExtremeCloud IQ - name: Application description: Application management and application metrics - name: Alert description: ExtremeCloud IQ generated alerts and events - name: Log description: Access all kinds of logs in ExtremeCloud IQ - name: Notification description: Push events/logs to users via Webhook, Email, SMS, etc. - name: Configuration - Deployment description: Push configuration to devices - name: Configuration - Basic description: VLAN Profile/DHCP Server/... - name: Configuration - User Management description: User Group/End User/PCG/PPSK Classification - name: Configuration - Policy description: SSID/User Profile/Classification Rule/CCG/Radio Profile/... - name: Configuration - Network description: Tunnel Concentrator Service, Network service - name: Configuration - Authentication description: AD/LDAP/RADIUS/RADSEC/CWP/... - name: Configuration - Certificate description: Certificate - name: Copilot - Connectivity Experience description: The Copilot Connectivity Experience API - name: Copilot - Anomalies description: The Copilot Anomalies API - name: PacketCaptures description: Packet capture sessions in ExtremeCloud IQ - name: Essentials - ExtremeLocation description: The ExtremeLocation and Analytics API - name: Misc description: Metadata - Country/... - name: SDWAN description: The SDWAN API - name: Thread description: Thread Networks in ExtremeCloud IQ - name: AFC description: ExtremeCloud IQ AFC Feature. - name: Universal Compute Platform description: The Universal Compute Platform (UCP) API - name: Administration description: API Token Management and 3rd Party API Connections - name: Dashboard description: Device and client health and status/dashboard - name: D360 description: Device 360 - name: Dashboard - Wireless Client Health description: Client dashboard - name: Dashboard - Wireless Usage and Capacity description: Usage and capacity dashboard - name: Dashboard - Wireless Device Health description: Device dashboard - name: Dashboard - Wired Client Health description: Client dashboard - name: Dashboard - Wired Device Health description: Device dashboard - name: Dashboard - Wired Usage and Capacity description: Wired Usage and Capacity - name: Switch Inspector Panel description: Switch Inspector Panel - name: Geo-View description: Geo View - name: NG Reports description: The NG Reports - On Demand Analytics and Scheduled Reporting - name: NG Scheduled Reports description: The NG Reports - Scheduled Reporting - name: UZ description: UZ Requests - name: Client - Details description: The details of client associate to the devices of ExtremeCloud IQ - name: RTTS description: RTT sessions in ExtremeCloud IQ paths: /login: post: tags: - Authentication summary: User login with username and password description: Get access token via username and password authentication.

The 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.

User can also provide an optional rate limits parameter to control the rate limiting for the current session. operationId: login externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_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_rate_limiting: summary: Login with rate limiting description: User login with rate limiting value: username: username@company.com password: ChangeMe rate_limit: hour: 7500 login_with_multiple_rate_limits: summary: Login with multiple rate limits description: User login with multiple rate limits value: username: username@company.com password: ChangeMe rate_limit: hour: 7500 second: 100 required: true responses: '200': description: Successfully login content: application/json: schema: $ref: '#/components/schemas/XiqLoginResponse' examples: Login_successful: summary: Login successful description: Login successful response example. value: access_token: eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjpmYWxzZSwib3duZXJfaWQiOjEwMiwib3JnX2lkIjowLCJkYXRhX2NlbnRlciI6IlVTX1dlc3QiLCJxdW90YSI6Ijc1MDA7dz0zNjAwIiwianRpIjoiMTcyZTExMWMwNDMzNDBkODkyYmViYTkyNmZlOTM0NmYiLCJpc3MiOiJleHRyZW1lY2xvdWRpcS5jb20iLCJpYXQiOjE2NDQ4NzcwNDgsImV4cCI6MTY0NDk2MzQ0OH0.kFRSUXLhg9800gSU2BQ4Gf7l_8eEhgpd0D90Ia6w0kw token_type: Bearer expires_in: 86400 default: $ref: '#/components/responses/ErrorResponse' /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. operationId: logout externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_logout responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /auth/apitoken: post: tags: - Authorization summary: Generate new API token description: Generate a new API token with given permissions and expiration time.

The available permission list can be found via 'GET /auth/permissions' endpoint.

User can also provide an optional rate limits parameter to control the rate limiting for the API token. operationId: generateApiToken externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_generate_api_token requestBody: description: Generate API token request body content: application/json: schema: $ref: '#/components/schemas/XiqGenerateApiTokenRequest' examples: Generate_API_token: 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_rate_limiting: summary: Generate API token with specific permissions and rate limiting description: Generate API token with a single permission to read account info and rate limiting value: description: Token for reading account info only expire_time: 1604737598 permissions: - account:r rate_limit: hour: 7500 Generate_API_token_with_multiple_rate_limits: summary: Generate API token with specific permissions and multiple rate limits description: Generate API token with a single permission to read account info and multiple rate limits value: description: Token for reading account info only expire_time: 1604737598 permissions: - account:r rate_limit: hour: 7500 second: 100 required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqGenerateApiTokenResponse' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /auth/apitoken/info: get: tags: - Authorization summary: Get current API token details description: Introspect current API token and get detail information. operationId: getCurrentApiTokenInfo externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_api_token_details responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqApiTokenInfo' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /auth/apitoken/:validate: post: tags: - Authorization summary: Validate API token description: Validate JWT format API token. operationId: validateApiToken externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_validate_api_token requestBody: content: text/plain: schema: type: string description: The API token to be validated required: true responses: '200': description: The API token is valid '401': description: The API token is invalid or revoked default: $ref: '#/components/responses/ErrorResponse' /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. operationId: listPermissions externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_list_permissions responses: '200': description: Successful operation content: application/json: schema: type: string default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /auth/permissions/:check: post: tags: - Authorization summary: Check permissions description: Get required permissions for given HTTP request. operationId: checkPermissions externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_check_permissions requestBody: content: application/json: schema: $ref: '#/components/schemas/XiqCheckPermissionRequest' required: true responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/XiqCheckPermissionResponse' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /operations/{operationId}: get: tags: - Operation summary: Get Long-Running Operation (LRO) status and result description: |- Get the Long-Running Operation (LRO) status and result. The 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' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] delete: tags: - Operation summary: Delete Long-Running Operation (LRO) description: The Long-Running Operation (LRO) can be deleted when the operation is done or in PENDING status. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_delete_operation operationId: deleteOperation parameters: - name: operationId in: path description: The operation ID required: true schema: type: string responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /operations/{operationId}/:cancel: post: tags: - Operation summary: Cancel Long-Running Operation (LRO) description: |- When the cancelable is true in operation metadata the clients are allowed to send a cancel request to ask the backend to cancel the operation. The 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 default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /account/home: get: tags: - Account summary: Get home ExtremeCloud IQ account info description: Get home ExtremeCloud IQ account info. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_basic_info operationId: getHomeAccount responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqAccount' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /account/external: get: tags: - Account summary: List accessible external guest accounts description: List accessible external ExtremeCloud IQ accounts. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_list_external_accounts operationId: listExternalAccounts responses: '200': description: OK content: application/json: schema: type: array items: $ref: '#/components/schemas/XiqExternalAccount' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /account/:switch: post: tags: - Account summary: Switch to another ExtremeCloud IQ account description: Switch to external ExtremeCloud IQ account or switch back to home ExtremeCloud IQ account. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_switch_account operationId: switchAccount parameters: - name: id in: query description: The account ID to switch, switch back to home ExtremeCloud IQ account if not provide required: false schema: type: integer format: int64 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqLoginResponse' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /account/viq: get: tags: - Account summary: Get VIQ Info description: Get account VIQ and license info. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_viq_info operationId: getViqInfo responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqViq' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /account/viq/:backup: post: tags: - Account summary: Backup VIQ description: Backup VIQ in ExtremeCloud IQ. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_viq_backup operationId: backupViq responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /account/viq/default-device-password: get: tags: - Account summary: Get the default device password in the account description: Get the default device password in the account. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_default_device_password operationId: getDefaultDevicePassword responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqDefaultDevicePassword' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] put: tags: - Account summary: Update the default device password in the account description: Update the default device password in the global setting for accessing the console/shell of the devices. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_update_default_device_password operationId: updateDefaultDevicePassword requestBody: description: The new default device password content: application/json: schema: type: string required: true responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /v1/account/viq/default-device-password: put: tags: - Account summary: Update the default device password 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 default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /account/export: post: tags: - Account summary: Create VIQ export data description: Export VIQ reports. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_viq_export_report operationId: viqExportReport parameters: - name: timeoutInSeconds in: query description: The maximum export duration required: false schema: type: integer format: int64 - name: excludeDeviceFirmware in: query description: Whether exclude device firmwares from VIQ export file or not required: false schema: type: boolean responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqViqExportReport' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /account/import: post: tags: - Account summary: Import VIQ details from a file description: Import Viq details. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_viq_import operationId: viqImport requestBody: content: multipart/form-data: schema: required: - file type: object properties: file: type: string description: The import file to import VIQ data(.tar/.tar.gz) format: binary required: true parameters: - name: timeoutInSeconds in: query description: The maximum import duration required: false schema: type: integer format: int64 - name: resendUserNotifications in: query description: Resend Cloud PPSK/RADIUS password through email/SMS. required: false schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqViqImportReport' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /account/download: get: tags: - Account summary: Download VIQ reports or logs description: Download VIQ exports reports and export or import logs. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_viq_reports_download operationId: downloadViqReports parameters: - name: reportName in: query description: The name of the report required: true schema: type: string responses: '200': description: OK content: application/octet-stream: schema: type: string format: byte default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /account/export-import-status: get: tags: - Account summary: Status of VIQ export/import operation description: Check the current VIQ export or import status. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_viq_export_import_status operationId: exportImportStatus parameters: - name: reportName in: query description: The name of the report required: true schema: type: string - name: statusType in: query description: The operation type- export or import required: true schema: type: string items: $ref: '#/components/schemas/XiqViqStatusType' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqViqExportImportResponse' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /account/viq/:reset: post: tags: - Account summary: Resetting 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 default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /account/vhm/setting: get: tags: - Account summary: Get Account VHM Setting description: Get Flag status of CoPilot, SSH Aavailibility, Supplemental CLI, AP Out-of-the-box Wireless Onboarding. 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: type: array items: $ref: '#/components/schemas/XiqVhmSettingInfo' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /account/vhm/setting/{id}: put: tags: - Account summary: Update Account VHM Setting description: Enable/Disable CoPilot, SSH Aavailibility, Supplemental CLI, AP Out-of-the-box Wireless Onboarding. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_update_vhm_setting_by_id operationId: updateVhmSetting parameters: - $ref: '#/components/parameters/id' requestBody: description: The payload of the update Account VHM Setting. content: application/json: schema: $ref: '#/components/schemas/XiqUpdateVhmSettingRequest' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqVhmSetting' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /account/vhm/status: get: tags: - Account summary: Get Account VHM Status description: Check VHM Account status like vhm name, current run 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' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /backup/history/grid: get: tags: - Account summary: Get Backup History Grid description: Get Backup History Grid to track and restore backed up database. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_backup_history_grid operationId: backupGrid responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PagedBackupGrid' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /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_restore operationId: backupRestore parameters: - name: backup_file in: query description: The backup file that needs to be restored. required: true schema: type: string responses: '201': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /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: backupDelete parameters: - name: backup_files in: query description: The list of backup files (comma-separated) that need to be deleted. required: true schema: type: array items: type: string example: - 24.5.0.28_1719393103615 - 24.5.0.28_1719333999741 style: form explode: false responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /third/party/applications: get: tags: - Account summary: Get third party applications description: Get third party applications. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_third_party_applications_by_owner_id operationId: getThirdPartyApplications responses: '200': description: OK content: application/json: schema: type: array items: $ref: '#/components/schemas/XiqThirdPartyApplications' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /users: get: tags: - User summary: List all users description: List users with pagination. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_user_list operationId: listUsers parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/limit' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PagedXiqUser' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] post: tags: - User summary: Create new user description: Create a new user to access. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_create_new_user operationId: createUser requestBody: description: Create new user request body content: application/json: schema: $ref: '#/components/schemas/XiqCreateUserRequest' required: true responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/XiqUser' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /users/me: get: tags: - User summary: Get current user info description: Get currently login user info. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_current_user operationId: getCurrentUser responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqUser' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /users/{id}: get: tags: - User summary: Get user info by ID description: Get user info for a specific user. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_user operationId: getUser parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqUser' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] patch: tags: - User summary: Update user info description: Updates user info for a specific user. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_update_user operationId: updateUser parameters: - $ref: '#/components/parameters/id' 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' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] delete: tags: - User summary: Delete user by ID description: Delete a specific user. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_delete_user operationId: deleteUser parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /users/external: get: tags: - User summary: List external access users description: List a page of external access users. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_external_user_list operationId: listExternalUsers parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/limit' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PagedXiqExternalUser' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] post: tags: - User summary: Grant external access description: Grant external access to a specific user. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_grant_external_user operationId: grantExternalUser requestBody: description: Grant external user request content: application/json: schema: $ref: '#/components/schemas/XiqGrantExternalUserRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqExternalUser' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /users/external/{id}: get: tags: - User summary: Get external access info description: Get external access info for a specific external user. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_external_user operationId: getExternalUser parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqExternalUser' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] patch: tags: - User summary: Update external access info description: Updates external access info for a specific user. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_update_external_user operationId: updateExternalUser parameters: - $ref: '#/components/parameters/id' requestBody: description: Update external user request content: application/json: schema: $ref: '#/components/schemas/XiqUpdateExternalUserRequest' examples: Update_external_user_info.: description: Update external user info. value: user_role: ADMINISTRATOR required: true responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] delete: tags: - User summary: Revoke external access description: Revoke external acccess for a specific user. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_revoke_external_user operationId: revokeExternalUser parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /users/grid: post: tags: - User summary: List users description: Returns a paginated list of users with support for search, filter, and sort. operationId: list_users parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/limit' - name: search in: query description: Search term for user name, email or group required: false schema: type: string - name: sort_field in: query description: Field to sort by required: false schema: type: string enum: - data_usage - session_duration - expiration - user_name - email - group - source - $ref: '#/components/parameters/order' - $ref: '#/components/parameters/startTime' - $ref: '#/components/parameters/endTime' requestBody: required: false content: application/json: schema: type: object properties: user_name: type: array items: type: string description: Filter by user name(s) group: type: array items: type: string description: Filter by user group(s) email: type: array items: type: string description: Filter by email(s) source: type: array items: type: string description: Filter by session source(s) status: type: boolean description: Filter by user status number_filters: type: array description: | The number-based column filters available. Available columns: data_usage, session_duration, expiration. items: $ref: '#/components/schemas/number_filter' site_ids: description: List of site IDs to filter the users grid type: array items: type: integer format: int64 responses: '200': description: A paginated list of user sessions content: application/json: schema: $ref: '#/components/schemas/RmPagedUsers' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /users/filter_metadata: post: tags: - User summary: List user grid filter metadata description: Returns lists of available values for user_name, group, and source fields used in the user grid. operationId: listUserGridFilterMetadata requestBody: required: false content: application/json: schema: type: object properties: site_ids: description: List of site IDs to filter the users grid type: array items: type: integer format: int64 responses: '200': description: Lists of values for user grid filters content: application/json: schema: type: object properties: user_names: type: array items: type: string description: List of unique user names groups: type: array items: type: string description: List of unique user groups sources: type: array items: type: string description: List of unique session sources emails: type: array items: type: string description: List of unique emails default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /users/type_distribution: post: tags: - User summary: Get user type distribution description: Returns the percentage distribution of connected users by type (PPSK, RADIUS, Others) and the total number of connected users. operationId: getUserTypeDistribution requestBody: required: false content: application/json: schema: type: object properties: site_ids: description: List of site IDs to filter the users grid type: array items: type: integer format: int64 responses: '200': description: User type distribution and total connected users content: application/json: schema: type: object properties: ppsk_percentage: type: number format: float description: Percentage of users authenticated via PPSK radius_percentage: type: number format: float description: Percentage of users authenticated via RADIUS others_percentage: type: number format: float description: Percentage of users authenticated via other methods total_connected_users: type: integer description: Total number of connected users default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /users/data_usage: post: tags: - User summary: Get user data usage description: Returns data usage in bytes for each user. operationId: getUserDataUsage requestBody: required: false content: application/json: schema: type: object properties: site_ids: description: List of site IDs to filter the users grid type: array items: type: integer format: int64 responses: '200': description: Data usage per user content: application/json: schema: type: object properties: users: type: array items: type: object properties: user_name: type: string description: Name or identifier of the user data_usage_gb: type: number format: float description: Data usage in bytes default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /users/grid_export: post: tags: - User summary: Export user grid description: Export the user grid data as a CSV file. operationId: exportUserGridToCsv parameters: - name: search in: query description: Search term for user name, email or group required: false schema: type: string - name: sort_field in: query description: Field to sort by required: false schema: type: string enum: - data_usage - session_duration - expiration - user_name - email - group - source - $ref: '#/components/parameters/order' - $ref: '#/components/parameters/startTime' - $ref: '#/components/parameters/endTime' requestBody: required: false content: application/json: schema: type: object properties: user_name: type: array items: type: string description: Filter by user name(s) group: type: array items: type: string description: Filter by user group(s) source: type: array items: type: string description: Filter by session source(s) email: type: array items: type: string description: Filter by email(s) site_ids: description: List of site IDs to filter the client health grid type: array items: type: integer format: int64 number_filters: type: array description: | The number-based column filters available. Available columns: data_usage, session_duration, expiration. items: $ref: '#/components/schemas/number_filter' responses: '202': description: Accepted - The request has been accepted for processing, but the processing has not been completed. headers: location: description: The URL to check the status or download the exported file schema: type: string format: uri retry-after: description: Time in seconds to wait before polling the status schema: type: integer default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /hiq/status: get: tags: - HIQ summary: Get HIQ status description: Get Hierarchical ExtremeCloud IQ (HIQ) status. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_hiq_status operationId: getHiqStatus responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqHiqStatus' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /hiq/context: get: tags: - HIQ summary: Get HIQ context description: |- Get the current effective HIQ context for reading or creating data in organizations. Appliable 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' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] put: tags: - HIQ summary: Set HIQ context description: |- Set the current effective HIQ context for reading or creating data in organizations. Only 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 default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /hiq/context/reading: get: tags: - HIQ summary: Get organizations for reading data description: |- Get organizations for reading data (Empty list means reading data from all organizations in the HIQ). Appliable 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 default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] put: tags: - HIQ summary: Set organizations for reading data description: |- Set organization for reading data (Empty list means reading data from all organizations in the HIQ). Only 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 default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /hiq/context/creating: get: tags: - HIQ summary: Get organization for creating new data description: |- Get organization for creating new data (Only one organization is active for creating new data). Appliable 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 default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] put: tags: - HIQ summary: Set organization for creating new data description: |- Set organization for creating new data (Only one organization is active for creating new data). Only 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 default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /hiq/organizations: get: tags: - HIQ summary: List all organizations description: List all organizations in current HIQ (Available when HIQ is enabled). externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_all_organizations operationId: listOrganizations responses: '200': description: OK content: application/json: schema: type: array items: $ref: '#/components/schemas/XiqOrganization' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] post: tags: - HIQ summary: Create a new organization description: Create a new organization in current HIQ (Available when HIQ is enabled). externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_create_organization operationId: createOrganization requestBody: description: Create new organization request body content: application/json: schema: $ref: '#/components/schemas/XiqCreateOrganizationRequest' required: true responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/XiqOrganization' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /hiq/organizations/{id}: delete: tags: - HIQ summary: Delete an existing organization description: Delete an existing organization (Available when HIQ is enabled). externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_delete_organization operationId: deleteOrganization parameters: - $ref: '#/components/parameters/id' responses: '204': description: No Content default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /hiq/organizations/{id}/:rename: post: tags: - HIQ summary: Rename an existing organization description: Rename an existing organization (Available when HIQ is enabled). externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_rename_organization operationId: renameOrganization parameters: - $ref: '#/components/parameters/id' requestBody: description: The new organization name content: application/json: schema: type: string required: true responses: '204': description: No Content default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /locations: post: tags: - Location summary: Create 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/ClsCreateLocationRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ClsLocation' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /locations/tree: get: tags: - Location summary: Get location tree description: Get location hierarchical tree. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_location_tree operationId: getLocationTree parameters: - name: parentId in: query description: The parent location ID, return root locations if parent is null required: false schema: type: integer format: int64 - name: expandChildren in: query description: |- Whether to return the child locations recursively, default is true. Set 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/ClsLocation' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /locations/tree/devices: get: tags: - Location summary: Get devices on the location hierarchy description: Get devices on the location hierarchy with pagination. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_location_tree_devices operationId: getLocationDevicesList parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/limit' - 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. Set 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/PagedClsLocationTreeDevice' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /locations/tree/maps: get: tags: - Location summary: Get maps on the location hierarchy description: Get maps on the location hierarchy with pagination. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_location_tree_maps operationId: getLocationMapsList parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/limit' - 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. Set 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/PagedClsLocationTreeMap' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /locations/floorplan: post: tags: - Location summary: Upload floorplan description: Upload the floorplan map for the VIQ. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_upload_floor_plan operationId: uploadFloorplan requestBody: content: multipart/form-data: schema: required: - file type: object properties: file: type: string description: "The floorplan image file to upload. \n For better performance, Extreme Networks recommends that the image file (.png .jpeg) be less than 10 MB." format: binary required: true responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /locations/{id}: put: tags: - Location summary: Update location description: Update the 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: - $ref: '#/components/parameters/id' requestBody: description: Update location request body content: application/json: schema: $ref: '#/components/schemas/ClsUpdateLocationRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ClsLocation' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] delete: tags: - Location summary: Delete location by ID description: Delete the location for the specified ID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_delete_location operationId: deleteLocation parameters: - $ref: '#/components/parameters/id' - 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 content: application/json: schema: type: string default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /locations/floor: get: tags: - Location summary: List floors description: List pages of floors by filter. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_list_floors operationId: getFloors parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/limit' - 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: type: array items: $ref: '#/components/schemas/ClsFloor' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] post: tags: - Location summary: Create 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/ClsCreateFloorRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ClsFloor' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /locations/floor/{id}: get: tags: - Location summary: Get a floor by ID description: Get the floor for the specified ID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_floor operationId: getFloor parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ClsFloor' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] put: tags: - Location summary: Update floor description: Update floor information with the floor ID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_update_floor operationId: updateFloor parameters: - $ref: '#/components/parameters/id' requestBody: description: Update floor request body content: application/json: schema: $ref: '#/components/schemas/ClsUpdateFloorRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ClsFloor' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] delete: tags: - Location summary: Delete floor by ID description: Delete the floor for the specified ID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_delete_floor operationId: deleteFloor parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /locations/building: get: tags: - Location summary: List buildings description: List pages of buildings by filter. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_list_buildings operationId: getBuildings parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/limit' - 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: type: array items: $ref: '#/components/schemas/ClsBuilding' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] post: tags: - Location summary: Create building description: Create a new building under the parent location. 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/ClsCreateBuildingRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ClsBuilding' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /locations/building/{id}: get: tags: - Location summary: Get a building by ID description: Get the building for the specified ID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_building operationId: getBuilding parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ClsBuilding' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] put: tags: - Location summary: Update building description: Update the building information with the building ID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_update_building operationId: updateBuilding parameters: - $ref: '#/components/parameters/id' requestBody: description: Update building request body content: application/json: schema: $ref: '#/components/schemas/ClsUpdateBuildingRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ClsBuilding' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] delete: tags: - Location summary: Delete building by ID description: Delete the building for the specified ID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_delete_building operationId: deleteBuilding parameters: - $ref: '#/components/parameters/id' - 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 default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /locations/site: get: tags: - Location summary: List sites description: List pages of sites by filter. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_list_sites operationId: getSites parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/limit' - 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: type: array items: $ref: '#/components/schemas/ClsSite' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] post: tags: - Location summary: Create site description: Create a new site under the GENERIC folder. 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/ClsCreateSiteRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ClsSite' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /locations/site/{id}: get: tags: - Location summary: Get site by ID description: Get the site for the specified ID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_site operationId: getSite parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ClsSite' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] put: tags: - Location summary: Update site by ID description: Update the site information with the site ID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_update_site operationId: updateSite parameters: - $ref: '#/components/parameters/id' requestBody: description: Update site request body content: application/json: schema: $ref: '#/components/schemas/ClsUpdateSiteRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ClsSite' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] delete: tags: - Location summary: Delete site by ID description: Delete the site for the specified ID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_delete_site operationId: deleteSite parameters: - $ref: '#/components/parameters/id' - 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 default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /locations/wall/type: get: tags: - Location summary: Get a 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/ClsWallType' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] 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 responses: '200': description: Create wall type request body content: application/json: schema: $ref: '#/components/schemas/ClsCreateWallTypeRequest' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /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: - $ref: '#/components/parameters/id' requestBody: description: Update wall type request body content: application/json: schema: $ref: '#/components/schemas/ClsUpdateWallTypeRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ClsWallType' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] delete: tags: - Location summary: Delete a wall type description: Delete the custom 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: - $ref: '#/components/parameters/id' responses: '204': description: No Content content: application/json: schema: type: string default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /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: findWallTypeReference parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/json: schema: type: array items: $ref: '#/components/schemas/ClsWallTypeReference' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /devices: get: tags: - Device summary: '[LRO] List devices' description: List devices with filters and pagination. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_device_list operationId: listDevices parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/locationIds' - 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' - $ref: '#/components/parameters/order' - 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: nullField in: query description: The device empty field, only returns the selected field that is null required: false schema: $ref: '#/components/schemas/XiqDeviceNullField' - $ref: '#/components/parameters/async' - 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' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /devices/:onboard: post: tags: - Device summary: Onboard Devices description: |- Onboard devices for all devices, such as Extreme/Aerohive, EXOS, VOSS, WiNG, Dell, and Digital Twin. This is asynchronized operation to support massive device onboarding. operationId: onboardDevices requestBody: content: application/json: schema: $ref: '#/components/schemas/XiqOnboardDeviceRequest' required: true responses: '202': description: Accepted default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /devices/:advanced-onboard: post: tags: - Device summary: '[LRO] Advanced Onboard Devices' description: Advanced onboard devices for all devices, such as Extreme/Aerohive, EXOS, VOSS, WiNG, and Dell. 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. To 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: - $ref: '#/components/parameters/async' requestBody: content: application/json: schema: $ref: '#/components/schemas/XiqAdvancedOnboardDeviceRequest' required: true responses: '200': description: Ok content: application/json: schema: $ref: '#/components/schemas/XiqAdvancedOnboardDeviceResponse' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /devices/:manage: post: tags: - Device summary: Change status to Managed description: Change device management status to Managed for the target devices. operationId: changeStatusToManage requestBody: content: application/json: schema: $ref: '#/components/schemas/XiqDeviceFilter' required: true responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /devices/:unmanage: post: tags: - Device summary: Change status to Unmanaged description: Change device management status to Unmanaged for the target devices. operationId: changeStatusToUnmanage requestBody: description: The device filter content: application/json: schema: $ref: '#/components/schemas/XiqDeviceFilter' required: true responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /devices/:cli: post: tags: - Device summary: '[LRO] Send CLI to devices' description: Send CLI commands to the target devices. This API can be run at async mode, please follow the Long-Running Operation (LRO) guide to track the progress and the result. operationId: sendCliToDevices parameters: - $ref: '#/components/parameters/async' requestBody: content: application/json: schema: $ref: '#/components/schemas/XiqSendCliRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqSendCliResponse' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /devices/:reboot: post: tags: - Device summary: Reboot devices description: Reboot the target devices. operationId: rebootDevices requestBody: content: application/json: schema: $ref: '#/components/schemas/XiqDeviceFilter' required: true responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /devices/:delete: post: tags: - Device summary: Delete devices description: Bulk delete the devices matching the filter criteria. 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 default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /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#_reset_devices_for_once_device operationId: resetDevices parameters: - $ref: '#/components/parameters/async' requestBody: content: application/json: schema: type: object properties: device_ids: type: array items: type: integer format: int64 description: List of device IDs to reset to factory default. required: true responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /devices/location/:query: post: tags: - Device summary: Query location for multiple devices description: Query the location for the target 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' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /devices/location/:assign: post: tags: - Device summary: Assign location to multiple devices description: Assign the location to the target devices. operationId: assignDevicesLocation requestBody: content: application/json: schema: $ref: '#/components/schemas/XiqAssignDevicesLocationRequest' required: true responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /devices/location/:revoke: post: tags: - Device summary: Revoke location for multiple devices description: Revoke the location from the target devices. operationId: revokeDevicesLocation requestBody: content: application/json: schema: $ref: '#/components/schemas/XiqDeviceFilter' required: true responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /devices/network-policy/:query: post: tags: - Device summary: Query network policy for multiple devices description: Query the network policy for the target devices. 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' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /devices/radius-proxy/:assign: put: tags: - Device summary: Assign RADIUS proxy to devices description: Assign a 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 default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /devices/network-policy/:assign: post: tags: - Device summary: Assign network policy to multiple devices description: Assign the network policy to the target devices. operationId: assignDevicesNetworkPolicy requestBody: content: application/json: schema: $ref: '#/components/schemas/XiqAssignDevicesNetworkPolicyRequest' required: true responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /devices/network-policy/:revoke: post: tags: - Device summary: Revoke network policy for multiple devices description: Revoke the network policy from the target devices. operationId: revokeDevicesNetworkPolicy requestBody: content: application/json: schema: $ref: '#/components/schemas/XiqDeviceFilter' required: true responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /devices/network-policy/{policyId}: get: tags: - Device summary: List assigned devices for network policy description: List assigned devices for the network policy with pagination. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_list_assigned_devices_for_network_policy operationId: listDevicesByNetworkPolicy parameters: - name: policyId in: path description: The network policy ID required: true schema: type: integer format: int64 - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/limit' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PagedXiqDevice' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /devices/country-code/:assign: post: tags: - Device summary: Assign a country code to devices description: Assign the country code to one or more devices. operationId: assignDevicesCountryCode requestBody: content: application/json: schema: $ref: '#/components/schemas/XiqAssignDevicesCountryCodeRequest' required: true responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /devices/os/:change: post: tags: - Device summary: Change device OS mode description: Change OS mode for AP or Switch. operationId: changeDevicesOsMode requestBody: content: application/json: schema: $ref: '#/components/schemas/XiqChangeDevicesOsModeRequest' required: true responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /devices/ibeacon: put: tags: - Device summary: Change iBeacon settings for devices description: Update the existing or create new iBeacon settings for multiple devices. externalDocs: description: API Reference url: http://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 default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /devices/stats: get: tags: - Device summary: Get device stats description: Get device stats, such as total device count, managed device count, connected device count, etc. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_list_device_status_summary operationId: getDeviceStats parameters: - name: locationId in: query description: The location ID required: false schema: type: integer format: int64 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqDeviceStats' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /devices/{id}: get: tags: - Device summary: Get device info for a specific device description: Get device info for a specific device. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_device_details_for_one_device operationId: getDevice parameters: - $ref: '#/components/parameters/id' - 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/XiqDevice' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] delete: tags: - Device summary: Delete a device description: Delete a specific device. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_delete_device operationId: deleteDevice parameters: - $ref: '#/components/parameters/id' - name: force_delete in: query description: Force deletion of device required: false schema: type: boolean default: false responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /devices/{id}/:manage: post: tags: - Device summary: Change admin state to 'Managed' for a device description: Change device management status to Managed for a specific device. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_change_status_to_managed_for_one_device operationId: changeDeviceStatusToManage parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /devices/{id}/:unmanage: post: tags: - Device summary: Change admin state to 'Unmanaged' for a device description: Change device admin state to 'Unmanaged' for a specific device. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_change_status_to_unmanaged_for_one_device operationId: changeDeviceStatusToUnmanage parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /devices/{id}/:cli: post: tags: - Device summary: Send CLI to a device description: Send CLI commands to a specific device. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_send_cli_to_one_device operationId: sendCliToDevice parameters: - $ref: '#/components/parameters/id' 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' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /devices/{id}/:reboot: post: tags: - Device summary: Reboot a device description: Reboot a specific device. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_reboot_one_device operationId: rebootDevice parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /devices/{id}/:reset: post: tags: - Device summary: '[LRO] Reset a device to factory default' description: Reset a device to factory default settings. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_reset_device_for_once_device operationId: resetDevice parameters: - $ref: '#/components/parameters/id' - $ref: '#/components/parameters/async' responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /devices/{id}/hostname: put: tags: - Device summary: Change hostname for a device description: Change hostname for a specific device. operationId: changeHostname parameters: - $ref: '#/components/parameters/id' - name: hostname in: query description: The new hostname required: true schema: type: string responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /devices/{id}/description: put: tags: - Device summary: Change description for a device description: Change description for a specific device. operationId: changeDeviceDescription parameters: - $ref: '#/components/parameters/id' requestBody: description: The device description content: text/plain: schema: maxLength: 64 minLength: 1 type: string required: true responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /devices/{id}/location: get: tags: - Device summary: Get location for a device description: Get the location info for a specific device. operationId: getDeviceLocation parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqDeviceLocation' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] put: tags: - Device summary: Assign location to a device description: Assign a location to a specific device with extra map and geographical properties. operationId: assignDeviceLocation parameters: - $ref: '#/components/parameters/id' requestBody: content: application/json: schema: $ref: '#/components/schemas/XiqDeviceLocationAssignment' required: true responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] delete: tags: - Device summary: Revoke location for a device description: Revoke the assigned location for a specific device. operationId: revokeDeviceLocation parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /devices/{id}/network-policy: get: tags: - Device summary: Get network policy for a device description: Get the network policy for a specific device. operationId: getDeviceNetworkPolicy parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqNetworkPolicy' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] put: tags: - Device summary: Assign network policy to a device description: Assign a network policy to a specific device. operationId: assignDeviceNetworkPolicy parameters: - $ref: '#/components/parameters/id' - name: networkPolicyId in: query description: The network policy ID to assign required: true schema: type: integer format: int64 responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] delete: tags: - Device summary: Revoke network policy for a device description: Revoke the assigned network policy for a specific device. operationId: revokeDeviceNetworkPolicy parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /devices/{id}/ssid/:override: post: tags: - Device summary: Override SSID for a device description: Override SSID broadcast name/passphrase for a specific device. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_device_level_ssid_override operationId: overrideDeviceLevelSsid parameters: - $ref: '#/components/parameters/id' requestBody: content: application/json: schema: $ref: '#/components/schemas/XiqDeviceLevelSsid' required: true responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /devices/{id}/ssid/status: get: tags: - Device summary: Get SSID status for a device description: Get the SSIDs status on each wifi interface for a specific device. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_device_level_ssid_status_on_each_wifi_interface operationId: getDeviceLevelSsidStatus parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/json: schema: type: object additionalProperties: $ref: '#/components/schemas/XiqDeviceLevelSsidStatus' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /devices/{id}/ssid/status/:change: post: tags: - Device summary: Enable or disable SSID for a device description: Enable or disable SSIDs on the given wifi interfaces for a specific device. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_change_the_device_level_ssid_status_on_each_wifi_interface operationId: changeDeviceLevelSsidStatus parameters: - $ref: '#/components/parameters/id' requestBody: content: application/json: schema: $ref: '#/components/schemas/XiqUpdateDeviceLevelSsidStatus' required: true responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /devices/{id}/alarms: get: tags: - Device summary: List alarms for a device description: List alarms for a specific device. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_device_alarms_for_one_device operationId: listDeviceAlarm parameters: - $ref: '#/components/parameters/id' - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/startTime' - $ref: '#/components/parameters/endTime' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PagedXiqDeviceAlarm' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /devices/{id}/history/cpu-mem: get: tags: - Device summary: Get device CPU/memory usage history description: Get average device CPU and memory usage history. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_device_cpu_and_memory_usage_for_one_device operationId: getDeviceCpuMemoryHistory parameters: - $ref: '#/components/parameters/id' - $ref: '#/components/parameters/startTime' - $ref: '#/components/parameters/endTime' - name: interval in: query description: The aggregate interval in milliseconds required: true schema: type: integer format: int64 responses: '200': description: OK content: application/json: schema: type: array items: $ref: '#/components/schemas/XiqDeviceCpuMemoryUsage' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /devices/{id}/ibeacon: get: tags: - Device summary: Get the device iBeacon setting description: Get the device iBeacon setting by device ID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_device_ibeacon operationId: getDeviceIbeacon parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqDeviceIbeacon' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /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: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqDeviceIot' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /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: - $ref: '#/components/parameters/id' requestBody: description: The IoT profile ID. content: application/json: schema: type: integer format: int64 required: true responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /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: - $ref: '#/components/parameters/id' responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /devices/digital-twin: get: tags: - Device summary: List Digital Twin product information description: List of Digital Twin product information with pagination. externalDocs: description: API Reference url: http://extremecloudiq.com/api-docs/api-reference.html#_list_digital_twin_products operationId: listDigitalTwinProducts parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/limit' - 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' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /devices/{id}/bounce-port: post: tags: - Device summary: Bounce port of a device 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: - $ref: '#/components/parameters/id' requestBody: content: application/json: schema: $ref: '#/components/schemas/XiqBounceDevicePortRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqBounceDevicePortResponse' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /devices/{id}/monitor/:refresh: post: tags: - Device summary: Monitor refresh device information description: The request monitor refresh the device information. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_monitor_refresh operationId: monitorRefreshDevice parameters: - $ref: '#/components/parameters/id' - name: function in: query description: The function to refresh. ROUTE, MAC required: true schema: $ref: '#/components/schemas/XiqDeviceMonitorRefreshFunction' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqMonitorRefresh' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /devices/{id}/monitor/refresh/status: get: tags: - Device summary: Monitor refresh device information status description: The request monitor refresh the device information status. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_monitor_refresh_status operationId: monitorRefreshDeviceStatus parameters: - $ref: '#/components/parameters/id' - name: taskKey in: query description: Key for the device refresh required: true schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqMonitorRefreshStatus' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /devices/installation-report: get: tags: - Device summary: Get Installation devices description: List the device installation report. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_xiq_device_installation_report operationId: getXiqDeviceInstallationReport parameters: - name: id in: query description: Unique id required: true schema: type: integer items: type: integer format: int64 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqDeviceInstallationReportResponse' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /devices/{id}/thread/commissioner/:start: post: tags: - Device summary: Start the Thread Commissioner description: Start the Thread Commissioner. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_device_thread_commissioner_start operationId: startThreadCommissioner parameters: - $ref: '#/components/parameters/id' requestBody: content: application/json: schema: $ref: '#/components/schemas/XiqThreadStartCommissionerRequest' required: true responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /devices/{id}/thread/commissioner/:stop: post: tags: - Device summary: Stop the Thread Commissioner description: Stop the Thread Commissioner. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_device_thread_commissioner_stop operationId: stopThreadCommissioner parameters: - $ref: '#/components/parameters/id' requestBody: content: application/json: schema: $ref: '#/components/schemas/XiqThreadStopCommissionerRequest' required: true responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /devices/radio-information: get: tags: - Device summary: List radio information description: List radio and BSS information associated to a device. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_list_devices_radio_information operationId: listDevicesRadioInformation parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/deviceIds' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PagedXiqRadioEntity' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /devices/{id}/gallery-image: get: tags: - Device summary: Download device gallery image description: Download the image file from the device media gallery. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_download_device_gallery_image operationId: downloadDeviceGalleryImage parameters: - $ref: '#/components/parameters/id' - name: imageName in: query description: The image name required: true schema: type: string responses: '200': description: OK content: application/octet-stream: schema: format: binary type: string default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /devices/{id}/client-monitor: get: tags: - Device summary: Get client monitor setting of a device description: Get the device-specific client monitor setting that override SSID's client monitor profile. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_client_monitor_setting_for_one_device operationId: getDeviceClientMonitor parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqDeviceClientMonitor' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] put: tags: - Device summary: Configure client monitor setting of a device description: Configure the device-specific client monitor setting that override SSID's client monitor profile. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_configure_client_monitor_setting_for_one_device operationId: configureDeviceClientMonitor parameters: - $ref: '#/components/parameters/id' requestBody: content: application/json: schema: $ref: '#/components/schemas/XiqDeviceClientMonitor' required: true responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] delete: tags: - Device summary: Delete client monitor setting for a device description: Delete the device-specific client monitor setting that override SSID's client monitor profile. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_delete_client_monitor_setting_for_one_device operationId: deleteDeviceClientMonitor parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /devices/{id}/ftm-settings: get: tags: - Device summary: Get FTM Settings by device ID description: Get FTM Settings for the specified device ID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_ftm_settings_by_device_id operationId: getFtmSettings parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqFtmSettings' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] put: tags: - Device summary: Configure (create / update) device FTM Settings description: Configure (create / update) device FTM Settings. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_configure_ftm_settings operationId: configureFtmSettings parameters: - $ref: '#/components/parameters/id' 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' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] delete: tags: - Device summary: Delete FTM Settings by device ID description: Delete FTM Settings by device ID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_delete_ftm_settings operationId: deleteFtmSettings parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /devices/{id}/radio-operating-mode: get: tags: - Device summary: Get device radio operating modes description: Get the device radio operating mode by device ID at device level. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_device_radio_operating_mode operationId: getDeviceRadioOperatingMode parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqDeviceRadioOperatingMode' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] put: tags: - Device summary: Configure radio operating mode of a device description: Configure the device-specific radio operating mode setting at device level and set the radio profiles to the default radio profiles.
If the radio profile ID is not provided for a wifi interface in the request, the default Radio Profile will be added to device. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_configure_radio_operating_mode_device operationId: configureDeviceRadioOperatingMode parameters: - $ref: '#/components/parameters/id' requestBody: content: application/json: schema: $ref: '#/components/schemas/XiqConfigureRadioOperatingModeRequest' examples: Configure_AP5020_radio_operating_mode: summary: Configure radio operating mode for AP5020 device and set custom radio profiles for each wifi interface. value: radio_operating_mode: SERVICE_2_5_6 wireless_interfaces: - name: WIFI0 radio_profile_id: 1000 - name: WIFI1 radio_profile_id: 2000 - name: WIFI2 radio_profile_id: 3000 required: true responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /devices/status: get: tags: - Device summary: Get the status of devices (online/offline) description: Get the connection status of the devices. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_devices_status operationId: getDeviceStatus parameters: - $ref: '#/components/parameters/startTime' - $ref: '#/components/parameters/endTime' - name: locationId in: query description: The location ID required: true schema: type: integer format: int64 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqDeviceStatus' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /devices/rm-devices-connection-status: post: tags: - Device summary: Get Device connection status description: Returns the count of total devices, offline devices, online devices for both wired and wireless devices based on the provided siteIds filters. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_device_connection_status operationId: rmDeviceConnectionStatus parameters: - name: deviceCategory in: query description: The device category - wired, wireless (Defaults to "ALL" if not selected) required: false schema: type: string enum: - WIRED - WIRELESS - TPME - name: deviceTypes in: query description: The device types to return (REAL by default) required: false schema: type: array items: $ref: '#/components/schemas/XiqAhDeviceSimulatedType' - name: includeUnassigned in: query description: To include unassigned location required: false schema: type: boolean requestBody: required: false content: application/json: schema: type: object properties: site_ids: description: List of site IDs to filter the counts type: array items: type: integer format: int64 responses: '200': description: Returns the counts of various device connection status count based on the filters content: application/json: schema: $ref: '#/components/schemas/RmDeviceConnectionStatusResponse' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /devices/rm-devices-page: post: tags: - Device summary: '[LRO] List RM Devices Page' description: List RM Devices Page with filters and pagination. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_rm_device_list operationId: listRmDevicesPage parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/limit' - 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: configMismatch in: query description: Config audit status(MATCHED(false) or UNMATCHED(true)) 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 (Defaults to "ALL" if not selected) required: false schema: type: string enum: - WIRED - WIRELESS - TPME - name: deviceTypes in: query description: The device types to return required: false schema: type: array items: $ref: '#/components/schemas/XiqAhDeviceSimulatedType' - name: stackedView in: query description: Whether to include only virtual stack (when set to true) or also the stack members (when set to false) required: false schema: type: boolean - name: sortField in: query description: The sort field required: false schema: $ref: '#/components/schemas/RmDeviceSortField' - $ref: '#/components/parameters/order' - $ref: '#/components/parameters/async' - name: includeUnassigned in: query description: To include unassigned location required: false schema: type: boolean requestBody: content: application/json: schema: type: object properties: site_ids: description: List of site IDs to filter the device list type: array items: type: integer format: int64 sns: description: The device serial numbers to filter type: array items: type: string hostnames: description: The device host names to filter type: array items: type: string mac_addresses: description: The device mac addresses to filter type: array items: type: string default_gateway_ips: description: The device default gateways to filter type: array items: type: string product_types: description: The device product types to filter type: array items: type: string firmware_versions: description: The software version of the devices type: array items: type: string country_codes: description: The country codes of the devices type: array items: type: integer managed_by: description: The entities managing the devices type: array items: type: string network_policies: description: The device network policies to filter type: array items: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PagedRmXiqDevice' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /devices/rm-devices-metadata: post: tags: - Device summary: Get Metadata Information for given Device description: Get metadata info for RM Device Page with site ID filter. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_rm_device_metadata operationId: getRmDeviceMetadata parameters: - name: deviceCategory in: query description: The device category - wired, wireless (Defaults to "ALL" if not selected) required: false schema: type: string enum: - WIRED - WIRELESS - name: adminStates in: query description: The device admin states 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/XiqAhDeviceSimulatedType' - name: includeUnassigned in: query description: To include unassigned location required: false schema: type: boolean requestBody: required: false content: application/json: schema: type: object properties: site_ids: description: List of site IDs to filter the RM Device Metadata type: array items: type: integer format: int64 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/RmDeviceMetadataResponse' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /devices/rm-devices-stack/{stackId}: get: tags: - Device summary: Get Stack Member Info for given Stack description: Get Stack Member Information for given stack ID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_rm_device_stack_info operationId: getRmDeviceStackInfo 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/RmDeviceStackInfoResponse' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /devices/rm-devices-page/export: post: tags: - Device summary: '[LRO] Export RM devices page' description: Export RM devices page as a csv file. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_export_rm_devices_page operationId: exportRmDeviceToCsv 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: configMismatch in: query description: Config audit status(MATCHED(false) or UNMATCHED(true)) 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 (Defaults to "ALL" if not selected) required: false schema: type: string enum: - WIRED - WIRELESS - name: deviceTypes in: query description: The device types to return required: false schema: type: array items: $ref: '#/components/schemas/XiqAhDeviceSimulatedType' - name: sortField in: query description: The sort field required: false schema: $ref: '#/components/schemas/RmDeviceSortField' - $ref: '#/components/parameters/order' - $ref: '#/components/parameters/async' - name: includeUnassigned in: query description: To include unassigned location required: false schema: type: boolean requestBody: content: application/json: schema: type: object properties: site_ids: description: List of site IDs to filter the device list type: array items: type: integer format: int64 sns: description: The device serial numbers to filter type: array items: type: string hostnames: description: The device host names to filter type: array items: type: string mac_addresses: description: The device mac addresses to filter type: array items: type: string default_gateway_ips: description: The device default gateways to filter type: array items: type: string product_types: description: The device product types to filter type: array items: type: string firmware_versions: description: The software version of the devices type: array items: type: string country_codes: description: The country codes of the devices type: array items: type: integer managed_by: description: The entities managing the devices type: array items: type: string network_policies: description: The device network policies to filter type: array items: type: string responses: '202': description: Accepted - The request has been accepted for processing, but the processing has not been completed. headers: cache-control: description: Cache control directives schema: type: string content-length: description: The length of the response body in octets (8-bit bytes) schema: type: integer date: description: The date and time at which the message was originated schema: type: string format: date-time expires: description: The date/time after which the response is considered stale schema: type: string location: description: The URL to which the client should navigate to check the status of the request schema: type: string format: uri pragma: description: Implementation-specific directives that might apply to any recipient along the request-response chain schema: type: string ratelimit-limit: description: The maximum number of requests that the client is allowed to make in a given time period schema: type: string ratelimit-remaining: description: The number of requests remaining in the current rate limit window schema: type: integer retry-after: description: The amount of time to wait before making a follow-up request schema: type: integer server: description: A name for the server schema: type: string example: nginx x-content-type-options: description: Prevents the browser from interpreting files as a different MIME type schema: type: string x-xss-protection: description: Enables cross-site scripting (XSS) filter schema: type: string default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /devices/reports/{id}: get: tags: - Device summary: Download the Export CSV file for Device Status description: Returns the CSV File of the device status based on the provided filters. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_device_status_grid operationId: deviceStatusGridExport parameters: - name: id in: path description: The report ID required: true schema: type: string responses: '200': description: Returns the CSV File of the device status grid content: application/octet-stream: schema: type: string format: byte default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /devices/actions-support-metadata: post: tags: - Device summary: Get metadata for supported device actions description: Retrieve metadata information about supported device actions for a given product type. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_device_action_metadata operationId: getDeviceActionMetadata parameters: - name: deviceActions in: query description: List of device actions to retrieve metadata info required: false schema: type: array items: $ref: '#/components/schemas/RmDeviceActionEnum' requestBody: required: false content: application/json: schema: type: object properties: product_types: type: array description: Product types filter to retrieve metadata for items: type: string responses: '200': description: Device Action Metadata response content: application/json: schema: type: object properties: action_supported_metadata: type: array items: type: object properties: device_action: $ref: '#/components/schemas/RmDeviceActionEnum' supported_product_types: type: array items: type: string default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /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 requestBody: content: application/json: schema: type: object properties: device_ids: type: array items: type: integer format: int64 description: List of device IDs to filter active SSH sessions required: true responses: '200': description: OK content: application/json: schema: type: array items: $ref: '#/components/schemas/XiqDevicesSshActiveSessions' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /devices/thread/commissioner/start: post: tags: - Device summary: Start the Thread Commissioner by Building IDs description: Start the Thread Commissioner by Building IDs. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_device_thread_start_commissioner_bybuildings operationId: startThreadCommissionerByBuildings parameters: - $ref: '#/components/parameters/ownerId' requestBody: content: application/json: schema: $ref: '#/components/schemas/XiqThreadStartCommissionerByBuildingsRequest' required: true responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /devices/thread/commissioner/stop: post: tags: - Device summary: Stop the Thread Commissioner by Building IDs description: Stop the Thread Commissioner by Building IDs. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_device_thread_stop_commissioner_bybuildings operationId: stopThreadCommissionerByBuildings parameters: - $ref: '#/components/parameters/ownerId' requestBody: content: application/json: schema: $ref: '#/components/schemas/XiqThreadStopCommissionerByBuildingsRequest' required: true responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /network-policies: get: tags: - Network Policy summary: List network policies description: List a page of network policies. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_list_network_policies operationId: listNetworkPolices parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/limit' - name: policyNames in: query description: The list of policy names required: false schema: type: array items: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PagedXiqNetworkPolicy' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] post: tags: - Network Policy summary: Create network policy description: Create a new network policy. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_create_network_policy operationId: createNetworkPolicy requestBody: description: The body of create network policy API content: application/json: schema: $ref: '#/components/schemas/XiqCreateNetworkPolicyRequest' required: true responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/XiqNetworkPolicy' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /network-policies/{id}: get: tags: - Network Policy summary: Get the network policy description: Get an existing network policy by ID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_network_policy operationId: getNetworkPolicy parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqNetworkPolicy' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] put: tags: - Network Policy summary: Update the network policy description: Update network policy by ID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_update_network_policy operationId: updateNetworkPolicy parameters: - $ref: '#/components/parameters/id' 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' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] delete: tags: - Network Policy summary: Delete the network policy description: Delete an existing network policy by ID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_delete_network_policy operationId: deleteNetworkPolicy parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /network-policies/{id}/ssids: get: tags: - Network Policy summary: List SSIDs for a network policy description: List a page of SSIDs for a specific network policy. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_list_ssid_list_for_the_network_policy operationId: listSsidsByNetworkPolicy parameters: - $ref: '#/components/parameters/id' - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/limit' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PagedXiqSsid' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /network-policies/{id}/ssids/:add: post: tags: - Network Policy summary: Add SSIDs to a network policy description: Add SSIDs to a specific network policy. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_adding_multiple_ssids_to_the_network_policy operationId: addSsidsToNetworkPolicy parameters: - $ref: '#/components/parameters/id' 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 default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /network-policies/{id}/ssids/:remove: post: tags: - Network Policy summary: Removes SSIDs from the network policy description: Removing multiple SSIDs from the network policy. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_removing_multiple_ssids_from_the_network_policy operationId: deleteSsidsFromNetworkPolicy parameters: - $ref: '#/components/parameters/id' 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 default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /network-scorecard/locations/{id}/device-health: get: tags: - Network Scorecard summary: Get device's overall health for given location operationId: getDeviceHealth description: Get the device's overall health details for given location. parameters: - $ref: '#/components/parameters/id' - $ref: '#/components/parameters/startTime' - $ref: '#/components/parameters/endTime' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/DeviceOverallHealth' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /network-scorecard/locations/{id}/client-health: get: tags: - Network Scorecard summary: Get clients' overall health for given location operationId: getClientHealth description: Get the clients' overall health details for given location. parameters: - $ref: '#/components/parameters/id' - $ref: '#/components/parameters/startTime' - $ref: '#/components/parameters/endTime' - 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/ClientOverallHealth' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /network-scorecard/locations/{id}/wifi-health: get: tags: - Network Scorecard summary: Get devices' Wi-Fi health for given location operationId: getWifiHealth description: Get the devices' Wi-Fi health details for given location. parameters: - $ref: '#/components/parameters/id' - $ref: '#/components/parameters/startTime' - $ref: '#/components/parameters/endTime' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/WiFiOverallHealth' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /network-scorecard/locations/{id}/network-health: get: tags: - Network Scorecard summary: Get devices' network health for given location operationId: getNetworkHealth description: Get the devices' network health details for given location. parameters: - $ref: '#/components/parameters/id' - $ref: '#/components/parameters/startTime' - $ref: '#/components/parameters/endTime' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/NetworkOverallHealth' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /network-scorecard/locations/{id}/services-health: get: tags: - Network Scorecard summary: Get devices' services health for given location operationId: getServicesHealth description: Get the devices' services health details for given location. parameters: - $ref: '#/components/parameters/id' - $ref: '#/components/parameters/startTime' - $ref: '#/components/parameters/endTime' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ServicesOverallHealth' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /clients/active: get: tags: - Client summary: List active clients description: List active clients with filters and pagination. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_list_active_clients operationId: getActiveClients parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/views' - $ref: '#/components/parameters/locationIds' - $ref: '#/components/parameters/deviceIds' - 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 - name: clientHealthStatus in: query description: The client health status - 1 - HEALTHY, 2 - POOR required: false schema: type: integer - name: excludeLocallyManaged in: query description: Return Cloud managed Devices' clients. Default value - false required: false schema: type: boolean - name: userNames in: query description: The user names. required: false schema: type: array items: type: string - name: searchString in: query description: The SearchString required: false schema: type: string - name: sortField in: query description: Sort field. Available values - 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 required: false schema: type: string - name: sortOrder in: query description: Sort order (ascending by default). Available values - ASC, DESC required: false schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PagedXiqClient' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /clients/summary: get: tags: - Client summary: Get client summary metrics description: Get number of connected wireless clients and number of detected wired clients. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_client_summary operationId: getClientSummary parameters: - $ref: '#/components/parameters/locationIds' - $ref: '#/components/parameters/deviceIds' - 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 - name: excludeLocallyManaged in: query description: Return Cloud managed Devices' clients. Default value - false required: false schema: type: boolean - name: searchString in: query description: The SearchString required: false schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqClientSummary' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /clients/usage: get: tags: - Client summary: Get usage per client externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_client_usage operationId: getClientUsage description: Get the client usage. parameters: - name: clientIds in: query description: The client IDs required: true schema: type: array items: type: integer format: int64 - $ref: '#/components/parameters/startTime' - $ref: '#/components/parameters/endTime' responses: '200': description: OK content: application/json: schema: type: array items: $ref: '#/components/schemas/XiqClientUsage' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /clients/{id}: get: tags: - Client summary: Get client info externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_client_details operationId: getClient description: Get client detailed information. parameters: - $ref: '#/components/parameters/id' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/views' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqClient' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /clients/alias: put: tags: - Client summary: Set the aliases for multiple clients externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_set_aliases_for_multiple_clients operationId: setClientsAliases description: Bulk update the aliases for multiple clients based on the mac addresses. Empty or null alias value deletes the previous client alias. requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/XiqClientMacAddressAlias' required: true responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /clients/active/count: get: tags: - Client summary: Get active clients count description: List active clients count. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_count_of_active_clients operationId: getActiveClientsCount parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/views' - $ref: '#/components/parameters/locationIds' - $ref: '#/components/parameters/deviceIds' - 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 - name: clientHealthStatus in: query description: The client health status - 1 - HEALTHY, 2 - POOR required: false schema: type: integer - name: excludeLocallyManaged in: query description: Return Cloud managed Devices' clients. Default value - false required: false schema: type: boolean - name: searchString in: query description: The SearchString required: false schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/GetActiveClientsResponse' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /clients/byMac/{clientMac}: delete: tags: - Client summary: Disconnect the client externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_delete_client_by_macaddress operationId: disconnectClient description: Disconnect the client. parameters: - $ref: '#/components/parameters/mac' responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /clients/getByMac/{clientMac}: get: tags: - Client summary: Get client info by mac externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_client_details_for_one_client operationId: getClientByMac description: Get detailed client information by mac. parameters: - $ref: '#/components/parameters/mac' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/views' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqClient' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /clients/disconnect: post: tags: - Client summary: Disconnect clients description: Disconnect one or more clients by their MAC addresses. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_delete_client_by_macaddress operationId: disconnect_clients requestBody: required: true content: application/json: schema: type: object properties: mac_addresses: type: array description: List of client MAC addresses to disconnect items: type: string format: mac responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /applications: get: tags: - Application summary: List the applications description: List a page of applications by filter. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_list_the_applications operationId: listApplications parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/limit' - name: sortField in: query description: The sort field required: false schema: $ref: '#/components/schemas/XiqApplicationSortField' - $ref: '#/components/parameters/order' - 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 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PagedXiqApplication' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /applications/top{n}: get: tags: - Application summary: List the TopN applications description: List the TopN applications by usage. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_list_top_n_applications_usage operationId: listTopApplicationsUsage parameters: - $ref: '#/components/parameters/n' - $ref: '#/components/parameters/startTime' - $ref: '#/components/parameters/endTime' responses: '200': description: OK content: application/json: schema: type: array items: $ref: '#/components/schemas/XiqTopApplicationsUsage' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /applications/{id}/clients/top{n}: get: tags: - Application summary: List the TopN clients for a application description: List the TopN clients by usage for a specific application. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_list_top_n_clients_usage_for_one_application operationId: listApplicationTopClientsUsage parameters: - $ref: '#/components/parameters/id' - $ref: '#/components/parameters/n' - $ref: '#/components/parameters/startTime' - $ref: '#/components/parameters/endTime' responses: '200': description: OK content: application/json: schema: type: array items: $ref: '#/components/schemas/XiqApplicationTopClientsUsage' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /applications/grid: post: tags: - Application summary: List application usage summary description: Returns a paginated list of application usage summaries with support for search, filter, and sort. operationId: listApplicationUsageSummary parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/limit' - name: sort_field in: query description: Field to sort by (e.g., usage, percentage_usage, clients, users) required: false schema: type: string enum: - usage - percentage_usage - clients - users - application_name - category_name - $ref: '#/components/parameters/order' - $ref: '#/components/parameters/async' - name: search in: query description: Search term for application or category name required: false schema: type: string requestBody: description: Filters for category and number-based columns required: false content: application/json: schema: type: object properties: category_name: type: array items: type: string description: Filter by one or more category (application group) names application_name: type: array items: type: string description: Filter by one or more application names site_ids: description: List of site IDs to filter the applications grid type: array items: type: integer format: int64 number_filters: type: array description: | The number-based column filters available. Available columns: usage, percentageUsage, clients, users. items: $ref: '#/components/schemas/number_filter' responses: '200': description: A paginated list of application usage summaries content: application/json: schema: $ref: '#/components/schemas/PagedAppUsageSummary' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /applications/category_metadata: get: tags: - Application summary: List application categories and names description: Returns a list of unique application category names along with associated application names used in application usage data. operationId: listApplicationCategoriesAndNames responses: '200': description: Lists of application categories and application names content: application/json: schema: type: object properties: categories: type: array items: type: string description: Application category name applicationNames: type: array items: type: string description: Application name default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /applications/grid/export: post: tags: - Application summary: Export application usage summary description: Export the application usage summary grid as a CSV file. operationId: export_application_usage_to_csv parameters: - name: search in: query description: Search term for application or category name required: false schema: type: string - name: sort_field in: query description: Field to sort by (e.g., usage, percentage_usage, clients, users) required: false schema: type: string enum: - usage - percentage_usage - clients - users - $ref: '#/components/parameters/order' - $ref: '#/components/parameters/async' requestBody: content: application/json: schema: type: object properties: category_name: type: array items: type: string description: Filter by one or more category (application group) names application_name: type: array items: type: string description: Filter by one or more application names site_ids: description: List of site IDs to filter the applications grid type: array items: type: integer format: int64 number_filters: type: array description: | The number-based column filters available. Available columns: usage, percentage_usage, clients, users. items: $ref: '#/components/schemas/number_filter' responses: '202': description: Accepted - The request has been accepted for processing, but the processing has not been completed. headers: location: description: The URL to check the status or download the exported file schema: type: string format: uri retry-after: description: Time in seconds to wait before polling the status schema: type: integer default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /alerts: get: tags: - Alert summary: List the alerts description: List a page of alerts by filter. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_list_the_alerts operationId: listAlerts parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/startTime' - $ref: '#/components/parameters/endTime' - $ref: '#/components/parameters/acknowledged' - $ref: '#/components/parameters/categoryIds' - $ref: '#/components/parameters/severityIds' - $ref: '#/components/parameters/messageMetadataIds' - $ref: '#/components/parameters/siteId' - name: sortField in: query description: The sort field required: false schema: $ref: '#/components/schemas/XiqAlertSortField' - $ref: '#/components/parameters/order' - name: keyword in: query description: The keyword to filter, such as summery, severity, source and etc. required: false schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PagedXiqAlert' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /alerts/:acknowledge: post: tags: - Alert summary: Acknowledge the alerts description: Acknowledge the alerts by ID list. 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/alertIds' responses: '200': description: OK content: application/json: schema: type: array description: The data in the current page items: $ref: '#/components/schemas/XiqAlert' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /alerts/count-by-{group}: get: tags: - Alert summary: Count the alerts by different grouping description: Count the number of alerts and events based on Severity, Category, and Alert Type. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_count_the_alerts_by_group operationId: countAlertsByGroup parameters: - $ref: '#/components/parameters/startTime' - $ref: '#/components/parameters/endTime' - $ref: '#/components/parameters/group' - $ref: '#/components/parameters/acknowledged' - $ref: '#/components/parameters/siteId' responses: '200': description: OK content: application/json: schema: type: array items: $ref: '#/components/schemas/XiqAlertGroupCount' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /alerts/reports: post: tags: - Alert summary: '[LRO] Create alert event report' description: Creates a report page of alert event. 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#_create_an_alert_report operationId: createAlertReport parameters: - $ref: '#/components/parameters/startTime' - $ref: '#/components/parameters/endTime' - $ref: '#/components/parameters/acknowledged' - $ref: '#/components/parameters/categoryIds' - $ref: '#/components/parameters/severityIds' - $ref: '#/components/parameters/messageMetadataIds' - name: siteId in: query description: The site to filter, return global data if not specified 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: sortField in: query description: The sort field required: false schema: $ref: '#/components/schemas/XiqAlertSortField' - $ref: '#/components/parameters/order' - name: keyword in: query description: The keyword to filter, such as summery, severity, source and etc. required: false schema: type: string - $ref: '#/components/parameters/async' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqAlertReport' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /alerts/reports/{id}: get: tags: - Alert summary: Download an alert event report description: Download report of alert event . 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/octet-stream: schema: type: string format: byte default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /alert-subscriptions/emails: get: tags: - Alert summary: List email subscriptions description: List all email subscriptions. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_list_alert_email_subscriptions operationId: listEmailSubscriptions responses: '200': description: OK content: application/json: schema: type: array items: $ref: '#/components/schemas/XiqAlertEmailSubscription' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] post: tags: - Alert summary: Create email subscription description: Create email subscription. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_create_subscription_email operationId: createEmailSubscription requestBody: description: The payload of create email subscription. content: application/json: schema: $ref: '#/components/schemas/XiqCreateAlertEmailSubscriptionRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqAlertEmailSubscription' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /alert-subscriptions/emails/:delete: post: tags: - Alert summary: '[LRO] Delete alert subscription email in bulk' description: Delete alert subscription email by a list of IDs.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#_bulk_delete_alert_email_subscriptions operationId: deleteBulkAertSubscriptionEmail requestBody: content: application/json: schema: $ref: '#/components/schemas/subscriptionIds' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqDeleteBulkAlertSubscriptionEmailResponse' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /alert-subscriptions/emails/{id}: get: tags: - Alert summary: Get email subscription info for a specific email description: Get email subscription info for a specific email. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_an_alert_email_subscription operationId: getEmailSubscription parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqAlertEmailSubscription' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] put: tags: - Alert summary: Update email subscription description: Update email subscription. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_update_an_alert_email_subscription operationId: updateEmailSubscription parameters: - $ref: '#/components/parameters/id' requestBody: description: The payload of update email subscription. content: application/json: schema: $ref: '#/components/schemas/XiqUpdateAlertEmailSubscriptionRequest' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqAlertEmailSubscription' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] delete: tags: - Alert summary: Delete email subscription description: Delete an exist email subscription. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_delete_an_alert_email_subscription operationId: deleteEmailSubscription parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /alert-subscriptions/emails/{id}/:verify: post: tags: - Alert summary: External email address verification description: User sends a verification email to the specified email address to verify, by clicking the verify link/button in the email. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_verify_an_alert_email_subscription operationId: verifySubscriptionEmail parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /alert-subscriptions/webhooks: get: tags: - Alert summary: List webhook subscriptions description: List webhook subscriptions. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_list_alert_webhook_subscriptions operationId: listWebhookSubscriptions responses: '200': description: OK content: application/json: schema: type: array items: $ref: '#/components/schemas/XiqAlertWebhookSubscription' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] post: tags: - Alert summary: Create webhook subscription description: Create webhook subscription. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_create_an_alert_webhook_subscription operationId: createWebhookSubscription requestBody: description: The payload of create webhook subscription. content: application/json: schema: $ref: '#/components/schemas/XiqCreateAlertWebhookSubscriptionRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqAlertWebhookSubscription' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /alert-subscriptions/webhooks/:delete: post: tags: - Alert summary: '[LRO] Delete alert subscription webhook in bulk' description: Delete alert subscription webhook by a list of IDs.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#_bulk_delete_alert_webhook_subscriptions operationId: deleteBulkAertSubscriptionWebhook requestBody: content: application/json: schema: $ref: '#/components/schemas/subscriptionIds' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqDeleteBulkAlertSubscriptionWebhookResponse' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /alert-subscriptions/webhooks/{id}: get: tags: - Alert summary: Get webhook subscription info for a specific url description: Get webhook subscription info for a specific url. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_an_alert_webhook_subscription operationId: getWebhookSubscription parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqAlertWebhookSubscription' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] put: tags: - Alert summary: Update webhook subscription description: Update webhook subscription. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_update_an_alert_webhook_subscription operationId: updateWebhookSubscription parameters: - $ref: '#/components/parameters/id' requestBody: description: The payload of update webhook subscription. content: application/json: schema: $ref: '#/components/schemas/XiqUpdateAlertWebhookSubscriptionRequest' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqAlertWebhookSubscription' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] delete: tags: - Alert summary: Delete webhook subscription description: Delete an exist webhook subscription. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_delete_an_alert_webhook_subscription operationId: deleteWebhookSubscription parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /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_subscription operationId: listServiceNowSubscriptions responses: '200': description: OK content: application/json: schema: type: array items: $ref: '#/components/schemas/XiqAlertServiceNowSubscription' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] 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: description: The payload of create ServiceNow subscription. content: application/json: schema: $ref: '#/components/schemas/XiqCreateAlertServiceNowSubscriptionRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqAlertServiceNowSubscription' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /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_an_alert_servicenow_subscription operationId: deleteBulkAlertSubscriptionServiceNow requestBody: content: application/json: schema: $ref: '#/components/schemas/subscriptionIds' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqDeleteBulkAlertSubscriptionServiceNowResponse' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /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: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqAlertServiceNowSubscription' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] 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: - $ref: '#/components/parameters/id' requestBody: description: The payload of update ServiceNow subscription. content: application/json: schema: $ref: '#/components/schemas/XiqUpdateAlertServiceNowSubscriptionRequest' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqAlertServiceNowSubscription' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] 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_alert_serviceNow_subscription operationId: patchServiceNowSubscription parameters: - $ref: '#/components/parameters/id' requestBody: description: The payload of ServiceNow subscription. content: application/json: schema: $ref: '#/components/schemas/XiqPatchAlertServiceNowSubscriptionRequest' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqAlertServiceNowSubscription' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] delete: tags: - Alert summary: Delete ServiceNow subscription description: Delete an exist ServiceNow subscription. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_delete_an_alert_ServiceNow_subscription operationId: deleteServiceNowSubscription parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /alert-policies: get: tags: - Alert summary: List all alert policies description: Get a list of all alert policies belonging to the current user and an overview 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 security: - BearerAuth: [] 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: type: object description: The alert policies belonging to this user. properties: global_policy: description: The global policy. Empty when includeGlobal is false. $ref: '#/components/schemas/XiqAlertPolicy' site_policies: type: array description: A list of site policies. items: $ref: '#/components/schemas/XiqAlertPolicy' default: $ref: '#/components/responses/ErrorResponse' 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 security: - BearerAuth: [] requestBody: description: The body of create site policy API content: application/json: schema: $ref: '#/components/schemas/XiqCreateAlertPolicyRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqAlertPolicy' description: The newly created alert policy. default: $ref: '#/components/responses/ErrorResponse' /alert-policies/{policyId}: 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 security: - BearerAuth: [] parameters: - $ref: '#/components/parameters/policyId' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqAlertPolicy' default: $ref: '#/components/responses/ErrorResponse' put: tags: - Alert summary: Update a site-based alert policy description: Modify a site-based alert policy's details, including the policy name and sites. The global policy cannot be updated. The sites can be obtained from the alerts/sites API. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_update_an_alert_policy operationId: updateAlertPolicy security: - BearerAuth: [] parameters: - $ref: '#/components/parameters/policyId' requestBody: description: The body of update alert site policy API content: application/json: schema: $ref: '#/components/schemas/XiqUpdateAlertPolicyRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqAlertPolicy' description: The newly created alert policy. default: $ref: '#/components/responses/ErrorResponse' delete: tags: - Alert summary: Delete a site-based alert policy description: Delete an alert policy. All the associated alert rules will be deleted as well. The global policy cannot be deleted. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_delete_an_alert_policy operationId: deleteAlertPolicy security: - BearerAuth: [] parameters: - $ref: '#/components/parameters/policyId' responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' /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 alert policy, 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' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /alert-policies/{policyId}/rules/{ruleId}: get: tags: - Alert summary: Get details of an alert rule description: Get the full details of an alert rule's state. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_an_alert_rule operationId: getAlertRule security: - BearerAuth: [] parameters: - $ref: '#/components/parameters/policyId' - $ref: '#/components/parameters/ruleId' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqAlertRule' default: $ref: '#/components/responses/ErrorResponse' put: tags: - Alert summary: Update an alert rule description: Update the state of an alert rule. The rule's identifier may change as a result of this operation. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_update_an_alert_rule operationId: updateAlertRule security: - BearerAuth: [] parameters: - $ref: '#/components/parameters/policyId' - $ref: '#/components/parameters/ruleId' requestBody: description: The body of update alert rule API content: application/json: schema: $ref: '#/components/schemas/XiqUpdateAlertRuleRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqAlertRule' default: $ref: '#/components/responses/ErrorResponse' /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. The rule's identifier may change as a result of this operation. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_enable_an_alert_rule operationId: enableAlertRule security: - BearerAuth: [] parameters: - $ref: '#/components/parameters/policyId' - $ref: '#/components/parameters/ruleId' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqAlertRule' description: The updated alert rule status. default: $ref: '#/components/responses/ErrorResponse' /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. The rule's identifier may change as a result of this operation. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_disable_an_alert_rule operationId: disableAlertRule security: - BearerAuth: [] parameters: - $ref: '#/components/parameters/policyId' - $ref: '#/components/parameters/ruleId' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqAlertRule' description: The updated alert rule status. default: $ref: '#/components/responses/ErrorResponse' /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: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/startTime' - 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: 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 - name: sortField in: query description: The field for sorting required: false schema: $ref: '#/components/schemas/XiqAuditLogSortField' - $ref: '#/components/parameters/order' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PagedXiqAuditLog' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /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: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqAuditLogFullDescriptions' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /logs/audit/reports: post: tags: - Log summary: 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: createAuditLogReport parameters: - 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: sortField in: query description: The field for sorting required: false schema: $ref: '#/components/schemas/XiqAuditLogSortField' - $ref: '#/components/parameters/order' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqAuditLogReport' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /logs/audit/reports/{id}: get: tags: - Log summary: Download audit logs description: Download report of audit logs. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_audit_log_download operationId: downloadAuditLogs parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/octet-stream: schema: type: string format: byte default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /logs/sms: get: tags: - Log summary: List SMS logs description: List a page of SMS logs. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_list_sms_log operationId: listSmsLogs parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/limit' - 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' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /logs/email: get: tags: - Log summary: List Email logs description: List a page of Email logs. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_list_email_log operationId: listEmailLogs parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/limit' - 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' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /logs/auth: get: tags: - Log summary: List auth logs description: List a page of auth logs. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_list_authentication_log operationId: listAuthLogs parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/limit' - 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' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /logs/credential: get: tags: - Log summary: List credential logs description: List a page of credential logs. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_list_credential_log operationId: listCredentialLogs parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/limit' - 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' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /logs/accounting: get: tags: - Log summary: List accounting logs description: List a page of accounting logs. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_list_accounting_log operationId: listAccountingLogs parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/limit' - 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' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /subscriptions/webhook: get: tags: - Notification summary: List webhook subscriptions description: List all webhook subscriptions. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_list_webhook_subscriptions operationId: list parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/limit' responses: '200': description: OK content: application/json: schema: type: array items: $ref: '#/components/schemas/PagedXiqWebhookSubscription' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] post: tags: - Notification summary: Create webhook subscriptions description: Create multiple webhook subscriptions. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_create_webhook_subscriptions operationId: createSubscriptions requestBody: description: The payload of create multiple webhook subscriptions content: application/json: schema: type: array items: $ref: '#/components/schemas/XiqCreateWebhookSubscriptionRequest' required: true responses: '202': description: Accepted default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /subscriptions/webhook/{id}: delete: tags: - Notification summary: Delete webhook subscription description: Delete an exist webhook subscription. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_delete_webhook_subscriptions operationId: deleteSubscription parameters: - $ref: '#/components/parameters/id' responses: '202': description: Accepted default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] put: tags: - Notification summary: Update webhook subscription by ID description: Update an existing webhook subscription by the specified ID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_update_webhook_subscription operationId: updateSubscription parameters: - $ref: '#/components/parameters/id' requestBody: description: The payload to update webhook subscription content: application/json: schema: $ref: '#/components/schemas/XiqUpdateWebhookSubscriptionRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqWebhookSubscription' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /subscriptions/webhook/export: get: tags: - Notification summary: Export all webhook subscriptions description: Export all webhook subscriptions as a csv file. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_export_webhook_subscriptions operationId: exportToCsv parameters: - name: sortField in: query description: The field for sorting required: false schema: $ref: '#/components/schemas/XiqSortOrder' - name: keyword in: query description: The keyword to filter - user name, email required: false schema: type: string responses: '200': description: OK content: application/octet-stream: schema: type: string format: byte default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /deployments: post: tags: - Configuration - Deployment summary: '[LRO] Push configuration and upgrade firmware' description: Push configuration and upgrade firmware to the target devices. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_push_configuration_and_upgrade_firmware_to_devices operationId: deployConfig parameters: - $ref: '#/components/parameters/async' requestBody: description: The device deploy configuration content: application/json: schema: $ref: '#/components/schemas/XiqDeploymentRequest' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqDeploymentResponse' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] get: tags: - Configuration - Deployment summary: Get list of deployments description: Get firmware upgrade details across multiple sites and devices. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_firmware_upgrade_details operationId: getFirmwareUpgradeDetails parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/limit' responses: '200': description: OK content: application/json: schema: allOf: - $ref: '#/components/schemas/XiqPage' - type: object properties: data: type: array description: The data in the current page items: $ref: '#/components/schemas/XiqDeploymentDetailsResponse' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /deployments/overview: get: tags: - Configuration - Deployment summary: Get configuration deployment overview description: Get configuration deployment status overview. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_configuration_deployment_overview operationId: getDeployOverview responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqDeploymentOverview' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /deployments/status: get: tags: - Configuration - Deployment summary: Get configuration deployment status description: Get configuration deployment status for the target devices. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_configuration_deployment_status operationId: getDeployStatus parameters: - name: deviceIds in: query description: The target device IDs required: true schema: uniqueItems: true type: array items: type: integer format: int64 responses: '200': description: OK content: application/json: schema: type: object additionalProperties: $ref: '#/components/schemas/XiqDeploymentStatus' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /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: description: The device details content: application/json: schema: type: object properties: device_ids: type: array description: The device IDs uniqueItems: true items: type: integer format: int64 product_types: type: array description: The product types items: type: string responses: '200': description: OK content: application/json: schema: type: object properties: firmware_metadatas: type: object description: The compatible firmware metadatas per device additionalProperties: $ref: '#/components/schemas/XiqDeviceFirmwareMetadata' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /deployments/{deploymentId}: put: tags: - Configuration - Deployment summary: Update schedule with deployment ID description: Update firmware upgrade across multiple sites. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_update_firmware_upgrade operationId: updateFirmwareUpgrade parameters: - in: path description: The deployment ID name: deploymentId required: true schema: type: integer format: uint64 requestBody: description: The device deploy configuration update request content: application/json: schema: $ref: '#/components/schemas/XiqDeploymentRequest' responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] get: tags: - Configuration - Deployment summary: Get details of the deployment by deployment ID description: Get firmware upgrade schedule details across sites. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_firmware_upgrade_schedule_details operationId: getFirmwareUpgradeScheduleDetails parameters: - in: path description: The deployment ID name: deploymentId required: true schema: type: integer format: uint64 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqDeploymentDetailsResponse' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] delete: tags: - Configuration - Deployment summary: Delete the deployment schedule by ID description: Delete firmware upgrade schedule. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#delete_firmware_upgrade_schedule operationId: deleteFirmwareUpgradeSchedule parameters: - in: path description: The deployment ID name: deploymentId required: true schema: type: integer format: uint64 responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /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_upgrade_schedule_status operationId: getFirmwareUpgradeScheduleStatus parameters: - in: path description: The deployment ID name: deploymentId required: true schema: type: integer format: uint64 - $ref: '#/components/parameters/async' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqDeploymentScheduleStatusResponse' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /vlan-profiles: get: tags: - Configuration - Basic summary: List VLAN profiles description: Get a page of VLAN profiles. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_list_the_vlan_profiles operationId: listVlanProfiles parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/limit' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PagedXiqVlanProfile' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] post: tags: - Configuration - Basic summary: Create VLAN profile description: Create a new VLAN profile. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_create_vlan_profile_configuration operationId: createVlanProfile requestBody: description: The payload to create new VLAN profile content: application/json: schema: $ref: '#/components/schemas/XiqCreateVlanProfileRequest' required: true responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/XiqVlanProfile' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /vlan-profiles/{id}: get: tags: - Configuration - Basic summary: Get a VLAN profile description: Get a specific VLAN profile by ID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_vlan_profile_by_id operationId: getVlanProfile parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqVlanProfile' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] patch: tags: - Configuration - Basic summary: Update a VLAN profile description: Update a specific VLAN profile. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_update_vlan_profile_configuration operationId: updateVlanProfile parameters: - $ref: '#/components/parameters/id' 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' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] delete: tags: - Configuration - Basic summary: Delete a VLAN profile description: Delete a specific VLAN profile by ID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_delete_vlan_profile_configuration operationId: deleteVlanProfile parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /email-templates: get: tags: - Configuration - User Management summary: List Email templates description: List all Email notification templates. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_list_email_templates operationId: listEmailTemplates parameters: - name: passwordType in: query description: The password type required: false schema: $ref: '#/components/schemas/XiqPasswordType' responses: '200': description: OK content: application/json: schema: type: array items: $ref: '#/components/schemas/XiqEmailTemplate' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /sms-templates: get: tags: - Configuration - User Management summary: List SMS templates description: List all SMS notification templates. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_list_sms_templates operationId: listSmsTemplates parameters: - name: passwordType in: query description: The password type required: false schema: $ref: '#/components/schemas/XiqPasswordType' responses: '200': description: OK content: application/json: schema: type: array items: $ref: '#/components/schemas/XiqSmsTemplate' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /endusers: get: tags: - Configuration - User Management summary: List end users description: List a page of end users. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_list_end_users operationId: listEndUsers parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/limit' - 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' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] post: tags: - Configuration - User Management summary: Create an end user description: Create a new end user. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_create_end_user operationId: createEndUser requestBody: description: Create end user request body content: application/json: schema: $ref: '#/components/schemas/XiqCreateEndUserRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqEndUser' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /endusers/{id}: put: tags: - Configuration - User Management summary: Update an end user description: Update a specific end user. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_update_end_user operationId: updateEndUser parameters: - $ref: '#/components/parameters/id' 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' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] delete: tags: - Configuration - User Management summary: Delete end user by ID description: Delete a specific end user. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_delete_end_user operationId: deleteSsidUser parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /endusers/{id}/:regenerate-password: post: tags: - Configuration - User Management summary: Regenerate a new password for the end user description: Update the end 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: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqRegenerateEndUserPasswordResponse' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /usergroups: get: tags: - Configuration - User Management summary: List user groups description: List a page of user groups. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_list_user_groups operationId: listUserGroups parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/limit' - 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' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] post: tags: - Configuration - User Management summary: Create user group description: Create a new user group. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_create_user_group operationId: createUserGroup requestBody: description: Create user group request body content: application/json: schema: $ref: '#/components/schemas/XiqCreateUserGroupRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqUserGroup' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /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: - $ref: '#/components/parameters/id' 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' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] delete: tags: - Configuration - User Management summary: Delete user group by ID description: Delete the user-group for the specified ID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_delete_user_group operationId: deleteUserGroup parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /pcgs/key-based: get: tags: - Configuration - User Management summary: List Key-based Private Client Groups description: List all Key-based Private Client Groups. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_list_all_key_based_pcg_entries operationId: listKeyBasedPrivateClientGroups responses: '200': description: OK content: application/json: schema: type: array items: $ref: '#/components/schemas/XiqKeyBasedPcg' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] post: tags: - Configuration - User Management summary: ' [LRO] Create a Key-based Private Client Group' description: Setup a Key-based Private Client Group, including network policy, user, user group, SSID, etc. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_initiate_key_based_pcg operationId: setupKeyBasedPrivateClientGroupNetworkPolicy parameters: - $ref: '#/components/parameters/async' requestBody: description: The request to setup Key-based PCG network policy content: application/json: schema: $ref: '#/components/schemas/XiqCreateKeyBasedPcgNetworkPolicyRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqCreateKeyBasedPcgNetworkPolicyResponse' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /pcgs/key-based/network-policy-{policyId}/:onboard: post: tags: - Configuration - User Management summary: ' [LRO] Create Key-based PCG in network policy' description: Create a Key-based Private Client Group for a specific network policy. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_create_key_based_pcg_data operationId: onboardKeyBasedPrivateClientGroup parameters: - name: policyId in: path description: The network policy ID required: true schema: type: integer format: int64 - $ref: '#/components/parameters/async' requestBody: content: application/json: schema: $ref: '#/components/schemas/XiqOnboardKeyBasedPcgRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqOnboardKeyBasedPcgResponse' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /pcgs/key-based/network-policy-{policyId}: delete: tags: - Configuration - User Management summary: Delete Private Client Group from a network policy description: Delete Private Client Group settings from a network policy. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_delete_key_based_pcg operationId: deletePcg parameters: - name: policyId in: path description: The network policy ID required: true schema: type: integer format: int64 - name: ids in: query description: The IDs of the Key-based PCG entity to be deleted from network policy required: true schema: type: array items: type: integer format: int64 responses: '202': description: Accepted default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /pcgs/key-based/network-policy-{policyId}/users: get: tags: - Configuration - User Management summary: Get users for a PCG-enabled network policy description: Get users for a specific PCG-enabled network policy. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_key_based_pcg_users_from_given_network_policy_id operationId: getKeyBasedPcgUsers parameters: - name: policyId in: path description: The network policy ID required: true schema: type: integer format: int64 responses: '200': description: OK content: application/json: schema: type: array items: $ref: '#/components/schemas/XiqKeyBasedPcgUser' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] 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 - $ref: '#/components/parameters/async' 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/XiqAddKeyBasedPcgUsersToNetworkPolicyResponse' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] put: tags: - Configuration - User Management summary: Replace all users in a PCG-enabled network policy description: Replace all users in a specific PCG-enabled network policy. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_replace_all_key_based_pcg_users operationId: updateKeyBasedPcgUsers parameters: - name: policyId in: path description: The network policy ID required: true schema: type: integer format: int64 requestBody: description: The payload of update Key-based PCG users request content: application/json: schema: $ref: '#/components/schemas/XiqUpdateKeyBasedPcgUsersRequest' required: true responses: '202': description: Accepted default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] delete: tags: - Configuration - User Management summary: Delete users from a PCG-enabled network policy description: Delete users from a PCG-enabled network policy. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_delete_key_based_pcg_users operationId: deleteKeyBasedPcgUsers parameters: - name: policyId in: path description: The network policy ID required: true schema: type: integer format: int64 requestBody: description: The payload of delete Key-based PCG users request content: application/json: schema: $ref: '#/components/schemas/XiqDeleteKeyBasedPcgUsersRequest' required: true responses: '202': description: Accepted default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /pcgs/key-based/network-policy-{policyId}/port-assignments: get: tags: - Configuration - User Management summary: Get device port assignments in network policy description: Get port assignments for devices (only support AP150W now) 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' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] post: tags: - Configuration - User Management summary: Assign ports to devices in network policy description: Assign ports for devices (only support AP150W now) in a network policy. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_assign_ports_for_ap150w 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' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /pcgs/key-based/network-policy-{policyId}/keys/:generate: post: tags: - Configuration - User Management summary: Generate shared keys for users in network policy description: Generate/regenerate shared keys for specified users in a specific PCG-enable network policy. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_generate_keys operationId: generateKeys parameters: - name: policyId in: path description: The network policy ID required: true schema: type: integer format: int64 - name: userIds in: query description: The user IDs required: true schema: type: array items: type: integer format: int64 responses: '202': description: Accepted default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /pcgs/key-based/network-policy-{policyId}/keys/:email: post: tags: - Configuration - User Management summary: Send keys to users in network policy via Email description: Send keys to specified users in PCG-enabled network policy via Email. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_email_keys operationId: emailKeys parameters: - name: policyId in: path description: The network policy ID required: true schema: type: integer format: int64 - name: userIds in: query description: The user IDs required: true schema: type: array items: type: integer format: int64 responses: '202': description: Accepted default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /classification-rules: get: tags: - Configuration - Policy summary: List classification rules description: List a page of classification rules. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_list_the_classification_rules operationId: listClassificationRules parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/limit' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PagedXiqClassificationRule' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] post: tags: - Configuration - Policy summary: Create classification rule description: Create a new classification rule. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_create_classification_rule_configuration operationId: createClassificationRule requestBody: description: The payload to create a new classification rule content: application/json: schema: $ref: '#/components/schemas/XiqCreateClassificationRuleRequest' required: true responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/XiqClassificationRule' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /classification-rules/{id}: get: tags: - Configuration - Policy summary: Get a classification rule by ID description: Get a specific classification rule. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_classification_rule_by_id operationId: getClassificationRule parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqClassificationRule' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] put: tags: - Configuration - Policy summary: Update classification rule description: Update the exist classification rule. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_update_classification_rule_configuration operationId: updateClassificationRule parameters: - $ref: '#/components/parameters/id' requestBody: description: The payload to update exist classification rule content: application/json: schema: $ref: '#/components/schemas/XiqUpdateClassificationRuleRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqClassificationRule' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] delete: tags: - Configuration - Policy summary: Delete classification rule by ID description: Delete an existing classification rule by ID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_delete_classification_rule_configuration operationId: deleteClassificationRule parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /l3-address-profiles: get: tags: - Configuration - Policy summary: List L3 address profile description: List all L3 Address Profiles. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_list_the_l3_address_profile operationId: listL3AddressProfiles parameters: - name: addressType in: query description: The address type schema: type: string enum: - L3_ADDRESS_TYPE_UNSPECIFIED - L3_ADDRESS_TYPE_IP_ADDRESS - L3_ADDRESS_TYPE_IP_SUBNET - L3_ADDRESS_TYPE_IP_RANGE - L3_ADDRESS_TYPE_HOST_NAME - L3_ADDRESS_TYPE_WILDCARD_HOST_NAME - L3_ADDRESS_TYPE_WILDCARD - UNRECOGNIZED responses: '200': description: OK content: application/json: schema: type: array items: $ref: '#/components/schemas/XiqL3AddressProfile' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] post: tags: - Configuration - Policy summary: Create L3 address profile description: Create a new L3 address profile. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_create_l3_address_profile operationId: createL3AddressProfile requestBody: description: The payload to create a new L3 address profile. content: application/json: schema: $ref: '#/components/schemas/XiqCreateL3AddressProfileRequest' required: true responses: '201': description: Created content: application/json: schema: oneOf: - $ref: '#/components/schemas/XiqHostNameAddressProfile' - $ref: '#/components/schemas/XiqWildcardHostNameAddressProfile' - $ref: '#/components/schemas/XiqIpAddressProfile' - $ref: '#/components/schemas/XiqIpRangeAddressProfile' - $ref: '#/components/schemas/XiqSubnetAddressProfile' - $ref: '#/components/schemas/XiqWildcardAddressProfile' discriminator: propertyName: addressType default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /l3-address-profiles/{id}: get: tags: - Configuration - Policy summary: Get L3 address profile by ID description: Get an existing L3 address profile by the specified ID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_l3_address_profile_by_id operationId: getL3AddressProfile parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/json: schema: oneOf: - $ref: '#/components/schemas/XiqHostNameAddressProfile' - $ref: '#/components/schemas/XiqWildcardHostNameAddressProfile' - $ref: '#/components/schemas/XiqIpAddressProfile' - $ref: '#/components/schemas/XiqIpRangeAddressProfile' - $ref: '#/components/schemas/XiqSubnetAddressProfile' - $ref: '#/components/schemas/XiqWildcardAddressProfile' discriminator: propertyName: addressType default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] put: tags: - Configuration - Policy summary: Update L3 address profile by ID description: Update an existing L3 address profile by the specified ID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_update_L3_address_profile_by_id operationId: updateL3AddressProfile parameters: - $ref: '#/components/parameters/id' requestBody: description: The payload of the update L3 address profile. content: application/json: schema: $ref: '#/components/schemas/XiqUpdateL3AddressProfileRequest' required: true responses: '200': description: OK content: application/json: schema: oneOf: - $ref: '#/components/schemas/XiqHostNameAddressProfile' - $ref: '#/components/schemas/XiqWildcardHostNameAddressProfile' - $ref: '#/components/schemas/XiqIpAddressProfile' - $ref: '#/components/schemas/XiqIpRangeAddressProfile' - $ref: '#/components/schemas/XiqSubnetAddressProfile' - $ref: '#/components/schemas/XiqWildcardAddressProfile' discriminator: propertyName: addressType default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] delete: tags: - Configuration - Policy summary: Delete L3 address profile by ID description: Delete an existing L3 address profile by the specified ID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_delete_L3_address_profile_by_id operationId: deleteL3AddressProfile parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /ip-firewall-policies: get: tags: - Configuration - Policy summary: List IP Firewall policies description: List a page of IP Firewall policies. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_list_ip_firewall_policies operationId: listIpFirewallPolicies parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/limit' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PagedIpFirewall' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] post: tags: - Configuration - Policy summary: Create IP Firewall policy description: Create a new IP Firewall policy. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_create_ip_firewall_policy operationId: createIpFirewallPolicy requestBody: description: The payload to create a new IP Firewall policy. content: application/json: schema: $ref: '#/components/schemas/XiqIpFirewallPolicyRequest' required: true responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/XiqIpFirewall' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /ip-firewall-policies/{id}: get: tags: - Configuration - Policy summary: Get IP Firewall Policy by ID description: Get an existing IP Firewall policy by the specified ID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_ip_firewall_policy_by_id operationId: getIpFirewallPolicy parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqIpFirewall' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] put: tags: - Configuration - Policy summary: Update IP Firewall policy by ID description: Update an existing IP Firewall policy by the specified ID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_update_ip_firewall_policy_by_id operationId: updateIpPolicyRequest parameters: - $ref: '#/components/parameters/id' requestBody: description: The payload of the update IP Firewall policy request. content: application/json: schema: $ref: '#/components/schemas/XiqIpFirewallPolicyRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqIpFirewall' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] delete: tags: - Configuration - Policy summary: Delete IP Firewall policy by ID description: Delete an existing IP Firewall policy by the specified ID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_delete_ip_firewall_policy_by_id operationId: deleteIpFirewallPolicy parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /ip-firewall-policies/{id}/ip-firewall-rule/:attach: post: tags: - Configuration - Policy summary: Attach IP Firewall Rule to IP Firewall policy description: Attach IP Firewall Rule to a IP Firewall policy. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_attach_ip_firewall_rule_to_ip_firewall_policy operationId: attachIpFirewallRuleToIpFirewallPolicy parameters: - $ref: '#/components/parameters/id' requestBody: description: The IP Firewall rule to be attached to the IP Firewall policy. content: application/json: schema: $ref: '#/components/schemas/XiqAttachIpFirewallRuleToIpFirewallPolicy' required: true responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /ip-firewall-policies/{id}/ip-firewall-rule/:detach: post: tags: - Configuration - Policy summary: Detach IP Firewall Rule from IP Firewall policy description: Detach IP Firewall Rule from a IP Firewall policy. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_detach_ip_firewall_rule_from_ip_firewall_policy operationId: detachIpFirewallRuleFromIpFirewallPolicy parameters: - $ref: '#/components/parameters/id' requestBody: description: The IP Firewall Rule ID to be detached from the IP Firewall policy. content: application/json: schema: $ref: '#/components/schemas/XiqIpFirewallRuleId' required: true responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /mac-firewall-policies: get: tags: - Configuration - Policy summary: List MAC Firewall policies description: List a page of MAC Firewall policies. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_list_mac_firewall_policies operationId: listMacFirewallPolicies parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/limit' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PagedMacFirewall' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] post: tags: - Configuration - Policy summary: Create MAC Firewall Policy description: Create a new MAC Firewall policy. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_create_mac_firewall_policy operationId: createMacFirewallPolicy requestBody: description: The payload to create a new Mac Firewall policy. content: application/json: schema: $ref: '#/components/schemas/XiqMacFirewallPolicyRequest' required: true responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/XiqMacFirewall' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /mac-firewall-policies/{id}: get: tags: - Configuration - Policy summary: Get MAC Firewall Policy by ID description: Get an existing MAC Firewall policy by the specified ID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_mac_firewall_policy_by_id operationId: getMacFirewallPolicy parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqMacFirewall' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] put: tags: - Configuration - Policy summary: Update MAC Firewall policy by ID description: Update an existing MAC Firewall policy by the specified ID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_update_mac_firewall_policy_by_id operationId: updateMacPolicyRequest parameters: - $ref: '#/components/parameters/id' requestBody: description: The payload of the update MAC Firewall policy request. content: application/json: schema: $ref: '#/components/schemas/XiqMacFirewallPolicyRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqMacFirewall' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] delete: tags: - Configuration - Policy summary: Delete MAC Firewall policy by ID description: Delete an existing MAC Firewall policy by the specified ID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_delete_mac_firewall_policy_by_id operationId: deleteMacFirewallPolicy parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /mac-object-profiles: get: tags: - Configuration - Policy summary: List MAC objects description: List a page of MAC objects. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_list_mac_objects operationId: listMacObjects parameters: - name: macType in: query description: The MAC object type required: true schema: $ref: '#/components/schemas/XiqMacObjectType' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PagedXiqMacObject' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] post: tags: - Configuration - Policy summary: Create MAC object description: Create a new MAC object. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_create_mac_object operationId: createMacObject requestBody: description: The request body to create new MAC object. content: application/json: schema: $ref: '#/components/schemas/XiqCreateMacObjectRequest' required: true responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/XiqMacObject' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /mac-object-profiles/{id}: get: tags: - Configuration - Policy summary: Get MAC object by ID description: Get an existing MAC object by the specified ID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_mac_object_by_id operationId: getMacObject parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqMacObject' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] put: tags: - Configuration - Policy summary: Update MAC object by ID description: Update an existing MAC object by the specified ID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_update_mac_object_by_id operationId: updateMacObject parameters: - $ref: '#/components/parameters/id' requestBody: description: The payload of the update MAC object request. content: application/json: schema: $ref: '#/components/schemas/XiqUpdateMacObjectRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqMacObject' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] delete: tags: - Configuration - Policy summary: Delete MAC object by ID description: Delete an existing MAC object by the specified ID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_delete_mac_object_by_id operationId: deleteMacObject parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /mac-firewall-policies/{id}/mac-firewall-rule/:attach: post: tags: - Configuration - Policy summary: Attach MAC Firewall Rule to MAC Firewall policy description: Attach MAC Firewall Rule to a MAC Firewall policy. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_attach_mac_firewall_rule_to_mac_firewall_policy operationId: attachMacFirewallRuleToMacFirewallPolicy parameters: - $ref: '#/components/parameters/id' requestBody: description: The MAC Firewall rule to be attached to the MAC Firewall policy. content: application/json: schema: $ref: '#/components/schemas/XiqAttachMacFirewallRuleToMacFirewallPolicy' required: true responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /mac-firewall-policies/{id}/mac-firewall-rule/:detach: post: tags: - Configuration - Policy summary: Detach MAC Firewall Rule from IP Firewall policy description: Detach MAC Firewall Rule from a IP Firewall policy. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_detach_mac_firewall_rule_from_mac_firewall_policy operationId: detachMacFirewallRuleFromMacFirewallPolicy parameters: - $ref: '#/components/parameters/id' requestBody: description: The MAC Firewall rule to be detached from the MAC Firewall policy. content: application/json: schema: $ref: '#/components/schemas/XiqMacFirewallRuleId' required: true responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /radio-profiles: get: tags: - Configuration - Policy summary: List radio profiles description: List a page of radio profiles. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_list_the_radio_profiles operationId: listRadioProfiles parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/limit' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PagedXiqRadioProfile' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] post: tags: - Configuration - Policy summary: Create a radio profile description: Create a new radio profile. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_create_radio_profile_configuration operationId: createRadioProfile requestBody: description: The request body to create new user profile. content: application/json: schema: $ref: '#/components/schemas/XiqCreateRadioProfileRequest' required: true responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/XiqRadioProfile' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /radio-profiles/{id}: get: tags: - Configuration - Policy summary: Get radio profile by ID description: Get radio profile details for the specified ID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_radio_profile_by_id operationId: getRadioProfile parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqRadioProfile' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] put: tags: - Configuration - Policy summary: Update radio profile by ID description: Update the existing radio profile by the profile ID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_update_radio_profile_configuration operationId: updateRadioProfile parameters: - $ref: '#/components/parameters/id' requestBody: description: The payload of the update radio profile request. content: application/json: schema: $ref: '#/components/schemas/XiqUpdateRadioProfileRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqRadioProfile' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] delete: tags: - Configuration - Policy summary: Delete radio profile by ID description: Delete the existing radio profile by the profile ID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_delete_radio_profile_configuration operationId: deleteRadioProfile parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /radio-profiles/channel-selection/{id}: get: tags: - Configuration - Policy summary: Get channel selection settings description: Get the channel selection settings belonging to a radio profile. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_radio_profile_channel_selection_by_id operationId: getRpChannelSelection parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqRpChannelSelection' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] put: tags: - Configuration - Policy summary: Update channel selection settings description: Update the channel selection settings belonging to a radio profile. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_update_radio_profile_channel_selection_by_id operationId: updateRpChannelSelection parameters: - $ref: '#/components/parameters/id' requestBody: description: The payload of the update channel selection settings request. content: application/json: schema: $ref: '#/components/schemas/XiqUpdateRpChannelSelectionRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqRpChannelSelection' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /radio-profiles/mac-ouis: get: tags: - Configuration - Policy summary: List MAC OUI profiles description: List a page of MAC OUI profiles. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_list_mac_oui_profiles operationId: listRpMacOuiProfiles parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/limit' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PagedXiqRpMacOuiProfile' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] post: tags: - Configuration - Policy summary: Create a MAC OUI profile description: Create a new MAC OUI profile for radio usage optimization. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_create_mac_oui_profile_configuration operationId: createMacOuiProfile requestBody: description: The request body to create new user profile. content: application/json: schema: $ref: '#/components/schemas/XiqCreateRpMacOuiProfileRequest' required: true responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/XiqRpMacOuiProfile' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /radio-profiles/mac-ouis/{id}: get: tags: - Configuration - Policy summary: Get MAC OUI profile description: Get the MAC OUI profile belonging the radio optimization settings. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_mac_oui_profile_by_id operationId: getRpMacOuiProfile parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqRpMacOuiProfile' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] put: tags: - Configuration - Policy summary: Update MAC OUI profile description: Update the existing MAC OUI profile for radio usage optimization. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_update_mac_oui_profile_by_id operationId: updateRpMacOuiProfile parameters: - $ref: '#/components/parameters/id' requestBody: description: The payload of the update MAC OUI profile request. content: application/json: schema: $ref: '#/components/schemas/XiqUpdateRpMacOuiProfileRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqRpMacOuiProfile' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] delete: tags: - Configuration - Policy summary: Delete MAC OUI profile description: Delete the existing MAC OUI profile for radio usage optimization. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_delete_mac_oui_profile_by_id operationId: deleteRpMacOuiProfile parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /radio-profiles/miscellaneous/{id}: get: tags: - Configuration - Policy summary: Get radio miscellaneous settings description: Get the radio miscellaneous settings belonging to a radio profile. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_radio_miscellaneous_settings_by_id operationId: getRpMiscellaneousSettings parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqRpMiscellaneousSettings' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] put: tags: - Configuration - Policy summary: Update radio miscellaneous settings description: Update the radio miscellaneous settings belonging to a radio profile. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_update_radio_miscellaneous_settings_by_id operationId: updateRpMiscellaneousSettings parameters: - $ref: '#/components/parameters/id' requestBody: description: The payload of the update radio miscellaneous settings request. content: application/json: schema: $ref: '#/components/schemas/XiqUpdateRpMiscellaneousSettingsRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqRpMiscellaneousSettings' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /radio-profiles/neighborhood-analysis/{id}: get: tags: - Configuration - Policy summary: Get neighborhood analysis settings description: Get the neighborhood analysis settings belonging to a radio profile. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_radio_profile_neighborhood_analysis_by_id operationId: getNeighborhoodAnalysis parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqRpNeighborhoodAnalysis' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] put: tags: - Configuration - Policy summary: Update neighborhood analysis settings description: Update the neighborhood analysis settings belonging to a radio profile. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_update_radio_profile_neighborhood_analysis_by_id operationId: updateNeighborhoodAnalysis parameters: - $ref: '#/components/parameters/id' requestBody: description: The payload of the update neighborhood analysis settings request. content: application/json: schema: $ref: '#/components/schemas/XiqUpdateRpNeighborhoodAnalysisRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqRpNeighborhoodAnalysis' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /radio-profiles/radio-usage-opt/{id}: get: tags: - Configuration - Policy summary: Get radio usage optimization settings description: Get the radio usage optimization settings belonging to a radio profile. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_radio_usage_optimization_by_id operationId: getRpRadioUsageOptimization parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqRpRadioUsageOptimization' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] put: tags: - Configuration - Policy summary: Update radio usage optimization settings description: Update the radio usage optimization settings belonging to a radio profile. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_update_radio_usage_optimization_by_id operationId: updateRpRadioUsageOptimization parameters: - $ref: '#/components/parameters/id' requestBody: description: The payload of the update radio usage optimization settings request. content: application/json: schema: $ref: '#/components/schemas/XiqUpdateRpRadioUsageOptimizationRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqRpRadioUsageOptimization' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /radio-profiles/sensor-scan/{id}: get: tags: - Configuration - Policy summary: Get sensor scan settings description: Get the sensor scan settings belonging to a radio profile. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_sensor_scan_settings_by_id operationId: getRpSensorScanSettings parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqRpSensorScanSettings' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] put: tags: - Configuration - Policy summary: Update sensor scan settings description: Update the sensor scan settings belonging to a radio profile. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_update_sensor_scan_settings_by_id operationId: updateRpSensorScanSettings parameters: - $ref: '#/components/parameters/id' requestBody: description: The payload of the update sensor scan settings request. content: application/json: schema: $ref: '#/components/schemas/XiqUpdateRpSensorScanSettingsRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqRpSensorScanSettings' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /radio-profiles/wmm-qos/{id}: get: tags: - Configuration - Policy summary: Get Wmm QoS settings description: Get the Wi-Fi Multimedia (WMM) QoS settings belonging to a radio profile. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_wmm_qos_settings_by_id operationId: getRpWmmQosSettings parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqRpWmmQosSettings' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] put: tags: - Configuration - Policy summary: Update Wmm QoS settings description: Update the Wi-Fi Multimedia (WMM) QoS settings belonging to a radio profile. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_update_wmm_qos_settings_by_id operationId: updateRpWmmQosSettings parameters: - $ref: '#/components/parameters/id' requestBody: description: The payload of the update Wmm QoS settings request. content: application/json: schema: $ref: '#/components/schemas/XiqUpdateRpWmmQosSettingsRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqRpWmmQosSettings' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /user-profiles: get: tags: - Configuration - Policy summary: List user profiles description: List a page of user profiles. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_list_the_user_profiles operationId: listUserProfiles parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/limit' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PagedXiqUserProfile' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] post: tags: - Configuration - Policy summary: Create a user profile description: Create a new user profile. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_create_user_profile_configuration operationId: createUserProfile requestBody: description: The request body to create new user profile. content: application/json: schema: $ref: '#/components/schemas/XiqCreateUserProfileRequest' required: true responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/XiqUserProfile' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /user-profiles/{id}: get: tags: - Configuration - Policy summary: Get user profile by ID description: Get user profile details for the specified ID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_user_profile_by_id operationId: getUserProfile parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqUserProfile' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] put: tags: - Configuration - Policy summary: Update user profile description: Update an existing user profile. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_update_user_profile_configuration operationId: updateCoUserProfile parameters: - $ref: '#/components/parameters/id' requestBody: description: The payload of user profile. content: application/json: schema: $ref: '#/components/schemas/XiqUpdateUserProfileRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqUserProfile' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] delete: tags: - Configuration - Policy summary: Delete an user profile by ID description: Delete an existing user profile by ID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_delete_user_profile_configuration operationId: deleteCoUserProfile parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /user-profile-assignments: get: tags: - Configuration - Policy summary: List User Profile Assignments description: List a page of User Profile Assignments. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#list_user_profile_assignments operationId: listUserProfileAssignments parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/limit' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PagedXiqUserProfileAssignment' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] post: tags: - Configuration - Policy summary: Create User Profile Assignment description: Create User Profile Assignment. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#create_user_profile_assignment operationId: createUserProfileAssignment requestBody: description: The request body to create new User Profile Assignment object. content: application/json: schema: $ref: '#/components/schemas/XiqCreateUserProfileAssignmentRequest' required: true responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/XiqUserProfileAssignment' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /user-profile-assignments/{id}: get: tags: - Configuration - Policy summary: Get User Profile Assignment by ID description: Get an existing User Profile Assignment object by the specified ID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_user_profile_assignment_by_id operationId: getUpUserProfileAssignment parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqUserProfileAssignment' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] delete: tags: - Configuration - Policy summary: Delete User Profile Assignment by ID description: Delete an existing User Profile Assignment by the specified ID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_delete_user_profile_assignment_by_id operationId: deleteUserProfileAssignment parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /user-profiles/{id}/ip-firewall-policies/:attach: post: tags: - Configuration - Policy summary: Attach IP Firewall policy to User Profile description: Attach an IP Firewall policy to a User Profile. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_attach_ip_firewall_policy_to_user_profile operationId: attachIpFirewallPolicyToUserProfile parameters: - $ref: '#/components/parameters/id' requestBody: description: The IP Firewall policy ID and traffic direction to be attached to the SSID. content: application/json: schema: $ref: '#/components/schemas/XiqAttachIpFirewallRequest' required: true responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /user-profiles/{id}/ip-firewall-policies/:detach: post: tags: - Configuration - Policy summary: Detach IP Firewall policy from User Profile description: Detach an IP Firewall policy from a User Profile. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_detach_ip_firewall_policy_from_user_profile operationId: detachIpFirewallPolicyFromUserProfile parameters: - $ref: '#/components/parameters/id' requestBody: description: The IP Firewall policy ID to be detached from User Profile. content: application/json: schema: $ref: '#/components/schemas/XiqDetachIpFirewallRequest' required: true responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /user-profiles/{id}/mac-firewall-policies/:attach: post: tags: - Configuration - Policy summary: Attach MAC Firewall policy to User Profile description: Attach a MAC Firewall policy to a User Profile. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_attach_mac_firewall_policy_to_user_profile operationId: attachMacFirewallPolicyToUserProfile parameters: - $ref: '#/components/parameters/id' requestBody: description: The MAC Firewall policy ID and traffic direction to be attached to the SSID. content: application/json: schema: $ref: '#/components/schemas/XiqAttachMacFirewallRequest' required: true responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /user-profiles/{id}/mac-firewall-policies/:detach: post: tags: - Configuration - Policy summary: Detach MAC Firewall policy from User Profile description: Detach a MAC Firewall policy from a User Profile. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_detach_mac_firewall_policy_from_user_profile operationId: detachMacFirewallPolicyFromUserProfile parameters: - $ref: '#/components/parameters/id' requestBody: description: The MAC Firewall policy ID and traffic direction to be detached from User Profile. content: application/json: schema: $ref: '#/components/schemas/XiqDetachMacFirewallRequest' required: true responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /hotspot-profiles: get: tags: - Configuration - Policy summary: List Hotspot profiles description: List a page of Hotspot profiles. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_list_the_hotspot_profiles operationId: listHotspotProfiles parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/limit' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PagedXiqHotspotProfile' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] post: tags: - Configuration - Policy summary: Create a Hotspot profile description: Create a new Hotspot profile. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_create_hotspot_profile operationId: createHotspotProfile requestBody: description: The request body to create new Hotspot profile. content: application/json: schema: $ref: '#/components/schemas/XiqHotspotProfileRequest' required: true responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/XiqHotspotProfile' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /hotspot-profiles/{id}: get: tags: - Configuration - Policy summary: Get Hotspot profile by ID description: Get Hotspot profile for the specified ID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_hotspot_profile_by_id operationId: getHotspotProfile parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqHotspotProfile' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] put: tags: - Configuration - Policy summary: Update Hotspot profile by ID description: Update the existing Hotspot profile by the profile ID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_update_hotspot_profile operationId: updateHotspotProfile parameters: - $ref: '#/components/parameters/id' requestBody: description: The payload of the update Hotspot profile request. content: application/json: schema: $ref: '#/components/schemas/XiqHotspotProfileRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqHotspotProfile' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] delete: tags: - Configuration - Policy summary: Delete Hotspot profile by ID description: Delete the existing Hotspot profile by the profile ID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_delete_hotspot_profile operationId: deleteHotspotProfile parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /hotspot-service-profiler-profiles: get: tags: - Configuration - Policy summary: List Hotspot Service Provider profiles description: List a page of Hotspot Service Provider profiles. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_list_the_hotspot_service_provider_profiles operationId: listHotspotServiceProviderProfiles parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/limit' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PagedXiqHotspotServiceProviderProfile' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] post: tags: - Configuration - Policy summary: Create a Hotspot Service Provider profile description: Create a Hotspot Service Provider profile. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_create_hotspot_service_provider_profile operationId: createHotspotServiceProviderProfile requestBody: description: The request body to create new Hotspot Service Provider profile. content: application/json: schema: $ref: '#/components/schemas/XiqHotspotServiceProviderProfileRequest' required: true responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/XiqHotspotServiceProviderProfile' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /hotspot-service-provider-profiles/{id}: get: tags: - Configuration - Policy summary: Get Hotspot Service Provider profile by ID description: Get Hotspot Service Provider profile for the specified ID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_hotspot_service_provider_profile_by_id operationId: getHotspotServiceProviderProfile parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqHotspotServiceProviderProfile' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] put: tags: - Configuration - Policy summary: Update Hotspot Service Provider profile by ID description: Update the existing Hotspot Service Provider profile by ID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_update_hotspot_service_provider_profile operationId: updateHotspotServiceProviderProfile parameters: - $ref: '#/components/parameters/id' requestBody: description: The payload of the update Hotspot Service Provider profile request. content: application/json: schema: $ref: '#/components/schemas/XiqHotspotServiceProviderProfileRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqHotspotServiceProviderProfile' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] delete: tags: - Configuration - Policy summary: Delete Hotspot Service Provider profile by ID description: Delete the existing Hotspot Service Provider profile by ID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_delete_hotspot_service_provider_profile operationId: deleteHotspotServiceProviderProfile parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /ssids: get: tags: - Configuration - Policy summary: List SSIDs description: List SSIDs with filter and pagination. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_list_ssids operationId: listSsids parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/limit' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PagedXiqSsid1' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /ssids/{id}/:rename: post: tags: - Configuration - Policy summary: Rename SSID (Wireless name) description: Change SSID broadcast name (Wireless name). externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_rename_ssidwireless_name operationId: renameSsid parameters: - $ref: '#/components/parameters/id' requestBody: description: The new SSID name content: application/json: schema: type: string required: true responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /ssids/{id}/cwp/:attach: post: tags: - Configuration - Policy summary: Attach CWP to an SSID description: Attach CWP to an SSID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_attach_cwp_to_an_ssid operationId: attachCwpToSsid parameters: - $ref: '#/components/parameters/id' requestBody: description: The CWP ID to be attached to the SSID. For CWP with only User Auth on Captive Web Portal enabled, please also attach a RADIUS server group or enable ExtremeCloud IQ Authentication Service. content: application/json: schema: type: integer format: int64 required: true responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /ssids/{id}/cwp/:enable: post: tags: - Configuration - Policy summary: Enable and attach the CWP on the SSID description: Enable and attach the CWP on the SSID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_enable_and_attach_the_cwp_on_the_ssid operationId: enableSsidCwp parameters: - $ref: '#/components/parameters/id' requestBody: description: The new CWP ID. For CWP with only User Auth on Captive Web Portal enabled, please also attach a RADIUS server group or enable ExtremeCloud IQ Authentication Service. content: application/json: schema: type: integer format: int64 required: true responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /ssids/{id}/cwp/:disable: post: tags: - Configuration - Policy summary: Disable the CWP on the SSID description: Disable the CWP on the SSID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_disable_and_detach_the_cwp_on_the_ssid operationId: disableSsidCwp parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /ssids/{id}/mode/dot1x: put: tags: - Configuration - Policy summary: Change the SSID mode to 802.1x and Authentication description: Change the SSID mode to 802.1x. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_set_ssid_mode_to_dot1x operationId: setSsidModeDot1x parameters: - $ref: '#/components/parameters/id' requestBody: description: The payload to change the SSID mode to 802.1x and set the Authentication settings content: application/json: schema: $ref: '#/components/schemas/XiqSetSsidModeDot1xRequest' required: true responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /ssids/{id}/mode/open: put: tags: - Configuration - Policy summary: Change the SSID mode to open access description: Change the SSID mode to open access. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_set_ssid_mode_to_open_access operationId: setSsidModeOpen parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /ssids/{id}/mode/psk: put: tags: - Configuration - Policy summary: Change the SSID mode to PSK description: Change the SSID mode to PSK. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_set_ssid_mode_to_psk operationId: setSsidModePsk parameters: - $ref: '#/components/parameters/id' requestBody: description: The payload to change the SSID mode to PSK content: application/json: schema: $ref: '#/components/schemas/XiqSetSsidModePskRequest' required: true responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /ssids/{id}/mode/ppsk: put: tags: - Configuration - Policy summary: Change the SSID mode to PPSK description: Change the SSID mode to PPSK. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_set_ssid_mode_to_ppsk operationId: setSsidModePpsk parameters: - $ref: '#/components/parameters/id' requestBody: description: The payload to change the SSID mode to PPSK content: application/json: schema: $ref: '#/components/schemas/XiqSetSsidModePpskRequest' required: true responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /ssids/{id}/mode/wep: put: tags: - Configuration - Policy summary: Change the SSID mode to WEP description: Change the SSID mode to WEP. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_set_ssid_mode_to_wep operationId: setSsidModeWep parameters: - $ref: '#/components/parameters/id' requestBody: description: The payload to change the SSID mode to WEP content: application/json: schema: $ref: '#/components/schemas/XiqSetSsidModeWepRequest' required: true responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /ssids/{id}/psk/password: put: tags: - Configuration - Policy summary: Change the SSID PSK password description: Change the SSID PSK password. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_change_the_ssid_psk_password operationId: changePskPassword parameters: - $ref: '#/components/parameters/id' requestBody: description: The new SSID PSK password content: application/json: schema: type: string required: true responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /ssids/{id}/radius-server-group/:attach: post: tags: - Configuration - Policy summary: Attach radius server group to an SSID description: Attach radius server group to an SSID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_attach_radius_server_group_to_an_ssid operationId: attachRadiusServerGroupToSsid parameters: - $ref: '#/components/parameters/id' requestBody: description: The radius server group ID to be attached to the SSID content: application/json: schema: type: integer format: int64 required: true responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /ssids/{id}/radius-client-profile/:attach: post: tags: - Configuration - Policy summary: Attach RADIUS client profile to an SSID description: Attach RADIUS client profile to an SSID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_attach_radius_client_profile_to_an_ssid operationId: attachRadiusClientProfileToSsid parameters: - $ref: '#/components/parameters/id' requestBody: description: The RADIUS client profile ID to be attached to the SSID content: application/json: schema: type: integer format: int64 required: true responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /ssids/{id}/user-profile-assignments/:attach: post: tags: - Configuration - Policy summary: Attach User Profile Assignment to SSID description: Attach User Profile Assignment to an SSID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_attach_user_profile_assignment_to_ssid operationId: attachUserProfileAssignmentToSsid parameters: - $ref: '#/components/parameters/id' requestBody: description: |- The User Profile ID and User Profile Assignment ID to be attached to the SSID. User Profile and User Profile Assignment IDs are added to a User Profile Assignment Rule List within the SSID. Will also set the necessary fields on the SSID to allow User Profile Assignment using RADIUS attributes: 'Apply a different user profile to various clients and user groups', 'Allow User profile assignment using RADIUS attributes in addition to the three tunnel RADIUS attributes' & 'Standard RADIUS Attribute' to 'Filter-Id'. content: application/json: schema: $ref: '#/components/schemas/XiqAttachUPAssignmentRequest' required: true responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /ssids/{id}/user-profile-assignments/:detach: post: tags: - Configuration - Policy summary: Detach User Profile Assignment from SSID description: Detach User Profile Assignment from an SSID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_detach_user_profile_assignment_from_ssid operationId: detachUserProfileAssignmentFromSsid parameters: - $ref: '#/components/parameters/id' requestBody: description: The User Profile ID and User Profile Assignment ID to be detached from the SSID. content: application/json: schema: $ref: '#/components/schemas/XiqDetachUPAssignmentRequest' required: true responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /ssids/{id}/user-profile/:attach: post: tags: - Configuration - Policy summary: Attach user profile to an SSID description: Attach user profile to an SSID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_attach_user_profile_to_an_ssid operationId: attachUserProfileToSsid parameters: - $ref: '#/components/parameters/id' requestBody: description: The user profile ID to be attached to the SSID content: application/json: schema: type: integer format: int64 required: true responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /ssids/advanced-settings/{id}: get: tags: - Configuration - Policy summary: Get advanced settings for SSID description: Get the advanced settings belonging to a SSID profile. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_ssid_advanced_settings_by_id operationId: getSsidAdvancedSettings parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqSsidAdvancedSettings' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] put: tags: - Configuration - Policy summary: Update SSID advanced settings description: Update the advanced settings belonging to a SSID profile. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_update_ssid_advanced_settings_by_id operationId: updateSsidAdvancedSettings parameters: - $ref: '#/components/parameters/id' requestBody: description: The payload of the update advanced settings request. content: application/json: schema: $ref: '#/components/schemas/XiqUpdateSsidAdvancedSettingsRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqSsidAdvancedSettings' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /ssids/{id}/hotspot-profiles/:enable: post: tags: - Configuration - Policy summary: Enable and attach the Hotspot profile on the SSID description: Enable and attach the Hotspot profile on the SSID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_enable_and_attach_the_hotspot_on_the_ssid operationId: enableSsidHotspot parameters: - $ref: '#/components/parameters/id' requestBody: description: The Hotspot profile ID to be attached to the SSID. content: application/json: schema: type: integer format: int64 required: true responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /ssids/{id}/hotspots-profiles/:disable: post: tags: - Configuration - Policy summary: Disable the Hotspot profile on the SSID description: Disable the Hotspot profile on the SSID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_disable_and_detach_the_hotspot_on_the_ssid operationId: disableSsidHotspot parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /ccgs: get: tags: - Configuration - Policy summary: '[LRO] List clould config groups' description: List a papge of cloud config groups. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_list_cloud_config_groups operationId: listCloudConfigGroups parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/async' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PagedXiqCloudConfigGroup' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] post: tags: - Configuration - Policy summary: Create new cloud config group description: Create a new cloud config group. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_create_cloud_config_group operationId: createCloudConfigGroup requestBody: description: Create new cloud config group request body content: application/json: schema: $ref: '#/components/schemas/XiqCreateCloudConfigGroupRequest' required: true responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/XiqCloudConfigGroup' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /ccgs/{id}: get: tags: - Configuration - Policy summary: Get a cloud config group description: Get cloud config group info for the specified ID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_cloud_config_group operationId: getCloudConfigGroup parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqCloudConfigGroup' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] put: tags: - Configuration - Policy summary: Update cloud config group information description: Update the cloud config group details having the specified ID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_update_cloud_config_group operationId: updateCloudConfigGroup parameters: - $ref: '#/components/parameters/id' requestBody: description: Update cloud config group request body content: application/json: schema: $ref: '#/components/schemas/XiqUpdateCloudConfigGroupRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqCloudConfigGroup' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] delete: tags: - Configuration - Policy summary: Delete a cloud config group description: Delete a specific cloud config group by ID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_delete_cloud_config_group operationId: deleteCloudConfigGroup parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /iot-profiles: get: tags: - Configuration - Policy summary: List IoT profiles description: List a page of IoT profiles. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_list_the_iot_profiles operationId: listIotProfiles parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/limit' - name: appSupported in: query description: IoT profile app supported type required: false schema: $ref: '#/components/schemas/XiqIotApplicationSupported' - name: appId in: query description: IoT profile app ID type required: false schema: $ref: '#/components/schemas/XiqIotApplicationId' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PagedXiqIotProfile' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] post: tags: - Configuration - Policy summary: Create an IoT profile description: Create a new IoT profile. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_create_iot_profile_configuration operationId: createIotProfile requestBody: description: The request body to create new IoT profile. content: application/json: schema: $ref: '#/components/schemas/XiqIotProfileRequest' required: true responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/XiqIotProfile' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /iot-profiles/{id}: get: tags: - Configuration - Policy summary: Get IoT profile by ID description: Get IoT profile details for the specified ID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_iot_profile_by_id operationId: getIotProfile parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqIotProfile' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] put: tags: - Configuration - Policy summary: Update IoT profile by ID description: Update the existing IoT profile by the profile ID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_update_iot_profile_configuration operationId: updateIotProfile parameters: - $ref: '#/components/parameters/id' requestBody: description: The payload of the update IoT profile request. content: application/json: schema: $ref: '#/components/schemas/XiqIotProfileRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqIotProfile' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] delete: tags: - Configuration - Policy summary: Delete IoT profile by ID description: Delete the existing IoT profile by the profile ID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_delete_iot_profile_configuration operationId: deleteIotProfile parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /client-monitor-profiles: get: tags: - Configuration - Policy summary: List client monitor profiles description: List a page of client monitor profiles. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_list_client_monitor_profiles operationId: listClientMonitorProfiles parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/limit' - name: sortField in: query description: Sort field. Available values - NAME required: false schema: type: string enum: - NAME - $ref: '#/components/parameters/order' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PagedXiqClientMonitorProfile' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] post: tags: - Configuration - Policy summary: Create a client monitor profile description: Create a new client monitor profile. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_create_client_monitor_profile operationId: createClientMonitorProfile requestBody: description: The request body to create new client monitor profile content: application/json: schema: $ref: '#/components/schemas/XiqClientMonitorProfileRequest' required: true responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/XiqClientMonitorProfile' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /client-monitor-profiles/{id}: get: tags: - Configuration - Policy summary: Get a client monitor profile by ID description: Get client monitor profile details for the specified ID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_client_monitor_profile operationId: getClientMonitorPolicy parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqClientMonitorProfile' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] put: tags: - Configuration - Policy summary: Update client monitor profile by ID description: Update an existing client monitor profile. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_update_client_monitor_profile operationId: updateClientMonitorPolicy parameters: - $ref: '#/components/parameters/id' requestBody: description: The payload of client monitor profile. content: application/json: schema: $ref: '#/components/schemas/XiqClientMonitorProfileRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqClientMonitorProfile' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] delete: tags: - Configuration - Policy summary: Delete a client monitor profile by ID description: Delete an existing client monitor profile by ID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_delete_client_monitor_profile operationId: deleteClientMonitorProfile parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /ssids/{id}/client-monitor-profile/:attach: post: tags: - Configuration - Policy summary: Attach client monitor profile to an SSID description: Attach client monitor profile to an SSID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_attach_client_monitor_profile_to_an_ssid operationId: attachClientMonitorProfileToSsid parameters: - $ref: '#/components/parameters/id' requestBody: description: The client monitor profile ID to be attached to the SSID content: application/json: schema: type: integer format: int64 required: true responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /radio-operating-modes/{productType}: get: tags: - Configuration - Policy summary: Get AP Radio Operating Mode description: "Modern AP hardware types include dual or triple band radios.\nA limited subset of band combinations are supported.\nOperating mode defines the supported band combinations per radio. \nAccess Points with fixed band radios use GENERIC operating mode. \nSERVICE_2_5_6: wifi0-2.4Ghz, wifi1-5Ghz, wifi2-6Ghz\nSENSOR_SERVICE_5_6: wifi0-Tri-band sensor, wifi1-5Ghz, wifi2-6Ghz\nSERVICE_5L_5H_6: wifi0-5G Low, wifi1-5G High, wifi2-6Ghz\nSENSOR_SERVICE_5_2: wifi0-Tri-band sensor, wifi1-5GHz, wifi2-2.4Ghz\nSERVICE_5L_5H_2: wifi0-5G Low, wifi1-5G High, wifi2-2.4Ghz\nSERVICE_6L_5_6H: wifi0-6G Low, wifi1-5GHz, wifi2-6Ghz.\nSERVICE_2_5H_5L: wifi0-2.4Ghz, wifi1-5G High, wifi2-5G Low." externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_radio_operating_mode operationId: getDeviceOperationMode parameters: - name: productType in: path description: Product/AP Model required: true schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqDeviceRadioModesSettings' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /tunnel-concentrators: get: tags: - Configuration - Network summary: List Tunnel Concentrator services description: Get a page of Tunnel Concentrator services. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_list_the_tunnel_concentrators operationId: listTunnelConcentrators parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/limit' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PagedXiqTunnelConcentrator' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] post: tags: - Configuration - Network summary: Create Tunnel Concentrator Service description: Create a new Tunnel Concentrator Service. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_create_tunnel_concentrator_configuration operationId: createTunnelConcentrator requestBody: description: The payload to create new Tunnel Concentrator Service content: application/json: schema: $ref: '#/components/schemas/XiqTunnelConcentratorRequest' required: true responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/XiqTunnelConcentrator' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /tunnel-concentrators/{id}: get: tags: - Configuration - Network summary: Get a Tunnel Concentrator Service description: Get a specific Tunnel Concentrator Service by ID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_tunnel_concentrator_by_id operationId: getTunnelConcentrator parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqTunnelConcentrator' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] put: tags: - Configuration - Network summary: Update a Tunnel Concentrator Service description: Update a specific Tunnel Concentrator Service. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_update_tunnel_concentrator_configuration operationId: updateTunnelConcentrator parameters: - $ref: '#/components/parameters/id' requestBody: description: The payload to update Tunnel Concentrator Service content: application/json: schema: $ref: '#/components/schemas/XiqTunnelConcentratorRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqTunnelConcentrator' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] delete: tags: - Configuration - Network summary: Delete a Tunnel Concentrator Service description: Delete a specific Tunnel Concentrator Service by ID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_delete_tunnel_concentrator_configuration operationId: deleteTunnelConcentrator parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /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: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/limit' - 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' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] post: tags: - Configuration - Network summary: Create Network Service description: Create a new Network Service. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_create_network_service operationId: createNetworkService requestBody: description: The payload to create new Network Service content: application/json: schema: $ref: '#/components/schemas/XiqNetworkServiceRequest' required: true responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/XiqNetworkService' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /network-services/{id}: delete: tags: - Configuration - Network summary: Delete a Network Service by ID description: Delete a Network Service by ID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_delete_network_service operationId: deleteNetworkService parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /ad-servers: get: tags: - Configuration - Authentication summary: List active directory servers description: List a page of active directory servers. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_list_the_active_directory_server operationId: listActiveDirectoryServers parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/limit' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PagedXiqActiveDirectoryServer' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /cwps: get: tags: - Configuration - Authentication summary: List captive web portals description: List a page of Captive Web Portals. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_list_captive_web_portals operationId: listCaptiveWebPortals parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/limit' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PagedXiqCwp' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /ldap-servers: get: tags: - Configuration - Authentication summary: List LDAP servers description: List a page of LDAP servers. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_list_ldap_servers operationId: listLdapServers parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/limit' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PagedXiqLdapServer' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] post: tags: - Configuration - Authentication summary: Create LDAP server description: Create a new LDAP server. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_create_ldap_server operationId: createLdapServer requestBody: description: The body of create LDAP server API content: application/json: schema: $ref: '#/components/schemas/XiqCreateLdapServerRequest' examples: Create_a_new_LDAP_server: summary: Create a new LDAP server description: The payload to create a new LDAP server value: name: test-ldap-server description: test ldap server enable_tls: true bind_dn: extreme.com bind_dn_password: '123456' base_dn: extreme.com l3_address_profile_id: 10 protocol_type: LDAP enable_strip_realm_name: false destination_port: 10 verification_mode: TRY ca_certificate_id: 1000 client_certificate_id: 2000 client_key_id: 30000 client_key_password: '' required: true responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/XiqLdapServer' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /ldap-servers/{id}: get: tags: - Configuration - Authentication summary: Get LDAP server by ID description: Get a specific LDAP server by ID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_ldap_server operationId: getLdapServer parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqLdapServer' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] put: tags: - Configuration - Authentication summary: Update LDAP server configuration description: Update configuration for a specific LDAP server. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_update_ldap_server operationId: updateLdapServer parameters: - $ref: '#/components/parameters/id' 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' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] delete: tags: - Configuration - Authentication summary: Delete a LDAP server description: Delete a specific LDAP server by ID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_delete_ldap_server operationId: deleteLdapServer parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /radius-client-objects: get: tags: - Configuration - Authentication summary: List RADIUS client objects description: List a page of RADIUS client object configurations. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_list_the_radius_client_objects_configuration operationId: listRadiusClientObjects parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/limit' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PagedXiqRadiusClientObject' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] post: tags: - Configuration - Authentication summary: Create RADIUS client object configuration description: Create a new RADIUS client object configuration. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_create_radius_client_object_configuration operationId: createRadiusClientObject requestBody: description: Use the payload configuration to create a new RADIUS client object content: application/json: schema: $ref: '#/components/schemas/XiqCreateRadiusClientObjectRequest' required: true responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/XiqRadiusClientObject' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /radius-client-objects/{id}: get: tags: - Configuration - Authentication summary: Get RADIUS client object by ID description: Get detailed configuration for a specific RADIUS client object. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_list_the_radius_client_object_configuration_by_id operationId: getRadiusClientObject parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqRadiusClientObject' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] put: tags: - Configuration - Authentication summary: Update RADIUS client object configuration description: Update RADIUS client object configuration by ID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_update_radius_client_object_configuration operationId: updateRadiusClientObject parameters: - $ref: '#/components/parameters/id' requestBody: description: The payload to update the RADIUS client object content: application/json: schema: $ref: '#/components/schemas/XiqUpdateRadiusClientObjectRequest' required: true responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] delete: tags: - Configuration - Authentication summary: Delete a RADIUS client object configuration description: Delete an existing RADIUS client object configuration by ID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_delete_radius_client_object_configuration operationId: deleteRadiusClientObject parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /radius-proxies: get: tags: - Configuration - Authentication summary: List RADIUS proxies description: List a page of RADIUS proxy configurations. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_list_the_radius_proxy_configuration operationId: listRadiusProxies parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/limit' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PagedXiqRadiusProxy' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] post: tags: - Configuration - Authentication summary: Create RADIUS proxy configuration description: Create a new RADIUS proxy configuration. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_create_radius_proxy_configuration operationId: createRadiusProxy requestBody: description: The body of create RADIUS proxy API content: application/json: schema: $ref: '#/components/schemas/XiqCreateRadiusProxyRequest' examples: Create_a_new_RADIUS_proxy: summary: Create a new RADIUS proxy description: The payload to create a new RADIUS proxy value: name: radius-proxy-1 description: Radius Proxy 1 format_type: NAI retry_count: 3 retry_delay: 5 dead_time: 300 enable_inject_operator_name_attribute: false device_ids: - 1 clients: - shared_secret: '123456' description: '' l3_address_profile_id: 1000 realms: - name: 'NULL' enable_strip_realm_name: false radius_client_object_id: 2000 - name: DEFAULT enable_strip_realm_name: false radius_client_object_id: 3000 required: true responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/XiqRadiusProxy' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /radius-proxies/{id}: get: tags: - Configuration - Authentication summary: Get the RADIUS proxy configuration description: Get an existing RADIUS proxy configuration by ID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_the_radius_proxy_configuration_by_id operationId: getRadiusProxy parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqRadiusProxy' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] put: tags: - Configuration - Authentication summary: Update RADIUS proxy configuration description: Update RADIUS proxy configuration by ID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_update_radius_proxy_configuration operationId: updateRadiusProxy parameters: - $ref: '#/components/parameters/id' requestBody: description: The body of update RADIUS proxy API content: application/json: schema: $ref: '#/components/schemas/XiqUpdateRadiusProxyRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqRadiusProxy' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] delete: tags: - Configuration - Authentication summary: Delete the RADIUS proxy configuration description: Delete an existing RADIUS proxy configuration by ID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_delete_radius_proxy_configuration operationId: deleteRadiusProxy parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /radius-proxies/devices: get: tags: - Configuration - Authentication summary: List Radius proxy devices operationId: listRadiusProxyDevices description: List devices for Radius Proxy. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_list_radius_proxy_devices parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/limit' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PagedXiqInternalRadiusDevice' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /radius-servers/internal: get: tags: - Configuration - Authentication summary: List all internal RADIUS servers description: List all internal RADIUS servers configurations. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_list_the_internal_radius_servers operationId: listInternalRadiusServers parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/limit' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PagedXiqInternalRadiusServer' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] post: tags: - Configuration - Authentication summary: Create internal RADIUS server configuration description: Create a new internal RADIUS server configuration. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_create_internal_radius_server_configuration operationId: createInternalRadiusServer requestBody: description: Use the payload configuration to create a new internal RADIUS server content: application/json: schema: $ref: '#/components/schemas/XiqCreateInternalRadiusServerRequest' required: true responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/XiqInternalRadiusServer' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /radius-servers/internal/{id}: get: tags: - Configuration - Authentication summary: Get internal RADIUS server by ID description: Get detailed configuration for internal RADIUS server by ID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_list_the_internal_radius_server_by_id operationId: getInternalRadiusServer parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqInternalRadiusServer' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] put: tags: - Configuration - Authentication summary: Update internal RADIUS server configuration description: Update internal RADIUS server configuration by ID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_update_internal_radius_server_configuration operationId: updateInternalRadiusServer parameters: - $ref: '#/components/parameters/id' 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' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] delete: tags: - Configuration - Authentication summary: Delete internal RADIUS server configuration description: Delete an existing internal RADIUS server configuration by ID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_delete_internal_radius_server_configuration operationId: deleteInternalRadiusServer parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /radius-servers/internal/devices: get: tags: - Configuration - Authentication summary: List all internal RADIUS devices description: List all internal RADIUS devices fields. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_list_the_internal_radius_devices operationId: listInternalRadiusDevices parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/limit' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PagedXiqInternalRadiusDevice' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /radius-servers/external: get: tags: - Configuration - Authentication summary: List external RADIUS servers description: List a page of external RADIUS server configurations. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_list_the_external_radius_servers operationId: listExternalRadiusServers parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/limit' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PagedXiqExternalRadiusServer' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] post: tags: - Configuration - Authentication summary: Create external RADIUS server configuration description: Create a new external RADIUS server configuration. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_create_external_radius_server_configuration operationId: createExternalRadiusServer requestBody: description: Use the payload configuration to create a new external RADIUS server content: application/json: schema: $ref: '#/components/schemas/XiqCreateExternalRadiusServerRequest' examples: Create_a_new_External_RADIUS_server: summary: Create a new External RADIUS Server description: The payload to create a new External RADIUS Server. value: name: external-server shared_secret: '123456' authentication_port: 1812 accounting_port: 1813 ip_addr: 10.10.10.10 server_type: ACCOUNTING access_type: STANDARD enable_a3: true Create_a_new_RADSEC_server: summary: Create a new RADSEC Server description: The payload to create a new RADSEC Server. value: name: radsec-server shared_secret: '123456' authentication_port: 2083 accounting_port: 2083 server_type: ACCOUNTING enable_a3: true enable_peer_discovery: true access_type: SECURE trust_point_id: 1234567890 required: true responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/XiqExternalRadiusServer' examples: create_radius_successful: summary: Created External RADIUS Server description: Created External RADIUS Server. value: id: 1234567890 create_time: '2019-08-24T14:15:22Z' update_time: '2019-08-24T14:15:22Z' org_id: 100 name: external-server shared_secret: '123456' authentication_port: 1812 accounting_port: 1813 ip_addr: 10.10.10.10 server_type: ACCOUNTING enable_a3: true create_radsec_successful: summary: Created RADSEC Server description: Created RADSEC Server. value: id: 9876543210 create_time: '2019-08-24T14:15:22Z' update_time: '2019-08-24T14:15:22Z' org_id: 100 name: radsec-server shared_secret: '123456' authentication_port: 1812 accounting_port: 1813 server_type: ACCOUNTING enable_a3: true enable_peer_discovery: true access_type: SECURE trust_point: id: 3456789012 create_time: '2019-08-23T11:35:24Z' update_time: '2019-08-23T11:35:24Z' org_id: 100 name: cert-bundle-trust-point bundle_type: TRUST_POINT certificate_ids: - 10000 - 20000 - 30000 default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /radius-servers/external/{id}: get: tags: - Configuration - Authentication summary: Get external RADIUS server by ID description: Get detailed configuration for a specific external RADIUS server. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_list_the_external_radius_server_by_id operationId: getExternalRadiusServer parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqExternalRadiusServer' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] put: tags: - Configuration - Authentication summary: Update external RADIUS server configuration description: Update external RADIUS server configuration by ID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_update_external_radius_server_configuration operationId: updateExternalRadiusServer parameters: - $ref: '#/components/parameters/id' requestBody: description: The payload to update the external RADIUS server content: application/json: schema: $ref: '#/components/schemas/XiqUpdateExternalRadiusServerRequest' required: true responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] delete: tags: - Configuration - Authentication summary: Delete external RADIUS server configuration description: Delete an existing external RADIUS server configuration by ID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_delete_external_radius_server_configuration operationId: deleteExternalRadiusServer parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /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: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/limit' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PagedXiqRadsecProxy' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] 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 name_format: NAI operator_name_type: WBAID operator_name: SP.Extreme:CA realms: - name: DEFAULT enable_strip_realm_name: false external_radius_server_object_ids: - 1000 - 1001 required: true responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/XiqRadsecProxy' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /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_radius_proxy_configuration_by_id operationId: getRadsecProxy parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqRadsecProxy' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] 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_radius_proxy_configuration operationId: updateRadsecProxy parameters: - $ref: '#/components/parameters/id' requestBody: description: The body of update RADSEC proxy API content: application/json: schema: $ref: '#/components/schemas/XiqUpdateRadsecProxyRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqRadsecProxy' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] 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_radius_proxy_configuration operationId: deleteRadsecProxy parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /certificates: get: tags: - Configuration - Certificate summary: List certificates description: List a page of certificates. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_list_certificates operationId: listCertificates parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/limit' - 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' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /certificates/import: post: tags: - Configuration - Certificate summary: Import Certificate description: Import a Certificate. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_import_certificate operationId: importCertificate requestBody: description: The body to import Certificate. content: multipart/form-data: schema: $ref: '#/components/schemas/XiqImportCertRequest' required: true responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/XiqCertificate' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /certificates/{id}: delete: tags: - Configuration - Certificate summary: Delete Certificate description: Delete an existing Certificate by ID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_delete_certificate operationId: deleteCertificate parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /certificate-bundles: get: tags: - Configuration - Certificate summary: List Certificate Bundles description: List a page of Certificate Bundle configurations. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_list_the_certificate_bundle_configuration operationId: listCertificateBundles parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/limit' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PagedXiqCertificateBundle' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] post: tags: - Configuration - Certificate summary: Create Certificate Bundle description: Create a new Certificate Bundle configuration. 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 a Certificate Bundle. content: application/json: schema: $ref: '#/components/schemas/XiqCreateCertBundleRequest' required: true responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/XiqCertificateBundle' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /certificate-bundles/{id}: get: tags: - Configuration - Certificate summary: Get the Certificate Bundle description: Get an existing Certificate Bundle configuration by ID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_the_certificate_bundle_by_id operationId: getCertificateBundle parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqCertificateBundle' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] put: tags: - Configuration - Certificate summary: Update Certificate Bundle description: Update Certificate Bundle configuration by ID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_update_certificate_configuration operationId: updateCertificateBundle parameters: - $ref: '#/components/parameters/id' requestBody: description: The request body to updated Certificate Bundle, content: application/json: schema: $ref: '#/components/schemas/XiqUpdateCertBundleRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqCertificateBundle' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] delete: tags: - Configuration - Certificate summary: Delete the Certificate Bundle description: Delete an existing Certificate Bundle configuration by ID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_delete_certificate_bundle operationId: deleteCertificateBundle parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /copilot/connectivity/wireless/experience: get: tags: - Copilot - Connectivity Experience summary: List Wireless Connectivity Experiences description: List a page of Quality-Index trends by selected view type. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_wireless_experience operationId: getWirelessExperience parameters: - $ref: '#/components/parameters/wirelessViewType' - $ref: '#/components/parameters/startTime' - $ref: '#/components/parameters/endTime' - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/sortField' - $ref: '#/components/parameters/sortOrder' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqCopilotConnectivityExperience' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /copilot/connectivity/wired/experience: get: tags: - Copilot - Connectivity Experience summary: List Wired Connectivity Experiences description: List a page of Quality-Index trends by selected view type. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_wired_experience operationId: getWiredExperience parameters: - $ref: '#/components/parameters/wiredViewType' - $ref: '#/components/parameters/startTime' - $ref: '#/components/parameters/endTime' - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/sortField' - $ref: '#/components/parameters/sortOrder' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqCopilotConnectivityExperience' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /copilot/connectivity/wired/quality-index: get: tags: - Copilot - Connectivity Experience summary: Get Wired Connectivity QualityIndex description: Get Quality-Index for a specific view type. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_wired_quality_index operationId: getWiredQualityIndex parameters: - $ref: '#/components/parameters/wiredViewType' - $ref: '#/components/parameters/wiredViewIdentifier' - $ref: '#/components/parameters/forensicBucket' - $ref: '#/components/parameters/startTime' - $ref: '#/components/parameters/endTime' - $ref: '#/components/parameters/locationId' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqCopilotWiredQualityIndex' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /copilot/connectivity/wired/events: get: tags: - Copilot - Connectivity Experience summary: List Wired Connectivity Events description: List a page of wired events over a selected period of time. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_wired_events operationId: getWiredEvents parameters: - $ref: '#/components/parameters/wiredViewType' - $ref: '#/components/parameters/wiredViewIdentifier' - $ref: '#/components/parameters/wiredScoreType' - $ref: '#/components/parameters/forensicBucket' - $ref: '#/components/parameters/startTime' - $ref: '#/components/parameters/endTime' - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/wiredSortField' - $ref: '#/components/parameters/sortOrder' - $ref: '#/components/parameters/searchKey' - $ref: '#/components/parameters/timestamp' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqCopilotWiredEvents' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /copilot/connectivity/locations: get: tags: - Copilot - Connectivity Experience summary: Get Connectivity By Locations description: Get Connectivity details by Locations in a Table with pagination & sorting. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_connectivity_by_locations operationId: getConnectivityDetailsByLocations parameters: - $ref: '#/components/parameters/startTime' - $ref: '#/components/parameters/endTime' - $ref: '#/components/parameters/locationId' - $ref: '#/components/parameters/searchKey' - $ref: '#/components/parameters/clientType' - $ref: '#/components/parameters/qualityIndex' - $ref: '#/components/parameters/forensicBucket' - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/sortField' - $ref: '#/components/parameters/sortOrder' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqCopilotConnectivityByLocations' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /copilot/connectivity/client-type: get: tags: - Copilot - Connectivity Experience summary: Get Connectivity By Client Type description: Get Connectivity details by client type in the widgets. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_connectivity_by_client_type operationId: getConnectivityDetailsByClientType parameters: - $ref: '#/components/parameters/startTime' - $ref: '#/components/parameters/endTime' - $ref: '#/components/parameters/locationId' - $ref: '#/components/parameters/clientType' - $ref: '#/components/parameters/qualityIndex' - $ref: '#/components/parameters/forensicBucket' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqCopilotConnectivityByClientType' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /copilot/connectivity/wireless/locations/quality-index: get: tags: - Copilot - Connectivity Experience summary: Get Wireless QualityIndex By Locations description: Get Quality-Index for a specific view type. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_wireless_quality_index_by_locations operationId: getWirelessQualityIndexByLocations parameters: - $ref: '#/components/parameters/startTime' - $ref: '#/components/parameters/endTime' - $ref: '#/components/parameters/forensicBucket' - $ref: '#/components/parameters/viewId' - $ref: '#/components/parameters/ssid' - $ref: '#/components/parameters/osType' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqCopilotWirelessQualityIndexByLocation' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /copilot/connectivity/wireless/locations/time-to-connect: get: tags: - Copilot - Connectivity Experience summary: Get Wireless Time-To-Connect By Locations description: List a page of Time-To-Connect score data over a selected period of time. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_wireless_time_to_connect_by_locations operationId: getWirelessTimeToConnectByLocations parameters: - $ref: '#/components/parameters/startTime' - $ref: '#/components/parameters/endTime' - $ref: '#/components/parameters/forensicBucket' - $ref: '#/components/parameters/viewId' - $ref: '#/components/parameters/ssid' - $ref: '#/components/parameters/osType' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqCopilotTimeToConnect' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /copilot/connectivity/wireless/locations/performance: get: tags: - Copilot - Connectivity Experience summary: Get Wireless Connectivity Performance By Locations description: List a page of Performance score data over a selected period of time. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_wireless_performance_by_locations operationId: getWirelessPerformanceByLocations parameters: - $ref: '#/components/parameters/startTime' - $ref: '#/components/parameters/endTime' - $ref: '#/components/parameters/forensicBucket' - $ref: '#/components/parameters/viewId' - $ref: '#/components/parameters/ssid' - $ref: '#/components/parameters/osType' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqCopilotPerformance' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /copilot/connectivity/wireless/locations/events: get: tags: - Copilot - Connectivity Experience summary: List Wireless Connectivity Events By Locations description: List a page of wireless events over a selected period of time. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_wireless_events_by_locations operationId: getWirelessEventsByLocations parameters: - $ref: '#/components/parameters/startTime' - $ref: '#/components/parameters/endTime' - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/wirelessSortField' - $ref: '#/components/parameters/sortOrder' - $ref: '#/components/parameters/wirelessScoreType' - $ref: '#/components/parameters/forensicBucket' - $ref: '#/components/parameters/searchKey' - $ref: '#/components/parameters/viewId' - $ref: '#/components/parameters/timestamp' - $ref: '#/components/parameters/ssid' - $ref: '#/components/parameters/osType' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqCopilotWirelessEvents' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /copilot/connectivity/wired/locations/hardware: get: tags: - Copilot - Connectivity Experience summary: Get Wired - Hardware By Locations description: List a page of hardware score data over a selected period of time and total ports with affected. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_wired_hardware_by_location operationId: getWiredHardwareByLocation parameters: - $ref: '#/components/parameters/wiredViewType' - $ref: '#/components/parameters/wiredViewIdentifier' - $ref: '#/components/parameters/forensicBucket' - $ref: '#/components/parameters/startTime' - $ref: '#/components/parameters/endTime' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqCopilotHardwareByLocation' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /copilot/anomalies/poeflapping/stats: get: tags: - Copilot - Anomalies summary: Get POE Flapping Anomaly Device Stats description: Get all the stats for anomaly device. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_copilot_anomaly_device_stats operationId: getCopilotAnomalyDeviceStats parameters: - $ref: '#/components/parameters/anomalyId' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqCopilotPoeFlappingStats' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /copilot/anomalies/port-efficiency/stats: get: tags: - Copilot - Anomalies summary: Get PortEfficiency Device Stats description: Get all the stats for PortEfficiency device. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_copilot_portefficiency_device_stats operationId: getCopilotPortEfficiencyDeviceStats parameters: - $ref: '#/components/parameters/anomalyId' - $ref: '#/components/parameters/offsetTime' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqCopilotPortEfficiencyStats' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /copilot/anomalies/port-efficiency/speed-duplex-stats: get: tags: - Copilot - Anomalies summary: Get PortEfficiency Device Speed and Duplex Stats description: Get all the speed and duplex for PortEfficiency device. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_copilot_portefficiency_device_speed_duplex operationId: getCopilotPortEfficiencyDeviceSpeedDuplex parameters: - $ref: '#/components/parameters/anomalyId' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqCopilotPortEfficiencySpeedDuplex' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /copilot/anomalies/dfs-recurrence/count-stats: get: tags: - Copilot - Anomalies summary: Get DFSRecurrence Device Channel Count Stats description: Get DFS Recurrence anomaly radar event count stats. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_copilot_dfsrecurrence_countstats operationId: getCopilotDfsRecurrenceCountStats parameters: - $ref: '#/components/parameters/anomalyId' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqCopilotDfsRecurrenceCountStats' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /copilot/anomalies/dfs-recurrence/channel-stats: get: tags: - Copilot - Anomalies summary: Get DFSRecurrence Device Channel Change Stats description: Get DFS Recurrence anomaly device channel change stats. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_copilot_dfsrecurrence_channelstats operationId: getCopilotDfsRecurrenceChannelStats parameters: - $ref: '#/components/parameters/anomalyId' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqCopilotDFSRecurrenceChannelStats' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /copilot/anomalies/adverse-traffic/device-stats: get: tags: - Copilot - Anomalies summary: Get Adverse Traffic Pattern Anomaly Device Stats description: Get all the stats for anomaly device. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_copilot_anomaly_adverse-traffic_device-stats operationId: getCopilotAnomalyAtpDeviceStats parameters: - $ref: '#/components/parameters/anomalyId' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqCopilotATPDeviceStats' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /copilot/anomalies/adverse-traffic/packet-counts: get: tags: - Copilot - Anomalies summary: Get Adverse Traffic Pattern Anomaly Packet Counts description: Get all the stats for anomaly device. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_copilot_anomaly_adverse-traffic_packet-counts operationId: getCopilotAnomalyAtpPacketCounts parameters: - $ref: '#/components/parameters/anomalyId' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqCopilotATPPacketCounts' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /copilot/anomalies/wifi-efficiency/stats: get: tags: - Copilot - Anomalies summary: Get WifiEfficiency Device Stats description: Get all the stats for WifiEfficiency device. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_copilot_wifiefficiency_stats operationId: getCopilotWifiEfficiencyStats parameters: - $ref: '#/components/parameters/anomalyId' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqCopilotWifiEfficiencyStats' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /copilot/anomalies/wifi-efficiency/client-list: get: tags: - Copilot - Anomalies summary: Get WifiEfficiency contributing client list description: Get all the client list for WifiEfficiency device. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_copilot_wifiefficiency_client-list operationId: getCopilotWifiEfficiencyClientlist parameters: - $ref: '#/components/parameters/deviceId' - $ref: '#/components/parameters/channelNumber' - $ref: '#/components/parameters/timestamp1' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqCopilotWifiEfficiencyClientlist' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /copilot/anomalies/wifi-capacity/stats: get: tags: - Copilot - Anomalies summary: Get WifiCapacity Device Stats description: Get all the stats for WifiCapacity device. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_copilot_wificapacity_stats operationId: getCopilotWifiCapacityStats parameters: - $ref: '#/components/parameters/anomalyId' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqCopilotWifiCapacityStats' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /copilot/anomalies/wifi-capacity/client-list: get: tags: - Copilot - Anomalies summary: Get WifiCapacity contributing client list description: Get all the client list for WifiCapacity device. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_copilot_wificapacity_client-list operationId: getCopilotWifiCapacityClientList parameters: - $ref: '#/components/parameters/deviceId' - $ref: '#/components/parameters/channelNumber' - $ref: '#/components/parameters/timestamp1' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqCopilotWifiCapacityClientlist' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /copilot/assurance-scans/overview: get: tags: - Copilot - Anomalies summary: Get AssuranceScans for all anomaly devices description: Get all assuranceScans data for a given location. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_copilot_assurancescans_overview operationId: getCopilotAssuranceScansOverview responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqCopilotAssuranceScansOverview' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /copilot/anomalies/devices/feedback: put: tags: - Copilot - Anomalies summary: Update Anomalies Feedback description: Update and save Anomaly Feedback. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_put_copilot_anomaly_devices_feedback operationId: putCopilotAnomalyDevicesFeedback requestBody: description: The body of update feedback content: application/json: schema: $ref: '#/components/schemas/XiqAnomaliesFeedbackRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqCopilotAnomaliesSuccess' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /copilot/anomalies/anomalies-by-category: get: tags: - Copilot - Anomalies summary: Get Anomalies by Categories description: Get all anomalies for a given viewType. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_copilot_anomaly_anomalies-by-category operationId: getCopilotAnomaliesbyCategory parameters: - $ref: '#/components/parameters/startTime1' - $ref: '#/components/parameters/endTime1' - $ref: '#/components/parameters/buildingId' - $ref: '#/components/parameters/severity' - $ref: '#/components/parameters/anomalyType' - $ref: '#/components/parameters/muted' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqCopilotAnomaliesByCategory' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /copilot/anomalies/devices-with-locations: get: tags: - Copilot - Anomalies summary: Devices with Locations description: Get all devices for all the anomalies and locations. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_copilot_anomaly_devices_with_locations operationId: getCopilotDevicesWithLocations parameters: - $ref: '#/components/parameters/startTime1' - $ref: '#/components/parameters/endTime1' - $ref: '#/components/parameters/buildingId' - $ref: '#/components/parameters/severity' - $ref: '#/components/parameters/anomalyType' - $ref: '#/components/parameters/muted' - $ref: '#/components/parameters/sortField1' - $ref: '#/components/parameters/sortOrder' - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/searchKey' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqCopilotAnomaliesDevicesWithLocation' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /copilot/anomalies/update-device-action: put: tags: - Copilot - Anomalies summary: Update Devices Action description: Update & save action for Anomaly devices. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#update_copilot_anomalies_devices_action operationId: updateCopilotAnomaliesDevicesAction parameters: - $ref: '#/components/parameters/async' requestBody: description: The body of update devices content: application/json: schema: $ref: '#/components/schemas/XiqUpdateAnomaliesAndDevicesRequest' required: true responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /copilot/anomalies/report: get: tags: - Copilot - Anomalies summary: Download Anomalies Report description: Download all devices and locations for all the anomalies. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_copilot_anomaly_download_report operationId: getAnomaliesReport parameters: - $ref: '#/components/parameters/startTime1' - $ref: '#/components/parameters/endTime1' - $ref: '#/components/parameters/buildingId' - $ref: '#/components/parameters/severity' - $ref: '#/components/parameters/anomalyType' - $ref: '#/components/parameters/muted' - $ref: '#/components/parameters/sortField1' - $ref: '#/components/parameters/sortOrder' - $ref: '#/components/parameters/searchKey' - $ref: '#/components/parameters/fileType' - $ref: '#/components/parameters/offsetTime' responses: '200': description: OK content: text/csv: schema: $ref: '#/components/schemas/XiqCopilotAnomaliesReport' application/pdf: schema: $ref: '#/components/schemas/XiqCopilotAnomaliesReport' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /copilot/anomalies/poeflapping/trends: get: tags: - Copilot - Anomalies summary: Get POE Flapping Anomaly Device Power Mode Trends description: Get all the poe trends for anomalous device. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_copilot_anomaly_poe-flapping_trends operationId: getPoeFlappingTrends parameters: - $ref: '#/components/parameters/anomalyId' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqPoeTrendGraphsResponse' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /copilot/anomalies/poeflapping/lldp-cdp-info: get: tags: - Copilot - Anomalies summary: Get anomalous device lldp cdp Info details description: Get LLDP-CDP information and location details for anomalous devices. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_copilot_anomaly_poe-flapping_lldp-cdp-info operationId: getLldpCdpInfo parameters: - $ref: '#/components/parameters/anomalyId' - $ref: '#/components/parameters/deviceId' - $ref: '#/components/parameters/lastDetectedTime' - $ref: '#/components/parameters/anomalyType' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqCopilotLldpCdpInfo' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /copilot/anomalies/excluded-vlans-list: get: tags: - Copilot - Anomalies summary: Get Excluded Vlan List description: Get Excluded vlans details with Site details. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_exceptional_vlan_list operationId: getCopilotExceptionalVlanList parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/limit' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqCopilotExceptionalVlanList' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /copilot/anomalies/exclude-vlans: post: tags: - Copilot - Anomalies summary: Excluding Vlan from Sites description: Add, Update, Delete excluded vlan from sites. operationId: excludeSitesVlan externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_exclude_sites_vlan requestBody: description: Excluding vlan from sites request body content: multipart/json: schema: type: object required: - excludeSitesVlanRequest - old_vlan_id - action_type - dismiss properties: excludeSitesVlanRequest: type: object description: excluded sites vlan details. required: - excluded_vlan_details properties: excluded_vlan_details: type: array items: $ref: '#/components/schemas/XiqCopilotVlanDetailsEntity' old_vlan_id: type: integer format: int32 action_type: $ref: '#/components/schemas/XiqCopilotActionType' dismiss: type: boolean responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /copilot/anomalies/exclude-vlans-csv: post: tags: - Copilot - Anomalies summary: Excluding Vlan from Sites - CSV description: Add excluded vlan from sites using CSV. operationId: excludeSitesVlanCsv externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_exclude_sites_vlan_csv parameters: - name: action_type in: query description: The type of action to perform (add) required: true schema: $ref: '#/components/schemas/XiqCopilotActionType' - name: dismiss in: query description: Whether to dismiss the action after execution required: true schema: type: boolean requestBody: description: Excluding vlan from sites request body using CSV content: multipart/form-data: schema: type: object required: - csv_file properties: csv_file: type: string format: binary responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /copilot/anomalies/missing-vlan/count: get: tags: - Copilot - Anomalies summary: Get MissingVlan Anomalies Count description: MissingVlan anomaly count for specified vlanIds and siteIds. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_copilot_anomaly_missing-vlan_count operationId: getCopilotAnomalyMissingVlanCount parameters: - $ref: '#/components/parameters/startTimeCount' - $ref: '#/components/parameters/endTimeCount' - $ref: '#/components/parameters/vlanIds' - $ref: '#/components/parameters/siteIds' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqCopilotMissingVlanCount' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /copilot/anomalies/hardware-health/stats: get: tags: - Copilot - Anomalies summary: Get HardwareHealth Anomaly Stats description: Get all the stats for anomaly device. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_copilot_anomaly_hardware-health_stats operationId: getCopilotAnomalyHardwareHealthStats parameters: - $ref: '#/components/parameters/anomalyId' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqCopilotHardwareHealthStats' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /copilot/anomalies/hardware-health/client-list: get: tags: - Copilot - Anomalies summary: Get HardwareHealth contributing client list description: Get all the client list for HardwareHealth device. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_copilot_hardware-health_client-list operationId: getCopilotHardwareHealthClientList parameters: - $ref: '#/components/parameters/deviceId' - $ref: '#/components/parameters/timestamp1' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqCopilotHardwareHealthClientlist' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /copilot/anomalies/hardware-health/cpu-mem-stats: get: tags: - Copilot - Anomalies summary: Get HardwareHealth CPU & Memory Stats description: Get CPU or memory details for HardwareHealth device. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_copilot_hardware-health_cpu_mem_stats operationId: getCopilotHardwareHealthCpuMemStats parameters: - $ref: '#/components/parameters/deviceId' - $ref: '#/components/parameters/hhStatsFieldType' - $ref: '#/components/parameters/timestamp1' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqCopilotHardwareHealthCpuMemStats' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /packetcaptures: get: tags: - PacketCaptures summary: List packet capture sessions operationId: listPacketCaptures description: List packet capture sessions with filters and pagination. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_list_packet_captures parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/limit' - 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: sortField in: query description: Sort field. Available values - NAME, START_TIME and STATUS required: false schema: type: string enum: - NAME - START_TIME - STATUS - $ref: '#/components/parameters/order' - 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' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] post: tags: - PacketCaptures summary: Create a new packet capture session operationId: createPacketCapture 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 requestBody: content: application/json: schema: $ref: '#/components/schemas/XiqPacketCapture' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqPacketCapture' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /packetcaptures/{id}: get: tags: - PacketCaptures summary: Get a packet capture session by ID operationId: getPacketCapture description: Get a packet capture session by id. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_packet_capture parameters: - $ref: '#/components/parameters/id' - 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' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] delete: tags: - PacketCaptures summary: Delete a packet capture session operationId: deletePacketCapture 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 parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /packetcaptures/{id}/:stop: post: tags: - PacketCaptures summary: Stop a packet capture session operationId: stopPacketCapture description: Stop an active packet capture session. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_stop_active_packet_capture parameters: - $ref: '#/components/parameters/id' requestBody: content: application/json: schema: $ref: '#/components/schemas/XiqCaptureStopRequest' required: true responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /packetcaptures/{id}/:upload: post: tags: - PacketCaptures summary: Upload a packet capture session's capture files operationId: uploadPacketCaptureFiles 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_captures_capture_files parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /packetcaptures/files: get: tags: - PacketCaptures summary: Get an AP packet capture file operationId: getPacketCaptureFile 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 parameters: - name: cloudFileUrl in: query description: The packet capture file path required: true schema: type: string responses: '200': description: Returns requested packet capture file. content: application/octet-stream: schema: type: string description: Packet capture file format: binary default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /essentials/eloc/clients/{clientMac}/last-known-location: get: tags: - Essentials - ExtremeLocation summary: Get the last known location of the client description: Get the last known location of the client on the floor plan. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_eloc_clients_lastknown_location_by_macAddress_for_one_client operationId: elocLastKnownClientLocation parameters: - $ref: '#/components/parameters/mac' - $ref: '#/components/parameters/floorId' - $ref: '#/components/parameters/parentId' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqEssentialsElocClientLastknownLocation' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /countries: get: tags: - Misc summary: Get country list description: Get list of countries and country codes. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_country_list operationId: getCountryList responses: '200': description: OK content: application/json: schema: type: array $ref: '#/components/schemas/XiqCountry' default: $ref: '#/components/responses/ErrorResponse' security: [] /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 default: $ref: '#/components/responses/ErrorResponse' security: [] /countries/{countryAlpha2Code}/states: get: tags: - Misc summary: Get state list in a country 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_list_of_states_in_a_country operationId: getStateListByCountryCode parameters: - name: countryAlpha2Code in: path description: The country ISO 2-letter code. required: true schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqCountryState' default: $ref: '#/components/responses/ErrorResponse' security: [] /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: minimum: 1 type: integer format: int32 default: 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: maximum: 100 minimum: 1 type: integer format: int32 default: 10 - 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' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /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: $ref: '#/components/schemas/XiqThreadRouterField' - name: routerViews in: query description: The views to return thread router fields required: false schema: type: array items: $ref: '#/components/schemas/XiqThreadRouterField' - 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' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /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: minimum: 1 type: integer format: int32 default: 1 - name: limit in: query description: Page Size, min = 1, max = 100 required: false schema: maximum: 100 minimum: 1 type: integer format: int32 default: 10 - name: sortField in: query description: The sort field required: false schema: $ref: '#/components/schemas/ThreadRouterSortField' - name: sortOrder in: query description: The sort order (ascending by default) required: false schema: $ref: '#/components/schemas/XiqSortOrder' - name: views in: query description: The views to return thread router fields required: false schema: type: array items: $ref: '#/components/schemas/XiqThreadRouterView' - name: fields in: query description: The thread router fields to return required: false schema: type: array items: $ref: '#/components/schemas/XiqThreadRouterField' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PagedXiqThreadRouter' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /afcserver: get: tags: - AFC summary: Get list of AFC Servers description: Get list of AFC Servers. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_list_afc_servers operationId: listAfcServers parameters: - $ref: '#/components/parameters/ownerId' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqListAfcServers' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /afcserver/statistics/{server_id}: get: tags: - AFC 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 - 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' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /ap/afc/interface/details/{sn}: get: tags: - AFC summary: Get AP Interface status description: Get AP Interface status info. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_afc_ap_interface_details operationId: getAfcApDetails parameters: - $ref: '#/components/parameters/sn' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqAfcApInterfaceDetails' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /afc/recalculateSite/{id}: post: tags: - AFC summary: AFC Recalculate Geolocation description: Recalculate geolocation for site. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_recalculate_afc_site operationId: recalculateSite parameters: - name: id in: path description: The device id required: true schema: type: integer format: int64 responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /afc/aps/reportFtm: post: tags: - AFC summary: Request FTM data for APs description: Request FTM data for a list of Access Points. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_request_ftm_data 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 default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /afc/aps/status/summary: get: tags: - AFC summary: AFC AP status Summary description: AFC Status summary of AP channels and powers query. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_afc_ap_status_stats operationId: getAfcApsStatusSummary responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqAfcApStatusSummary' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /floor/afc/details: get: tags: - AFC summary: Get AFC Floor Details description: Retrieve AFC related floor height and accuracy data for a specific floor. operationId: getFloorAfcProperties parameters: - $ref: '#/components/parameters/ownerId' - name: floorId in: query description: The Id of the floor required: true schema: type: integer format: int64 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqAfcFloorDetails' security: - BearerAuth: [] post: tags: - AFC summary: Add AFC Floor Details description: Create new AFC related floor height and accuracy data for a floor. operationId: addFloorAfcProperties requestBody: description: Floor AFC related properties body content: application/json: schema: $ref: '#/components/schemas/XiqAfcFloorDetails' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqAfcFloorDetails' security: - BearerAuth: [] put: tags: - AFC summary: Update AFC Floor Details description: Update existing AFC related floor height and accuracy data for a floor. operationId: updateFloorAfcProperties requestBody: description: Floor AFC related properties body content: application/json: schema: $ref: '#/components/schemas/XiqAfcFloorDetails' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqAfcFloorDetails' security: - BearerAuth: [] /aps/afc/query: get: tags: - AFC summary: Query AFC APs description: Retrieve AFC summary information for access points including status, geolocation, and spectrum mismatch data. operationId: getApsAfcSummaryInfo parameters: - $ref: '#/components/parameters/ownerId' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqAfcApsInfoElement' security: - BearerAuth: [] post: tags: - AFC summary: Query AFC APs description: Retrieve AFC summary information for access points including status, geolocation, and spectrum mismatch data. operationId: getApsAfcSummaryInfoWithFilter parameters: - $ref: '#/components/parameters/ownerId' requestBody: content: application/json: schema: type: object properties: site_ids: description: List of site IDs to filter the device list type: array items: type: integer format: int64 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqAfcApsInfoElement' security: - BearerAuth: [] /ap/afc/diagnostics/{id}: get: tags: - AFC summary: Get AFC AP Diagnostics description: Retrieve AFC diagnostics information. operationId: getApsAfcDiagnostics parameters: - $ref: '#/components/parameters/ownerId' - name: id in: path description: device id required: true schema: type: integer format: int64 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqAfcApDiagnostics' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /ap/afc/floorReport/{deviceId}: get: summary: Get AFC Floor Report description: Retrieves the AFC geolocation floor report for a specific device. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_afc_geolocation_floor_report operationId: getAfcGeolocationFloorReport tags: - AFC 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' example: floor_report: Floor geolocation report data for AFC calculations security: - BearerAuth: [] /aps/afc/update: post: tags: - AFC summary: Request Manual Spectrum for device(s) description: Manual Spectrum request for device(s). operationId: postApsManualAfcSpectrum requestBody: description: AFC site schedule request body content: application/json: schema: $ref: '#/components/schemas/XiqAfcApManualSpectrum' required: true responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /site/afc/schedule: get: tags: - AFC summary: Get AFC Site Schedule description: Get AFC site update settings. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_afc_site_schedule operationId: getAfcSiteSchedule parameters: - $ref: '#/components/parameters/ownerId' - $ref: '#/components/parameters/folderId' responses: '200': description: OK content: application/json: schema: type: array items: $ref: '#/components/schemas/XiqAfcSiteScheduleResponse' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] post: tags: - AFC summary: Create AFC Site Schedule description: Create AFC Site Schedule. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_add_afc_site_schedule operationId: addAfcSiteSchedule requestBody: description: The body of the Site Schedule content: application/json: schema: $ref: '#/components/schemas/XiqAfcSiteSchedule' required: true responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] put: tags: - AFC summary: Update AFC SiteSchedule description: Update AFC SiteSchedule. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_update_afc_site_schedule operationId: updateAfcSiteSchedule requestBody: description: The body of the Site Schedule content: application/json: schema: $ref: '#/components/schemas/XiqAfcSiteSchedule' required: true responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /afc/mobileapp/apcandidates: post: tags: - AFC summary: Find potential AP candidates to be used as anchor description: Find potential AP candidates to be used as anchor. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_afc_mobileapp_apcandidates operationId: afcMobileappApCandidates requestBody: content: application/json: schema: $ref: '#/components/schemas/XiqAfcMobileappScanInfo' responses: '200': description: List of AP candidates that may be used as anchors content: application/json: schema: $ref: '#/components/schemas/XiqMobileappAnchorCandidatesResponse' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /ucp/{id}/engines/installed: get: tags: - Universal Compute Platform summary: Get list of all installed engines for a UCP device description: Retrieve the list of installed engines from a connected UCP device. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_ucp_engines_installed operationId: getDeviceUcpEnginesInstalled parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqUcpEnginesInstalled' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /acct-api-token: get: tags: - Administration summary: List API Access Tokens description: List tokens to which API Access has been granted. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_list_acct_api_access_tokens operationId: listApiAccessToken parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/limit' - name: sortField in: query description: The field for sorting required: false schema: type: string - name: searchString in: query description: The SearchString required: false schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PagedXiqApiAccessToken' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] post: tags: - Administration summary: Add API Access token description: Create a API token. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_create_acct_api_access_token operationId: createApiAccessToken requestBody: description: The request body to create new API Access token. content: application/json: schema: $ref: '#/components/schemas/XiqCreateApiAccessTokenRequest' required: true responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/XiqApiAccessTokenResponse' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /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: - $ref: '#/components/parameters/id' responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] patch: tags: - Administration summary: Update API Access token description: Update API token by ID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_update_acct_api_access_token operationId: updateApiAccessToken parameters: - $ref: '#/components/parameters/id' requestBody: description: The request body to update new API Access token. content: application/json: schema: $ref: '#/components/schemas/XiqUpdateApiAccessTokenRequest' required: true responses: '201': description: Updated content: application/json: schema: $ref: '#/components/schemas/XiqApiAccessToken' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /acct-api-token_:delete: delete: tags: - Administration summary: Bulk Delete API Access Token by ID description: Bulk Delete existing API Access Tokens by the specified IDs. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_bulk_delete_api_access_token_by_id operationId: bulkDeleteApiAccessToken parameters: - name: ids description: The API Access Token ids to delete. in: query required: true schema: uniqueItems: true type: array items: type: integer format: int64 responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /third-party-api-connection: get: tags: - Administration summary: List 3rd party API connection description: List the 3rd party API connection. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_list_third_party_api_connections operationId: list1 responses: '200': description: OK content: application/json: schema: type: array items: $ref: '#/components/schemas/XiqThirdPartyApiConnection' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] put: tags: - Administration summary: Update 3rd party API connection description: Update the 3rd party API connection. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_update_third_party_api_connection operationId: updateSubscription1 requestBody: description: The payload to update 3rd party API connections content: application/json: schema: $ref: '#/components/schemas/XiqUpdateThirdPartyApiConnectionRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqThirdPartyApiConnection' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] delete: tags: - Administration summary: Delete 3rd party API connection description: Delete an exist 3rd party API connection. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_delete_third_party_api_connection operationId: deleteSubscription1 responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /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: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/limit' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PagedXiqCredentialDistributionGroup' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] post: tags: - Administration summary: Create Credential Distribution Group description: Create a new Credential Distribution Groups. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_create_credential_distribution_group operationId: createCredentialDistributionGroup requestBody: description: The request body to create new Credential Distribution Groups. content: application/json: schema: $ref: '#/components/schemas/XiqCreateCredentialDistributionGroupRequest' required: true responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/XiqCredentialDistributionGroup' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /credential-distribution-groups/{id}: put: tags: - Administration summary: Update Credential Distribution Group description: Update a existing Credential Distribution Group by the specified ID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_update_credential_distribution_group_by_id operationId: updateCredentialDistributionGroup parameters: - $ref: '#/components/parameters/id' requestBody: description: The request body to update new Credential Distribution Groups. content: application/json: schema: $ref: '#/components/schemas/XiqUpdateCredentialDistributionGroupRequest' required: true responses: '200': description: Created content: application/json: schema: $ref: '#/components/schemas/XiqCredentialDistributionGroup' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /credential-distribution-groups_:delete: delete: tags: - Administration summary: Delete Credential Distribution Group by IDs description: Delete an existing Credential Distribution Group by the specified IDs. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_bulk_delete_credential_distribution_group_by_ids operationId: deleteCredentialDistributionGroup parameters: - name: ids description: The API Access Token ids to delete. in: query required: true schema: uniqueItems: true type: array items: type: integer format: int64 responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /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#_post_alert_diagnostics operationId: alertCountDashboard parameters: - name: alertsTimeRange in: query description: Alerts Time Range in days (defaults to 1 day) required: false schema: type: integer format: int32 minimum: 0 - name: include_unassigned in: query description: To include unassigned location required: false schema: type: boolean requestBody: required: false content: application/json: schema: type: object properties: site_ids: description: List of site IDs to filter the alerts type: array items: type: integer format: int64 responses: '200': description: Returns the counts of various alert types based on the filters content: application/json: schema: $ref: '#/components/schemas/XiqAlertsResponse' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /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#_post_asset_counts operationId: assetCountDashboard parameters: - name: include_unassigned in: query description: To include unassigned location required: false schema: type: boolean requestBody: required: false content: application/json: schema: type: object properties: site_ids: description: List of site IDs to filter the assets type: array items: type: integer format: int64 responses: '200': description: Returns the counts of various asset types based on the filters content: application/json: schema: $ref: '#/components/schemas/XiqAssetsResponse' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /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#_post_client_health operationId: clientHealthDashboard parameters: - name: include_unassigned in: query description: To include unassigned location required: false schema: type: boolean requestBody: required: false content: application/json: schema: type: object properties: site_ids: description: List of site IDs to filter the client health type: array items: type: integer format: int64 responses: '200': description: Returns the counts of clients, including unhealthy clients content: application/json: schema: $ref: '#/components/schemas/XiqClientHealthResponse' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /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#_post_device_health operationId: deviceHealthDashboard parameters: - name: include_unassigned in: query description: To include unassigned location required: false schema: type: boolean requestBody: required: false content: application/json: schema: type: object properties: site_ids: description: List of site IDs to filter the device health type: array items: type: integer format: int64 responses: '200': description: Returns the counts of devices, including offline devices content: application/json: schema: $ref: '#/components/schemas/XiqDeviceHealthResponse' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /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#_post_usage_and_capacity operationId: usageAndCapacityIssuesDashboard parameters: - name: include_unassigned in: query description: To include unassigned location required: false schema: type: boolean requestBody: required: false content: application/json: schema: type: object properties: site_ids: description: List of site IDs to filter the usage & capacity issues type: array items: type: integer format: int64 responses: '200': description: Returns the counts of usage & capacity issues based on the filters content: application/json: schema: $ref: '#/components/schemas/XiqUsageAndCapacityResponse' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /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#_post_sites_with_issues operationId: sitesWithIssuesDashboard parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/limit' - name: keyword in: query description: The site name filter required: false schema: type: string - name: sortField in: query description: The sort field required: false schema: $ref: '#/components/schemas/XiqSiteWithIssuesSortField' - name: sortOrder in: query description: The sort order required: false schema: $ref: '#/components/schemas/XiqSortOrder' - name: alertsTimeRange in: query description: Alerts Time Range in days (defaults to 1 day) required: false schema: type: integer format: int32 minimum: 0 default: 1 - name: include_unassigned in: query description: To include unassigned location required: false schema: type: boolean requestBody: required: false content: application/json: schema: type: object properties: site_ids: description: List of site IDs to filter the sites type: array items: type: integer format: int64 responses: '200': description: Returns the details of sites with issues based on the filters content: application/json: schema: $ref: '#/components/schemas/PagedXiqSitesWithIssuesResponse' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /dashboard/device_types: get: tags: - Dashboard summary: Dashboard device types description: Returns a list of diagnostics device types. operationId: dashboardDeviceTypes responses: '200': description: A list of diagnostics device types content: application/json: schema: type: object properties: device_types: type: array items: $ref: '#/components/schemas/XiqRmDiagnosticsDeviceType' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /dashboard/export: post: tags: - Dashboard summary: Export Sites with issues as CSV File description: Returns the site names along with alerts, usage and capacity, assets, client health, and device health based on the provided filters as CSV File. You can filter the results by sites. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_post_sites_with_issues_export operationId: sitesWithIssuesDashboardExport parameters: - name: keyword in: query description: The site name filter required: false schema: type: string - name: sortField in: query description: The sort field required: false schema: $ref: '#/components/schemas/XiqSiteWithIssuesSortField' - name: sortOrder in: query description: The sort order required: false schema: $ref: '#/components/schemas/XiqSortOrder' - name: alertsTimeRange in: query description: Alerts Time Range in days (defaults to 1 day) required: false schema: type: integer format: int32 minimum: 0 default: 1 - name: include_unassigned in: query description: To include unassigned location required: false schema: type: boolean requestBody: required: false content: application/json: schema: type: object properties: site_ids: description: List of site IDs to filter the sites type: array items: type: integer format: int64 responses: '202': description: Accepted - The request has been accepted for processing, but the processing has not been completed. headers: cache-control: description: Cache control directives schema: type: string content-length: description: The length of the response body in octets (8-bit bytes) schema: type: integer date: description: The date and time at which the message was originated schema: type: string format: date-time expires: description: The date/time after which the response is considered stale schema: type: string location: description: The URL to which the client should navigate to check the status of the request schema: type: string format: uri pragma: description: Implementation-specific directives that might apply to any recipient along the request-response chain schema: type: string ratelimit-limit: description: The maximum number of requests that the client is allowed to make in a given time period schema: type: string ratelimit-remaining: description: The number of requests remaining in the current rate limit window schema: type: integer retry-after: description: The amount of time to wait before making a follow-up request schema: type: integer server: description: A name for the server schema: type: string example: nginx x-content-type-options: description: Prevents the browser from interpreting files as a different MIME type schema: type: string x-xss-protection: description: Enables cross-site scripting (XSS) filter schema: type: string format: byte default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /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#_get_wireless_diagnostics_dashboard_criteria operationId: wirelessDiagnosticsDashboardCriteria responses: '200': description: Returns the criteria for wireless diagnostics dashboard content: application/json: schema: type: object properties: device_health_criteria_param: $ref: '#/components/schemas/XiqWirelessDeviceHealthCriteria' client_health_criteria_param: $ref: '#/components/schemas/XiqWirelessClientHealthCriteria' usage_capacity_criteria_param: $ref: '#/components/schemas/XiqWirelessUsageAndCapacityCriteria' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] post: tags: - Dashboard summary: Create 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#_post_wireless_diagnostics_dashboard_criteria operationId: createWirelessDiagnosticsDashboardCriteria requestBody: content: application/json: schema: type: object properties: device_health_criteria: type: object properties: cpu_utilization: type: integer format: float description: CPU Utilization percentage memory_utilization: type: integer format: float description: Memory Utilization percentage poe: type: integer format: float description: Power over Ethernet (PoE) usage wired_port_multicast: type: integer format: float description: Wired Port Multicast traffic percentage wired_port_broadcast: type: integer format: float description: Wired Port Broadcast traffic percentage client_health_criteria: type: object properties: assoc_param_slow: type: integer format: float description: Association parameter for slow connections assoc_unit_slow: type: string description: Unit for association parameter for slow connections auth_param_slow: type: integer format: float description: Authentication parameter for slow connections auth_unit_slow: type: string description: Unit for authentication parameter for slow connections dhcp_param_slow: type: integer format: float description: DHCP parameter for slow connections dhcp_unit_slow: type: string description: Unit for DHCP parameter for slow connections roams_param_slow: type: integer format: float description: Roaming parameter for slow connections roams_unit_slow: type: string description: Unit for roaming parameter for slow connections rssi_param: type: integer format: float description: RSSI parameter rssi_unit: type: string description: Unit for RSSI parameter snr_param: type: integer format: float description: SNR parameter snr_unit: type: string description: Unit for SNR parameter onboard_param: type: integer format: float description: Onboarding parameter onboard_unit: type: string description: Unit for onboarding parameter usage_capacity_criteria: type: object properties: channel_utilization: type: integer format: float description: Channel Utilization percentage lnk_err: type: integer format: float description: Link Error percentage retries: type: integer format: float description: Retries percentage pkt_loss: type: integer format: float description: Packet Loss percentage interference: type: integer format: float description: Interference percentage noise: type: integer format: float description: Noise level noise_unit: type: string description: Unit for Noise level responses: '200': description: Returns the criteria for wireless diagnostics dashboard content: application/json: schema: type: object properties: device_health_criteria_param: $ref: '#/components/schemas/XiqPostWirelessDeviceHealthCriteria' client_health_criteria_param: $ref: '#/components/schemas/XiqPostWirelessClientHealthCriteria' usage_capacity_criteria_param: $ref: '#/components/schemas/XiqPostWirelessUsageAndCapacityCriteria' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /dashboard/wireless/dashboard/reports/{id}: get: tags: - Dashboard summary: Download the Export CSV file description: Returns the CSV File of the Site With Issue status based on the provided filters. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_site_with_issue_report operationId: siteWithIssueGridExportReport parameters: - name: id in: path description: The report ID required: true schema: type: string responses: '200': description: Returns the CSV File of the Site With Issue grid content: application/octet-stream: schema: type: string default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /d360/wireless/surrounding-aps: post: tags: - D360 summary: Surrounding APs description: Get a list of surrounding APs. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_wireless_surrounding_aps operationId: surroundingAps parameters: - name: deviceId in: query description: The device ID required: true schema: type: integer format: int64 - $ref: '#/components/parameters/startTime' - $ref: '#/components/parameters/endTime' - $ref: '#/components/parameters/selectedTime' - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/limit' requestBody: required: false content: application/json: schema: type: object properties: numberFilters: type: object description: The number based column filters available(Available columns- Channel width, rssi, channel utilization %, number of clients ). properties: data: type: array items: $ref: '#/components/schemas/number_filter' ssids: description: The ssids available type: array items: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PagedRmSurroundingAps' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /d360/wireless/interfaces-stats: get: tags: - D360 summary: Wireless Interfaces Stats description: Get Statistics of wireless interfaces of a device. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_wireless_interfaces_stats operationId: wirelessInterfacesStats parameters: - name: deviceId in: query description: The device ID required: true schema: type: integer format: int64 - $ref: '#/components/parameters/startTime' - $ref: '#/components/parameters/endTime' - $ref: '#/components/parameters/selectedTime' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/RmWirelessInterfacesList' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /d360/overview/devices-summary: get: tags: - D360 summary: Get Device Summary description: List the summary of device details. externalDocs: description: API Reference url: http://extremecloudiq.com/api-docs/api-reference.html#_get_device_summary operationId: getDeviceSummary 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/RmDeviceSummary' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /d360/overview/devices-location: get: tags: - D360 summary: Get Device Geo Location description: Get the geographical location of device. externalDocs: description: API Reference url: http://extremecloudiq.com/api-docs/api-reference.html#_get_device_geo_location operationId: getDeviceGeoLocation 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/RmDeviceGeoLocation' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /d360/alert/graph: get: tags: - D360 summary: Alerts Graph description: List a list of alerts for Graphing API. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_alert_graph operationId: alertsGraph parameters: - $ref: '#/components/parameters/startTime' - $ref: '#/components/parameters/endTime' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/GraphResponse' /d360/client/graph: post: tags: - D360 summary: Client Graph description: List a list of connected clients for Graphing API of D360. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_client_graph operationId: clientsGraph parameters: - name: deviceId in: query description: The device ID required: true schema: type: integer format: int64 - $ref: '#/components/parameters/startTime' - $ref: '#/components/parameters/endTime' requestBody: required: true content: application/json: schema: type: object properties: filter_name: description: List of available filters for clients graph type: array items: $ref: '#/components/schemas/RmClientGraphFilterType' responses: '200': description: OK content: application/json: schema: type: array description: The graph response based on filters. items: $ref: '#/components/schemas/RmClientGraphResponse' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /d360/device-metadata: get: tags: - D360 summary: Device metadata description: The device metadata like timestamp from which device is online and location. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_connected_since operationId: connectedSince parameters: - name: deviceId in: query description: The device ID required: true schema: type: integer format: int64 - name: deviceType in: query description: The device type (wired/wireless) schema: $ref: '#/components/schemas/XiqDeviceType' responses: '200': description: OK content: application/json: schema: type: object properties: device_data: $ref: '#/components/schemas/RmDeviceData' device_path: type: object properties: folder_path_info: type: array items: $ref: '#/components/schemas/RmDevicePathInfo' network_policy: type: object description: The network policy attached to device properties: policy_id: description: The policy Id. type: integer format: int64 policy_name: description: The policy Name type: string default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /d360/installation/media: post: tags: - D360 summary: Installation Media-upload description: Upload installation media. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_upload_media operationId: uploadMedia requestBody: description: The request body to upload the installation media. content: application/json: schema: type: object properties: filePath: description: The path of the file(.png/.jpg or .mp4/.mov) type: string title: description: The title of the the file type: string fileDescription: description: The description of the file type: string responses: '200': description: Returns the response of the client health grid content: application/json: schema: $ref: '#/components/schemas/RmMediaUploadResponse' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] delete: tags: - D360 summary: Installation Media-delete description: Delete installation media. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_delete_media operationId: deleteMedia parameters: - name: mediaId in: query description: The id of the media file required: true schema: type: integer format: int64 responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /d360/wired/interface-grid: get: tags: - D360 summary: Wired Interfaces description: Wired Interfaces -Grid. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_wired_interfaces_grid operationId: wiredGrid parameters: - name: deviceId in: query description: The device ID required: true schema: type: integer format: int64 responses: '200': description: Returns the response of the wired interfaces grid content: application/json: schema: $ref: '#/components/schemas/RmWiredInterfaceGrid' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /d360/device/location: get: tags: - D360 summary: Device Location description: Retrieves the device location details on the map for the device. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_device_location operationId: deviceLocation parameters: - name: deviceId in: query description: The device ID required: true schema: type: integer format: int64 responses: '200': description: Returns the response of the device location content: application/json: schema: type: object properties: folder_id: type: integer description: Unique identifier for the folder. device_id: type: integer description: Unique identifier for the device. device_mac_address: type: string description: MAC address of the device. device_hostname: type: string description: Hostname of the device. device_type: type: string description: Type of the device. device_function: type: string description: Function of the device. x: type: number format: double description: X-coordinate of the device location. y: type: number format: double description: Y-coordinate of the device location. default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /d360/device/issues: get: tags: - D360 summary: Device Issues description: Retrieves the various issues for device. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_device_issues operationId: deviceIssues parameters: - name: deviceId in: query description: The device ID required: true schema: type: integer format: int64 responses: '200': description: Returns the response of the device issues content: application/json: schema: type: object properties: association_failures: type: integer description: The number of association failures. authentication_failures: type: integer description: The number of authentication failures. ip_address_issues: type: integer description: The number of IP Address issues. excessive_packet_loss_ap_count: type: integer format: int64 description: Count of APs with excessive packet loss default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /d360/device/stats: get: tags: - D360 summary: Device Stats description: Grid of Device Stats. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_wireless_interfaces_graph operationId: deviceStats parameters: - name: deviceId in: query description: The device ID required: true schema: type: integer format: int64 - $ref: '#/components/parameters/startTime' - $ref: '#/components/parameters/endTime' responses: '200': description: OK content: application/json: schema: type: array description: The graph response based on filters. items: $ref: '#/components/schemas/XiqDeviceHealthGridResponse' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /d360/wireless/interfaces-graph: get: tags: - D360 summary: Wireless Interfaces 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#_wireless_interfaces_graph operationId: wirelessInterfacesGraph parameters: - name: deviceId in: query description: The device ID required: true schema: type: integer format: int64 - $ref: '#/components/parameters/startTime' - $ref: '#/components/parameters/endTime' - name: channel in: query description: The channel filters. required: true schema: $ref: '#/components/schemas/RmChannelFilterType' - name: source in: query description: The source filters. required: true schema: $ref: '#/components/schemas/RmSourceFilterType' responses: '200': description: OK content: application/json: schema: type: array description: The graph response based on filters. items: $ref: '#/components/schemas/RmWirelessInterfacesGraphResponse' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /d360/client/stats: get: tags: - D360 summary: Client Stats description: Client statistics. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_client_stats operationId: clientStats parameters: - name: deviceId in: query description: The device ID required: true schema: type: integer format: int64 - $ref: '#/components/parameters/startTime' - $ref: '#/components/parameters/endTime' responses: '200': description: Returns the client statistics. content: application/json: schema: $ref: '#/components/schemas/RmClientStats' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /d360/device/interfaces: get: tags: - D360 summary: Wireless Interfaces per device description: List available wifi interfaces on device model. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_device_interfaces operationId: deviceInterfaces parameters: - name: deviceModel in: query description: The model of device required: true schema: $ref: '#/components/schemas/RmDevices' responses: '200': description: OK content: application/json: schema: type: array description: The available interfaces for the device. items: $ref: '#/components/schemas/RmDeviceInterfaces' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /d360/client/grid: get: tags: - D360 summary: Client Grid description: List a list of connected clients for Graphing API of D360. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_client_graph operationId: clientGrid parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/limit' - name: keyword in: query description: The keyword to search required: false schema: type: string - name: deviceId in: query description: The device ID required: true schema: type: integer format: int64 - $ref: '#/components/parameters/startTime' - $ref: '#/components/parameters/endTime' - $ref: '#/components/parameters/selectedTime' - name: clientStatus in: query description: The client statistics filter. required: false schema: type: array items: $ref: '#/components/schemas/RmClientStatisticsFilter' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PagedRmD360ClientGrid' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /d360/wireless/surrounding-aps/ssid-metadata: get: tags: - D360 summary: SSID metadata of surrounding APs description: Grid of Device Stats. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_ssid_metadata operationId: ssidMetadata parameters: - name: deviceId in: query description: The device ID required: true schema: type: integer format: int64 - $ref: '#/components/parameters/startTime' - $ref: '#/components/parameters/endTime' responses: '200': description: OK content: application/json: schema: type: array description: The available ssids of the surrounding APs of the device items: type: string default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /d360/event/graph: get: tags: - D360 summary: Events Graph description: Retrieve a time-series graph of event metrics. Each timestamp includes an array of event types with their respective counts. Only selected filters will be included in the response. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_event_graph operationId: eventsGraph parameters: - $ref: '#/components/parameters/startTime' - $ref: '#/components/parameters/endTime' - name: deviceId in: query description: The device ID required: true schema: type: integer format: int64 - name: filter in: query description: | Filter events by type. Only selected event types will be included in the response. Valid values: `CRITICAL`, `MAJOR`, `MINOR`, `INFO`, `ACTIVE`, `CLEARED`, `ALL`. required: false schema: type: array items: type: string enum: - CRITICAL - MAJOR - MINOR - INFO - ACTIVE - CLEARED - ALL uniqueItems: true example: - CRITICAL - MAJOR style: form explode: true responses: '200': description: OK content: application/json: schema: type: object description: The Graph metric response. properties: data: type: array description: List of event metrics grouped by timestamp. items: type: object 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: type: object properties: event_name: type: string enum: - CRITICAL - MAJOR - MINOR - INFO - ACTIVE - CLEARED - ALL description: The name of the event type. count: type: integer format: int64 description: Number of events of this type at the timestamp. /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: wiredQueueGrid parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/limit' - name: deviceId in: query description: The unique device identifier. It can be virtual slot id and all stack ports will be returned or a member slot id and only that slot ports will be returned. required: true schema: type: integer format: int64 responses: '200': description: Returns all QOS queue statistics for a wired device content: application/json: schema: $ref: '#/components/schemas/PagedRmWiredQueueGridResponse' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /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: wirelessClientHealthGrid parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/limit' - 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/XiqClientHealthSortField' - name: sortOrder in: query description: The sort order required: false schema: $ref: '#/components/schemas/XiqSortOrder' - name: connectionStatus in: query description: The current connection status of the client (e.g., connected, disconnected). required: false schema: $ref: '#/components/schemas/XiqClientHealthConnectionStatus' - name: includeUnassigned in: query description: To include unassigned clients required: false schema: type: boolean requestBody: required: false content: application/json: schema: type: object properties: site_ids: description: List of site IDs to filter the client health grid type: array items: type: integer format: int64 device_ids: description: List of device IDs to filter the device health grid type: array items: type: integer format: int64 number_filter: type: array description: The number based column filters available(Available columns- dhcp_response_time,snr,rssi, authentication_failures, association_failures, roaming, onboarding_time). items: $ref: '#/components/schemas/number_filter' frequency: description: The frequency band (e.g., 2.4 GHz, 5 GHz) used by the client device. $ref: '#/components/schemas/XiqClientHealthFrequencySortField' alias: description: The aliases available type: array items: type: string auth_methods: description: The authentication methods available type: array items: type: string encryption_methods: description: The encryption methods available type: array items: type: string operating_systems: description: The operating systems available type: array items: type: string ssids: description: The ssids available type: array items: type: string user_profiles: description: The user profiles available type: array items: type: string category_assignments: description: The category assignments available type: array items: type: string has_association_issues: description: Indicates if the client has an association issue type: boolean has_authentication_issues: description: Indicates if the client has an authentication issue type: boolean has_ip_address_issues: description: Indicates if the client has an IP address issue type: boolean has_roaming_issues: description: Indicates if the client has a roaming issue type: boolean responses: '200': description: Returns the response of the client health grid content: application/json: schema: $ref: '#/components/schemas/PagedXiqClientHealthGridResponse' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /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#_post_wireless_client_health_connectivity_issues operationId: wirelessClientHealthConnectivityIssues parameters: - name: includeUnassigned in: query description: To include unassigned clients required: false schema: type: boolean requestBody: required: false content: application/json: schema: type: object properties: site_ids: description: List of site IDs to filter the clients with connectivity issues type: array items: type: integer format: int64 responses: '200': description: Returns the counts of clients with connectivity issues based on the filters content: application/json: schema: $ref: '#/components/schemas/XiqWirelessClientHealthConnectivityIssues' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /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#_post_wireless_client_health_frequency_distribution operationId: wirelessClientHealthFrequencyDistribution parameters: - name: includeUnassigned in: query description: To include unassigned clients required: false schema: type: boolean requestBody: required: false content: application/json: schema: type: object properties: site_ids: description: List of site IDs to filter the clients with different frequency distribution type: array items: type: integer format: int64 responses: '200': description: Returns the counts of clients with different frequency distribution based on the filters content: application/json: schema: $ref: '#/components/schemas/XiqWirelessClientHealthFrequencyDistribution' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /dashboard/wireless/client-health/roaming-issues: post: tags: - Dashboard - Wireless Client Health summary: Count of wireless clients with roaming issues description: Returns the wireless clients with roaming issues 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#_post_wireless_client_health_roaming_issues operationId: wirelessClientHealthRoamingIssues parameters: - name: includeUnassigned in: query description: To include unassigned clients required: false schema: type: boolean requestBody: required: false content: application/json: schema: type: object properties: site_ids: description: List of site IDs to filter the clients with roaming issues type: array items: type: integer format: int64 responses: '200': description: Returns the counts of clients with roaming issues based on the filters content: application/json: schema: type: object 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) default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /dashboard/wireless/client-health/filter-metadata: post: tags: - Dashboard - Wireless Client Health summary: Wireless client health grid filter metadata description: Returns the client health health grid filter metadata. 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: wirelessClientHealthGridFilterMetada parameters: - name: includeUnassigned in: query description: To include unassigned clients required: false schema: type: boolean requestBody: content: application/json: schema: type: object properties: site_ids: type: array items: type: integer format: int64 description: The site ID list to filter responses: '200': description: OK content: application/json: schema: type: object description: The filter metadata available for client health grid. properties: connection_status: type: array description: The available connection status items: type: string frequency: type: array description: The available frequency bands items: type: string ssid: type: array description: The available ssids items: type: string os: type: array description: The available operating systems items: type: string authentication: type: array description: The available authentication methods items: type: string encryption: type: array description: The available encryption methods items: type: string user_profile: type: array description: The available user profiles items: type: string category_assignment: type: array description: The available category assignments items: type: string default: $ref: '#/components/responses/ErrorResponse' /dashboard/wireless/client-health/issue/association: post: tags: - Dashboard - Wireless Client Health summary: Wireless client health association issues description: Returns the client health association 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#_post_client_health_association_issues operationId: wirelessClientHealthAssociationIssues parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/limit' - name: macAddress in: query description: The macAddress to filter required: false schema: type: string - name: includeUnassigned in: query description: To include unassigned clients required: false schema: type: boolean requestBody: required: false content: application/json: schema: type: object properties: site_ids: description: List of site IDs to filter the client health grid type: array items: type: integer format: int64 responses: '200': description: Returns the response of client health grid content: application/json: schema: $ref: '#/components/schemas/RmWirelessClientHealthIssueResponse' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /dashboard/wireless/client-health/issue/authentication: post: tags: - Dashboard - Wireless Client Health summary: Wireless client health authentication issues description: Returns the client health authentication 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#_post_client_health_authentication_issues operationId: wirelessClientHealthAuthenticationIssues parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/limit' - name: macAddress in: query description: The macAddress to filter required: false schema: type: string - name: includeUnassigned in: query description: To include unassigned clients required: false schema: type: boolean requestBody: required: false content: application/json: schema: type: object properties: site_ids: description: List of site IDs to filter the client health grid type: array items: type: integer format: int64 responses: '200': description: Returns the response of client health grid content: application/json: schema: $ref: '#/components/schemas/RmWirelessClientHealthIssueResponse' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /dashboard/wireless/client-health/issue/roaming: post: tags: - Dashboard - Wireless Client Health summary: Wireless client health roaming issues description: Returns the client health 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#_post_client_health_roaming_issues operationId: wirelessClientHealthIssueRoaming parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/limit' - name: macAddress in: query description: The macAddress to filter required: false schema: type: string - name: includeUnassigned in: query description: To include unassigned clients required: false schema: type: boolean requestBody: required: false content: application/json: schema: type: object properties: site_ids: description: List of site IDs to filter the client health grid type: array items: type: integer format: int64 responses: '200': description: Returns the response of client health grid content: application/json: schema: $ref: '#/components/schemas/RmWirelessClientHealthRoamingIssueResponse' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /dashboard/wireless/client-health/issue/ipaddress: post: tags: - Dashboard - Wireless Client Health summary: Wireless client health ip address issues description: Returns the client health ip address 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#_post_client_health_ip_address_issues operationId: wirelessClientHealthIpAddressIssues parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/limit' - name: macAddress in: query description: The macAddress to filter required: false schema: type: string - name: includeUnassigned in: query description: To include unassigned clients required: false schema: type: boolean requestBody: required: false content: application/json: schema: type: object properties: site_ids: description: List of site IDs to filter the client health grid type: array items: type: integer format: int64 responses: '200': description: Returns the response of client health grid content: application/json: schema: $ref: '#/components/schemas/RmWirelessClientHealthIpAddressIssueResponse' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /dashboard/wireless/client-health/export: post: tags: - Dashboard - Wireless Client Health summary: Export Grid as a CSV File description: Returns the CSV File of 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_export operationId: wirelessClientHealthGridExport parameters: - 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/XiqClientHealthSortField' - name: sortOrder in: query description: The sort order required: false schema: $ref: '#/components/schemas/XiqSortOrder' - name: connectionStatus in: query description: The current connection status of the client (e.g., connected, disconnected). required: false schema: $ref: '#/components/schemas/XiqClientHealthConnectionStatus' - name: includeUnassigned in: query description: To include unassigned clients required: false schema: type: boolean requestBody: required: false content: application/json: schema: type: object properties: site_ids: description: List of site IDs to filter the client health grid type: array items: type: integer format: int64 device_ids: description: List of device IDs to filter the device health grid type: array items: type: integer format: int64 number_filter: type: array description: The number based column filters available(Available columns- dhcp_response_time,snr,rssi, authentication_failures, association_failures, roaming, onboarding_time). items: $ref: '#/components/schemas/number_filter' frequency: description: The frequency band (e.g., 2.4 GHz, 5 GHz) used by the client device. $ref: '#/components/schemas/XiqClientHealthFrequencySortField' alias: description: The aliases available type: array items: type: string auth_methods: description: The authentication methods available type: array items: type: string encryption_methods: description: The encryption methods available type: array items: type: string operating_systems: description: The operating systems available type: array items: type: string ssids: description: The ssids available type: array items: type: string user_profiles: description: The user profiles available type: array items: type: string category_assignments: description: The category assignments available type: array items: type: string has_association_issues: description: Indicates if the client has an association issue type: boolean has_authentication_issues: description: Indicates if the client has an authentication issue type: boolean has_ip_address_issues: description: Indicates if the client has an IP address issue type: boolean has_roaming_issues: description: Indicates if the client has a roaming issue type: boolean responses: '202': description: Accepted - The request has been accepted for processing, but the processing has not been completed. headers: cache-control: description: Cache control directives schema: type: string content-length: description: The length of the response body in octets (8-bit bytes) schema: type: integer date: description: The date and time at which the message was originated schema: type: string format: date-time expires: description: The date/time after which the response is considered stale schema: type: string location: description: The URL to which the client should navigate to check the status of the request schema: type: string format: uri pragma: description: Implementation-specific directives that might apply to any recipient along the request-response chain schema: type: string ratelimit-limit: description: The maximum number of requests that the client is allowed to make in a given time period schema: type: string ratelimit-remaining: description: The number of requests remaining in the current rate limit window schema: type: integer retry-after: description: The amount of time to wait before making a follow-up request schema: type: integer server: description: A name for the server schema: type: string example: nginx x-content-type-options: description: Prevents the browser from interpreting files as a different MIME type schema: type: string x-xss-protection: description: Enables cross-site scripting (XSS) filter schema: type: string format: byte default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /dashboard/wireless/client-health/reports/{id}: get: tags: - Dashboard - Wireless Client Health summary: Download the Export CSV file description: Returns the CSV File of the Wireless Client Health status based on the provided filters. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_client_grid_export_report operationId: wirelessClientHealthGridExportReport parameters: - name: id in: path description: The report ID required: true schema: type: string responses: '200': description: Returns the CSV File of the Wireless Client Health content: application/octet-stream: schema: type: string default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /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#_post_usage_and_capacity_grid operationId: wirelessUsageAndCapacityGrid parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/limit' - name: keyword in: query description: The keyword to search required: false schema: type: string - name: sortField in: query description: The sort order required: false schema: $ref: '#/components/schemas/XiqUsageAndCapacitySortField' - name: sortOrder in: query description: The sort order required: false schema: $ref: '#/components/schemas/XiqSortOrder' - name: includeUnassigned in: query description: To include unassigned devices required: false schema: type: boolean requestBody: required: false content: application/json: schema: type: object properties: site_ids: description: List of site IDs to filter the usage & capacity grid type: array items: type: integer format: int64 device_ids: description: List of device IDs to filter the device health grid type: array items: type: integer format: int64 building_ids: description: List of building IDs to filter the usage & capacity grid type: array items: type: integer format: int64 buildings: description: List of building to filter the usage & capacity grid type: array items: type: string floors: description: List of floor to filter the usage & capacity grid type: array items: type: string has_usage_capacity_issues: description: Indicates if the device has a usage capacity issue type: boolean has_packet_loss_issues: description: Indicates if the device has a packet loss issue type: boolean has_retries_issues: description: Indicates if the device has a retries issue type: boolean number_filters: type: array description: The number based column filters available (Available columns- radio_2dot4g_utilization_score, radio_5g_utilization_score, radio_6g_utilization_score, wifi0_retry_score, wifi1_retry_score, wifi2_retry_score, packet_loss). items: $ref: '#/components/schemas/number_filter' responses: '200': description: Returns the response of usage & capacity grid content: application/json: schema: $ref: '#/components/schemas/PagedXiqUsageAndCapacityGridResponse' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /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#_post_wireless_usage_capacity_excessive_packet_loss operationId: wirelessUsageCapacityExcessivePacketLoss parameters: - name: includeUnassigned in: query description: To include unassigned devices required: false schema: type: boolean requestBody: required: false content: application/json: schema: type: object properties: site_ids: description: List of site IDs to filter the count of APs with excessive packet loss type: array items: type: integer format: int64 responses: '200': description: Returns the counts of APs with excessive packet loss based on the filters content: application/json: schema: type: object properties: excessive_packet_loss_ap_count: type: integer format: int64 description: Count of APs with excessive packet loss default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /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. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_post_wireless_usage_capacity_excessive_utilization operationId: wirelessUsageCapacityExcessiveUtilization parameters: - name: includeUnassigned in: query description: To include unassigned devices required: false schema: type: boolean requestBody: required: false content: application/json: schema: type: object properties: site_ids: description: List of site IDs to filter the counts of APs with excessive channel utilization type: array items: type: integer format: int64 responses: '200': description: Returns the counts of APs with excessive channel utilization based on the filters content: application/json: schema: $ref: '#/components/schemas/XiqWirelessUsageCapacityExcessiveUtilization' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /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#_post_wireless_usage_capacity_excessive_retries operationId: wirelessUsageCapacityExcessiveRetries parameters: - name: includeUnassigned in: query description: To include unassigned devices required: false schema: type: boolean requestBody: required: false content: application/json: schema: type: object properties: site_ids: description: List of site IDs to filter the counts of APs with excessive retries type: array items: type: integer format: int64 responses: '200': description: Returns the counts of APs with excessive retries based on the filters content: application/json: schema: type: object properties: excessive_retries_ap_count: type: integer format: int64 description: Count of APs with excessive retries default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /dashboard/wireless/usage-capacity/export: post: tags: - Dashboard - Wireless Usage and Capacity summary: 'Export Wireless usage & capacity grid as CSV File ' description: Returns the CSV File of 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#_post_usage_and_capacity_grid operationId: wirelessUsageAndCapacityGridExport parameters: - 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/XiqUsageAndCapacitySortField' - name: sortOrder in: query description: The sort order required: false schema: $ref: '#/components/schemas/XiqSortOrder' - name: includeUnassigned in: query description: To include unassigned devices required: false schema: type: boolean requestBody: required: false content: application/json: schema: type: object properties: site_ids: description: List of site IDs to filter the usage & capacity grid type: array items: type: integer format: int64 device_ids: description: List of device IDs to filter the device health grid type: array items: type: integer format: int64 building_ids: description: List of building IDs to filter the usage & capacity grid type: array items: type: integer format: int64 buildings: description: List of building to filter the usage & capacity grid type: array items: type: string floors: description: List of floor to filter the usage & capacity grid type: array items: type: string has_usage_capacity_issues: description: Indicates if the device has a usage capacity issue type: boolean number_filters: type: array description: The number based column filters available (Available columns- radio_2dot4g_utilization_score, radio_5g_utilization_score, radio_6g_utilization_score, wifi0_retry_score, wifi1_retry_score, wifi2_retry_score, packet_loss). items: $ref: '#/components/schemas/number_filter' responses: '202': description: Accepted - The request has been accepted for processing, but the processing has not been completed. headers: cache-control: description: Cache control directives schema: type: string content-length: description: The length of the response body in octets (8-bit bytes) schema: type: integer date: description: The date and time at which the message was originated schema: type: string format: date-time expires: description: The date/time after which the response is considered stale schema: type: string location: description: The URL to which the client should navigate to check the status of the request schema: type: string format: uri pragma: description: Implementation-specific directives that might apply to any recipient along the request-response chain schema: type: string ratelimit-limit: description: The maximum number of requests that the client is allowed to make in a given time period schema: type: string ratelimit-remaining: description: The number of requests remaining in the current rate limit window schema: type: integer retry-after: description: The amount of time to wait before making a follow-up request schema: type: integer server: description: A name for the server schema: type: string example: nginx x-content-type-options: description: Prevents the browser from interpreting files as a different MIME type schema: type: string x-xss-protection: description: Enables cross-site scripting (XSS) filter schema: type: string format: byte default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /dashboard/wireless/usage-capacity/reports/{id}: get: tags: - Dashboard - Wireless Usage and Capacity summary: Download the Export CSV file description: Returns the CSV File of the Wireless Usage And Capacity status based on the provided filters. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_usage_and_capacity_report operationId: wirelessUsageAndCapacityGridExportReport parameters: - name: id in: path description: The report ID required: true schema: type: string responses: '200': description: Returns the CSV File of the usage and capacity grid content: application/octet-stream: schema: type: string default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /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#_get_device_health_grid operationId: wirelessDeviceHealthGrid parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/limit' - 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/XiqDeviceHealthGridSortField' - name: sortOrder in: query description: The sort order required: false schema: $ref: '#/components/schemas/XiqSortOrder' - name: includeUnassigned in: query description: To include unassigned devices required: false schema: type: boolean requestBody: required: false content: application/json: schema: type: object properties: site_ids: description: List of site IDs to filter the device health grid type: array items: type: integer format: int64 device_ids: description: List of device IDs to filter the device health grid type: array items: type: integer format: int64 has_device_health_issues: description: Indicates if the device has a device health issue type: boolean has_poe_issues: description: Indicates if the device has a poe issue type: boolean number_filters: type: array description: The number based column filters available(Available columns- cpu_usage_percentage, memory_usage_percentage, eth0_broadcast_score, eth0_multicast_score, eth0_unicast_score, eth1_broadcast_score, eth1_unicast_score, eth1_multicast_score). items: $ref: '#/components/schemas/number_filter' responses: '200': description: Returns the response of the device health grid content: application/json: schema: $ref: '#/components/schemas/PagedXiqDeviceHealthGridResponse' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /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_wireless_device_health_issues_cpu_usage operationId: wirelessDeviceHealthCpuUsageIssues parameters: - name: includeUnassigned in: query description: To include unassigned devices required: false schema: type: boolean requestBody: required: false content: application/json: schema: type: object properties: site_ids: description: List of site IDs to filter the wireless devices CPU usage issues. type: array items: type: integer format: int64 responses: '200': description: Returns the counts of wirless devices having CPU usage issues. content: application/json: schema: $ref: '#/components/schemas/XiqWirelessDeviceHealthCpuUsageIssues' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /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 (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_wireless_device_health_issues_memory_usage operationId: wirelessDeviceHealthMemoryUsageIssues parameters: - name: includeUnassigned in: query description: To include unassigned devices required: false schema: type: boolean requestBody: required: false content: application/json: schema: type: object properties: site_ids: description: List of site IDs to filter the wireless devices Memory usage issues. type: array items: type: integer format: int64 responses: '200': description: Returns the counts of wirless devices having Memory usage issues. content: application/json: schema: $ref: '#/components/schemas/XiqWirelessDeviceHealthMemoryUsageIssues' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /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_wireless_device_health_issues_poe_usage operationId: wirelessDeviceHealthPoEUsageIssues parameters: - name: includeUnassigned in: query description: To include unassigned devices required: false schema: type: boolean requestBody: required: false content: application/json: schema: type: object properties: site_ids: description: List of site IDs to filter the wireless devices PoE usage issues. type: array items: type: integer format: int64 responses: '200': description: Returns the counts of wirless devices having PoE usage issues. content: application/json: schema: $ref: '#/components/schemas/XiqWirelessDeviceHealthPoEUsageIssues' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /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#_post_device_health_wireless_summary operationId: wirelessDeviceHealthSummary parameters: - name: includeUnassigned in: query description: To include unassigned devices required: false schema: type: boolean requestBody: required: false content: application/json: schema: type: object properties: site_ids: description: List of site IDs to filter the wireless devices summary type: array items: type: integer format: int64 responses: '200': description: Returns the counts of wirless devices and devices with health issues content: application/json: schema: $ref: '#/components/schemas/XiqWirelessDeviceHealthSummary' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /dashboard/wireless/device-health/reboot/summary: get: tags: - Dashboard - Wireless Device Health summary: Wireless device reboot summary description: Returns the device reboot summary of a device. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_device_health_grid operationId: wirelessDeviceHealthRebootSummary parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/limit' - name: deviceId in: query description: The deviceId to collect reboot summary required: false schema: type: integer format: int64 responses: '200': description: Returns the response of the device reboot summary content: application/json: schema: $ref: '#/components/schemas/PagedXiqDeviceRebootSummaryResponse' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /dashboard/wireless/device-health/export: post: tags: - Dashboard - Wireless Device Health summary: Wireless device health grid Export description: Returns the device health grid export 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#_get_device_health_grid_export operationId: wirelessDeviceHealthGridExport parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/limit' - 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/XiqDeviceHealthGridSortField' - name: sortOrder in: query description: The sort order required: false schema: $ref: '#/components/schemas/XiqSortOrder' - name: includeUnassigned in: query description: To include unassigned devices required: false schema: type: boolean requestBody: required: false content: application/json: schema: type: object properties: site_ids: description: List of site IDs to filter the device health grid type: array items: type: integer format: int64 device_ids: description: List of device IDs to filter the device health grid type: array items: type: integer format: int64 has_device_health_issues: description: Indicates if the device has a device health issue type: boolean has_poe_issues: description: Indicates if the device has a poe issue type: boolean number_filters: type: array description: The number based column filters available(Available columns- cpu_usage_percentage, memory_usage_percentage, eth0_broadcast_score, eth0_multicast_score, eth0_unicast_score, eth1_broadcast_score, eth1_unicast_score, eth1_multicast_score). items: $ref: '#/components/schemas/number_filter' responses: '202': description: Accepted - The request has been accepted for processing, but the processing has not been completed. headers: cache-control: description: Cache control directives schema: type: string content-length: description: The length of the response body in octets (8-bit bytes) schema: type: integer date: description: The date and time at which the message was originated schema: type: string format: date-time expires: description: The date/time after which the response is considered stale schema: type: string location: description: The URL to which the client should navigate to check the status of the request schema: type: string format: uri pragma: description: Implementation-specific directives that might apply to any recipient along the request-response chain schema: type: string ratelimit-limit: description: The maximum number of requests that the client is allowed to make in a given time period schema: type: string ratelimit-remaining: description: The number of requests remaining in the current rate limit window schema: type: integer retry-after: description: The amount of time to wait before making a follow-up request schema: type: integer server: description: A name for the server schema: type: string example: nginx x-content-type-options: description: Prevents the browser from interpreting files as a different MIME type schema: type: string x-xss-protection: description: Enables cross-site scripting (XSS) filter schema: type: string format: byte default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /dashboard/wireless/device-health/reports/{id}: get: tags: - Dashboard - Wireless Device Health summary: Download the Export CSV file description: Returns the CSV File of the wireless Device Health status based on the provided filters. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_device_status_grid_report operationId: wirelessDeviceHealthGridExportReport parameters: - name: id in: path description: The report ID required: true schema: type: string responses: '200': description: Returns the CSV File of the device health grid content: application/octet-stream: schema: type: string default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /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: wiredClientHealthGrid parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/limit' - 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/XiqWiredClientHealthSortField' - name: sortOrder in: query description: The sort order required: false schema: $ref: '#/components/schemas/XiqSortOrder' requestBody: required: false content: application/json: schema: type: object properties: site_ids: description: List of site IDs to filter the client health grid type: array items: type: integer format: int64 device_ids: description: List of device IDs to filter the client health grid type: array items: type: integer format: int64 number_filter: type: object description: The number based column filters available. properties: data: type: array items: $ref: '#/components/schemas/number_filter' responses: '200': description: Returns the response of the client health grid content: application/json: schema: $ref: '#/components/schemas/PagedXiqWiredClientHealthGridResponse' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /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: wiredClientHealthIpConnectivityIssues parameters: - name: deviceId in: query description: The device ID required: false schema: type: integer format: int64 requestBody: required: false content: application/json: schema: type: object properties: site_ids: description: List of site IDs to filter the clients with IP connectivity issues type: array items: type: integer format: int64 device_ids: description: List of device IDs to filter the clients with IP connectivity issues type: array items: type: integer format: int64 responses: '200': description: Returns the counts of clients with IP connectivity issues based on the filters content: application/json: schema: $ref: '#/components/schemas/XiqWiredClientHealthIpConnectivityIssues' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /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: wiredClientHealthPortCongestionIssues parameters: - name: deviceId in: query description: The device ID required: false schema: type: integer format: int64 requestBody: required: false content: application/json: schema: type: object properties: site_ids: description: List of site IDs to filter the clients with port congestion issues type: array items: type: integer format: int64 device_ids: description: List of device IDs to filter the clients with port congestion issues type: array items: type: integer format: int64 responses: '200': description: Returns the counts of clients with port congestion issues based on the filters content: application/json: schema: $ref: '#/components/schemas/XiqWiredClientHealthPortCongestionIssues' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /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: wiredClientHealthTrafficAnomalies parameters: - name: deviceId in: query description: The device ID required: false schema: type: integer format: int64 requestBody: required: false content: application/json: schema: type: object properties: site_ids: description: List of site IDs to filter the clients with traffic anomalies type: array items: type: integer format: int64 device_ids: description: List of device IDs to filter the clients with traffic anomalies type: array items: type: integer format: int64 responses: '200': description: Returns the counts of clients with traffic anomalies based on the filters content: application/json: schema: $ref: '#/components/schemas/XiqWiredClientHealthTrafficAnomalies' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /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: wiredClientHealthPortErrors parameters: - name: deviceId in: query description: The device ID required: false schema: type: integer format: int64 requestBody: required: false content: application/json: schema: type: object properties: site_ids: description: List of site IDs to filter the clients with port errors type: array items: type: integer format: int64 device_ids: description: List of device IDs to filter the clients with port errors type: array items: type: integer format: int64 responses: '200': description: Returns the counts of clients with port errors based on the filters content: application/json: schema: $ref: '#/components/schemas/XiqWiredClientHealthPortErrors' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /dashboard/wired/device-health/summary: post: tags: - Dashboard - Wired Device Health summary: Device health summary for wired devices description: Returns the count of total wired 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#_post_device_health_wired_summary operationId: wiredDeviceHealthSummary requestBody: required: false content: application/json: schema: type: object properties: site_ids: description: List of site IDs to filter the wired devices summary type: array items: type: integer format: int64 responses: '200': description: Returns the counts of wired devices and devices with health issues content: application/json: schema: $ref: '#/components/schemas/XiqWiredDeviceHealthSummary' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /dashboard/wired/device-health/cpu-usage-issues: post: tags: - Dashboard - Wired Device Health summary: CPU usage issues for wired devices description: Returns the count of wired 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_wired_device_health_issues_cpu_usage operationId: wiredDeviceHealthCpuUsageIssues requestBody: required: false content: application/json: schema: type: object properties: site_ids: description: List of site IDs to filter the wired devices CPU usage issues. type: array items: type: integer format: int64 responses: '200': description: Returns the counts of wired devices having CPU usage issues content: application/json: schema: $ref: '#/components/schemas/XiqWiredDeviceHealthCpuUsageIssues' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /dashboard/wired/device-health/memory-usage-issues: post: tags: - Dashboard - Wired Device Health summary: Memory usage issues for wired devices description: Returns the count of wired devices having memory usage issues (memory 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_wired_device_health_issues_memory_usage operationId: wiredDeviceHealthMemoryUsageIssues requestBody: required: false content: application/json: schema: type: object properties: site_ids: description: List of site IDs to filter the wired devices Memory usage issues type: array items: type: integer format: int64 responses: '200': description: Returns the counts of wired devices having memory usage issues content: application/json: schema: $ref: '#/components/schemas/XiqWiredDeviceHealthMemoryUsageIssues' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /dashboard/wired/device-health/temperature-issues: post: tags: - Dashboard - Wired Device Health summary: Temperature issues for wired devices description: Returns the count of wired devices having temperature 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_wired_device_health_issues_temperature operationId: wiredDeviceHealthTemperatureIssues requestBody: required: false content: application/json: schema: type: object properties: site_ids: description: List of site IDs to filter the wired devices temperature issues type: array items: type: integer format: int64 responses: '200': description: Returns the counts of wired devices having temperature issues content: application/json: schema: $ref: '#/components/schemas/XiqWiredDeviceHealthTemperatureIssues' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /dashboard/wired/device-health/poe-usage-issues: post: tags: - Dashboard - Wired Device Health summary: PoE usage issues for wired devices description: Returns the count of wired devices having PoE 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_wired_device_health_issues_poe_usage operationId: wiredDeviceHealthPoEUsageIssues requestBody: required: false content: application/json: schema: type: object properties: site_ids: description: List of site IDs to filter the wired devices PoE usage issues type: array items: type: integer format: int64 responses: '200': description: Returns the counts of wired devices having PoE usage issues content: application/json: schema: $ref: '#/components/schemas/XiqWiredDeviceHealthPoeUsageIssues' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /dashboard/wired/device-health/fan-issues: post: tags: - Dashboard - Wired Device Health summary: Fan status issues for wired devices description: Returns the count of wired devices having fan status 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_wired_device_health_issues_fan_status operationId: wiredDeviceHealthFanStatusIssues requestBody: required: false content: application/json: schema: type: object properties: site_ids: description: List of site IDs to filter the wired devices fan status issues type: array items: type: integer format: int64 responses: '200': description: Returns the counts of wired devices having fan status issues content: application/json: schema: $ref: '#/components/schemas/XiqWiredDeviceHealthFanStatusIssues' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /dashboard/wired/device-health/psu-issues: post: tags: - Dashboard - Wired Device Health summary: PSU status issues for wired devices description: Returns the count of wired devices having PSU status 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_wired_device_health_issues_psu_status operationId: wiredDeviceHealthPSUStatusIssues requestBody: required: false content: application/json: schema: type: object properties: site_ids: description: List of site IDs to filter the wired devices PSU status issues type: array items: type: integer format: int64 responses: '200': description: Returns the counts of wired devices having PSU status issues content: application/json: schema: $ref: '#/components/schemas/XiqWiredDeviceHealthPsuStatusIssues' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /dashboard/wired/device-health/grid: post: tags: - Dashboard - Wired Device Health summary: Wired Device Health Grid description: Returns the device health grid of wired 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#_get_device_health_grid operationId: wiredDeviceHealthGrid parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/limit' - 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/XiqWiredDeviceHealthGridSortField' - name: sortOrder in: query description: The sort order required: false schema: $ref: '#/components/schemas/XiqSortOrder' requestBody: required: false content: application/json: schema: type: object properties: site_ids: description: List of site IDs to filter the device health grid type: array items: type: integer format: int64 device_ids: description: List of device IDs to filter the device health grid type: array items: type: integer format: int64 filter_field: description: The filters available for the device health grid type: array items: type: string format: enum $ref: '#/components/schemas/XiqWiredDeviceHealthGridFilterField' responses: '200': description: Returns the response of the device health grid content: application/json: schema: $ref: '#/components/schemas/PagedXiqWiredDeviceHealthGridResponse' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /dashboard/wired/device-health/poe-usage-status: post: tags: - Dashboard - Wired Device Health summary: PoE usage status for wired devices description: Returns the PoE usage for wired devices based on the provided device ID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_device_health_poe operationId: wiredDeviceHealthPoe parameters: - name: deviceId in: query description: The device ID to provide the PoE usage (all the slots will be provided for a stack) required: true schema: type: integer format: int64 responses: '200': description: Returns the PoE usage for the specified device ID (all the slots will be provided for a stack) content: application/json: schema: $ref: '#/components/schemas/XiqWiredDeviceHealthPoeUsageStatusResponse' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /dashboard/wired/device-health/temperature-status: post: tags: - Dashboard - Wired Device Health summary: Temperature status for wired devices description: Returns the temperature for wired devices based on the provided device ID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_device_health_temperature operationId: wiredDeviceHealthTemperature parameters: - name: deviceId in: query description: The device ID to provide the temperature (all the slots will be provided for a stack) required: true schema: type: integer format: int64 responses: '200': description: Returns the temperature for the specified device ID (all the slots will be provided for a stack) content: application/json: schema: $ref: '#/components/schemas/XiqWiredDeviceHealthTemperatureStatusResponse' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /dashboard/wired/device-health/fan-status: post: tags: - Dashboard - Wired Device Health summary: Fan status for wired devices description: Returns the fan health status for wired devices based on the provided device ID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_device_health_fan_status operationId: wiredDeviceHealthFanStatus parameters: - name: deviceId in: query description: The device ID to provide the fan health status (all the slots will be provided for a stack) required: true schema: type: integer format: int64 responses: '200': description: Returns the fan health status for the specified device ID (all the slots will be provided for a stack) content: application/json: schema: $ref: '#/components/schemas/XiqWiredDeviceHealthFanStatusResponse' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /dashboard/wired/device-health/psu-status: post: tags: - Dashboard - Wired Device Health summary: PSU status for wired devices description: Returns the PSU health status for wired devices based on the provided device ID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_device_health_psu operationId: wiredDeviceHealthPsu parameters: - name: deviceId in: query description: The device ID to provide the fan health status (all the slots will be provided for a stack) required: true schema: type: integer format: int64 responses: '200': description: Returns the PSU health status for the specified device ID (all the slots will be provided for a stack) content: application/json: schema: $ref: '#/components/schemas/XiqWiredDeviceHealthPsuStatusResponse' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /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: wiredUsageCapacityGrid parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/limit' - name: keyword in: query description: The keyword to search (hostname, IP or site) required: false schema: type: string - name: sortField in: query description: The field used for sorting. required: false schema: $ref: '#/components/schemas/XiqWiredUsageCapacitySortField' - name: sortOrder in: query description: The sort order required: false schema: $ref: '#/components/schemas/XiqSortOrder' requestBody: required: false content: application/json: schema: type: object properties: site_ids: description: List of site IDs to filter usage and capacity grid type: array items: type: integer format: int64 device_ids: description: List of device IDs to filter usage and capacity grid type: array items: type: integer format: int64 filter_field: description: The filters available for usage and capacity grid type: array items: type: string format: enum $ref: '#/components/schemas/XiqWiredUsageCapacityFilter' responses: '200': description: Returns the response for usage and capacity grid content: application/json: schema: $ref: '#/components/schemas/PagedXiqWiredUsageCapacityGridResponse' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /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: wiredUsageCapacityUsageUtilization requestBody: required: false content: application/json: schema: type: object properties: site_ids: description: List of site IDs to filter total bandwidth utilized by wired devices type: array items: type: integer format: int64 responses: '200': description: Returns total bandwidth utilized by wired devices based on the provided filters content: application/json: schema: $ref: '#/components/schemas/XiqWiredUsageCapacityUsageUtilization' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /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: wiredUsageCapacityThroughput requestBody: required: false content: application/json: schema: type: object properties: site_ids: description: List of site IDs to filter throughput for wired devices type: array items: type: integer format: int64 responses: '200': description: Returns the throughput for wired devices based on the provided filters content: application/json: schema: $ref: '#/components/schemas/XiqWiredUsageCapacityThroughput' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /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: wiredUsageCapacityCongestion requestBody: required: false content: application/json: schema: type: object properties: site_ids: description: List of site IDs to filter the congestion for wired devices type: array items: type: integer format: int64 responses: '200': description: Returns the congestion for wired devices based on the provided filters content: application/json: schema: $ref: '#/components/schemas/XiqWiredUsageCapacityCongestion' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /switch-inspector/diagnostics: post: tags: - Switch Inspector Panel summary: Diagnostics Widget for Wired Devices description: Returns the "Device Health", "Usage and Capacity" and "Client Health" current number of issues for wired devices based on the provided device ID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_wired_diagnostics_widget operationId: wiredDiagnosticsWidget parameters: - name: deviceId in: query description: The device ID for which the "Device Health", "Usage and Capacity" and "Client Health" current number of issues needs to be provided required: true schema: type: integer format: int64 responses: '200': description: Returns the "Device Health", "Usage and Capacity" and "Client Health" current number of issues for the specified device ID content: application/json: schema: $ref: '#/components/schemas/XiqSwitchInspectorPanelDiagnosticsWidget' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /geo-view: get: tags: - Geo-View summary: Geo View Data description: Geo View hierarchical data. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_geo_view operationId: geoView responses: '200': description: OK content: application/json: schema: type: array items: $ref: '#/components/schemas/GeoViewNode' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /ng-reports/reports: get: tags: - NG Reports summary: Get scheduled reports description: Retrieve scheduled reports based on frequency and keyword search. operationId: getScheduledReports parameters: - name: request in: query description: Type of report to retrieve required: true schema: type: string enum: - monthly_reports - daily_reports - weekly_reports - name: keyword in: query description: Keyword to search reports required: false schema: type: string responses: '200': description: A list of scheduled reports content: application/json: schema: type: array items: type: object properties: report_name: type: string description: Name of the report recipients: type: array items: type: string description: List of report recipients latest_report_pdf: type: string format: uri description: URL to the latest report PDF enable_report: type: boolean description: Indicates if the report is enabled default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] post: tags: - NG Reports summary: Create a new scheduled report description: Create a new scheduled report with specified details. operationId: createScheduledReport requestBody: required: true content: application/json: schema: type: object required: - report_name - recipients - enable_report properties: report_name: type: string description: Name of the report recipients: type: array items: type: string description: List of email recipients enable_report: type: boolean description: Whether the report is enabled frequency: type: string enum: - daily_reports - weekly_reports - monthly_reports description: Frequency of the report responses: '201': description: Report successfully created default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /ng-reports/reports/{id}: delete: tags: - NG Reports summary: Delete a scheduled report description: Delete a scheduled report by its unique identifier. operationId: deleteScheduledReport parameters: - $ref: '#/components/parameters/id' responses: '204': description: Report successfully deleted (No Content) default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] put: tags: - NG Reports summary: Update an existing scheduled report description: Update the details of a scheduled report by its ID. operationId: updateScheduledReport parameters: - $ref: '#/components/parameters/id' requestBody: required: true content: application/json: schema: type: object properties: report_name: type: string recipients: type: array items: type: string enable_report: type: boolean frequency: type: string enum: - daily_reports - weekly_reports - monthly_reports responses: '200': description: Report successfully updated default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /ng-reports/metrics/timeseries.yaml: post: tags: - NG Reports summary: Time Series data in NG Reports Metrics operationId: timeseriesReportMetrics description: This API returns the data for the graph widgets. requestBody: description: The payload to get the table data metrics data required: true content: application/json: schema: oneOf: - $ref: '#/components/schemas/XiqMaxConcurrentClientsRequest' - $ref: '#/components/schemas/XiqUniqueWifiClientsRequest' - $ref: '#/components/schemas/XiqClientSessionsRequest' - $ref: '#/components/schemas/XiqClientAirtimeUsageRequest' - $ref: '#/components/schemas/XiqUniqueClientsByOSRequest' - $ref: '#/components/schemas/XiqAppTrafficPercentageRequest' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/XiqDiagnosticsTimeSeriesResponse' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /ng-reports/metrics/tabledata.yaml: post: tags: - NG Reports summary: Table Data data in NG Reports Metrics description: This API returns the table (raw) Data data in NG Reports Metrics. operationId: tabledataReportMetrics requestBody: description: The payload to get the table data metrics data required: true content: application/json: schema: oneOf: - $ref: '#/components/schemas/XiqMaxConcurrentClientsRequest-2' - $ref: '#/components/schemas/XiqUniqueWifiClientsRequest-2' - $ref: '#/components/schemas/XiqClientSessionsRequest-2' - $ref: '#/components/schemas/XiqClientAirtimeUsageRequest-2' - $ref: '#/components/schemas/XiqUniqueClientsByOSRequest-2' - $ref: '#/components/schemas/XiqAppTrafficPercentageRequest-2' responses: '200': description: OK content: application/json: schema: allOf: - $ref: '#/components/schemas/XiqPage' - type: object properties: data: type: array description: The data in the current page items: $ref: '#/components/schemas/XiqDiagnosticsTableDataResponse' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /ng-reports/metrics/metadata/ssid: post: tags: - NG Reports summary: Ssid filter metadata description: Returns the Ssid filter metadata. You can filter the results by sites,buildings,floor. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_ng-reports_metadata_ssid operationId: getDiagnosticsSsidFilterMetadata requestBody: content: application/json: schema: type: object properties: site_ids: type: array items: type: integer format: int64 description: The site ID list to filter building_ids: type: array items: type: integer format: int64 description: The Building ID list to filter floor_ids: type: array items: type: integer format: int64 description: The Floor ID list to filter responses: '200': description: OK content: application/json: schema: type: array description: The List of Ssids items: type: string default: $ref: '#/components/responses/ErrorResponse' /ng-reports/metrics/metadata/os: post: tags: - NG Reports summary: Client Os filter metadata description: Returns the Client Os filter metadata. You can filter the results by sites,buildings,floor,ssid,band. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_ng-reports_metadata_os operationId: getDiagnosticsOsFilterMetadata requestBody: content: application/json: schema: type: object properties: site_ids: type: array items: type: integer format: int64 description: The site ID list to filter building_ids: type: array items: type: integer format: int64 description: The Building ID list to filter floor_ids: type: array items: type: integer format: int64 description: The Floor ID list to filter ssids: type: array items: type: string description: The Ssid list to filter bands: type: array items: type: string description: The Band list to filter responses: '200': description: OK content: application/json: schema: type: array description: The List of os items: type: string default: $ref: '#/components/responses/ErrorResponse' /ng-reports/metrics/metadata/band: post: tags: - NG Reports summary: Band filter metadata description: Returns the Band filter metadata. You can filter the results by sites,buildings,floor,ssid. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_ng-reports_metadata_band operationId: getDiagnosticsBandFilterMetadata requestBody: content: application/json: schema: type: object properties: site_ids: type: array items: type: integer format: int64 description: The site ID list to filter building_ids: type: array items: type: integer format: int64 description: The Building ID list to filter floor_ids: type: array items: type: integer format: int64 description: The Floor ID list to filter ssids: type: array items: type: string description: The Ssid list to filter responses: '200': description: OK content: application/json: schema: type: array description: The List of Bands items: type: string default: $ref: '#/components/responses/ErrorResponse' /ng-reports/metrics/metadata/client: post: tags: - NG Reports summary: Client filter metadata description: Returns the Client filter metadata. You can filter the results by sites,buildings,floor,usernames. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_ng-reports_metadata_client operationId: getDiagnosticsClientFilterMetadata requestBody: content: application/json: schema: type: object properties: site_ids: type: array items: type: integer format: int64 description: The site ID list to filter building_ids: type: array items: type: integer format: int64 description: The Building ID list to filter floor_ids: type: array items: type: integer format: int64 description: The Floor ID list to filter usernames: type: array items: type: string description: The username list to filter responses: '200': description: OK content: application/json: schema: type: array description: The filter metadata available for Client. items: type: object properties: id: type: integer description: id hostname: type: string description: Host Name mac_address: type: string description: Mac address default: $ref: '#/components/responses/ErrorResponse' /ng-reports/metrics/metadata/user: post: tags: - NG Reports summary: User filter metadata description: Returns the user filter metadata. You can filter the results by sites,buildings,floor. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_ng-reports_metadata_user operationId: getDiagnosticsUserFilterMetadata requestBody: content: application/json: schema: type: object properties: site_ids: type: array items: type: integer format: int64 description: The site ID list to filter building_ids: type: array items: type: integer format: int64 description: The Building ID list to filter floor_ids: type: array items: type: integer format: int64 description: The Floor ID list to filter responses: '200': description: OK content: application/json: schema: type: array description: The filter metadata available for User. items: type: object properties: id: type: integer description: id username: type: string description: User Name default: $ref: '#/components/responses/ErrorResponse' /ng-reports/metrics/metadata/applications: post: tags: - NG Reports summary: Application filter metadata description: Returns the Application filter metadata. You can filter the results by sites, buildings, floor, usernames, and client MAC addresses. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_ng-reports_metadata_application operationId: getDiagnosticsApplicationFilterMetadata requestBody: content: application/json: schema: type: object properties: site_ids: type: array items: type: integer format: int64 description: The site ID list to filter. building_ids: type: array items: type: integer format: int64 description: The building ID list to filter. floor_ids: type: array items: type: integer format: int64 description: The floor ID list to filter. usernames: type: array items: type: string description: The username list to filter. client_macs: type: array items: type: string description: The client MAC list to filter. responses: '200': description: OK content: application/json: schema: type: array description: The filter metadata available for the application. items: type: object properties: id: type: integer description: Application Code. name: type: string description: Application Name. default: $ref: '#/components/responses/ErrorResponse' /ng-reports/metrics/metadata/devices: post: tags: - NG Reports summary: Devices filter metadata description: Returns the Channel filter metadata. You can filter the results by sites,buildings,floor,channel,band. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_ng-reports_metadata_devices operationId: getDiagnosticsDeviceFilterMetadata requestBody: content: application/json: schema: type: object properties: site_ids: type: array items: type: integer format: int64 description: The site ID list to filter building_ids: type: array items: type: integer format: int64 description: The Building ID list to filter floor_ids: type: array items: type: integer format: int64 description: The Floor ID list to filter bands: type: array items: type: string description: The Band list to filter channel: type: array items: type: integer format: int64 description: The Channel list to filter ostype: type: array items: type: string description: The OsType list to filter responses: '200': description: OK content: application/json: schema: type: array description: The filter metadata available for Devices. items: type: object properties: id: type: integer description: id hostname: type: string description: Host Name default: $ref: '#/components/responses/ErrorResponse' /ng-reports/metrics/get-metrics-grouping: get: tags: - NG Reports summary: Grouping of Metrics description: Provides detailed information about the grouping of different metrics. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_ng-reports_metadata_application operationId: metricsGrouping responses: '200': description: OK content: application/json: schema: type: object properties: clientsAnalytics: type: array items: type: string example: | - maxConcurrentClientsOverTime - uniqueClientsOverTimeBySsid - uniqueWiFiClientsOverTime - clientQualityScopeOverTime - clientSessionsOverTime - clientAirtimeUsageOverTime - wirelessClientsByOs - uniqueClientsByOs applicationUsageAnalytics: type: array items: type: string example: | - applicationUsage deviceAnalytics: type: array items: type: string example: | - devicesByClientsOverTime - switchSummary default: $ref: '#/components/responses/ErrorResponse' /ng-reports/download/reports: post: tags: - NG Reports summary: Download NG reports description: Returns the Xlsx/pdf for provided metrics on the provided filters. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_post_export_download operationId: ngReportDownload requestBody: description: The payload to get the table data metrics required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/XiqDownloadReportsRequest' responses: '202': description: Accepted - The request has been accepted for processing, but processing has not been completed. headers: cache-control: description: Cache control directives schema: type: string content-length: description: The length of the response body in octets (8-bit bytes) schema: type: integer date: description: The date and time at which the message was originated schema: type: string format: date-time expires: description: The date/time after which the response is considered stale schema: type: string location: description: The URL to check the request status schema: type: string format: uri pragma: description: Implementation-specific directives that might apply to any recipient schema: type: string ratelimit-limit: description: The maximum number of requests allowed in a given time period schema: type: string ratelimit-remaining: description: The number of requests remaining in the current rate limit window schema: type: integer retry-after: description: Time to wait before making a follow-up request schema: type: integer server: description: Server name schema: type: string example: nginx x-content-type-options: description: Prevents browser from interpreting files as a different MIME type schema: type: string x-xss-protection: description: Enables cross-site scripting (XSS) filter schema: type: string format: byte default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /ng-reports/download/reports/{id}: get: tags: - NG Reports summary: Download the file description: Returns the file for the given metrics based on the provided filters. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_metrics_report operationId: ngReportExport parameters: - name: id in: path description: The file name required: true schema: type: string responses: '200': description: Returns the file for the given metrics content: application/octet-stream: schema: type: string default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /ng-reports/information/{metrics}: get: tags: - NG Reports summary: Information of filters description: Returns the filter for the given metrics. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_metrics_report operationId: ngReportInfo parameters: - $ref: '#/components/parameters/id-2' responses: '200': description: OK content: application/json: schema: type: array description: The filter metadata available for metrics. items: type: object properties: metrics: type: string description: Unique metric identifier. description: type: string description: Description of the metric. filters_supported: type: array description: List of filters applicable. items: type: string default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /ng-reports/scheduled/network-summary: get: tags: - NG Scheduled Reports summary: Get Scheduled Network Summary Reports description: Fetches all the scheduled Network Summary Reports. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_ng_reports_scheduled_network_summary operationId: getScheduledNetworkSummaryReports parameters: - name: keyword in: query description: The keyword to search the report file name and recipient email required: false schema: type: string responses: '200': description: Returns scheduled network summary reports grouped by schedule ID content: application/json: schema: type: object properties: report_id: type: integer format: int64 description: Unique identifier for the Report report_schedule_id: type: integer format: int64 description: Unique Identifier for the Report Schedule enable_schedule: type: boolean default: true description: Whether the schedule is enabled report_runs: type: array items: $ref: '#/components/schemas/XiqScheduledReport' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /ng-reports/scheduled/pci-compliance: get: tags: - NG Scheduled Reports summary: Get Scheduled PCI Compliance Reports description: Fetches all the scheduled PCI Compliance Reports. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_ng_reports_scheduled_pci_compliance operationId: getScheduledPciComplianceReports parameters: - name: keyword in: query description: The keyword to search the report file name and recipient email required: false schema: type: string responses: '200': description: Returns scheduled PCI compliance reports grouped by schedule ID content: application/json: schema: type: object properties: report_id: type: integer format: int64 description: Unique identifier for the Report report_schedule_id: type: integer format: int64 description: Unique Identifier for the Report Schedule enable_schedule: type: boolean default: true description: Whether the schedule is enabled report_runs: type: array items: $ref: '#/components/schemas/XiqScheduledReport' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /ng-reports/scheduled/{reportScheduleId}: patch: tags: - NG Scheduled Reports summary: Enable/Disable Report Schedule description: Enable/Disable an existing schedule for a Report. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_patch_report_schedule operationId: patchReportSchedule parameters: - name: reportScheduleId in: path required: true description: Unique identifier for the report schedule schema: type: integer format: int64 - name: enableSchedule in: query required: false description: Whether the schedule is enabled schema: type: boolean default: true responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /ng-reports/scheduled/custom: get: tags: - NG Scheduled Reports summary: Get Scheduled Custom Reports description: Fetches all the schedules for Custom Reports based on frequency. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_scheduled_custom_reports operationId: getScheduledCustomReports parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/limit' - name: frequency in: query description: Frequency of the report (MONTHLY, WEEKLY, DAILY) required: false schema: type: array items: type: string enum: - MONTHLY - WEEKLY - DAILY - name: keyword in: query description: The keyword to search the report name and recipient email required: false schema: type: string responses: '200': description: Returns a list of scheduled custom reports content: application/json: schema: $ref: '#/components/schemas/PagedCustomScheduledReport' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] post: tags: - NG Scheduled Reports summary: Create Schedule for Custom Report description: Creates a schedule for a Custom Report using the provided schedule ID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_post_scheduled_custom_reports operationId: createCustomReportSchedule requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/XiqCreateCustomReportScheduleRequest' responses: '200': description: Schedule created successfully content: application/json: schema: $ref: '#/components/schemas/XiqCustomReportScheduleResponse' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] delete: tags: - NG Scheduled Reports summary: Delete Report Schedules description: Deletes an existing schedule for a Report. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_delete_report_schedule operationId: deleteReportSchedule parameters: - name: reportScheduleIds in: query required: true description: Comma-separated list of report schedule IDs to delete schema: type: array items: type: integer format: int64 responses: '200': description: Schedule deleted successfully default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /ng-reports/scheduled/custom/{reportId}: get: tags: - NG Scheduled Reports summary: Get Custom Report Schedule by ID description: Fetches a specific scheduled custom report using its report ID. operationId: getScheduledCustomReportById parameters: - name: reportId in: path required: true description: Unique identifier of the scheduled report schema: type: integer format: int64 responses: '200': description: Returns the report details for the given report ID content: application/json: schema: $ref: '#/components/schemas/XiqCustomReportScheduleResponse' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] put: tags: - NG Scheduled Reports summary: Edit Schedule for Custom Report description: Updates an existing schedule for a Custom Report. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_update_custom_report_schedule operationId: updateCustomReportSchedule parameters: - name: reportId in: path required: true description: Unique identifier for the report schedule schema: type: integer format: int64 requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/XiqUpdateCustomReportScheduleRequest' responses: '200': description: Schedule updated successfully content: application/json: schema: $ref: '#/components/schemas/XiqCustomReportScheduleResponse' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /ng-reports/scheduled/custom/{reportScheduleId}/runs: get: tags: - NG Scheduled Reports summary: Get Report Runs for Custom Report Schedule description: Retrieves all report runs for a given custom report schedule. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_custom_report_runs operationId: getCustomReportRuns parameters: - name: reportScheduleId in: path required: true description: Unique identifier for the report schedule schema: type: integer format: int64 - name: frequency in: query required: false description: Filter by frequency (MONTHLY, WEEKLY, DAILY) schema: type: array items: type: string enum: - MONTHLY - WEEKLY - DAILY responses: '200': description: List of report runs content: application/json: schema: type: array items: $ref: '#/components/schemas/XiqReportRun' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /ng-reports/scheduled/runs: delete: tags: - NG Scheduled Reports summary: Delete Report Runs description: Deletes an existing Report schedule run. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_delete_custom_report_run operationId: deleteCustomReportRun parameters: - name: reportRunIds in: query required: true description: Comma-separated list of report run IDs to delete schema: type: array items: type: integer format: int64 responses: '200': description: Report Run deleted successfully default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /ng-reports/scheduled/runs/{reportRunId}/recipients: get: tags: - NG Scheduled Reports summary: Get Recipients for given Report Run description: Retrieves all recipients for a given report run ID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_report_runs_recipients operationId: getReportRunRecipients parameters: - name: reportRunId in: path required: true description: Unique identifier for the report run schema: type: integer format: int64 - name: keyword in: query description: The keyword to search required: false schema: type: string responses: '200': description: List of recipients for the report content: application/json: schema: $ref: '#/components/schemas/XiqReportRunRecipient' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /ng-reports/scheduled/{reportId}/recipients: get: tags: - NG Scheduled Reports summary: Get Recipients for given Report description: Retrieves all recipients for a given report ID. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_report_recipients operationId: getReportRecipients parameters: - name: reportId in: path required: true description: Unique identifier for the report schema: type: integer format: int64 - name: keyword in: query description: The keyword to search required: false schema: type: string responses: '200': description: List of recipients for the report content: application/json: schema: $ref: '#/components/schemas/XiqReportRecipient' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] put: tags: - NG Scheduled Reports 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 required: true description: Unique identifier for the report schema: type: integer format: int64 requestBody: required: true content: application/json: schema: type: object properties: recipients: type: array description: List of recipients to add items: type: object properties: email: type: string description: Recipient email address notifier_id: type: integer format: int64 description: Unique identifier for the notifier responses: '200': description: Recipients added successfully default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] post: tags: - NG Scheduled Reports 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 required: true description: Unique identifier for the report schema: type: integer format: int64 requestBody: required: true content: application/json: schema: type: object properties: recipient_ids: type: array items: type: integer format: int64 description: List of recipient ids to delete responses: '200': description: Recipients deleted successfully default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /ng-reports/scheduled/reports/download: get: tags: - NG Scheduled Reports 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_scheduled_report_file operationId: downloadScheduledReportFile parameters: - name: reportRunId in: query required: true description: Unique identifier of the report to download schema: type: integer format: int64 - name: fileFormat in: query required: true description: File format to download (PDF or XLSX) schema: type: string enum: - PDF - XLSX - name: preview in: query required: false description: Param to view Preview, (applicable only when fileFormat = PDF) schema: type: boolean responses: '200': description: File download or inline preview response content: application/pdf: schema: type: string format: binary application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: schema: type: string format: binary default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /client-details/topology/client-trail/{macAddress}: get: tags: - Client - Details summary: Client Trail Topology description: Return the Nodes and Links to draw the topology for client. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_client_details_topology operationId: clientDetailsTopology parameters: - name: macAddress in: path description: The Mac Address of Client required: true schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/client_details_topology' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /client-details/overview/info/{clientId}: get: tags: - Client - Details summary: Client Details Overview description: Return the Details for the clients. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_get_client_details_info operationId: clientDetailsOverview parameters: - name: clientId in: path description: The Id of Client required: true schema: type: integer format: int64 - name: startTime in: query description: The start time for the data to be returned (in milliseconds since epoch) required: false schema: type: integer format: int64 - name: endTime in: query description: The end time for the data to be returned (in milliseconds since epoch) required: false schema: type: integer format: int64 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/client_details_overview' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] /rtts/supported-devices: post: tags: - RTTS summary: List RTTS supported devices operationId: listRttsSupportedDevices 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 requestBody: content: application/json: schema: $ref: '#/components/schemas/XiqRttsSupportedDevicesRequest' required: true responses: '200': description: OK content: application/json: schema: type: array items: $ref: '#/components/schemas/XiqRttsSupportedDevice' default: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] components: schemas: RateLimitPolicy: type: object description: Configuration for API usage quotas and throughput limits. required: - hour properties: hour: type: integer format: int64 minimum: 1 description: The sustained request quota per hour. Defines the baseline traffic capacity. example: 7500 second: type: integer format: int64 minimum: 1 description: The maximum burst allowance per second. If omitted, no short-term throttling is applied. example: 100 XiqLoginRequest: allOf: - type: object required: - username - password properties: username: type: string description: The login username password: type: string description: The login password rate_limit: $ref: '#/components/schemas/RateLimitPolicy' XiqErrorParams: type: object description: Error parameters properties: field: type: string description: The error field value: type: string description: The error value XiqError: type: object properties: error_code: type: string description: The error code error_id: type: string description: The error ID for internal troubleshooting error_message: type: string description: The error detailed message error_message_code: type: string description: The error message code error_message_description: type: string description: The error message description error_params: $ref: '#/components/schemas/XiqErrorParams' required: - error_code - error_id - error_message XiqLoginResponse: type: object required: - access_token - token_type - expires_in 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 XiqGenerateApiTokenRequest: allOf: - type: object required: - permissions properties: expire_time: type: integer description: The token expire time, format is the number of seconds from epoch of 1970-01-01T00:00:00Z. If null means no expiration, the minimum value is current time plus 300 seconds. format: int64 description: type: string description: The token description permissions: type: array description: The token permissions items: type: string description: The token permissions rate_limit: $ref: '#/components/schemas/RateLimitPolicy' XiqGenerateApiTokenResponse: type: object required: - access_token - create_time - creator_id - customer_id - permissions properties: access_token: type: string description: The API access token create_time: type: string description: The create timestamp format: date-time expire_time: type: string description: The expire timestamp, if null means no expiration format: date-time creator_id: type: integer description: The user ID who created the API token format: int64 customer_id: type: integer description: The customer ID who owns the API token format: int64 description: type: string description: The description for the API token permissions: type: array description: The permissions for the API token items: type: string description: The permissions for the API token XiqApiTokenInfo: type: object required: - user_name - user_id - role - owner_id - data_center - scopes - issued_at properties: user_name: type: string description: The login username user_id: type: integer description: The login user ID format: int64 role: type: string description: The role of login user owner_id: type: integer description: The home ownerId of login user format: int64 data_center: type: string description: The home data center of login user scopes: type: array description: The login user permissions items: type: string description: The login user permissions issued_at: type: string description: The time at which the JWT was issued format: date-time expiration_time: type: string description: The expiration time on or after which the JWT MUST NOT be accepted for processing format: date-time expires_in: type: integer description: The expires in seconds format: int64 XiqCheckPermissionRequest: type: object required: - uri - method properties: uri: type: string description: The request HTTP URI method: type: string description: The request HTTP method XiqPermission: type: object description: The permission required: - name - description - category 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 XiqCheckPermissionResponse: type: object required: - permissions - roles properties: permissions: type: array description: The permission list items: $ref: '#/components/schemas/XiqPermission' roles: uniqueItems: true type: array description: The role list items: type: string description: The role list XiqOperationStatus: type: string description: The current operation status enum: - PENDING - RUNNING - CANCELING - SUCCEEDED - FAILED - CANCELED XiqOperationMetadata: type: object description: The metadata of Long Running Operation (LRO) required: - status - cancelable - create_time - update_time - expires_in properties: status: $ref: '#/components/schemas/XiqOperationStatus' cancelable: type: boolean description: Indicates if the operation can be canceled in the current status percentage: maximum: 100 minimum: 0 type: integer description: The progress in percentage ranges from 0 to 100 (it's not guaranteed to be accurate) format: int32 step: type: string description: The optional step name for multiple steps operations when the operation is running create_time: type: string description: The operation's create time, which is the time when the operation is in PENDING status format: date-time update_time: type: string description: The operation's last update time format: date-time start_time: type: string description: The operation's start time, which is the time when the operation is in RUNNING status format: date-time end_time: type: string description: The operation's end time, which is the time when the operation is done format: date-time expires_in: type: integer description: The number of seconds remaining until the operation expires and is to be deleted. format: int64 XiqOperationObject: type: object description: Long Running Operation (LRO) model required: - id - metadata - done properties: id: type: string description: The unique identifier of the operation metadata: $ref: '#/components/schemas/XiqOperationMetadata' done: type: boolean description: Whether the operation is done response: type: object description: The API response of the operation if the status is SUCCEEDED error: $ref: '#/components/schemas/XiqError' XiqBaseEntity: required: - id - create_time - update_time type: object properties: id: type: integer description: The unique identifier format: int64 create_time: type: string description: The create time format: date-time update_time: type: string description: The last update time format: date-time XiqAccountType: type: string description: Account type enum: - INTERNAL - CUSTOMER - HIQ - PARTNER XiqAccountMode: type: string description: Account mode enum: - COPILOT - CONNECT XiqAccount: allOf: - $ref: '#/components/schemas/XiqBaseEntity' - type: object required: - name - account_type - account_mode - quota - data_center properties: name: type: string description: Account name account_type: $ref: '#/components/schemas/XiqAccountType' account_mode: $ref: '#/components/schemas/XiqAccountMode' quota: type: string description: The API quota policy data_center: type: string description: The default Regional Data Center (RDC) to hold data from customer network industry: type: string description: The industry of the account belongs to country: type: string description: The country for the account state: type: string description: The state for the account (if any) city: type: string description: The city for the account address: type: string description: The address for the account zipcode: type: string description: The zipcode of the address XiqExternalAccount: allOf: - $ref: '#/components/schemas/XiqBaseEntity' - type: object required: - name - alias - active - data_center properties: 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 XiqLicenseStatus: type: string description: The VIQ license status enum: - BUY - PLAN - EVAL - EXPIRED - INVALID - MIGRATED XiqEntitlementType: type: string description: The entitlement key type enum: - EVALUATION - PERMANENT - RENEW - UNKNOWN XiqLicenseMode: type: string description: The license mode enum: - BUY - PLANNER - EVAL - MSP - UNKNOWN XiqViqLicense: allOf: - $ref: '#/components/schemas/XiqBaseEntity' - type: object properties: status: $ref: '#/components/schemas/XiqLicenseStatus' active_date: type: string description: The active date format: date-time expire_date: type: string description: The expire date format: date-time entitlement_key: type: string description: The entitlement key entitlement_type: $ref: '#/components/schemas/XiqEntitlementType' mode: $ref: '#/components/schemas/XiqLicenseMode' devices: type: integer description: The device number format: int32 activated: type: integer description: The activated device number format: int32 available: type: integer description: The available device number format: int32 XiqViq: type: object properties: devices: type: integer description: Total number of all licensed devices format: int32 standalone: type: boolean description: Returns true if HIQ is not enabled, otherwise returns false expired: type: boolean description: Whether VIQ is expired customer_id: type: string description: The customer ID, also known as Salesforce customer ID vhm_id: type: string description: The VIQ ID owner_id: type: integer description: The owner account ID format: int64 licenses: type: array description: The license list items: $ref: '#/components/schemas/XiqViqLicense' XiqDefaultDevicePassword: type: object description: The default device password required: - password properties: password: type: string description: The default device password XiqViqExportReport: type: object description: ExtremeCloud IQ Viq Export data properties: export_status: type: string description: The viq export status export_file_name: type: string description: The viq export report file name log_file_name: type: string description: The viq export log file name XiqViqImportReport: type: object description: ExtremeCloud IQ Viq Import data properties: import_status: type: string description: The viq import status log_file_name: type: string description: The viq import log file name XiqViqStatusType: type: string enum: - EXPORT - IMPORT XiqViqTasks: type: object properties: tesk: type: string description: The name of the task finish_percentage: type: integer description: Task finish percentage format: int64 detail: type: string description: Details of task status: type: string description: Status of the task XiqViqExportImportResponse: type: object properties: user_name: type: string description: The user name of the user vhm_id: type: string description: The VIQ ID operation: type: string description: Type of Operation export/import status: type: string description: Status of the request total_finish_percentage: type: integer description: Total finish percentage of the operation format: int64 task_progress: type: array description: The tasks list items: $ref: '#/components/schemas/XiqViqTasks' export_file_name: type: string description: The VIQ export report file name log_file: type: string description: The VIQ export log file name export_time: type: integer description: The last exported time format: int64 XiqVhmSettingInfo: allOf: - $ref: '#/components/schemas/XiqBaseEntity' - type: object properties: id: type: integer description: VHM Setting Id format: int64 vhm_name: type: string description: The viq name. current_status: type: string description: The viq current status like ACTIVE_STATUS. backed_up_on: type: integer description: The last backup time in milliseconds. format: int64 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 XiqUpdateVhmSettingRequest: type: object properties: 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 XiqVhmSetting: allOf: - $ref: '#/components/schemas/XiqBaseEntity' - type: object properties: id: type: integer description: VHM Setting Id format: int64 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 XiqVhmStatus: type: object description: VHM Account Status properties: vhm_name: type: string description: The viq name. current_status: type: string description: The viq current status like ACTIVE_STATUS. XiqPage: required: - count - page - total_count - total_pages type: object properties: page: type: integer description: The current page number format: int32 count: type: integer description: The element count of the current page format: int32 total_pages: type: integer description: The total page number based on request page size format: int32 total_count: type: integer description: The total element count format: int64 XiqBackupGrid: type: object description: Backup History Grid 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. PagedBackupGrid: allOf: - $ref: '#/components/schemas/XiqPage' - type: object properties: data: type: array description: The data in the current page items: $ref: '#/components/schemas/XiqBackupGrid' XiqThirdPartyApplications: type: object properties: client_id: type: string description: The ID of the application client redirect_url: type: string description: The redirect URL of the application name: type: string description: The name of the application description: type: string description: The description of the application state: type: string description: The state of the application XiqUserRole: type: string description: The user administrative role. enum: - ADMINISTRATOR - OPERATOR - MONITOR - HELP_DESK - GUEST_MANAGEMENT - OBSERVER - INSTALLER - APPLICATION_OPERATOR XiqUser: allOf: - $ref: '#/components/schemas/XiqBaseEntity' - type: object required: - login_name properties: login_name: type: string description: Login name, i.e. username or login Email first_name: type: string description: The first name last_name: type: string description: The last name, i.e. family name display_name: type: string description: The name to display phone: type: string description: The Phone Number job_title: type: string description: The job title locale: type: string description: The locale user_role: $ref: '#/components/schemas/XiqUserRole' idle_timeout: type: integer description: The idle timeout in minutes, the minimum value is 5 minutes and the maximum value is 4 hours format: int32 last_login_time: type: string description: The last login time format: date-time org_id: type: integer description: The HIQ organization ID if it is HIQ user format: int64 PagedXiqUser: allOf: - $ref: '#/components/schemas/XiqPage' - type: object properties: data: type: array description: The data in the current page items: $ref: '#/components/schemas/XiqUser' XiqCreateUserRequest: type: object required: - login_name - display_name - user_role properties: login_name: type: string description: Login name, i.e. username or login Email display_name: type: string description: The user name to display idle_timeout: type: integer description: The idle timeout in minutes, the minimum value is 5 minutes and the maximum value is 4 hours format: int32 user_role: $ref: '#/components/schemas/XiqUserRole' XiqUpdateUserRequest: type: object properties: login_name: type: string description: Login name, i.e. username or login Email display_name: type: string description: The user name to display idle_timeout: type: integer description: The idle timeout in minutes, the minimum value is 5 minutes and the maximum value is 4 hours format: int32 user_role: $ref: '#/components/schemas/XiqUserRole' XiqExternalUser: allOf: - $ref: '#/components/schemas/XiqBaseEntity' - type: object required: - login_name - user_role properties: login_name: type: string description: Login name, i.e. username or login Email user_role: $ref: '#/components/schemas/XiqUserRole' org_id: type: integer description: The HIQ organization ID if it is HIQ user. format: int64 enable_api_access: type: boolean description: Whether to enable API access. PagedXiqExternalUser: allOf: - $ref: '#/components/schemas/XiqPage' - type: object properties: data: type: array description: The data in the current page items: $ref: '#/components/schemas/XiqExternalUser' XiqGrantExternalUserRequest: type: object required: - login_name - user_role properties: login_name: type: string description: Login name, i.e. username or login Email user_role: $ref: '#/components/schemas/XiqUserRole' org_id: type: integer description: The HIQ organization ID if it is HIQ user, otherwise leave it as empty format: int64 enable_api_access: type: boolean description: Whether to enable API access, false by default XiqUpdateExternalUserRequest: type: object properties: user_role: $ref: '#/components/schemas/XiqUserRole' org_id: type: integer description: The HIQ organization ID if it is HIQ user, otherwise leave it as empty. format: int64 enable_api_access: type: boolean description: Whether to enable API access, false by default. XiqSortOrder: type: string enum: - ASC - DESC number_filter: type: object description: If the filter type is between, only then min and max are to be used, else value is to be used. properties: column_name: description: The name of the column being filtered type: string filter_type: description: The type of number filter type: string enum: - eq - neq - gt - gte - lt - lte - bw - blank - notblank value: description: The value of the number type: integer format: int64 min: description: The minimum value of the number type: integer format: int64 max: description: The maximum value of the number type: integer format: int64 RmUsers: type: object 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: Name of the user email: type: string description: Email address of the user group: type: string description: Group to which the user belongs wireless_clients: type: integer description: The number of wireless clients wired_clients: type: integer 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 RmPagedUsers: allOf: - $ref: '#/components/schemas/XiqPage' - type: object properties: data: type: array description: The data in the current page items: $ref: '#/components/schemas/RmUsers' XiqHiqStatus: type: object required: - enabled properties: enabled: type: boolean description: HIQ is enabled or not XiqHiqContext: type: object required: - reading_org_ids - creating_org_id properties: reading_org_ids: type: array description: The organization ID list for reading data (Empty means read data from all organizations in the HIQ) items: type: integer description: The organization ID list for reading data (Empty means read data from all organizations in the HIQ) format: int64 creating_org_id: type: integer description: The organization ID for creating new data format: int64 XiqViqEntity: allOf: - $ref: '#/components/schemas/XiqBaseEntity' - type: object properties: org_id: type: integer description: The organization identifier, valid when enabling HIQ feature format: int64 required: - org_id XiqOrganizationType: type: string description: The organization type enum: - REGULAR - PRIVATE XiqOrganization: allOf: - $ref: '#/components/schemas/XiqViqEntity' - type: object description: The HIQ organization required: - name - type properties: name: type: string description: The organization name type: $ref: '#/components/schemas/XiqOrganizationType' color: type: string description: The tagged color for the organization XiqCreateOrganizationRequest: type: object required: - name properties: name: type: string description: The organization name, must be unique in VIQ color: type: string description: The tagged color for the organization ClsCreateLocationRequest: type: object required: - parent_id - name properties: parent_id: type: integer description: The parent location ID format: int64 name: type: string description: The location name ClsLocation: allOf: - $ref: '#/components/schemas/XiqViqEntity' - type: object description: The hierarchical location for Generic/Building/Floor required: - name - type - unique_name properties: parent_id: type: integer description: The parent location ID format: int64 name: type: string description: The location name unique_name: type: string description: The unique location name type: type: string description: The location type address: type: string description: The address of the location children: type: array description: The child locations items: $ref: '#/components/schemas/ClsLocation' ClsLocationTreeDevice: type: object description: The device on the location hierarchy. required: - device_name - serial_number - mac_address - device_function - product_type - ip_address - location_id - x - y - scale_x - scale_y properties: device_name: type: string description: The name of the device. serial_number: type: string description: The device serial number. mac_address: type: string description: The device MAC address. device_function: type: string description: The device function, such as AP, Router, Switch, etc. product_type: type: string description: 'The product type, such as: AP_230, BR_100, NX9600, etc.' ip_address: type: string description: The device IPv4 address. location_id: type: integer description: The location ID of the device on the location hierarchy. format: int64 map_name: type: string description: The background map for the device overlay. x: type: number description: The x-position of the device relative to the horizontal scale in meter. format: double y: type: number description: The y-position of the device relative to the vertical scale in meter. format: double scale_x: type: number description: The horizontal scale for the background map in meter. format: double scale_y: type: number description: The vertical scale for the background map in meter. format: double PagedClsLocationTreeDevice: allOf: - $ref: '#/components/schemas/XiqPage' - type: object properties: data: type: array description: The data in the current page items: $ref: '#/components/schemas/ClsLocationTreeDevice' ClsLocationTreeMap: type: object description: The map on the location hierarchy. required: - map_name - width - height - data properties: map_name: type: string description: The background map name. width: type: number description: The x-dimension of the map in pixels. format: double height: type: number description: The y-dimension of the map in pixels. format: double data: type: string description: The base-64 encoded string of the map. PagedClsLocationTreeMap: allOf: - $ref: '#/components/schemas/XiqPage' - type: object properties: data: type: array description: The data in the current page items: $ref: '#/components/schemas/ClsLocationTreeMap' ClsUpdateLocationRequest: type: object required: - parent_id - name properties: parent_id: type: integer description: The parent location ID format: int64 name: type: string description: The location name ClsRfEnvironmentType: type: string description: The floor RF environment enum: - AUTO_ESTIMATE - OFFICE - OUTDOOR_FREE_SPACE - OBSTRUCTED_IN_BUILDING - OUTDOOR_SUBURBAN - WAREHOUSE - OUTDOOR_DENSE_URBAN ClsMeasurementUnit: type: string description: The measurement unit in feet/meters enum: - FEET - METERS ClsFloor: allOf: - $ref: '#/components/schemas/XiqViqEntity' - type: object description: The Floor information on the floor plan required: - parent_id - name - unique_name - environment - db_attenuation - measurement_unit - installation_height properties: parent_id: type: integer description: The parent building ID format: int64 name: type: string description: The floor name unique_name: type: string description: The floor unique name environment: $ref: '#/components/schemas/ClsRfEnvironmentType' db_attenuation: type: number description: The floor attenuation in dBs format: double measurement_unit: $ref: '#/components/schemas/ClsMeasurementUnit' installation_height: type: number description: The installation height format: double map_size_width: type: number description: The floormap width format: double map_size_height: type: number description: The floormap height format: double map_name: type: string description: The floormap name ClsCreateFloorRequest: type: object required: - parent_id - name - db_attenuation - measurement_unit - installation_height - map_size_width - map_size_height properties: parent_id: type: integer description: The parent building ID format: int64 name: type: string description: The floor name environment: $ref: '#/components/schemas/ClsRfEnvironmentType' db_attenuation: type: number description: The floor attenuation in dBs format: double measurement_unit: $ref: '#/components/schemas/ClsMeasurementUnit' installation_height: type: number description: The installation height format: double map_size_width: type: number description: The floor map width format: double map_size_height: type: number description: The floor map height format: double map_name: type: string description: The floor map name ClsUpdateFloorRequest: type: object required: - parent_id - name - db_attenuation - measurement_unit - installation_height - map_size_width - map_size_height properties: parent_id: type: integer description: The parent building ID format: int64 name: type: string description: The floor name environment: $ref: '#/components/schemas/ClsRfEnvironmentType' db_attenuation: type: number description: The floor attenuation in dBs format: double measurement_unit: $ref: '#/components/schemas/ClsMeasurementUnit' installation_height: type: number description: The installation height format: double map_size_width: type: number description: The floor map width format: double map_size_height: type: number description: The floor map height format: double map_name: type: string description: The floor map name ClsAddress: type: object required: - address - city - state properties: address: type: string description: The street address 1 address2: type: string description: The street address 2 city: type: string description: the city/town of the address postal_code: type: string description: The postal/ZIP code of the address state: type: string description: The province/state of the address ClsBuilding: allOf: - $ref: '#/components/schemas/XiqViqEntity' - type: object description: The building information required: - name - parent_id properties: parent_id: type: integer description: The parent location ID format: int64 name: type: string description: The location name unique_name: type: string description: The unique location name type: type: string description: The location type address: $ref: '#/components/schemas/ClsAddress' latitude: type: number description: The latitude coordinate for the building format: double longitude: type: number description: The longitude coordinate for the building format: double ClsCreateBuildingRequest: type: object required: - parent_id - name - address properties: parent_id: type: integer description: The parent location ID format: int64 name: type: string description: The building name address: $ref: '#/components/schemas/ClsAddress' latitude: type: number description: The latitude coordinate for the building format: double longitude: type: number description: The longitude coordinate for the building format: double ClsUpdateBuildingRequest: type: object required: - parent_id - name - address properties: parent_id: type: integer description: The parent location ID format: int64 name: type: string description: The building name address: $ref: '#/components/schemas/ClsAddress' latitude: type: number description: The latitude coordinate for the building format: double longitude: type: number description: The longitude coordinate for the building format: double ClsSite: allOf: - $ref: '#/components/schemas/XiqViqEntity' - type: object description: The site information required: - name - parent_id - country_code properties: parent_id: type: integer description: The parent site group ID format: int64 name: type: string description: The site name unique_name: type: string description: The unique site name type: type: string description: The location type country_code: type: integer format: int32 description: The site country code. Get the list of country codes from /countries XAPI address: $ref: '#/components/schemas/ClsAddress' created_by: type: integer description: The user ID used to create the site format: int64 latitude: type: number description: The latitude coordinate for the site address format: double longitude: type: number description: The longitude coordinate for the site address format: double ClsCreateSiteRequest: type: object required: - name - country_code properties: parent_id: type: integer description: The parent site group ID format: int64 name: type: string description: The site name country_code: type: integer format: int32 description: The site country code. Get the list of country codes from /countries XAPI address: $ref: '#/components/schemas/ClsAddress' latitude: type: number description: The latitude coordinate for the site format: double longitude: type: number description: The longitude coordinate for the site format: double ClsUpdateSiteRequest: type: object required: - name - country_code properties: parent_id: type: integer description: The parent site group ID format: int64 name: type: string description: The site name country_code: type: integer format: int32 description: The site country code. Get the list of country codes from /countries XAPI address: $ref: '#/components/schemas/ClsAddress' latitude: type: number description: The latitude coordinate for the site format: double longitude: type: number description: The longitude coordinate for the site format: double ClsWallType: type: object properties: id: type: integer description: The Wall type id format: int64 name: type: string description: The Wall type name attenuation: type: number description: The Wall type attenuation format: double color: type: string description: The Wall type color owner_id: type: integer description: The Owner ID format: int64 org_id: type: integer description: The Org ID format: int64 predefined: type: boolean description: Is the Wall type is predefined ClsCreateWallTypeRequest: required: - attenuation - color - name properties: name: maxLength: 254 type: string description: The Wall type name attenuation: maximum: 999 minimum: -999 type: number description: The Wall type attenuation format: double color: pattern: ^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{8})$ type: string description: The Wall type color ClsUpdateWallTypeRequest: type: object required: - attenuation - color - name properties: name: maxLength: 254 type: string description: The Wall type name attenuation: maximum: 999 minimum: -999 type: number description: The Wall type attenuation format: double color: pattern: ^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{8})$ type: string description: The Wall type color ClsWallTypeReference: type: object properties: folder_id: type: integer description: The folder ID format: int64 path: type: string description: The path XiqDeviceAdminState: type: string enum: - NEW - BOOTSTRAP - STAGED - MANAGED - UNMANAGED XiqDeviceSortField: type: string description: All available device sort fields

MAC = Device MAC Address
SN = Device Serial Number enum: - MAC - SN XiqDeviceView: type: string description: 'The logic collections of device fields

BASIC: ID, ORG_ID, SERIAL_NUMBER, SERVICE_TAG, MAC_ADDRESS, SIMULATED, DEVICE_FUNCTION, PRODUCT_TYPE, HOSTNAME, IP_ADDRESS, SOFTWARE_VERSION, DEVICE_ADMIN_STATE, CONNECTED, CONFIG_MISMATCH
FULL: All fields
STATUS: ID, DEVICE_ADMIN_STATE, CONNECTED
LOCATION: ID, LOCATION_ID, LOCATIONS
CLIENT: ID, ACTIVE_CLIENTS
DETAIL: ID, ORG_ID, CREATE_TIME, UPDATE_TIME, SERIAL_NUMBER, SERVICE_TAG, MAC_ADDRESS,SIMULATED, DEVICE_FUNCTION, PRODUCT_TYPE, HOSTNAME, IP_ADDRESS, SOFTWARE_VERSION, DEVICE_ADMIN_STATE, CONNECTED, LAST_CONNECT_TIME, DNS_SERVER_ADDRESS, SUBNET_MASK, DEFAULT_GATEWAY, IPV6_ADDRESS, IPV6_NETMASK, DISPLAY_VERSION, CONFIG_MISMATCH' 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 - CONFIG_MISMATCH - SYSTEM_UP_TIME - SUBSCRIPTION_LICENSE XiqDeviceNullField: type: string enum: - LOCATION_ID - NETWORK_POLICY_ID XiqLocationEntity: allOf: - $ref: '#/components/schemas/XiqViqEntity' - type: object properties: location_id: type: integer description: The location identifier format: int64 required: - location_id XiqDeviceFunction: type: string description: The device function, such as AP, Router, Switch, etc. enum: - AP - ROUTER - ROUTER_AS_L2_VPN_GATEWAY - ROUTER_AS_L3_VPN_GATEWAY - SWITCH - SWITCH_HAC - SWITCH_DELL - L2_VPN_GATEWAY - L3_VPN_GATEWAY XiqLocationLegend: type: object description: The simple location information properties: id: type: integer description: The location ID format: int64 name: type: string description: The location name XiqDeviceGeolocation: allOf: - type: object properties: latitude: type: integer description: Latitude expressed as a floating point number. longitude: type: integer description: Longitude expressed as a floating point number. height: type: integer majorAxis: type: integer minorAxis: type: integer orientation: type: integer XiqAfcApStatus: type: string description: Status of AP AFC. enum: - PENDING - GRACE_PERIOD - AVAILABLE - NA XiqAfcPowerMode: type: string description: AFC Power Mode enum: - LPI - SP XiqDeviceAfcRadioData: type: object description: The device AFC Radio columns properties: radioIndex: type: integer description: The wifi radio index afcStatus: $ref: '#/components/schemas/XiqAfcApStatus' channel: type: integer powerMode: $ref: '#/components/schemas/XiqAfcPowerMode' power: type: integer XiqDevice: allOf: - $ref: '#/components/schemas/XiqLocationEntity' - type: object description: Generic ExtremeCloud IQ Device model properties: serial_number: type: string description: The device serial number, valid for all non-HAC devices service_tag: type: string description: The device service tag, valid for all HAC devices mac_address: type: string description: The device MAC address device_function: $ref: '#/components/schemas/XiqDeviceFunction' product_type: type: string description: 'The product type, such as: AP_230, BR_100, NX9600, etc.' hostname: type: string description: The device hostname ip_address: type: string description: The device IPv4 address software_version: type: string description: The device OS software version device_admin_state: $ref: '#/components/schemas/XiqDeviceAdminState' connected: type: boolean description: The device connection status last_connect_time: type: string description: The device last connect time format: date-time network_policy_name: type: string description: The network policy name for the device network_policy_id: type: integer description: The network policy ID for the device format: int64 primary_ntp_server_address: type: string description: The primary NTP server address for the device primary_dns_server_address: type: string description: The primary DNS server address for the device subnet_mask: type: string description: The subnet mask for the device default_gateway: type: string description: The default gateway for the device ipv6_address: type: string description: The ipv6 address for the device ipv6_netmask: type: integer description: The ipv6 netmask for the device format: int32 simulated: type: boolean description: The device is simulated or not display_version: type: string description: The display version for the device active_clients: type: integer description: The active client count for the device format: int32 locations: type: array description: The detailed location items: $ref: '#/components/schemas/XiqLocationLegend' country_code: type: integer description: The assigned country code on the device format: int32 configMismatch: type: boolean description: Config audit status(MATCHED(false) or UNMATCHED(true)) system_up_time: type: integer description: The device uptime format: int64 description: type: string description: The device description geoLocation: $ref: '#/components/schemas/XiqDeviceGeolocation' afcRadios: type: array description: Afc related Radio data items: $ref: '#/components/schemas/XiqDeviceAfcRadioData' subscription_license: type: string description: The subscription license of the device PagedXiqDevice: allOf: - $ref: '#/components/schemas/XiqPage' - type: object properties: data: type: array description: The data in the current page items: $ref: '#/components/schemas/XiqDevice' XiqExtremeDevices: type: object description: Extreme/Aerohive devices to onboard required: - sns properties: sns: type: array description: The serial numbers items: type: string description: The serial numbers XiqExosDevices: type: object description: ExtremeXOS (EXOS) devices to onboard required: - sns properties: sns: type: array description: The serial numbers items: type: string description: The serial numbers XiqVossDevices: type: object description: VSP Operating System Software (VOSS) devices to onboard required: - sns properties: sns: type: array description: The serial numbers items: type: string description: The serial numbers XiqWingDevices: type: object description: ExtremeWireless (WiNG) devices to onboard required: - sn_to_mac properties: sn_to_mac: type: object description: Serial number -> MAC address additionalProperties: type: string description: Serial number -> MAC address XiqDellDevices: type: object description: Dell devices to onboard required: - sn_to_st properties: sn_to_st: type: object additionalProperties: type: string description: Serial number -> Service tag description: Serial number -> Service tag XiqDigitalTwinMake: type: string description: The Digital Twin device make. enum: - SWITCH_ENGINE - FABRIC_ENGINE XiqDigitalTwinModel: type: string description: The Digital Twin device model. enum: - DT_5320_16P_4XE - DT_5320_16P_4XE_DC - DT_5320_24P_8XE - DT_5320_24T_8XE - DT_5320_48P_8XE - DT_5320_48T_8XE - DT_5420F_16MW_32P_4XE - DT_5420F_16W_32P_4XE - DT_5420F_24P_4XE - DT_5420F_24S_4XE - DT_5420F_24T_4XE - DT_5420F_48P_4XE - DT_5420F_48P_4XL - DT_5420F_48T_4XE - DT_5420F_8W_16P_4XE - DT_5420M_16MW_32P_4YE - DT_5420M_24T_4YE - DT_5420M_24W_4YE - DT_5420M_48T_4YE - DT_5420M_48W_4YE - DT_5520_12MW_36W - DT_5520_24T - DT_5520_24W - DT_5520_24X - DT_5520_48SE - DT_5520_48T - DT_5520_48W - DT_5520_24T_ACDC - DT_5520_48T_ACDC - DT_5520_24X_ACDC - DT_5520_48SE_ACDC - DT_5720_24MW - DT_5720_24MXW - DT_5720_48MW - DT_5720_48MXW - DT_7520_48YE_8CE - DT_7520_48XT_6C - DT_7520_48Y_8C - DT_7720_32C XiqDigitalTwinVimModule: type: string description: The Digital Twin VIM modules. enum: - DT_5520_VIM_4X - DT_5520_VIM_4XE - DT_5520_VIM_4YE - DT_5720_VIM_2CE - DT_5720_VIM_6YE XiqDigitalTwinFeatLicense: type: string description: The Digital Twin feature licenses. enum: - PRD_5000_PRMR - PRD_5000_MACSEC - PRD_5320_10G_4P - PRD_5320_10G_8P - PRD_7000_MACSEC - PRD_7000_PRMR XiqDigitalTwinDevice: type: object required: - make - model - os_version properties: make: $ref: '#/components/schemas/XiqDigitalTwinMake' model: $ref: '#/components/schemas/XiqDigitalTwinModel' os_type: type: string description: The Digital Twin device OS type. os_version: type: string description: The Digital Twin device OS version. vim_modules: type: array description: The Digital Twin VIM modules. items: $ref: '#/components/schemas/XiqDigitalTwinVimModule' feat_licenses: type: array description: The Digital Twin feature licenses. items: $ref: '#/components/schemas/XiqDigitalTwinFeatLicense' description: The Digital Twin device to onboard. XiqDigitalTwinDevices: type: object properties: dts: type: array description: The Digital Twin devices to onboard. items: $ref: '#/components/schemas/XiqDigitalTwinDevice' description: Digital Twin devices to onboard 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' XiqDeviceLocationAssignment: type: object description: Device location assignment required: - location_id properties: location_id: type: integer description: The assigned location ID, it must be FLOOR type format: int64 x: type: number description: The horizontal value in the floor map format: double y: type: number description: The vertical value in the floor map format: double latitude: type: number description: The latitude in the geography format: double longitude: type: number description: The longitude in the geography format: double XiqExtremeDevice: required: - serial_number type: object properties: serial_number: type: string description: The serial number location: $ref: '#/components/schemas/XiqDeviceLocationAssignment' network_policy_id: type: integer description: The assigned network policy format: int64 hostname: type: string description: The device hostname description: Extreme/Aerohive device to onboard XiqExosDevice: required: - serial_number type: object properties: serial_number: type: string description: The serial number location: $ref: '#/components/schemas/XiqDeviceLocationAssignment' network_policy_id: type: integer description: The assigned network policy format: int64 hostname: type: string description: The device hostname description: ExtremeXOS (EXOS) device to onboard XiqVossDevice: required: - serial_number type: object properties: serial_number: type: string description: The serial number location: $ref: '#/components/schemas/XiqDeviceLocationAssignment' network_policy_id: type: integer description: The assigned network policy format: int64 hostname: type: string description: The device hostname description: VSP Operating System Software (VOSS) device to onboard XiqWingDevice: required: - mac_address - serial_number type: object properties: serial_number: type: string description: The serial number mac_address: type: string description: The mac address location: $ref: '#/components/schemas/XiqDeviceLocationAssignment' network_policy_id: type: integer description: The assigned network policy format: int64 hostname: type: string description: The device hostname description: ExtremeWireless (WiNG) device to onboard XiqDellDevice: required: - serial_number - service_tag type: object properties: serial_number: type: string description: The serial number service_tag: type: string description: The service tag location: $ref: '#/components/schemas/XiqDeviceLocationAssignment' network_policy_id: type: integer description: The assigned network policy format: int64 hostname: type: string description: The device hostname description: Dell device to onboard XiqDigitalTwinOnboardDevice: required: - digital_twin_device type: object properties: digital_twin_device: $ref: '#/components/schemas/XiqDigitalTwinDevice' location: $ref: '#/components/schemas/XiqDeviceLocationAssignment' network_policy_id: type: integer description: The assigned network policy format: int64 hostname: type: string description: The device hostname description: The Digital Twin device to onboard. XiqAdvancedOnboardDeviceRequest: type: object properties: extreme: type: array description: The selected target devices items: $ref: '#/components/schemas/XiqExtremeDevice' exos: type: array description: The selected target devices items: $ref: '#/components/schemas/XiqExosDevice' voss: type: array description: The selected target devices items: $ref: '#/components/schemas/XiqVossDevice' wing: type: array description: The selected target devices items: $ref: '#/components/schemas/XiqWingDevice' dell: type: array description: The selected target devices items: $ref: '#/components/schemas/XiqDellDevice' dt: type: array description: The selected target devices items: $ref: '#/components/schemas/XiqDigitalTwinOnboardDevice' unmanaged: type: boolean description: Whether to unmanage the devices description: The payload to advanced onboard devices XiqSuccessOnboardDevice: required: - device_id - serial_number type: object properties: serial_number: type: string description: The serial number device_id: type: integer description: The device id format: int64 description: The success onboard device XiqOnboardError: type: string description: The onboard error code enum: - UNKNOWN - SUCCEED - EXIST_IN_REDIRECT - FAILED_IN_DB - FAILED_STORE_IN_REDIRECT - SN_IS_NOT_RIGHT - PRODUCT_TYPE_NOT_EXIST - REACH_MAX_SIZE - NOT_SUPPORT_DEVICE - SN_EXISTED_IN_HM - DEVICE_EXISTED - NETMASK_IP_NOT_NULL - BRANCH_ID_USED - INVALID_SERVICE_TAG - RADIO_WIFI1_NOT_SUPPORT - RADIO_PROFILE_NOT_EXIST - SDR_PROFILE_NOT_EXIST - ADMIN_STATE_NOT_SUPPORT - WIFI_POWER_NOT_SUPPORT - OPERATION_MODE_NOT_SUPPORT - COUNTRY_CODE_NOT_SUPPORT - WIFI0_CHANNEL_NOT_SUPPORT - WIFI1_CHANNEL_NOT_SUPPORT - COUNTRY_CODE_IS_NEEDED - MAC_ADDR_REQUIRED - WING_AP_INVALID_ONBOARDING_DATA - NOT_DUAL_BOOT_AP - INVALID_CSV_LOCATION - NOT_SUPPORTED_FOR_CONNECT - DEVICE_EXISTED_ANOTHER_ACCOUNT - FAILED_IN_DTIS_SERVICE - FAILED_IN_DTIS_MAX_CONCURRENT_LIMIT_REACHED - FAILED_DTINSTANCE_ALREADY_ASSOCIATED - FAILED_IN_DTIS_MAX_OVERALL_LIMIT_REACHED - FAILED_IN_DTIS_MAX_LICENSE_LIMIT_REACHED - FAILED_DTINSTANCE_RELAUNCHED_RECENTLY - FAILED_COPILOT_DISABLED - FAILED_IN_DTIS_MAX_CONCURRENT_LIMIT_REACHED_BY_BATCH - FAILED_IN_DTIS_MAX_OVERALL_LIMIT_REACHED_BY_BATCH - NETWORK_POLICY_NOT_FOUND XiqFailureOnboardDevice: required: - serial_number type: object properties: serial_number: type: string description: The serial number error: $ref: '#/components/schemas/XiqOnboardError' description: The fail onboard device XiqAdvancedOnboardDeviceResponse: type: object properties: success_devices: type: array description: The success devices items: $ref: '#/components/schemas/XiqSuccessOnboardDevice' failure_devices: type: array description: The failure devices items: $ref: '#/components/schemas/XiqFailureOnboardDevice' description: The response for advanced onboard devices XiqDeviceFilter: type: object description: The filter to get matched devices properties: ids: type: array description: The device ID list items: type: integer description: The device ID list format: int64 XiqSendCliRequest: type: object description: The request for sending CLIs to devices required: - devices - clis properties: devices: $ref: '#/components/schemas/XiqDeviceFilter' clis: type: array description: The one or multiple CLIs to send items: type: string description: The one or multiple CLIs to send XiqCliResponseCode: type: string description: The CLI response code enum: - UNSPECIFIED - SUCCEED - ERR_DEVICE_NOT_EXIST - ERR_DEVICE_NOT_ACTIVE - ERR_SEND_MESSAGE - ERR_CLI_EXECUTED - ERR_DEVICE_NOT_SUPPORTED - ERR_SIMULATE_NOT_SUPPORTED - ERR_VERSION_NOT_SUPPORTED - ERR_PARSE_FILE - ERR_UNMANAGED_DEVICE - ERR_CLI_NOT_SENT - ERR_TIMEOUT - ERR_VPN_USING - CLI_SENT_SUCCEED - ERR_CLI_MAX_CLI_LIMIT_EXCEEDED XiqCliOutput: type: object description: The CLI output required: - cli - response_code properties: cli: type: string description: The CLI sent to the device response_code: $ref: '#/components/schemas/XiqCliResponseCode' output: type: string description: The CLI output XiqSendCliResponse: type: object description: The response for sending CLIs to devices properties: device_cli_outputs: type: object description: device ID -> CLI outputs additionalProperties: type: array description: device ID -> CLI outputs items: $ref: '#/components/schemas/XiqCliOutput' XiqDeviceLocation: type: object description: Device location info required: - create_time - location_name - location_type - location_unique_name - update_time properties: location_id: type: integer description: The assigned location ID, it must NOT be BUILDING type format: int64 create_time: type: string description: The timestamp when the device assigned to the location format: date-time update_time: type: string description: The timestamp when the location info was last updated format: date-time org_id: type: integer description: The organization identifier, valid when enabling HIQ feature format: int64 parent_id: type: integer description: The parent location ID format: int64 location_name: type: string description: The location name location_unique_name: type: string description: The unique location name location_type: type: string description: The location type location_address: type: string description: The address for the location x: type: number description: The horizontal value in the floor map format: double y: type: number description: The vertical value in the floor map format: double latitude: type: number description: The latitude in the geography format: double longitude: type: number description: The longitude in the geography format: double XiqAssignDevicesLocationRequest: type: object description: Device location assignment for multiple devices required: - devices - device_location properties: devices: $ref: '#/components/schemas/XiqDeviceFilter' device_location: $ref: '#/components/schemas/XiqDeviceLocationAssignment' XiqNetworkPolicy: allOf: - $ref: '#/components/schemas/XiqViqEntity' - type: object description: The network policy required: - name - predefined - type properties: 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 XiqAssignDevicesNetworkPolicyRequest: type: object description: Device network policy assignment for multiple devices required: - devices - network_policy_id properties: devices: $ref: '#/components/schemas/XiqDeviceFilter' network_policy_id: type: integer description: The assigned network policy format: int64 XiqCountryCode: type: string description: The country code. enum: - AFGHANISTAN_4 - ALGERIA_12 - ARGENTINA_32 - ARUBA_533 - AUSTRALIA_36 - AUSTRIA_40 - AZERBAIJAN_31 - BAHAMAS_44 - BAHRAIN_48 - BANGLADESH_50 - BARBADOS_52 - BELARUS_112 - BELGIUM_56 - BERMUDA_60 - BHUTAN_64 - BOLIVIA_68 - BRAZIL_76 - BULGARIA_100 - CAMBODIA_116 - CAMEROON_120 - CANADA_124 - CAYMAN_ISLANDS_136 - CHILE_152 - COLOMBIA_170 - COSTA_RICA_188 - CROATIA_191 - CYPRUS_196 - CZECH_REPUBLIC_203 - DENMARK_208 - DOMINICAN_REPUBLIC_214 - ECUADOR_218 - EGYPT_818 - EL_SALVADOR_222 - ESTONIA_233 - FINLAND_246 - FRANCE_250 - FRENCH_GUIANA_254 - GEORGIA_268 - GERMANY_276 - GHANA_288 - GREECE_300 - GUAM_316 - GUATEMALA_320 - GUYANA_328 - HAITI_332 - HONDURAS_340 - HONG_KONG_344 - HUNGARY_348 - ICELAND_352 - INDIA_356 - INDONESIA_360 - IRELAND_372 - PAKISTAN_586 - ISRAEL_376 - ITALY_380 - JAMAICA_388 - JAPAN_4014 - JORDAN_400 - KAZAKHSTAN_398 - KENYA_404 - KOREA_410 - KUWAIT_414 - KYRGYZSTAN_417 - LATVIA_428 - LEBANON_422 - LIECHTENSTEIN_438 - LITHUANIA_440 - LUXEMBOURG_442 - MACAO_446 - MALAWI_454 - MALAYSIA_458 - MALTA_470 - MAURITIUS_480 - MEXICO_484 - MOLDOVA_498 - MOROCCO_504 - MOZAMBIQUE_508 - NEPAL_524 - NETHERLANDS_528 - NEW_CALEDONIA_540 - NEW_ZEALAND_554 - NICARAGUA_558 - NIGERIA_566 - NORWAY_578 - OMAN_512 - PALAU_585 - PANAMA_591 - PAPUA_NEW_GUINEA_598 - PARAGUAY_600 - CHINA_156 - PERU_604 - POLAND_616 - PORTUGAL_620 - PUERTO_RICO_630 - QATAR_634 - PHILIPPINES_608 - ROMANIA_642 - RUSSIA_643 - SAUDI_ARABIA_682 - SERBIA_688 - SINGAPORE_702 - SLOVAK_REPUBLIC_703 - SLOVENIA_705 - SOUTH_AFRICA_710 - SPAIN_724 - SRI_LANKA_144 - SURINAME_740 - SWEDEN_752 - SWITZERLAND_756 - TAIWAN_158 - TANZANIA_834 - THAILAND_764 - REPUBLIC_OF_MACEDONIA_807 - TOGO_768 - TRINIDAD_Y_TOBAGO_780 - TUNISIA_788 - TURKEY_792 - TURKS_AND_CAICOS_ISLANDS_796 - U_A_E_784 - US_VIRGIN_ISLANDS_850 - UKRAINE_804 - UNITED_KINGDOM_826 - UNITED_STATES_840 - URUGUAY_858 - VANUATU_548 - VENEZUELA_862 - VIETNAM_704 XiqAssignDevicesCountryCodeRequest: type: object description: Device country-code assignment for multiple devices required: - devices - country_code properties: devices: $ref: '#/components/schemas/XiqDeviceFilter' country_code: $ref: '#/components/schemas/XiqCountryCode' XiqChangeDevicesOsModeRequest: type: object description: The request for change the device(s) OS mode. required: - device_ids - target_os properties: device_ids: maxItems: 2147483647 minItems: 1 type: array description: 'The one or multiple device IDs to change the OS mode. Must be all AP or Switches in the same list. For AP only "AP_410C", "AP_460C", "AP_305C", "AP_305CX", "AP_460S6C", "AP_460S12C", "AP_302W" are allowed change to WiNG OS. For Switch: only "5520", "5420F", "5420M" are allowed to change its OS type.' items: type: integer description: 'The one or multiple device IDs to change the OS mode. Must be all AP or Switches in the same list. For AP only "AP_410C", "AP_460C", "AP_305C", "AP_305CX", "AP_460S6C", "AP_460S12C", "AP_302W" are allowed change to WiNG OS. For Switch: only "5520", "5420F", "5420M" are allowed to change its OS type.' format: int64 target_os: type: string description: 'The target OS mode to change to, for AP: only WiNG is supported, for Switch: EXOS or VOSS' example: WiNG XiqChangeDevicesIbeaconRequest: type: object description: The request to update the existing devices' iBeacon settings or create the settings if they have not already been created. required: - device_ids properties: device_ids: maxItems: 2147483647 minItems: 1 type: array description: 'The one or multiple device IDs to change the iBeacon settings. You can configure the embedded iBeacon transmitter in the following APs: AP122, AP122X, AP150W, AP245X, AP250, and AP550.' items: type: integer description: 'The one or multiple device IDs to change the iBeacon settings. You can configure the embedded iBeacon transmitter in the following APs: AP122, AP122X, AP150W, AP245X, AP250, and AP550.' format: int64 enabled: type: boolean description: Whether to enable the device beacon. Default to True on new device iBeacon setting. major: maximum: 65635 minimum: 0 type: integer description: Identification of a subset of beacons in a venue. Default to 1 on new device iBeacon setting. format: int32 minor: maximum: 65635 minimum: 0 type: integer description: Identification of a beacon in a specific location. Default to 1 on new device iBeacon setting. format: int32 power: maximum: 127 minimum: -128 type: integer description: The transmission power in dBm. Default to -59 on new device iBeacon setting. format: int32 enable_monitoring: type: boolean deprecated: true description: Whether to enable iBeacon monitoring. Default to True on new device iBeacon setting. This has been marked deprecated as it has been renamed, please use '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 to enable BLE Scan Cloud Reporting. enable_batch_reporting: type: boolean description: Whether to enable BLE Scan Batch Reporting. network_policy_ibeacon_id: type: integer description: The beacon network policy ID format: int64 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 XiqDeviceLevelSsid: type: object description: The ssid/passphrase for device level ssid to override required: - ssid_id properties: ssid_id: type: integer description: The SSID ID to override, cannot be null. format: int64 ssid: type: string description: The broadcast ssid name to override. Can only override if the SSID profile is OPEN or PSK mode. passphrase: type: string description: The ssid passphrase to override. Can only override if the SSID profile is in PSK mode. XiqDeviceLevelSsidStatus: type: object description: The SSID status required: - wifi0_enabled - wifi1_enabled 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 XiqWirelessIfName: type: string description: The one or multiple ssid on wifi interfaces (example:wifi0 or wifi1) to be disabled/enabled, cannot be empty or no SSID will be disabled or enabled. enum: - WIFI0 - WIFI1 - WIFI2 XiqUpdateDeviceLevelSsidStatus: type: object description: The request for disable/enable device level ssid. required: - ssid_ids - if_names - enabled properties: ssid_ids: type: array description: The one or multiple SSID to be disabled/enabled, cannot be empty or no action will be triggered. items: type: integer description: The one or multiple SSID to be disabled/enabled, cannot be empty or no action will be triggered. format: int64 if_names: type: array description: The one or multiple ssid on wifi interfaces (example:wifi0 or wifi1) to be disabled/enabled, cannot be empty or no SSID will be disabled or enabled. items: $ref: '#/components/schemas/XiqWirelessIfName' enabled: type: boolean description: To disable or enable the given device level SSIDs on the wifi interfaces. XiqDeviceAlarm: type: object description: The device alarm view properties: entity_id: type: integer description: The device ID format: int64 timestamp: type: integer description: The timestamp for alarm created format: int64 severity: type: string description: The severity of the alarm category: type: string description: The category of the alarm device_mac: type: string description: The device MAC of the alarm client_mac: type: string description: The client MAC of the alarm description: type: string description: The alarm description PagedXiqDeviceAlarm: allOf: - $ref: '#/components/schemas/XiqPage' - type: object properties: data: type: array description: The data in the current page items: $ref: '#/components/schemas/XiqDeviceAlarm' XiqDeviceCpuMemoryUsage: type: object description: Get time series of the average device cpu and memory usage properties: average_cpu: type: integer description: The device average cpu usage format: int32 average_memory: type: integer description: The device average memory usage format: int32 timestamp: type: integer description: The timestamp for data aggregate format: int64 XiqDeviceIbeacon: type: object description: The device iBeacon settings. required: - enabled - major - minor - power - enable_monitoring - enable_cloud_reporting - enable_batch_reporting properties: id: type: integer description: The device iBeacon ID. format: int64 enabled: type: boolean description: Whether the device iBeacon is enabled. major: type: integer description: Identification of a subset of beacons in a venue. Valid values are 0 to 65635. format: int32 minor: type: integer description: Identification of a beacon in a specific location. Valid values are 0 to 65635. format: int32 power: type: integer description: The transmission power in dBm. Valid values are 0 to 65635. format: int32 enable_monitoring: type: boolean deprecated: true description: Whether to enable iBeacon monitoring. Default to True on new device iBeacon setting. This has been marked deprecated as it has been renamed, please use '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 iBeacon Cloud Reporting is enabled. enable_batch_reporting: type: boolean description: Whether the device iBeacon Batch Reporting is enabled. network_policy_ibeacon_id: type: integer description: The beacon network policy ID. format: int64 XiqIotApplicationId: type: string enum: - THREAD_GATEWAY description: IoT application identifiers. XiqIotApplicationSupported: type: string enum: - SINGLE - MULTI description: IoT profile supported type. XiqIotpTgWhiteListEntry: type: object required: - long_eui - pskd properties: long_eui: oneOf: - type: string minLength: 16 maxLength: 16 pattern: ^[0-9a-fA-F]+$ description: The factory-assigned IEEE EUI-64. (16 hex digits). FFFFFFFFFFFFFFFF is reserved. - type: string pattern: ^\*$ description: Match any joiner. pskd: type: string minLength: 6 maxLength: 32 description: 'The PSKd (Pre-Shared-Key for the Device) is the Joining Device Credential encoded using base32-thread. A Joining Device Credential is encoded as uppercase, alphanumeric characters (base32-thread: 0-9,A-Y excluding I,O,Q, and Z for readability) with a minimum length of 6 such characters and a maximum length of 32 such characters.' pattern: '[0-9ABCDEFGHJKLMNPRSTUVWXY]+' XiqIotProfileThreadGateway: type: object required: - name - app_supported properties: app_id: $ref: '#/components/schemas/XiqIotApplicationId' app_supported: $ref: '#/components/schemas/XiqIotApplicationSupported' name: type: string description: The IoT profile name threadGateway: type: object required: - short_pan_id - ext_pan_id - master_key - network_name - channel properties: short_pan_id: type: string minLength: 4 maxLength: 4 pattern: ^[0-9a-fA-F]+$ description: The Personal Area Network (PAN) ID. (4 hex digits). FFFF is reserved. ext_pan_id: type: string minLength: 16 maxLength: 16 pattern: ^[0-9a-fA-F]+$ description: The Extended Personal Area Network (PAN) ID. (16 hex digits) master_key: type: string minLength: 32 maxLength: 32 pattern: ^[0-9a-fA-F]+$ description: The network key is used to secure access to the Thread network. It is used to encrypt and authenticate all messages on the network. (32 hex digits) network_name: type: string minLength: 1 maxLength: 16 description: A human-readable name for the network, up to 16 bytes in length. channel: type: integer minimum: 0 description: 802.15.4 channel number, 11-26 enable_nat64: type: boolean default: true description: Enable NAT64 functions including the translator and the prefix publishing. comm_credentials: type: string minLength: 6 maxLength: 255 pattern: ^.{6,255}$ description: The Commissioner Credential is used along with the Extended PAN ID, and Network Name to create the PSKc (Pre-Shared Key for the Commissioner). comm_timeout: type: integer default: 120 minimum: 1 maximum: 2000000 description: After this timeout the Commissioner will shutdown. The default is 120 sec. but the max is approximately 23 days. white_list: type: array items: $ref: '#/components/schemas/XiqIotpTgWhiteListEntry' description: The table of approved Thread end-devices. default_user_profile_id: type: integer description: The default user-profile ID. format: int64 enable_dns_search_domain: type: boolean default: false description: Enable adding DNS search domain to unqualified host lookups forwarded by upstream DNS (in the thread border router). XiqIotpMaBleBeaconAppType: type: string description: The BLE Beacon application type. enum: - IBEACON - EDDYSTONE_URL XiqIotpMaBleBeaconIBeacon: type: object required: - app_type - major - minor - uuid properties: app_type: $ref: '#/components/schemas/XiqIotpMaBleBeaconAppType' major: maximum: 65535 minimum: 0 default: 0 type: integer format: int32 description: BLE Beacon iBeacon application major value. minor: maximum: 65535 minimum: 0 default: 0 type: integer format: int32 description: BLE Beacon iBeacon application minor value. uuid: type: string default: 00000000-0000-0000-0000-000000000000 format: uuid description: BLE Beacon iBeacon application UUID. measured_rss: maximum: 15 minimum: -120 default: -52 type: integer format: int32 description: BLE Beacon iBeacon application measured Received Signal Strength value, in dBm. advertise_interval: maximum: 10240 minimum: 100 default: 500 type: integer format: int32 description: BLE Beacon iBeacon application advertising interval value in milliseconds. tx_power: maximum: 3 minimum: -16 default: 3 type: integer format: int32 description: BLE Beacon Eddystone-url transmit power, measured in dBm. XiqIotpMaBleBeaconEddystoneUrl: type: object required: - app_type - url properties: app_type: $ref: '#/components/schemas/XiqIotpMaBleBeaconAppType' url: type: string maxLength: 34 format: uri description: BLE Beacon Eddystone-url application URL. measured_rss: maximum: 15 minimum: -120 default: -30 type: integer format: int32 description: BLE Beacon Eddystone-url application measured Received Signal Strength Indication value. advertise_interval: maximum: 10240 minimum: 100 default: 500 type: integer format: int32 description: BLE Beacon Eddystone-url application advertising interval value in milliseconds. tx_power: maximum: 3 minimum: -16 default: 3 type: integer format: int32 description: BLE Beacon Eddystone-url transmit power, measured in dBm. XiqIotpMaBleBeaconApplication: type: object description: The BLE Beacon application oneOf: - $ref: '#/components/schemas/XiqIotpMaBleBeaconIBeacon' - $ref: '#/components/schemas/XiqIotpMaBleBeaconEddystoneUrl' discriminator: propertyName: app_type mapping: IBEACON: '#/components/schemas/XiqIotpMaBleBeaconIBeacon' EDDYSTONE_URL: '#/components/schemas/XiqIotpMaBleBeaconEddystoneUrl' XiqIotpMaBleBeacon: type: object properties: applications: type: array maxItems: 2 description: Collection of BLE Beacon applications items: $ref: '#/components/schemas/XiqIotpMaBleBeaconApplication' XiqHttpServer: type: object required: - url properties: url: type: string maxLength: 256 format: uri description: The HTTP server URL. interval: maximum: 60 minimum: 1 default: 10 type: integer format: int32 description: The HTTP server interval, in seconds. enable_deduplication: type: boolean default: true description: Enable to remove BLE scan duplicates entries within the specified time interval. XiqIotpMaBleScanDestination: type: object description: The BLE Scan destination. properties: http_server: $ref: '#/components/schemas/XiqHttpServer' XiqIotpMaBleScanAppType: type: string description: The BLE Scan application type. enum: - IBEACON - EDDYSTONE_URL - GENERIC XiqIotpMaBleScanIBeacon: type: object required: - app_type properties: app_type: $ref: '#/components/schemas/XiqIotpMaBleScanAppType' min_rss: maximum: 20 minimum: -120 default: -100 type: integer format: int32 description: BLE Scan iBeacon application minimum Received Signal Strength value, in dBm. uuid: type: string default: 00000000-0000-0000-0000-000000000000 format: uuid description: BLE Scan iBeacon application UUID. A value of "00000000-0000-0000-0000-000000000000" indicates no filtering is applied. XiqIotpMaBleScanEddystoneUrl: type: object required: - app_type properties: app_type: $ref: '#/components/schemas/XiqIotpMaBleScanAppType' min_rss: maximum: 20 minimum: -120 default: -100 type: integer format: int32 description: BLE Scan Eddystone-url application minimum Received Signal Strength value, in dBm. XiqIotpMaBleScanVendorType: type: string description: The BLE Scan Vendor types for BLE Scan applications. enum: - ANY - CHORUS - CUSTOM XiqIotpMaBleScanVendor: type: object required: - company_id properties: vendor_type: $ref: '#/components/schemas/XiqIotpMaBleScanVendorType' vendor_name: type: string description: Custom Vendor name, for CUSTOM Vendor type. company_id: maximum: 65535 minimum: -1 default: -1 type: integer format: int32 description: Unique company identifier. This value will be used as a filter, whereby if specified the AP will only forward frames for beacons with matching value on the 2 byte field 6 - 7. A value of "-1" indicates no filtering is applied. Company IDs provided at https://www.bluetooth.com/specifications/assigned-numbers/company-identifiers/ XiqIotpMaBleScanGeneric: type: object required: - app_type properties: app_type: $ref: '#/components/schemas/XiqIotpMaBleScanAppType' min_rss: maximum: 20 minimum: -120 default: -100 type: integer format: int32 description: BLE Scan Eddystone-url application minimum Received Signal Strength value, in dBm. vendors: type: array maxItems: 5 description: Collection of BLE Scan vendor filters for Generic Scan applications. items: $ref: '#/components/schemas/XiqIotpMaBleScanVendor' XiqIotpMaBleScanApplication: type: object description: The BLE Scan application oneOf: - $ref: '#/components/schemas/XiqIotpMaBleScanIBeacon' - $ref: '#/components/schemas/XiqIotpMaBleScanEddystoneUrl' - $ref: '#/components/schemas/XiqIotpMaBleScanGeneric' discriminator: propertyName: app_type mapping: IBEACON: '#/components/schemas/XiqIotpMaBleScanIBeacon' EDDYSTONE_URL: '#/components/schemas/XiqIotpMaBleScanEddystoneUrl' GENERIC: '#/components/schemas/XiqIotpMaBleScanGeneric' XiqIotpMaBleScan: type: object properties: destination: $ref: '#/components/schemas/XiqIotpMaBleScanDestination' applications: type: array maxItems: 3 description: Collection of BLE Scan applications items: $ref: '#/components/schemas/XiqIotpMaBleScanApplication' XiqIotProfileMultiApplication: type: object required: - name - app_supported properties: app_supported: $ref: '#/components/schemas/XiqIotApplicationSupported' name: type: string description: The IoT profile name ble_beacon: $ref: '#/components/schemas/XiqIotpMaBleBeacon' ble_scan: $ref: '#/components/schemas/XiqIotpMaBleScan' XiqIotProfileRequest: type: object description: The IoT Profile oneOf: - $ref: '#/components/schemas/XiqIotProfileThreadGateway' - $ref: '#/components/schemas/XiqIotProfileMultiApplication' discriminator: propertyName: app_supported mapping: SINGLE: '#/components/schemas/XiqIotProfileThreadGateway' MULTI: '#/components/schemas/XiqIotProfileMultiApplication' XiqDeviceIot: type: object description: The device IoT profile Wireless Interface settings. required: - enabled properties: enabled: type: boolean description: Whether the device IoT profile Wireless Interface is enabled. iot_profile: $ref: '#/components/schemas/XiqIotProfileRequest' XiqDeviceVlanAttrDhcpSnoopingAction: type: string enum: - NONE - DROP_PACKET XiqClassificationType: type: string description: Classification type enum: - LOCATION - CLOUD_CONFIG_GROUP - IP_ADDRESS - IP_SUBNET - IP_RANGE XiqClassification: allOf: - $ref: '#/components/schemas/XiqBaseEntity' - type: object description: The payload of common object - classification required: - classification_type - match - classification_id - value properties: classification_type: $ref: '#/components/schemas/XiqClassificationType' match: type: boolean description: Contains or not contains classification_id: type: integer description: The ID of location, cloud config group, IP address, IP subnet or IP range. format: int64 value: type: string description: The value of classification XiqClassificationRule: allOf: - $ref: '#/components/schemas/XiqBaseEntity' - type: object description: The payload of common object - classification assignment required: - name properties: name: type: string description: The classification assignment name description: type: string description: The classification assignment description classifications: type: array description: The details of rule assignments items: $ref: '#/components/schemas/XiqClassification' XiqVlanObjectClassifiedEntry: allOf: - $ref: '#/components/schemas/XiqBaseEntity' - type: object description: The payload of VLAN object classified entry required: - vlan_id properties: vlan_id: type: integer description: The VLAN ID format: int32 classification_rule: $ref: '#/components/schemas/XiqClassificationRule' XiqVlanProfile: allOf: - $ref: '#/components/schemas/XiqBaseEntity' - type: object description: The payload of common object - VLAN profile required: - name - default_vlan_id - enable_classification properties: name: type: string description: The VLAN profile name default_vlan_id: type: integer description: The default VLAN ID format: int32 enable_classification: type: boolean description: If apply VLANs to devices using classification classified_entries: type: array description: The VLAN object classified entries items: $ref: '#/components/schemas/XiqVlanObjectClassifiedEntry' XiqDeviceBaseVlanAttributes: type: object description: The payload of a VLAN attribute object properties: name: type: string description: Name of the VLAN dhcp_snooping_enabled: type: boolean description: Whether dhcp snooping is enabled on this VLAN dhcp_snooping_action: type: object $ref: '#/components/schemas/XiqDeviceVlanAttrDhcpSnoopingAction' description: Action to take when rogue DHCP packets are detected when dhcp snooping is enabled. igmp_snooping_enabled: type: boolean description: Whether igmp snooping is enabled on this VLAN immediate_leave: type: boolean description: When enabled, the multicast host is removed immediately if it leaves the group. Applicable when igmp snooping is enabled. always_create: type: boolean description: Whether the VLAN should be created even if not assigned to any port isid_id: type: integer description: ISID ID isid_name: type: string description: Name of the ISID vlanObj: type: object $ref: '#/components/schemas/XiqVlanProfile' description: VLAN common object XiqDeviceVlanAttributes: allOf: - type: object description: The payload of a VLAN attribute object properties: vlan_id: type: integer description: The VLAN ID format: int32 - $ref: '#/components/schemas/XiqDeviceBaseVlanAttributes' PagedXiqDeviceVlanAttributes: allOf: - $ref: '#/components/schemas/XiqPage' - type: object properties: data: type: array description: The data in the current page items: $ref: '#/components/schemas/XiqDeviceVlanAttributes' XiqDeviceCreateVlanAttributes: allOf: - type: object description: The payload of a VLAN attribute object required: - vlan_id - name - dhcp_snooping_enabled - igmp_snooping_enabled - always_create properties: vlan_id: type: integer description: The VLAN ID format: int32 - $ref: '#/components/schemas/XiqDeviceBaseVlanAttributes' XiqDeviceUpdateVlanAttributes: allOf: - $ref: '#/components/schemas/XiqDeviceBaseVlanAttributes' - minProperties: 1 XiqDigitalTwinProducts: type: object description: The Digital Twin product information. required: - make - model - os_versions properties: make: type: string description: The Digital Twin device make. model: type: string description: The Digital Twin device model. os_type: type: string description: The Digital Twin device OS type. os_versions: type: array description: The Digital Twin device OS versions. items: type: string description: The Digital Twin device OS versions. PagedXiqDigitalTwinProducts: allOf: - $ref: '#/components/schemas/XiqPage' - type: object properties: data: type: array description: The data in the current page items: $ref: '#/components/schemas/XiqDigitalTwinProducts' XiqBounceDevicePortRequest: type: object description: The request for bounce port for the given device id. required: - interfaceName properties: portNumber: type: string description: The port number of the device (eg. 1,2, ..) bouncePortReason: type: string description: The reason to bounce the port of the specific device/switch. XiqBounceDevicePortOperationResult: allOf: - type: object description: Generic ExtremeCloud IQ Device model properties: status: type: string description: The status value message: type: string description: The message XiqBounceDevicePortData: allOf: - type: object description: Generic ExtremeCloud IQ Device model properties: status: type: integer description: The status value requestId: type: integer description: The requestId of the response format: int32 results: type: array description: The list of results items: $ref: '#/components/schemas/XiqBounceDevicePortOperationResult' XiqBounceDevicePortResponse: allOf: - type: object description: Generic ExtremeCloud IQ Device model properties: data: $ref: '#/components/schemas/XiqBounceDevicePortData' XiqDeviceGatewayIpType: type: string enum: - FIRST - LAST XiqDeviceDhcpServiceType: type: string enum: - DHCP_RELAY_AGENT - DHCP_SERVER XiqDeviceDhcpPlatform: type: string enum: - SWITCH_ENGINE_OR_FABRIC_ENGINE - XR_OR_AP XiqDeviceDhcpRelay: type: object description: DHCP relay agent and server. required: - name - service_type - platform properties: id: type: integer description: The DHCP relay agent and server ID format: int64 name: type: string description: Name of DHCP relay agent or server description: type: string description: Description of DHCP relay agent or server service_type: type: object $ref: '#/components/schemas/XiqDeviceDhcpServiceType' description: Service type DHCP Agent or DHCP Server platform: type: object $ref: '#/components/schemas/XiqDeviceDhcpPlatform' description: Platform type selection XR / AP or VOSS / EXOS primary_server: type: string description: Primary Ip server of DHCP agent secondary_server: type: string description: Secondary Ip server of DHCP agent XiqDeviceSubnetworkIpv4: type: object description: The IPv4 Subnetwork Interface that is configured on the device. required: - name - ip_addr_space - gateway_ip_type - vlan_profile - clients_number properties: id: type: integer description: The IPv4 Subnetwork Interface ID format: int64 name: type: string description: Subnetwork name description: type: string description: Subnetwork description ip_addr_space: type: string description: Subnetwork Ipv4 address gateway_ip_type: type: object $ref: '#/components/schemas/XiqDeviceGatewayIpType' description: Subnetwork gateway type first or last IP address available vlan_profile: type: string description: VLAN profile ID enable_dhcp: type: boolean description: Enable DHCP relay server dhcp_relay: $ref: '#/components/schemas/XiqDeviceDhcpRelay' clients_number: type: integer description: Number of clients available for subnetwork format: int64 XiqDeviceConfigureIpv4InterfacesInfo: type: object description: The IPv4 Interface that is configured on the device. properties: subnetwork: $ref: '#/components/schemas/XiqDeviceSubnetworkIpv4' vlan_attribute: $ref: '#/components/schemas/XiqDeviceVlanAttributes' ip_address: type: string description: The IPv4 address set on the interface ip_address_to_int: type: integer description: The IPv4 address set on the interface to numeric format format: int64 routing_instance: type: string description: The Routing Instance enable_forwarding: type: boolean description: Indicates whether or not IPv4 is forwarding on the VLAN enable_vlan_loopback: type: boolean description: Indicates whether or not Vlan Loopback is enabled on the interface use_ip_addr_as_ospf_router_id: type: boolean description: Indicates whether or not to use ip address as ospf router id on the interface override_dhcp_relay: type: boolean description: Indicates whether or not to override DHCP relay on the interface enable_dhcp: type: boolean description: Indicates whether or not to enable DHCP relay on the interface if override DHCP relay is enabled primary_dhcp_server: type: string description: Primary DHCP Server can be set if DHCP is enabled secondary_dhcp_server: type: string description: Secondary DHCP Server can be set if DHCP is enabled XiqDeviceConfigureIpv4Interface: allOf: - type: object description: The payload of a IPv4 Interface properties: ipv4_interface_id: type: integer description: The IPv4 Interface ID format: int64 - $ref: '#/components/schemas/XiqDeviceConfigureIpv4InterfacesInfo' PagedXiqDeviceConfigureIpv4Interfaces: allOf: - $ref: '#/components/schemas/XiqPage' - type: object properties: data: type: array description: The data in the current page items: $ref: '#/components/schemas/XiqDeviceConfigureIpv4Interface' XiqDeviceConfigureIpv4InterfacesRequest: type: object description: The IPv4 Interface Request that is configured on the device. properties: ip_address: type: string description: The IPv4 address set on the interface routing_instance: type: string description: The Routing Instance enable_forwarding: type: boolean description: Indicates whether or not IPv4 is forwarding on the VLAN enable_vlan_loopback: type: boolean description: Indicates whether or not Vlan Loopback is enabled on the interface use_ip_addr_as_ospf_router_id: type: boolean description: Indicates whether or not to use ip address as ospf router id on the interface override_dhcp_relay: type: boolean description: Indicates whether or not to override DHCP relay on the interface enable_dhcp: type: boolean description: Indicates whether or not to enable DHCP relay on the interface if override DHCP relay is enabled primary_dhcp_server: type: string description: Primary DHCP Server can be set if DHCP is enabled secondary_dhcp_server: type: string description: Secondary DHCP Server can be set if DHCP is enabled XiqDeviceCreateConfigureIpv4Interface: allOf: - type: object description: The payload of a IPv4 Interface required: - ip_address properties: vlan_id: type: integer description: VLAN attribute ID format: int32 - $ref: '#/components/schemas/XiqDeviceConfigureIpv4InterfacesRequest' XiqDeviceConfigureIpv4InterfacesResponse: allOf: - type: object description: The payload of a IPv4 Interface required: - subnetwork_id - vlan_attribute - ip_address - ipv4_interface_id properties: subnetwork_id: type: integer description: Subnetwork ID format: int64 ipv4_interface_id: type: integer description: IPv4 Interface ID format: int64 vlan_attribute: $ref: '#/components/schemas/XiqDeviceVlanAttributes' - $ref: '#/components/schemas/XiqDeviceConfigureIpv4InterfacesRequest' - minProperties: 1 XiqDeviceUpdateConfigureIpv4Interface: allOf: - type: object description: The payload of a IPv4 Interface required: - subnetwork_id - vlan_profile - ip_address properties: subnetwork_id: type: integer description: Subnetwork ID format: int64 vlan_id: type: integer description: VLAN attribute ID format: int32 - $ref: '#/components/schemas/XiqDeviceConfigureIpv4InterfacesRequest' - minProperties: 1 XiqDeviceConfigureIpv4StaticRoutesInfo: type: object description: The IPv4 Static Route that is configured on the device. properties: name: type: string description: Name of the static route dest_subnetwork: type: string description: Destination subnetwork IP and mask dest_subnetwork_to_int: type: integer description: Destination subnetwork IP and mask to numeric format format: int64 next_hop_ip: type: string description: Next hop IP next_hop_ip_to_int: type: integer description: Next hop IP to numeric format format: int64 next_hop_ip_ping_protection: type: boolean description: Next hop IP ping protection metric: type: integer description: Metric set up on a static route format: int32 routing_instance: type: string description: The Routing Instance XiqDeviceConfigureIpv4StaticRoute: allOf: - type: object description: The payload of a IPv4 Static Route properties: ipv4_static_route_id: type: integer description: The IPv4 Static Route ID format: int64 - $ref: '#/components/schemas/XiqDeviceConfigureIpv4StaticRoutesInfo' PagedXiqDeviceConfigureIpv4StaticRoutes: allOf: - $ref: '#/components/schemas/XiqPage' - type: object properties: data: type: array description: The data in the current page items: $ref: '#/components/schemas/XiqDeviceConfigureIpv4StaticRoute' XiqDeviceCreateConfigureIpv4StaticRoute: allOf: - type: object description: The payload of a IPv4 Static Route required: - name - dest_subnetwork - next_hop_ip - metric - $ref: '#/components/schemas/XiqDeviceConfigureIpv4StaticRoutesInfo' XiqDeviceUpdateConfigureIpv4StaticRoute: allOf: - type: object description: The payload of a IPv4 Interface required: - ipv4_static_route_id - name - dest_subnetwork - next_hop_ip - metric properties: ipv4_static_route_id: type: integer description: The IPv4 Static Route ID format: int64 - $ref: '#/components/schemas/XiqDeviceConfigureIpv4StaticRoutesInfo' - minProperties: 1 XiqDeviceVlanSortField: type: string description: All available VLAN Attributes sort fields for a device

VLAN_ID = VLAN ID
ACTIVE_PORTS = Number of total active ports in the VLAN
IGMP_SNOOPING_ENABLED = Disabled or Enabled
DHCP_SNOOPING_ENABLED = Disabled or Enabled
STP_INSTANCE = STP Instance name enum: - VLAN_ID - ACTIVE_PORTS - IGMP_SNOOPING_ENABLED - DHCP_SNOOPING_ENABLED - STP_INSTANCE XiqDeviceMonitorVlanAttributesInfo: type: object description: The VLAN attributes that are monitored per VLAN on the device. required: - vlan_id properties: vlan_id: type: integer description: The VLAN ID format: int32 vlan_name: type: string description: The VLAN Name active_ports: type: array description: The active ports in the VLAN items: type: string description: The active ports in the VLAN stp_instance: type: string description: The STP instance name for the VLAN stp_enabled: type: boolean description: Indicates whether or not STP is enabled or disabled on the VLAN igmp_snooping_enabled: type: boolean description: Indicates whether or not IGMP Snooping is enabled or disabled on the VLAN dhcp_snooping_enabled: type: boolean description: Indicates whether or not DCHP Snooping is enabled or disabled on the VLAN vrf_name: type: string description: The name of the VRF for the VLAN dynamic_enabled: type: boolean description: Indicates whether or not this is a Dynamic VLAN member_ports: type: array description: The member ports in the VLAN items: type: string description: The member ports in the VLAN tagged_ports: type: array description: The tagged ports in the VLAN items: type: string description: The tagged ports in the VLAN untagged_ports: type: array description: The untagged ports in the VLAN items: type: string description: The untagged ports in the VLAN dynamic_ports: type: array description: The dynamic ports in the VLAN items: type: string description: The dynamic ports in the VLAN non_forwarding_vlan_enabled: type: boolean description: Indicates whether or not this VLAN is a Non-Forwarding VLAN (learning VLAN) isid_id: type: integer description: The ISID ID format: int32 isid_name: type: string description: The ISID Name num_active_ports_count: type: integer description: The count of active ports in the VLAN format: int32 num_tagged_ports_count: type: integer description: The count of tagged ports in the VLAN format: int32 num_untagged_ports_count: type: integer description: The count of untagged ports in the VLAN format: int32 XiqDeviceMonitorVlanAttributes: type: object description: The VLAN attributes information for the device. required: - earliest_refresh_time - latest_refresh_time - latest_refresh_timestamp - vlan_attributes_info properties: earliest_refresh_time: type: string description: The time of the earliest refresh of VLAN Attributes information from the device latest_refresh_time: type: string description: The time of the latest refresh of VLAN Attributes information from the device latest_refresh_timestamp: type: integer description: The latest successful refresh timestamp of VLAN Attributes information from the device format: int64 vlan_attributes_info: type: array description: The VLAN attributes monitored per VLAN from the device items: $ref: '#/components/schemas/XiqDeviceMonitorVlanAttributesInfo' PagedXiqDeviceMonitorVlanAttributes: allOf: - $ref: '#/components/schemas/XiqPage' - type: object properties: data: type: array description: The data in the current page for VLAN attributes items: $ref: '#/components/schemas/XiqDeviceMonitorVlanAttributes' XiqDeviceVlanIpv4InterfacesSortField: type: string description: All available VLAN IPv4 Interfaces sort fields for a device

VLAN_ID = VLAN ID
IPV4_FORWARDING_ENABLED = Indicates if IPv4 Forwarding is enabled or not on the IPv4 interface
ROUTING_INSTANCE = The Routing instance of the IPv4 interface
IPV4_ADDRESS = IPv4 Address of the interface
IPV4_SUBNET = IPv4 subnet of the interface enum: - VLAN_ID - IPV4_FORWARDING_ENABLED - ROUTING_INSTANCE - IPV4_ADDRESS - IPV4_SUBNET XiqDeviceMonitorVlanIpv4InterfacesDetails: type: object description: The IPv4 Interfaces that are monitored per VLAN on the device. required: - vlan_id properties: vlan_id: type: integer description: The VLAN ID format: int32 vlan_name: type: string description: The VLAN Name ipv4_forwarding_enabled: type: boolean description: Indicates whether or not IPv4 is forwarding on the VLAN routing_instance: type: string description: The Routing instance name where the IPv4 interface is configured ipv4_address: type: string description: The IPv4 Address ipv4_subnet: type: string description: The IPv4 Subnet member_ports: type: array description: The member ports in the VLAN items: type: string description: The member ports in the VLAN tagged_ports: type: array description: The tagged ports in the VLAN items: type: string description: The tagged ports in the VLAN untagged_ports: type: array description: The untagged ports in the VLAN items: type: string description: The untagged ports in the VLAN non_forwarding_vlan_enabled: type: boolean description: Indicates whether or not this VLAN is a Non-Forwarding VLAN (learning VLAN) XiqDeviceMonitorVlanIpv4Interfaces: type: object description: The VLAN IPv4 Interfaces information for the device. required: - earliest_refresh_time - latest_refresh_time - latest_refresh_timestamp - vlan_ipv4_interfaces_details properties: earliest_refresh_time: type: string description: The time of the earliest refresh of VLAN IPv4 Interfaces information from the device latest_refresh_time: type: string description: The time of the latest refresh of VLAN IPv4 Interfaces information from the device latest_refresh_timestamp: type: integer description: The latest successful refresh timestamp of VLAN IPv4 Interfaces information from the device format: int64 vlan_ipv4_interfaces_details: type: array description: The IPv4 Interfaces monitored per VLAN from the device items: $ref: '#/components/schemas/XiqDeviceMonitorVlanIpv4InterfacesDetails' PagedXiqDeviceMonitorVlanIpv4Interfaces: allOf: - $ref: '#/components/schemas/XiqPage' - type: object properties: data: type: array description: The data in the current page for VLAN IPv4 Interfaces items: $ref: '#/components/schemas/XiqDeviceMonitorVlanIpv4Interfaces' XiqDeviceIpv4RoutingSortField: type: string description: All available IPv4 Routing sort fields for a device

DESTINATION = IPv4 Route Destination
NEXTHOP = Nexthop of the IPv4 Route Destination
VLAN_NAME = VLAN Name of the IPv4 Route
VLAN_ID = VLAN ID of the IPv4 Route
ROUTE_ORIGIN = The route origin of the IPv4 Route
STATUS = The status of the IPv4 Route
METRIC = The metric of the IPv4 Route
AGE = The age of the IPv4 route
ROUTE_TYPE_PRIORITY = The route type priority of the IPv4 Route
ROUTING_INSTANCE = The Routing Instance of the IPv4 Route enum: - DESTINATION - NEXTHOP - VLAN_NAME - VLAN_ID - ROUTE_ORIGIN - STATUS - METRIC - AGE - ROUTE_TYPE_PRIORITY - ROUTING_INSTANCE XiqDeviceIpv4RoutingRouteOriginField: type: string description: All available Route origin types for a route on a device

DIRECT = Direct Routes
STATIC = Static Routes
OSPF = OSPF Routes enum: - DIRECT - STATIC - OSPF XiqDeviceIpv4RoutingStatusField: type: string description: All available Status types for a route on a device

UP = Routes that have up status
DOWN = Routes that have down status enum: - UP - DOWN XiqDeviceMonitorIpv4RoutingInfoNexthop: type: object description: The Neighbor information for an IPv4 Route. required: - nexthop_ipv4_address properties: nexthop_ipv4_address: type: string description: The nexthop IPv4 address of the IPv4 route nexthop_device_id: type: integer description: Device id of the Nexthop format: int64 nexthop_host_name: type: string description: The host name of the Nexthop ping_protection_enabled: type: boolean description: Indicates whether or not ping route protection is enabled for Static Routes ping_protection_state: type: string description: The state of the IPv4 ping protection gateway ping_protection_last_uptime: type: integer description: The last time the gateway transitioned to the UP state format: int64 ping_protection_last_downtime: type: integer description: The last time the gateway transitioned to the DOWN state format: int64 XiqDeviceMonitorIpv4RoutingDetails: type: object description: The IPv4 Routing details information that is monitored on the device. required: - destination properties: destination: type: string description: The IPv4 route destination (IPv4 address/masklength) nexthop: type: object $ref: '#/components/schemas/XiqDeviceMonitorIpv4RoutingInfoNexthop' description: The IPv4 address of the nexthop for the IPv4 route vlan_id: type: integer description: The VLAN ID format: int32 vlan_name: type: string description: The VLAN Name route_origin: type: string description: The route type (Static, OSPF, VRRP, Direct, etc.) status: type: string description: The status of the IPv4 route (Unknown, Inactive, Active) metric: type: integer description: The metric of the Route format: int32 age: type: integer description: The number of seconds since this route was last updated or otherwise determined to be correct. format: int32 route_type_priority: type: string description: The priority of the IPv4 Route based on route type routing_instance: type: string description: The Routing instance name of the IPv4 Route isid_id: type: integer description: The ISID ID format: int32 isid_name: type: string description: The ISID Name XiqDeviceMonitorIpv4Routing: type: object description: The IPv4 Routing information for the device. required: - earliest_refresh_time - latest_refresh_time - latest_refresh_timestamp - ipv4_routing_details properties: earliest_refresh_time: type: string description: The time of the earliest refresh of IPv4 Routing information from the device latest_refresh_time: type: string description: The time of the latest refresh of IPv4 Routing information from the device latest_refresh_timestamp: type: integer description: The latest successful refresh timestamp of IPv4 Routing information from the device format: int64 ipv4_routing_details: type: array description: The IPv4 Routing information monitored from the device items: $ref: '#/components/schemas/XiqDeviceMonitorIpv4RoutingDetails' PagedXiqDeviceMonitorIpv4Routing: allOf: - $ref: '#/components/schemas/XiqPage' - type: object properties: data: type: array description: The data in the current page for IPv4 Routing items: $ref: '#/components/schemas/XiqDeviceMonitorIpv4Routing' XiqDeviceMonitorIpv4RoutingTimelineInfo: type: object description: The IPv4 Routing timeline information that is monitored on the device. properties: static_routes_count: type: integer description: The number of Static routes format: int32 direct_routes_count: type: integer description: The number of Direct routes format: int32 ospf_routes_count: type: integer description: The number of OSPF routes format: int32 bgp_routes_count: type: integer description: The number of BGP routes format: int32 isis_routes_count: type: integer description: The number of ISIS routes format: int32 total_routes_count: type: integer description: The total number of routes format: int32 timestamp: type: integer description: The timestamp for when route information was collected format: int64 XiqDeviceMonitorIpv4RoutingTimeline: type: object description: The IPv4 Routing timeline information for the device. required: - ipv4_routing_timelines properties: range_start_time: type: integer description: The range start time format: int64 range_stop_time: type: integer description: The range stop time format: int64 precision: type: integer description: The precision value format: int64 ipv4_routing_timelines: type: array description: The IPv4 Routing Summary timeline information per Routing Instance monitored from the device items: $ref: '#/components/schemas/XiqDeviceMonitorIpv4RoutingTimelineInfo' XiqDeviceMonitorRefreshFunction: type: string description: The device monitor refresh function, route, mac. enum: - ROUTE - MAC XiqMonitorRefresh: type: object description: Device refresh information response properties: taskKey: type: string description: task key format: string XiqDeviceMonitorRefreshStatus: type: string description: The device monitor refresh status. enum: - INVALID - FINISHED - UNFINISHED - TASK_NOT_EXIST - UNKNOWN XiqMonitorRefreshStatus: type: object description: The monitor refresh status properties: status: $ref: '#/components/schemas/XiqDeviceMonitorRefreshStatus' taskKey: type: string description: task key format: string percentage: type: integer description: Status percentage format: int32 XiqDeviceInstallationReportResponse: type: object description: The device installation response required: - onboarded - location_name - network_policy_name - device_template_name - ip_address - default_gateway - ntp_server - dns_server - enable_poe - xiq_connectivity - installation_images properties: onboarded: type: boolean description: Device onboard status location_name: type: string description: Location unique name network_policy_name: type: string description: Network policy name device_template_name: type: string description: Device template name ip_address: type: string description: Device IPv4 address default_gateway: type: string description: Device default gateway ntp_server: type: string description: ntp server address dns_server: type: string description: dns server address enable_poe: type: boolean description: Enable PoE xiq_connectivity: type: boolean description: Cloud or Locally managed indicator. True means Cloud managed device installation_images: type: boolean description: Device contains installation images or not XiqThreadStartCommissionerRequest: type: object description: Start the Thread Commissioner on a thread router device. properties: comm_timeout: type: integer default: 120 minimum: 1 maximum: 2000000 description: After this timeout the Commissioner will shutdown. The default is 120 sec. but the max is approximately 23 days. interface_name: type: string description: The IoT interface on which to start the Commissioner. The default is iot0. XiqThreadStopCommissionerRequest: type: object description: Stop the Thread Commissioner on a thread router device. properties: interface_name: type: string description: The IoT interface on which to stop the Commissioner. The default is iot0. XiqSsidStatus: type: string enum: - OPEN - CLOSED XiqSsidSecurityType: type: string enum: - OPEN - ENHANCED_OPEN - PPSK - PSK - WEP - TYPE_802DOT1X XiqWirelessClient: type: object description: ExtremeCloud IQ BSS and Network Data required: - network_policy_name - ssid - ssid_status - ssid_security_type 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/XiqSsidSecurityType' description: The SSID access security type XiqWirelessWlan: allOf: - $ref: '#/components/schemas/XiqWirelessClient' - type: object description: The Wireless wlan detail. properties: bssid: type: string description: The BSSID of wlan. XiqRadio: type: object description: ExtremeCloud IQ Radio Information associated to a device required: - name - channel_number - channel_width - mode - mac - power properties: name: type: string description: The radio name channel_number: type: integer description: The channel number format: int32 channel_width: type: string description: The channel width mode: type: string description: The radio mode mac_address: type: string description: The radio MAC address power: type: integer description: The radio power format: int32 wlans: type: array description: The wireless wlan details $ref: '#/components/schemas/XiqWirelessWlan' clients: type: array description: the wireless client details deprecated: true items: $ref: '#/components/schemas/XiqWirelessClient' XiqRadioEntity: type: object description: ExtremeCloud IQ Radio Information per device required: - device_id properties: device_id: type: integer description: The device ID format: int64 radios: type: array description: The radio information associated to device items: $ref: '#/components/schemas/XiqRadio' PagedXiqRadioEntity: allOf: - $ref: '#/components/schemas/XiqPage' - type: object properties: data: type: array description: The data in the current page items: $ref: '#/components/schemas/XiqRadioEntity' XiqDeviceClientMonitor: type: object description: Device-specific client monitor setting required: - enable properties: enable: type: boolean description: Enable or disable client monitoring on the device client_monitor_profile: type: integer description: The unique identifier of a client monitor profile. If specified, it overrides the SSID's client monitor profile on this device format: int64 XiqWgs84: type: object required: - latitude - longitude - altitude 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. minimum: -90 maximum: 90 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. minimum: -180 maximum: 180 altitude: type: number format: double description: Meters above sea level. minimum: -500 maximum: 1000 XiqZsubelementAboveFloor: type: object required: - height - height_uncertainty properties: height: type: number format: double description: Height above the floor in meters. minimum: 0 maximum: 250 height_uncertainty: type: number format: double description: Height uncertainty in meters. minimum: 0 maximum: 10 XiqZsubelement: type: object required: - expected_to_move - floor_number properties: expected_to_move: type: boolean description: Indicates whether the device is expected to move. floor_number: type: integer description: The floor number where the device is installed. minimum: -25 maximum: 250 above_floor: $ref: '#/components/schemas/XiqZsubelementAboveFloor' XiqFtmSettingsRequest: type: object description: Fine Time Measurement (FTM) settings for 802.11mc device support. required: - wgs84_override - zsubelement_override - civic_address_override properties: wgs84_override: type: boolean description: | World Geodetic System 1984 (WGS84) override. If 'false' and GPS or AP-to-AP ranging or XIQ location has provided these values they will be used. If 'true', the manually entered values for latitude, longitude, and altitude will be used. wgs84: $ref: '#/components/schemas/XiqWgs84' zsubelement_override: type: boolean description: | Z-subelement override. If 'false' and XIQ location has provided these values they will be used. If 'true', the manually entered values will be used. zsubelement: $ref: '#/components/schemas/XiqZsubelement' civic_address_override: type: boolean description: Civic Address override. civic_address: type: string description: Civic Address as hex encoded RFC4776 formatted string. maxLength: 480 minLength: 2 XiqFtmSettings: allOf: - $ref: '#/components/schemas/XiqViqEntity' - $ref: '#/components/schemas/XiqFtmSettingsRequest' XiqDeviceRadioOperatingMode: title: OperatingMode description: 'Modern AP hardware types include dual or triple band radios. A limited subset of band combinations are supported. Operating mode defines the supported band combinations per radio. Access Points with fixed band radios use GENERIC operating mode.
SERVICE_2_5_6: wifi0-2.4Ghz, wifi1-5Ghz, wifi2-6Ghz
SENSOR_SERVICE_5_6: wifi0-Tri-band sensor, wifi1-5Ghz, wifi2-6Ghz
SERVICE_5L_5H_6: wifi0-5G Low, wifi1-5G High, wifi2-6Ghz
SENSOR_SERVICE_5_2: wifi0-Tri-band sensor, wifi1-5GHz, wifi2-2.4Ghz
SERVICE_5L_5H_2: wifi0-5G Low, wifi1-5G High, wifi2-2.4Ghz
SERVICE_6L_5_6H: wifi0-6G Low, wifi1-5GHz, wifi2-6Ghz
SERVICE_2_5H_5L: wifi0-2.4Ghz, wifi1-5G High, wifi2-5G Low
' enum: - GENERIC - SERVICE_2_5_6 - SENSOR_SERVICE_5_6 - SERVICE_5L_5H_6 - SENSOR_SERVICE_5_2 - SERVICE_5L_5H_2 - SERVICE_6L_5_6H - SERVICE_2_5H_5L type: string default: GENERIC example: SERVICE_2_5_6 XiqDeviceWirelessInterfaceEntry: type: object description: Wireless Interface settings entry. required: - name properties: name: $ref: '#/components/schemas/XiqWirelessIfName' radio_profile_id: type: integer description: The Radio Profile ID format: int64 XiqConfigureRadioOperatingModeRequest: type: object description: Request to configure Radio Operating mode settings for AP device required: - radio_operating_mode properties: radio_operating_mode: $ref: '#/components/schemas/XiqDeviceRadioOperatingMode' wireless_interfaces: description: Wireless Interface type: array items: $ref: '#/components/schemas/XiqDeviceWirelessInterfaceEntry' XiqDeviceStatus: type: object properties: AP: type: object properties: online_count: type: integer format: int32 offline_count: type: integer format: int32 total_count: type: integer format: int32 online_percentage: type: integer format: int32 offline_percentage: type: integer format: int32 Switch: type: object properties: online_count: type: integer format: int32 offline_count: type: integer format: int32 total_count: type: integer format: int32 online_percentage: type: integer format: int32 offline_percentage: type: integer format: int32 XiqAhDeviceSimulatedType: type: string enum: - REAL - SIMULATED - DIGITAL_TWIN RmDeviceConnectionStatusResponse: type: object properties: total_devices: type: integer format: int64 description: Total count of devices connected_devices: type: integer format: int64 description: Total count of online devices disconnected_devices: type: integer format: int64 description: Total count of offline devices total_managed_devices: type: integer format: int64 description: Total count of managed devices connected_managed_devices: type: integer format: int64 description: Total count of online managed devices disconnected_managed_devices: type: integer format: int64 description: Total count of offline managed devices total_unmanaged_devices: type: integer format: int64 description: Total count of unmanaged devices connected_unmanaged_devices: type: integer format: int64 description: Total count of online unmanaged devices disconnected_unmanaged_devices: type: integer format: int64 description: Total count of offline unmanaged devices total_simulated_devices: type: integer format: int64 description: Total count of simulated devices RmDeviceSortField: type: string description: All available device sort fields

MAC = Device MAC Address
SN = Device Serial Number enum: - MAC - SN - HOSTNAME - CONNECTION_STATUS - OS - PRODUCT_TYPE XiqDeviceLicenseTier: type: string description: The Device License Tier Enum. enum: - NOT_APPLICABLE - TIER_A - TIER_B - TIER_C - TIER_D - UNKNOWN - NONE XiqAhDeviceLicenseType: type: string description: The Device License Type Enum. enum: - LEGACY - NAVIGATOR - PILOT - COPILOT - NONE - NA - TRIAL - NOT_REQUIRED - GRACEPERIOD - UNLICENSED - STANDARD - ADVANCED - NOT_LICENSED RmDeviceIcons: type: object description: Device icons status properties: afc_status: type: boolean description: AFC status provisioned_device: type: boolean description: Provisioned device status config_rolled_back: type: boolean description: Configuration rollback status undetermined: type: boolean description: Undetermined status configured_at_device_level: type: boolean description: Configured at device level status device_update_unsuccessful: type: boolean description: Device update success status managed_by_extreme_iot: type: boolean description: Managed by Extreme IoT status thread_commissioner_running: type: boolean description: Thread commissioner running status monitoring_unassociated_clients: type: boolean description: Monitoring unassociated clients status switch_stack: type: boolean description: Switch stack status switch_stack_warning: type: boolean description: Switch stack warning status radsec_proxy_server: type: boolean description: RADSEC proxy server status rogue_ap_mitigation_on: type: boolean description: Rogue AP mitigation status sensor_mode: type: boolean description: Sensor mode status (true => active, false => inactive) swap: type: boolean description: Swap status spectrum_intelligence: type: boolean description: Spectrum intelligence status vpn_server: type: string description: VPN server status enum: - VPN_STATUS_UP - VPN_STATUS_DOWN - VPN_STATUS_UP_DOWN vpn_client: type: string description: VPN client status enum: - VPN_STATUS_UP - VPN_STATUS_DOWN - VPN_STATUS_UP_DOWN locally_managed: type: boolean description: Locally managed status extreme_cluster_appliance: type: boolean description: Extreme cluster appliance status fabric_attach: type: boolean description: Fabric attach status fabric_attach_error: type: boolean description: Fabric attach error status old_os: type: boolean description: Device formerly used another OS persona, which is no longer active config_pending: type: boolean description: Configuration pending status RmDevicePage: allOf: - $ref: '#/components/schemas/XiqViqEntity' - type: object description: Generic ExtremeCloud IQ Device model properties: connected: type: boolean description: The device connection status hostname: type: string description: The device hostname device_ip: type: string description: The device IPv4 address mac_address: type: string description: The device MAC address serial_number: type: string description: The device serial number, valid for all non-HAC devices locations: type: object description: The detailed location of the device properties: site: type: string description: Site location of the device site_id: type: integer description: The site Id format: int64 building: type: string description: The building where the device is located building_id: type: integer description: The building Id format: int64 floor: type: string description: The floor where the device is located floor_id: type: integer description: The floor Id format: int64 system_up_time: type: integer description: The device uptime format: int64 has_management_ip_issue: type: boolean description: Flag to display warning icon on management IP i.e it checks if it is self assigned IP has_default_gateway_issue: type: boolean description: Flag to display warning icon on default gateway IP has_firmware_version_issue: type: boolean description: Flag to display warning icon on firmware version issue depending on the targeted version default_gateway: type: string description: The default gateway for the device 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.' updated_on: type: integer description: The device updated on time format: int64 ipv6_address: type: string description: The ipv6 address for the device device_admin_state: $ref: '#/components/schemas/XiqDeviceAdminState' country_code: type: integer description: The assigned country code on the device format: int32 managed_by: type: string description: The entity managing the device config_mismatch: type: boolean description: Config audit status(MATCHED(false) or UNMATCHED(true)) sim_type: $ref: '#/components/schemas/XiqAhDeviceSimulatedType' healthy_clients: type: integer description: The count of healthy clients connected to the device format: int32 unhealthy_clients: type: integer description: The count of unhealthy clients connected to the device format: int32 channel_wifi0: type: string description: The channel for wifi 0 interface power_wifi0: type: string description: The power level for wifi 0 interface radio_wifi0: type: string description: The radio type for wifi 0 interface channel_wifi1: type: string description: The channel for wifi 1 interface power_wifi1: type: string description: The power level for wifi 1 interface radio_wifi1: type: string description: The radio type for wifi 1 interface channel_wifi2: type: string description: The channel for wifi 2 interface power_wifi2: type: string description: The power level for wifi 2 interface radio_wifi2: type: string description: The radio type for wifi 2 interface stack_size: type: integer format: int8 description: The number of devices in the stack (0 for standalone devices) device_license_tier: $ref: '#/components/schemas/XiqDeviceLicenseTier' device_license_type: $ref: '#/components/schemas/XiqAhDeviceLicenseType' device_icons: $ref: '#/components/schemas/RmDeviceIcons' stack_id: type: integer format: int64 description: The stack id (only for stack members) network_policy_id: type: integer description: The network policy ID format: int64 network_policy_name: type: string description: The network policy name os: type: string description: The device operating system device_template_name: type: string description: The device template name cloud_config_groups: type: array description: List of cloud config groups items: type: string PagedRmXiqDevice: allOf: - $ref: '#/components/schemas/XiqPage' - type: object properties: data: type: array description: The data in the current page items: $ref: '#/components/schemas/RmDevicePage' RmCountryCodeName: type: object description: Country Code Name properties: country_code: type: integer format: int32 description: Country Code country_name: type: string description: Country Name RmDeviceMetadataResponse: type: object description: Generic ExtremeCloud IQ Device model properties: default_gateway: type: array description: List of default gateways for the device items: type: string software_version: type: array description: List of device OS software versions items: type: string product_type: type: object description: Map of product types, where keys are device models and values are their descriptions. additionalProperties: type: string device_admin_state: type: array description: List of device admin states items: $ref: '#/components/schemas/XiqDeviceAdminState' country_code: type: array description: List of assigned country codes on the device items: type: integer format: int32 managed_by: type: array description: List of entities managing the device items: type: string sim_type: type: array items: $ref: '#/components/schemas/XiqAhDeviceSimulatedType' network_policy: type: array description: List of network policy items: type: string radio_wifi0: type: array description: List of radio types for wifi 0 interface items: type: string radio_wifi1: type: array description: List of radio types for wifi 1 interface items: type: string radio_wifi2: type: array description: List of radio types for wifi 2 interface items: type: string country_code_name: type: array description: List Of Country Code and Name items: $ref: '#/components/schemas/RmCountryCodeName' RmDeviceStackInfoResponse: type: object description: Generic ExtremeCloud IQ Device model properties: hostname: type: string description: The hostname of the device associated with the stack serial_number: type: string description: The serial number of the device associated with the stack product_type: type: string description: The product type of the device associated with the stack ip_address: type: string description: The device IPv4 address mac_address: type: string description: The device MAC address RmDeviceActionEnum: 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 - DIAGNOSTICS - SPECTRUM_INTELLIGENCE - RADIUS_TEST - FIRMWARE_UPGRADE - ASSIGN_NETWORK_POLICY - ADD_TO_CLOUD_CONFIG_GROUP - REVERT_DEVICE_TO_TEMPLATE - CHANGE_OS - UPDATE_DEVICE XiqAfcCoordinatesSource: type: string description: Source of coordinates:
APP - Mobile Application GPS coordinates,
GPS - AP reported GPS coordinates,
GEO - Geolocation Agent derived coordinates
enum: - APP - GPS - GEO XiqAfcMobileappCoordinates: allOf: - type: object properties: latitude: type: number description: Latitude expressed as a floating point number minimum: -90 maximum: 90 longitude: type: number description: Longitude expressed as a floating point number minimum: -180 maximum: 180 source: $ref: '#/components/schemas/XiqAfcCoordinatesSource' ts: type: number description: Timestamp of the acquired geolocation (milliseconds from epoch) XiqDeviceMobileappGpsRequest: allOf: - type: object properties: gpsAnchor: type: boolean default: false description: Use this AP as GPS anchor to derive geo-coordinates of other APs on the floor distance: type: number minimum: 0 default: 5 description: Distance between AP and the phone hosting the mobile APP in meters. cep: type: number minimum: 0 description: Circular error probability, expressed as the radius of a circle centered on the true value that contains 50% of the actual GPS measurements. CEP68 is based on Android OS. coordinates: $ref: '#/components/schemas/XiqAfcMobileappCoordinates' XiqDevicesSshActiveSessions: type: object description: The Ssh Active Sessions Data properties: device_id: type: integer format: int64 description: The device ID of the device host_name: type: string description: The host name of device serial_number: type: string description: The serial number of device site_name: type: string description: The site name of device percentage_progress: type: integer format: int32 description: The percentage ssh session timeout in mins start_time: type: integer format: int64 description: The start time of ssh session time_out: type: integer format: int64 description: The time out of ssh session session_id: type: string description: The session ID for the active ssh access of device XiqThreadBuilding: type: object description: The building where thread devices are located. properties: building_id: type: integer description: The location id format: int64 XiqThreadStartCommissionerByBuildingsRequest: type: object description: The start commissioner service request based on buildings. properties: buildings: description: List of buildings where the Thread Commissioner should be started. type: array items: $ref: '#/components/schemas/XiqThreadBuilding' ext_pan_id: description: The extended PAN ID for the Thread network. type: string minLength: 16 maxLength: 16 pattern: ^[0-9a-fA-F]+$ comm_timeout: type: integer default: 120 minimum: 1 maximum: 2000000 description: After this timeout the Commissioner will shutdown. The default is 120 sec. but the max is approximately 23 days. owner_id: type: integer format: int64 description: The owner ID. XiqThreadStopCommissionerByBuildingsRequest: type: object description: The stop commissioner service request based on buildings. properties: buildings: description: List of buildings where the Thread Commissioner should be stopped. type: array items: $ref: '#/components/schemas/XiqThreadBuilding' ext_pan_id: description: The extended PAN ID for the Thread network. type: string minLength: 16 maxLength: 16 pattern: ^[0-9a-fA-F]+$ owner_id: type: integer format: int64 description: The owner ID. PagedXiqNetworkPolicy: allOf: - $ref: '#/components/schemas/XiqPage' - type: object properties: data: type: array description: The data in the current page items: $ref: '#/components/schemas/XiqNetworkPolicy' XiqNetworkPolicyType: type: string description: The network policy type enum: - NETWORK_ACCESS_AND_SWITCHING - BRANCH_ROUTING - WIRELESS_ACCESS - SWITCHING - NETWORK_ACCESS_AND_SWITCHING_AND_BR - NETWORK_ACCESS_AND_BRANCH_ROUTING - SWITCHING_AND_BRANCH_ROUTING XiqCreateNetworkPolicyRequest: type: object required: - name - type properties: name: type: string description: The network policy name description: type: string description: The network policy description type: $ref: '#/components/schemas/XiqNetworkPolicyType' 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' XiqSsid: allOf: - $ref: '#/components/schemas/XiqViqEntity' - type: object description: The SSID required: - name - broadcast_name - predefined properties: name: type: string description: The SSID profile name broadcast_name: type: string description: The SSID broadcast name description: type: string description: The SSID description predefined: type: boolean description: Whether it is predefined advanced_settings_id: type: integer description: The SSID advanced settings ID format: int64 PagedXiqSsid: allOf: - $ref: '#/components/schemas/XiqPage' - type: object properties: data: type: array description: The data in the current page items: $ref: '#/components/schemas/XiqSsid' DeviceOverallHealth: type: object description: The devices health score over the period properties: overall_score: type: integer description: The overall health score format: int32 device_availability_score: type: integer description: The device availability score format: int32 device_hardware_health_score: type: integer description: The device hardware health score format: int32 config_and_firmware_score: type: integer description: The config and firmware score format: int32 ClientOverallHealth: type: object description: The clients health score over the period properties: overall_score: type: integer description: The overall health score format: int32 wifi_health_score: type: integer description: The health score of Wi-Fi format: int32 network_health_score: type: integer description: The health score of network format: int32 application_health_score: type: integer description: The health score of application format: int32 WiFiOverallHealth: type: object description: The clients health score over the period properties: overall_score: type: integer description: The overall health score format: int32 snr_health_score: type: integer description: The health score of snr format: int32 utilization_health_score: type: integer description: The health score of utilization format: int32 association_health_score: type: integer description: The health score of association format: int32 NetworkOverallHealth: type: object description: The network health score over the period properties: overall_score: type: integer description: The overall health score format: int32 internet_availability_score: type: integer description: The overall network health score format: int64 average_internet_latency: type: integer description: The internet performance value in milli-seconds format: int64 network_usage: type: integer description: The network usage value in MB format: int64 ServicesOverallHealth: type: object description: The network health score over the period properties: overall_score: type: integer description: The overall health score format: int32 network_services_score: type: integer description: The health score of network services format: int32 authentication_services_score: type: integer description: The health score of authentication services format: int32 management_services_score: type: integer description: The health score of management services format: int32 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 - MAKE - OS_VERSION - CONNECTED_TO - CONNECTION_DURATION - CAPTIVE_WEB_PORTAL XiqClientView: type: string description: The logic collections of client fields

BASIC: ID, ORG_ID, HOSTNAME, MAC_ADDRESS, IP_ADDRESS, IPV6_ADDRESS, OS_TYPE, DEVICE_ID,CONNECTED, ONLINE_TIME, OFFLINE_TIME, CONNECTION_TYPE, SSID, PORT
FULL: All fields
STATUS: ID, CONNECTED, ONLINE_TIME, OFFLINE_TIME
DETAIL: ID, CREATE_TIME, UPDATE_TIME, ORG_ID, ORG_NAME, LOCATION_ID, HOSTNAME, MAC_ADDRESS, IP_ADDRESS, IPV6_ADDRESS, OS_TYPE, DEVICE_ID, DEVICE_FUNCTION, DEVICE_NAME, DEVICE_MAC_ADDRESS, USERNAME, USER_PROFILE_NAME, CONNECTED, ONLINE_TIME, OFFLINE_TIME, VLAN, CONNECTION_TYPE, SSID, PORT, BSSID, PORT_TYPE_NAME, INTERFACE_NAME, AUTH, ENCRYPTION_METHOD, CHANNEL, RSSI, SNR, WING_AP, VENDOR, RADIO_TYPE, ALIAS, MAC_PROTOCOL, MAKE, OS_VERSION, CONNECTED_TO, CONNECTION_DURATION, CAPTIVE_WEB_PORTAL
LOCATION: ID, LOCATION_ID, LOCATIONS
METRICS: ID, CLIENT_HEALTH, APPLICATION_HEALTH, NETWORK_HEALTH, RADIO_HEALTH
IOT: ID, MOBILITY, CATEGORY, DESCRIPTION enum: - BASIC - FULL - STATUS - DETAIL - LOCATION - METRICS - IOT XiqDeviceEntity: allOf: - $ref: '#/components/schemas/XiqLocationEntity' - type: object properties: device_id: type: integer description: The device identifier format: int64 required: - device_id XiqClient: allOf: - $ref: '#/components/schemas/XiqDeviceEntity' - type: object properties: hostname: type: string description: The hostname of the client mac_address: type: string description: The MAC address of the client ip_address: type: string description: The IP address of the client ipv6_address: type: string description: The IPv6 address of the client os_type: type: string description: The OS type of the client username: type: string description: The username of the client. user_profile_name: type: string description: The user profile name of the client connected: type: boolean description: Client is connected or not online_time: type: string description: The online time for the client format: date-time offline_time: type: string description: The offline time for the client format: date-time vlan: type: integer description: The associate VLAN format: int32 connection_type: type: integer description: The connection type format: int32 ssid: type: string description: The SSID port: type: string description: The associate device port org_name: type: string description: The organization name device_function: type: integer description: The associated device function format: int32 device_mac_address: type: string description: The associated device mac address device_name: type: string description: The associated device name auth: type: integer description: The authentication type format: int32 channel: type: integer description: The channel value format: int32 client_health: type: integer description: The health score of client format: int32 application_health: type: integer description: The health score of application format: int32 radio_health: type: integer description: The health score of radio format: int32 network_health: type: integer description: The health score of network format: int32 radio_type: type: integer description: |- The radio type. Represented by an integer code for each standard: - 1 - 2.4G - 2 - 5G - 3 - WIRED - 4 - 6G - 5 - THREAD format: int32 encryption_method: type: integer description: |- The encryption method, represented by an integer code for each encryption type: - -1 - N/A (Not applicable) - 0 - AES (Advanced Encryption Standard) - 1 - TKIP (Temporal Key Integrity Protocol) - 2 - WEP (Wired Equivalent Privacy) - 3 - NON (No encryption) - 4 - CCMP (Counter Mode with Cipher Block Chaining Message Authentication Code Protocol) - 5 - KEYGUARD (Keyguard encryption) - 6 - WEP128 (128-bit WEP encryption) - 7 - WEP64 (64-bit WEP encryption) - 8 - WAPI (WLAN Authentication and Privacy Infrastructure) - 9 - GCMP256 (256-bit Galois/Counter Mode Protocol) - 10 - NONE (No encryption) - 11 - PAP (Password Authentication Protocol) - 12 - MsCHAP (Microsoft Challenge Handshake Authentication Protocol) - 13 - EAP-MD5 (Extensible Authentication Protocol - MD5) - 14 - EAP-TLS (Extensible Authentication Protocol - Transport Layer Security) - 15 - PEAP (Protected Extensible Authentication Protocol) - 16 - TTLS (Tunneled Transport Layer Security) - 17 - TTLS-INNER-TUNNEL (Inner tunnel for TTLS) - 18 - PEAP-INNER-TUNNEL (Inner tunnel for PEAP) - 19 - EAP-FAST (Extensible Authentication Protocol - Flexible Authentication via Secure Tunneling) - 20 - EAP-LEAP (Lightweight Extensible Authentication Protocol) - 21 - EAP-RSA (Extensible Authentication Protocol - RSA) - 22 - EAP-SIM (Extensible Authentication Protocol - SIM) - 23 - EAP-AKA (Extensible Authentication Protocol - AKA) - 24 - EAP-TEAP (Extensible Authentication Protocol - Tunneled EAP) format: int32 mac_protocol: type: string description: |- The MAC protocol. - 'N/A' - '802.11a' - '802.11b' - '802.11g' - '802.11na' - '802.11ng' - '802.11ac' - '802.11ax-2.4g' - '802.11ax-5g' - '802.3' - '802.11ax-6g' - '802.15.4' - '802.11be-2g' - '802.11be-5g' - '802.11be-6g' interface_name: type: string description: The interface name bssid: type: string description: The bssid rssi: type: integer description: The RSSI format: int32 snr: type: integer description: The SNR format: int32 description: type: string description: The description of client category: type: string description: The category of client mobility: type: string description: The client mobility port_type_name: type: string description: The client port type name wing_ap: type: boolean description: Wing ap flag vendor: type: string description: The vendor of client locations: type: array description: The detailed location items: $ref: '#/components/schemas/XiqLocationLegend' productType: type: string description: The Category which describes the Extreme device types(For example:SR_2208P, AP_4000, AP_5010) alias: type: string maxLength: 255 description: The alias of the client PagedXiqClient: allOf: - $ref: '#/components/schemas/XiqPage' - type: object properties: data: type: array description: The data in the current page items: $ref: '#/components/schemas/XiqClient' XiqClientSummary: type: object description: The summary for clients properties: connected_wireless_client_count: type: integer description: The connected wireless client count format: int64 detected_wired_client_count: type: integer description: The detected wired client count format: int64 XiqClientUsage: type: object description: The client usage over the period properties: client_id: type: integer description: The client ID format: int64 usage: type: integer description: The client total usage format: int64 XiqClientMacAddressAlias: type: object description: The client's mac address and alias required: - mac_address properties: mac_address: type: string minLength: 12 maxLength: 12 description: The MAC address of the client alias: type: string maxLength: 255 description: The alias of the client GetActiveClientsResponse: type: object properties: count: type: integer description: The connected wireless client count format: int64 XiqApplicationSortField: type: string enum: - NAME - CATEGORY XiqApplicationDetectionProtocol: type: string enum: - HTTP - HTTPS XiqApplicationDetectionType: type: string enum: - HOST_NAME - SERVER_IP_ADDRESS - PORT_NUMBER XiqApplicationDetectionRule: type: object description: The Application Detection Rule properties: value: type: string description: The value of detection rule type. protocol: $ref: '#/components/schemas/XiqApplicationDetectionProtocol' type: $ref: '#/components/schemas/XiqApplicationDetectionType' XiqApplication: allOf: - $ref: '#/components/schemas/XiqViqEntity' - type: object properties: name: type: string description: The application name. description: type: string description: The application description. predefined: type: boolean description: Flag to describe whether the application is predefined or customized. category_id: type: integer description: The category ID of application. format: int64 category_name: type: string description: The category name of application. detection_rules: type: array description: The application detection rules. items: $ref: '#/components/schemas/XiqApplicationDetectionRule' PagedXiqApplication: allOf: - $ref: '#/components/schemas/XiqPage' - type: object properties: data: type: array description: The data in the current page items: $ref: '#/components/schemas/XiqApplication' XiqTopApplicationsUsage: type: object description: The Top N Applications Usage properties: id: type: integer description: The application ID format: int64 name: type: string description: The application name clients: type: integer description: The associated unique client count format: int64 users: type: integer description: The associated unique user count format: int64 usage: type: integer description: The application usage format: int64 XiqApplicationTopClientsUsage: type: object description: The Top N Clients Usage per Application properties: application_id: type: integer description: The application ID format: int64 client_id: type: integer description: The TOP N client ID format: int64 client_mac_address: type: string description: The MAC address of TOP N client client_host_name: type: string description: The host name of TOP N client usage: type: integer description: The TOP N client usage format: int64 RmAppUsageSummary: type: object properties: application_name: type: string description: Name of the application category_name: type: string description: Name of the application group or category usage: type: integer format: int64 description: Total data usage in bytes for the application percentage_usage: type: number format: float description: Percentage of total traffic attributed to this application clients: type: integer description: Number of unique client devices that used the application users: type: integer description: Number of unique users associated with the application PagedAppUsageSummary: allOf: - $ref: '#/components/schemas/XiqPage' - type: object properties: data: type: array description: The data in the current page items: $ref: '#/components/schemas/RmAppUsageSummary' XiqAlertSortField: type: string description: All available device sort fields TIMESTAMP = Last Detected, SOURCE = Source Name. enum: - TIMESTAMP - SOURCE XiqAlertSource: type: object description: The alert source info properties: source_type_id: type: string description: The alert source type ID. source_name: type: string description: The alert source name source_type: type: string description: The alert source type. source_id: type: string description: The alert source ID. required: - source_type_id - source_name - source_type - source_id XiqAlertTag: type: object description: The tag for the alert 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 - name - value - is_hidden XiqAlert: type: object description: The Alert Model properties: id: type: string description: The unique identifier owner_id: type: integer description: The owner ID format: int64 timestamp: type: string description: The alert create time format: date-time org_id: type: integer description: The organization identifier, valid when enabling HIQ feature format: int64 message_metadata_id: type: integer format: int64 description: The identifier for the unique message type that corresponds to this rule. If message_metadata_type is "EVENT", then this identifier corresponds to the ID from the alerts metadata events API. If message_metadata_type is "METRIC", then this identifier corresponds to the ID from the alerts metadata metrics API. message_metadata_type: type: string description: The type of the message. Currently "EVENT" and "METRIC". Used for getting the metadata API. summary: type: string description: A high-level, text summary message of the event. Will be used to construct an alert's description. severity_id: type: integer format: int64 description: The alert severity ID. severity_name: type: string description: The alert severity name. category_id: type: integer format: int64 description: The alert category ID. category_name: type: string description: The alert category name. source: $ref: '#/components/schemas/XiqAlertSource' acknowledged: type: boolean description: Whether or not this alert has been acknowledged. site_id: type: integer description: The site identifier. format: int64 site_name: type: string description: The site name. alert_policy_id: type: integer description: The alert policy identifier. format: int64 alert_policy_name: type: string description: The alert policy name. alert_rule_id: type: integer description: The alert rule identifier. format: int64 acknowledged_username: type: string description: The login name of the user that acknowledged the alert. tags: type: array description: Additional information for the alert. The values correspond to the object from the alerts/metadata/tags API. items: $ref: '#/components/schemas/XiqAlertTag' required: - id - owner_id - timestamp - message_metadata_id - message_metadata_type - summary - severity_id - severity_name - category_id - category_name - source - acknowledged - site_id - site_name - alert_policy_id - alert_policy_name - alert_rule_id - tags PagedXiqAlert: allOf: - $ref: '#/components/schemas/XiqPage' - type: object properties: data: type: array description: The data in the current page items: $ref: '#/components/schemas/XiqAlert' alertIds: type: object description: The request object to acknowledge. properties: alert_ids: type: array description: The alert ID list items: type: string description: The alert ID XiqAlertGroupQuery: type: string enum: - SEVERITY - CATEGORY - ALERT_TYPE XiqAlertGroupCount: type: object properties: group_id: type: integer description: The group unique identifier. format: int64 group_name: type: string description: The group display name on GUI. count: type: integer description: The count of the type. format: int64 description: The alert group count information. When the group is SEVERITY, the group_id will be severity ID When the group is CATEGORY, the group_id will be category ID When the group is ALERT_TYPE, the group_id will be message metadata ID. required: - group_id - group_name - count XiqAlertReport: type: object description: ExtremeCloud IQ alert report properties: id: type: integer description: The alert report ID format: int64 XiqAlertEmailSubscription: allOf: - $ref: '#/components/schemas/XiqBaseEntity' - type: object description: The email subscription data model required: - email - is_email_verified - is_subscribe_all properties: email: type: string format: email 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 items: type: integer format: int64 description: The selected alert policy list. This field is optional because it is only needed when is_subscribe_all is false. resend_email_after: type: string format: date-time description: This field represents the time after for the user can resend a new verification email. XiqCreateAlertEmailSubscriptionRequest: type: object description: The payload to create email subscription required: - email - is_subscribe_all - alert_policy_ids properties: email: type: string format: email 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 items: type: integer format: int64 description: The selected alert policy list. This field will be an empty collection when is_subscribe_all is true. subscriptionIds: type: object description: The filter to get alert subscriptions properties: ids: type: array description: The subscription ID list items: type: integer description: The subscription ID list format: int64 XiqBulkOperationResult: type: string enum: - PARTIAL_SUCCESS - SUCCESS XiqBulkDeleteEmailSubscriptionResult: type: object description: The result of bulk detele email susbscriptions. properties: ID: type: integer format: int64 description: The ID of email subscription. XiqDeleteBulkAlertSubscriptionEmailResponse: type: object description: The result of a bulk delete for alert email subscriptions. required: - result properties: result: type: string description: The result of this bulk deletion (SUCCESS/PARTIAL_SUCCESS). $ref: '#/components/schemas/XiqBulkOperationResult' example: PARTIAL_SUCCESS reason: type: string description: Indicate the reason of unresolved_deletion. example: At least one ID not found. unresolved_deletions: type: array description: This result will be shown when a bulk delete partially succeeds, providing details of unsuccessful delete IDs and associated names. items: $ref: '#/components/schemas/XiqBulkDeleteEmailSubscriptionResult' XiqUpdateAlertEmailSubscriptionRequest: type: object description: The payload to create email subscription required: - alert_policy_ids properties: email: type: string format: email 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 items: type: integer format: int64 description: The selected alert policy list. This field will be an empty collection when is_subscribe_all is true. XiqAlertWebhookSubscription: allOf: - $ref: '#/components/schemas/XiqBaseEntity' - type: object description: The webhook subscription data model required: - url - is_subscribe_all properties: url: type: string format: uri 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 items: type: integer format: int64 description: The selected alert policy list. This field is optional because it is only needed when is_subscribe_all is false. XiqCreateAlertWebhookSubscriptionRequest: type: object description: The payload to create webhook subscription required: - url - is_subscribe_all - alert_policy_ids properties: url: type: string format: uri 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 items: type: integer format: int64 description: The selected alert policy list. This field will be an empty collection when is_subscribe_all is true. XiqBulkDeleteWebhookSubscriptionResult: type: object description: The result of bulk delete webhook susbscriptions. properties: ID: type: integer format: int64 description: The ID of webhook subscription. XiqDeleteBulkAlertSubscriptionWebhookResponse: type: object description: The result of a bulk delete for alert webhook subscriptions. required: - result properties: result: type: string description: The result of this bulk deletion (SUCCESS/PARTIAL_SUCCESS). $ref: '#/components/schemas/XiqBulkOperationResult' reason: type: string description: Indicate the reason of unresolved_deletion. example: At least one ID not found. unresolved_deletions: type: array description: This result will be shown when a bulk delete partially succeeds, providing details of unsuccessful delete IDs and associated names. items: $ref: '#/components/schemas/XiqBulkDeleteWebhookSubscriptionResult' XiqUpdateAlertWebhookSubscriptionRequest: type: object description: The payload to create webhook subscription required: - alert_policy_ids properties: url: type: string format: uri 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 items: type: integer format: int64 description: The selected alert policy list. This field will be an empty collection when is_subscribe_all is true. XiqAlertServiceNowSubscription: allOf: - $ref: '#/components/schemas/XiqBaseEntity' - type: object description: The ServiceNow subscription data model required: - servicenow_account_email - is_subscribe_all properties: servicenow_account_email: type: string format: email description: The ServiceNow account email. is_enabled: type: boolean description: Enable/disable alert notifications for an ServiceNow. is_subscribe_all: type: boolean description: The all alert policies selected flag. alert_policy_ids: type: array items: type: integer format: int64 description: The selected alert policy list. This field is optional because it is only needed when is_subscribe_all is false. XiqCreateAlertServiceNowSubscriptionRequest: type: object description: The payload to create ServiceNow subscription required: - servicenow_account_email - is_subscribe_all - alert_policy_ids properties: servicenow_account_email: type: string description: The ServiceNow account email which ends with @service-now.com . is_enabled: type: boolean description: Enable/disable alert notifications for an ServiceNow. is_subscribe_all: type: boolean description: The all alert policies selected flag. alert_policy_ids: type: array items: type: integer format: int64 description: The selected alert policy list. This field will be an empty collection when is_subscribe_all is true. XiqBulkDeleteServiceNowSubscriptionResult: type: object description: The result of bulk delete ServiceNow susbscriptions. properties: ID: type: integer format: int64 description: The ID of ServiceNow subscription. XiqDeleteBulkAlertSubscriptionServiceNowResponse: type: object description: The result of a bulk delete for alert ServiceNow subscriptions. required: - result properties: result: type: string description: The result of this bulk deletion (SUCCESS/PARTIAL_SUCCESS). $ref: '#/components/schemas/XiqBulkOperationResult' example: PARTIAL_SUCCESS reason: type: string description: Indicate the reason of unresolved_deletion. example: At least one ID not found. unresolved_deletions: type: array description: This result will be shown when a bulk delete partially succeeds, providing details of unsuccessful delete IDs and associated names. items: $ref: '#/components/schemas/XiqBulkDeleteServiceNowSubscriptionResult' XiqUpdateAlertServiceNowSubscriptionRequest: type: object description: The payload to update ServiceNow subscription required: - alert_policy_ids properties: servicenow_account_email: type: string description: The ServiceNow account email which ends with @service-now.com . is_enabled: type: boolean description: Enable/disable alert notifications for ServiceNow account. is_subscribe_all: type: boolean description: The all alert policies selected flag. alert_policy_ids: type: array items: type: integer format: int64 description: The selected alert policy list. This field will be an empty collection when is_subscribe_all is true. XiqPatchAlertServiceNowSubscriptionRequest: type: object description: The payload to update ServiceNow subscription properties: servicenow_account_email: type: string description: The ServiceNow account email which ends with @service-now.com . is_enabled: type: boolean description: Enable/disable alert notifications for a ServiceNow account. is_subscribe_all: type: boolean description: The all alert policies selected flag. alert_policy_ids: type: array items: type: integer format: int64 description: The selected alert policy list. This field will be an empty collection when is_subscribe_all is true. XiqAlertPolicyType: type: string description: All available policy type GLOBAL and SITE. enum: - GLOBAL - SITE XiqAlertSite: type: object properties: site_id: type: integer description: The location unique identifier format: int64 site_name: type: string description: The site name description: The site information. required: - site_id - site_name XiqAlertRuleOverview: type: object description: The overview for an alert rule. Detailed information is available from the get alert rule API. properties: id: type: integer format: int64 description: The unique identifier of this 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: - id - name - enabled XiqAlertEventRulesByCategory: type: object description: A category and overviews of the associated event-based alert rules. properties: category_id: type: integer format: int64 category_name: type: string rules: type: array items: $ref: '#/components/schemas/XiqAlertRuleOverview' required: - category_id - category_name - rules XiqAlertMetricRulesByMetricset: type: object description: A metricset and overviews of the associated metric-based alert rules. properties: metricset_id: type: integer format: int64 metricset_name: type: string rules: type: array items: $ref: '#/components/schemas/XiqAlertRuleOverview' required: - metricset_id - metricset_name - rules XiqAlertPolicy: type: object properties: id: type: integer description: The unique identifier format: int64 owner_id: type: integer description: The owner ID format: int64 org_id: type: integer description: The organization identifier, valid when enabling HIQ feature format: int64 name: type: string description: The name of this policy sites: type: array items: $ref: '#/components/schemas/XiqAlertSite' event_rules_overview: type: array description: A list of overviews of the event-based alert rules, grouped by category. items: $ref: '#/components/schemas/XiqAlertEventRulesByCategory' metric_rules_overview: type: array description: A list of overviews of the metric-based alert rules, grouped by metricset. items: $ref: '#/components/schemas/XiqAlertMetricRulesByMetricset' description: The alert policy model. Includes the alert policy and the associated rules. required: - id - owner_id - org_id - name - event_rules_overview - metric_rules_overview XiqCreateAlertPolicyRequest: type: object description: The body of a create alert policy request. properties: name: type: string description: The alert policy name site_ids: type: array description: The list of sites to be included in this policy items: type: integer format: int64 required: - name - site_ids XiqUpdateAlertPolicyRequest: type: object description: The request body for updating an alert policy. required: - site_ids properties: name: type: string description: The alert policy name site_ids: type: array description: The list of sites to be included in this policy items: type: integer format: int64 XiqAlertRuleThresholdOperator: type: string enum: - GT - GE - EQ - LT - LE - NE description: Has value when message_metadata_type is "METRIC". The operator for comparing with the threshold. XiqAlertRule: type: object description: The state for a configured alert rule. properties: id: type: integer description: The unique identifier of this rule. format: int64 message_metadata_id: type: integer format: int64 description: The identifier for the unique message type that corresponds to this rule. If message_metadata_type is "EVENT", then this identifier corresponds to the ID from the alerts metadata events API. If message_metadata_type is "METRIC", then this identifier corresponds to the ID from the alerts metadata metrics API. message_metadata_name: type: string description: The display name for the message. Can also be used as a display name for this rule. message_metadata_type: type: string description: The type of the message. Currently "EVENT" and "METRIC". Used for getting the metadata API. 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. trigger_type: type: string description: The configured trigger type of the rule. Currently "DEFERRED", "REPEATED", and "IMMEDIATE". Additional values may be added in the future. example: DEFERRED is_enabled: type: boolean description: True if this rule is active and enabled. duration: type: integer format: int32 description: Has value when trigger_type is "DEFERRED". The deferred duration, in seconds. example: 1 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. example: 3 threshold: type: number format: double description: Has value when message_metadata_type is "METRIC". The threshold for the metric. unit: type: string description: The unit of this threshold operator: $ref: '#/components/schemas/XiqAlertRuleThresholdOperator' required: - id - message_metadata_id - message_metadata_name - message_metadata_type - description - severity_id - severity_name - trigger_type - is_enabled 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. Currently "DEFERRED", "REPEATED", and "IMMEDIATE". Additional values may be added in the future. example: DEFERRED duration: type: integer format: int32 description: Has value when trigger_type is "DEFERRED". The deferred duration, in seconds. example: 1 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. example: 3 threshold: type: number format: double description: Has value when type is "METRIC". The threshold for the message. operator: $ref: '#/components/schemas/XiqAlertRuleThresholdOperator' XiqAuditLogCategory: type: string enum: - ADMIN - SYSTEM - DEPLOYMENT - CONFIG - MONITOR - ALARM XiqAuditLogSortField: type: string description: All fields used to sort the audit logs enum: - TIMESTAMP XiqAuditLog: type: object description: ExtremeCloud IQ Audit Log required: - id properties: id: type: integer description: The audit log id format: int64 category: $ref: '#/components/schemas/XiqAuditLogCategory' user_id: type: integer description: The user id format: int64 code: type: integer description: The audit log code format: int32 username: type: string description: The user name vhm_name: type: string description: The vhm name parameters: type: string description: The audit log parameters org_id: type: integer description: The org id format: int64 timestamp: type: integer description: The audit log timestamp format: int64 description: type: string description: The audit log summary full_description_id: type: integer description: The audit log full description id format: int64 PagedXiqAuditLog: allOf: - $ref: '#/components/schemas/XiqPage' - type: object properties: data: type: array description: The data in the current page items: $ref: '#/components/schemas/XiqAuditLog' XiqAuditLogFullDescriptions: type: object description: ExtremeCloud IQ Audit Log full descriptions required: - id - timestamp - device_id - description properties: id: type: integer description: The audit log full description id format: int64 timestamp: type: integer description: The full description timestamp format: int64 device_id: type: integer description: The device id format: int64 description: type: string description: The audit log full description XiqAuditLogReport: type: object description: ExtremeCloud IQ Audit Log report properties: id: type: integer description: The audit log report ID format: int64 XiqSmsLogStatus: type: string description: The SMS status enum: - SEND_OUT - COMPLETE - SUCCESS - FAIL XiqSmsLog: type: object description: ExtremeCloud IQ SMS Log required: - id properties: id: type: integer description: The SMS log id format: int64 user_id: type: integer description: The user id format: int64 customer_id: type: string description: The customer id tel: type: string description: The phone number profile_name: type: string description: The profile name status: $ref: '#/components/schemas/XiqSmsLogStatus' message_id: type: string description: The message id from 3rd provider status_from_provider: type: string description: The status from provider provider_type: type: string description: The provider type org_id: type: integer description: The org id format: int64 timestamp: type: integer description: The audit log timestamp format: int64 PagedXiqSmsLog: allOf: - $ref: '#/components/schemas/XiqPage' - type: object properties: data: type: array description: The data in the current page items: $ref: '#/components/schemas/XiqSmsLog' XiqEmailLog: type: object description: ExtremeCloud IQ Email Log required: - id properties: id: type: integer description: The Email log id format: int64 username: type: string description: The username org_id: type: integer description: The org id format: int64 timestamp: type: integer description: The email log timestamp format: int64 user_id: type: integer description: The user id format: int64 customer_id: type: string description: The customer id approver_email: type: string description: The approver Email status: type: string description: The email log status PagedXiqEmailLog: allOf: - $ref: '#/components/schemas/XiqPage' - type: object properties: data: type: array description: The data in the current page items: $ref: '#/components/schemas/XiqEmailLog' XiqAuthLog: type: object description: ExtremeCloud IQ Auth Log required: - id properties: id: type: string description: The auth log id auth_type: type: string description: The auth type sn: type: string description: The serial number vhm_id: type: string description: The vhm id username: type: string description: The username reply: type: string description: The reply called_station_id: type: string description: The called station id calling_station_id: type: string description: The calling station id auth_date: type: integer description: The authentication date format: int64 ssid: type: string description: The ssid identity: type: string description: The identity nas_port_type: type: string description: The nas port type reject_reason: type: string description: The reject reason nas_identifier: type: string description: The nas identifier mgmt_mac_address: type: string description: The management mac address org_id: type: integer description: The org id format: int64 timestamp: type: integer description: The audit log timestamp format: int64 PagedXiqAuthLog: allOf: - $ref: '#/components/schemas/XiqPage' - type: object properties: data: type: array description: The data in the current page items: $ref: '#/components/schemas/XiqAuthLog' XiqCredentialLog: type: object description: ExtremeCloud IQ Credential Log required: - id properties: id: type: integer description: The Credential log id format: int64 username: type: string description: The username vhm_id: type: string description: The vhm id org_id: type: integer description: The org id format: int64 timestamp: type: integer description: The credential log timestamp format: int64 PagedXiqCredentialLog: allOf: - $ref: '#/components/schemas/XiqPage' - type: object properties: data: type: array description: The data in the current page items: $ref: '#/components/schemas/XiqCredentialLog' XiqAccountingLog: type: object description: ExtremeCloud IQ Accounting Log required: - id properties: id: type: integer description: The Accounting log id format: int64 username: type: string description: The username org_id: type: integer description: The org id format: int64 timestamp: type: integer description: The email log timestamp format: int64 vhm_id: type: string description: The vhm id device_serial_number: type: string description: The device serial number acct_session_id: type: string description: The acct session id acct_multi_id: type: string description: The acct multi id group_name: type: string description: The group name nas_ip_address: type: string description: The nas ip address nas_port: type: string description: The nas port nas_port_type: type: string description: The nas port type acct_start_time: type: integer description: The acct start time format: int64 acct_stop_time: type: integer description: The acct stop time format: int64 acct_session_time: type: integer description: The acct session time format: int64 acct_authentic: type: string description: The acct authentic connect_info: type: string description: The connect info acct_input_octets: type: integer description: The acct input octets format: int64 acct_output_octets: type: integer description: The acct output octets format: int64 called_station_id: type: string description: The called station id calling_station_id: type: string description: The calling station id acct_terminate_cause: type: string description: The acct terminate cause service_type: type: string description: The service type framed_ip_address: type: string description: The framed ip address acct_start_delay: type: integer description: The acct start delay format: int64 acct_stop_delay: type: integer description: The acct stop delay format: int64 ssid: type: string description: The ssid identity: type: string description: The identity nas_identifier: type: string description: The nas identifier mgmt_mac_address: type: string description: The management mac address attribute_num: type: integer description: The attribute num format: int32 event_time: type: integer description: The event time format: int64 PagedXiqAccountingLog: allOf: - $ref: '#/components/schemas/XiqPage' - type: object properties: data: type: array description: The data in the current page items: $ref: '#/components/schemas/XiqAccountingLog' XiqSubscriptionDataType: type: string description: The webhook subscription data type. enum: - LOCATION - AUDIT_LOG - GDPR_LOG - CREDENTIAL_LOG - ACCOUNTING_LOG - AUTHENTICATION_LOG - EMAIL_LOG - SMS_LOG XiqSubscriptionMessageType: type: string description: The subscription message type. 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 description: The webhook subscription status. enum: - ENABLED - DISABLED XiqWebhookSubscription: allOf: - $ref: '#/components/schemas/XiqBaseEntity' - type: object description: The webhook subscription data model required: - application - url - secret - data_type - message_type - status properties: application: type: string description: The external application name. url: type: string description: The webhook endpoint URL. secret: type: string description: The basic auth secret for the webhook endpoint. data_type: $ref: '#/components/schemas/XiqSubscriptionDataType' message_type: $ref: '#/components/schemas/XiqSubscriptionMessageType' status: $ref: '#/components/schemas/XiqSubscriptionStatus' PagedXiqWebhookSubscription: allOf: - $ref: '#/components/schemas/XiqPage' - type: object properties: data: type: array description: The data in the current page items: $ref: '#/components/schemas/XiqWebhookSubscription' XiqCreateWebhookSubscriptionRequest: type: object description: The payload to create webhook subscription required: - application - url - message_type properties: 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. message_type: $ref: '#/components/schemas/XiqSubscriptionMessageType' XiqUpdateWebhookSubscriptionRequest: type: object description: The payload to update webhook subscription required: - application - url - message_type - status properties: 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. message_type: $ref: '#/components/schemas/XiqSubscriptionMessageType' description: The API Subscriber message type e.g, "LOCATION_AP_CENTRIC" or "LOCATION_CLIENT_CENTRIC". status: $ref: '#/components/schemas/XiqSubscriptionStatus' description: The API Subscriber status e.g, "ENABLED" or "DISABLED". XiqScheduleDetails: type: object description: The deployment schedule details required: - start_time properties: start_time: type: integer description: The start time of the firmware upgrade format: int64 XiqDeployDeviceFilter: type: object description: The filter to get matched devices properties: ids: type: array description: The device ID list items: type: integer description: The device ID list format: int64 site_ids: type: array description: The site ID list items: type: integer description: The site ID list format: int64 XiqFirmwareUpgradePolicy: type: object description: The firmware upgrade policy required: - enable_enforce_upgrade - enable_distributed_upgrade 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 required: - firmware_id - device_id - product_type properties: firmware_id: type: integer description: The device compatible firmware metadata ID format: int64 device_id: type: integer description: The device ID format: int64 product_type: type: string description: The product type XiqFirmwareActivateOption: type: object description: The firmware activate option (Only one of them can be enabled) properties: activation_delay_seconds: type: integer description: Activate after the given seconds format: int64 activation_time: type: integer description: Activate at the following time according to the system clock on the updated device format: int64 enable_activate_at_next_reboot: type: boolean description: Activate at next reboot (requires rebooting manually) 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 description: The firmware upgrade versions items: $ref: '#/components/schemas/XiqFirmwareUpgradeVersion' firmware_activate_option: $ref: '#/components/schemas/XiqFirmwareActivateOption' XiqDeploymentOverviewDetails: type: object description: The configuration deployment overview required: - total_devices - in_progress_devices - total_progress properties: total_devices: type: integer description: The total device count format: int32 in_progress_devices: type: integer description: The device count with in progress deployment format: int32 total_progress: type: integer description: The total progress, range from 0 to 100 format: int32 XiqDeploymentDetailsResponse: type: object description: The deployment details properties: deployment_id: type: integer format: uint64 schedule: $ref: '#/components/schemas/XiqScheduleDetails' devices: $ref: '#/components/schemas/XiqDeployDeviceFilter' policy: $ref: '#/components/schemas/XiqDeploymentPolicy' overview: $ref: '#/components/schemas/XiqDeploymentOverviewDetails' XiqDeploymentRequest: type: object description: The configuration deployment request to devices properties: schedule: $ref: '#/components/schemas/XiqScheduleDetails' devices: $ref: '#/components/schemas/XiqDeployDeviceFilter' policy: $ref: '#/components/schemas/XiqDeploymentPolicy' XiqDeploymentStatus: type: object description: The configuration deployment status properties: current_progress: type: integer description: The current deploy progress if not finished, range from 0 to 100 format: int32 current_step_code: type: string description: The code of the current deploy step if not finished current_step_message: type: string description: The readable message of the current deploy step if not finished is_finished_successful: type: boolean description: Indicates whether the last deployment is successful if finished last_deploy_time: type: integer description: The last deployed time (Only valid when in_progress = false) format: int64 finished: type: boolean status_message: type: string description: The status message XiqDeploymentResponse: type: object description: The configuration deployment response properties: deployment_id: type: integer description: The deployment ID format: uint64 deployment_status: type: object additionalProperties: $ref: '#/components/schemas/XiqDeploymentStatus' XiqDeploymentOverview: type: object description: The configuration deployment overview required: - in_progress_devices - total_progress properties: in_progress_devices: type: integer description: The device count with in progress deployment format: int32 total_progress: type: integer description: The total progress, range from 0 to 100 format: int32 XiqDeviceFirmwareMetadata: type: object description: The device compatible firmware metadata properties: firmware_id: type: integer description: The firmware metadata ID format: int64 create_time: type: string description: The create time format: date-time update_time: type: string description: The last update time format: date-time 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 XiqScheduleStatus: type: string enum: - SCHEDULED - IN_PROGRESS - ABORTED - COMPLETED - FAILED - TIME_OUT XiqDeploymentScheduleStatusResponse: type: object description: The status of the firmware upgrade sites/devices properties: schedule_status: $ref: '#/components/schemas/XiqScheduleStatus' schedule_time: type: integer format: uint64 created_time: type: integer format: uint64 updated_time: type: integer format: uint64 site_info: type: object description: The site information properties: site_id: type: integer format: uint64 device_ids: type: array description: The device ID list items: type: integer description: The device ID format: uint64 overview: $ref: '#/components/schemas/XiqDeploymentOverview' deployment_status: type: object additionalProperties: $ref: '#/components/schemas/XiqDeploymentStatus' overview: $ref: '#/components/schemas/XiqDeploymentOverview' PagedXiqVlanProfile: allOf: - $ref: '#/components/schemas/XiqPage' - type: object properties: data: type: array description: The data in the current page items: $ref: '#/components/schemas/XiqVlanProfile' XiqCreateVlanObjectClassifiedEntryRequest: type: object description: The VLAN object classified entries required: - vlan_id - classification_rule_id properties: vlan_id: type: integer description: The VLAN ID format: int32 classification_rule_id: type: integer description: The classification rule ID format: int64 XiqCreateVlanProfileRequest: type: object required: - name - default_vlan_id - enable_classification properties: name: type: string description: The VLAN profile name default_vlan_id: type: integer description: The default VLAN ID format: int32 enable_classification: type: boolean description: If apply VLANs to devices using classification classified_entries: type: array description: The VLAN object classified entries items: $ref: '#/components/schemas/XiqCreateVlanObjectClassifiedEntryRequest' XiqUpdateVlanObjectClassifiedEntryRequest: type: object description: The VLAN object classified entries required: - vlan_id - classification_rule_id properties: vlan_id: type: integer description: The VLAN ID format: int32 classification_rule_id: type: integer description: The classification rule ID format: int64 XiqUpdateVlanProfileRequest: type: object required: - name - default_vlan_id - enable_classification properties: name: type: string description: The VLAN profile name default_vlan_id: type: integer description: The default VLAN ID format: int32 enable_classification: type: boolean description: If apply VLANs to devices using classification classified_entries: type: array description: The VLAN object classified entries items: $ref: '#/components/schemas/XiqUpdateVlanObjectClassifiedEntryRequest' XiqPasswordType: type: string description: The access key type enum: - PPSK - RADIUS XiqEmailTemplate: allOf: - $ref: '#/components/schemas/XiqViqEntity' - type: object description: The password or the PPSK notification template for user groups. required: - name - predefined - password_type properties: name: type: string description: The email template name description: type: string description: The email template description predefined: type: boolean description: Whether or not it is a system predefined 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' XiqSmsTemplate: allOf: - $ref: '#/components/schemas/XiqViqEntity' - type: object description: The password or PPSK notification template for user groups. required: - name - predefined - password_type properties: 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' XiqEndUser: allOf: - $ref: '#/components/schemas/XiqViqEntity' - type: object description: The password or PPSK notification template for user groups. required: - name - email_address - phone_number - user_name - user_group_id - expired_time properties: name: type: string description: The user common name description: type: string description: The user description email_address: type: string description: The user email address phone_number: type: string description: The user phone number password: type: string description: The user password user_name: type: string description: The user identifiable name or the same one from common name, emailAddress or phoneNumber organization: type: string description: The organization name visit_purpose: type: string description: The purpose of visit email_password_delivery: type: string description: The email address for password delivery sms_password_delivery: type: string description: The sms number for password delivery user_group_id: type: integer description: The user group ID format: int64 expired_time: type: integer description: The password expired time format: int64 vlan_override: type: integer description: VLAN ID override assigned to the user format: int32 minimum: 1 maximum: 4094 PagedXiqEndUser: allOf: - $ref: '#/components/schemas/XiqPage' - type: object properties: data: type: array description: The data in the current page items: $ref: '#/components/schemas/XiqEndUser' XiqCreateEndUserRequest: type: object required: - user_group_id - user_name properties: user_group_id: type: integer description: The user group ID format: int64 name: type: string description: The user common name user_name: type: string description: The designated username, must match either the user's name, emailAddress, or phoneNumber organization: type: string description: The organization name visit_purpose: type: string description: The purpose of visit description: type: string description: The user description email_address: type: string description: The user email phone_number: type: string description: The user phone number password: type: string description: The user password, if null a random password will be generated base on the user group rule email_password_delivery: type: string description: The password delivery Email sms_password_delivery: type: string description: The password delivery SMS vlan_override: type: integer minimum: 1 maximum: 4094 description: VLAN ID override assigned to the user (range 1-4094, Optional) format: int32 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 minimum: 1 maximum: 4094 description: VLAN ID override assigned to the user (range 1-4094, Optional) format: int32 XiqRegenerateEndUserPasswordResponse: type: object description: The newly generated password for the end user required: - password properties: password: type: string description: The new password of the end user XiqPasswordDbLocation: type: string description: The access key storage location enum: - CLOUD - LOCAL XiqPcgType: type: string description: The private client group type for pcgUseOnly enum: - AP_BASED - KEY_BASED XiqPskGenerationMethod: type: string description: The psk generation method enum: - PASSWORD_ONLY - USER_STRING_PASSWORD XiqPasswordCharacterType: type: string description: Password generation using letters, numbers, and/or special characters enum: - INCLUDE_ALL_CHARACTER_TYPE_ENABLED - INCLUDE_ANY_CHARACTER_TYPES_ENABLED - INCLUDE_ONLY_ONE_CHARACTER_TYPE_ENABLED XiqPasswordSettings: type: object description: The password settings ID required: - psk_generation_method - password_character_types - password_length properties: enable_letters: type: boolean description: Enable use of letters enable_numbers: type: boolean description: Enable use of numbers enable_special_characters: type: boolean description: Enable use of special characters password_concat_string: type: string description: The password concatenated string psk_generation_method: $ref: '#/components/schemas/XiqPskGenerationMethod' password_character_types: $ref: '#/components/schemas/XiqPasswordCharacterType' password_length: type: integer description: The maximun password string length format: int32 XiqExpirationType: type: string description: The for one of the account expiration types. enum: - NEVER_EXPIRE - VALID_DURING_DATES - VALID_FOR_TIME_PERIOD - DAILY XiqDateTimeType: type: object description: The end date and time required: - day_of_month - month - year - hour_of_day - minute_of_hour properties: day_of_month: type: integer description: The day of month format: int32 month: type: integer description: The month format: int32 year: type: integer description: The year format: int32 hour_of_day: type: integer description: The 24-hour format hour of day format: int32 minute_of_hour: type: integer description: The minute of the hour format: int32 XiqValidDuringDateSettings: type: object description: The settings for Valid During Dates option or null for other settings. required: - start_date_time - end_date_time - time_zone properties: start_date_time: $ref: '#/components/schemas/XiqDateTimeType' end_date_time: $ref: '#/components/schemas/XiqDateTimeType' time_zone: type: string description: The date/time timezone XiqValidTimePeriodAfterType: type: string description: The valid time period after Id creation or first login. enum: - ID_CREATION - FIRST_LOGIN XiqDateTimeUnitType: type: string description: The after expiration scheduled time unit. enum: - MINUTE - HOUR - DAY - WEEK XiqValidTimePeriodAfterIdCreation: type: object description: The settings for the valid time period after ID Creation option or null for the other option required: - valid_time_period - valid_time_period_unit properties: valid_time_period: type: integer description: The valid time period after account creation format: int32 valid_time_period_unit: $ref: '#/components/schemas/XiqDateTimeUnitType' XiqValidTimePeriodAfterFirstLogin: type: object description: The settings for the valid time period after First Login option or null for the other option required: - valid_time_period - valid_time_period_unit - first_login_within - first_login_within_unit properties: valid_time_period: type: integer description: The valid time period after the first login format: int32 valid_time_period_unit: $ref: '#/components/schemas/XiqDateTimeUnitType' first_login_within: type: integer description: The first time the access key must be used format: int32 first_login_within_unit: $ref: '#/components/schemas/XiqDateTimeUnitType' XiqValidForTimePeriodSettings: type: object description: The settings for Valid For Time Period option or null for other settings. required: - valid_time_period_after properties: valid_time_period_after: $ref: '#/components/schemas/XiqValidTimePeriodAfterType' after_id_creation_settings: $ref: '#/components/schemas/XiqValidTimePeriodAfterIdCreation' after_first_login_settings: $ref: '#/components/schemas/XiqValidTimePeriodAfterFirstLogin' XiqValidDailySettings: type: object description: The settings for Valid Daily option or null for other settings. required: - daily_end_hour - daily_end_minute - daily_start_hour - daily_start_minute properties: daily_start_hour: type: integer description: The 24-hour format start hour of the day format: int32 daily_start_minute: type: integer description: The minute of the hour format: int32 daily_end_hour: type: integer description: The 24-hour format end hour of day the end format: int32 daily_end_minute: type: integer description: The minute of the hour format: int32 XiqExpirationActionType: type: string description: The Expiration Action to take, null if the account is never expired. enum: - SHOW_MESSAGE - REJECT_ACCESS XiqPostExpirationAction: type: object description: The type of action to take after the account expiration. properties: enable_credentials_renewal: type: boolean description: The renew user credentials option or null for other option. enable_delete_immediately: type: boolean description: The immediate delete option or null to schedule the delete. delete_after_value: type: integer description: The after expiration scheduled time to delete or null to not delete.. format: int32 delete_after_unit: $ref: '#/components/schemas/XiqDateTimeUnitType' XiqExpirationSettings: type: object description: The password expiration settings properties: expiration_type: $ref: '#/components/schemas/XiqExpirationType' valid_during_dates: $ref: '#/components/schemas/XiqValidDuringDateSettings' valid_for_time_period: $ref: '#/components/schemas/XiqValidForTimePeriodSettings' valid_daily: $ref: '#/components/schemas/XiqValidDailySettings' expiration_action: $ref: '#/components/schemas/XiqExpirationActionType' post_expiration_action: $ref: '#/components/schemas/XiqPostExpirationAction' XiqDeliverySettings: type: object description: The password delivery settings properties: email_template_id: type: integer description: The Email Template ID format: int64 sms_template_id: type: integer description: The SMS Template ID format: int64 XiqUserGroup: allOf: - $ref: '#/components/schemas/XiqViqEntity' - type: object description: The password or PPSK notification template for user groups. required: - name - predefined - password_db_location - password_type - delivery_settings - password_settings - expiration_settings properties: name: type: string description: The user group name description: type: string description: The user group description predefined: type: boolean description: Whether it is predefined password_db_location: $ref: '#/components/schemas/XiqPasswordDbLocation' password_type: $ref: '#/components/schemas/XiqPasswordType' pcg_use_only: type: boolean description: Whether it's for PCG use only pcg_type: $ref: '#/components/schemas/XiqPcgType' ppsk_use_only: type: boolean description: Whether it's for PPSK use only enable_cwp_reg: type: boolean description: Whether to enable CWP registration setting password_settings: $ref: '#/components/schemas/XiqPasswordSettings' expiration_settings: $ref: '#/components/schemas/XiqExpirationSettings' delivery_settings: $ref: '#/components/schemas/XiqDeliverySettings' PagedXiqUserGroup: allOf: - $ref: '#/components/schemas/XiqPage' - type: object properties: data: type: array description: The data in the current page items: $ref: '#/components/schemas/XiqUserGroup' XiqCreateUserGroupRequest: type: object required: - name - password_db_location - password_type - password_settings - expiration_settings - delivery_settings properties: name: type: string description: The user group name description: type: string description: The user group description password_db_location: $ref: '#/components/schemas/XiqPasswordDbLocation' ppsk_use_only: type: boolean description: Whether it's for PPSK use only password_type: $ref: '#/components/schemas/XiqPasswordType' enable_max_clients_per_ppsk: type: boolean description: The enablement for the maximum number of clients per private PSK max_clients_per_ppsk: type: integer description: The maximum number of clients per private PSK format: int32 pcg_use_only: type: boolean description: Whether it's for PCG use only pcg_type: $ref: '#/components/schemas/XiqPcgType' enable_cwp_reg: type: boolean description: Whether to enable CWP registration setting password_settings: $ref: '#/components/schemas/XiqPasswordSettings' expiration_settings: $ref: '#/components/schemas/XiqExpirationSettings' delivery_settings: $ref: '#/components/schemas/XiqDeliverySettings' XiqUpdateUserGroupRequest: type: object required: - name - password_db_location - password_type - delivery_settings - password_settings - expiration_settings properties: name: type: string description: The user group name description: type: string description: The user group description password_db_location: $ref: '#/components/schemas/XiqPasswordDbLocation' ppsk_use_only: type: boolean description: Whether it's for PPSK use only password_type: $ref: '#/components/schemas/XiqPasswordType' enable_max_clients_per_ppsk: type: boolean description: The enablement for the maximum number of clients per private PSK max_clients_per_ppsk: type: integer description: The maximum number of clients per private PSK format: int32 pcg_use_only: type: boolean description: Whether it's for PCG use only pcg_type: $ref: '#/components/schemas/XiqPcgType' enable_cwp_reg: type: boolean description: Whether to enable CWP registration setting password_settings: $ref: '#/components/schemas/XiqPasswordSettings' expiration_settings: $ref: '#/components/schemas/XiqExpirationSettings' delivery_settings: $ref: '#/components/schemas/XiqDeliverySettings' XiqKeyBasedPcgUser: allOf: - $ref: '#/components/schemas/XiqViqEntity' - type: object description: The key based PCG user detailed info required: - name - email - user_group_name 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 XiqKeyBasedPcg: allOf: - $ref: '#/components/schemas/XiqViqEntity' - type: object description: The response of key based PCG data required: - policy_id - policy_name - ssid_name - enabled properties: policy_id: type: integer description: The network policy ID format: int64 policy_name: type: string description: The network policy name ssid_name: type: string description: The SSID name enabled: type: boolean description: Enabled Key Based PCG users: type: array description: The XIQ key based PCG users items: $ref: '#/components/schemas/XiqKeyBasedPcgUser' XiqKeyBasedPcgUserBaseInfo: required: - email - name - user_group_name type: object properties: name: type: string description: The user name of key based PCG, which could not share with other exist key based PCG email: type: string description: The email for deliver key based PCG user password user_group_name: type: string description: The user group name description: The user's base info XiqCreateKeyBasedPcgNetworkPolicyRequest: type: object description: The request to initiate Key-based Private Client Group required: - policy_name - ssid_name - users 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' XiqCreateKeyBasedPcgNetworkPolicyResponse: allOf: - $ref: '#/components/schemas/XiqViqEntity' - type: object description: The response of key based PCG data required: - policy_id - policy_name - ssid_name properties: policy_id: type: integer description: The network policy ID format: int64 policy_name: type: string description: The network policy name ssid_name: type: string description: The SSID name users: type: array description: The XIQ key based PCG users items: $ref: '#/components/schemas/XiqKeyBasedPcgUser' XiqOnboardKeyBasedPcgRequest: type: object description: The payload to create Key Based PCG data(from exist network policy and SSID) required: - ssid_name - enabled - user_ids properties: ssid_name: type: string enabled: type: boolean description: Enable the key based PCG user_ids: type: array description: The request user IDs items: type: integer description: The request user IDs format: int64 XiqOnboardKeyBasedPcgResponse: type: object description: Add users to a PCG-enabled network policy properties: policy_name: type: string description: The policy name ssid_name: type: string description: The SSID name status: type: string description: Add user status XiqUpdateKeyBasedPcgUsersRequest: type: object description: The payload of replace Key-based Private Client Group users request required: - users properties: users: type: array description: The Key-based PCG users items: $ref: '#/components/schemas/XiqKeyBasedPcgUserBaseInfo' XiqCreateKeyBasedPcgUsersRequest: type: object description: The payload of add Key-based Private Client Group users request required: - users properties: users: type: array description: The key based PCG users items: $ref: '#/components/schemas/XiqKeyBasedPcgUserBaseInfo' XiqAddKeyBasedPcgUsersToNetworkPolicyResponse: type: object description: Add users to a PCG-enabled network policy properties: policy_id: type: integer description: The policy id format: int64 status: type: string description: Add user status users: type: array description: The XIQ key based PCG users items: $ref: '#/components/schemas/XiqKeyBasedPcgUser' XiqDeleteKeyBasedPcgUsersRequest: type: object description: The payload of delete Key Based Private Client Group users request required: - user_ids properties: user_ids: type: array description: The user ID list items: type: integer description: The user ID list format: int64 XiqPcgPortAssignmentEntryDeviceMeta: allOf: - $ref: '#/components/schemas/XiqViqEntity' - type: object description: The PCG port assignment entry device info required: - mac_address - serial_number - product_type properties: mac_address: type: string description: The mac address serial_number: type: string description: The serial number product_type: type: string description: The product type XiqPcgPortAssignmentEntryEthUserMeta: allOf: - $ref: '#/components/schemas/XiqViqEntity' - type: object description: The PCG port assignment entry of eth user info required: - name - password - user_type - user_group_name - ssids properties: name: type: string description: The user name password: type: string description: The user password user_type: type: string description: The user type user_group_name: type: string description: The user group name ssids: type: array description: The SSIDs items: type: string description: The SSIDs XiqPcgPortAssignmentEntryDetail: allOf: - $ref: '#/components/schemas/XiqViqEntity' - type: object description: The PCG port assignment entry detail properties: device: $ref: '#/components/schemas/XiqPcgPortAssignmentEntryDeviceMeta' eth1: $ref: '#/components/schemas/XiqPcgPortAssignmentEntryEthUserMeta' eth2: $ref: '#/components/schemas/XiqPcgPortAssignmentEntryEthUserMeta' eth3: $ref: '#/components/schemas/XiqPcgPortAssignmentEntryEthUserMeta' XiqGetPortAssignmentDetailsResponse: type: object description: The response of port assignment details for AP150W required: - policy_id - policy_name properties: policy_id: type: integer description: The network policy ID format: int64 policy_name: type: string description: The network policy name pcg_port_assignment_entry_details: type: array description: The PCG port assignment entry details items: $ref: '#/components/schemas/XiqPcgPortAssignmentEntryDetail' XiqPcgPortAssignment: type: object description: The PCG port assignment entry required: - device_id properties: device_id: type: integer description: The device ID of AP150W format: int64 eth1_user_id: type: integer description: The eth1 user ID, get available users from "/pcgs/key-based/network-policy-{policyId}/users" format: int64 eth2_user_id: type: integer description: The eth2 user ID, get available users from "/pcgs/key-based/network-policy-{policyId}/users" format: int64 eth3_user_id: type: integer description: The eth3 user ID, get available users from "/pcgs/key-based/network-policy-{policyId}/users" format: int64 XiqPcgAssignPortsRequest: type: object description: The payload to assign ports for AP150W required: - port_assignments properties: port_assignments: type: array description: The port assignment list items: $ref: '#/components/schemas/XiqPcgPortAssignment' XiqPcgPortAssignmentEntry: allOf: - $ref: '#/components/schemas/XiqViqEntity' - type: object description: The PCG port assignment entry required: - device_id properties: device_id: type: integer description: The device ID of AP150W format: int64 eth1_user_id: type: integer description: The eth1 user ID, get available users from "/pcgs/key-based/network-policy-{policyId}/users" format: int64 eth2_user_id: type: integer description: The eth2 user ID, get available users from "/pcgs/key-based/network-policy-{policyId}/users" format: int64 eth3_user_id: type: integer description: The eth3 user ID, get available users from "/pcgs/key-based/network-policy-{policyId}/users" format: int64 XiqPcgAssignPortsResponse: type: object description: The response of assign ports for AP150W required: - policy_id - policy_name - pcg_port_assignment_entries properties: policy_id: type: integer description: The network policy ID format: int64 policy_name: type: string description: The network policy name pcg_port_assignment_entries: type: array description: The port assignment entry list items: $ref: '#/components/schemas/XiqPcgPortAssignmentEntry' PagedXiqClassificationRule: allOf: - $ref: '#/components/schemas/XiqPage' - type: object properties: data: type: array description: The data in the current page items: $ref: '#/components/schemas/XiqClassificationRule' XiqCreateClassificationRequest: type: object description: The details of rule assignments required: - classification_type - match - classification_type_id properties: classification_type: type: string description: Classification type enum: - CLASSIFICATION_TYPE_UNSPECIFIED - CLASSIFICATION_TYPE_LOCATION - CLASSIFICATION_TYPE_CLOUD_CONFIG_GROUP - CLASSIFICATION_TYPE_IP_ADDRESS - CLASSIFICATION_TYPE_IP_SUBNET - CLASSIFICATION_TYPE_IP_RANGE - UNRECOGNIZED match: type: boolean description: Contains or not contains classification_type_id: type: integer description: The ID of location, cloud config group, IP address, IP subnet or IP range. format: int64 XiqCreateClassificationRuleRequest: type: object required: - name - classifications properties: name: type: string description: The name of classification rule description: type: string description: The description of classification rule classifications: type: array description: The details of rule assignments items: $ref: '#/components/schemas/XiqCreateClassificationRequest' XiqUpdateClassificationRequest: type: object description: The details of rule Rules required: - classification_type - match - classification_type_id properties: classification_type: type: string description: Classification type enum: - CLASSIFICATION_TYPE_UNSPECIFIED - CLASSIFICATION_TYPE_LOCATION - CLASSIFICATION_TYPE_CLOUD_CONFIG_GROUP - CLASSIFICATION_TYPE_IP_ADDRESS - CLASSIFICATION_TYPE_IP_SUBNET - CLASSIFICATION_TYPE_IP_RANGE - UNRECOGNIZED match: type: boolean description: Contains or not contains) classification_type_id: type: integer description: The ID of location, cloud config group, IP address, IP subnet or IP range. format: int64 XiqUpdateClassificationRuleRequest: required: - name - classifications type: object properties: name: type: string description: The name of classification assignment description: type: string description: The description of classification assignment classifications: type: array description: The details of rule Rules items: $ref: '#/components/schemas/XiqUpdateClassificationRequest' XiqL3AddressType: type: string description: Address type enum: - IP_ADDRESS - IP_SUBNET - IP_RANGE - HOST_NAME - WILDCARD_HOST_NAME - WILDCARD XiqAddressProfileClassifiedEntry: type: object description: Address profile classified entry properties: value: type: string description: The classified entry value. description: type: string description: The classified entry description. netmask: type: string description: The classified entry netmask. ip_address_end: type: string description: The classified entry IP address end. wildcard_mask: type: string description: The classified entry wildcard mask. classification_assignment_id: type: integer format: int64 description: The classification assignment ID for RADIUS client profile entry. XiqL3AddressCommon: allOf: - type: object description: The L3 address common objects required: - name - address_type properties: predefined: type: boolean description: Flag to describe whether the application is predefined or customised. name: type: string description: Address profile name. description: type: string description: Address profile description. value: type: string description: Address profile value. enable_classification: type: boolean description: The flag to enable classification on L3 address profile. address_type: $ref: '#/components/schemas/XiqL3AddressType' description: The L3 address profile type. classified_entries: type: array description: The address profile classified entries. items: $ref: '#/components/schemas/XiqAddressProfileClassifiedEntry' description: address profile classified entry. XiqL3AddressProfile: allOf: - $ref: '#/components/schemas/XiqViqEntity' - $ref: '#/components/schemas/XiqL3AddressCommon' - type: object description: The L3 address profile XiqCreateL3AddressProfileRequest: type: object required: - name - address_type properties: name: type: string description: The L3 Address profile name. value: type: string description: The L3 Address profile value. description: type: string description: The L3 Address profile description. address_type: $ref: '#/components/schemas/XiqL3AddressType' description: The L3 address type. enable_classification: type: boolean description: The flag to enable classification entries on host name address profile. classified_entries: type: array description: The host name address profile classified entries. items: $ref: '#/components/schemas/XiqAddressProfileClassifiedEntry' description: The host name address profile classified entry. ip_address_end: type: string description: The classified entry IP address end, only available for "IP_RANGE" address type. netmask: type: string description: The classified entry IP address end, only available for "IP_SUBNET" address type. wildcard_mask: type: string description: The wildcard address profile mask value, only available for "WILDCARD" address type. XiqHostNameAddressProfile: allOf: - $ref: '#/components/schemas/XiqL3AddressProfile' XiqWildcardHostNameAddressProfile: allOf: - $ref: '#/components/schemas/XiqL3AddressProfile' XiqIpAddressProfile: allOf: - $ref: '#/components/schemas/XiqL3AddressProfile' XiqIpRangeAddressProfile: allOf: - $ref: '#/components/schemas/XiqL3AddressProfile' - type: object description: IP range address profile properties: ip_address_end: type: string description: The classified entry IP address end. XiqSubnetAddressProfile: allOf: - $ref: '#/components/schemas/XiqL3AddressProfile' - type: object description: Subnet address profile properties: netmask: type: string description: The Subnet address netmask. XiqWildcardAddressProfile: allOf: - $ref: '#/components/schemas/XiqL3AddressProfile' - type: object description: Wildcard address profile properties: wildcard_mask: type: string description: The wildcard address profile mask value. XiqUpdateL3AddressProfileRequest: type: object properties: name: type: string description: The L3 Address profile name. description: type: string description: The L3 Address profile description. enable_classification: type: boolean description: The flag to enable classification entries on host name address profile. classified_entries: type: array description: The host name address profile classified entries. items: $ref: '#/components/schemas/XiqAddressProfileClassifiedEntry' description: The host name address profile classified entry. ip_address_end: type: string description: The classified entry IP address end. netmask: type: string description: The classified entry IP netmask. wildcard_mask: type: string description: The wildcard address profile mask value. XiqIpFirewallAction: type: string enum: - PERMIT - DENY - TRAFFIC_DROP - NAT - REDIRECT XiqNetworkIpProtocol: type: string enum: - TCP - UDP - SVP - CUSTOM XiqNetworkAlgType: type: string enum: - NONE - FTP - TFTP - SIP - DNS - HTTP XiqNetworkServiceRequest: type: object description: Network properties: name: type: string description: The network service name. description: type: string description: The network service name. ip_protocol: $ref: '#/components/schemas/XiqNetworkIpProtocol' description: The IP protocol. protocol_number: type: integer format: int32 description: The protocol number. port_number: type: integer format: int32 description: The port number. alg_type: $ref: '#/components/schemas/XiqNetworkAlgType' description: The Application Layer Gateway (ALG) type. XiqNetwork: allOf: - $ref: '#/components/schemas/XiqViqEntity' - $ref: '#/components/schemas/XiqNetworkServiceRequest' XiqNetworkService: allOf: - $ref: '#/components/schemas/XiqNetwork' - type: object description: Network Service required: - service_type properties: service_type: type: string description: Service type. enum: - NETWORK - APPLICATION XiqApplicationService: allOf: - $ref: '#/components/schemas/XiqApplication' - type: object description: Application service required: - service_type properties: service_type: type: string description: Service type. enum: - NETWORK - APPLICATION XiqLoggingType: type: string description: Firewall Rule Logging type enum: - 'OFF' - DROPPED_PACKETS - SESSION_INITIATION - SESSION_TERMINATION - BOTH XiqIpFirewallRule: allOf: - $ref: '#/components/schemas/XiqViqEntity' - type: object description: IP Firewall Rule properties: action: $ref: '#/components/schemas/XiqIpFirewallAction' description: The IP Firewall Action. service: anyOf: - $ref: '#/components/schemas/XiqNetworkService' - $ref: '#/components/schemas/XiqApplicationService' discriminator: propertyName: service_type mapping: NETWORK: '#/components/schemas/XiqNetworkService' APPLICATION: '#/components/schemas/XiqApplicationService' description: The IP Firewall service type. source_ip: $ref: '#/components/schemas/XiqL3AddressProfile' description: Source IP for IP Firewall Rule. destination_ip: $ref: '#/components/schemas/XiqL3AddressProfile' description: Destination IP for IP Firewall Rule. logging_type: $ref: '#/components/schemas/XiqLoggingType' description: The logging Type for IP Firewall Rule. XiqIpFirewall: allOf: - $ref: '#/components/schemas/XiqViqEntity' - type: object description: IP Firewall policy. properties: name: type: string description: The IP Firewall policy name description: type: string description: The IP Firewall policy description. rules: type: array description: List of IP Firewall Rules. items: $ref: '#/components/schemas/XiqIpFirewallRule' predefined: type: boolean description: Flag to describe whether the application is predefined or customized. PagedIpFirewall: allOf: - $ref: '#/components/schemas/XiqPage' - type: object properties: data: type: array description: The data in the current page items: $ref: '#/components/schemas/XiqIpFirewall' XiqIpFirewallRuleRequest: type: object properties: action: $ref: '#/components/schemas/XiqIpFirewallAction' description: The IP Firewall Action. service: type: integer description: Application or Network Service ID for IP Firewall Rule. format: int64 source_ip: type: integer description: Source IP for IP Firewall Rule. format: int64 destination_ip: type: integer description: Destination IP for IP Firewall Rule. format: int64 logging_type: $ref: '#/components/schemas/XiqLoggingType' description: The logging Type for IP Firewall Rule. XiqIpFirewallPolicyRequest: type: object required: - name - description - rules properties: name: type: string description: The IP firewall policy name description: type: string description: The IP firewall policy description. rules: type: array description: List of IP Firewall Rules..... items: $ref: '#/components/schemas/XiqIpFirewallRuleRequest' XiqAttachIpFirewallRuleToIpFirewallPolicy: type: object properties: service_id: type: integer format: int64 description: The Application / Network Service ID. source_ip: type: integer format: int64 description: The Source L3 Address Profile ID. destination_ip: type: integer format: int64 description: The Destination L3 Address Profile ID. action: $ref: '#/components/schemas/XiqIpFirewallAction' description: The IP Firewall Action. logging_type: $ref: '#/components/schemas/XiqLoggingType' description: The logging Type for IP Firewall Rule. XiqIpFirewallRuleId: type: object required: - ip_firewall_rule_id properties: ip_firewall_rule_id: type: integer format: int64 description: The IP Firewall Rule ID. XiqMacFirewallAction: type: string enum: - PERMIT - DENY XiqMacObjectType: type: string description: Mac Object type enum: - MAC_OUI - MAC_RANGE - MAC_ADDRESS XiqMacObject: allOf: - $ref: '#/components/schemas/XiqViqEntity' - type: object description: The MAC Object. properties: name: type: string description: The MAC object name. description: type: string description: The MAC object description. predefined: type: boolean description: Whether the MAC Oui is predefined. value: type: string description: The MAC octets. mac_type: $ref: '#/components/schemas/XiqMacObjectType' description: The MAC object type e.g, "MAC_OUI", "MAC_RANGE" or "MAC_ADDRESS". defender_defined: type: boolean description: Whether defender is defined. mac_address_end: type: string description: The MAC address end, only available for "MAC_RANGE" type. XiqMacFirewallRule: allOf: - $ref: '#/components/schemas/XiqViqEntity' - type: object description: Mac Firewall Rule properties: action: $ref: '#/components/schemas/XiqMacFirewallAction' description: The Mac Firewall Action. source_mac: $ref: '#/components/schemas/XiqMacObject' description: The Source MAC address. destination_mac: $ref: '#/components/schemas/XiqMacObject' description: The Destination MAC address. logging_type: $ref: '#/components/schemas/XiqLoggingType' description: The logging Type for MAC Firewall Rule. XiqMacFirewall: allOf: - $ref: '#/components/schemas/XiqViqEntity' - type: object description: MAC Firewall policy. properties: name: type: string description: The MAC Firewall policy name description: type: string description: The MAC Firewall policy description. rules: type: array description: List of MAC Firewall Rules items: $ref: '#/components/schemas/XiqMacFirewallRule' predefined: type: boolean description: Flag to describe whether the application is predefined or customised. PagedMacFirewall: allOf: - $ref: '#/components/schemas/XiqPage' - type: object properties: data: type: array description: The data in the current page items: $ref: '#/components/schemas/XiqMacFirewall' XiqMacFirewallRuleRequest: type: object properties: action: $ref: '#/components/schemas/XiqMacFirewallAction' description: The MAC Firewall Action. source_mac: type: integer description: Source MAC address for MAC Firewall Rule. format: int64 destination_mac: type: integer description: Destination MAC address for MAC Firewall Rule. format: int64 logging_type: $ref: '#/components/schemas/XiqLoggingType' description: The logging Type for MAC Firewall Rule. XiqMacFirewallPolicyRequest: type: object required: - name - description - rules properties: name: type: string description: The MAC Firewall policy name. description: type: string description: The MAC Firewall policy description. rules: type: array description: List of MAC Firewall Rules items: $ref: '#/components/schemas/XiqMacFirewallRuleRequest' PagedXiqMacObject: allOf: - $ref: '#/components/schemas/XiqPage' - type: object properties: data: type: array description: The data in the current page. items: $ref: '#/components/schemas/XiqMacObject' XiqCreateMacObjectRequest: type: object required: - name - value - mac_type properties: name: type: string description: The product model. description: type: string description: The product description. value: type: string description: The MAC octets. mac_type: $ref: '#/components/schemas/XiqMacObjectType' description: The type e.g, "MAC_OUI", "MAC_RANGE" or "MAC_ADDRESS". mac_address_end: type: string description: The MAC address end, only available for "MAC_RANGE" type. 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. XiqAttachMacFirewallRuleToMacFirewallPolicy: type: object properties: source_mac: type: integer format: int64 description: The Source MAC address ID. destination_mac: type: integer format: int64 description: The Destination MAC address ID. action: $ref: '#/components/schemas/XiqMacFirewallAction' description: The MAC Firewall Action. logging_type: $ref: '#/components/schemas/XiqLoggingType' description: The logging Type for MAC Firewall Rule. XiqMacFirewallRuleId: type: object required: - mac_firewall_rule_id properties: mac_firewall_rule_id: type: integer format: int64 description: The MAC Firewall Rule ID. XiqRadioMode: type: string description: The supported radio modes. enum: - B_G - G_N - A - A_N - AC - AX_2_4_GHZ - AX_5_GHZ - AX_6_GHZ - BE_2_4_GHZ - BE_5_GHZ - BE_6_GHZ XiqRadioProfile: allOf: - $ref: '#/components/schemas/XiqBaseEntity' - type: object description: The payload of Radio Profile properties: name: type: string description: The radio profile name predefined: type: boolean description: Whether the radio profile is predefined or user-customized. description: type: string description: The radio profile description. transmission_power: type: integer description: The transmission power floor from 1 up to 20 dBm or null for Auto. format: int32 max_transmit_power: type: integer description: The maximum transmit power from 10 up to 20 dBm. format: int32 transmission_power_floor: type: integer description: The transmission power floor from 2 up to 20 dBm. format: int32 transmission_power_max_drop: type: integer description: The transmission power max drop from 0 up to 18 dB. format: int32 max_clients: type: integer description: The maximum number of clients from 1 up to 255. format: int32 enable_client_transmission_power: type: boolean description: Whether or not client transmission power control (802.11h) is enabled. client_transmission_power: type: integer description: The client transmission power from 1 up to 20 dBm if it is enabled. format: int32 enable_ofdma: type: boolean description: Whether to enable Orthogonal Frequency Division Multiple Access (802.11ax) for multiple-user access by subdividing a channel. radio_mode: $ref: '#/components/schemas/XiqRadioMode' neighborhood_analysis_id: type: integer description: The neighborhood analysis Id. format: int64 channel_selection_id: type: integer description: The channel selection Id. format: int64 radio_usage_optimization_id: type: integer description: The radio usage optimization Id. format: int64 miscellaneous_settings_id: type: integer description: The miscellaneous settings Id format: int64 presence_server_settings_id: type: integer description: The presence server settings Id. format: int64 sensor_scan_settings_id: type: integer description: The sensor scan settings Id. format: int64 PagedXiqRadioProfile: allOf: - $ref: '#/components/schemas/XiqPage' - type: object properties: data: type: array description: The data in the current page items: $ref: '#/components/schemas/XiqRadioProfile' XiqCreateRadioProfileRequest: type: object required: - name properties: name: type: string description: The radio profile name description: type: string description: The radio profile description. transmission_power: maximum: 20 minimum: 1 type: integer description: The transmission power floor in the range of 1-20 dBm or null for Auto. format: int32 max_transmit_power: maximum: 20 minimum: 10 type: integer description: The maximum transmit power in the range of 10-20 dBm. format: int32 transmission_power_floor: maximum: 20 minimum: 2 type: integer description: The transmission power floor in the range of 2-20 dBm. format: int32 transmission_power_max_drop: maximum: 18 minimum: 0 type: integer description: The transmission power max drop in the range of 0-18 dB. format: int32 max_clients: maximum: 255 minimum: 1 type: integer description: The maximum number of clients in the range of 1-255. format: int32 enable_client_transmission_power: type: boolean description: Whether or not client transmission power control (802.11h) is enabled. client_transmission_power: maximum: 20 minimum: 1 type: integer description: The client transmission power (in the range of 1-20 dBm) if it is enabled. format: int32 radio_mode: $ref: '#/components/schemas/XiqRadioMode' enable_ofdma: type: boolean description: Whether to enable Orthogonal Frequency Division Multiple Access (802.11ax) for multiple-user access by subdividing a channel. XiqUpdateRadioProfileRequest: type: object properties: name: type: string description: The radio profile name description: type: string description: The radio profile description. transmission_power: maximum: 20 minimum: 1 type: integer description: The transmission power floor in the range of 1-20 dBm or null for Auto. format: int32 max_transmit_power: maximum: 20 minimum: 10 type: integer description: The maximum transmit power in the range of 10-20 dBm. format: int32 transmission_power_floor: maximum: 20 minimum: 2 type: integer description: The transmission power floor in the range of 2-20 dBm. format: int32 transmission_power_max_drop: maximum: 18 minimum: 0 type: integer description: The transmission power max drop in the range of 0-18 dB. format: int32 max_clients: maximum: 255 minimum: 1 type: integer description: The maximum number of clients in the range of 1-255. format: int32 enable_client_transmission_power: type: boolean description: Whether or not client transmission power control (802.11h) is enabled. client_transmission_power: maximum: 20 minimum: 1 type: integer description: The client transmission power (in the range of 1-20 dBm) if it is enabled. format: int32 radio_mode: $ref: '#/components/schemas/XiqRadioMode' enable_ofdma: type: boolean description: Whether to enable Orthogonal Frequency Division Multiple Access (802.11ax) for multiple-user access by subdividing a channel. XiqRpChannelSelection: allOf: - $ref: '#/components/schemas/XiqBaseEntity' - type: object description: The payload of channel selection for the radio profile properties: enable_dynamic_channel_switching: type: boolean description: Whether to dynamically select and switch channels based on the defined criteria. channel_width: type: string description: The channel frequency range enable_dynamic_frequency_selection: type: boolean description: Whether dynamic frequency selection is enabled (a/n, a, ac mode) enable_static_channel: type: boolean description: Whether static channel is enabled (manual channel selection return) enable_zero_wait_dfs: type: boolean description: Whether ZeroWait DFS is enabled enable_use_last_selection: type: boolean description: Whether to use the last known power and channel during the AP boot up process exclude_channels: type: string description: The comma-separated list of excluded channels not on the selected channel width. exclude_channels_width: type: string description: The comma-separated list of excluded channels on the selected channel width. channel: type: integer description: The number of channel selections from 1 up to 165 or AUTO for default selection. format: int32 enable_limit_channel_selection: type: boolean description: Whether to allow for limiting the channel selection to non-overlapping channels. (b/g,g/n/, axes modes) channel_region: type: string description: The channel region -- "USA", "Canada", "Europe", or "World" channel_model: maximum: 4 minimum: 3 type: integer description: The number of channel models to limit. format: int32 channels: type: string description: The comma separated list of channels allowed channel switching enable_channel_auto_selection: type: boolean description: Whether to enable automatic channel switching during specified time interval. channel_selection_start_time: type: string description: The start time for channel switching in 24-hr time format of hh:mm channel_selection_end_time: type: string description: The end time for channel switching in 24-hr time format of hh:mm enable_avoid_switch_channel_if_clients_connected: type: boolean description: Whether to avoid channel switching if there are already max connected clients channel_selection_max_clients: type: integer description: The maximum number of connected clients from 0 up to 100 to avoid switching format: int32 enable_switch_channel_if_exceed_threshold: type: boolean description: Whether to enable channel switching when RF interference exceeds the threshold rf_interference_threshold: type: integer description: The RF interference threshold from 10 up to 80 for channel switching. format: int32 crc_error_threshold: type: integer description: The CRC error threshold from 10 up to 80 for channel switching. format: int32 XiqUpdateRpChannelSelectionRequest: type: object properties: enable_dynamic_channel_switching: type: boolean description: Whether to dynamically select and switch channels based on the defined criteria. channel_width: type: string description: The channel frequency range enable_dynamic_frequency_selection: type: boolean description: Whether dynamic frequency selection is enabled (a/n, a, ac mode) enable_static_channel: type: boolean description: Whether static channel is enabled (manual channel selection return) enable_zero_wait_dfs: type: boolean description: Whether ZeroWait DFS is enabled enable_use_last_selection: type: boolean description: Whether to use the last known power and channel during the AP boot up process exclude_channels: type: string description: The comma-separated list of excluded channels not on the selected channel width. exclude_channels_width: type: string description: The comma-separated list of excluded channels on the selected channel width. channel: maximum: 165 minimum: 1 type: integer description: The number of channel selections or AUTO for default selection. format: int32 enable_limit_channel_selection: type: boolean description: Whether to allow for limiting the channel selection to non-overlapping channels. (b/g,g/n/, axes modes) channel_region: type: string description: The channel region -- "USA", "Canada", "Europe", or "World" channel_model: maximum: 4 minimum: 3 type: integer description: The number of channel models to limit. format: int32 channels: type: string description: The comma separated list of channels allowed channel switching enable_channel_auto_selection: type: boolean description: Whether to enable automatic channel switching during specified time interval. channel_selection_start_time: type: string description: The start time for channel switching in 24-hr time format of hh:mm channel_selection_end_time: type: string description: The end time for channel switching in 24-hr time format of hh:mm enable_avoid_switch_channel_if_clients_connected: type: boolean description: Whether to avoid channel switching if there are already max connected clients channel_selection_max_clients: maximum: 100 minimum: 0 type: integer description: The maximum number of connected clients to avoid switching format: int32 enable_switch_channel_if_exceed_threshold: type: boolean description: Whether to enable channel switching when RF interference exceeds the threshold rf_interference_threshold: maximum: 80 minimum: 10 type: integer description: The RF interference threshold for channel switching. format: int32 crc_error_threshold: maximum: 80 minimum: 10 type: integer description: The CRC error threshold for channel switching. format: int32 XiqRpMacOuiProfile: allOf: - $ref: '#/components/schemas/XiqBaseEntity' - type: object description: The MAC OUI profile for radio profile properties: name: type: string description: The product model description: type: string description: The product description predefined: type: boolean description: Whether the MAC Oui is predefined. value: type: string description: The MAC octets mac_type: type: string description: The type or "MAC_OUI" defender_defined: type: boolean description: Whether defender is defined extreme_iot_defined: type: boolean description: Whether is the Extreme Iot Defined PagedXiqRpMacOuiProfile: allOf: - $ref: '#/components/schemas/XiqPage' - type: object properties: data: type: array description: The data in the current page items: $ref: '#/components/schemas/XiqRpMacOuiProfile' XiqCreateRpMacOuiProfileRequest: type: object required: - name - value properties: name: type: string description: The product name value: type: string description: The product MAC or OUI description: type: string description: The product description mac_type: type: string description: The json type, eg, "mac-oui-profile" or "MAC_OUI" defender_defined: type: boolean description: Whether defender is defined 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 XiqRpWmmQosSettings: allOf: - $ref: '#/components/schemas/XiqBaseEntity' - type: object description: The WMM QoS settings for the radio profile properties: access_category: type: string description: The media categories, including "VOICE", "VIDEO", "BEST_EFFORT", and "BACKGROUND" arbitration_interframe_space: type: integer description: The Arbitration Interframe space from 1 up to 15. format: int32 min_contention_window: type: integer description: The Minimum Contention window from 1 up to 15. format: int32 max_contention_window: type: integer description: The Maximum Contention window from 1 up to 15. format: int32 transmission_opportunity_limit: type: integer description: The Transmission Opportunity limit from 0 up to 8192. format: int32 enable_no_ack: type: boolean description: Whether to enable No Acknowledgment XiqRpMiscellaneousSettings: allOf: - $ref: '#/components/schemas/XiqBaseEntity' - type: object description: The Miscellaneous settings for radio profile properties: sla_throughput_level: type: string description: The Client SLA options -- "NORMAL_DENSITY", "HIGH_DENSITY" (performance-oriented), or "LOW_DENSITY" (coverage-oriented) radio_range: type: integer description: The Outdoor Deployment for signal distance from 300 to 10000 meters format: int32 wmm_qos_settings: type: array description: The WMM QoS settings for various media types items: $ref: '#/components/schemas/XiqRpWmmQosSettings' XiqUpdateRpMiscellaneousSettingsRequest: type: object properties: sla_throughput_level: type: string description: The Client SLA options -- "NORMAL_DENSITY", "HIGH_DENSITY" (performance-oriented), or "LOW_DENSITY" (coverage-oriented) radio_range: maximum: 10000 minimum: 300 type: integer description: The Outdoor Deployment for signal distance from 300 to 10000 meters format: int32 XiqRpNeighborhoodAnalysis: allOf: - $ref: '#/components/schemas/XiqBaseEntity' - type: object description: The neighborhood analysis config for the radio profile properties: enable_background_scan: type: boolean description: Whether to enable background scanning of neighboring devices background_scan_interval: type: integer description: The background scan interval from 1 up to 1440 minutes format: int32 enable_skip_scan_when_clients_connected: type: boolean description: Whether to enable skipping of background scan when devices have client connections enable_skip_scan_when_clients_in_power_save_mode: type: boolean description: Whether to skipping of background scan when connected devices are in power save mode enable_skip_scan_when_process_voice_traffic: type: boolean description: Whether to enable skipping of background scan when devices have network traffic with voice priority XiqUpdateRpNeighborhoodAnalysisRequest: type: object properties: enable_background_scan: type: boolean description: Whether background scan of neighboring devices is enabled background_scan_interval: maximum: 1440 minimum: 1 type: integer description: The background scan interval in the range of 1 to 1440 minutes format: int32 enable_skip_scan_when_clients_connected: type: boolean description: Whether to skip background scan when devices have client connections enable_skip_scan_when_clients_in_power_save_mode: type: boolean description: Whether to skip background scan when connected devices are in power save mode enable_skip_scan_when_process_voice_traffic: type: boolean description: Whether to skip background scan when devices have network traffic with voice priority XiqRpRadioUsageOptimization: allOf: - $ref: '#/components/schemas/XiqBaseEntity' - type: object description: The radio usage optimization config for the radio profile properties: preamble: type: string description: The preamble data length -- "AUTO" or "LONG" beacon_period: type: integer description: The amount of time between beacons from 40 up to 3500. format: int32 enable_frame_burst: type: boolean description: Whether to enable Frame Burst enable_smart_antenna: type: boolean description: Whether to enable Smart Antenna (Enabling this option will disable (Null) for MU-MIMO) enable_backhaul_failover: type: boolean description: Whether to enable backhaul failover. Backhaul failover settings determine the thresholds at which the device switches from a wired to a wireless backhaul link, and the thresholds at which the device switches back wireless_backhaul_switch_trigger_time: type: integer description: Switch to Wireless Backhaul after 1 up to 5 seconds after the wired link fails format: int32 wired_backhaul_revert_hold_time: type: integer description: Revert Back to Wired Backhaul after 1 up to 300 seconds after the wired link is established format: int32 enable_band_steering: type: boolean description: Whether to enable band steering. Enabling steers clients from 2.4 GHz to 5.0 GHz radio band band_steering_mode: type: string description: The band steering mode -- "BALANCE", "URGE_5G", or "ENFORCE_5G" ignore_initial_client_connection_number: type: integer description: The number of connection attempts from 1 to 100 for 2.4 GHz clients to ignore before responding for URGE_5G steering mode. format: int32 enable_client_load_balancing: type: boolean description: Whether to enable client load balancing. Enabling load-balances clients across neighboring Extreme Networks within the same hive. Set WiFi0 and WiFi1 radios to the same load balancing mode when it is based on the number of associated stations. load_balancing_mode: type: string description: The client load balancing mode -- "AIRTIME_BASED" or "CLIENT_NUMBER" crc_error_rate_per_device: type: integer description: The CRC Error rate threshold from 1 up to 99 for "AIRTIME_BASED" load balancing. Ignore probe and association requests per device when CRC Error rate exceeds the threshold. format: int32 rf_interference_per_device: type: integer description: The RF Interference threshold from 1 up to 99 for "AIRTIME_BASED" load balancing. Ignore probe and association requests per device when RF Interference exceeds the threshold. format: int32 average_airtime_per_client: type: integer description: The Average Airtime Per Client threshold from 1 up to 5 for "AIRTIME_BASED" load balancing. Ignore probe and association requests per device when Average Airtime Per Client exceeds the threshold. format: int32 anchor_period: type: integer description: The Anchor Period from 10 up to 600 for both "AIRTIME_BASED" and "CLIENT_NUMBER" load balancing. Ignore probe and association requests from clients associated with other Extreme Networks devices until Anchor Period Eelapses in the range of 10 to 600 seconds format: int32 neighbor_query_interval: type: integer description: In both client load balancing modes, query neighbors about client load every 1 up to 600 seconds format: int32 enable_weak_signal_probe_request_suppression: type: boolean description: Whether to enable Weak Signal Probe Request Suppression. Weak Signal Probe Request Suppression allows the configuration of signal-to-noise threshold beyond which the device does not respond to client probes. weak_snr_threshold: type: integer description: The signal to noise threshold from 1 up to 100 for Weak Signal Probe Request Suppression. format: int32 enable_safety_net: type: boolean description: Whether to enable Safety Net. When a device is overloaded or is probed by clients with a low signal-to-noise ratio, Safety Net allows the device to respond to association requests after a certain time period lapses. safety_net_period: type: integer description: The Safety Net Time Period from 5 up to 300 seconds. format: int32 enable_high_density: type: boolean description: Whether to enable High Density Configuration. Enabling optimizes performance in high density environments management_frame_basic_data_rate: type: string description: The data rates to support in high density environment -- "HIGH" or "LOW" enable_suppress_successive_probe_request: type: boolean description: Whether to Reduce Response to Probe Requests. Enabling suppresses successive requests within the same beacon interval probe_response_reduction_option: type: string description: The suppress response to broadcast probes options -- "ONLY_ONE_SSID_RESPOND_AT_A_TIME" (allowed for only one SSID to respond at a time), "REDUCE_CERTAIN_CLIENTS_RESPONSE" (reducing responses to certain client devices). suppression_limit: type: integer description: The Number of Connection Attempts from 1 up to 10 format: int32 enable_radio_balance: type: boolean description: Whether to enable Radio Load Balancing. Enabling distributes wireless clients that support 5 GHz band evenly across the two radios in Dual-5G mode when an SSID is available on both radios enable_ampdu: type: boolean description: Enable Aggregate MAC Protocol Data Units to combine data frames into larger frames before transmission. enable_mu_mimo: type: boolean description: Whether to enable Multiple-Input Multiple-Output (802.11ac & 802.11ax) for multiple-user access by using different spatial streams. enable_ofdma_down_link: type: boolean description: Whether to enable OFDMA for AP downlink communication. enable_ofdma_up_link: type: boolean description: Whether to enable OFDMA for AP uplink communication. bss_coloring: type: integer description: Whether to enable BSS Coloring (802.11ax ) to identify overlapping basic service sets (OBSSs). format: int32 enable_target_weak_time: type: boolean description: Whether to enable Target Weak Time. mac_ouis: type: array description: The device vendor identifiers for the "REDUCE_CERTAIN_CLIENTS_RESPONSE" for the probe response reduction option items: $ref: '#/components/schemas/XiqRpMacOuiProfile' ratio_for_5g_clients: type: integer description: The percentage distribution from 1 up to 100 for 2.4 and 5.0 GHz clients for "BALANCE" steering mode. format: int32 XiqUpdateRpRadioUsageOptimizationRequest: type: object properties: preamble: type: string description: The preamble data length -- "AUTO" or "LONG" beacon_period: maximum: 3500 minimum: 40 type: integer description: The amount of time between beacons in the range from 40 to 3500. format: int32 enable_frame_burst: type: boolean description: Whether to enable Frame Burst enable_smart_antenna: type: boolean description: Whether to enable Smart Antenna (Enabling this option will disable (Null) for MU-MIMO) enable_backhaul_failover: type: boolean description: Whether to enable backhaul failover. Backhaul failover settings determine the thresholds at which the device switches from a wired to a wireless backhaul link, and the thresholds at which the device switches back wireless_backhaul_switch_trigger_time: maximum: 5 minimum: 1 type: integer description: Switch to Wireless Backhaul after the number of seconds (1 to 5) after the wired link fails format: int32 wired_backhaul_revert_hold_time: maximum: 300 minimum: 1 type: integer description: Revert Back to Wired Backhaul after the number of seconds (1 to 300) after the wired link is established format: int32 enable_band_steering: type: boolean description: Whether to enable band steering. Enabling steers clients from 2.4 GHz to 5.0 GHz radio band band_steering_mode: type: string description: The band steering mode -- "BALANCE", "URGE_5G", or "ENFORCE_5G" ratio_for5g_clients: maximum: 100 minimum: 1 type: integer description: The allowed percentage distribution of 2.4 and 5.0 GHz clients for "BALANCE" steering mode. format: int32 ignore_initial_client_connection_number: maximum: 100 minimum: 1 type: integer description: The number of connection attempts from 2.4 GHz clients to ignore before responding for URGE_5G steering mode. format: int32 enable_client_load_balancing: type: boolean description: Whether to enable client load balancing. Enabling load-balances clients across neighboring Extreme Networks within the same hive. Set WiFi0 and WiFi1 radios to the same load balancing mode when it is based on the number of associated stations. load_balancing_mode: type: string description: The client load balancing mode -- "AIRTIME_BASED" or "CLIENT_NUMBER" crc_error_rate_per_device: maximum: 99 minimum: 1 type: integer description: The CRC Error rate threshold value for "AIRTIME_BASED" load balancing. Ignore probe and association requests per device when CRC Error rate exceeds the threshold. format: int32 rf_interference_per_device: maximum: 99 minimum: 1 type: integer description: The RF Interference threshold value for "AIRTIME_BASED" load balancing. Ignore probe and association requests per device when RF Interference exceeds the threshold. format: int32 average_airtime_per_client: maximum: 5 minimum: 1 type: integer description: The Average Airtime Per Client threshold value for "AIRTIME_BASED" load balancing. Ignore probe and association requests per device when Average Airtime Per Client exceeds the threshold. format: int32 anchor_period: maximum: 600 minimum: 10 type: integer description: The Anchor Period value for both "AIRTIME_BASED" and "CLIENT_NUMBER" load balancing. Ignore probe and association requests from clients associated with other Extreme Networks devices until Anchor Period Eelapses in the range of 10 to 600 seconds format: int32 neighbor_query_interval: maximum: 600 minimum: 1 type: integer description: In both client load balancing modes, query neighbors about client load every in the range of 1 to 600 seconds format: int32 enable_weak_signal_probe_request_suppression: type: boolean description: Whether to enable Weak Signal Probe Request Suppression. Weak Signal Probe Request Suppression allows the configuration of signal-to-noise threshold beyond which the device does not respond to client probes. weak_snr_threshold: maximum: 100 minimum: 1 type: integer description: The signal to noise threshold in the range of 1 to 100 for Weak Signal Probe Request Suppression. format: int32 enable_safety_net: type: boolean description: Whether to enable Safety Net. When a device is overloaded or is probed by clients with a low signal-to-noise ratio, Safety Net allows the device to respond to association requests after a certain time period lapses. safety_net_period: maximum: 300 minimum: 5 type: integer description: The Safety Net Time Period in the range of 5 to 300 seconds. format: int32 enable_high_density: type: boolean description: Whether to enable High Density Configuration. Enabling optimizes performance in high density environments management_frame_basic_data_rate: type: string description: The data rates to support in high density environment -- "HIGH" or "LOW" enable_suppress_successive_probe_request: type: boolean description: Whether to Reduce Response to Probe Requests. Enabling suppresses successive requests within the same beacon interval probe_response_reduction_option: type: string description: The suppress response to broadcast probes options -- "ONLY_ONE_SSID_RESPOND_AT_A_TIME" (allowed for only one SSID to respond at a time), "REDUCE_CERTAIN_CLIENTS_RESPONSE" (reducing responses to certain client devices). suppression_limit: maximum: 10 minimum: 1 type: integer description: The Number of Connection Attempts in the range of 1 to 10 format: int32 enable_radio_balance: type: boolean description: Whether to enable Radio Load Balancing. Enabling distributes wireless clients that support 5 GHz band evenly across the two radios in Dual-5G mode when an SSID is available on both radios mac_oui_ids: type: array description: The MacOui Profile IDs for the "REDUCE_CERTAIN_CLIENTS_RESPONSE" probe response reduction option items: type: integer description: The MacOui Profile IDs for the "REDUCE_CERTAIN_CLIENTS_RESPONSE" probe response reduction option format: int64 enable_ampdu: type: boolean description: Enable Aggregate MAC Protocol Data Units to combine data frames into larger frames before transmission. enable_mu_mimo: type: boolean description: Whether to enable Multiple-Input Multiple-Output (802.11ac & 802.11ax) for multiple-user access by using different spatial streams. enable_ofdma_down_link: type: boolean description: Whether to enable OFDMA for AP downlink communication. enable_ofdma_up_link: type: boolean description: Whether to enable OFDMA for AP uplink communication. bss_coloring: maximum: 63 minimum: 1 type: integer description: The numerical identifier of the basic service sets (802.11ax ) to identify overlapping basic service sets (OBSSs). format: int32 enable_target_weak_time: type: boolean description: Whether to enable Target Weak Time. XiqRpSensorScanSettings: allOf: - $ref: '#/components/schemas/XiqBaseEntity' - type: object description: The sensor scan settings for the radio profile properties: enable_scan_all_channels: type: boolean description: Whether to enable scanning all channels dwell_time: type: string description: The dwell time in ms scan_channels: type: string description: The comma separated list of scan channels 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 XiqUpdateRpWmmQosSettingsRequest: type: object properties: arbitration_interframe_space: maximum: 15 minimum: 1 type: integer description: The Arbitration Interframe space, in the range of 1 to 15. format: int32 min_contention_window: maximum: 15 minimum: 1 type: integer description: The Minimum Contention window, in the range of 1 to 15. format: int32 max_contention_window: maximum: 15 minimum: 1 type: integer description: The Maximum Contention window, in the range of 1 to 15. format: int32 transmission_opportunity_limit: maximum: 8192 minimum: 0 type: integer description: The Transmission Opportunity limit, in the range of 0 to 8192. format: int32 enable_no_ack: type: boolean description: Whether to enable No Acknowledgment XiqUserProfile: allOf: - $ref: '#/components/schemas/XiqBaseEntity' - type: object description: The payload of User Profile required: - name properties: name: type: string description: The user profile name vlan_profile: $ref: '#/components/schemas/XiqVlanProfile' enable_firewall: type: boolean description: Flag to enable Firewall. inbound_mac_firewall: $ref: '#/components/schemas/XiqMacFirewall' description: The Inbound MAC Firewall policy. outbound_mac_firewall: $ref: '#/components/schemas/XiqMacFirewall' description: The Outbound MAC Firewall policy. mac_firewall_default_action: $ref: '#/components/schemas/XiqMacFirewallAction' description: The MAC Firewall Default action. inbound_ip_firewall: $ref: '#/components/schemas/XiqIpFirewall' description: The Inbound IP Firewall policy. outbound_ip_firewall: $ref: '#/components/schemas/XiqIpFirewall' description: The Outbound IP Firewall policy. ip_firewall_default_action: $ref: '#/components/schemas/XiqIpFirewallAction' description: The IP Firewall Default action. PagedXiqUserProfile: allOf: - $ref: '#/components/schemas/XiqPage' - type: object properties: data: type: array description: The data in the current page items: $ref: '#/components/schemas/XiqUserProfile' XiqCreateUserProfileRequest: type: object required: - name - vlan_profile_id properties: name: type: string description: The user profile name vlan_profile_id: type: integer description: The VLAN profile id format: int64 XiqUpdateUserProfileRequest: type: object properties: name: type: string description: The user profile name vlan_profile_id: type: integer description: The VLAN profile id format: int64 XiqAttributeType: type: string enum: - TUNNEL - STANDARD - CUSTOM XiqUserProfileAssignmentRadiusAttribute: allOf: - type: object description: User Profile Assignment Radius Attribute properties: attribute_type: $ref: '#/components/schemas/XiqAttributeType' description: The Attribute type name attribute_values: type: string description: The Attribute type value XiqOsObject: allOf: - type: object description: The OS object. properties: id: type: integer description: The unique identifier format: int64 name: type: string description: The OS object name. XiqScheduleType: type: string enum: - ONE_TIME - RECURRING description: The schedule type. XiqRecurrenceType: type: string enum: - EVERYDAY - WEEKDAY_RANGE description: The schedule recurrence type. XiqWeekDay: type: string enum: - MONDAY - TUESDAY - WEDNESDAY - THURSDAY - FRIDAY - SATURDAY - SUNDAY XiqSchedule: allOf: - type: object description: The schedule. properties: description: type: string description: The schedule description. schedule_type: $ref: '#/components/schemas/XiqScheduleType' description: The schedule type name. start_date: type: string format: date description: The start date. end_date: type: string format: date description: The end date. start_time: type: string description: The start time. end_time: type: string description: The end time. recurrence_type: $ref: '#/components/schemas/XiqRecurrenceType' description: The recurrence type. weekday_from: $ref: '#/components/schemas/XiqWeekDay' description: The weekday from value. weekday_to: $ref: '#/components/schemas/XiqWeekDay' description: The weekday to value. start_time_2: type: string description: The second start time. end_time_2: type: string description: The second end time. XiqUserProfileAssignment: allOf: - $ref: '#/components/schemas/XiqViqEntity' - type: object description: The User Profile Assignment properties: name: type: string description: The User Profile Assignment description: type: string description: The User Profile Assignment description authorisation_policy: type: string description: The Authorization policy name. folder_ids: type: array description: The location folder Id list. items: type: integer format: int64 description: The location ID. assignment_radius_attribute: $ref: '#/components/schemas/XiqUserProfileAssignmentRadiusAttribute' description: The User Profile Assignment Radius Attribute. user_groups: type: array uniqueItems: true description: The set of User groups. items: $ref: '#/components/schemas/XiqUserGroup' mac_object_profiles: type: array uniqueItems: true description: The set of Mac object profiles. items: $ref: '#/components/schemas/XiqMacObject' os_object_dhcp: type: array uniqueItems: true description: The set of OS DHCP objects. items: $ref: '#/components/schemas/XiqOsObject' os_object_https: type: array uniqueItems: true description: The set of OS HTTP objects. items: $ref: '#/components/schemas/XiqOsObject' schedules: type: array uniqueItems: true description: The set of schedules. items: $ref: '#/components/schemas/XiqSchedule' PagedXiqUserProfileAssignment: allOf: - $ref: '#/components/schemas/XiqPage' - type: object properties: data: type: array description: The data in the current page. items: $ref: '#/components/schemas/XiqUserProfileAssignment' XiqCreateUserProfileAssignmentRequest: type: object properties: name: type: string description: The User Profile Assignment description: type: string description: The User Profile Assignment description folder_ids: type: array description: The location folder Id list. items: type: integer format: int64 description: The location ID. assignment_radius_attribute: $ref: '#/components/schemas/XiqUserProfileAssignmentRadiusAttribute' description: The User Profile Assignment Radius Attribute. XiqTraffic: type: string enum: - INBOUND - OUTBOUND description: The Firewall traffic direction. XiqAttachIpFirewallRequest: type: object required: - policy_id - traffic properties: policy_id: type: integer format: int64 description: The IP Firewall policy ID traffic: $ref: '#/components/schemas/XiqTraffic' description: The IP Firewall traffic direction. XiqDetachIpFirewallRequest: type: object required: - policy_id properties: policy_id: type: integer format: int64 description: The IP Firewall policy ID traffic: $ref: '#/components/schemas/XiqTraffic' description: The IP Firewall traffic direction. XiqAttachMacFirewallRequest: type: object required: - policy_id - traffic properties: policy_id: type: integer format: int64 description: The MAC Firewall policy ID traffic: $ref: '#/components/schemas/XiqTraffic' description: The MAC Firewall traffic direction. XiqDetachMacFirewallRequest: type: object required: - policy_id properties: policy_id: type: integer format: int64 description: The MAC Firewall policy ID traffic: $ref: '#/components/schemas/XiqTraffic' description: The MAC Firewall traffic direction. XiqHsLanguageCode: type: string description: 'Language code (3B abbreviation) found at: http://www.loc.gov/standards/iso639-2/ISO-639-2_utf-8.txt.' default: eng pattern: ^[a-z]{3}$ XiqHsLocalizedName: type: object description: A language specific name. required: - name properties: name: type: string description: Up to 252 byte UTF-8 string. minLength: 1 maxLength: 252 language: $ref: '#/components/schemas/XiqHsLanguageCode' XiqHsVenueGroup: type: string description: The venue group ID categorizes the general type of location. enum: - UNSPECIFIED - ASSEMBLY - BUSINESS - EDUCATIONAL - FACTORY_AND_INDUSTRIAL - INSTITUTIONAL - MERCANTILE - RESIDENTIAL - STORAGE - UTILITY_AND_MISCELLANEOUS - VEHICULAR - OUTDOOR default: UNSPECIFIED XiqHsVenueType: type: string description: The venue type ID further specifies the particular kind of location within the general venue group. Each venue type ID must match the venue group ID to accurately describe the venue information. enum: - UNSPECIFIED - ARENA - STADIUM - PASSENGER_TERMINAL - AMPHITHEATRE - AMUSEMENT_PARK - PLACE_OF_WORSHIP - CONVENTION_CENTRE - LIBRARY - MUSEUM - RESTAURANT - THEATRE - BAR - COFFEE_SHOP - ZOO_OR_AQUARIUM - EMERGENCY_COORDINATION_CENTRE - DOCTOR_OR_DENTIST_OFFICE - BANK - FIRE_STATION - POLICE_STATION - POST_OFFICE - PROFESSIONAL_OFFICE - RESEARCH_AND_DEVELOPMENT_FACILITY - ATTORNEY_OFFICE - SCHOOL_PRIMARY - SCHOOL_SECONDARY - UNIVERSITY_OR_COLLEGE - FACTORY - HOSPITAL - LONG_TERM_CARE_FACILITY - ALCOHOL_AND_DRUG_REHABILITATION_CENTRE - GROUP_HOME - PRISON_OR_JAIL - RETAIL_STORE - GROCERY_MARKET - AUTOMOTIVE_SERVICE_STATION - SHOPPING_MALL - GAS_STATION - PRIVATE_RESIDENCE - HOTEL_OR_MOTEL - DORMITORY - BOARDING_HOUSE - AUTOMOBILE_OR_TRUCK - AIRPLANE - BUS - FERRY - SHIP_OR_BOAT - TRAIN - MOTOR_BIKE - MUNI-MESH_NETWORK - CITY_PARK - REST_AREA - TRAFFIC_CONTROL - BUS_STOP - KIOSK default: UNSPECIFIED XiqHsVenue: type: object description: Venue information helps client devices understand the type and nature of the location where the Wi-Fi network is deployed. properties: venue_group: $ref: '#/components/schemas/XiqHsVenueGroup' venue_type: $ref: '#/components/schemas/XiqHsVenueType' names: type: array description: Localized names for the venue. items: $ref: '#/components/schemas/XiqHsLocalizedName' XiqHsAccessNetworkType: type: string description: "The Hotspot profile Access Network:\n * `PRIVATE` - An enterprise network with user accounts.\n * `PRIVATE_WITH_GUEST` - An enterprise network providing guest access.\n * `CHARGEABLE_PUBLIC` - Open to anyone but access requires payment.\n * `FREE_PUBLIC` - Open network, free of charge but may still require acceptance of terms of use (and may involve OSU servers with captive portal).\n * `PERSONAL_DEVICE` - Personal device network.\n * `EMERGENCY` - Emergency services only network. \n * `TEST` - Test or experimental network.\n * `WILDCARD` - Wildcard network." default: CHARGEABLE_PUBLIC enum: - PRIVATE - PRIVATE_WITH_GUEST - CHARGEABLE_PUBLIC - FREE_PUBLIC - PERSONAL_DEVICE - EMERGENCY - TEST - WILDCARD XiqHsIpv4Type: type: string description: |- The IPv4 address availability enum: * `NOT_AVAILABLE` - No IPv4 address is available. * `PUBLIC` - A publicly routable IPv4 address is available. * `PORT_RESTRICTED` - An IPv4 address is available but with port restrictions. * `SINGLE_NAT` - A private IPv4 address behind a single NAT (Network Address Translation). * `DOUBLE_NAT` - A private IPv4 address behind a double NAT. * `PORT_RESTRICTED_SINGLE_NAT` - A private IPv4 address behind a single NAT with port restrictions. * `PORT_RESTRICTED_DOUBLE_NAT` - A private IPv4 address behind a double NAT with port restrictions. * `UNKNOWN` - The type of IPv4 address availability is unknown. default: UNKNOWN enum: - NOT_AVAILABLE - PUBLIC - PORT_RESTRICTED - SINGLE_NAT - DOUBLE_NAT - PORT_RESTRICTED_SINGLE_NAT - PORT_RESTRICTED_DOUBLE_NAT - UNKNOWN XiqHsIpv6Type: type: string description: The IPv6 address availability enum. default: UNKNOWN enum: - NOT_AVAILABLE - AVAILABLE - UNKNOWN XiqHsWanLinkStatus: type: string description: The WAN metric status. enum: - DOWN - UP - TEST XiqHsWanMetrics: type: object description: Hotspot WAN (Wide Area Network) metrics. required: - status - downlink_speed - uplink_speed properties: status: $ref: '#/components/schemas/XiqHsWanLinkStatus' downlink_speed: type: integer minimum: 0 maximum: 4194304 description: The downlink speed for the WAN network, in kbps (where 0 is unknown). uplink_speed: type: integer minimum: 0 maximum: 4194304 description: The uplink speed for the WAN network, in kbps (where 0 is unknown). XiqHsConnectionCapabilityProtocol: type: string description: Hotspot Connection Capability protocol. enum: - ESP - ICMP - TCP - UDP XiqHsConnectionCapabilityStatus: type: string description: Connection capability status. enum: - CLOSED - OPEN - UNKNOWN default: UNKNOWN XiqHsConnectionCapability: type: object description: |- The connection capability informs client devices about available network services. Used to identify the IP protocols that are permitted or denied on the network or whose permission status is unknown. required: - protocol - port_number - status properties: protocol: $ref: '#/components/schemas/XiqHsConnectionCapabilityProtocol' port_number: type: integer format: int32 minimum: 0 maximum: 65535 description: The port number. status: $ref: '#/components/schemas/XiqHsConnectionCapabilityStatus' XiqHsQosAhClassToDscpRange: type: object description: 'ah_class to DSCP range. The DSCP range for each user priority is non-overlapping. The end value for the DSCP range must be greater than or equal to the start value. ' required: - ah_class - dscp_range_start - dscp_range_end properties: ah_class: type: integer minimum: 0 maximum: 7 description: Extreme QoS class value. dscp_range_start: type: integer minimum: 0 maximum: 63 description: Start value for DSCP range. dscp_range_end: type: integer minimum: 0 maximum: 63 description: End value for DSCP range. XiqHsQosDscpException: type: object description: A DSCP priority to map to an Extreme QoS class that is different than the class mapped to the DSCP range in which the DSCP priority already exists. required: - dscp_value - ah_class properties: ah_class: type: integer minimum: 0 maximum: 7 description: Extreme QoS class value. dscp_value: type: integer minimum: 0 maximum: 63 description: Start value for DSCP range. XiqHsQosMap: type: object properties: dscp_ranges: type: array description: A map of ah-class to DSCP range. items: $ref: '#/components/schemas/XiqHsQosAhClassToDscpRange' dscp_exceptions: type: array description: The list of exceptions to the mapping of ah-class to DSCP values. maxItems: 21 items: $ref: '#/components/schemas/XiqHsQosDscpException' XiqHsOsuNetworkAuthType: type: string description: |- The Network Authentication type for Hotspot profiles: * `ACCEPTANCE_TERMS` - Indicate that the network requires the user to accept terms and conditions. * `ONLINE_SIGN_UP` - Indicate that the network supports online enrollment and that the user can obtain authentication credentials online. * `CWP` - Capital web authentication, the network infrastructure performs an HTTP/HTTPS redirect for authentication. enum: - ACCEPTANCE_TERMS - ONLINE_SIGN_UP - CWP XiqHsOnlineSignup: type: object description: The Hotspot profile Online Signup settings. required: - network_auth_type properties: network_auth_type: $ref: '#/components/schemas/XiqHsOsuNetworkAuthType' redirection_url: type: string description: The redirection URL, when the Network Authentication type is CWP. ssid_id: type: integer description: OSU SSID ID, when the Network Authentication type is ONLINE_SIGN_UP. The authentication mode must be open or OSEN. format: int64 XiqHsEapMethod: type: string description: The Extensible Authentication Protocol (EAP) method. enum: - EAP_TTLS_PAP - EAP_TTLS_CHAP - EAP_TTLS_MSCHAP - EAP_TTLS_MSCHAPV2 - EAP_TLS - EAP_SIM XiqHsNaiEncodingType: type: string description: The NAI realm encoding type. default: RFC-4282 enum: - RFC-4282 - UTF-8 XiqHsNaiRealm: type: object description: The Network Access Identification (NAI) realm. required: - name properties: name: type: string minLength: 1 maxLength: 255 description: NAI realm. description: type: string description: Description of NAI realm. eap_methods: type: array description: The list of Extensible Authentication Protocol (EAP) methods. items: $ref: '#/components/schemas/XiqHsEapMethod' encoding_type: $ref: '#/components/schemas/XiqHsNaiEncodingType' XiqHsRoamingConsortium: type: object description: The Roaming Consortium network provider. required: - consortium_id properties: consortium_id: type: string pattern: ^[0-9A-Fa-f]{6,30}$ description: IEEE-assigned Organizational Identifier (OI). description: type: string description: Description of Roaming Consortium OI. XiqHsCellularNetwork: type: object description: The 3GPP cellular network. required: - mcc - mnc properties: mcc: type: string pattern: ^\d{3}$ description: "Mobile Country Code (MCC). \nThe three-digit mobile country code as defined by the ITU (International Telecommunication Union), which indicates the country in which the user is operating.\nhttps://www.mcc-mnc.com/" mnc: type: string pattern: ^\d{2,3}$ description: "Mobile Network Code (MNC). \nhttps://www.mcc-mnc.com/" description: type: string description: Description of 3GPP cellular network. The MCC is paired with the MNC to uniquely identify a mobile subscriber's network. XiqHsspIconFile: type: object description: The OSU registration server icon according to language mode. required: - file_name - file properties: file_directory_name: type: string minLength: 1 maxLength: 32 description: The icon file name for the OSU provider. file: type: string minLength: 1 maxLength: 32 description: |- Contains the icon file (jpg, png, bmp, gif format) base64 encoded. A single icon size must be less than 64 KB. language: $ref: '#/components/schemas/XiqHsLanguageCode' XiqHsspOsuMethod: type: string description: |- OSU protocols supported by the Service Provider: * `OMA_DM` - Set OSU provider support of the OMA DM (Open Mobile Alliance Device Management) protocol. * `SOAP_XML_SPP` - Set OSU provider support of SOAP XML SPP (Simple Object Access Protocol Extensible Markup Language Subscription Provisioning Protocol). enum: - OMA_DM - SOAP_XML_SPP XiqHotspotServiceProviderProfileRequest: type: object description: The Hotspot Service Provider profile. required: - name properties: name: type: string description: The Hotspot Service Provider name. friendly_names: type: array minItems: 0 maxItems: 10 items: $ref: '#/components/schemas/XiqHsLocalizedName' descriptions: type: array minItems: 0 maxItems: 10 items: $ref: '#/components/schemas/XiqHsLocalizedName' icon_files: type: array description: The list of localized icon files for the service provider. minItems: 0 maxItems: 5 items: $ref: '#/components/schemas/XiqHsspIconFile' nai_realms: type: array description: List of Network Access Identification (NAI) realms. A NAI realm is a FQDN of a service provider. maxItems: 10 items: $ref: '#/components/schemas/XiqHsNaiRealm' roaming_consortiums: type: array description: List of Roaming Consortium identifiers. maxItems: 15 items: $ref: '#/components/schemas/XiqHsRoamingConsortium' cellular_networks: type: array description: List of 3rd Generation Partnership Project (3GPP) cellular networks. maxItems: 15 items: $ref: '#/components/schemas/XiqHsCellularNetwork' osu_uri: type: string description: |- The online signup server URI. 'Syntax available at: http://tools.ietf.org/html/rfc3986#section-1.1.2' osu_methods: type: array description: Encoded OSU methods and their priorities. Priority is given by the index/position in the array. items: $ref: '#/components/schemas/XiqHsspOsuMethod' osu_nai: type: string description: Network Access Identifier (NAI) used as client identity during EAP authentication. XiqHotspotProfileRequest: type: object description: The Hotspot profile. required: - name - domain_name properties: name: type: string description: The Hotspot profile name. hessid: type: string pattern: ^([0-9a-fA-F]{2}[:]){5}([0-9a-fA-F]{2})$ example: 00:50:56:01:AE:79 description: Homogenous Extended Service Set Identifier (HESSID) for a Hotspot 2.0 network. MAC address representation for the user interfaces. The HESSID should be different from any MU MAC. It is recommended to use one of the BSSIDs of a registered AP. domain_name: type: string description: The domain name of the entity or organization operating the IEEE 802.11 access network. minLength: 0 maxLength: 255 operator_names: type: array description: Localized names for the Hotspot operator. items: $ref: '#/components/schemas/XiqHsLocalizedName' venue: $ref: '#/components/schemas/XiqHsVenue' access_network_type: $ref: '#/components/schemas/XiqHsAccessNetworkType' dgaf: type: boolean description: Downstream Group Address Forwarding (DGAF). Forward all downlink wireless broadcast ARP and multicast packets. default: false ipv4_availability: $ref: '#/components/schemas/XiqHsIpv4Type' ipv6_availability: $ref: '#/components/schemas/XiqHsIpv6Type' wan_metrics: $ref: '#/components/schemas/XiqHsWanMetrics' connection_capabilities: type: array description: The list of connection capabilities. items: $ref: '#/components/schemas/XiqHsConnectionCapability' qos_map: $ref: '#/components/schemas/XiqHsQosMap' gas_comeback_delay: type: integer minimum: 0 maximum: 65535 default: 0 description: Generic Advertisement Service (GAS) comeback message delay time. The unit is Time Unit (TU) 1 TU = 1024 microseconds. When GAS delay is 0, there is no delay. anqp_domain_id: type: integer minimum: 0 maximum: 65535 default: 0 description: The Access Network Query protocol (ANQP) domain ID. All APs in the same ESS that share a common nonzero ANQP domain ID will have identical ANQP information. When the value is 0, the ANQP information is unique to the AP. online_signup: $ref: '#/components/schemas/XiqHsOnlineSignup' nai_realms: type: array description: List of Network Access Identification (NAI) realms. A NAI realm is a FQDN of a service provider. maxItems: 10 items: $ref: '#/components/schemas/XiqHsNaiRealm' roaming_consortiums: type: array description: List of Roaming Consortium identifiers. maxItems: 15 items: $ref: '#/components/schemas/XiqHsRoamingConsortium' cellular_networks: type: array description: List of 3rd Generation Partnership Project (3GPP) cellular networks. maxItems: 15 items: $ref: '#/components/schemas/XiqHsCellularNetwork' service_providers: type: array description: The list of supported hotspot service providers. items: $ref: '#/components/schemas/XiqHotspotServiceProviderProfileRequest' XiqHotspotProfile: allOf: - $ref: '#/components/schemas/XiqViqEntity' - $ref: '#/components/schemas/XiqHotspotProfileRequest' PagedXiqHotspotProfile: allOf: - $ref: '#/components/schemas/XiqPage' - type: object properties: data: type: array description: The data in the current page items: $ref: '#/components/schemas/XiqHotspotProfile' XiqHotspotServiceProviderProfile: allOf: - $ref: '#/components/schemas/XiqViqEntity' - $ref: '#/components/schemas/XiqHotspotServiceProviderProfileRequest' PagedXiqHotspotServiceProviderProfile: allOf: - $ref: '#/components/schemas/XiqPage' - type: object properties: data: type: array description: The data in the current page items: $ref: '#/components/schemas/XiqHotspotServiceProviderProfile' XiqSsidKeyType: type: string description: The key type, ASCII or HEX example: ASCII enum: - ASCII - HEX XiqSsidSaeGroup: type: string description: 'The SAE group: ALL, ECC, or FFC, must be selected when the key management is WPA3' enum: - ALL - ECC - FFC XiqSsidKeyManagement: type: string enum: - WPA_PSK - WPA2_PSK - WPA3_PSK - AUTO_PSK - WPA_8021X - WPA2_8021X - WPA3_8021X - AUTO_8021X - WEP - WEP_8021X XiqSsidEncryptionMethod: type: string enum: - CCMP - TKIP - AUTO_TKIP_CCMP - WEP40 - WEP104 - AES192 XiqSsidAccessSecurity: allOf: - type: object description: The Ssid Access Security. properties: key_type: $ref: '#/components/schemas/XiqSsidKeyType' description: The key type e.g, ASCII or HEX. key_value: type: string description: The schedule type name. sae_group: $ref: '#/components/schemas/XiqSsidSaeGroup' description: The SAE group. anti_logging_threshold: type: integer format: int64 description: The anti logging threshold value. transition_mode: type: boolean description: The flag for enabling transition mode. security_type: type: string description: The security type. key_management: $ref: '#/components/schemas/XiqSsidKeyManagement' description: The SSID key management value. encryption_method: $ref: '#/components/schemas/XiqSsidEncryptionMethod' description: The SSID encryption method. XiqRadiusClientProfileEntry: allOf: - type: object description: The RADIUS client profile entry. properties: classification_assignment_id: type: integer format: int64 description: The classification assignment ID for RADIUS client profile entry. radius_client_object_id: type: integer format: int64 description: The RADIUS client object ID for RADIUS client profile entry. XiqRadiusClientProfile: allOf: - type: object description: The RADIUS Client profile. properties: default_radius_client_object_id: type: integer format: int64 description: The default RADIUS client object ID. enable_classification: type: boolean description: The flag to enable classification entries on RADIUS client profile. classified_entries: description: The RADIUS client profile classified entries. type: array items: $ref: '#/components/schemas/XiqRadiusClientProfileEntry' description: The RADIUS client profile entry. XiqUserProfileAssignmentRule: allOf: - type: object description: User Profile Assignment Rule properties: user_profile: $ref: '#/components/schemas/XiqUserProfile' description: The User Profile of User Profile Assignment rule. enable_by_cwp: type: boolean description: The flag for enableBypassCwp. user_profile_assignment: $ref: '#/components/schemas/XiqUserProfileAssignment' description: The User Profile Assignment. XiqSsid1: allOf: - $ref: '#/components/schemas/XiqViqEntity' - type: object description: The SSID required: - name - broadcast_name - predefined properties: name: type: string description: The SSID profile name broadcast_name: type: string description: The SSID broadcast name description: type: string description: The SSID description predefined: type: boolean description: Whether it is predefined enable_user_profile_assignment: type: boolean description: The flag to enable User Profile Assignment. enable_radius_attribute_user_profile_assignment: type: boolean description: The flag to enable Radius Attribute User Profile Assignment. attribute_type: $ref: '#/components/schemas/XiqAttributeType' description: The SSID attribute type. attribute_key: type: integer description: The SSID attribute key. format: int32 access_security: $ref: '#/components/schemas/XiqSsidAccessSecurity' description: The SSID access security. radius_client_profile: $ref: '#/components/schemas/XiqRadiusClientProfile' description: The RADIUS client profile. default_user_profile: type: integer description: The default User Profile ID. format: int64 vendor_id: type: integer description: The vendor id, when the Attribute type is CUSTOM. user_profile_assignment_rules: type: array description: The user profile assignment rules. items: $ref: '#/components/schemas/XiqUserProfileAssignmentRule' advanced_settings_id: type: integer description: The SSID advanced settings ID format: int64 PagedXiqSsid1: allOf: - $ref: '#/components/schemas/XiqPage' - type: object properties: data: type: array description: The data in the current page items: $ref: '#/components/schemas/XiqSsid1' XiqSsidDot1xKeyManagement: type: string description: 'The key management: WPA_8021X, WPA2_8021X, WPA3_8021X or AUTO_8021X' enum: - WPA_8021X - WPA2_8021X - WPA3_8021X - AUTO_8021X XiqSsidDot1xEncryptionMethod: type: string description: 'The encryption method: for WPA_8021X, WPA2_8021X, please use CCMP or TKIP, for AUTO_8021X, please use AUTO_TKIP_CCMP, for WPA3_8021X, please use AES192' enum: - CCMP - TKIP - AUTO_TKIP_CCMP - AES192 XiqSetSsidModeDot1xRequest: type: object description: The request for setting the SSID to be 802.1x mode and Authentication settings. Authentication with ExtremeCloud IQ Authentication Service and Authentication with ExtremeCloud Universal ZTNA are mutually exclusive. required: - key_management - encryption_method properties: key_management: $ref: '#/components/schemas/XiqSsidDot1xKeyManagement' encryption_method: $ref: '#/components/schemas/XiqSsidDot1xEncryptionMethod' enable_idm: type: boolean description: Flag for using ExtremeCloud IQ Authentication Service or not enable_uztna: type: boolean default: false description: Flag for using Authentication with ExtremeCloud Universal ZTNA or not transition_mode: type: boolean description: Flag for enabling transition mode if using WPA3 as the key management type radius_server_group_id: type: integer description: The RADIUS server group ID if not using ExtremeCloud IQ Authentication Service format: int64 user_group_ids: type: array description: The user group IDs if using ExtremeCloud IQ Authentication Service items: type: integer description: The user group IDs if using ExtremeCloud IQ Authentication Service format: int64 XiqSsidPskKeyManagement: type: string description: 'The key management: WPA3_PSK, WPA2_PSK, WPA_PSK,AUTO_PSK' enum: - WPA_PSK - WPA2_PSK - WPA3_PSK - AUTO_PSK XiqSsidPskEncryptionMethod: type: string description: 'The encryption method: for WPA3_PSK please use CCMP, for WPA2_PSK or WPA_PSK, please use CCMP or TKIP, for AUTO_PSK, please use AUTO_TKIP_CCMP' enum: - CCMP - TKIP - AUTO_TKIP_CCMP XiqSetSsidModePskRequest: type: object description: The request for setting the SSID to be PSK mode. required: - key_management - encryption_method - key_type - key_value properties: key_management: $ref: '#/components/schemas/XiqSsidPskKeyManagement' encryption_method: $ref: '#/components/schemas/XiqSsidPskEncryptionMethod' anti_logging_threshold: type: integer description: The anti logging threshold format: int32 key_type: $ref: '#/components/schemas/XiqSsidKeyType' key_value: maxLength: 2147483647 minLength: 8 type: string description: The PSK key value, minimum 8 characters long sae_group: $ref: '#/components/schemas/XiqSsidSaeGroup' transition_mode: type: boolean description: Indicates the transition mode if key management is WPA3 XiqSsidPpskKeyManagement: type: string description: 'The key management: WPA2_PSK, WPA_PSK, AUTO_PSK' enum: - WPA_PSK - WPA2_PSK - AUTO_PSK XiqSetSsidModePpskRequest: type: object description: The request for setting the SSID to be PPSK mode. required: - key_management - encryption_method - user_group_ids - enable_max_clients_per_ppsk - enable_mac_bind properties: key_management: $ref: '#/components/schemas/XiqSsidPpskKeyManagement' encryption_method: $ref: '#/components/schemas/XiqSsidPskEncryptionMethod' user_group_ids: type: array description: The user group IDs to be attached to the SSID, cannot be empty items: type: integer description: The user group IDs to be attached to the SSID, cannot be empty format: int64 enable_max_clients_per_ppsk: type: boolean description: Flag for enabling the max clients per PPSK max_clients_per_ppsk: maximum: 15 minimum: 0 type: integer description: The max clients (0-15) per PPSK if enabled enable_max_clients_per_ppsk flag, 0 means unlimited format: int32 enable_mac_bind: type: boolean description: Flag for enabling mac binding or not. This setting is only supported with local PPSK. max_macs_per_ppsk: maximum: 5 minimum: 1 type: integer description: Set the max MAC binding numbers per private PSK, Min:1, Max:5 format: int32 ppsk_server_id: type: integer description: The PPSK server device ID format: int64 XiqSsidWepKeyManagement: type: string description: The key management type, WEP or WEP_8021X enum: - WEP - WEP_8021X XiqSsidWepEncryptionMethod: type: string description: The encryption method type, WEP104 or WEP40 enum: - WEP40 - WEP104 XiqSsidWepAuthenticationMethod: type: string description: The authentication method type, OPEN or SHARED enum: - OPEN - SHARED XiqSsidWepDefaultKey: type: string description: The default key, FIRST, SECOND,THIRD, OR FOURTH enum: - FIRST - SECOND - THIRD - FOURTH XiqSetSsidModeWepRequest: type: object description: The request for setting the SSID to be WEP mode. required: - key_management - encryption_method properties: key_management: $ref: '#/components/schemas/XiqSsidWepKeyManagement' encryption_method: $ref: '#/components/schemas/XiqSsidWepEncryptionMethod' authentication_method: $ref: '#/components/schemas/XiqSsidWepAuthenticationMethod' default_key: $ref: '#/components/schemas/XiqSsidWepDefaultKey' key_type: $ref: '#/components/schemas/XiqSsidKeyType' key_value: maxLength: 13 minLength: 5 type: string description: The first key value, must be 13 characters long for WEP104, and 5 characters long for WEP40, cannot be null if it is the default key example: abcd123456789 key_value2: maxLength: 13 minLength: 5 type: string description: The second key value, must be 13 characters long for WEP104, and 5 characters long for WEP40, cannot be null if it is the default key key_value3: maxLength: 13 minLength: 5 type: string description: The third key value, must be 13 characters long for WEP104, and 5 characters long for WEP40, cannot be null if it is the default key key_value4: maxLength: 13 minLength: 5 type: string description: The fourth key value, must be 13 characters long for WEP104, and 5 characters long for WEP40, cannot be null if it is the default key radius_server_group_id: type: integer description: The RADIUS server group ID if using WEP_8021x as the key management format: int64 XiqUserProfileAssignmentEntry: type: object properties: user_profile_id: type: integer format: int64 description: The User Profile ID. user_profile_assignment_id: type: integer format: int64 description: The User Profile Assignment ID. XiqAttachUPAssignmentRequest: type: object properties: user_profile_assignment_rules: type: array description: The User Profile Assignment and User Profile Id's to attach to SSID. items: $ref: '#/components/schemas/XiqUserProfileAssignmentEntry' enable_user_profile_assignment: type: boolean description: The flag to enable User Profile Assignment. enable_radius_attribute_user_profile_assignment: type: boolean description: The flag to enable Radius Attribute User Profile Assignment. attribute_type: $ref: '#/components/schemas/XiqAttributeType' description: The SSID attribute type. attribute_key: type: integer description: The SSID attribute key. format: int32 default_radius_client_object_id: type: integer format: int64 description: The default RADIUS client object ID. XiqDetachUPAssignmentRequest: type: object properties: user_profile_assignment_rules: type: array description: The User Profile Assignment and User Profile Id's to attach to SSID. items: $ref: '#/components/schemas/XiqUserProfileAssignmentEntry' XiqSsidAdvancedSettings: allOf: - $ref: '#/components/schemas/XiqBaseEntity' - type: object description: The advanced settings for the SSID properties: enable802_dot11mc: type: boolean description: Whether to enable 802.11mc on SSID XiqUpdateSsidAdvancedSettingsRequest: type: object properties: enable802_dot11mc: type: boolean description: Whether to enable 802.11mc on SSID. XiqCloudConfigGroup: allOf: - $ref: '#/components/schemas/XiqViqEntity' - type: object description: The CCG required: - name - predefined properties: name: type: string description: The CCG name description: type: string description: The CCG description predefined: type: boolean description: Whether it is predefined read_only: type: boolean description: Whether it is read-only zone_name: type: string description: The zone name. zone_id: type: integer description: The zone ID format: int64 zone_location_id: type: integer description: The zone location ID format: int64 device_ids: type: array description: The device IDs selected for this Ccg. items: type: integer description: The device IDs selected for this Ccg. format: int64 PagedXiqCloudConfigGroup: allOf: - $ref: '#/components/schemas/XiqPage' - type: object properties: data: type: array description: The data in the current page items: $ref: '#/components/schemas/XiqCloudConfigGroup' XiqCreateCloudConfigGroupRequest: type: object required: - name properties: name: type: string description: The CCG name description: type: string description: The CCG description device_ids: type: array description: The device ID list. items: type: integer description: The device ID list. format: int64 XiqUpdateCloudConfigGroupRequest: type: object properties: name: type: string description: The CCG name description: type: string description: The CCG description device_ids: type: array description: The device ID list. items: type: integer description: The device ID list. format: int64 XiqIotProfile: allOf: - $ref: '#/components/schemas/XiqViqEntity' - $ref: '#/components/schemas/XiqIotProfileRequest' PagedXiqIotProfile: allOf: - $ref: '#/components/schemas/XiqPage' - type: object properties: data: type: array description: The data in the current page items: $ref: '#/components/schemas/XiqIotProfile' XiqClientMonitorParameters: type: object description: The client monitor setting parameters properties: trigger_times: type: integer format: int32 minimum: 1 maximum: 10 default: 1 description: Set how many times the problem type is detected to trigger reporting the problem and related logs. Default value is 1. Range is 1-10. report_interval: type: integer format: int32 minimum: 0 maximum: 3600 default: 30 description: Set the interval (in seconds) to report the problem and related logs. Default value is 30 seconds. Range is 0 or 30-3600. XiqClientMonitorSetting: type: object description: The client monitor setting properties: association: description: Setting for reporting the client association problem $ref: '#/components/schemas/XiqClientMonitorParameters' authentication: description: Setting for reporting the client authentication problem $ref: '#/components/schemas/XiqClientMonitorParameters' networking: description: Setting for reporting the client networking problem $ref: '#/components/schemas/XiqClientMonitorParameters' XiqClientMonitorProfileRequest: allOf: - type: object properties: name: type: string description: The client monitor profile name - $ref: '#/components/schemas/XiqClientMonitorSetting' XiqClientMonitorProfile: allOf: - $ref: '#/components/schemas/XiqViqEntity' - $ref: '#/components/schemas/XiqClientMonitorProfileRequest' PagedXiqClientMonitorProfile: allOf: - $ref: '#/components/schemas/XiqPage' - type: object properties: data: type: array description: The data in the current page items: $ref: '#/components/schemas/XiqClientMonitorProfile' XiqDeviceRadioBand: type: string description: Radio Interface Bands enum: - BAND24 - BAND5 - BAND6 - BAND5LOW - BAND5HIGH - BAND6LOW - BAND6HIGH - BANDNONE example: BAND24 XiqDeviceInterfaceRadioMode: type: object description: Device Radio Interface Band. required: - name - band - default_radio_mode properties: name: $ref: '#/components/schemas/XiqWirelessIfName' band: $ref: '#/components/schemas/XiqDeviceRadioBand' default_radio_mode: $ref: '#/components/schemas/XiqRadioMode' XiqDeviceRadioModesSettings: type: array description: Device Radio Operating Mode settings based on AP Model. items: type: object required: - key properties: key: $ref: '#/components/schemas/XiqDeviceRadioOperatingMode' wireless_interfaces: description: Wireless Interface type: array items: $ref: '#/components/schemas/XiqDeviceInterfaceRadioMode' XiqMulticastRule: allOf: - type: object properties: ip: type: string description: IPv4 or IPv6 address with optional CIDR XiqTunnelConcentratorRequest: type: object required: - name - redundant - primary_tc - primary_listening_interface - primary_vlan - primary_tagged - primary_bridging_interface - tunnel_address - native_vlan description: |- Tunnel Concentrator Service object. Tunnel Concentrator Service can be configured in two modes: - Single - Redundant In single mode one instance of Tunnel Concentrator application terminates tunnels. Tunnel destination is defined by "tunnel_address" field. Port, VLAN and bridge interface of the "tunnel_address" are identified by fields: - primary_listening_interface - primary_vlan - primary_tagged - primary_bridged_interface In case of single Tunnel Concentrator "backup_*" fields are not used. In redundant mode a pair of Tunnel Concentrators applications form VRRP cluster. Each of the paired Tunnel Concentrators gets separate configuration via "primary_*" and "backup_*" fields. IP address of each Tunnel Concentrator is provided in the "primary_ip" and "backup_ip" fields. Tunnel IP address, provided in the "tunnel_address", is VRRP address. "router_id" defines VRRP router ID. Router priority is not configurable and assigned automatically, 100 to primary Tunnel Concentrator, 50 to backup. properties: name: type: string description: The Tunnel Concentrator Service name minLength: 1 maxLength: 255 decription: type: string description: The Tunnel Concentrator Service decription minLength: 0 maxLength: 1024 primary_tc: type: integer description: The Primary Tunnel Concentrator device ID format: int64 backup_tc: type: integer description: The Backup Tunnel Concentrator device ID format: int64 redundant: type: boolean description: Indicates if redundant Tunnel Concentrators (primary and backup) are configured primary_listening_interface: type: integer description: Primary Listening Interface ID format: int32 minimum: 1 maximum: 4 backup_listening_interface: type: integer description: Backup Listening Interface ID format: int32 minimum: 1 maximum: 4 primary_bridging_interface: type: integer description: Primary Bridging Interface ID format: int32 minimum: 1 maximum: 4 backup_bridging_interface: type: integer description: Backup Bridging Interface ID format: int32 minimum: 1 maximum: 4 primary_vlan: type: integer description: The VLAN ID for the primary listening interface format: int32 minimum: 1 maximum: 4094 backup_vlan: type: integer description: The VLAN ID for the backup listening interface format: int32 minimum: 1 maximum: 4094 primary_tagged: type: boolean description: Indicates if primary VLAN is tagged. backup_tagged: type: boolean description: Indicates if backup VLAN is tagged. primary_ip: type: string description: The primary IP address of network interface for accepting connections from APs (listening interface). format: ipv4 backup_ip: type: string description: The backup IP address of network interface for accepting connections from APs (listening interface). format: ipv4 tunnel_address: type: string 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])$ description: IP address/CIDR of listening interface. router_id: type: integer description: Virtual Router group ID. Routers with the same VR ID cooperate in election of main router and must have the same VRRP IP address. format: int32 minimum: 1 maximum: 254 default: 1 native_vlan: type: integer description: Specifies which VLAN ID is transmitted untagged on the bridged interface. format: int32 minimum: 1 maximum: 4094 gateway: type: string description: Default gateway for the listening interface. format: ipv4 blockNonEssentialBroadcast: type: boolean description: Indicates if Tunnel Concentrator will block non essential broadcast default: true arpProxy: type: boolean description: Indicates if arp proxy is enabled default: true multicastRules: type: array items: $ref: '#/components/schemas/XiqMulticastRule' description: List of Multicast rules XiqTunnelConcentrator: allOf: - $ref: '#/components/schemas/XiqViqEntity' - $ref: '#/components/schemas/XiqTunnelConcentratorRequest' PagedXiqTunnelConcentrator: allOf: - $ref: '#/components/schemas/XiqPage' - type: object properties: data: type: array description: The data in the current page items: $ref: '#/components/schemas/XiqTunnelConcentrator' PagedXiqNetworkService: allOf: - $ref: '#/components/schemas/XiqPage' - type: object properties: data: type: array description: The data in the current page items: $ref: '#/components/schemas/XiqNetworkService' XiqActiveDirectoryServerBaseDnFetchMode: type: string description: The base DN fetch mode of active directory server enum: - AUTO - MANUAL XiqActiveDirectoryServer: allOf: - $ref: '#/components/schemas/XiqViqEntity' - type: object description: The configuration of Active Directory Server properties: name: type: string description: The active directory server name description: type: string description: The description for active directory server base_dn: type: string description: The base DN of active directory server enable_tls: type: boolean description: Flag to enable TLS bind_dn: type: string description: The bind DN of active directory server bind_dn_password: type: string description: The bind DN password of active directory server domain: type: string description: The domain of active directory server computer_ou: type: string description: The compute OU of active directory server domain_admin: type: string description: The domain admin of active directory server domain_admin_password: type: string description: The domain admin password of active directory server enable_save_domain_admin_credentials: type: boolean description: Flag to enable save domain admin credentials short_domain: type: string description: The short domain of active directory server realm: type: string description: The realm of active directory server base_dn_fetch_mode: $ref: '#/components/schemas/XiqActiveDirectoryServerBaseDnFetchMode' connection_setup_device_id: type: integer description: The connection setup device ID for active directory server format: int64 l3_address_profile_id: type: integer description: The associate L3 address profile ID for active directory server format: int64 PagedXiqActiveDirectoryServer: allOf: - $ref: '#/components/schemas/XiqPage' - type: object properties: data: type: array description: The data in the current page items: $ref: '#/components/schemas/XiqActiveDirectoryServer' XiqCwp: allOf: - $ref: '#/components/schemas/XiqViqEntity' - type: object description: The Captive Web Portal Entity properties: name: type: string description: The CWP name PagedXiqCwp: allOf: - $ref: '#/components/schemas/XiqPage' - type: object properties: data: type: array description: The data in the current page items: $ref: '#/components/schemas/XiqCwp' XiqLdapProtocolType: type: string description: LDAP server protocol type enum: - LDAP - LDAPS XiqLdapServerVerificationMode: type: string description: The LDAP server verification mode enum: - TRY - NEVER - DEMAND XiqLdapServer: allOf: - $ref: '#/components/schemas/XiqBaseEntity' - type: object description: The common object - LDAP server required: - name properties: name: type: string description: The LDAP server name description: type: string description: The LDAP server description enable_tls: type: boolean description: The LDAP server is enabled TLS or not bind_dn: type: string description: The LDAP server bind DN name bind_dn_password: type: string description: The LDAP server bind DN password base_dn: type: string description: The RADIUS user base DN l3_address_profile_id: type: integer description: The L3 address profile ID format: int64 protocol_type: $ref: '#/components/schemas/XiqLdapProtocolType' enable_strip_realm_name: type: boolean description: Enable strip realm name or not destination_port: type: integer description: The LDAP server destination port format: int32 verification_mode: $ref: '#/components/schemas/XiqLdapServerVerificationMode' ca_certificate_id: type: integer description: The CA certificate ID format: int64 client_certificate_id: type: integer description: The client certificate ID format: int64 client_key_id: type: integer description: The client key ID format: int64 client_key_password: type: string description: The LDAP server client key password PagedXiqLdapServer: allOf: - $ref: '#/components/schemas/XiqPage' - type: object properties: data: type: array description: The data in the current page items: $ref: '#/components/schemas/XiqLdapServer' XiqCreateLdapServerRequest: type: object required: - name - enable_tls - bind_dn_password - bind_dn - base_dn - l3_address_profile_id - protocol_type - enable_strip_realm_name - destination_port - verification_mode properties: name: type: string description: The LDAP server name description: type: string description: The LDAP server description(optional) enable_tls: type: boolean description: To enable TLS or not, if ture, caCertificateId, clientCertificateId and clientKeyId must be specified bind_dn: type: string description: The LDAP server bind DN name bind_dn_password: type: string description: The LDAP server bind DN password base_dn: type: string description: The RADIUS user base DN l3_address_profile_id: type: integer description: The L3 address profile ID format: int64 protocol_type: $ref: '#/components/schemas/XiqLdapProtocolType' enable_strip_realm_name: type: boolean description: enable strip realm name or not destination_port: minimum: 1 type: integer description: The LDAP server destination port (1 ~ 65535) format: int32 verification_mode: $ref: '#/components/schemas/XiqLdapServerVerificationMode' ca_certificate_id: type: integer description: The CA certificate ID, refer to XiqCertificate format: int64 client_certificate_id: type: integer description: The client certificate ID, refer to XiqCertificate format: int64 client_key_id: type: integer description: The client key ID, refer to XiqCertificate format: int64 client_key_password: type: string description: The LDAP server client key password XiqUpdateLdapServerRequest: type: object properties: name: type: string description: The LDAP server name description: type: string description: The LDAP server description enable_tls: type: boolean description: enable TLS or not, if ture, caCertificateId, clientCertificateId and clientKeyId must be specified bind_dn: type: string description: The LDAP server bind DN name bind_dn_password: type: string description: The LDAP server bind DN password base_dn: type: string description: The RADIUS user base DN l3_address_profile_id: type: integer description: The L3 address profile ID format: int64 protocol_type: $ref: '#/components/schemas/XiqLdapProtocolType' enable_strip_realm_name: type: boolean description: enable strip realm name or not destination_port: minimum: 1 type: integer description: The LDAP server destination port (1 ~ 65535) format: int32 verification_mode: $ref: '#/components/schemas/XiqLdapServerVerificationMode' ca_certificate_id: type: integer description: The CA certificate ID, refer to XiqCertificate format: int64 client_certificate_id: type: integer description: The client certificate ID, refer to XiqCertificate format: int64 client_key_id: type: integer description: The client key ID, refer to XiqCertificate format: int64 XiqServerRole: type: string description: The server role, PRIMARY or BACKUP enum: - PRIMARY - BACKUP1 - BACKUP2 - BACKUP3 XiqRadiusClientObjectType: type: string description: 'The entry server type: INTERNAL_RADIUS_SERVER, EXTERNAL_RADIUS_SERVER, INTERNAL_RADIUS_PROXY' enum: - EXTERNAL_RADIUS_SERVER - INTERNAL_RADIUS_SERVER - INTERNAL_RADIUS_PROXY XiqRadiusClientObjectEntry: type: object description: The entry of RADIUS client object required: - server_role - server_type - radius_server_id properties: server_role: $ref: '#/components/schemas/XiqServerRole' server_type: $ref: '#/components/schemas/XiqRadiusClientObjectType' radius_server_id: type: integer description: The ID of the RADIUS server object, for EXTERNAL_RADIUS_SERVER please use the ID of external RADIUS server object. For INTERNAL_RADIUS_SERVER, please use the RADIUS device ID format: int64 XiqRadiusClientObject: allOf: - $ref: '#/components/schemas/XiqBaseEntity' - type: object description: The RADIUS client object configuration required: - name - enable_inject_operator_name_attribute - enable_message_authenticator_attribute - enable_permit_dynamic_authorization_message_change - retry_interval - accounting_interim_update_interval - entries properties: name: type: string description: The RADIUS client object name. description: type: string description: The RADIUS client object description. enable_inject_operator_name_attribute: type: boolean description: The flag for enable inject operator name attribute. enable_message_authenticator_attribute: type: boolean description: The flag for enable message authenticator attribute enable_permit_dynamic_authorization_message_change: type: boolean description: The flag for enable permit dynamic authorization message change retry_interval: maximum: 100000000 minimum: 60 type: integer description: The retry interval, 60 - 100000000 seconds format: int32 accounting_interim_update_interval: maximum: 100000000 minimum: 60 type: integer description: The accounting interim update interval, 60 - 100000000 seconds format: int32 entries: maxItems: 2147483647 minItems: 1 type: array description: The list of RADIUS client object entries items: $ref: '#/components/schemas/XiqRadiusClientObjectEntry' PagedXiqRadiusClientObject: allOf: - $ref: '#/components/schemas/XiqPage' - type: object properties: data: type: array description: The data in the current page items: $ref: '#/components/schemas/XiqRadiusClientObject' XiqCreateRadiusClientObjectRequest: type: object required: - name - enable_inject_operator_name_attribute - enable_message_authenticator_attribute - enable_permit_dynamic_authorization_message_change - retry_interval - accounting_interim_update_interval - entries properties: name: type: string description: The RADIUS client object name. description: type: string description: The RADIUS client object description. enable_inject_operator_name_attribute: type: boolean description: The flag for enable Inject Operator Name Attribute enable_message_authenticator_attribute: type: boolean description: The flag for enable message authenticator attribute enable_permit_dynamic_authorization_message_change: type: boolean description: The flag for enable permit dynamic authorization message change retry_interval: maximum: 100000000 minimum: 60 type: integer description: The retry interval, 60 - 100000000 seconds format: int32 accounting_interim_update_interval: maximum: 100000000 minimum: 60 type: integer description: The accounting interim update interval, 60 - 100000000 seconds format: int32 entries: maxItems: 2147483647 minItems: 1 type: array description: The list of RADIUS client object entries items: $ref: '#/components/schemas/XiqRadiusClientObjectEntry' XiqUpdateRadiusClientObjectRequest: type: object required: - name - enable_inject_operator_name_attribute - enable_message_authenticator_attribute - enable_permit_dynamic_authorization_message_change - retry_interval - accounting_interim_update_interval properties: name: type: string description: The RADIUS client object name. description: type: string description: The RADIUS client object description. enable_inject_operator_name_attribute: type: boolean description: The flag for enable Inject Operator Name Attribute enable_message_authenticator_attribute: type: boolean description: The flag for enable message authenticator attribute enable_permit_dynamic_authorization_message_change: type: boolean description: The flag for enable permit dynamic authorization message change retry_interval: maximum: 100000000 minimum: 60 type: integer description: The retry interval, 60 - 100000000 seconds format: int32 accounting_interim_update_interval: maximum: 100000000 minimum: 60 type: integer description: The accounting interim update interval, 60 - 100000000 seconds format: int32 XiqRadiusProxyFormatType: type: string description: The format type of RADIUS proxy enum: - NAI - NT - SPN - AUTO XiqRadiusClient: type: object description: The associate RADIUS client for RADIUS proxy properties: id: type: integer description: The RADIUS client ID format: int64 shared_secret: type: string description: The shared secret of RADIUS client description: type: string description: The RADIUS client description l3_address_profile_id: type: integer description: The associate L3 address profile ID format: int64 XiqRadiusProxyRealm: type: object description: The associate RADIUS proxy realm for RADIUS proxy properties: id: type: integer description: The RADIUS proxy realm ID format: int64 name: type: string description: The RADIUS proxy realm name enable_strip_realm_name: type: boolean description: The flag for enable strip realm name radius_client_object_id: type: integer description: The associate RADIUS client object ID format: int64 XiqRadiusProxy: allOf: - $ref: '#/components/schemas/XiqViqEntity' - type: object description: The configuration of 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' retry_count: type: integer description: The retry count of RADIUS proxy format: int32 retry_delay: type: integer description: The retry delay of RADIUS proxy format: int32 dead_time: type: integer description: The dead time of RADIUS proxy format: int32 enable_inject_operator_name_attribute: type: boolean description: The flag for enable inject operator name attribute clients: type: array description: The RADIUS clients of RADIUS proxy items: $ref: '#/components/schemas/XiqRadiusClient' realms: type: array description: The RADIUS realms of RADIUS proxy items: $ref: '#/components/schemas/XiqRadiusProxyRealm' PagedXiqRadiusProxy: allOf: - $ref: '#/components/schemas/XiqPage' - type: object properties: data: type: array description: The data in the current page items: $ref: '#/components/schemas/XiqRadiusProxy' 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 description: The associate L3 address profile ID format: int64 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 description: The associate RADIUS client object ID format: int64 XiqCreateRadiusProxyRequest: type: object description: The payload to create a new RADIUS proxy required: - name - format_type - retry_count - retry_delay - dead_time - realms - device_ids properties: name: type: string description: The RADIUS proxy name description: type: string description: The RADIUS proxy description format_type: $ref: '#/components/schemas/XiqRadiusProxyFormatType' retry_count: type: integer description: The retry count of RADIUS proxy format: int32 retry_delay: type: integer description: The retry delay of RADIUS proxy format: int32 dead_time: type: integer description: The dead time of RADIUS proxy format: int32 enable_inject_operator_name_attribute: type: boolean description: The flag for enable inject operator name attribute clients: type: array description: The RADIUS clients of RADIUS proxy items: $ref: '#/components/schemas/XiqCreateRadiusClient' realms: maxItems: 2147483647 minItems: 2 type: array description: The RADIUS realms of RADIUS proxy, provide at least two default RADIUS realms with name 'DEFAULT' and 'NULL' items: $ref: '#/components/schemas/XiqCreateRadiusProxyRealm' device_ids: type: array description: The device IDS to assign RADIUS proxy items: type: integer description: The device IDS to assign RADIUS proxy format: int64 XiqUpdateRadiusClient: type: object description: The associate RADIUS client for RADIUS proxy properties: id: type: integer description: The RADIUS client ID, using an existing ID or leave empty to create a new one format: int64 shared_secret: type: string description: The shared secret of RADIUS client description: type: string description: The RADIUS client description l3_address_profile_id: type: integer description: The associate L3 address profile ID format: int64 XiqUpdateRadiusProxyRealm: type: object description: The associate RADIUS proxy realm for RADIUS proxy properties: id: type: integer description: The RADIUS proxy realm ID, using an existing ID or leave empty to create a new one format: int64 name: type: string description: The RADIUS proxy realm name enable_strip_realm_name: type: boolean description: The flag for enable strip realm name radius_client_object_id: type: integer description: The associate RADIUS client object ID format: int64 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' retry_count: type: integer description: The retry count of RADIUS proxy format: int32 retry_delay: type: integer description: The retry delay of RADIUS proxy format: int32 dead_time: type: integer description: The dead time of RADIUS proxy format: int32 enable_inject_operator_name_attribute: type: boolean description: The flag for enable inject operator name attribute clients: type: array description: The RADIUS clients of RADIUS proxy items: $ref: '#/components/schemas/XiqUpdateRadiusClient' realms: maxItems: 2147483647 minItems: 2 type: array description: The RADIUS realms of RADIUS proxy, provide at least two default RADIUS realms with name 'DEFAULT' and 'NULL' items: $ref: '#/components/schemas/XiqUpdateRadiusProxyRealm' XiqInternalRadiusDevice: allOf: - $ref: '#/components/schemas/XiqViqEntity' - type: object description: The configuration of internal RADIUS device object required: - radius_server_id - radius_server_name - host_name properties: radius_server_id: type: integer description: The RADIUS server id format: int64 radius_server_name: type: string description: The RADIUS server name host_name: type: string description: The RADIUS server device hostname PagedXiqInternalRadiusDevice: allOf: - $ref: '#/components/schemas/XiqPage' - type: object properties: data: type: array description: The data in the current page items: $ref: '#/components/schemas/XiqInternalRadiusDevice' XiqInternalRadiusServerAuthenticationMethodGroup: type: string description: The authentication group enum: - TLS_PEAP_TTLS_LEAP_MD5 - TLS_PEAP_TTLS_LEAP - TLS_PEAP - TLS_TTLS - TLS - LEAP XiqInternalRadiusServerAuthenticationMethod: type: string description: The default authentication method enum: - TLS - PEAP - TTLS - LEAP - MD5 XiqExternalUserDirectoryType: type: string description: The external user directory type enum: - OPEN_LDAP - ACTIVE_DIRECTORY XiqExternalUserDirectoryEntry: type: object description: The payload of common object - External User Directory Entry required: - default_server_id - server_role properties: default_server_id: type: integer description: 'The default external user directory server id, could be active directory server id(get the id list from endpoint: ''/ad-servers'') or LDAP server id(get the id list from endpoint: ''/ldap-servers'') depends on the ''external_user_directory_type'' ' format: int64 server_role: $ref: '#/components/schemas/XiqServerRole' XiqExternalUserDirectory: type: object description: The setting for external user directory, AD or LDAP required: - ldap_retry_interval - local_check_interval - remote_check_interval - enable_radius_server_credential_caching - cache_lifetime - user_group_attribute - external_user_directory_type - entries properties: ldap_retry_interval: maximum: 200000000 minimum: 60 type: integer description: Retry the previously unresponsive primary server after the specified seconds format: int32 default: 600 local_check_interval: maximum: 3600 minimum: 30 type: integer description: Time to user local cache if none of the external servers are reachable in seconds format: int32 default: 300 remote_check_interval: maximum: 3600 minimum: 10 type: integer description: Try the next backup server after specified seconds format: int32 default: 30 enable_radius_server_credential_caching: type: boolean description: Caching credentials allows for better performance and higher availability by reducing the dependence on RADIUS servers across high-latency WAN links. cache_lifetime: maximum: 2592000 minimum: 3600 type: integer description: Retain Cache for format: int32 default: 86400 user_group_attribute: type: string description: 'The user group attribute, use string such as: ''memberOf''' example: memberOf default: memberOf external_user_directory_type: $ref: '#/components/schemas/XiqExternalUserDirectoryType' entries: type: array description: The external user directory server entries items: $ref: '#/components/schemas/XiqExternalUserDirectoryEntry' XiqInternalRadiusServer: allOf: - $ref: '#/components/schemas/XiqViqEntity' - type: object description: The configuration of internal RADIUS server object required: - name - authentication_method_group - default_authentication_method - authentication_server_port - enable_verify_server_cert - enable_check_cert_common_name - enable_check_user_for_tls_auth - enable_authentication_server - enable_radius_accounting_settings - external_user_directory - ca_certificate_id - server_certificate_id - server_key_id - device_ids properties: name: type: string description: The internal RADIUS server name description: type: string description: The internal RADIUS server description authentication_method_group: $ref: '#/components/schemas/XiqInternalRadiusServerAuthenticationMethodGroup' default_authentication_method: $ref: '#/components/schemas/XiqInternalRadiusServerAuthenticationMethod' enable_verify_server_cert: type: boolean description: Enable verify server cert or not server_key_password: type: string description: password for server key enable_check_cert_common_name: type: boolean description: Enable check cert common name or not enable_check_user_for_tls_auth: type: boolean description: Enable check user for TLS auth or not enable_check_user_for_peap_auth: type: boolean description: Enable check user for PEAP auth or not, for Active Directory as the external user directory only enable_check_user_for_ttls_auth: type: boolean description: Enable check user for TTLS auth or not, for Active Directory as the external user directory only enable_authentication_server: type: boolean description: Enable the RADIUS server as authentication or not enable_radius_accounting_settings: type: boolean description: Enable the RADIUS server as accounting or not, must enable authentication server if want to enable accounting settings authentication_server_port: maximum: 65535 minimum: 1 type: integer description: Port for the authentication, must enable authentication. Max:65535, Min:1 format: int32 default: 1812 active_session_limit: maximum: 15 minimum: 0 type: integer description: Active session limit, must enable accounting setting. Max:15, Min:0 format: int32 default: 0 active_session_age_timeout: maximum: 300000000 minimum: 30 type: integer description: Active session age timeout in seconds, must enable accounting setting. Max:300000000, Min:30 format: int32 default: 30 external_user_directory: $ref: '#/components/schemas/XiqExternalUserDirectory' ca_certificate_id: type: integer description: The CA certificate ID format: int64 server_certificate_id: type: integer description: The Server certificate ID format: int64 server_key_id: type: integer description: The Server key ID format: int64 device_ids: type: array description: The list of device ID associated with the internal RADIUS server items: type: integer description: The list of device ID associated with the internal RADIUS server format: int64 clients: type: array description: The RADIUS clients of RADIUS proxy items: $ref: '#/components/schemas/XiqRadiusClient' PagedXiqInternalRadiusServer: allOf: - $ref: '#/components/schemas/XiqPage' - type: object properties: data: type: array description: The data in the current page items: $ref: '#/components/schemas/XiqInternalRadiusServer' XiqCreateInternalRadiusServerRequest: type: object required: - name - authentication_method_group - default_authentication_method - enable_verify_server_cert - enable_check_cert_common_name - enable_check_user_for_tls_auth - enable_authentication_server - enable_radius_accounting_settings - external_user_directory - ca_certificate_id - server_certificate_id - server_key_id - device_ids properties: name: type: string description: The internal RADIUS server name description: type: string description: The internal RADIUS server description authentication_method_group: $ref: '#/components/schemas/XiqInternalRadiusServerAuthenticationMethodGroup' default_authentication_method: $ref: '#/components/schemas/XiqInternalRadiusServerAuthenticationMethod' enable_verify_server_cert: type: boolean description: Enable verify server cert or not server_key_password: type: string description: password for server key enable_check_cert_common_name: type: boolean description: Enable check cert common name or not enable_check_user_for_tls_auth: type: boolean description: Enable check user for TLS auth or not enable_check_user_for_peap_auth: type: boolean description: Enable check user for PEAP auth or not, for Active Directory as the external user directory only enable_check_user_for_ttls_auth: type: boolean description: Enable check user for TTLS auth or not, for Active Directory as the external user directory only enable_authentication_server: type: boolean description: Enable the RADIUS server as authentication or not enable_radius_accounting_settings: type: boolean description: Enable the RADIUS server as accounting or not, must enable authentication server if want to enable accounting settings authentication_server_port: maximum: 65535 minimum: 1 type: integer description: Port for the authentication, must enable authentication. Max:65535, Min:1 format: int32 default: 1812 active_session_limit: maximum: 15 minimum: 0 type: integer description: Active session limit, must enable accounting setting. Max:15, Min:0 format: int32 default: 0 active_session_age_timeout: maximum: 300000000 minimum: 30 type: integer description: Active session age timeout in seconds, must enable accounting setting. Max:300000000, Min:30 format: int32 default: 1800 external_user_directory: $ref: '#/components/schemas/XiqExternalUserDirectory' ca_certificate_id: type: integer description: 'The CA certificate ID, which could be fetched from endpoint: ''/certificates'' and pick up with type ''CA''' format: int64 server_certificate_id: type: integer description: 'The Server certificate ID, which could be fetched from endpoint: ''/certificates'' and pick up with type ''CERT''' format: int64 server_key_id: type: integer description: 'The Server key ID, which could be fetched from endpoint: ''/certificates and pick up with type ''KEY''' format: int64 device_ids: type: array description: The list of device ID associated with the internal RADIUS server items: type: integer description: The list of device ID associated with the internal RADIUS server format: int64 clients: type: array description: 'The RADIUS clients of RADIUS proxy, which could be fetched from endpoint: ''/radius-proxy''' items: $ref: '#/components/schemas/XiqRadiusClient' XiqUpdateInternalRadiusServerRequest: type: object required: - name - authentication_method_group - default_authentication_method - enable_verify_server_cert - enable_check_cert_common_name - enable_check_user_for_tls_auth - ca_certificate_id - enable_authentication_server - enable_radius_accounting_settings - server_certificate_id - server_key_id properties: name: type: string description: The internal RADIUS server name description: type: string description: The internal RADIUS server description authentication_method_group: $ref: '#/components/schemas/XiqInternalRadiusServerAuthenticationMethodGroup' default_authentication_method: $ref: '#/components/schemas/XiqInternalRadiusServerAuthenticationMethod' enable_verify_server_cert: type: boolean description: Enable verify server cert or not server_key_password: type: string description: password for server key enable_check_cert_common_name: type: boolean description: Enable check cert common name or not enable_check_user_for_tls_auth: type: boolean description: Enable check user for TLS auth or not enable_check_user_for_peap_auth: type: boolean description: Enable check user for PEAP auth or not, for Active Directory as the external user directory only enable_check_user_for_ttls_auth: type: boolean description: Enable check user for TTLS auth or not, for Active Directory as the external user directory only enable_authentication_server: type: boolean description: Enable the RADIUS server as authentication or not enable_radius_accounting_settings: type: boolean description: Enable the RADIUS server as accounting or not, must enable authentication server if want to enable accounting settings authentication_server_port: maximum: 65535 minimum: 1 type: integer description: Port for the authentication, must enable authentication. Max:65535, Min:1 format: int32 default: 1812 active_session_limit: maximum: 15 minimum: 0 type: integer description: Active session limit, must enable accounting setting. Max:15, Min:0 format: int32 default: 0 active_session_age_timeout: maximum: 300000000 minimum: 30 type: integer description: Active session age timeout in seconds, must enable accounting setting. Max:300000000, Min:30 format: int32 default: 30 ca_certificate_id: type: integer description: 'The CA certificate ID, which could be fetched from endpoint: ''/certificates'' and pick up with type ''CA''' format: int64 server_certificate_id: type: integer description: 'The Server certificate ID, which could be fetched from endpoint: ''/certificates'' and pick up with type ''CERT''' format: int64 server_key_id: type: integer description: 'The Server key ID, which could be fetched from endpoint: ''/certificates and pick up with type ''KEY''' format: int64 clients: type: array description: 'The RADIUS clients of RADIUS proxy, which could be fetched form endpoint: ''/radius-proxy''' items: $ref: '#/components/schemas/XiqRadiusClient' XiqRadiusServerType: type: string description: The port type of the RADIUS server, can only be either ACCOUNTING, AUTHENTICATION, or BOTH enum: - ACCOUNTING - AUTHENTICATION - BOTH XiqCertBundleType: type: string description: The type of Certificate Bundle. enum: - TRUST_POINT XiqCertificateType: type: string enum: - CERT - KEY - CA XiqCertificate: allOf: - $ref: '#/components/schemas/XiqBaseEntity' - type: object description: The certificate required: - name properties: name: type: string description: The certificate file name cert_type: $ref: '#/components/schemas/XiqCertificateType' XiqCertificateBundle: allOf: - $ref: '#/components/schemas/XiqViqEntity' - type: object description: The configuration of Certificate Bundle required: - bundle_type properties: bundle_type: $ref: '#/components/schemas/XiqCertBundleType' certificates: type: array description: Certificate Bundles certificates. items: $ref: '#/components/schemas/XiqCertificate' XiqRadiusAccessType: type: string 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. enum: - STANDARD - SECURE XiqExternalRadiusServer: allOf: - $ref: '#/components/schemas/XiqViqEntity' - type: object description: The configuration of external RADIUS server object required: - name - authentication_port - accounting_port - server_type - enable_a3 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 description: The authentication port for the external RADIUS server (1 ~ 65535). The default for a External RADIUS server of type 'STANDARD', the default port is 1812. For a External RADIUS server of type 'SECURE', the default port is 2083. format: int32 accounting_port: type: integer description: The accounting port for the external RADIUS server (1 ~ 65535). The default for a External RADIUS server of type 'STANDARD', the default port is 1813. For a External RADIUS server of type 'SECURE', the default port is 2083. format: int32 server_type: $ref: '#/components/schemas/XiqRadiusServerType' ip_address: type: string description: The ip address or hostname of the RADIUS server, this is not allowed when Peer Discovery is enabled. 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. trust_point: $ref: '#/components/schemas/XiqCertificateBundle' access_type: $ref: '#/components/schemas/XiqRadiusAccessType' PagedXiqExternalRadiusServer: allOf: - $ref: '#/components/schemas/XiqPage' - type: object properties: data: type: array description: The data in the current page items: $ref: '#/components/schemas/XiqExternalRadiusServer' XiqCreateExternalRadiusServerRequest: type: object required: - name - authentication_port - accounting_port - server_type - enable_a3 properties: name: type: string description: The external RADIUS server name shared_secret: type: string description: The shared secret for the external RADIUS server (optional) authentication_port: maximum: 65535 minimum: 1 type: integer description: The authentication port for the external RADIUS server (1 ~ 65535). The default for a External RADIUS server of type 'STANDARD', the default port is 1812. For a External RADIUS server of type 'SECURE' the default port is 2083. format: int32 accounting_port: maximum: 65535 minimum: 1 type: integer description: The accounting port for the external RADIUS server (1 ~ 65535). The default for a External RADIUS server of type 'STANDARD', the default port is 1813, For a External RADIUS server of type 'SECURE', the default port is 2083. format: int32 server_type: $ref: '#/components/schemas/XiqRadiusServerType' ip_addr: type: string description: The IP address or hostname of the RADIUS server enable_a3: type: boolean description: Indicates whether this is an Extreme A3 RADIUS server or not, cannot be updated after creation. Please set it to false if it is not an Extreme A3 RADIUS server. 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_point_id: type: integer description: The Certificate Bundle Trust Point ID. format: int64 access_type: $ref: '#/components/schemas/XiqRadiusAccessType' XiqUpdateExternalRadiusServerRequest: type: object required: - name - authentication_port - accounting_port - server_type properties: name: type: string description: The external RADIUS server name. shared_secret: type: string description: The shared secret for the external RADIUS server (optional). authentication_port: maximum: 65535 minimum: 1 type: integer description: The authentication port for the external RADIUS server (1 ~ 65535). The default for a External RADIUS server of type 'STANDARD', the default port is 1812. For a External RADIUS server of type 'SECURE', the default port is 2083. format: int32 accounting_port: maximum: 65535 minimum: 1 type: integer description: The accounting port for the external RADIUS server (1 ~ 65535). The default for a External RADIUS server of type 'STANDARD', the default port is 1813. For a External RADIUS server of type 'SECURE', the default port is 2083. format: int32 server_type: $ref: '#/components/schemas/XiqRadiusServerType' 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_point_id: type: integer description: The Trust Point Certificate Bundle ID. format: int64 XiqRadsecOperatorNameType: type: string description: The operator name type of a RADSEC proxy. enum: - WBAID XiqRadsecProxyRealm: type: object description: The RADSEC proxy realm definition properties: name: type: string description: The RADIUS proxy realm name enable_strip_realm_name: type: boolean description: The flag to strip the realm name external_radius_server_object_ids: type: array description: The list of external RADIUS server object IDs (up to 8) items: type: integer format: int64 XiqRadsecProxy: allOf: - $ref: '#/components/schemas/XiqViqEntity' - type: object description: The configuration of 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' enable_inject_operator_name_attribute: type: boolean description: The flag for enable inject operator name attribute. operator_name_type: $ref: '#/components/schemas/XiqRadsecOperatorNameType' operator_name: type: string description: The RADSEC proxy operator name. realms: type: array description: The RADSEC realms of RADSEC proxy. items: $ref: '#/components/schemas/XiqRadsecProxyRealm' PagedXiqRadsecProxy: allOf: - $ref: '#/components/schemas/XiqPage' - type: object properties: data: type: array description: The data in the current page items: $ref: '#/components/schemas/XiqRadsecProxy' XiqRadsecNameFormatType: type: string description: The name format type of a RADSEC proxy. enum: - NAI XiqCreateRadsecProxyRequest: type: object description: The payload to create a new RADSEC proxy. required: - name - realms properties: name: type: string description: The RADSEC proxy name. description: type: string description: The RADSEC proxy description. name_format: $ref: '#/components/schemas/XiqRadsecNameFormatType' enable_inject_operator_name_attribute: type: boolean description: The flag for enable inject operator name attribute. operator_name_type: $ref: '#/components/schemas/XiqRadsecOperatorNameType' operator_name: type: string description: The RADSEC proxy operator name. realms: type: array description: The RADSEC realms of RADSEC proxy. items: $ref: '#/components/schemas/XiqRadsecProxyRealm' XiqUpdateRadsecProxyRequest: type: object description: The payload to update RADSEC proxy properties: name: type: string description: The RADSEC proxy name description: type: string description: The RADSEC proxy description name_format: $ref: '#/components/schemas/XiqRadsecNameFormatType' 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: maxItems: 2147483647 minItems: 2 type: array description: The RADSEC realms of RADSEC proxy, provide at least two default RADSEC realms with name 'DEFAULT' and 'NULL' items: $ref: '#/components/schemas/XiqUpdateRadiusProxyRealm' PagedXiqCertificate: allOf: - $ref: '#/components/schemas/XiqPage' - type: object properties: data: type: array description: The data in the current page items: $ref: '#/components/schemas/XiqCertificate' XiqCertConvertOptionType: type: string description: The Certificate convert option, required when the convert option type is 'KEY'. enum: - CERTIFICATE - KEY XiqImportCertRequest: type: object description: The payload to import a certificate. required: - name - file - file_type properties: name: type: string description: The certificate name. file: type: string format: binary description: The certificate file to import. file_type: $ref: '#/components/schemas/XiqCertificateType' enable_convert_pfx: type: boolean description: Whether to convert the certificate format from PFX to PEM. pfx_password: type: string description: The PFX password. enable_convert_der: type: boolean description: Whether to convert the certificate format from DER to PEM. convert_option_type: $ref: '#/components/schemas/XiqCertConvertOptionType' der_password: type: string description: The DER password, required when the convert option type is 'KEY'. PagedXiqCertificateBundle: allOf: - $ref: '#/components/schemas/XiqPage' - type: object properties: data: type: array description: The data in the current page items: $ref: '#/components/schemas/XiqCertificateBundle' XiqCreateCertBundleRequest: type: object description: The payload to create a new Certificate Bundle. required: - name - bundle_type properties: name: type: string description: The Certificate Bundle name. description: type: string description: The Certificate Bundle description. bundle_type: $ref: '#/components/schemas/XiqCertBundleType' certificate_ids: type: array description: Collection of Certificate IDs. items: type: integer format: int64 XiqUpdateCertBundleRequest: type: object description: The payload to update a Certificate Bundle. required: - name properties: name: type: string description: The Certificate Bundle name. description: type: string description: The Certificate Bundle description. certificate_ids: type: array description: Collection of Certificate IDs. items: type: integer format: int64 XiqClientType: type: string enum: - WIRELESS - WIRED XiqCopilotConnectivityExperienceEntity: type: object description: Copilot Experience Entity required: - id - name - info - quality_index - trend_indicator - client_type - quality_index_graph properties: id: type: string name: type: string info: type: string quality_index: type: integer minimum: 1 maximum: 10 trend_indicator: type: string enum: - UP - DOWN - EQUAL - NA client_type: $ref: '#/components/schemas/XiqClientType' quality_index_graph: type: array description: The data in the current page items: type: object description: Connectivity experience quality sequence required: - timestamp - value properties: timestamp: type: integer format: int64 value: type: integer minimum: 1 maximum: 10 XiqCopilotConnectivityExperience: allOf: - $ref: '#/components/schemas/XiqPage' - type: object properties: data: type: array description: The data in the current page items: $ref: '#/components/schemas/XiqCopilotConnectivityExperienceEntity' XiqCopilotWiredQualityIndex: type: object description: Wired Connectivity Experience QualityIndex required: - quality_index - hardware_score properties: quality_index: type: integer minimum: 1 maximum: 10 hardware_score: type: integer minimum: 1 maximum: 10 XiqCopilotWiredEventEntity: type: object description: Wired Event Entity required: - device_id - hostname - interface_errors - maximum_errors - mgmt_ip - port - serial_number properties: device_id: type: string hostname: type: string interface_errors: type: number format: double maximum_errors: type: number format: double mgmt_ip: type: string port: type: string serial_number: type: string XiqCopilotWiredEvents: allOf: - $ref: '#/components/schemas/XiqPage' - type: object properties: data: type: array description: The data in the current page items: $ref: '#/components/schemas/XiqCopilotWiredEventEntity' XiqQualityIndex: type: string enum: - LOW - MEDIUM - HIGH XiqCopilotConnectivityByLocationsEntity: type: object description: Copilot Experience Entity required: - id - name - quality_index - quality_index_value - client_type - quality_index_graph properties: id: type: string name: type: string quality_index: type: integer minimum: 1 maximum: 10 quality_index_value: $ref: '#/components/schemas/XiqQualityIndex' client_type: $ref: '#/components/schemas/XiqClientType' quality_index_graph: type: array description: The data in the current page items: type: object description: Connectivity experience quality sequence required: - timestamp - value properties: timestamp: type: integer format: int64 value: type: integer minimum: 1 maximum: 10 XiqCopilotConnectivityByLocations: allOf: - $ref: '#/components/schemas/XiqPage' - type: object properties: data: type: array description: The data in the current page items: $ref: '#/components/schemas/XiqCopilotConnectivityByLocationsEntity' XiqCopilotConnectivityByClientType: type: object description: data sequence required: - sites_by_wireless - sites_by_wired properties: sites_by_wireless: type: object description: The data in the current page required: - low_quality_score_count - medium_quality_score_count - high_quality_score_count - total_quality_score_count properties: low_quality_score_count: type: integer format: int32 medium_quality_score_count: type: integer format: int32 high_quality_score_count: type: integer format: int32 total_quality_score_count: type: integer format: int32 sites_by_wired: type: object description: The data in the current page required: - low_quality_score_count - medium_quality_score_count - high_quality_score_count - total_quality_score_count properties: low_quality_score_count: type: integer format: int32 medium_quality_score_count: type: integer format: int32 high_quality_score_count: type: integer format: int32 total_quality_score_count: type: integer format: int32 XiqCopilotWirelessQualityIndexByLocation: type: object description: Wireless Connectivity Experience QualityIndex required: - quality_index - time_to_connect_score - performance_score - total_clients properties: quality_index: type: integer minimum: 1 maximum: 10 time_to_connect_score: type: integer minimum: 1 maximum: 10 performance_score: type: integer minimum: 1 maximum: 10 total_clients: type: integer format: int32 XiqCopilotTimeToConnectEntity: type: object description: Connectivity experience Time-To-Connect entity required: - timestamp - quality_index - total_clients - time_to_connect_score - above_assoc_threshold - above_auth_threshold - above_dhcp_threshold - time_to_assoc - time_to_auth - time_to_dhcp - performance_score properties: timestamp: type: integer format: int64 quality_index: type: integer minimum: 1 maximum: 10 total_clients: type: integer time_to_connect_score: type: integer minimum: 1 maximum: 10 above_assoc_threshold: type: number format: double above_auth_threshold: type: number format: double above_dhcp_threshold: type: number format: double time_to_assoc: type: integer time_to_auth: type: integer time_to_dhcp: type: integer performance_score: type: integer minimum: 1 maximum: 10 XiqCopilotTimeToConnect: type: object properties: quality_index_graph: type: array description: The data in the current page items: $ref: '#/components/schemas/XiqCopilotTimeToConnectEntity' XiqCopilotPerformanceEntity: type: object description: Connectivity Experience Performance Entity required: - timestamp - quality_index - total_clients - time_to_connect_score - performance_score - snr - retries_data properties: timestamp: type: integer format: int64 quality_index: type: integer minimum: 1 maximum: 10 time_to_connect_score: type: integer minimum: 1 maximum: 10 total_clients: type: integer performance_score: type: integer minimum: 1 maximum: 10 snr: type: integer minimum: 1 maximum: 100 retries_data: type: object description: retry related data required: - rx_retry - tx_retry - above_retry_threshold properties: rx_retry: type: number format: double tx_retry: type: number format: double above_retry_threshold: type: number format: double XiqCopilotPerformance: type: object properties: quality_index_graph: type: array description: The data in the current page items: $ref: '#/components/schemas/XiqCopilotPerformanceEntity' XiqCopilotWirelessEventEntity: type: object description: Wireless Event Entity required: - client_id - hostname - mac - average_value - maximum_value - os_type - threshold - ssid - retries_data properties: client_id: type: string hostname: type: string average_value: type: number format: double maximum_value: type: number format: double mac: type: string os_type: type: string threshold: type: number format: double ssid: type: string retries_data: type: object description: retry related data required: - avg_rx_retry - max_rx_retry - avg_tx_retry - max_tx_retry - rx_retry_threshold - tx_retry_threshold properties: avg_rx_retry: type: number format: double max_rx_retry: type: number format: double avg_tx_retry: type: number format: double max_tx_retry: type: number format: double rx_retry_threshold: type: number format: double tx_retry_threshold: type: number format: double XiqCopilotWirelessEvents: allOf: - $ref: '#/components/schemas/XiqPage' - type: object properties: data: type: array description: The data in the current page items: $ref: '#/components/schemas/XiqCopilotWirelessEventEntity' XiqCopilotHardwareEntity: type: object description: Connectivity Experience Hardware entity required: - timestamp - quality_index - total_switches - affected_ratio properties: timestamp: type: integer format: int64 quality_index: type: integer minimum: 1 maximum: 10 total_switches: type: integer affected_ratio: type: integer minimum: 1 maximum: 100 XiqCopilotHardwareByLocation: type: object description: Wired Connectivity Experience Hardware required: - quality_index_graph - total_ports - total_affected_ports properties: quality_index_graph: type: array description: The data in the current page items: $ref: '#/components/schemas/XiqCopilotHardwareEntity' total_ports: type: integer format: int32 total_affected_ports: type: integer format: int32 XiqFlapCountEntity: type: object description: data sequence required: - timestamp - flap_count - sub_optimal_count - optimal_time_spent properties: timestamp: type: integer format: int64 flap_count: type: integer sub_optimal_count: type: integer optimal_time_spent: type: number format: double XiqCopilotPoeFlappingStats: type: object properties: flap_count_entities: type: array description: The data in the current page items: $ref: '#/components/schemas/XiqFlapCountEntity' XiqDuplexDataRateEntity: type: object description: data sequence required: - timestamp - duplex_mode - datarate_mode properties: timestamp: type: integer format: int64 duplex_mode: type: integer datarate_mode: type: integer XiqCopilotPortEfficiencyStats: type: object properties: duplex_data_rate_entities: type: array description: The data in the current page items: $ref: '#/components/schemas/XiqDuplexDataRateEntity' XiqSpeedDuplexEntity: type: object description: data sequence required: - timestamp - value properties: timestamp: type: integer format: int64 value: type: integer XiqCopilotPortEfficiencySpeedDuplex: type: object properties: speed_duplex_entities: type: array description: The data in the current page items: $ref: '#/components/schemas/XiqSpeedDuplexEntity' XiqCountStatsEntity: type: object description: data sequence required: - timestamp - count properties: timestamp: type: integer format: int64 count: type: integer XiqCopilotDfsRecurrenceCountStats: type: object description: data sequence required: - dfs_channel_changes_entity - normal properties: dfs_channel_changes_entity: type: array description: The data in the current page items: $ref: '#/components/schemas/XiqCountStatsEntity' normal: type: integer XiqChannelStatsEntity: type: object description: data sequence required: - timestamp - channel_number properties: timestamp: type: integer format: int64 channel_number: type: integer XiqCopilotDFSRecurrenceChannelStats: type: object description: data sequence required: - dfs_channel_stats_entity - min_channel - max_channel properties: dfs_channel_stats_entity: type: array description: The data in the current page items: $ref: '#/components/schemas/XiqChannelStatsEntity' min_channel: type: integer max_channel: type: integer XiqATPDeviceStatEntity: type: object description: data sequence required: - timestamp - avg_cpu - avg_memory - avg_client_count properties: timestamp: type: integer format: int64 avg_cpu: type: number format: double avg_memory: type: number format: double avg_client_count: type: integer XiqCopilotATPDeviceStats: type: object properties: atp_device_stat_entities: type: array description: The data in the current page items: $ref: '#/components/schemas/XiqATPDeviceStatEntity' XiqATPPacketCountsEntity: type: object description: data sequence required: - timestamp - unicast_tx - unicast_rx - multicast_tx - multicast_rx - broadcast_tx - broadcast_rx properties: timestamp: type: integer format: int64 unicast_tx: type: integer format: int64 unicast_rx: type: integer format: int64 multicast_tx: type: integer format: int64 multicast_rx: type: integer format: int64 broadcast_tx: type: integer format: int64 broadcast_rx: type: integer format: int64 XiqCopilotATPPacketCounts: type: object properties: atp_packet_counts_entities: type: array description: The data in the current page items: $ref: '#/components/schemas/XiqATPPacketCountsEntity' XiqTxRxStatsDataEntity: type: object description: data sequence required: - timestamp - data_rate_failure_percent - client_count - normal_failure_percent properties: timestamp: type: integer format: int64 data_rate_failure_percent: type: number format: double client_count: type: integer format: int32 normal_failure_percent: type: integer XiqCopilotWifiEfficiencyStats: type: object description: data sequence required: - total_client_sessions - show_tx_data - sessions_data properties: total_client_sessions: type: integer format: int64 show_tx_data: type: boolean sessions_data: type: array description: The data in the current page items: $ref: '#/components/schemas/XiqTxRxStatsDataEntity' XiqClientStatsEntity: type: object description: data sequence required: - client_mac - client_name - client_host_os - avg_snr - avg_tx_rate - avg_rx_rate - client_id properties: client_mac: type: string client_name: type: string client_host_os: type: string avg_snr: type: integer avg_tx_rate: type: integer avg_rx_rate: type: integer client_id: type: integer format: int64 XiqCopilotWifiEfficiencyClientlist: type: object properties: client_stats_entities: type: array description: The data in the current page items: $ref: '#/components/schemas/XiqClientStatsEntity' XiqDeviceStatsEntity: type: object description: data sequence required: - timestamp - avg_interference_utilization - avg_tx_utilization - avg_rx_utilization - avg_total_channel_utilization - avg_num_clients - normal_interference properties: timestamp: type: integer format: int64 avg_interference_utilization: type: integer avg_tx_utilization: type: integer avg_rx_utilization: type: integer avg_total_channel_utilization: type: integer avg_num_clients: type: integer normal_interference: type: integer XiqCopilotWifiCapacityStats: type: object properties: device_stats: type: array description: The data in the current page items: $ref: '#/components/schemas/XiqDeviceStatsEntity' HealthScoreType: type: string enum: - GOOD - MEDIUM - POOR XiqClientWifiStatsEntity: type: object description: data sequence required: - client_mac - client_name - client_host_os - avg_snr - avg_rssi - health_score - client_id properties: client_mac: type: string client_name: type: string client_host_os: type: string avg_snr: type: integer avg_rssi: type: integer health_score: type: array description: The health score type items: $ref: '#/components/schemas/HealthScoreType' client_id: type: integer format: int64 XiqCopilotWifiCapacityClientlist: type: object properties: client_wifi_stats: type: array description: The data in the current page items: $ref: '#/components/schemas/XiqClientWifiStatsEntity' XiqAnomaliesCount: type: object description: data sequence required: - timestamp - total_anomalies_count - wifi_efficiency_count - wifi_capacity_count - poe_count - pe_count - dfs_count - mb_cast_count - hardware_health_count - missing_vlan_count properties: timestamp: type: integer format: int64 total_anomalies_count: type: integer format: int64 wifi_efficiency_count: type: integer format: int64 wifi_capacity_count: type: integer format: int64 poe_count: type: integer format: int64 pe_count: type: integer format: int64 dfs_count: type: integer format: int64 mb_cast_count: type: integer format: int64 hardware_health_count: type: integer format: int64 missing_vlan_count: type: integer format: int64 XiqCopilotAssuranceScansOverview: type: object description: data sequence required: - aggregated_scans_count - anomalies_count properties: aggregated_scans_count: type: integer format: int64 anomalies_count: type: array description: The data in the current page items: $ref: '#/components/schemas/XiqAnomaliesCount' XiqAnomalyType: type: string enum: - POE_STABILITY - DFS_RECURRENCE - ADVERSE_TRAFFIC - PORT_EFFICIENCY - WIFI_CAPACITY - WIFI_EFFICIENCY - HARDWARE_HEALTH - MISSING_VLAN XiqFeedbackType: type: string enum: - LIKE - DISLIKE XiqAnomaliesFeedbackRequest: type: object description: The feedback request properties: anomalyType: $ref: '#/components/schemas/XiqAnomalyType' anomalyId: type: string feedbackType: $ref: '#/components/schemas/XiqFeedbackType' feedback: type: string XiqCopilotAnomaliesSuccess: type: object description: value required: - success properties: success: type: boolean XiqAnomalySeverity: type: string enum: - LOW - MEDIUM - HIGH XiqAnomaliesSiteEntity: type: object description: data sequence required: - building_id - location_name - anomalies_count_by_location properties: building_id: type: integer format: int64 location_name: type: string anomalies_count_by_location: type: integer format: int32 XiqAnomaliesTypeEntity: type: object description: data sequence required: - anomaly_type - anomalies_count_by_type properties: anomaly_type: $ref: '#/components/schemas/XiqAnomalyType' anomalies_count_by_type: type: integer format: int32 XiqCopilotAnomaliesByCategory: type: object description: data sequence required: - anomalies_by_location - anomalies_by_severity - anomalies_by_type properties: anomalies_by_location: type: array description: The data in the current page items: $ref: '#/components/schemas/XiqAnomaliesSiteEntity' anomalies_by_severity: type: object description: The data in the current page required: - low_severity_anomalies_count - medium_severity__anomalies_count - high_severity_anomalies_count - anomalies_count_by_severity properties: low_severity_anomalies_count: type: integer format: int32 medium_severity_anomalies_count: type: integer format: int32 high_severity_anomalies_count: type: integer format: int32 anomalies_count_by_severity: type: integer format: int32 anomalies_by_type: type: array description: The data in the current page items: $ref: '#/components/schemas/XiqAnomaliesTypeEntity' XiqDeviceCategory: type: string enum: - WIRED - WIRELESS XiqCopilotMissingVlanAffectedDevicesEntity: type: object required: - ap_device_id - ap_name - upstream_switch_interface - missing_vlans properties: ap_device_id: type: integer format: int64 ap_name: type: string upstream_switch_interface: type: string missing_vlans: type: array items: type: integer XiqCopilotMissingVlanInfo: type: object required: - lldp_enabled - upstream_switch_name - floor_name - affected_devices_entity properties: lldp_enabled: type: boolean upstream_switch_name: type: string floor_name: type: string affected_devices_entity: type: array items: $ref: '#/components/schemas/XiqCopilotMissingVlanAffectedDevicesEntity' XiqAnomalyDeviceWithLocation: type: object description: Anomaly Location Entity required: - building_id - location_name - muted - severity - anomaly_type - last_detected_time - device_id - device_name - device_model - device_make - switch_stack - category - interface_name - location_id - anomaly_id - channel_mode - frequency - recommended_action - issue - anomaly_subtypes - missing_vlan_info properties: building_id: type: integer format: int64 location_name: type: string muted: type: boolean severity: $ref: '#/components/schemas/XiqAnomalySeverity' anomaly_type: $ref: '#/components/schemas/XiqAnomalyType' last_detected_time: type: integer format: int64 device_id: type: integer format: int64 device_name: type: string device_model: type: string device_make: type: string switch_stack: type: boolean category: $ref: '#/components/schemas/XiqDeviceCategory' interface_name: type: string location_id: type: integer format: int64 anomaly_id: type: string channel_mode: type: string frequency: type: string recommended_action: type: string issue: type: string anomaly_subtypes: type: string missing_vlan_info: $ref: '#/components/schemas/XiqCopilotMissingVlanInfo' XiqCopilotAnomaliesDevicesWithLocation: allOf: - $ref: '#/components/schemas/XiqPage' - type: object description: The devices and location entity data required: - anomaly_details - affected_count properties: anomaly_details: type: array description: The data in the current page items: $ref: '#/components/schemas/XiqAnomalyDeviceWithLocation' affected_count: type: object description: The data in the current page required: - total_anomaly_count - affected_location_count - affected_devices_count properties: total_anomaly_count: type: integer format: int32 affected_location_count: type: integer format: int32 affected_devices_count: type: integer format: int32 XiqUpdateActionAnomalyDetails: type: object description: Update Action Anomaly Details Entity required: - buildingId - locationId - anomalyId - anomalyType properties: buildingId: type: integer format: int64 locationId: type: integer format: int64 anomalyId: type: string anomalyType: $ref: '#/components/schemas/XiqAnomalyType' XiqActionType: type: string enum: - MUTE - UNMUTE - DISMISSED XiqUpdateAnomaliesAndDevicesRequest: type: object description: The device update action request required: - anomalyDetails - actionType properties: anomalyDetails: type: array description: The data in the current page items: $ref: '#/components/schemas/XiqUpdateActionAnomalyDetails' actionType: $ref: '#/components/schemas/XiqActionType' XiqCopilotAnomaliesDetails: type: object description: Anomaly Devices & Location Entity required: - location_name - severity - anomaly_type - last_detected_time - device_name - category - interface_name properties: location_name: type: string severity: $ref: '#/components/schemas/XiqAnomalySeverity' anomaly_type: $ref: '#/components/schemas/XiqAnomalyType' last_detected_time: type: integer format: int64 device_name: type: string category: $ref: '#/components/schemas/XiqDeviceCategory' interface_name: type: string XiqCopilotAnomaliesReport: allOf: - type: object description: The devices and location entity data required: - anomaly_details properties: anomaly_details: type: array description: The data in the current page items: $ref: '#/components/schemas/XiqCopilotAnomaliesDetails' XiqTrendGraphEntity: type: object description: power mode trends required: - timestamp properties: timestamp: type: integer format: int64 power_mode: type: string XiqPoeTrendGraphsResponse: type: object properties: trend_graph_entities: type: array description: The data in the current page items: $ref: '#/components/schemas/XiqTrendGraphEntity' XiqAffectedDownlinkDevice: type: object description: Copilot Anomaly Affected Downlink Devices Details required: - host_name - product_type - interface_name - port_id - last_detected_time properties: host_name: type: string description: host name of affected downlink device product_type: type: string description: model of affected downlink device interface_name: type: string description: interface name of affected downlink device port_id: type: string description: port ID of affected downlink device last_detected_time: type: integer description: last detected timestamp format: int64 XiqUnaffectedDownlinkDevice: type: object description: Copilot Anomaly Unaffected Downlink Devices Details required: - host_name - product_type - interface_name - port_id properties: host_name: type: string description: host name of unaffected downlink device product_type: type: string description: model of unaffected downlink device interface_name: type: string description: interface name of unaffected downlink device port_id: type: string description: port ID of unaffected downlink device XiqPowerSourceEquipment: type: object description: Copilot LLdp-Cdp Info For Anomalous Access Points required: - is_lldp_cdp_enabled - affected_downlink_devices - unaffected_downlink_devices properties: is_lldp_cdp_enabled: type: boolean uplink_switch_system_name: type: string uplink_switch_system_id: type: string uplink_switch_device_id: type: integer format: int64 location_name: type: string floor_name: type: string 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' XiqCopilotLldpCdpInfo: type: object description: Copilot Anomalies LLdp-Cdp Info Response properties: lldp_cdp_info: type: object description: The data in the current page $ref: '#/components/schemas/XiqPowerSourceEquipment' XiqCopilotVlanSiteDetails: description: Details of a site type: object required: - site_name - site_id properties: site_id: type: integer format: int64 site_name: type: string XiqCopilotExcludedVlanDetailsEntity: type: object description: Excluded Vlan details Entity required: - vlan_id - site_details properties: vlan_id: type: integer format: int64 site_details: type: array items: $ref: '#/components/schemas/XiqCopilotVlanSiteDetails' XiqCopilotExceptionalVlanList: allOf: - $ref: '#/components/schemas/XiqPage' - type: object description: data sequence required: - excluded_vlan_details properties: excluded_vlan_details_entity: type: array description: The data in the current page items: $ref: '#/components/schemas/XiqCopilotExcludedVlanDetailsEntity' XiqCopilotVlanDetailsEntity: type: object description: details of vlans to be excluded from sites required: - vlan_ids - site_ids properties: vlan_ids: type: array items: type: integer format: int64 site_ids: type: array items: type: integer format: int64 XiqCopilotActionType: description: type of action to be performed type: string enum: - ADD - UPDATE - DELETE XiqCopilotAnomaliesSiteEntity: type: object description: data sequence required: - site_id - site_name - anomalies_count properties: site_id: type: integer format: int64 site_name: type: string anomalies_count: type: integer format: int64 XiqCopilotMissingVlanCount: type: object description: data sequence required: - total_anomalies_count - anomalies_count_by_site properties: total_anomalies_count: type: integer format: int64 anomalies_count_by_site: type: array description: The data in the current page items: $ref: '#/components/schemas/XiqCopilotAnomaliesSiteEntity' XiqHardwareHealthDeviceStatsEntity: type: object description: data sequence required: - timestamp - avg_cpu_utilization - avg_memory_utilization - avg_client_count - unit_temperature - poe_power_mode properties: timestamp: type: integer format: int64 avg_cpu_utilization: type: number format: double avg_memory_utilization: type: number format: double avg_client_count: type: integer unit_temperature: type: number format: double poe_power_mode: type: string XiqHardwareHealthPacketCountsEntity: type: object description: data sequence required: - timestamp - unicast_tx - unicast_rx - multicast_tx - multicast_rx - broadcast_tx - broadcast_rx - throughput properties: timestamp: type: integer format: int64 unicast_tx: type: integer format: int64 unicast_rx: type: integer format: int64 multicast_tx: type: integer format: int64 multicast_rx: type: integer format: int64 broadcast_tx: type: integer format: int64 broadcast_rx: type: integer format: int64 throughput: type: integer format: int64 XiqHardwareHealthRebootStatsEntity: type: object description: data sequence required: - timestamp - reboot_code properties: timestamp: type: integer format: int64 reboot_code: type: integer format: int64 XiqCopilotHardwareHealthStats: allOf: - type: object description: data sequence required: - hardware-health_device_stats_entities - hardware-health_packet_counts_entities - hardware-health_reboot_stats_entities properties: hardware-health_device_stats_entities: type: array description: The data in the current page items: $ref: '#/components/schemas/XiqHardwareHealthDeviceStatsEntity' hardware-health_packet_counts_entities: type: array description: The data in the current page items: $ref: '#/components/schemas/XiqHardwareHealthPacketCountsEntity' hardware-health_reboot_stats_entities: type: array description: The data in the current page items: $ref: '#/components/schemas/XiqHardwareHealthRebootStatsEntity' XiqHardwareHealthClientStatsEntity: type: object description: data sequence required: - client_mac - client_name - client_host_os - avg_snr - health_score - client_id properties: client_mac: type: string client_name: type: string client_host_os: type: string avg_snr: type: integer health_score: type: array description: The health score type items: $ref: '#/components/schemas/HealthScoreType' client_id: type: integer format: int64 XiqCopilotHardwareHealthClientlist: type: object properties: client_stats_entities: type: array description: The data in the current page items: $ref: '#/components/schemas/XiqHardwareHealthClientStatsEntity' XiqAnomalyHhStatsType: type: string enum: - CPU_STATS - MEMORY_STATS XiqHardwareHealthCpuMemStatsEntity: type: object description: data sequence required: - timestamp - stats_ten_secs - stats_twenty_secs - stats_thirty_secs properties: timestamp: type: integer format: int64 stats_ten_secs: type: string stats_twenty_secs: type: string stats_thirty_secs: type: string XiqCopilotHardwareHealthCpuMemStats: type: object properties: cpu_memory_stats_entity: type: array description: The data in the current page items: $ref: '#/components/schemas/XiqHardwareHealthCpuMemStatsEntity' XiqPacketCaptureField: type: string enum: - ID - ORG_ID - NAME - CAPTURE_ID_TYPE - AP_SERIAL_NUMBER - DEVICE_IDS - LOCATION_ID - DURATION - DESTINATION - FILTER - CAPTURE_IF - START_TIME - END_TIME - STATUS - CLOUD_STORAGE - RESULTS XiqSerialNumber: type: object description: The globally unique serial number of the device being registered. The serial number is represented as a string. properties: ap_serial_number: type: string pattern: "^[\\p{Print}&&[^\t\n\r;:&\\p{Cntrl}'\"]]{1,16}$" XiqDeviceIds: type: object description: The device ID list. properties: device_ids: type: array items: type: integer description: The device ID format: int64 XiqLocationId: type: object description: The assigned location ID, it must be FLOOR type properties: location_id: type: integer format: int64 XiqCaptureIdentifier: type: object description: Identifier for AP device selections. APs can be selected using the AP serial number, a list of device numeric IDs or the location ID. required: - capture_id_type properties: capture_id_type: description: The capture identifier type for selecting the APs. Depending on the type, one of "AP_SERIAL_NUMBER", "DEVICE_IDS" and "LOCATION" must be provided. type: string enum: - AP_SERIAL_NUMBER - DEVICE_IDS - LOCATION anyOf: - $ref: '#/components/schemas/XiqSerialNumber' - $ref: '#/components/schemas/XiqDeviceIds' - $ref: '#/components/schemas/XiqLocationId' discriminator: propertyName: capture_id_type mapping: AP_SERIAL_NUMBER: '#/components/schemas/XiqSerialNumber' DEVICE_IDS: '#/components/schemas/XiqDeviceIds' LOCATION: '#/components/schemas/XiqLocationId' XiqDestinationType: title: XiqDestinationType type: string description: The destination for the packet capture files. CLOUD for XIQ cloud storage. CLOUD_SHARK for sending the capture files to CloudShark, in addition to XIQ cloud storage. enum: - CLOUD - CLOUD_SHARK example: CLOUD XiqPolicyRuleProtocolType: type: string title: XiqPolicyRuleProtocolType description: Protocol type to filter by. enum: - ANY - USER_DEFINED - ICMP - ICMPV6 - TCP - UDP - GRE - IPSEC_ESP - IPSEC_AH default: ANY example: ANY XiqCaptureFilter: title: XiqCaptureFilter description: This represents the properties of filters used for the packet capture. allOf: - type: object properties: mac_addr: type: array items: type: string description: A string containing the client MAC address used for packet capturing. ip_addr: type: array items: type: string description: A string containing the client IP addresses used to filter the packets. protocol: $ref: '#/components/schemas/XiqPolicyRuleProtocolType' protocol_number: type: integer format: int32 description: The protocol number if protocol is "USER_DEFINED". 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. example: mac_addr: - '...' - '...' ip_addr: - '...' - '...' protocol: any port: 12345 vlan: 2,4,5-10 XiqCaptureDirectionSelection: type: string title: XiqCaptureDirectionSelection description: The capture traffic direction enum: - OUT - IN - BOTH default: BOTH example: BOTH XiqCaptureWiredSelection: type: string title: XiqCaptureWiredSelection description: Wired interface to filter by. enum: - ALL - ETH0 - ETH1 - ETH2 - ETH3 example: ETH0 XiqWiredFilterType: type: string title: XiqWiredFilterType description: Pre-defined filters for wired packet captures. enum: - DHCP - RADIUS - LLDP - ARP - MDNS example: DHCP XiqCaptureRadioSelection: type: string title: XiqCaptureRadioSelection description: Wireless radio type to filter by. enum: - ALL - RADIO1 - RADIO2 - RADIO3 example: RADIO1 XiqCaptureBandSelection: type: string title: XiqCaptureBandSelection description: Wireless band to filter by. enum: - ALL - 2.4GHZ - 5GHZ - 6GHZ default: ALL example: 2.4GHZ XiqWirelessFilterType: type: string title: XiqWirelessFilterType description: Pre-defined filters for wireless packet captures. enum: - MANAGEMENT - CONTROL - DATA - EAPOL - BEACONS - PROBES example: DATA XiqCaptureLocation: title: XiqCaptureLocation description: This represents the options for location packet capture. allOf: - type: object properties: direction: $ref: '#/components/schemas/XiqCaptureDirectionSelection' wired_interface: description: The name of the wired interface to capture. Set to ALL for all interfaces. $ref: '#/components/schemas/XiqCaptureWiredSelection' wired_filters: type: array description: The list of pre-defined wired filters for packet capture items: $ref: '#/components/schemas/XiqWiredFilterType' radio: description: The wireless radio to capture. Set to ALL for all radios. $ref: '#/components/schemas/XiqCaptureRadioSelection' wireless_band: description: The wireless band to capture. Set to ALL for all bands. $ref: '#/components/schemas/XiqCaptureBandSelection' wireless_filters: type: array description: The list of pre-defined wireless filters for packet capture items: $ref: '#/components/schemas/XiqWirelessFilterType' example: direction: Both wired_interface: ETH0 wireless_band: 2.4GHZ wireless_filters: - MANAGEMENT - CONTROL XiqPktCaptureStatus: type: string title: XiqPktCaptureStatus description: The status of the overall packet capture session or a packet capture result on an AP device's interface. enum: - INITIAL - ACTIVE - SUCCESS - PARTIAL_SUCCESS - FAILED default: INITIAL example: ACTIVE XiqCloudSharkStorage: type: object title: XiqCloudSharkStorage description: The packet capture file name and URL in CloudShark. properties: file_name: type: string file_url: type: string example: file_name: 2023051105924UTC-241FBD8FEDC0-wifi0.pcap file_url: https://www.cloudshark.org/captures/f27d1494400c XiqCaptureResult: title: XiqCaptureResult description: This represents the packet capture result on an AP's interface. A packet capture session may involve multiple APs on multiple interfaces. allOf: - type: object properties: id: type: integer description: The unique identifier format: int64 start_time: type: string description: The packet capture start time format: date-time end_time: type: string description: The packet capture end time format: date-time org_id: type: integer description: The organization identifier, valid when enabling HIQ feature format: int64 device_id: type: integer description: The device identifier format: int64 interface: type: string description: The interface name such as "WIFI0", "WIFI1", "ETH0", etc. hostname: type: string description: The device host name such as "US-MIL-1" mac_address: type: string description: The device MAC address such as "AABBCC001122" location_id: type: integer description: The location ID format: int64 locations: type: array description: The detailed location items: $ref: '#/components/schemas/XiqLocationLegend' status: description: The status of the packet capture result allOf: - $ref: '#/components/schemas/XiqPktCaptureStatus' error_message: type: string description: The error message (may be empty). storage: type: object description: The packet capture file storage properties: cloud_shark_storage: description: CloudShark file info when destination is CloudShark allOf: - $ref: '#/components/schemas/XiqCloudSharkStorage' cloud_storage: description: XIQ cloud storage location after a packet capture is completed. type: string XiqPacketCapture: title: XiqPacketCapture description: This represents the packet capture session allOf: - $ref: '#/components/schemas/XiqCaptureIdentifier' - type: object properties: id: type: integer description: The unique identifier format: int64 org_id: type: integer description: The organization identifier, valid when enabling HIQ feature format: int64 name: description: The packet capture session name. If the name is null or empty, it will be auto generated. type: string pattern: ^[A-Z0-9.-_]{0,128}$ duration: type: integer format: int32 maximum: 604800 minimum: 5 description: An integer containing the set packet capture duration in seconds, from 5 to a maximum of 604800 seconds (1 week). If not manually stopped, packet capture continues until the specified duration is reached, or the platform-maximum file size of the AP is reached. If duration is set to 0 or unspecified, capture stops when platform-maximum size is reached. destination: $ref: '#/components/schemas/XiqDestinationType' filter: $ref: '#/components/schemas/XiqCaptureFilter' capture_if: $ref: '#/components/schemas/XiqCaptureLocation' start_time: type: string readOnly: true description: The packet capture start time format: date-time end_time: type: string readOnly: true description: The packet capture end time format: date-time status: readOnly: true description: The status of the packet capture session allOf: - $ref: '#/components/schemas/XiqPktCaptureStatus' cloud_storage: description: XIQ cloud storage location for the archive of all capture files in this capture session, if available. type: string results: type: array readOnly: true description: The list of packet capture results - a PacketCaptureResult for each device's interface items: $ref: '#/components/schemas/XiqCaptureResult' PagedXiqPacketCapture: allOf: - $ref: '#/components/schemas/XiqPage' - type: object properties: data: type: array description: The data in the current page items: $ref: '#/components/schemas/XiqPacketCapture' XiqCaptureStopRequest: title: XiqCaptureStopRequest description: This represents the request for stopping a packet capture session. properties: device_ids: type: array description: The IDs of the devices for which the active packet capture is to be stopped. If empty, packet capture is to be stopped on all devices in this packet capture. items: type: integer description: The device ID format: int64 XiqEssentialsElocClientLastknownLocation: 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 format: date-time x: type: number description: The located client's last known horizontal value on the floor plan format: double y: type: number description: The located client's last known vertical value on the floor plan format: double XiqCountry: type: object description: The country list and country codes. required: - alpha2_code - country_code - short_name properties: dial_code: description: The dialing code for international calls, typically prefixed by the '+' key for mobile. type: string alpha2_code: description: The country ISO 2-letter code. type: string country_code: description: The country ISO numeric code. format: int32 maximum: 999 minimum: 1 type: integer internal_country_codes: description: Extreme IQ internal country codes. items: description: Extreme IQ internal country codes. format: int32 type: integer type: array short_name: description: The country short name. type: string name_en: description: The country official name in English. type: string name_jp: description: The country official name in Japanese. type: string name_fr: description: The country official name in French. type: string name_de: description: The country official name in German. type: string name_it: description: The country official name in Italian. type: string name_pt: description: The country official name in Portuguese. type: string name_zh: description: The country official name in Chinese. type: string name_es: description: The country official name in Spanish. type: string name_ko: description: The country official name in Korean. type: string XiqCountryState: type: object description: The states list of a country. required: - country_code - code - name properties: country_code: description: The country ISO 2-letter code. type: string code: description: The state or province code. type: string name: description: The state or province name. type: string ViewAlarmsResponse: type: array items: properties: id: description: internal id of the alarm instance type: string minLength: 4 example: 5cedee19-2219-404e-bc4b-964a5e3b6bae raised_date_time: description: timestamp when the alarm was raised type: integer format: int64 example: 1652607240 cleared_date_time: description: timestamp when the alarm was cleared (applicable only to cleared alarms) type: integer format: int64 example: 1652607380 local_appliance_id: description: local appliance id type: integer format: int64 example: 64102141172 local_appliance_name: description: local appliance name type: string minLength: 4 example: ebx-02 local_appliance_serial_number: description: local appliance serial number type: string minLength: 4 example: A0518X0005A0 remote_appliance_id: description: remote appliance id type: integer format: int64 example: 64108151319 remote_appliance_name: description: remote appliance name type: string minLength: 4 example: ebx-03 remote_appliance_serial_number: description: remote appliance serial number type: string minLength: 4 example: N0815K0319A0 local_site_id: description: local site id type: integer format: int64 example: 2 local_site_name: description: local site name type: string minLength: 4 example: Site 02 remote_site_id: description: local site id type: integer format: int64 example: 3 remote_site_name: description: remote site name type: string minLength: 4 example: Site 03 alarm_name: description: unique alarm name type: string minLength: 4 example: tunnel-failure alarm_description: description: human readable alarm name type: string minLength: 4 example: Tunnel Failure details: description: specific details about the alarm type: string minLength: 4 example: No other appliance in local site severity: description: severity of the alarm type: string minLength: 4 example: critical layer: description: category type: string minLength: 4 example: Underlay state: description: status of the alarm type: string minLength: 4 example: cleared ViewAlarmsResponsePaged: allOf: - $ref: '#/components/schemas/XiqPage' - type: object properties: data: $ref: '#/components/schemas/ViewAlarmsResponse' Error: required: - status - title - detail type: object properties: status: type: integer title: type: string detail: type: string AlarmSeverityCountResponseObject: type: object properties: total: description: total count of active alarms type: integer format: int32 example: 10 detail: description: count of active alarms for each severity(critical, major, minor) type: array items: properties: severity: description: severity of the alarm type: string minLength: 4 example: major count: description: count of alarms for the given severity type: integer format: int32 example: 10 AlarmSeverityCountResponse: type: object properties: data: description: Alarm active count per severity $ref: '#/components/schemas/AlarmSeverityCountResponseObject' SitesSummaryResponse: type: object properties: data: description: Sites Summary Response type: array items: properties: sites_count: description: total sites count type: integer format: int32 example: 14 average_throughput: description: average throughput across all the sites as of now type: number format: double example: 370 ViewAppliancesSummaryResponse: type: object properties: data: description: Appliances Summary Response type: array items: type: object properties: appliances_connected: description: connected appliances count type: integer format: int32 example: 18 appliances_disconnected: description: disconnected appliances count type: integer format: int32 example: 2 ViewWansSummaryResponse: type: object properties: data: description: Wan Services Summary Response type: array items: type: object properties: wans_count: description: total wan services count type: integer format: int32 example: 4 ApplicationsSummaryResponse: type: object properties: data: description: Applications Summary Response type: array items: properties: saas_applications: description: saas applications count type: integer format: int32 example: 300 dpi_applications: description: dpi applications count type: integer format: int32 example: 100 average_eqs: description: average eqs across all the applications as of now type: number example: 6.5 format: double ViewConnectionsResponse: type: array items: properties: initiator_appliance_id: description: The initiator appliance ID type: integer format: int64 example: 542024882680 responder_appliance_id: description: The responder appliance ID type: integer format: int64 example: 542024882681 initiator_appliance_name: description: The initiator appliance name type: string example: APPLIANCE-01 responder_appliance_name: description: The responder appliance name type: string example: APPLIANCE-02 initiator_site_id: description: This is the initiator site ID type: integer format: int64 example: 542024882780 responder_site_id: description: This is the responder site ID type: integer format: int64 example: 5420248827781 initiator_site_name: description: The initiator site name type: string example: SITE-01 responder_site_name: description: The responder site name type: string example: SITE-02 initiator_interface: description: The initiator interface name type: string minLength: 1 example: wan1 responder_interface: description: The responder interface name type: string minLength: 1 example: wan2 overlay_id: description: The overlay ID type: integer format: int64 example: 20 overlay_name: description: The overlay name type: string minLength: 1 example: MPLS1 status_id: description: The overlay status ID (up/down) type: string minLength: 1 example: up status: description: The overlay status type: string minLength: 1 example: Up type_id: description: The overlay type ID type: string enum: - vti - gre - gre_user - zsc - csec - sdi - aws - azure minLength: 1 example: gre type: description: The overlay type type: string minLength: 1 example: Overlay ViewConnectionsResponsePaged: allOf: - $ref: '#/components/schemas/XiqPage' - type: object properties: data: $ref: '#/components/schemas/ViewConnectionsResponse' TunnelSite: type: array items: properties: id: description: Site ID type: integer example: 5420248827679 format: int64 site_name: description: Site name type: string example: SITE-01 location: description: Site location type: string example: 23 Av. Carnot | Massy | Île-de-France | 91300 |France map_position: description: Site coordinates type: object properties: lat: description: Latitude type: number format: double example: 48.7270491 lng: description: Longitude type: number format: double example: 2.2644208 alarm: description: The site alarmed condition, if set to true it means site is at active alarmed state. type: boolean example: true TunnelSiteResponse: type: object properties: data: description: Connection site data $ref: '#/components/schemas/TunnelSite' QuerryPage: type: integer format: int32 example: 5 QuerryPageSize: type: integer format: int32 example: 10 TunnelInfo: type: array items: properties: initiator_appliance_id: description: The initiator appliance ID type: integer format: int64 example: 542024882680 responder_appliance_id: description: The responder appliance ID type: integer format: int64 example: 542024882681 initiator_appliance_name: description: The initiator appliance name type: string example: APPLIANCE-01 responder_appliance_name: description: The responder appliance name type: string example: APPLIANCE-02 initiator_site_id: description: This is the initiator site ID type: integer format: int64 example: 542024882780 responder_site_id: description: This is the responder site ID type: integer format: int64 example: 5420248827781 initiator_site_name: description: The initiator site name type: string example: SITE-01 responder_site_name: description: The responder site name type: string example: SITE-02 initiator_interface: description: The initiator interface name type: string minLength: 1 example: wan1 responder_interface: description: The responder interface name type: string minLength: 1 example: wan2 overlay_id: description: The overlay ID type: integer format: int64 example: 20 overlay_name: description: The overlay name type: string minLength: 1 example: MPLS1 status_id: description: The overlay status ID type: string enum: - up - down minLength: 1 example: up status: description: The overlay status type: string minLength: 1 example: Up type_id: description: The overlay type ID type: string enum: - vti - gre - gre_user - zsc - csec - sdi - aws - azure minLength: 1 example: gre type: description: The overlay type type: string minLength: 1 example: Overlay color_id: description: color_id is the unique number specifying a color that will be picked from the pool of colors maintained by Frontend in order to display each overlay distinctly. type: integer format: int32 example: 1 TunnelInfoData: type: object properties: data: description: Connection info data $ref: '#/components/schemas/TunnelInfo' TunnelInfoResponse: allOf: - $ref: '#/components/schemas/TunnelInfoData' - $ref: '#/components/schemas/XiqPage' application-metrics-summary: type: object description: Array of Object containing application overview summary details group by Application, Application Group or criticality properties: application_id: description: application Id type: number example: 5455656 application_name: description: application name type: string example: webex criticality: description: criticality type: string example: Top eqs: description: eqs value type: number format: double example: 9.55 throughput: description: throughput value type: number format: double example: 5553434.56 volume: description: volume value type: number format: double example: 44567.55 ApplicationMetricsSummaryInfoList_application-metrics-summary: type: array description: Array of Object containing application overview summary details group by Application, Application Group or criticality items: description: Object containing application summary Data $ref: '#/components/schemas/application-metrics-summary' TimeRange: type: object properties: start_time: description: start of the time-range. unit is seconds type: integer format: int64 example: 1654150860 end_time: description: end of the time-range. unit is seconds type: integer format: int64 example: 1654236480 resolution: description: time interval for aggregation. unit is seconds type: integer format: int64 example: 600 ApplicationsMetricsSummaryResponse: type: object properties: data: description: Returns Filtered summary data $ref: '#/components/schemas/ApplicationMetricsSummaryInfoList_application-metrics-summary' time_range: description: The timeRange response $ref: '#/components/schemas/TimeRange' pagination: description: The pagination response $ref: '#/components/schemas/XiqPage' FlowDirection: type: string enum: - lan_to_wan - wan_to_lan example: lan_to_wan default: lan_to_wan ApplicationGroupsEqsPerCriticality: type: object properties: top: description: application groups for criticality top type: array items: description: List of application groups type: object properties: application_group_id: description: application group id type: integer format: int64 example: 12234 application_group_name: description: application group name type: string example: BusinessApp application_group_eqs: description: EQS value between 0 - 10 type: number example: 9.85 high: description: application groups for criticality high type: array items: description: List of application groups type: object properties: application_group_id: description: application group id type: integer format: int64 example: 12231 application_group_name: description: application group name type: string example: ThinClient application_group_eqs: description: EQS value between 0 - 10 type: number example: 9.85 medium: description: application groups for criticality medium type: array items: description: List of application groups type: object properties: application_group_id: description: application group id type: integer format: int64 example: 12234 application_group_name: description: application group name type: string example: BackOffice application_group_eqs: description: EQS value between 0 - 10 type: number example: 9.85 low: description: application groups for criticality low type: array items: description: List of application groups type: object properties: application_group_id: description: application group id type: integer format: int64 example: 12234 application_group_name: description: application group name type: string example: Internet application_group_eqs: description: EQS value between 0 - 10 type: number example: 9.85 SitesOverview: type: array items: properties: site_id: description: site_src_id/site_dst_id type: integer format: int64 example: 1234 site_name: description: The site name. type: string example: Cloud Services appliance_id: description: appliance_src_id/appliance_dst_id type: integer format: int64 example: 1234 appliance_name: description: appliance name. type: string example: app1 wan_interface: description: nap_src_index/nap_dst_index type: integer format: int8 example: 1 flow_direction: allOf: - $ref: '#/components/schemas/FlowDirection' description: Flow data direction. capacity: description: capacity type: number example: 2.5 throughput: description: throughput type: number example: 2.5 utilization: description: utilization type: number format: double example: 85 eqs: description: EQS value between 0 - 10 type: number example: 9.85 application_groups_per_criticality: description: application_groups grouped by criticality $ref: '#/components/schemas/ApplicationGroupsEqsPerCriticality' SitesOverviewResponsePaged: allOf: - $ref: '#/components/schemas/XiqPage' - type: object properties: data: description: The data in the current page $ref: '#/components/schemas/SitesOverview' time_range: description: The time range response $ref: '#/components/schemas/TimeRange' SitesMetricsWanData: type: object properties: data: type: array description: Object containing Array of Networks and their information's example: - network_id: 665 network_name: Network1 volume: 123456 throughput: 12345 eqs: 9.85 delay: 90 jitter: 2 packet_loss: 0.12 rtt: 23 srt: 150 retransmission: 0.25 avg_session: 4.32 local_availability: 100 end_to_end_availability: 99.1 - network_id: 666 network_name: Network2 volume: 654321 throughput: 54321 eqs: 3.18 delay: 156 jitter: 11 packet_loss: 0.45 rtt: 179 srt: 1500 retransmission: 1.52 avg_session: 2.45 local_availability: 78.5 end_to_end_availability: 91.25 items: description: Holds list of Networks type: object properties: network_id: description: Network identifier type: integer example: 666 format: int64 network_name: description: Network name type: string example: MPLS volume: description: Volume of data seen on this transport network in bytes type: integer example: 34876665122 format: int64 throughput: description: Throughput seen on this transport network in bytes per seconds. type: integer example: 371225 format: int64 eqs: description: EQS for flows on this transport network (value between 0 to 10) type: number nullable: true example: 8.85 format: float delay: description: TCP delay in milliseconds or null if unknown type: integer nullable: true example: 110 format: int32 jitter: description: Jitter in milliseconds or null if unknown type: integer nullable: true example: 6 format: int32 packet_loss: description: Packet loss on this transport network in percentage (value between 0 and 100) type: number example: 0.15 format: float rtt: description: TCP RTT in milliseconds type: integer nullable: true example: 123 format: int32 srt: description: SRT in milliseconds type: integer nullable: true example: 10 format: int32 retransmission: description: Percentage of packet retransmission type: number nullable: true example: 0.23 format: float avg_session: description: Average number of sessions type: number example: 5.24 format: float local_availability: description: Local availability of the transport network in percentage or null if unknown type: number nullable: true example: 100 format: float end_to_end_availability: description: End to end availability of the transport network in percentage or null if unknown type: number nullable: true example: 97.52 format: float SitesMetricsWanResponse: allOf: - $ref: '#/components/schemas/SitesMetricsWanData' - $ref: '#/components/schemas/XiqPage' WorstEqsInfo: type: object description: Object with array worst 10 EQS group by Application or Application Group properties: eqs: description: eqs value type: number format: double example: 9.55 application_id: description: Application Id type: integer example: 1 format: int64 application_name: description: Application name type: string example: SHTTP WorstEqsInfoList: type: array description: Array of Object containing worst 10 Eqs group by Application or Application Group items: description: Object containing Eqs Data $ref: '#/components/schemas/WorstEqsInfo' WorstEqsResponse: type: object properties: data: description: Returns worst 10 Eqs group by Application or Application Group $ref: '#/components/schemas/WorstEqsInfoList' time_range: description: The timeRange response $ref: '#/components/schemas/TimeRange' TopThroughputInfo: type: object description: Object with array top 10 Volume group by Application group or Aplication properties: volume: description: Volume type: integer example: 525665 application_id: description: Application Id type: integer example: 1 format: int64 application_name: description: Application name type: string example: SHTTP TopThroughputInfoList: type: array description: Array of Object containing top 10 Volume group by Application Group or Application. items: description: Object containing throughput data $ref: '#/components/schemas/TopThroughputInfo' TopThroughputResponse: type: object properties: data: description: Returns top 10 Volume by Application Group or Application. $ref: '#/components/schemas/TopThroughputInfoList' time_range: description: The timeRange response $ref: '#/components/schemas/TimeRange' WanServicesThroughputEvolutionResponse: type: object properties: data: type: array description: Object containing array of Networks and their informations example: - network_id: 665 network_name: Network 1 network_throughput: - timestamp: 1663765260 throughput: 1560 - timestamp: 1663765320 throughput: 1550 - timestamp: 1663765380 throughput: 2050 - timestamp: 1663765440 throughput: 1666 - network_id: 666 network_name: Network 2 network_throughput: - timestamp: 1663765260 throughput: 2789 - timestamp: 1663765320 throughput: 12345 - timestamp: 1663765380 throughput: 123456 - timestamp: 1663765440 throughput: 65432 items: type: object properties: network_id: description: Network identifier type: integer example: 666 format: int64 network_name: description: Network name type: string example: MPLS network_throughput: type: array description: Object containing array of informations items: type: object properties: timestamp: type: integer format: int64 example: 1656322200 description: Timestamp of this throughput value (epoch time in seconds). throughput: description: throughput for flows on this transport network in bytes per seconds type: integer example: 1185 format: int64 raised_alarms: type: integer description: Object holds Raised alarms corresponding to the date time. example: 4 throughput: type: number description: Object holds Throughput in bytes corresponding to the date time. example: 55.88 format: double eqs: type: number description: Array containing EQS corresponding to the date time. example: 8.85 format: double MetricsTimeSeriesInfo: type: object description: Object with Date time and array of Raised alarms, EQS and Throughput information corresponding to the date time. properties: date_time: description: time in seconds in epoch format type: integer format: int64 example: 1662361715 raised_alarms: description: Array of Raised alarms information by time $ref: '#/components/schemas/raised_alarms' throughput: description: Array of Throughput information by time $ref: '#/components/schemas/throughput' eqs: description: Array of EQS information by time $ref: '#/components/schemas/eqs' MetricsTimeSeriesInfoList: type: array description: Array of Object containing Date Time and array of Raised alarms, EQS and Throughput information corresponding to the date time. items: description: Object containing Raised alarms, EQS and Throughput information $ref: '#/components/schemas/MetricsTimeSeriesInfo' MetricsTimeSeriesResponse: type: object properties: data: description: Returns Raised Alarms,EQS, Throughput info data $ref: '#/components/schemas/MetricsTimeSeriesInfoList' time_range: description: The timeRange response $ref: '#/components/schemas/TimeRange' ThroughPutEvolutionInfoDetails: type: array description: Object containing Array of throughput by criticality or Application Group . items: description: Holds list of throughput type: object properties: throughput: description: Application throughput type: number example: 5.56 application_group_id: description: Application group Id type: integer example: 1 format: int64 application_group_name: description: Application Group Name type: string example: Internet ThroughPutEvolutionInfo: type: object description: Object with Date time and array of throughput group by Criticality or Application group. properties: date_time: description: time in seconds in epoch format type: integer format: int64 example: 1662361715 throughput_list: description: Array of Throughput by time $ref: '#/components/schemas/ThroughPutEvolutionInfoDetails' ThroughPutEvolutionInfoList: type: array description: Array of Object containing Date Time and array of throughput group by criticality or Application group items: description: Object containing throughput data $ref: '#/components/schemas/ThroughPutEvolutionInfo' ThroughPutEvolutionResponse: type: object properties: data: description: Returns throughput info data $ref: '#/components/schemas/ThroughPutEvolutionInfoList' time_range: description: The timeRange response $ref: '#/components/schemas/TimeRange' EqsEvolutionInfoDetails: type: array description: Object containing Array of Eqs group by Application group or criticality or worst 10 Application items: description: Holds list of Eqs type: object properties: eqs: description: Application Eqs type: number example: 9.55 application_group_id: description: Application group Id type: integer example: 1 format: int64 application_order_number: description: Application order number in the worst n application list type: integer example: 1 format: int32 application_group: description: Application Group type: string example: Internet EqsEvolutionInfo: type: object description: Object with Date time and array of Eqs group by Application group or criticality or worst 10 Application. properties: date_time: description: time in seconds in epoch format type: integer format: int64 example: 1662361715 eqs_list: description: Array of Eqs data for the date time $ref: '#/components/schemas/EqsEvolutionInfoDetails' EqsEvolutionInfoList: type: array description: Array of Object containing Date Time and array of Eqs group by Application group or criticality or worst 10 Aplication items: description: Object containing Eqs data group by Application group or criticality or worst 10 Aplication $ref: '#/components/schemas/EqsEvolutionInfo' EqsEvolutionResponse: type: object properties: data: description: Returns Eqs info data $ref: '#/components/schemas/EqsEvolutionInfoList' time_range: description: The timeRange response $ref: '#/components/schemas/TimeRange' TopThroughPutEvolutionInfoDetails: type: array description: Object containing Array of throughput by top 10 Application. items: description: Holds list of throughput type: object properties: throughput: description: Application throughput type: number example: 5.56 application_id: description: Application Id type: integer example: 1 format: int64 application_order_number: description: Application order number in the top n application list type: integer example: 1 format: int32 application_name: description: Application name type: string example: Internet TopThroughPutEvolutionInfo: type: object description: Object with Date time and array of throughput group by top 10 Application. properties: date_time: description: time in seconds in epoch format type: integer format: int64 example: 1662361715 throughput_list: description: Array of Throughput by time $ref: '#/components/schemas/TopThroughPutEvolutionInfoDetails' TopThroughPutEvolutionInfoList: type: array description: Array of Object containing Date Time and array of throughput group by top 10 Application items: description: Object containing throughput data $ref: '#/components/schemas/TopThroughPutEvolutionInfo' TopThroughPutEvolutionResponse: type: object properties: data: description: Returns throughput info data $ref: '#/components/schemas/TopThroughPutEvolutionInfoList' time_range: description: The timeRange response $ref: '#/components/schemas/TimeRange' ApplicationGroupsPerCriticality: type: array items: properties: top: description: application groups for criticality top type: array items: description: List of application groups type: object properties: application_group_id: description: application group id type: number format: long example: 12234 application_group_name: description: application group name type: string example: BusinessApp high: description: application groups for criticality high type: array items: description: List of application groups type: object properties: application_group_id: description: application group id type: number format: long example: 12231 application_group_name: description: application group name type: string example: ThinClient medium: description: application groups for criticality medium type: array items: description: List of application groups type: object properties: application_group_id: description: application group id type: number format: long example: 12234 application_group_name: description: application group name type: string example: BackOffice low: description: application groups for criticality low type: array items: description: List of application groups type: object properties: application_group_id: description: application group id type: number format: long example: 12234 application_group_name: description: application group name type: string example: Internet SitesApplicationGroupResponse: type: object properties: data: description: The Application Groups per criticality $ref: '#/components/schemas/ApplicationGroupsPerCriticality' FlowData: type: array items: properties: local_site_name: type: string minLength: 1 example: SITE-PARIS local_site_id: type: integer format: int64 example: 20 local_appliance_name: type: string format: int64 example: APPLIANCE-1 local_appliance_id: type: integer format: int64 example: 1234 local_nap_index: type: integer format: int8 example: 1 remote_site_name: type: string minLength: 1 example: SITE-LONDON remote_site_id: type: integer format: int64 example: 40 remote_appliance_name: type: string minLength: 1 example: APPLIANCE-2 remote_appliance_id: type: integer format: int32 example: 5678 remote_nap_index: type: integer format: int8 example: 1 direction: description: Flow direction. 0, 1 for egress and ingress respectively. i.e. when traffic is flowing local site to remote site it is 1, and 0 for remote site to local site. type: integer format: int32 example: 1 eqs: description: It ranges between 0 and 10. 0 means worst and 10 means best. type: number minLength: 1 example: 5 application_group_name: type: string minLength: 1 example: BackOffice application_group_id: type: integer format: int64 example: 50 application_name: type: string minLength: 1 example: FTP application_id: type: integer format: int64 example: 60 criticality: description: It can be Top, High, Medium and Low. type: string minLength: 1 example: Top lan_throughput: description: Unit is bps type: number minLength: 1 example: 156 lan_goodput: description: Unit is bps type: number minLength: 1 example: 89.53 sessions: type: number minLength: 1 example: 1.2 lan_packet_loss_percentage: type: number minLength: 1 example: 5.62 lan_min_delay: description: Unit is milliseconds. type: number minLength: 1 example: 113.14 lan_avg_delay: description: Unit is milliseconds. type: number minLength: 1 example: 114 lan_max_delay: description: Unit is milliseconds. type: number minLength: 1 example: 114.16 lan_jitter: description: Unit is milliseconds. type: number minLength: 1 example: 43 wan_throughput: description: Unit is bps type: number minLength: 1 example: 156 wan_packet_loss_percentage: type: number minLength: 1 example: 0.69 wan_min_delay: description: Unit is milliseconds. type: number minLength: 1 example: 47.53 wan_avg_delay: description: Unit is milliseconds. type: number minLength: 1 example: 48 wan_max_delay: description: Unit is milliseconds. type: number minLength: 1 example: 48.13 wan_jitter: description: Unit is milliseconds. type: number minLength: 1 example: 0.02 compression_percentage: type: number minLength: 1 example: 10.22 srt_min: description: Unit is milliseconds. type: number minLength: 1 example: 200 srt_avg: description: Unit is milliseconds. type: number minLength: 1 example: 300 srt_max: description: Unit is milliseconds. type: number minLength: 1 example: 400 rtt_min: description: Unit is milliseconds. type: number minLength: 1 example: 500.58 rtt_avg: description: Unit is milliseconds. type: number minLength: 1 example: 501.36 rtt_max: description: Unit is milliseconds. type: number minLength: 1 example: 502.13 retransmit_percentage: type: number minLength: 1 example: 2.49 real_time: description: It can be 0 or 1. 1 means traffic type is real time. type: integer format: int32 example: 1 lan_avg_delay_eqs: description: It ranges between 0 and 10. 0 means worst and 10 means best. type: number minLength: 1 example: 5 lan_jitter_eqs: description: It ranges between 0 and 10. 0 means worst and 10 means best. type: number minLength: 1 example: 5 lan_packet_loss_eqs: description: It ranges between 0 and 10. 0 means worst and 10 means best. type: number minLength: 1 example: 5 srt_avg_eqs: description: It ranges between 0 and 10. 0 means worst and 10 means best. type: number minLength: 1 example: 5 rtt_avg_eqs: description: It ranges between 0 and 10. 0 means worst and 10 means best. type: number minLength: 1 example: 5 retransmit_eqs: description: It ranges between 0 and 10. 0 means worst and 10 means best. type: number minLength: 1 example: 5 compression_flag: description: It can be yes or no. type: string minLength: 1 example: 'yes' FlowsResponseData: type: object properties: time_range: description: The timeRange response $ref: '#/components/schemas/TimeRange' data: description: Returns flows view data $ref: '#/components/schemas/FlowData' FlowsResponse: allOf: - $ref: '#/components/schemas/FlowsResponseData' - $ref: '#/components/schemas/XiqPage' LocalSites: type: array items: description: Holds list of local sites and corresponding lan and wan throughput type: object properties: name: type: string minLength: 1 example: SITE-LONDON id: type: integer format: int64 example: 20 lan_throughput: description: Unit is bps type: number minLength: 1 example: 156 wan_throughput: description: Unit is bps type: number minLength: 1 example: 156 RemoteSites: type: array items: description: Holds list of remote sites and corresponding lan and wan throughput type: object properties: name: type: string minLength: 1 example: SITE-PARIS id: type: integer format: int64 example: 30 lan_throughput: description: Unit is bps type: number minLength: 1 example: 132 wan_throughput: description: Unit is bps type: number minLength: 1 example: 132 ApplicationGroups: type: array items: description: Holds list of application groups and corresponding lan and wan throughput type: object properties: name: type: string minLength: 1 example: BackOffice id: type: integer format: int64 example: 40 lan_throughput: description: Unit is bps type: number minLength: 1 example: 113 wan_throughput: description: Unit is bps type: number minLength: 1 example: 113 Applications: type: array items: description: Holds list of applications and corresponding lan and wan throughput type: object properties: name: type: string minLength: 1 example: FTP id: type: integer format: int64 example: 50 lan_throughput: description: Unit is bps type: number minLength: 1 example: 173 wan_throughput: description: Unit is bps type: number minLength: 1 example: 173 FlowsListData: type: object properties: local_sites: description: The list of local sites $ref: '#/components/schemas/LocalSites' remote_sites: description: The list of remote sites $ref: '#/components/schemas/RemoteSites' application_groups: description: The list of application groups $ref: '#/components/schemas/ApplicationGroups' applications: description: The list of applications $ref: '#/components/schemas/Applications' FlowsListResponse: type: object properties: time_range: description: The timeRange response $ref: '#/components/schemas/TimeRange' data: description: The Flows filter Object $ref: '#/components/schemas/FlowsListData' ApplicationOverviewSummaryInfo: type: object description: Array of Object containing application overview summary details group by Application, Application Group or criticality properties: application_id: description: application Id type: number example: 5455656 application_name: description: application name type: string example: webex criticality: description: criticality type: string example: Top eqs: description: eqs value type: number format: double example: 9.55 throughput: description: throughput value type: number format: double example: 5553434.56 volume: description: volume value type: number format: double example: 44567.55 ApplicationOverviewSummaryInfoList: type: array description: Array of Object containing application overview summary details group by Application, Application Group or criticality items: description: Object containing application summary Data $ref: '#/components/schemas/ApplicationOverviewSummaryInfo' ApplicationOverviewSummaryData: type: object properties: data: description: Returns Filtered summary data $ref: '#/components/schemas/ApplicationOverviewSummaryInfoList' time_range: description: The timeRange response $ref: '#/components/schemas/TimeRange' ApplicationOverviewSummary: allOf: - $ref: '#/components/schemas/ApplicationOverviewSummaryData' - $ref: '#/components/schemas/XiqPage' SitesJitterOverviewDetails: type: object properties: data: description: Sites overview response $ref: '#/components/schemas/SitesOverview' time_range: description: The time range response $ref: '#/components/schemas/TimeRange' SitesJitterOverviewResponse: allOf: - $ref: '#/components/schemas/XiqPage' - type: object properties: data: $ref: '#/components/schemas/SitesJitterOverviewDetails' DelayJitter: type: array description: Object containing an array of delay and jitter values for the site and the associated timestamp example: - timestamp: 1663765260 delay_lan: 156 delay_wan: 147 jitter_lan: 10 jitter_wan: 21 - timestamp: 1663765320 delay_lan: 155 delay_wan: 166 jitter_lan: 11 jitter_wan: 8 - timestamp: 1663765380 delay_lan: 205 delay_wan: 195 jitter_lan: 12 jitter_wan: 10 - timestamp: 1663765440 delay_lan: 151 delay_wan: 166 jitter_lan: 17 jitter_wan: 13 items: type: object properties: timestamp: type: integer format: int64 example: 1656322200 description: Timestamp of this delay and jitter value (epoch time in seconds). delay_lan: description: lan delay in milliseconds type: integer example: 118 format: int32 delay_wan: description: wan delay in milliseconds type: integer example: 118 format: int32 jitter_lan: description: lan jitter in milliseconds type: integer example: 11 format: int32 jitter_wan: description: wan jitter in milliseconds type: integer example: 11 format: int32 SitesDelayJitterResponse: type: object properties: data: description: The delay and jitter evolution. The array may be empty if the site is a tele managed one. $ref: '#/components/schemas/DelayJitter' AverageSessions: type: array description: Object containing an array of average sessions values for the site and the associated timestamp example: - timestamp: 1663765260 sessions: 156 - timestamp: 1663765320 sessions: 155 - timestamp: 1663765380 sessions: 205 - timestamp: 1663765440 sessions: 166 items: type: object properties: timestamp: type: integer format: int64 example: 1656322200 description: Timestamp of this sessions value (epoch time in seconds). sessions: description: average number of sessions type: number example: 118 format: double SitesAverageSessionsResponse: type: object properties: data: description: The average TCP session number evolution $ref: '#/components/schemas/AverageSessions' RTTSRT: type: array description: Object containing an array of RTT and SRT values for the site and the associated timestamp example: - timestamp: 1663765260 rtt: 156 srt: 10 - timestamp: 1663765320 rtt: 155 srt: 11 - timestamp: 1663765380 rtt: 205 srt: 12 - timestamp: 1663765440 rtt: 166 srt: 13 items: type: object properties: timestamp: type: integer format: int64 example: 1656322200 description: Timestamp of this RTT and SRT value (epoch time in seconds). rtt: description: RTT in milliseconds type: integer example: 118 format: int32 srt: description: SRT in milliseconds type: integer example: 11 format: int32 SitesRttSrtResponse: type: object properties: data: description: The RTT and SRT evolution $ref: '#/components/schemas/RTTSRT' Throughput: type: array description: Object containing an array of throughput values for the site and the associated timestamp example: - timestamp: 1663765260 throughput_lan: 156 throughput_wan: 150 - timestamp: 1663765320 throughput_lan: 155 throughput_wan: 155 - timestamp: 1663765380 throughput_lan: 205 throughput_wan: 210 - timestamp: 1663765440 throughput_lan: 166 throughput_wan: 167 items: type: object properties: timestamp: type: integer format: int64 example: 1656322200 description: Timestamp of this throughput value (epoch time in seconds). throughput_lan: description: lan throughput in bytes per second type: integer example: 123456789 format: int64 throughput_wan: description: wan throughput in bytes per second type: integer example: 123456789 format: int64 SitesThroughputEvolutionResponse: type: object properties: data: description: The throughput evolution $ref: '#/components/schemas/Throughput' PacketRetransmission: type: array description: Object containing an array of packet retransmission values for the site and the associated timestamp example: - timestamp: 1663765260 retransmission: 0.24 - timestamp: 1663765320 retransmission: 0.11 - timestamp: 1663765380 retransmission: 0.17 - timestamp: 1663765440 retransmission: 0.15 items: type: object properties: timestamp: type: integer format: int64 example: 1656322200 description: Timestamp of this packet retransmission value (epoch time in seconds). retransmission: description: retransmission in percentage type: number example: 0.26 format: float SitesPacketRetransmissionResponse: type: object properties: data: description: The TCP packet retransmission rate evolution $ref: '#/components/schemas/PacketRetransmission' PacketLoss: type: array description: Object containing an array of packet loss values for the site and the associated timestamp example: - timestamp: 1663765260 packet_loss_lan: 0.1 packet_loss_wan: 0.05 - timestamp: 1663765320 packet_loss_lan: 0.25 packet_loss_wan: 0.15 - timestamp: 1663765380 packet_loss_lan: 0 packet_loss_wan: 0.14 - timestamp: 1663765440 packet_loss_lan: 0.65 packet_loss_wan: 0.66 items: type: object properties: timestamp: type: integer format: int64 example: 1656322200 description: Timestamp of this delay value (epoch time in seconds). packet_loss_lan: description: lan packet loss in percentage type: number example: 0.17 format: float packet_loss_wan: description: wan packet loss in percentage type: number example: 0.15 format: float SitesPacketLossResponse: type: object properties: data: description: The TCP packet loss evolution $ref: '#/components/schemas/PacketLoss' EQS: type: array description: Object containing an array of EQS values for the site and the associated timestamp example: - timestamp: 1663765260 eqs: 10 - timestamp: 1663765320 eqs: 9.55 - timestamp: 1663765380 eqs: 9.62 - timestamp: 1663765440 eqs: 9.66 items: type: object properties: timestamp: type: integer format: int64 example: 1656322200 description: Timestamp of this EQS value (epoch time in seconds). eqs: description: EQS value type: number example: 9.66 format: float SitesEqsResponse: type: object properties: data: description: The EQS evolution $ref: '#/components/schemas/EQS' ResponseTimestamp: type: integer description: Time of the response in epoch format (milliseconds) format: int64 example: 1651743308000 ApplianceGetStatusSimple: type: object properties: data: type: array items: type: object properties: timestamp: $ref: '#/components/schemas/ResponseTimestamp' info: type: object properties: id: description: Appliance ID type: integer format: int64 example: 1 name: description: Appliance Name type: string example: Branch-01-IPE1 state: type: object properties: orchestrator_connected: description: True if appliance is connected to the orchestrator type: boolean example: true configuration_synchronized: description: True if appliance configuration in sync with orchestrator type: boolean example: true lldp_state_active: description: True if LLDP state is active type: boolean example: true firmware_version: description: Current applied appliance firmware type: string example: 22.03.0.2 ApplianceGetStatus: type: object properties: data: type: array items: type: object properties: timestamp: $ref: '#/components/schemas/ResponseTimestamp' info: type: object properties: id: description: Appliance ID type: integer format: int64 example: 1 name: description: Appliance Name type: string example: Branch-01-IPE1 state: type: object properties: orchestrator_connected: description: True if appliance is connected to the orchestrator type: boolean example: true configuration_synchronized: description: True if appliance configuration in sync with orchestrator type: boolean example: true time_synchronized: description: True if appliance is in sync with time servers type: boolean example: true last_configuration_update_timestamp: description: Last configuration update timestamp in epoch format (milliseconds) type: integer format: int64 example: 1651743308000 firmware_version: description: Current applied appliance firmware type: string example: 22.03.0.2 system: type: object properties: uptime: description: System uptime in milliseconds type: integer format: int64 example: 1651743308000 cpu: type: object properties: usage: description: Average CPU load in percentage type: integer format: int32 example: 50 network: type: object properties: interface: type: array items: type: object properties: name: description: Name of the interface type: string example: wan1 type: description: Indicates the interface protocol type. type: string enum: - eth - lo - gre - ipip example: eth state: description: Operational status of link. type: string enum: - up - down - dormant - testing - lowerlayerdown - notpresent - unknown example: up rx_bytes: description: Bytes received type: integer format: int64 example: 420 tx_bytes: description: Bytes sent type: integer format: int64 example: 1071 throughput: description: Throughput in bps type: number format: double example: 24 fabric: type: object properties: hostname: description: Hostname of the local switch type: string example: client-1 mac_address: description: MAC Address of the local switch type: string example: 7a:1d:1c:ad:4a:ad ip_address: description: IP Address of the local switch type: string example: 192.168.3.200 lldp_state: description: True if LLDP state is active type: boolean example: true uptime: description: Switch uptime in milliseconds type: integer format: int64 example: 1651743308000 num_peers_up: description: Number of peer switches with ISIS state as Up type: integer format: int32 example: 10 num_peers_down: description: Number of peer switches with ISIS state as Down type: integer format: int32 example: 10 ApplianceMonitoringCpuUsage: type: object properties: data: type: array items: type: object properties: timestamp: $ref: '#/components/schemas/ResponseTimestamp' info: type: object properties: id: description: Appliance ID type: integer format: int64 example: 1 name: description: Appliance Name type: string example: Branch-01-IPE1 cpu_usage: type: array description: Object containing array of information items: type: object properties: timestamp: $ref: '#/components/schemas/ResponseTimestamp' usage: description: CPU usage of the appliance in percentage type: integer example: 50 format: int32 ViewDeviceSimpleReferenceObject: type: object properties: id: type: integer format: int64 minimum: 1 name: type: string ViewDeviceResponse: type: object allOf: - type: object properties: id: type: integer format: int64 minimum: 1 owner_id: type: integer format: int64 org_id: type: integer format: int64 name: type: string type: type: string enum: - appliance description: Type of the device. serial_number: type: string description: Serial number of the device. mac_address: type: string description: MAC address of the device. model: type: string description: Model of the device. firmware_version: type: string description: Version of agent software running on the device. configuration: type: object properties: status: type: string description: | Status providing assessment of configuration status. - UNKNOWN: system error. - NOT_CONFIGURED: no template assigned. - TO_BE_CONFIGURED: never deployed. - UPDATING: a validated deployment has been triggered, orchestration is pending. - CONFIGURATION_FAILED: configuration was not successful (orchestration error or appliance error). "message" should contain indications. - CONFIGURATION_UPDATED: appliance has received and loaded deployed configuration. enum: - UNKNOWN - NOT_CONFIGURED - TO_BE_CONFIGURED - UPDATING - CONFIGURATION_FAILED - CONFIGURATION_UPDATED message: type: string description: | Message that may follow up a warning or error status. last_deployed_at: type: string format: date-time description: When the last valid deployment was requested by a User. last_updated_at: type: string format: date-time description: When the device received its last configuration (null if never deployed or not configured). in_sync: type: boolean description: | **true** indicates that latest deployed configuration is the one running on the device. connectivity: type: object properties: connected: type: boolean description: | **true** indicates the device is actively connected to the communicator. last_connected_at: type: string format: date-time description: Time since the device is connected to communicator. null when not connected. disconnected_at: type: string format: date-time description: Time since the device is disconnected to communicator. null when connected or never connected. site: description: Site which the device is bound to. allOf: - $ref: '#/components/schemas/ViewDeviceSimpleReferenceObject' description: type: string device_template: description: Device template applied to the device. allOf: - $ref: '#/components/schemas/ViewDeviceSimpleReferenceObject' management_network: type: object description: Management interface IP address. properties: ip_address: type: string format: ipv4 subnet_mask: type: integer minimum: 0 maximum: 32 wans: type: array description: WAN interfaces of the device. items: type: object properties: name: type: string enum: - WAN1 - WAN2 - WAN3 description: WAN interface name. enabled: type: boolean description: | If **false** other properties will be **null**. transport_network: $ref: '#/components/schemas/ViewDeviceSimpleReferenceObject' overlays: type: array items: type: object allOf: - $ref: '#/components/schemas/ViewDeviceSimpleReferenceObject' - type: object properties: type: type: string enum: - hub_and_spoke - third_party_vpn - cloud_mesh cloud_mesh_enabled: type: boolean description: | **true** if Cloud Mesh service is enabled on this device. as_number: description: AS Number. type: integer format: int64 minimum: 0 maximum: 65535 last_updated_at: type: string format: date-time description: When the device received its last configuration (null if never deployed or not configured). ViewDevicesResponse: type: object properties: data: type: array description: The data in the current page items: $ref: '#/components/schemas/ViewDeviceResponse' ViewDevicesResponsePaged: allOf: - $ref: '#/components/schemas/XiqPage' - $ref: '#/components/schemas/ViewDevicesResponse' Id: type: object required: - id properties: id: type: integer format: int64 minimum: 1 description: Identifier automatically generated when creating this object. Name: type: object properties: name: type: string minLength: 1 maxLength: 64 pattern: '[\w!#$%&''()*+,-.\\/:;<=>@[\]^`{|}~\s]*' description: Character string used to identify this object. FreeDescription: type: object properties: description: type: string description: Free text to add a custom description to this object. Timestamp: type: object properties: created_at: type: string example: '2022-06-14T17:24:13.429+00:00' description: Creation date and time of this object. readOnly: true updated_at: type: string example: '2022-06-14T17:24:13.429+00:00' description: Last update date and time of this object. readOnly: true OwnerId: type: object properties: owner_id: type: integer format: int64 description: Character string used to identify the owner of this object. readOnly: true OrgId: type: object properties: org_id: type: integer format: int64 description: Character string used to identify the organization of this object. readOnly: true ResponseObjectIdentifier: type: object allOf: - $ref: '#/components/schemas/Id' - $ref: '#/components/schemas/Name' - $ref: '#/components/schemas/FreeDescription' - $ref: '#/components/schemas/Timestamp' - $ref: '#/components/schemas/OwnerId' - $ref: '#/components/schemas/OrgId' VPNZoneCommonProperties: required: - name - priority allOf: - $ref: '#/components/schemas/Name' - $ref: '#/components/schemas/FreeDescription' - type: object properties: priority: type: integer description: Ordered priority of the VPN Zone among its siblings. The VPN Zone "Default" has always the highest priority. minimum: 1 maximum: 2147483645 nullable: true vpn_subnets: type: array items: type: object required: - prefix - mask properties: prefix: type: string format: ipv4 description: Subnet's prefix. mask: type: integer minimum: 0 maximum: 32 description: Length of the subnet's prefix. ReferencedObject: type: object allOf: - $ref: '#/components/schemas/Id' - type: object properties: name: type: string minLength: 1 maxLength: 64 pattern: '[\w!#$%&''()*+,-.\\/:;<=>@[]^`{|}~\s]*' description: Character string used to identify this object. readOnly: true description: type: string description: Free text to add a custom description to this object. readOnly: true VPNZoneResponseContent: allOf: - $ref: '#/components/schemas/ResponseObjectIdentifier' - $ref: '#/components/schemas/VPNZoneCommonProperties' - type: object properties: vpn_sites: type: array items: $ref: '#/components/schemas/ReferencedObject' description: Refers to a list of existing sites. VPNZoneCollectionResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/VPNZoneResponseContent' VPNZonePaginatedResponse: allOf: - $ref: '#/components/schemas/VPNZoneCollectionResponse' - $ref: '#/components/schemas/XiqPage' GetOverlayMain: type: object required: - type properties: type: type: string enum: - HUB-AND-SPOKE - THIRD-PARTY-VPN - APPS-ANYWHERE discriminator: propertyName: type mapping: HUB-AND-SPOKE: '#/components/schemas/GetOverlayHubAndSpoke' THIRD-PARTY-VPN: '#/components/schemas/GetOverlayExternalGateway' APPS-ANYWHERE: '#/components/schemas/GetAppsAnywhere' OverlayBaseCreate: type: object required: - name properties: name: type: string description: Name of the Overlay description: type: string description: Free text to add a custom description to this object. OverlayBaseUpdate: type: object allOf: - $ref: '#/components/schemas/OverlayBaseCreate' - type: object properties: id: type: number format: long minimum: 1 description: Identifier automatically generated when creating this object. OverlayBase: type: object allOf: - $ref: '#/components/schemas/OverlayBaseUpdate' - type: object properties: org_id: type: integer format: int64 readOnly: true owner_id: type: integer format: int64 readOnly: true created_at: type: string example: '2022-06-14T17:24:13.429+00:00' description: Creation date and time of this object. readOnly: true updated_at: type: string example: '2022-06-14T17:24:13.429+00:00' description: Last update date and time of this object. readOnly: true IKEEncryptionCipherMode: type: string description: Encryption cipher modes enum: - AES128CBC - AES256CBC - 3DESCBC - AES192CBC - AES128GCM - AES192GCM - AES256GCM - AES128GMAC - AES192GMAC - AES256GMAC AuthenticationCipherMode: type: string description: Authentication cipher modes enum: - SHA1 - SHA256 - MD5 - SHA384 - SHA512 IKEDiffieHellmanGroup: type: string description: Diffie Hellman groups enum: - '1' - '2' - '5' - '14' - '19' - '20' - '21' - '24' IKELifetime: description: Lifetime (seconds) type: integer minimum: 120 maximum: 172800 IPSECEncryptionCipherMode: type: string description: Encryption cipher modes enum: - 'NULL' - AES128CBC - AES256CBC - 3DESCBC - AES192CBC - AES128GCM - AES192GCM - AES256GCM - AES128GMAC - AES192GMAC - AES256GMAC IPSECDiffieHellmanGroup: type: string description: Diffie Hellman groups enum: - '1' - '2' - '5' - '14' - '19' - '20' - '21' - '24' - PFS disabled IPSECLifetime: description: Lifetime (seconds) type: integer minimum: 120 maximum: 172800 IPSECLifebytes: description: Lifebytes (kbytes) type: integer minimum: 5120 maximum: 2147483647 Mtu: description: MTU (bytes) type: integer minimum: 68 maximum: 64000 SecurityBase: type: object required: - ike_encryption_cipher - ike_auth_cipher - ike_dh_group - ike_lifetime - ipsec_encryption_cipher - ipsec_auth_cipher - ipsec_dh_group - ipsec_lifetime - mtu properties: ike_encryption_cipher: $ref: '#/components/schemas/IKEEncryptionCipherMode' ike_auth_cipher: $ref: '#/components/schemas/AuthenticationCipherMode' ike_dh_group: $ref: '#/components/schemas/IKEDiffieHellmanGroup' ike_lifetime: $ref: '#/components/schemas/IKELifetime' ipsec_encryption_cipher: $ref: '#/components/schemas/IPSECEncryptionCipherMode' ipsec_auth_cipher: $ref: '#/components/schemas/AuthenticationCipherMode' ipsec_dh_group: $ref: '#/components/schemas/IPSECDiffieHellmanGroup' ipsec_lifetime: $ref: '#/components/schemas/IPSECLifetime' ipsec_lifebytes: $ref: '#/components/schemas/IPSECLifebytes' mtu: $ref: '#/components/schemas/Mtu' AuthenticationMode: type: string description: Authentication mode (only psk supported) enum: - PSK PskEncoding: type: string description: PSK Encoding enum: - none - base64 CredentialsRead: type: object properties: mode: $ref: '#/components/schemas/AuthenticationMode' psk_encoding: $ref: '#/components/schemas/PskEncoding' configured: type: boolean readOnly: true description: if true, then some credentials are configured on remote side (but not exposed) SecurityRead: type: object allOf: - $ref: '#/components/schemas/SecurityBase' - type: object properties: credentials: $ref: '#/components/schemas/CredentialsRead' GetOverlayHubAndSpoke: allOf: - $ref: '#/components/schemas/GetOverlayMain' - $ref: '#/components/schemas/OverlayBase' - type: object properties: security: $ref: '#/components/schemas/SecurityRead' ExternalGatewayRouting: type: object required: - mode properties: mode: type: string enum: - bgp - static discriminator: propertyName: mode mapping: bgp: '#/components/schemas/BGPRouting' static: '#/components/schemas/StaticRouting' ASN32: type: integer format: int64 minimum: 0 maximum: 65535 BGPRouting: allOf: - $ref: '#/components/schemas/ExternalGatewayRouting' type: object properties: peer_ip_address: type: string format: ipv4 asn: $ref: '#/components/schemas/ASN32' local_network_preference: type: integer format: int64 minimum: 0 maximum: 4294967295 Subnet: type: object description: Simple network subnet properties: network: type: string format: ipv4 description: Subnet's address. example: 10.2.1.0 prefix_length: type: integer minimum: 0 maximum: 32 default: 24 description: Length of the subnet's prefix. example: 28 StaticRouting: allOf: - $ref: '#/components/schemas/ExternalGatewayRouting' type: object properties: remote_subnets: type: array items: $ref: '#/components/schemas/Subnet' ResponderId: description: Responder ID type: string GetOverlayExternalGateway: allOf: - $ref: '#/components/schemas/GetOverlayMain' - $ref: '#/components/schemas/OverlayBase' - type: object properties: primary_public_ip_address: type: string format: ipv4 routing: $ref: '#/components/schemas/ExternalGatewayRouting' security: allOf: - $ref: '#/components/schemas/SecurityRead' - type: object properties: responder_id: $ref: '#/components/schemas/ResponderId' OverlayAppsAnywhereRouting: allOf: - type: object properties: asn: $ref: '#/components/schemas/ASN32' AppsAnywhereRouteTable: allOf: - type: object properties: id: type: string description: The cloud id for the route table. name: type: string description: Name of the application anywhere overlay. is_default: type: boolean description: Is it default route table or not. OverlayAppsAnywhereDetails: allOf: - type: object properties: cloud_account_name: type: string description: Cloud account name for the overlay. provider: type: string enum: - AWS - AZURE description: Cloud provider type for this overlay. region: type: string description: The region name for this overlay. gateway_type: type: string enum: - VGW - TGW - VNET_GW - VHUB description: The type of the cloud gateway for this overlay. gateway_id: type: string description: The id of the cloud gateway. sku: type: string description: The sku for the gateway. virtual_wan_name: type: string description: The virtual wan name for this overlay. bandwidth: type: string description: The bandwidth for this overlay. is_usable: type: boolean description: The cloud gateway is usable. reason: type: string description: The reason behind the cloud gateway unusable. is_default_association_enable: type: boolean description: Default route table association is enable for the cloud gateway. is_default_propagation_enable: type: boolean description: Default route table propagation is enable for the cloud gateway. max_tunnels: type: integer description: The number of tunnel(s) created with this overlay. vpn_acceleration_mode: type: string enum: - NA - customizable - enabled - disabled description: The VPN acceleration type for this overlay. route_tables: type: array items: $ref: '#/components/schemas/AppsAnywhereRouteTable' description: The route tables for the associated cloud gateway. GetAppsAnywhere: allOf: - $ref: '#/components/schemas/GetOverlayMain' - $ref: '#/components/schemas/OverlayBase' - type: object properties: routing: $ref: '#/components/schemas/OverlayAppsAnywhereRouting' details: $ref: '#/components/schemas/OverlayAppsAnywhereDetails' GetOverlay: type: object properties: data: type: array items: $ref: '#/components/schemas/GetOverlayMain' OverlayDetails: allOf: - $ref: '#/components/schemas/GetOverlay' - $ref: '#/components/schemas/XiqPage' ApplicationGroupCommonProperties: allOf: - $ref: '#/components/schemas/FreeDescription' - type: object properties: rank: type: integer readOnly: true description: Ordered rank of the Application Group among its siblings. The application group "other" has always the highest rank. minimum: 1 criticality: type: string enum: - TOP - HIGH - MEDIUM - LOW default: TOP description: Business criticality. compression: type: string enum: - disabled - enabled default: disabled description: Capability State. Specifies whether this capability is enabled or disabled. df_override: type: string enum: - disabled - enabled default: disabled description: Allow to override the DF(Don't Fragment) setting for traffic in this application group dscp: type: string enum: - disabled - default - custom - af11 - af12 - af13 - af21 - af22 - af23 - af31 - af32 - af33 - af41 - af42 - af43 - cs1 - cs2 - cs3 - cs4 - cs5 - cs6 - cs7 - ef example: custom description: Apply the DSCP (Differentiated Services Code Point) coloring to the traffic in this application group dscp_custom_value: type: string pattern: ^[0-1]{6}$ example: '001100' description: 'This field only applies if the value of the "dscp" field is: CUSTOM. It is ignored otherwise. Allowed values range from 000000 (0) to 111111 (63)' ApplicationGroupResponseContent: required: - qos_profile - dws_policy allOf: - $ref: '#/components/schemas/ResponseObjectIdentifier' - $ref: '#/components/schemas/ApplicationGroupCommonProperties' - type: object properties: next: $ref: '#/components/schemas/ReferencedObject' description: Refers to the next Application Group. If null, the owner Application group is applied last. Next Application Group must be a sibling of the owner Application Group. qos_profile: $ref: '#/components/schemas/ReferencedObject' description: Refers to an existing QoS profile. applications: type: array items: $ref: '#/components/schemas/ReferencedObject' description: Refers to a list of existing applications. saas_applications: type: array items: $ref: '#/components/schemas/ReferencedObject' description: Refers to a list of existing saas applications. dws_policy: $ref: '#/components/schemas/ReferencedObject' description: Refers to an existing DWS policy. ApplicationGroupsCollectionResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ApplicationGroupResponseContent' ApplicationGroupsPaginatedResponse: allOf: - $ref: '#/components/schemas/ApplicationGroupsCollectionResponse' - $ref: '#/components/schemas/XiqPage' ApplianceProperties: allOf: - $ref: '#/components/schemas/Id' - $ref: '#/components/schemas/OwnerId' - $ref: '#/components/schemas/OrgId' - $ref: '#/components/schemas/Timestamp' - type: object properties: name: description: Appliance Name type: string minLength: 1 maxLength: 64 pattern: '[\w!#$%&''()*+,-.\\/:;<=>@[]^`{|}~\s]*' info: description: Appliance Info type: string example: info host_name: description: Appliance Host name type: string example: Host123 serial_number: description: Appliance Serial Number type: string example: 20K62208I-D0002 mac_address: description: Appliance Mac Address type: string example: C2CC57D0F70B tag: description: Appliance tag type: string example: 10C1 model: description: Appliance Model type: string example: ipe-30so site: $ref: '#/components/schemas/ReferencedObject' template: $ref: '#/components/schemas/ReferencedObject' GetOnboardApplianceMultipleData: type: object properties: data: type: array items: $ref: '#/components/schemas/ApplianceProperties' GetOnboardApplianceMultiple: allOf: - $ref: '#/components/schemas/GetOnboardApplianceMultipleData' - $ref: '#/components/schemas/XiqPage' GetOnboardApplianceSingle: type: object properties: data: $ref: '#/components/schemas/ApplianceProperties' CapabilityState: type: string enum: - DISABLED - ENABLED default: DISABLED description: Capability State. Specifies whether this capability is enabled or disabled. SdWanApplianceTemplateCommonProperties: allOf: - $ref: '#/components/schemas/Name' - $ref: '#/components/schemas/FreeDescription' - type: object properties: time_synchronization_server: $ref: '#/components/schemas/CapabilityState' wan_optimization: $ref: '#/components/schemas/CapabilityState' lan_to_wan: $ref: '#/components/schemas/CapabilityState' wan_to_lan: $ref: '#/components/schemas/CapabilityState' lan1: $ref: '#/components/schemas/CapabilityState' wan1: $ref: '#/components/schemas/CapabilityState' wan2: $ref: '#/components/schemas/CapabilityState' wan3: $ref: '#/components/schemas/CapabilityState' internet_backhauling: $ref: '#/components/schemas/CapabilityState' bypass_lan1_wan1: $ref: '#/components/schemas/CapabilityState' bypass_lan2_wan2: $ref: '#/components/schemas/CapabilityState' multipath: $ref: '#/components/schemas/CapabilityState' path_selection: type: string enum: - DYNAMIC - WIRE - SWITCH default: DYNAMIC role: type: string enum: - NONE - HUB - SPOKE default: SPOKE InnerObjectResponse: type: object allOf: - $ref: '#/components/schemas/Id' - $ref: '#/components/schemas/Name' - $ref: '#/components/schemas/FreeDescription' SdWanApplianceTemplateGetResponse: allOf: - $ref: '#/components/schemas/ResponseObjectIdentifier' - $ref: '#/components/schemas/SdWanApplianceTemplateCommonProperties' - type: object properties: lans: type: array items: $ref: '#/components/schemas/InnerObjectResponse' wans: type: array items: $ref: '#/components/schemas/InnerObjectResponse' ApplianceTemplateResponseById: type: object properties: data: $ref: '#/components/schemas/SdWanApplianceTemplateGetResponse' DeviceProperties: allOf: - $ref: '#/components/schemas/Timestamp' - type: object properties: template: allOf: - $ref: '#/components/schemas/ReferencedObject' readOnly: true wan_optimization: $ref: '#/components/schemas/CapabilityState' lan_to_wan: $ref: '#/components/schemas/CapabilityState' wan_to_lan: $ref: '#/components/schemas/CapabilityState' lan1: readOnly: true $ref: '#/components/schemas/CapabilityState' wan1: readOnly: true $ref: '#/components/schemas/CapabilityState' wan2: readOnly: true $ref: '#/components/schemas/CapabilityState' wan3: readOnly: true $ref: '#/components/schemas/CapabilityState' time_synchronization_server: $ref: '#/components/schemas/CapabilityState' role: type: string enum: - HUB - SPOKE - NONE default: SPOKE description: device role. path_selection: type: string enum: - DYNAMIC - WIRE - SWITCH readOnly: true internet_backhauling: $ref: '#/components/schemas/CapabilityState' bypass_lan1_wan1: $ref: '#/components/schemas/CapabilityState' bypass_lan2_wan2: $ref: '#/components/schemas/CapabilityState' multipath: readOnly: true $ref: '#/components/schemas/CapabilityState' is_overridden: type: boolean default: false readOnly: true local_parameters: type: object properties: appliance_name: type: string lan_gateway_ip_address: type: string local_as_auto: $ref: '#/components/schemas/CapabilityState' local_as_number: type: integer minimum: 1 managed: $ref: '#/components/schemas/CapabilityState' DeviceGeneralSettingsResponse: type: object properties: data: $ref: '#/components/schemas/DeviceProperties' InterfaceSpeed: type: string enum: - AUTO - 100FD - 1000FD default: AUTO DeviceLanInterfaceDhcpAddressRange: type: object required: - first_address - last_address properties: first_address: type: string format: ipv4 description: First address (included) of the range example: 10.10.10.2 last_address: type: string format: ipv4 description: Last address (included) of the range example: 10.10.10.239 DeviceLanInterfaceDhcpStaticAddress: type: object required: - ip_address - mac_address properties: ip_address: type: string format: ipv4 description: This IP address will be statically allocated example: 10.10.10.2 mac_address: type: string description: Device's mac address example: C8:05:4D:DD:6C:25 DeviceLanPropertiesCommon: allOf: - $ref: '#/components/schemas/Timestamp' - type: object properties: interface_speed: $ref: '#/components/schemas/InterfaceSpeed' ha: $ref: '#/components/schemas/CapabilityState' routing_type: type: string enum: - NONE - STATIC - BGP - OSPF default: NONE lan_interfaces: type: array items: type: object properties: position: type: integer readOnly: true vlan: $ref: '#/components/schemas/ReferencedObject' description: Relation to a vlan object (common object) dhcp_service: $ref: '#/components/schemas/ReferencedObject' description: Relation to a dhcp service object (common object) is_main: type: boolean default: false local_parameters: type: object properties: management_ip_address: type: string format: ipv4 prefix_length: type: integer minimum: 8 maximum: 30 router1_lan_ip_address: type: string format: ipv4 example: 192.168.0.2 router2_lan_ip_address: type: string format: ipv4 example: 192.168.0.3 router3_lan_ip_address: type: string format: ipv4 example: 192.168.0.4 vrrp_virtual_ip_address: type: string format: ipv4 example: 192.168.0.5 fabric_switch_ip_address: type: string format: ipv4 example: 192.168.0.6 dhcp: type: object properties: dynamic_addresses: type: array description: An IP address will be assigned to the device from this pool of addresses items: $ref: '#/components/schemas/DeviceLanInterfaceDhcpAddressRange' excluded_addresses: type: array description: An IP address from this pool of addresses must not be assigned to the device items: $ref: '#/components/schemas/DeviceLanInterfaceDhcpAddressRange' static_addresses: description: List of IP addresses that will be statically assigned to the device type: array items: $ref: '#/components/schemas/DeviceLanInterfaceDhcpStaticAddress' is_overridden: type: boolean default: false readOnly: true ihap_enabled: type: boolean default: false vrrp_enabled: type: boolean default: false DeviceLanBgpSettings: type: object properties: peer_ip_addresses: type: array items: type: string format: ipv4 as_path_prepend: $ref: '#/components/schemas/CapabilityState' as_path_prepend_number: type: integer minimum: 1 maximum: 10 default: 1 peer_appliances: type: array items: $ref: '#/components/schemas/ReferencedObject' DeviceLanOspfVrouterSettings: allOf: - type: object required: - vrouter_id - area_id - cost - authentication_method properties: vlan: type: object $ref: '#/components/schemas/ReferencedObject' vrouter_id: type: string enum: - WAN1 - WAN2 - WAN3 area_id: type: integer format: int64 minimum: 0 maximum: 4294967295 cost: type: integer default: 10 minimum: 1 maximum: 65535 authentication_method: type: string enum: - NONE - KEYED_MD5 - HMAC_SHA1 - HMAC_SHA256 - HMAC_SHA384 - HMAC_SHA512 default: NONE key: type: string key_id: type: integer minimum: 1 maximum: 255 DeviceLanOspfSettings: allOf: - type: object required: - hello_timer - dead_timer - priority - instance_id - route_cost properties: vrouters: type: array items: $ref: '#/components/schemas/DeviceLanOspfVrouterSettings' hello_timer: type: integer default: 10 minimum: 0 maximum: 65535 dead_timer: type: integer default: 40 minimum: 0 maximum: 65535 description: Valid range is **3 * Hello Timer to 65535** priority: type: integer default: 0 minimum: 0 maximum: 255 instance_id: type: integer default: 0 minimum: 0 maximum: 255 metric_type: type: string enum: - TYPE1 - TYPE2 default: TYPE1 route_cost: type: integer default: 10000 minimum: 1 maximum: 65535 default_originate: type: boolean default: false DeviceLanStaticRoutes: allOf: - $ref: '#/components/schemas/Subnet' - type: object properties: next_hop: type: string format: ipv4 DeviceLanPropertiesLocalParametersCommon: type: object properties: bgp: $ref: '#/components/schemas/DeviceLanBgpSettings' ospf: $ref: '#/components/schemas/DeviceLanOspfSettings' subnets: type: array items: $ref: '#/components/schemas/Subnet' static_routes: type: array items: $ref: '#/components/schemas/DeviceLanStaticRoutes' default_is_is_metric: type: integer minimum: 1 maximum: 65535 default: 20000 FabricTunnelResponse: type: object description: Fabric tunnel from local appliance to remote appliance configuration properties: site: $ref: '#/components/schemas/ReferencedObject' appliance: $ref: '#/components/schemas/ReferencedObject' fabric_switch_ip_address: type: string format: ipv4 example: 192.168.0.6 is_is_metric: type: integer operational_is_is_metric: description: 'IS-IS metric on the connection sent to the appliance: the IS-IS metric configured on the connection if it exists, else the HUB IS-IS metric.' type: integer DeviceLanPropertiesLocalParametersResponse: allOf: - $ref: '#/components/schemas/DeviceLanPropertiesLocalParametersCommon' - type: object properties: fabric_tunnels: type: array items: $ref: '#/components/schemas/FabricTunnelResponse' DeviceLanPropertiesResponse: allOf: - $ref: '#/components/schemas/DeviceLanPropertiesCommon' - type: object properties: local_parameters: $ref: '#/components/schemas/DeviceLanPropertiesLocalParametersResponse' IhapProfileCommonProperties: required: - keep_alive - peer_dead_factor allOf: - $ref: '#/components/schemas/Name' - $ref: '#/components/schemas/FreeDescription' - type: object properties: keep_alive: type: integer description: Keep alive time in milliseconds. The authorized range is [50 - 10000]. The default value is 100 ms. peer_dead_factor: type: integer description: Used to tune up the waiting time of the backup appliance before acknowledging the unresponsive active peer as down. The authorized range is [3 - 10]. The default value is 5. tunnel_persistence: type: boolean default: false description: By default, this option is disabled, i.e. there are no mounted tunnels on the standby appliance. preemption: type: boolean default: true description: This option is enabled by default. It means that the nominal standby appliance can preempt the backup active engine and become active again. bad_health_criteria: type: string enum: - AND - OR default: OR description: Engine bad health criteria for recognizing a fail over condition. The default value is OR. monitored_interfaces: type: string description: Semicolon(';') separated values of interfaces want to to monitor. Values can be lan1;lan2;wan1;wan2;wan3 IhapProfileResponseContent: properties: is_default: type: boolean default: false description: Readonly field. Only true for 'default' IHAP profile allOf: - $ref: '#/components/schemas/ResponseObjectIdentifier' - $ref: '#/components/schemas/IhapProfileCommonProperties' IhapConfigurationResponseProperties: allOf: - type: object properties: ihap: type: object properties: role: type: string enum: - NOMINAL - BACKUP default: NOMINAL peer_appliance: $ref: '#/components/schemas/ReferencedObject' profile: $ref: '#/components/schemas/IhapProfileResponseContent' VrrpProfileCommonProperties: required: - protocol_version - master_priority - backup_priority - weight - check_interval_msec - fall - rise - advert_interval_msec - garp_master_delay - garp_master_repeat - garp_master_refresh - garp_master_refresh_repeat - garp_lower_prio_delay - garp_lower_prio_repeat - garp_interval_usec - gna_interval_usec - instance_identifier allOf: - $ref: '#/components/schemas/Name' - $ref: '#/components/schemas/FreeDescription' - type: object properties: protocol_version: type: integer default: 2 description: VRRP protocol version, only version 2 is supported. multicast_peering_ip: type: string default: 224.0.0.18 description: IPv4 address of the group that corresponds to the abstract representation of the master and backup routers. Valid ip address include 224.0.0.x and 239.x.y.z. preempt: type: boolean default: true description: Enable or disable preemption. preempt_delay: type: integer default: 1 description: delays VRRP transition to the master by the number of seconds specified (1 by default). This delay prevents the backup from becoming the master very frequently, in cases of network flapping. master_priority: type: integer default: 200 description: Master priority values for the VRRP preemption mechanism, valid range 1 to 254. backup_priority: type: integer default: 190 description: Backup priority values for the VRRP preemption mechanism, valid range 1 to 254. weight: type: integer default: -20 description: Weight priority values for the VRRP preemption mechanism, valid range -253 to -1. check_interval_msec: type: integer default: 1000 description: Health Check Interfaces execution interval in millisecond, by default executed every second(1000 ms), valid range 10 to 30000 ms fall: type: integer default: 1 description: Number of failed health checks before the device is considered in bad health, valid range 1 to 254. rise: type: integer default: 3 description: Number of successful health checks before the device is considered in good health again, valid range 1 to 254. advert_interval_msec: type: integer default: 1000 description: The virtual router (master) sends VRRP advertisements to other VRRP routers in the same group. The priority and group ID of the virtual router master are carried in the advertisements. Advertisements are sent every second(1000 ms) by default, valid range 10 to 30000 ms. strict: type: boolean default: false description: Check this option to ignore any customized settings and strictly adhere to VRRP rules. garp_master_delay: type: integer default: 5 description: Delay for a second set of Gratuitous ARP messages after transition to Master. Default value is 5. Enter 0 for no second set. Valid range 0 to 60. garp_master_repeat: type: integer default: 5 description: Number of Gratuitous ARP messages to send at a time after transition to Master, valid range 1 to 20. garp_master_refresh: type: integer default: 0 description: Minimum time interval in seconds for refreshing Gratuitous ARP messages while Master, valid range 0 to 60. garp_master_refresh_repeat: type: integer default: 5 description: Number of Gratuitous ARP messages to send at a time while Master, valid range 1 to 20. garp_lower_prio_delay: type: integer default: 5 description: Delay for a second set of Gratuitous ARP messages after a lower priority advert has been received when Master. Default is 5. Enter 0 for no second set, valid range 1 to 30. garp_lower_prio_repeat: type: integer default: 5 description: number of Gratuitous ARP messages to send at a time after a lower priority advert has been received when Master, valid range 1 to 20. garp_interval_usec: type: integer default: 0 description: Default interval in microseconds between Gratuitous ARP messages sent on an interface, valid range 0 to 500000. gna_interval_usec: type: integer default: 0 description: Default interval in microseconds between unsolicited NA messages sent on an interface, valid range 0 to 500000. lower_prio_no_advert: type: boolean default: false description: Optional lower priority advert. higher_prio_send_advert: type: boolean default: false description: Optional higher priority advert. min_garp: type: boolean default: false description: Optional second GARP burst of packets. instance_identifier: type: integer default: 50 description: Virtual router id, valid range 0 to 255. tracking_interfaces: type: string description: Semicolon(';') separated values of interfaces. Values can be wan1;wan2;wan3. logic_tracking_interfaces: type: string enum: - AND - OR default: AND description: Engine bad health criteria for recognizing a fail over condition. VrrpProfileResponseContent: allOf: - $ref: '#/components/schemas/ResponseObjectIdentifier' - $ref: '#/components/schemas/VrrpProfileCommonProperties' properties: is_default: type: boolean default: false description: Readonly field. Only true for 'default' VRRP profile peering_type: type: string enum: - MULTICAST - UNICAST default: MULTICAST description: Readonly field. VRRP peering type, value is MULTICAST accept: type: boolean nullable: true description: Readonly field. Value is null VrrpConfigurationResponseProperties: allOf: - type: object properties: vrrp: type: object properties: role: type: string enum: - MASTER - BACKUP default: MASTER profile: $ref: '#/components/schemas/VrrpProfileResponseContent' DeviceLanInterfacesResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/DeviceLanPropertiesResponse' - $ref: '#/components/schemas/IhapConfigurationResponseProperties' - $ref: '#/components/schemas/VrrpConfigurationResponseProperties' FabricTunnelUpdate: type: object required: - appliance properties: appliance: type: object required: - id properties: id: type: integer description: ID of remote Appliance to which remote fabric switch is connected. is_is_metric: type: integer minimum: 1 maximum: 65535 nullable: true DeviceLanPropertiesLocalParametersUpdate: allOf: - $ref: '#/components/schemas/DeviceLanPropertiesLocalParametersCommon' - type: object properties: fabric_tunnels: type: array description: List of fabric tunnels to update. Only provided tunnels may have their IS-IS metric overridden. items: $ref: '#/components/schemas/FabricTunnelUpdate' DeviceLanPropertiesUpdate: allOf: - $ref: '#/components/schemas/DeviceLanPropertiesCommon' - type: object properties: local_parameters: $ref: '#/components/schemas/DeviceLanPropertiesLocalParametersUpdate' IhapConfigurationRequestProperties: allOf: - type: object properties: ihap: type: object properties: role: type: string enum: - NOMINAL - BACKUP default: NOMINAL peer_appliance: $ref: '#/components/schemas/Id' description: Associated peer appliance from same site profile: $ref: '#/components/schemas/Id' description: Associated IHAP profile VrrpConfigurationRequestProperties: allOf: - type: object properties: vrrp: type: object properties: role: type: string enum: - MASTER - BACKUP default: MASTER profile: $ref: '#/components/schemas/Id' description: Associated VRRP profile DeviceLanInterfacesUpdateRequest: type: object properties: data: type: array items: allOf: - $ref: '#/components/schemas/DeviceLanPropertiesUpdate' - $ref: '#/components/schemas/IhapConfigurationRequestProperties' - $ref: '#/components/schemas/VrrpConfigurationRequestProperties' DeviceLanInterfacesUpdateResponse: type: object properties: data: type: array items: allOf: - $ref: '#/components/schemas/DeviceLanPropertiesResponse' - $ref: '#/components/schemas/IhapConfigurationResponseProperties' - $ref: '#/components/schemas/VrrpConfigurationResponseProperties' DeviceWanResponse: type: object properties: mode: type: string enum: - BRIDGE - ROUTER discriminator: propertyName: mode mapping: BRIDGE: '#/components/schemas/DeviceWanBridgeResponse' ROUTER: '#/components/schemas/DeviceWanRouterResponse' DeviceWanCommon: type: object required: - transport_network properties: name: type: string enum: - WAN1 - WAN2 - WAN3 description: Character string used to identify this object. readOnly: true position: type: integer readOnly: true description: type: string description: Free text to add a custom description to this object. min_bandwidth_up: type: integer minimum: 1 default: 1 description: Minimum bandwidth UP (in kbps) bandwidth_up: type: integer minimum: 1 default: 1 description: Maximum bandwidth UP (in kbps) min_bandwidth_down: type: integer minimum: 1 default: 1 description: Minimum bandwidth DOWN (in kbps) bandwidth_down: type: integer minimum: 1 default: 1 description: Maximum bandwidth DOWN (in kbps) transport_network: $ref: '#/components/schemas/ReferencedObject' interface_speed: $ref: '#/components/schemas/InterfaceSpeed' is_overridden: type: boolean default: false readOnly: true DeviceWanBridgeCommon: allOf: - $ref: '#/components/schemas/Timestamp' - $ref: '#/components/schemas/DeviceWanCommon' - type: object properties: local_parameters: type: object properties: access_router_ip_address: type: string format: ipv4 DeviceWanBridgeResponse: allOf: - $ref: '#/components/schemas/DeviceWanResponse' - $ref: '#/components/schemas/DeviceWanBridgeCommon' DeviceWanSiteToSiteUpdate: type: object required: - overlay - remote properties: overlay: $ref: '#/components/schemas/ReferencedObject' remote: type: object required: - id - wan_name description: Remote termination point of that connection properties: id: type: integer minimum: 1 description: Identifier of the remote appliance. name: type: string description: Computed Name of the remote site_id: type: integer minimum: 1 description: Identifier of the remote site. site_name: type: string description: Name of the remote site appliance_name: type: string description: Name of the remote appliance wan_name: type: string enum: - WAN1 - WAN2 - WAN3 description: Identifier of the remote WAN interface. network_pref: type: integer minimum: 0 maximum: 4294967295 default: 100 description: BGP local preference. DeviceWanRouterCommon: allOf: - $ref: '#/components/schemas/Timestamp' - $ref: '#/components/schemas/DeviceWanCommon' - type: object properties: local_parameters: type: object properties: public_ip_address: type: string format: ipv4 dhcp: $ref: '#/components/schemas/CapabilityState' ip_address: type: string description: Mandatory if DHCP is DISABLED prefix_length: type: integer description: Mandatory if DHCP is DISABLED default_gateway: type: string description: Mandatory if DHCP is DISABLED overlay_ip_address: type: string description: IP Address internally used by the system to build connections to/from this device interface readOnly: true site_to_site_connections: type: array items: $ref: '#/components/schemas/DeviceWanSiteToSiteUpdate' default_bgp_local_preference: type: integer default: 100 dti: $ref: '#/components/schemas/CapabilityState' nat: $ref: '#/components/schemas/CapabilityState' edge_sentry: $ref: '#/components/schemas/CapabilityState' mtu: type: integer default: 1500 SimpleWanOverlayResponse: type: object properties: id: type: integer minimum: 1 description: Identifier automatically generated when creating this object. name: type: string description: Character string used to identify this object. description: type: string description: Free text to add a custom description to this object. type: readOnly: true type: string description: Overlay Types enum: - HUB-AND-SPOKE - THIRD-PARTY-VPN - APPS-ANYWHERE SimpleWanSecureWebGatewayResponse: type: object properties: id: type: integer minimum: 1 description: Identifier automatically generated when creating this object. name: type: string description: Character string used to identify this object. description: type: string description: Free text to add a custom description to this object. DeviceWanRouterResponse: allOf: - $ref: '#/components/schemas/DeviceWanResponse' - $ref: '#/components/schemas/DeviceWanRouterCommon' - type: object properties: overlays: type: array items: $ref: '#/components/schemas/SimpleWanOverlayResponse' secure_web_gateway: $ref: '#/components/schemas/SimpleWanSecureWebGatewayResponse' WanInterfaceCollectionResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/DeviceWanResponse' WanInterfacesResponse: allOf: - $ref: '#/components/schemas/WanInterfaceCollectionResponse' - $ref: '#/components/schemas/XiqPage' DeviceWanUpdate: type: object properties: mode: type: string enum: - BRIDGE - ROUTER discriminator: propertyName: mode mapping: BRIDGE: '#/components/schemas/DeviceWanBridgeUpdate' ROUTER: '#/components/schemas/DeviceWanRouterUpdate' DeviceWanBridgeUpdate: allOf: - $ref: '#/components/schemas/DeviceWanUpdate' - $ref: '#/components/schemas/DeviceWanBridgeCommon' DeviceWanCommonOverlayUpdate: type: object required: - id properties: id: type: integer minimum: 1 description: Id of the overlay. type: type: string description: Overlay Types (for documentation purpose only, not required in the payload) DeviceWanHubAndSpokeOverlayUpdate: allOf: - $ref: '#/components/schemas/DeviceWanCommonOverlayUpdate' - type: object properties: connections: type: array items: type: object required: - overlay - remote properties: remote: type: object required: - id - wan_name description: Remote termination point of that connection properties: id: type: integer minimum: 1 description: Identifier of the remote appliance. name: type: string description: Computed Name of the remote site_id: type: integer minimum: 1 description: Identifier of the remote site. site_name: type: string description: Name of the remote site appliance_name: type: string description: Name of the remote appliance wan_name: type: string enum: - WAN1 - WAN2 - WAN3 description: Identifier of the remote WAN interface. network_pref: type: integer minimum: 0 maximum: 4294967295 default: 100 description: BGP local preference. ExternalGatewayConnectionCommons: type: object properties: initiator_id: type: string description: mandatory if the wan interface do not provide a public IP address local_ip_address: type: string description: subnet remote_ip_address: type: string description: mandatory in case of overlay with static routing network_pref: type: integer minimum: 0 maximum: 4294967295 description: BGP local preference. Psk: type: string description: Pre-shared key PskEncodingCreateUpdate: type: string description: PSK Encoding, null or auto to let system detect it. enum: - none - base64 - auto CredentialsUpdate: type: object description: If not provided, the configured credentials will remains as previously set. properties: mode: $ref: '#/components/schemas/AuthenticationMode' psk: $ref: '#/components/schemas/Psk' psk_encoding: $ref: '#/components/schemas/PskEncodingCreateUpdate' ExternalVpnGatewayConnectionUpdate: allOf: - $ref: '#/components/schemas/ExternalGatewayConnectionCommons' - type: object properties: credentials: $ref: '#/components/schemas/CredentialsUpdate' DeviceWanThirdPartyVpnOverlayUpdate: allOf: - $ref: '#/components/schemas/DeviceWanCommonOverlayUpdate' - type: object required: - connection properties: connection: $ref: '#/components/schemas/ExternalVpnGatewayConnectionUpdate' RouteTable: type: object properties: id: type: string description: The cloud generated id of the route table ApsAnywhereConnectionAttributes: type: object properties: bgp_local_preference: type: integer example: 100 description: BGP local preference association_route_table: $ref: '#/components/schemas/RouteTable' description: Associated route table propagation_route_tables: type: array items: $ref: '#/components/schemas/RouteTable' description: List of propagated route tables vpn_acceleration: type: boolean default: false description: VPN acceleration enable/disable for a connection propagation_labels: type: array items: type: string description: Propagation labels for connection. Applicable for Azure. (vHub) AppsAnywhereConnectionUpdate: allOf: - $ref: '#/components/schemas/ApsAnywhereConnectionAttributes' DeviceWanAppsAnywhereOverlayUpdate: allOf: - $ref: '#/components/schemas/DeviceWanCommonOverlayUpdate' - type: object required: - apps_anywhere_connection properties: apps_anywhere_connection: $ref: '#/components/schemas/AppsAnywhereConnectionUpdate' DeviceWanOverlayUpdate: type: object required: - type discriminator: propertyName: type mapping: HUB-AND-SPOKE: '#/components/schemas/DeviceWanHubAndSpokeOverlayUpdate' THIRD-PARTY-VPN: '#/components/schemas/DeviceWanThirdPartyVpnOverlayUpdate' APPS-ANYWHERE: '#/components/schemas/DeviceWanAppsAnywhereOverlayUpdate' anyOf: - $ref: '#/components/schemas/DeviceWanHubAndSpokeOverlayUpdate' - $ref: '#/components/schemas/DeviceWanThirdPartyVpnOverlayUpdate' - $ref: '#/components/schemas/DeviceWanAppsAnywhereOverlayUpdate' SecureWebGatewayDestination: type: object properties: destination: description: Designate which public IP address is targeted by that connection enum: - PRIMARY - SECONDARY SecureWebGatewayConnectionCommons: allOf: - $ref: '#/components/schemas/SecureWebGatewayDestination' - $ref: '#/components/schemas/ExternalGatewayConnectionCommons' SecureWebGatewayConnectionUpdate: allOf: - $ref: '#/components/schemas/SecureWebGatewayConnectionCommons' - type: object properties: credentials: $ref: '#/components/schemas/CredentialsUpdate' DeviceWanRouterUpdate: allOf: - $ref: '#/components/schemas/DeviceWanUpdate' - $ref: '#/components/schemas/DeviceWanRouterCommon' - type: object properties: overlays: type: array items: $ref: '#/components/schemas/DeviceWanOverlayUpdate' secure_web_gateway: type: object required: - id - connections properties: id: minimum: 1 description: Identifier of the Secure Web Gateway connections: type: array items: $ref: '#/components/schemas/SecureWebGatewayConnectionUpdate' WanInterfaceUpdateRequest: type: object properties: data: type: array items: $ref: '#/components/schemas/DeviceWanUpdate' PolicyCollection: type: object properties: fabric: type: string enum: - ENABLED - DISABLED discriminator: propertyName: fabric mapping: ENABLED: '#/components/schemas/SdWanFabricPolicyResponse' DISABLED: '#/components/schemas/SdWanDefaultPolicyResponse' SdWanPolicySyslogProperties: required: - name - ip_address - port - protocol - activated properties: name: description: Syslog Name type: string minLength: 1 maxLength: 64 pattern: '[\w!#$%&''()*+,-.\\/:;<=>@[]^`{|}~\s]*' ip_address: description: IP Address of Syslog type: string example: 100.100.100.100 port: description: Post of Syslog type: string example: '100' protocol: description: Protocol of Syslog type: string example: TCP used_for_policy: description: true is syslog is used for a policy type: boolean example: true created_at: description: timestamp of when the object was created type: string example: '2023-04-05T02:46:07.122+00:00' updated_at: description: timestamp of when the object was updated type: string example: '2023-04-05T02:46:07.122+00:00' owner_id: description: id of the owner type: number example: 1 org_id: description: id of the organization type: number example: 1 SdWanPolicyCreateUpdateCommonProperties: allOf: - $ref: '#/components/schemas/Name' - type: object properties: ntp_server_ip_address: type: string description: IP address of the server NTP format: ipv4 description: type: string description: policy description syslogs: type: array description: Array of Syslogs attached to the policy items: $ref: '#/components/schemas/SdWanPolicySyslogProperties' SdWanDefaultPolicyProperties: required: - name - ntp_server_ip_address allOf: - $ref: '#/components/schemas/SdWanPolicyCreateUpdateCommonProperties' SdWanFabricPolicyProperties: allOf: - $ref: '#/components/schemas/SdWanDefaultPolicyProperties' - type: object properties: fabric_settings: type: object required: - lan_subnet properties: lan_subnet: type: string description: Range of LAN interfaces addresses example: 192.168.0.2/20 SdWanFabricPolicyResponse: allOf: - $ref: '#/components/schemas/PolicyCollection' - $ref: '#/components/schemas/ResponseObjectIdentifier' - $ref: '#/components/schemas/SdWanFabricPolicyProperties' SdWanDefaultPolicyResponse: allOf: - $ref: '#/components/schemas/PolicyCollection' - $ref: '#/components/schemas/ResponseObjectIdentifier' - $ref: '#/components/schemas/SdWanDefaultPolicyProperties' PolicyCollectionResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/PolicyCollection' PolicyPaginatedResponse: allOf: - $ref: '#/components/schemas/PolicyCollectionResponse' - $ref: '#/components/schemas/XiqPage' XiqThreadNetworkConfig: type: object properties: id: type: integer description: The unique identifier format: int64 channel: type: integer description: The network channel format: int32 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 description: The thread network configuration and security policy XiqThreadNetworks: type: object properties: networks: type: array items: $ref: '#/components/schemas/XiqThreadNetworkConfig' description: Active thread networks XiqThreadRouterField: 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 XiqThreadRouterNeighbor: type: object 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 description: The Thread Router neighbors associate to ExtremeCloud IQ device XiqThreadIpv6Setting: type: object properties: address: type: string scope: type: string cast: type: string type: type: string description: The thread client IP addresses 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' description: The thread veth0 network interface 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 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' description: The thread network data XiqThreadMleLinkMode: type: object properties: rx_on_when_idle: type: boolean full_thread_device: type: boolean full_network_data: type: boolean description: The thread MLE Link Mode configuration XiqThreadVersion: type: object properties: thread_version: type: string build_version: type: string api_version: type: string rcp_version: type: string description: The thread version 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 description: The thread leader service 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 description: The thread border router service XiqThreadBackboneBorderRouterService: type: object properties: state: type: string description: The thread backbone border router service XiqThreadBorderAgentService: type: object properties: state: type: string udp_port: type: integer format: int32 description: The thread backbone agent service XiqThreadCommissionerService: type: object properties: state: type: string description: The commissioner service XiqThreadNat64Service: type: object properties: prefix_manager_state: type: string translator_state: type: string translator_cidr: type: string description: The nat64 service on border router XiqThreadRouter: allOf: - $ref: '#/components/schemas/XiqBaseEntity' - type: object description: The Thread Router associate to ExtremeCloud IQ device properties: id: type: integer description: The unique identifier format: int64 create_time: type: string description: The create time format: date-time update_time: type: string description: The last update time format: date-time org_id: type: integer description: The organization identifier, valid when enabling HIQ feature format: int64 owner_id: type: integer description: The owner id format: int64 device_id: type: integer description: The device unique identifier format: int64 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 description: The transmit power format: int32 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' veth0: $ref: '#/components/schemas/XiqThreadNetworkInterface' network_data: $ref: '#/components/schemas/XiqThreadNetworkData' thread_mle_link_mode: $ref: '#/components/schemas/XiqThreadMleLinkMode' thread_version: $ref: '#/components/schemas/XiqThreadVersion' leader_service: $ref: '#/components/schemas/XiqThreadLeaderService' border_router_service: $ref: '#/components/schemas/XiqThreadBorderRouterService' backbone_border_router_service: $ref: '#/components/schemas/XiqThreadBackboneBorderRouterService' border_agent_service: $ref: '#/components/schemas/XiqThreadBorderAgentService' commissioner_service: $ref: '#/components/schemas/XiqThreadCommissionerService' nat64_service: $ref: '#/components/schemas/XiqThreadNat64Service' network_config: $ref: '#/components/schemas/XiqThreadNetworkConfig' active_clients: type: integer description: The count of active connected clients format: int32 hostname: type: string description: The device hostname last_reported: type: string description: The last reported datetime format: date-time thread_connected: type: boolean description: Is router connected to thread network XiqThreadNetworkTopology: type: object 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' description: The thread network topology ThreadRouterSortField: 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 XiqThreadRouterView: type: string enum: - BASIC - DETAIL - FULL PagedXiqThreadRouter: allOf: - $ref: '#/components/schemas/XiqPage' - type: object properties: data: type: array description: The data in the current page items: $ref: '#/components/schemas/XiqThreadRouter' XiqAfcServerState: type: string description: Status of AFC server connection enum: - CONNECTED - DNS_ERROR - UNREACHABLE - CONNECTION_REFUSED - INVALID_CERT - REVOKED_CERT - NOT_FOUND - HTTP_ERROR - INVALID_RESPONSE - CONNECTION_RESET - READ_TIMEOUT - UNKNOWN_ERROR XiqAfcServer: type: object properties: state: $ref: '#/components/schemas/XiqAfcServerState' server_url: type: string description: URL of the AFC server example: https://extremeserver.afc.wi-fi.com/api/9FxgegHdMPWi2sfJ region: type: string description: The country or regulatory region for which the AFC server provides service example: United States server_id: type: integer format: int64 description: The unique identifier of the AFC server example: 2 XiqListAfcServers: type: object properties: servers: type: array description: List of AFC servers items: $ref: '#/components/schemas/XiqAfcServer' XiqAfcServerStatistics: allOf: - type: object properties: id: type: integer format: int64 description: The unique identifier create_time: type: string format: date-time description: The create time update_time: type: string format: date-time description: The last update time connection_state: type: string description: The connection state of the AFC server enum: - CONNECTED - DISCONNECTED - CONNECTING - ERROR timestamp: type: integer format: int64 description: The timestamp of the statistics data point XiqAfcServersStatistics: allOf: - type: object properties: data: type: array items: $ref: '#/components/schemas/XiqAfcServerStatistics' description: List of AFC server statistics XiqAvailableChannelInfo: type: object properties: global_operating_class: type: integer description: "Operating class:\n- 131 = 20MHz bandwidth\n- 132 = 40MHz bandwidth \n- 133 = 80MHz bandwidth\n- 134 = 160MHz bandwidth\n- 137 = 320MHz bandwidth\n" channel_cfi: type: array description: RF channel numbers items: type: integer max_eirp: type: array description: Maximum RF power in dB items: type: number format: double XiqAfcAvailableSpectrum: type: object properties: request_id: type: string description: serial number of AP available_channel_info: type: array description: Available channel information for this AP items: $ref: '#/components/schemas/XiqAvailableChannelInfo' availability_expire_time: type: string description: Expiration time for the spectrum availability in ISO 8601 format XiqAfcApInterfaceDetails: type: object properties: status: $ref: '#/components/schemas/XiqAfcApStatus' expire: type: integer format: int64 description: Timestamp of the next AP channel/power info query (seconds from epoch) received: type: integer format: int64 description: Timestamp of the acquired channel/power (seconds from epoch) reason: type: string description: Reason for the current AFC status spectrum: $ref: '#/components/schemas/XiqAfcAvailableSpectrum' band_width: type: integer format: int64 description: Bandwidth used by the AP XiqReportFtmDataRequest: type: object properties: owner_id: type: integer format: int64 description: The owner ID ids: type: array description: List of Access Point IDs to request FTM data for items: type: integer format: int64 required: - owner_id - ids XiqAfcApStatusSummary: allOf: - type: object properties: totalAvailable: type: integer totalPending: type: integer totalGracePeriod: type: integer XiqAfcFloorDetails: type: object description: AFC Floor Details containing floor and AP height information properties: id: type: integer format: int64 description: Unique identifier for the floor details record floor_id: type: integer format: int64 description: The ID of the floor floor_height: type: number format: float description: Height of the floor floor_height_accuracy: type: integer format: int64 description: Accuracy of the floor height measurement ap_height: type: number format: float description: Height of the access point ap_height_accuracy: type: integer format: int64 description: Accuracy of the AP height measurement XiqAfcStatusSummary: type: object description: AFC Status Summary information properties: total_available: type: integer description: Total number of APs available total_pending: type: integer description: Total number of APs pending total_grace_period: type: integer description: Total number of APs in grace period XiqAfcGeolocationSummary: allOf: - type: object properties: total_available: type: integer description: Total number of Aps that have reported their geo location. total_unavailable: type: integer description: Total number of Aps that have not reported their geo location. XiqSpectrumMismatchSummary: type: object description: Spectrum Mismatch Summary information properties: total_backup: type: integer description: Total number of APs in backup mode total_radio_off: type: integer description: Total number of APs with radio off total_reduced: type: integer description: Total number of APs with reduced power XiqAfcApsInfoElement: type: object description: AFC APs Information Element containing status summaries properties: total_devices: type: integer description: Total number of AFC supported APs afc_status: $ref: '#/components/schemas/XiqAfcStatusSummary' description: AFC status summary information geo_location: $ref: '#/components/schemas/XiqAfcGeolocationSummary' description: Geolocation summary information spectrum_mismatch: $ref: '#/components/schemas/XiqSpectrumMismatchSummary' description: Spectrum mismatch summary information XiqAfcApDiagnostics: type: object description: AFC AP Diagnostics containing spectrum details properties: afc_spectrum_details: type: string description: AFC spectrum details for the AP diagnostics XiqGetAfcGeolocationFloorReportResponse: type: object description: Response containing AFC floor report data properties: floor_report: type: string description: | Floor geolocation report data used for AFC (Automated Frequency Coordination) calculations. required: - floor_report XiqAfcApManualSpectrum: type: object description: Manual spectrum request for AFC AP devices properties: ids: type: array description: List of AP device IDs for manual spectrum request items: type: integer format: int64 required: - ids XiqAfcSiteScheduleResponse: allOf: - type: object properties: ownerId: type: integer format: int64 folderId: type: integer format: int64 description: Site folder ID, retrievable through device inventory API example: 67890 siteTimeZone: type: string description: The timezone identifier for the site location, uses TZ database time zones format example: America/New_York siteSchedule: type: integer format: int64 description: The time of day in milliseconds since 00:00:00 (midnight) in the specified timezone when AFC spectrum recalculation should be performed for this site. Default is 0 (midnight) for new outdoor sites. example: 7200000 default_schedule: type: boolean XiqAfcSiteSchedule: allOf: - type: object properties: ownerId: type: integer format: int64 folderId: type: integer format: int64 description: Site folder ID, retrievable through device inventory API example: 67890 siteTimeZone: type: string description: The timezone identifier for the site location, uses TZ database time zones format example: America/New_York siteSchedule: type: integer format: int64 description: The time of day in milliseconds since 00:00:00 (midnight) in the specified timezone when AFC spectrum recalculation should be performed for this site. Default is 0 (midnight) for new outdoor sites. example: 7200000 isDefaultSchedule: type: boolean XiqMacAddress: description: Colon separated MAC address in upper or lower case type: string pattern: ^([0-9A-Fa-f]{2}[:]){5}([0-9A-Fa-f]{2})$ example: 18:09:F8:61:6B:C0 XiqAfcMobileappScanInfo: allOf: - type: object properties: ownerId: type: integer format: int64 bssidList: type: array description: Base radio BSSIDs reported by the mobile application scan items: $ref: '#/components/schemas/XiqMacAddress' XiqAfcMobileappAnchorCandidate: allOf: - type: object properties: id: type: integer description: The device unique identifier format: int64 serial: type: string description: The device serial number name: type: string description: AP name mac_address: $ref: '#/components/schemas/XiqMacAddress' 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, AP_5050D, AP_5020 etc.' location: type: string description: The location of the device, including floor name bssid: $ref: '#/components/schemas/XiqMacAddress' description: Base radio BSSID gpsAnchor: type: boolean default: false description: Use this AP as GPS anchor to derive geo-coordinates of other APs on the floor coordinates: $ref: '#/components/schemas/XiqAfcMobileappCoordinates' neighbors: type: integer description: Number of neighboring APs. XiqMobileappAnchorCandidatesResponse: type: object properties: candidates: description: List of AP candidates that may be used as anchors type: array items: $ref: '#/components/schemas/XiqAfcMobileappAnchorCandidate' description: The response for afc mobile app anchor candidates XiqUcpEngineInstanceElement: allOf: - type: object description: The payload of the UCP Engine Instance Installation Information properties: name: type: string description: The engine instance name displayName: type: string description: The display name of the instance XiqUcpEngineElement: allOf: - type: object description: The payload of the UCP Engine Installation Information properties: name: type: string description: The engine ID description: type: string description: The engine display name instances: type: array items: $ref: '#/components/schemas/XiqUcpEngineInstanceElement' instanceCount: type: integer maxInstances: type: integer type: type: string upgradable: type: boolean imageName: type: string XiqUcpEnginesInstalled: allOf: - type: object properties: engines: type: array description: The installed engines items: $ref: '#/components/schemas/XiqUcpEngineElement' example: engines: - name: xiq description: ExtremeCloud IQ instances: [] instanceCount: 0 maxInstances: 1 type: none upgradable: false - name: xiqtc description: Extreme Tunnel Concentrator instances: - name: xiqtc-1 displayName: 'xiqtc #1' instanceCount: 1 maxInstances: 3 type: vmi upgradable: true imageName: vmidisks/xiqtc XiqApiAccessToken: type: object description: The API Access Token. properties: id: type: integer description: The unique identifier format: int64 create_time: type: string description: The create time format: date-time update_time: type: string description: The last update time format: date-time accessToken: type: string description: The access token granted expireAt: type: integer description: The timestamp at which the token expires refreshToken: type: string description: The refresh token grantor: type: string description: The name of the grantor of API Access Token applicationName: type: string description: The third party application name clientId: type: string description: The client ID PagedXiqApiAccessToken: allOf: - $ref: '#/components/schemas/XiqPage' - type: object properties: data: type: array description: The data in the current page items: $ref: '#/components/schemas/XiqApiAccessToken' XiqCreateApiAccessTokenRequest: type: object required: - clientId properties: clientId: type: string description: The ID given to the client tokenExpireInDay: type: string description: The expiry of the token in days XiqApiAccessTokenResponse: type: object properties: owner_id: type: integer description: 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 generated expiration: type: integer description: The expiration refresh_token: type: string description: The refresh token generated XiqUpdateApiAccessTokenRequest: type: object required: - clientId properties: tokenExpireInDay: type: string description: The expiry of the token in days XiqThirdPartyApiConnection: allOf: - type: object description: The 3rd party API connections data model required: - api_token properties: api_token: type: string description: The api token. created_at: type: integer description: The api token created time in milliseconds. XiqUpdateThirdPartyApiConnectionRequest: type: object description: The payload to update 3rd party API connection required: - api_token properties: api_token: type: string description: This api token will overwrite the existing api token. XiqEmployeeGroup: type: string description: Employee Group Json Type enum: - EMPLOYEE_GROUP_ADMIN - EMPLOYEE_GROUP_AD - EMPLOYEE_GROUP_MANAGE XiqAdEmployeeGroup: allOf: - $ref: '#/components/schemas/XiqViqEntity' - type: object properties: name: type: string description: Name of the member group. owner_id: type: integer description: ID of the owner of the member group. XiqManageEmployeeGroup: allOf: - $ref: '#/components/schemas/XiqViqEntity' - type: object properties: name: type: string description: Acct User Details name. owner_id: type: integer description: The owner ID. XiqAdminEmployeeGroup: allOf: - $ref: '#/components/schemas/XiqViqEntity' - type: object properties: id: type: integer description: The admin member group ID. XiqUserGroups: allOf: - $ref: '#/components/schemas/XiqViqEntity' - type: object description: User Group response object for Credential Distribution Group properties: ownerId: type: integer format: int64 description: The ID of the owner of the user group. name: type: string description: The name of the user group. json_type: type: string description: The type of JSON data, e.g., "cloud-ppsk-user-group". description: type: string description: The description of the user group. password_rule_settings_id: type: integer format: int64 description: The ID of password rule settings for the user group. delivery_policy_settings_id: type: integer format: int64 description: The ID of delivery policy settings for the user group. time_expiration_settings_id: type: integer format: int64 description: The ID of time expiration settings for the user group. user_count: type: integer description: The number of users in the user group. ssids: type: array description: List of SSIDs associated with the user group. items: type: string group_type: type: string description: The type of user group, e.g., "CLOUD_PPSK". pcg_use_only: type: boolean description: Indicates if PCG use only is enabled. ppsk_use_only: type: boolean description: Indicates if PPSK use only is enabled. enable_pcg_filter: type: boolean description: Indicates if PCG filter is enabled. enable_self_reg: type: boolean description: Indicates if self-registration is enabled. enable_renew: type: boolean description: Indicates if renewal is enabled. XiqCredentialDistributionGroup: allOf: - $ref: '#/components/schemas/XiqViqEntity' - type: object properties: owner_id: type: integer description: The owner id. group_type: type: string description: The type of credential distribution group which can be "MANAGE" or "AD". 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/XiqEmployeeGroup' description: Type of JSON, in this case "ad-employee-group", "admin-employee-group" or "manage-employee-group". employee_group: type: array items: type: object description: The Employee Group oneOf: - $ref: '#/components/schemas/XiqAdEmployeeGroup' - $ref: '#/components/schemas/XiqManageEmployeeGroup' - $ref: '#/components/schemas/XiqAdminEmployeeGroup' discriminator: propertyName: json_type mapping: ad-employee-group: '#/components/schemas/XiqAdEmployeeGroup' manage-employee-group: '#/components/schemas/XiqManageEmployeeGroup' admin-employee-group: '#/components/schemas/XiqAdminEmployeeGroup' name: type: string description: Name of the entity. restrict_number: type: string description: Number restriction. user_groups: type: array description: The list of User Groups items: $ref: '#/components/schemas/XiqUserGroups' PagedXiqCredentialDistributionGroup: allOf: - $ref: '#/components/schemas/XiqPage' - type: object properties: data: type: array description: The data in the current page items: $ref: '#/components/schemas/XiqCredentialDistributionGroup' XiqAdEmployeeGroupRequest: type: object properties: name: type: string description: Name of the member group. owner_id: type: integer description: ID of the owner of the member group. XiqManageEmployeeGroupRequest: type: object properties: name: type: string description: Acct User Details name. owner_id: type: integer description: The owner ID. XiqAdminEmployeeGroupRequest: type: object properties: id: type: integer description: The admin member group ID. XiqCreateCredentialDistributionGroupRequest: type: object properties: name: type: string description: Name of the credential distribution group. owner_id: type: integer description: The owner ID. 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/XiqEmployeeGroup' description: Type of JSON, in this case "ad-employee-group", "admin-employee-group" or "manage-employee-group". employee_group: type: array items: type: object description: The Employee Group oneOf: - $ref: '#/components/schemas/XiqAdEmployeeGroupRequest' - $ref: '#/components/schemas/XiqManageEmployeeGroupRequest' - $ref: '#/components/schemas/XiqAdminEmployeeGroupRequest' discriminator: propertyName: json_type mapping: ad-employee-group: '#/components/schemas/XiqAdEmployeeGroupRequest' manage-employee-group: '#/components/schemas/XiqManageEmployeeGroupRequest' admin-employee-group: '#/components/schemas/XiqAdminEmployeeGroupRequest' restrict_number: type: string description: Number restriction. user_group_ids: type: array items: type: integer description: The list of user group IDs. XiqUpdateCredentialDistributionGroupRequest: type: object properties: name: type: string description: Name of the credential distribution group. owner_id: type: integer description: The owner ID. 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/XiqEmployeeGroup' description: Type of JSON, in this case "ad-employee-group", "admin-employee-group" or "manage-employee-group". employee_group: type: array items: type: object description: The Employee Group oneOf: - $ref: '#/components/schemas/XiqAdEmployeeGroupRequest' - $ref: '#/components/schemas/XiqManageEmployeeGroupRequest' - $ref: '#/components/schemas/XiqAdminEmployeeGroupRequest' discriminator: propertyName: json_type mapping: ad-employee-group: '#/components/schemas/XiqAdEmployeeGroupRequest' manage-employee-group: '#/components/schemas/XiqManageEmployeeGroupRequest' admin-employee-group: '#/components/schemas/XiqAdminEmployeeGroupRequest' restrict_number: type: string description: Number restriction. user_group_ids: type: array items: type: integer description: The list of user group IDs. XiqAlertsResponse: type: object 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 required: - critical - warning - information - total_unacknowledged XiqAssetsResponse: type: object 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 XiqClientHealthResponse: type: object 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 XiqDeviceHealthResponse: type: object 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 XiqUsageAndCapacityResponse: type: object properties: total_usage_and_capacity_issues: type: integer format: int64 description: Total count of usage & capacity issues wired_usage_and_capacity_issues: type: integer format: int64 description: Count of wired usage & capacity issues which includes switches and client issues wireless_usage_and_capacity_issues: type: integer format: int64 description: Count of wireless usage & capacity issues which includes access point issues XiqSiteWithIssuesSortField: type: string title: XiqSiteWithIssuesSortField description: Pre-defined sort fields for Site with issues enum: - ALERTS - STATUS - DEVICE_HEALTH - CLIENT_HEALTH - USAGE_CAPACITY - SITE_NAME example: ALERTS XiqSitesWithIssuesResponse: type: object 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 alerts: $ref: '#/components/schemas/XiqAlertsResponse' description: Alerts diagnostics of the site assets: $ref: '#/components/schemas/XiqAssetsResponse' description: Assets diagnostics of the site client_health: $ref: '#/components/schemas/XiqClientHealthResponse' description: Client Health diagnostics of the site device_health: $ref: '#/components/schemas/XiqDeviceHealthResponse' description: Device Health diagnostics of the site usage_and_capacity: $ref: '#/components/schemas/XiqUsageAndCapacityResponse' description: Usage and Capacity diagnostics of the site PagedXiqSitesWithIssuesResponse: allOf: - $ref: '#/components/schemas/XiqPage' - type: object properties: data: type: array description: The data in the current page items: $ref: '#/components/schemas/XiqSitesWithIssuesResponse' XiqRmDiagnosticsDeviceType: type: string description: The type of RM diagnostic device enum: - WIRED - WIRELESS - ALL XiqWirelessDeviceHealthCriteria: type: object properties: id: type: integer format: int64 description: Unique ID for Entry owner_id: type: integer format: int64 description: Owner ID for entry org_id: type: integer format: int64 description: Organization ID of the Entry cpu_utilization: type: integer format: float description: If CPU Utilization => 90% then issue is raised cpu_utilization_reln: type: string description: Operator for CPU utilization memory_utilization: type: integer format: float description: If Memory Utilization => 90% then issue is raised memory_utilization_reln: type: string description: Operator for memory utilization poe: type: integer format: int64 description: Device receiving power that allows full functionality (model dependent) wired_port_multicast: type: integer format: float description: If multicast in Wired port => 75% then issue is raised wired_port_multicast_reln: type: string description: Operator for wired port multicast wired_port_broadcast: type: integer format: float description: If broadcast in Wired port => 75% then issue is raised wired_port_broadcast_reln: type: string description: Operator for wired port broadcast XiqWirelessClientHealthCriteria: type: object properties: id: type: integer format: int64 description: Unique ID owner_id: type: integer format: int64 description: Owner ID of the Entry org_id: type: integer format: int64 description: Organization ID of the Entry assoc_reln_slow: type: string description: Operator for slow associations assoc_param_slow: type: integer format: int64 description: If slow associations. Slow >= 5 sec assoc_unit_slow: type: string description: Unit for slow associations auth_reln_slow: type: string description: Operator for slow Authentications auth_param_slow: type: integer format: int64 description: If Authentications is slow. Slow => 5 sec auth_unit_slow: type: string description: Unit for Authentications dhcp_reln_slow: type: string description: Operator for DHCP dhcp_param_slow: type: integer format: int64 description: DHCP if failed, Slow => 5 sec dhcp_unit_slow: type: string description: Unit for DHCP roams_reln_slow: type: string description: Operator for Roams roams_param_slow: type: integer format: int64 description: If Roams - Failed or slow roams. Slow => 3000 ms roams_unit_slow: type: string description: Unit for Roams rssi_reln: type: string description: Operator for RSSI rssi_param: type: integer format: int64 description: If RSSI <= -73dBm rssi_unit: type: string description: Unit for RSSI snr_reln: type: string description: Operator for SNR snr_param: type: integer format: int64 description: SNR <= 20dB snr_unit: type: string description: Unit for SNR onboard_reln: type: string description: Operator for onboard timing onboard_param: type: integer format: int64 description: 'If Onboarding time: > 10sec' onboard_unit: type: string description: Unit for onboard timing XiqWirelessUsageAndCapacityCriteria: type: object properties: id: type: integer format: int64 description: Unique ID owner_id: type: integer format: int64 description: Owner ID of the Entry org_id: type: integer format: int64 description: Organization ID of the Entry radio_24: type: integer format: float description: If 2.4GHz Radio Usage >= 70% issue is raised radio_24_reln: type: string description: Operator for 2.4GHz Radio Usage radio_5: type: integer format: float description: If 5GHz Radio Usage >= 70% issue is raised radio_5_reln: type: string description: Operator for 5GHz Radio Usage radio_6: type: integer format: float description: If 6GHz Radio Usage >= 70% issue is raised radio_6_reln: type: string description: Operator for 6GHz Radio Usage lnk_err_24: type: integer format: float description: If Link Error for 2.4GHz Radio >= 2% issue is raised lnk_err_24_reln: type: string description: Operator for 2.4GHz Link Error lnk_err_5: type: integer format: float description: If Link Error for 5GHz Radio >= 2% issue is raised lnk_err_5_reln: type: string description: Operator for 5GHz Link Error lnk_err_6: type: integer format: float description: If Link Error for 6GHz Radio >= 2% issue is raised lnk_err_6_reln: type: string description: Operator for 6GHz Link Error retries_24: type: integer format: float description: If Retries for 2.4GHz Radio >= 25% issue is raised retries_24_reln: type: string description: Operator for 2.4GHz Retries retries_5: type: integer format: float description: If Retries for 5GHz Radio >= 25% issue is raised retries_5_reln: type: string description: Operator for 5GHz Retries retries_6: type: integer format: float description: If Retries for 6GHz Radio >= 25% issue is raised retries_6_reln: type: string description: Operator for 6GHz Retries pkt_loss_24: type: integer format: float description: If Packet Loss for 2.4GHz Radio >= 5% issue is raised pkt_loss_24_reln: type: string description: Operator for 2.4GHz Packet Loss pkt_loss_5: type: integer format: float description: If Packet Loss for 5GHz Radio >= 5% issue is raised pkt_loss_5_reln: type: string description: Operator for 5GHz Packet Loss pkt_loss_6: type: integer format: float description: If Packet Loss for 6GHz Radio >= 5% issue is raised pkt_loss_6_reln: type: string description: Operator for 6GHz Packet Loss interference_24: type: integer format: float description: If Interference for 2.4GHz Radio >= 50% issue is raised interference_24_reln: type: string description: Operator for 2.4GHz Interference interference_5: type: integer format: float description: If Interference for 5GHz Radio >= 50% issue is raised interference_5_reln: type: string description: Operator for 5GHz Interference interference_6: type: integer format: float description: If Interference for 6GHz Radio >= 50% issue is raised interference_6_reln: type: string description: Operator for 6GHz Interference noise_24: type: integer format: float description: If Noise for 2.4GHz Radio is > -82dBm issue is raised noise_24_reln: type: string description: Operator for 2.4GHz Noise noise_24_unit: type: string description: Unit for 2.4GHz Noise noise_5: type: integer format: float description: If Noise for 5GHz Radio is > -82dBm issue is raised noise_5_reln: type: string description: Operator for 5GHz Noise noise_5_unit: type: string description: Unit for 5GHz Noise noise_6: type: integer format: float description: If Noise for 6GHz Radio is > -82dBm issue is raised noise_6_reln: type: string description: Operator for 6GHz Noise noise_6_unit: type: string description: Unit for 6GHz Noise XiqPostWirelessDeviceHealthCriteria: type: object properties: cpu_utilization: type: integer format: int64 description: CPU Utilization percentage memory_utilization: type: integer format: int64 description: Memory Utilization percentage poe: type: integer format: int64 description: Power over Ethernet (PoE) usage wired_port_multicast: type: integer format: int64 description: Wired Port Multicast traffic percentage wired_port_broadcast: type: integer format: int64 description: Wired Port Broadcast traffic percentage XiqPostWirelessClientHealthCriteria: type: object properties: assoc_param_slow: type: integer format: int64 description: Association parameter for slow connections assoc_unit_slow: type: string description: Unit for association parameter for slow connections auth_param_slow: type: integer format: int64 description: Authentication parameter for slow connections auth_unit_slow: type: string description: Unit for authentication parameter for slow connections dhcp_param_slow: type: integer format: int64 description: DHCP parameter for slow connections dhcp_unit_slow: type: string description: Unit for DHCP parameter for slow connections roams_param_slow: type: integer format: int64 description: Roaming parameter for slow connections roams_unit_slow: type: string description: Unit for roaming parameter for slow connections rssi_param: type: integer format: int64 description: RSSI parameter rssi_unit: type: string description: Unit for RSSI parameter snr_param: type: integer format: int64 description: SNR parameter snr_unit: type: string description: Unit for SNR parameter onboard_param: type: integer format: int64 description: Onboarding parameter onboard_unit: type: string description: Unit for onboarding parameter XiqPostWirelessUsageAndCapacityCriteria: type: object properties: channel_utilization: type: integer format: int64 description: Channel Utilization percentage lnk_err: type: integer format: int64 description: Link Error percentage retries: type: integer format: int64 description: Retries percentage pkt_loss: type: integer format: int64 description: Packet Loss percentage interference: type: integer format: int64 description: Interference percentage noise: type: integer format: int64 description: Noise level noise_unit: type: string description: Unit for Noise level RmSurroundingAps: type: object description: The Info about surrounding AP properties: mac: type: string description: The MAC address (BSSID) of the AP ssid: type: string description: SSID of the AP channelWidth: type: string description: Channel width rssi: type: integer description: Received Signal Strength Indicator (RSSI) mode: type: string description: Mode (Access / Backhaul) apType: type: integer description: Type of AP (0 --> unknown, 1 --> rogue AP, 2 --> friendly AP) isExtremeDevice: type: string description: Indicates if the device is an Extreme device channelUtilization: type: string description: Channel utilization percentage channelCrcRate: type: string description: Channel CRC rate clientNum: type: integer description: Number of clients connected PagedRmSurroundingAps: allOf: - $ref: '#/components/schemas/XiqPage' - type: object properties: data: type: array description: The data in the current page items: $ref: '#/components/schemas/RmSurroundingAps' RmWifiIntStats: type: object description: The WiFi interface stats properties: ssid_count: type: integer ssids: type: array items: type: string number_of_clients: type: integer channel_utilization: type: integer channel: type: integer channel_width: type: integer load_balancing: type: boolean band_steering: type: boolean channel_utilization_details: type: object properties: interference_percentage: type: integer tx_retries_percentage: type: integer rx_retries_percentage: type: integer RmWirelessInterfacesList: type: array description: The WiFi interface list. items: type: object properties: wifi0: $ref: '#/components/schemas/RmWifiIntStats' description: Stats of WiFi interface 0 wifi1: $ref: '#/components/schemas/RmWifiIntStats' description: Stats of WiFi interface 1 wifi2: description: Stats of WiFi interface 2 allOf: - $ref: '#/components/schemas/RmWifiIntStats' - type: object properties: afc_status: $ref: '#/components/schemas/XiqAfcApStatus' RmDeviceDetails: type: object description: The Device Details. properties: system_name: type: string description: The name of the system ip_address: type: string description: The IP address of the device model: type: string description: The model of the device sys_up_time: type: string description: The system uptime os_version: type: string description: The operating system version location: type: string description: The physical location of the device system_mac: type: string description: The MAC address of the system serial_number: type: string description: The serial number of the device system_description: type: string description: A brief description of the system software_version: type: string description: The version of the software running on the device device_license_tier: $ref: '#/components/schemas/XiqDeviceLicenseTier' device_license_type: $ref: '#/components/schemas/XiqAhDeviceLicenseType' RmDeviceSystemInformation: type: object description: The Device System Information. properties: host_name: type: string description: The name of the host network_policy: type: string description: The network policy applied to the device ssid: type: array items: type: string description: The SSIDs of the network device_model: type: string description: The model of the device function: $ref: '#/components/schemas/XiqDeviceFunction' device_template: type: string description: The template used for the device configuration alias: type: string description: The alias configuration_type: type: string description: The type of configuration applied to the device serial_number: type: string description: The serial number of the device iq_engine: type: string description: The IQ engine version running on the device device_status: $ref: '#/components/schemas/XiqDeviceAdminState' mgt0_ipv4_address: type: string description: The IPv4 address of the management interface mgt0_ipv6_address: type: string description: The IPv6 address of the management interface ipv4_subnet_mask: type: string description: The IPv4 subnet mask ipv6_subnet_mask: type: string description: The IPv6 subnet mask ipv4_default_gateway: type: string description: The IPv4 default gateway ipv6_default_gateway: type: string description: The IPv6 default gateway mgt0_macaddress: type: string description: The MAC address of the management interface dns: type: string description: The DNS server addresses ntp: type: string description: The NTP server addresses RmDeviceSummary: type: object description: The Device Summary. properties: connected_status: type: boolean description: Whether device is connected or not active_since: type: integer description: Timestamp for time since when device is online format: int64 device_health_issues: type: integer description: Number of device issues usage_and_capacity_issues: type: integer description: Number of usage and capacity issues client_health_issues: type: integer description: Number of client health issues device_details: $ref: '#/components/schemas/RmDeviceDetails' system_information: $ref: '#/components/schemas/RmDeviceSystemInformation' RmDeviceGeoLocation: type: object description: The Device Details. properties: gps_last_reported: type: integer description: Timestamp of when gps was last reported format: int64 latitude: type: integer description: The latitude of geo location format: int64 longitude: type: integer description: The longitude of geo location format: int64 elevation: type: integer description: The elevation in metres format: int64 GraphResponse: type: object description: The Graph metric response. properties: data: type: array description: The graph metric points items: type: object properties: value: type: integer description: The graph metric value format: int64 timestamp: type: integer description: The graph metric timestamp format: int64 RmClientGraphFilterType: type: string title: RmClientGraphFilterType description: Pre-defined filters for client graph enum: - CONNECTED_CLIENTS - UNIQUE_CLIENTS - POOR_HEALTH_CLIENTS - ALL example: CONNECTED_CLIENTS RmClientGraphResponse: type: object description: The response for client graph. properties: timestamp: type: integer description: The graph metric timestamp. format: int64 connected_clients: type: integer format: int64 description: The channel utilization percentage. unique_clients: type: integer format: int64 description: The number of clients connected. poor_health_clients: type: integer format: int64 description: The signal-to-noise ratio. XiqDeviceType: type: string title: XiqDeviceType description: Pre-defined filters for XIQ device type enum: - WIRELESS - WIRED example: WIRED RmDeviceData: type: object description: The Device Data. properties: folder_id: type: integer format: int64 description: Unique identifier for the folder containing the device. device_id: type: integer format: int64 description: Unique identifier for the device. device_mac_address: type: string description: MAC address of the device. device_type: type: string description: Type or category of the device. device_function: type: string description: Function or role of the device. device_model: type: string description: The model of the device. host_name: type: string description: Hostname assigned to the device. image_base_url: type: string description: Base URL for the device's image. image_file_name: type: string description: File name of the device's image. image_width: type: integer description: Width of the device's image in pixels. image_height: type: integer description: Height of the device's image in pixels. connected_since: type: integer format: int64 description: Timestamp indicating when the device was first connected. xaxis: type: integer description: X-axis coordinate of the device's location. yaxis: type: integer description: Y-axis coordinate of the device's location. RmDevicePathInfo: type: object description: The Device location path info. properties: folder_id: type: integer format: int64 description: Unique identifier for the folder. parent_id: type: integer format: int64 description: Unique identifier for the parent folder. name: type: string description: Name of the folder. folder_type: type: string description: Type of the folder (e.g., FLOOR). RmMediaUploadResponse: type: object description: The Media Upload response. properties: id: type: integer description: Unique identifier for the media. createdAt: type: integer format: int64 description: Timestamp when the media was created. updatedAt: type: integer format: int64 description: Timestamp when the media was last updated. ownerId: type: integer description: Unique identifier for the owner of the media. orgId: type: integer description: Unique identifier for the organization. deviceId: type: integer description: Unique identifier for the device. title: type: string description: Title of the media. type: type: string description: Type of the media (e.g., IMAGE, VIDEO). size: type: integer description: Size of the media in bytes. height: type: integer description: Height of the media in pixels. width: type: integer description: Width of the media in pixels. originalUrl: type: string description: URL to access the original media. thumbnailUrl: type: string description: URL to access the thumbnail version of the media. description: type: string description: Description of the media. RmWiredInterfaceGrid: type: array description: An array of wired interface objects. items: type: object properties: status: type: string enum: - online - offline - unknown description: The status of the interface. interface: type: string enum: - eth0 - eth1 description: The interface identifier. poe_usage: type: boolean description: Whether POE is being used port: type: string description: The port type. speed: type: integer description: The speed of the interface in Mbps. tx_bytes: type: integer description: The number of transmitted bytes. rx_bytes: type: integer description: The number of received bytes. tx_errors: type: integer description: The number of transmission errors. rx_errors: type: integer description: The number of reception errors. tx_drops: type: integer description: The number of dropped transmitted packets. rx_drops: type: integer description: The number of dropped received packets. XiqDeviceHealthGridResponse: type: object properties: device_id: type: integer description: The device identifier format: int64 hostname: type: string description: The hostname of the client device_ip: type: string description: The IP address of the client 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 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 has_device_health_issue: type: boolean description: Indicates where the device has a device health issue RmChannelFilterType: type: string title: RmChannelFilterType description: Pre-defined channel filters for wireless interface graph enum: - WIFI0 - WIFI1 - WIFI2 example: WIFI0 RmSourceFilterType: type: string title: RmSourceFilterType description: Pre-defined filters for wireless interface graph enum: - CHANNEL_UTILIZATION - CONNECTED_CLIENTS example: CHANNEL_UTILIZATION RmWirelessInterfacesGraphResponse: type: object description: The response for Wireless Interfaces graph. properties: timestamp: type: integer description: The graph metric timestamp. format: int64 channel_utilization: type: integer description: The channel utilization. format: int64 connected_clients: type: integer format: int64 description: The channel utilization percentage. RmClientStats: type: object description: The Client statistics.. properties: total_clients: type: integer description: Total clients within selected time range. poor_health_clients: type: integer description: Number of poor health clients unique_clients: type: integer description: Number of unique clients RmDevices: title: RmDevices description: The devices supported with IQE. 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 example: AP_650 RmDeviceInterfaces: type: string title: XiqDeviceType description: Pre-defined filters for XIQ device type enum: - WIFI0 - WIFI1 - WIFI2 example: WIFI0 RmClientStatisticsFilter: type: string title: RmClientStatisticsFilter description: The pre defined filters for Client statistics grid enum: - POOR_HEALTH - UNIQUE - TOTAL example: POOR_HEALTH RmD360ClientGrid: type: object description: The Client statistics. properties: connection_status: type: boolean description: Connection status of the client. client_hostname: type: string description: Hostname of the client. client_ip: type: string description: IP address of the client. site: type: string description: Site where the client is located. building: type: string description: Building where the client is located. floor: type: string description: Floor where the client is located. association_issues: type: integer description: Number of association issues. authentication_issues: type: integer description: Number of authentication issues. ip_address_issues: type: integer description: Number of IP address issues. snr: type: integer description: Signal-to-noise ratio. rssi: type: integer description: Received signal strength indicator. channel_utilization_score: type: integer description: Channel utilization score. frequency: type: string description: Frequency band used by the client. roaming_issues: type: integer description: Number of roaming issues. ipv4: type: string description: IPv4 address of the client. connected_device_mac: type: string description: MAC address of the connected device. ssid: type: string description: SSID of the network. vlan: type: integer description: VLAN ID. username: type: string description: Username of the client. authentication: type: string description: Authentication method used. encryption: type: string description: Encryption method used. user_profile: type: string description: User profile assigned to the client. alias: type: string description: Alias of the client. category_assignment: type: string description: Category assignment of the client. ipv6: type: string description: IPv6 address of the client. client_device_id: type: integer description: Unique identifier for the client device. device_id: type: integer description: Unique identifier for the device. last_session_start_time: type: integer format: int64 description: Timestamp of the last session start time. operating_system: type: string description: Operating system of the client device. client_mac: type: string description: MAC address of the client device. PagedRmD360ClientGrid: allOf: - $ref: '#/components/schemas/XiqPage' - type: object properties: data: type: array description: The data in the current page items: $ref: '#/components/schemas/RmD360ClientGrid' RmWiredQueueStats: type: object properties: qos_queue: type: integer format: int64 description: QOS queue value. In Switch Engine (EXOS) the values of 1 through 8 correspond to QOS profiles QP1 through QP8 respectively. In Fabric Engine (VOSS) the values of 0 to 7 correspond to QOS COS queues. 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. RmWiredPortQosState: 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: allOf: - type: array - $ref: '#/components/schemas/RmWiredQueueStats' RmWiredQueueGridResponse: type: array description: QOS queue statistics per interface items: allOf: - type: array - $ref: '#/components/schemas/RmWiredPortQosState' PagedRmWiredQueueGridResponse: allOf: - $ref: '#/components/schemas/XiqPage' - type: object properties: data: type: array description: The data in the current page items: $ref: '#/components/schemas/RmWiredQueueGridResponse' XiqClientHealthSortField: type: string title: ClientHealthSortField description: Pre-defined filters for warnings in dashboard - OPERATING_SYSTEM - CLIENT_RETRIES - IPV6 - RSSI - SNR - CLIENT_MAC - USER_PROFILE - ENCRYPTION - DEVICE_MAC - IPV4 - CONNECTION_STATUS - ALIAS - CATEGORY_ASSIGNMENT - CLIENT_IP - AIR_TIME - FREQUENCY - RX_CLIENT_RETIRES - AUTHENTICATION - CLIENT_DEVICE_ID - VLAN - TX_CLIENT_RETIRES example: OPERATING_SYSTEM XiqClientHealthConnectionStatus: type: string title: ClientHealthSortField description: Pre-defined filters for warnings in dashboard - CONNECTED - DISCONNECTED example: CONNECTED XiqClientHealthFrequencySortField: type: string title: ClientHealthFrequencyField description: Pre-defined filters for client health frequency - 2.4GHz - 5Ghz - 6Ghz example: 2.4GHz XiqWirelessConnectionStatus: type: string enum: - CONNECTED - DISCONNECTED XiqClientHealthGridResponse: type: object properties: connectionStatus: $ref: '#/components/schemas/XiqWirelessConnectionStatus' description: The current connection status of the client client_hostname: type: string description: The hostname of the client client_ip: type: string description: The IP address of the client 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: Indicates if there are association issues has_authentication_issues: type: boolean description: Indicates if there are authentication issues has_ip_address_issues: type: boolean description: Indicates if there are IP address issues has_roaming_issues: type: boolean description: Indicates if there are roaming issues snr: type: number format: float description: Signal-to-noise ratio of the client's connection rssi: type: number format: float description: Received signal strength indicator of the client's connection frequency: type: string description: The frequency band used by the client (e.g., 2.4 GHz, 5 GHz, 6 GHz) air_time: type: number format: float description: The percentage of air time of the client ipv4: type: string description: The IPv4 address assigned to the client connected_device_mac: type: string description: The MAC address of the connected device ssid: type: string description: The SSID of the network vlan: type: integer format: int64 description: The VLAN ID last_session_start_time: type: string format: date-time description: The start time of the last session operating_system: type: string description: The operating system of the client device client_mac: type: string description: The MAC address of the client device 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 description: The IPv6 address assigned to the client device_id: type: integer format: int64 description: The device to which client is connected client_device_id: type: integer format: int64 description: The client ID slowness: type: number format: float description: The slowness experienced by the client roaming_time: type: number format: float description: The roaming time association_duration: type: number format: float description: The association duration dhcp_ip_assignation_time: type: number format: float description: The DHCP IP assignation time authentication_response_time: type: number format: float description: The authentication response time rx_client_retries: type: integer format: int64 description: The number of receive client retries tx_client_retries: type: integer format: int64 description: The number of transmit client retries ipv4_warning: type: boolean description: Indicates if the IP is static / self assigned air_time_warning: type: boolean description: Indicates if the air time is exceeding threshold rtts_supported: type: boolean description: Indicates if RTT Session is supported PagedXiqClientHealthGridResponse: allOf: - $ref: '#/components/schemas/XiqPage' - type: object properties: data: type: array description: The data in the current page items: $ref: '#/components/schemas/XiqClientHealthGridResponse' XiqWirelessClientHealthConnectivityIssues: type: object 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) XiqWirelessClientHealthFrequencyDistribution: type: object properties: total_clients: type: integer format: int64 description: The total number of clients clients_2dot4GHz: type: integer format: int64 description: The number of clients using the 2.4 GHz frequency band clients_5GHz: type: integer format: int64 description: The number of clients using the 5 GHz frequency band clients_6GHz: type: integer format: int64 description: The number of clients using the 6 GHz frequency band RmWirelessClientHealthIssueResponse: allOf: - $ref: '#/components/schemas/XiqPage' - type: object description: The response body of wireless client health issues. properties: data: type: array description: The data in the current page items: type: object properties: date_time: description: The timestamp of the issue. type: string format: date-time reason_code: description: The reason code for the issue. type: string device_name: type: string description: The device name. RmWirelessClientHealthRoamingIssueResponse: allOf: - $ref: '#/components/schemas/XiqPage' - type: object description: The response body of wireless client health issues. properties: data: type: array description: The data in the current page items: type: object properties: date_time: description: The timestamp of the issue. type: string format: date-time issue_type: description: The issue type. type: string roaming_time: description: The roaming time. type: string device_name: type: string description: The device name. RmWirelessClientHealthIpAddressIssueResponse: allOf: - $ref: '#/components/schemas/XiqPage' - type: object description: The response body of wireless client health issues. properties: data: type: array description: The data in the current page items: type: object properties: date_time: description: The timestamp of the issue. type: string format: date-time issue_type: description: The issue type. type: string device_name: type: string description: The device name. XiqUsageAndCapacitySortField: type: string title: UsageAndCapacitySortField description: Pre-defined filters for usage and capacity filters - 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 example: HOSTNAME XiqUsageAndCapacityGridResponse: type: object properties: hostname: type: string description: Hostname of the device device_ip: type: string description: The IP address of the device 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 mac_address: type: string description: MAC address of the device device_id: type: integer description: The device ID format: int64 healthy_clients: type: integer description: The count of healthy clients connected to the device format: int32 unhealthy_clients: type: integer description: The count of unhealthy clients connected to the device format: int32 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 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 for wifi0 interference wifi1_packet_loss: type: integer format: int64 description: Packet loss score in APs for wifi1 interference wifi2_packet_loss: type: integer format: int64 description: Packet loss score in APs for wifi2 interference wifi0_interference_score: type: integer format: int64 description: Wifi 0 interface score wifi1_interference_score: type: integer format: int64 description: Wifi 1 interface score wifi2_interference_score: type: integer format: int64 description: Wifi 0 interface score wifi0_noise: type: integer format: int64 description: Wifi 0 noise wifi1_noise: type: integer format: int64 description: Wifi 1 noise wifi2_noise: type: integer format: int64 description: Wifi 2 noise link_error_2dot4g: type: integer format: int64 description: Link error score for 2.4 GHz radio link_error_5g: type: integer format: int64 description: Link error score for 5 GHz radio link_error_6g: type: integer format: int64 description: Link error score for 6 GHz radio 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 has_usage_capacity_issue: type: boolean description: Indicates if the device has a usage capacity issue PagedXiqUsageAndCapacityGridResponse: allOf: - $ref: '#/components/schemas/XiqPage' - type: object properties: data: type: array description: The data in the current page items: $ref: '#/components/schemas/XiqUsageAndCapacityGridResponse' XiqWirelessUsageCapacityExcessiveUtilization: type: object properties: total_ap_count: type: integer format: int64 description: Total count of APs radio2_dot4g_utilization_issue_ap_count: type: integer format: int64 description: Count of APs with utilization issues for 2.4 GHz radio radio5g_utilization_issue_ap_count: type: integer format: int64 description: Count of APs with utilization issues for 5 GHz radio radio6g_utilization_issue_ap_count: type: integer format: int64 description: Count of APs with utilization issues for 6 GHz radio XiqDeviceHealthGridSortField: type: string title: XiqDeviceHealthGridSortField description: Pre-defined filters for device health filters - HOSTNAME - SITE - CPU_USAGE_PERCENTAGE - MEMORY_USAGE_PERCENTAGE - TOTAL_ETH0_SCORE - TOTAL_ETH1_SCORE example: HOSTNAME PagedXiqDeviceHealthGridResponse: allOf: - $ref: '#/components/schemas/XiqPage' - type: object properties: data: type: array description: The data in the current page items: $ref: '#/components/schemas/XiqDeviceHealthGridResponse' XiqWirelessDeviceHealthCpuUsageIssues: type: object properties: cpu_usage_issue_device_count: type: integer format: int64 description: Count of devices with CPU usage issues. XiqWirelessDeviceHealthMemoryUsageIssues: type: object properties: memory_usage_issue_device_count: type: integer format: int64 description: Count of devices with Memory usage issues. XiqWirelessDeviceHealthPoEUsageIssues: type: object properties: poe_usage_issue_device_count: type: integer format: int64 description: Count of devices with PoE usage issues. XiqWirelessDeviceHealthSummary: type: object 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 PagedXiqDeviceRebootSummaryResponse: allOf: - $ref: '#/components/schemas/XiqPage' - type: object description: The response body of wireless device reboot summary. properties: data: type: array description: The data in the current page items: type: object properties: date_time: description: The timestamp of the device reboot. type: string format: date-time description: description: The reason for the device reboot. type: string XiqWiredClientHealthSortField: type: string title: WiredClientHealthSortField description: Pre-defined filters for client health sorting - 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 example: CONNECTION_STATUS XiqWiredClientHealthConnectionStatus: type: string enum: - CONNECTED - DISCONNECTED XiqWiredClientHealthGridResponse: type: object properties: connectionStatus: $ref: '#/components/schemas/XiqWiredClientHealthConnectionStatus' description: The current connection status of the client client_hostname: type: string description: The hostname of the client client_ip: type: string description: The IP address of the client 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 description: The IPv4 address assigned to the client has_ip_address_issues: type: boolean description: Indicates if there are IP address issues (related to UI tooltip) ipv6: type: string description: The IPv6 address assigned to the client 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 ID operating_system: type: string description: The operating system of the client device mac: type: string description: The MAC address of the client device 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: number format: double description: The total unicast packets percentage total_multicast_packets_percentage: type: number format: double description: The total multicast packets percentage total_broadcast_packets_percentage: type: number format: double description: The total broadcast packets percentage total_port_errors: type: integer format: int64 description: The total port errors device_id: type: integer format: int64 description: The device to which client is connected client_id: type: integer format: int64 description: The client ID PagedXiqWiredClientHealthGridResponse: allOf: - $ref: '#/components/schemas/XiqPage' - type: object properties: data: type: array description: The data in the current page items: $ref: '#/components/schemas/XiqWiredClientHealthGridResponse' XiqWiredClientHealthIpConnectivityIssues: 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 self assigned IPs XiqWiredClientHealthPortCongestionIssues: 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 XiqWiredClientHealthTrafficAnomalies: 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 XiqWiredClientHealthPortErrors: 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 XiqWiredDeviceHealthSummary: type: object properties: wired_devices: type: integer format: int64 description: Total count of devices wired_unhealthy_devices: type: integer format: int64 description: Total count of unhealthy devices XiqWiredDeviceHealthCpuUsageIssues: type: object properties: cpu_usage_issue_device_count: type: integer format: int64 description: Count of devices with CPU usage issues XiqWiredDeviceHealthMemoryUsageIssues: type: object properties: memory_usage_issue_device_count: type: integer format: int64 description: Count of devices with memory usage issues XiqWiredDeviceHealthTemperatureIssues: type: object properties: temperature_issue_device_count: type: integer format: int64 description: Count of devices with temperature issues XiqWiredDeviceHealthPoeUsageIssues: type: object properties: poe_usage_issue_device_count: type: integer format: int64 description: Count of devices with PoE usage issues XiqWiredDeviceHealthFanStatusIssues: type: object properties: fan_status_issue_device_count: type: integer format: int64 description: Count of devices with fan status issues XiqWiredDeviceHealthPsuStatusIssues: type: object properties: psu_status_issue_device_count: type: integer format: int64 description: Count of devices with PSU status issues XiqWiredDeviceHealthGridSortField: type: string title: WiredDeviceHealthSortField description: Pre-defined fields for device health sorting - CPU - MEM - TEMP - POE - FAN - PSU example: CPU XiqWiredDeviceHealthGridFilterField: description: The filters available for the wired device health grid enum: - CPU - MEM - TEMP - POE - FAN - PSU - HEALTH XiqWiredDeviceHealthGridResponse: type: object properties: device_id: type: integer format: int64 description: The id of the device stack_size: type: integer format: int8 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: integer format: int8 description: The CPU usage percentage of the device memory_usage: type: integer format: int8 description: The memory usage percentage of the device temperature: type: integer format: int16 description: The temperature of the device temperature_error_slots: type: integer format: int8 description: Indicates the number of the stack slots that have temperature errors/if a standalone device has temperature errors poe_usage: type: integer format: int8 description: The PoE usage percentage of the device poe_error_slots: type: integer format: int8 description: Indicates the number of the stack slots that have PoE errors/if a standalone device has PoE errors fan_error_slots: type: integer format: int8 description: Indicates the number of the stack slots that have fan errors/if a standalone device has fan errors psu_error_slots: type: integer format: int8 description: Indicates the number of the stack slots that have PSU errors/if a standalone device has PSU errors PagedXiqWiredDeviceHealthGridResponse: allOf: - $ref: '#/components/schemas/XiqPage' - type: object properties: data: type: array description: The data in the current page items: $ref: '#/components/schemas/XiqWiredDeviceHealthGridResponse' XiqWiredDeviceHealthPoeUsageStatusResponseEntry: type: object properties: slot_number: type: integer format: int8 description: The slot number of the device poe_usage: type: integer format: int8 description: The PoE usage percentage of the device XiqWiredDeviceHealthPoeUsageStatusResponse: type: object 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' XiqWiredDeviceHealthTemperatureStatusResponseEntry: type: object properties: slot_number: type: integer format: int8 description: The slot number of the device temperature: type: integer format: int16 description: The temperature of the device XiqWiredDeviceHealthTemperatureStatusResponse: type: object 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' XiqWiredDeviceHealthFanStatus: type: object properties: fan_description: type: string description: The fan description fan_status: type: string description: The fan status XiqWiredDeviceHealthFanStatusResponseEntry: type: object properties: slot_number: type: integer format: int8 description: The slot number of the device (0 for standalone) fan_status_error: type: integer format: int8 description: The number of fans that are not operating correctly fan_total: type: integer format: int8 description: The total number of fans fan_units: type: array description: The list of fans with their corresponding status items: $ref: '#/components/schemas/XiqWiredDeviceHealthFanStatus' XiqWiredDeviceHealthFanStatusResponse: type: object 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' XiqWiredDeviceHealthPsuStatus: type: object properties: psu_description: type: string description: The PSU description psu_status: type: string description: The PSU status XiqWiredDeviceHealthPsuStatusResponseEntry: type: object properties: slot_number: type: integer format: int8 description: The slot number of the device (0 for standalone) psu_status_error: type: integer format: int8 description: The number of PSUs that are not operating correctly psu_total: type: integer format: int8 description: The total number of PSUs psu_units: type: array description: The list of PSUs with their corresponding status items: $ref: '#/components/schemas/XiqWiredDeviceHealthPsuStatus' XiqWiredDeviceHealthPsuStatusResponse: type: object 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' XiqWiredUsageCapacitySortField: type: string title: WiredUsageAndCapacitySortField description: Pre-defined fields for usage and capacity sorting - 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 example: TOTAL_BANDWIDTH_UTILIZED XiqWiredUsageCapacityFilter: description: The filters available for usage and capacity grid enum: - TOTAL_QUEUE_CONGESTION_PKTS XiqWiredUsageCapacityGridResponse: type: object 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: True if the device is a stack otherwise false 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 PagedXiqWiredUsageCapacityGridResponse: allOf: - $ref: '#/components/schemas/XiqPage' - type: object properties: data: type: array description: The data in the current page items: $ref: '#/components/schemas/XiqWiredUsageCapacityGridResponse' XiqWiredUsageCapacityUsageUtilization: type: object properties: total_bandwidth_utilized: type: integer format: int64 description: Total utilized bandwidth in Bytes XiqWiredUsageCapacityThroughput: type: object 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 XiqWiredUsageCapacityCongestion: type: object 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 XiqSwitchInspectorPanelDiagnosticsWidget: type: object 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 GeoViewNode: type: object description: The Geo View data properties: folder_id: type: integer format: int64 folder_type: type: string description: The node type folder_name: type: string description: The name of the Node total_children: type: integer format: int64 description: Total number of children total_unhealthy_children: type: integer format: int64 description: Total number of unhealthy children folders: type: array description: Array of Child nodes items: $ref: '#/components/schemas/GeoViewNode' XiqReportMetrics: type: string description: Metrics Type. 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 - APP_TRAFFIC_PERCENTAGE - DEVICES_BY_CLIENTS - SWITCH_SUMMARY - UNIQUE_CLIENT_BY_SSID_PIE_CHART - APP_TRAFFIC_PERCENTAGE_PIE_CHART - TRAFFIC_VOLUME_PER_APP_PIE_CHART XiqMaxConcurrentClientsRequest: allOf: - type: object description: Network Service required: - service_type properties: metrics: $ref: '#/components/schemas/XiqReportMetrics' sort_field: description: '' type: string enum: - TIME_STAMP (default) - MAC - HOSTNAME sort_order: type: string description: '' enum: - ASC (default) - DESC site_ids: description: List of Site IDs type: array items: type: integer format: int64 building_ids: description: List of building IDs type: array items: type: integer format: int64 floor_ids: description: List of Floor IDs type: array items: type: integer format: int64 connTypes: description: | List of connection types type: string enum: - UNKNOWN - WIRELESS - WIRED - THREAD ssids: description: | List of SSIDs to filter type: array items: type: string bands: description: List of Bands to filter (Supports Multi-Select) type: array items: type: string enum: - 2.4GHz - 5GHz - 6GHz device_ids: description: | List of deviceIds to filter type: array items: type: integer format: int64 start_time: description: Epoch Time in milliseconds since 1/1/1970 type: integer format: int64 end_time: description: Epoch Time in milliseconds since 1/1/1970 type: integer format: int64 pageno: description: page number >= 1. Ignored if export is set to true type: integer format: int limit: description: size of each page. Ignored if export is set to true type: integer format: int async: description: LRO operation. default value false. Will be true if export is set to true type: boolean XiqUniqueWifiClientsRequest: allOf: - type: object description: Network Service required: - service_type properties: metrics: $ref: '#/components/schemas/XiqReportMetrics' sort_field: description: default TIME_STAMP type: string enum: - TIME_STAMP (default) - MAC - HOSTNAME - CONNECTED_TIME - DICONNECTED_TIME sort_order: type: string description: default ASC enum: - ASC (default) - DESC site_ids: description: List of Site IDs type: array items: type: integer format: int64 building_ids: description: List of building IDs type: array items: type: integer format: int64 floor_ids: description: List of Floor IDs type: array items: type: integer format: int64 ssids: description: | List of SSIDs to filter type: array items: type: string bands: description: List of Bands to filter (Supports Multi-Select) type: array items: type: string enum: - 2.4GHz - 5GHz - 6GHz channel_nums: description: | List of channel numbers to filter type: array items: type: integer format: int32 device_ids: description: | List of deviceIds to filter type: array items: type: integer format: int64 start_time: description: Epoch Time in milliseconds since 1/1/1970 type: integer format: int64 end_time: description: Epoch Time in milliseconds since 1/1/1970 type: integer format: int64 pageno: description: page number >= 1. Ignored if export is set to true type: integer format: int limit: description: size of each page. Ignored if export is set to true type: integer format: int async: description: LRO operation. default value false. Will be true if export is set to true type: boolean XiqClientSessionsRequest: allOf: - type: object description: Network Service required: - service_type properties: metrics: $ref: '#/components/schemas/XiqReportMetrics' sortField: description: '' type: string enum: - TIME_STAMP (default) - MAC - HOSTNAME - SESSION_DURATION sortOrder: type: string description: '' enum: - ASC (default) - DESC siteIds: description: List of Site IDs type: array items: type: integer format: int64 buildingIds: description: List of building IDs type: array items: type: integer format: int64 floorIds: description: List of Floor IDs type: array items: type: integer format: int64 ssids: description: | List of SSIDs to filter type: array items: type: string bands: description: List of Bands to filter (Supports Multi-Select) type: array items: type: string enum: - 2.4GHz - 5GHz - 6GHz channelNums: description: | List of channel numbers to filter type: array items: type: integer format: int32 deviceIds: description: | List of deviceIds to filter type: array items: type: integer format: int64 startTime: description: Epoch Time in milliseconds since 1/1/1970 type: integer format: int64 endTime: description: Epoch Time in milliseconds since 1/1/1970 type: integer format: int64 pageno: description: page number >= 1. Ignored if export is set to true type: integer format: int limit: description: size of each page. Ignored if export is set to true type: integer format: int async: description: LRO operation. default value false. Will be true if export is set to true type: boolean XiqClientAirtimeUsageRequest: allOf: - type: object description: Network Service required: - service_type properties: metrics: $ref: '#/components/schemas/XiqReportMetrics' sort_field: description: '' type: string enum: - TIME_STAMP (default) - MAC - HOSTNAME - PERCENTAGE_AIRTIME_UTILIZATION - RELATIVE_TIME sort_order: type: string description: '' enum: - ASC (default) - DESC site_ids: description: List of Site IDs type: array items: type: integer format: int64 building_ids: description: List of building IDs type: array items: type: integer format: int64 floor_ids: description: List of Floor IDs type: array items: type: integer format: int64 ssids: description: | List of SSIDs to filter type: array items: type: string bands: description: List of Bands to filter (Supports Multi-Select) type: array items: type: string enum: - 2.4GHz - 5GHz - 6GHz channel_nums: description: | List of channel numbers to filter type: array items: type: integer format: int32 device_ids: description: | List of deviceIds to filter type: array items: type: integer format: int64 start_time: description: Epoch Time in milliseconds since 1/1/1970 type: integer format: int64 end_time: description: Epoch Time in milliseconds since 1/1/1970 type: integer format: int64 pageno: description: page number >= 1. Ignored if export is set to true type: integer format: int limit: description: size of each page. Ignored if export is set to true type: integer format: int async: description: LRO operation. default value false. Will be true if export is set to true type: boolean XiqUniqueClientsByOSRequest: allOf: - type: object description: Network Service required: - service_type properties: metrics: $ref: '#/components/schemas/XiqReportMetrics' sort_field: description: '' type: string enum: - TIME_STAMP (default) - MAC - HOSTNAME sort_order: type: string description: '' enum: - ASC (default) - DESC site_ids: description: List of Site IDs type: array items: type: integer format: int64 building_ids: description: List of building IDs type: array items: type: integer format: int64 floor_ids: description: List of Floor IDs type: array items: type: integer format: int64 ssids: description: | List of SSIDs to filter type: array items: type: string bands: description: List of Bands to filter (Supports Multi-Select) type: array items: type: string enum: - 2.4GHz - 5GHz - 6GHz ostypes: description: List of OS types **The below table defines the different Widgets with there path param and description** 1. UnKnown -- 0 2. Windows -- 21000 3. Windows Phone -- 21001 4. MAC OS -- 21002 5. IPad -- 21003 6. IPhone -- 21004 7. IOS Device -- 21005 8. android -- 21006 9. Symbian -- 21007 10. blackbery -- 21008 11. chrome -- 21009 type: integer format: int32 deviceType: description: Device types type: array items: type: integer format: int start_time: description: Epoch Time in milliseconds since 1/1/1970 type: integer format: int64 end_time: description: Epoch Time in milliseconds since 1/1/1970 type: integer format: int64 pageno: description: page number >= 1. Ignored if export is set to true type: integer format: int limit: description: size of each page. Ignored if export is set to true type: integer format: int async: description: LRO operation. default value false. Will be true if export is set to true type: boolean XiqAppTrafficPercentageRequest: allOf: - type: object description: Network Service required: - service_type properties: metrics: $ref: '#/components/schemas/XiqReportMetrics' sortField: description: '' type: string enum: - TIME_STAMP (default) - MAC - HOSTNAME - APPLICATION_USAGE sortOrder: type: string description: '' enum: - ASC (default) - DESC site_ids: description: List of Site IDs type: array items: type: integer format: int64 building_ids: description: List of building IDs type: array items: type: integer format: int64 floor_ids: description: List of Floor IDs type: array items: type: integer format: int64 user_id: description: List of User IDs. type: array items: type: integer format: int64 client_mac: description: List of Client Mac Address. type: array items: type: string application_id: description: List of Application IDs. type: array items: type: integer format: int64 start_time: description: Epoch Time in milliseconds since 1/1/1970 type: integer format: int64 end_time: description: Epoch Time in milliseconds since 1/1/1970 type: integer format: int64 pageno: description: page number >= 1. Ignored if export is set to true type: integer format: int limit: description: size of each page. Ignored if export is set to true type: integer format: int async: description: LRO operation. default value false. Will be true if export is set to true XiqQoeDiagnosticsTimeRange: required: - startTime - endTime type: object properties: startTime: type: integer description: Start time in epoch format: int64 endTime: type: integer description: End time in epoch format: int64 XiqQoeDiagnosticsData: required: - timestamp - value type: object properties: timestamp: type: integer description: Time Stamp format: int64 value: type: integer description: values format: int64 XiqQoeDiagnosticsResponse: allOf: - type: object description: Network Service required: - service_type properties: metrics: $ref: '#/components/schemas/XiqReportMetrics' name: type: string description: Name of the Metrics timeRange: description: Time Range ( Start and End Time ) $ref: '#/components/schemas/XiqQoeDiagnosticsTimeRange' data: type: array description: The data for a particular metrics items: $ref: '#/components/schemas/XiqQoeDiagnosticsData' XiqDiagnosticsPieChart: allOf: - type: object description: Network Service required: - service_type properties: metrics: $ref: '#/components/schemas/XiqReportMetrics' name: type: string description: Name of the Metrics timeRange: description: Time Range ( Start and End Time ) $ref: '#/components/schemas/XiqQoeDiagnosticsTimeRange' data: type: array description: The data for a particular metrics items: required: - id - name - value type: object properties: id: type: integer description: Time Stamp format: int64 name: type: string description: name of the fraction value: type: integer description: values format: int64 XiqDiagnosticsTimeSeriesResponse: type: object description: Metrics response properties: Response Body ( Select Metrics ): anyOf: - $ref: '#/components/schemas/XiqQoeDiagnosticsResponse' - $ref: '#/components/schemas/XiqDiagnosticsPieChart' discriminator: propertyName: metrics mapping: MAX_CONCURRENT_CLIENTS: '#/components/schemas/XiqQoeDiagnosticsResponse' UNIQUE_WIFI_CLIENTS: '#/components/schemas/XiqQoeDiagnosticsResponse' CLIENT_SESSIONS: '#/components/schemas/XiqQoeDiagnosticsResponse' APP_TRAFFIC_PERCENTAGE: '#/components/schemas/XiqDiagnosticsPieChart' CLIENT_AIRTIME_USAGE: '#/components/schemas/XiqQoeDiagnosticsResponse' UNIQUE_CLIENTS_BY_OS: '#/components/schemas/XiqDiagnosticsPieChart' XiqMaxConcurrentClientsRequest-2: allOf: - type: object description: Network Service required: - service_type properties: METRICS: $ref: '#/components/schemas/XiqReportMetrics' sortField: description: '' type: string enum: - TIME_STAMP (default) - MAC - HOSTNAME sortOrder: type: string description: '' enum: - ASC (default) - DESC siteIds: description: List of Site IDs type: array items: type: integer format: int64 buildingIds: description: List of building IDs type: array items: type: integer format: int64 floorIds: description: List of Floor IDs type: array items: type: integer format: int64 connTypes: description: | List of connection types type: string enum: - UNKNOWN - WIRELESS - WIRED - THREAD ssids: description: | List of SSIDs to filter type: array items: type: string band: description: | List of Bands to filter type: string enum: - 2.4GHz - 5GHz - 6GHz deviceIds: description: | List of deviceIds to filter type: array items: type: integer format: int64 startTime: description: Epoch Time in milliseconds since 1/1/1970 type: array items: type: integer format: int64 endTime: description: Epoch Time in milliseconds since 1/1/1970 type: array items: type: integer format: int64 export: description: export to CSV format. true will initiate export. default value false type: boolean pageno: description: page number >= 1. Ignored if export is set to true type: integer format: int limit: description: size of each page. Ignored if export is set to true type: integer format: int async: description: LRO operation. default value false. Will be true if export is set to true type: boolean XiqUniqueWifiClientsRequest-2: allOf: - type: object description: Network Service required: - service_type properties: METRICS: $ref: '#/components/schemas/XiqReportMetrics' sortField: description: default TIME_STAMP type: string enum: - TIME_STAMP (default) - MAC - HOSTNAME - CONNECTED_TIME - DICONNECTED_TIME sortOrder: type: string description: default ASC enum: - ASC (default) - DESC siteIds: description: List of Site IDs type: array items: type: integer format: int64 buildingIds: description: List of building IDs type: array items: type: integer format: int64 floorIds: description: List of Floor IDs type: array items: type: integer format: int64 ssids: description: | List of SSIDs to filter type: array items: type: string band: description: | List of Bands to filter type: string enum: - 2.4GHz - 5GHz - 6GHz channelNums: description: | List of channel numbers to filter type: array items: type: integer format: int32 deviceIds: description: | List of deviceIds to filter type: array items: type: integer format: int64 startTime: description: Epoch Time in milliseconds since 1/1/1970 type: array items: type: integer format: int64 endTime: description: Epoch Time in milliseconds since 1/1/1970 type: array items: type: integer format: int64 export: description: export to CSV format. true will initiate export. default value false type: boolean pageno: description: page number >= 1. Ignored if export is set to true type: integer format: int limit: description: size of each page. Ignored if export is set to true type: integer format: int async: description: LRO operation. default value false. Will be true if export is set to true type: boolean XiqClientSessionsRequest-2: allOf: - type: object description: Network Service required: - service_type properties: METRICS: $ref: '#/components/schemas/XiqReportMetrics' sortField: description: '' type: string enum: - TIME_STAMP (default) - MAC - HOSTNAME - SESSION_DURATION sortOrder: type: string description: '' enum: - ASC (default) - DESC siteIds: description: List of Site IDs type: array items: type: integer format: int64 buildingIds: description: List of building IDs type: array items: type: integer format: int64 floorIds: description: List of Floor IDs type: array items: type: integer format: int64 ssids: description: | List of SSIDs to filter type: array items: type: string band: description: | List of Bands to filter type: string enum: - 2.4GHz - 5GHz - 6GHz channelNums: description: | List of channel numbers to filter type: array items: type: integer format: int32 deviceIds: description: | List of deviceIds to filter type: array items: type: integer format: int64 startTime: description: Epoch Time in milliseconds since 1/1/1970 type: array items: type: integer format: int64 endTime: description: Epoch Time in milliseconds since 1/1/1970 type: array items: type: integer format: int64 export: description: export to CSV format. true will initiate export. default value false type: boolean pageno: description: page number >= 1. Ignored if export is set to true type: integer format: int limit: description: size of each page. Ignored if export is set to true type: integer format: int async: description: LRO operation. default value false. Will be true if export is set to true type: boolean XiqClientAirtimeUsageRequest-2: allOf: - type: object description: Network Service required: - service_type properties: METRICS: $ref: '#/components/schemas/XiqReportMetrics' sortField: description: '' type: string enum: - TIME_STAMP (default) - MAC - HOSTNAME - PERCENTAGE_AIRTIME_UTILIZATION - RELATIVE_TIME sortOrder: type: string description: '' enum: - ASC (default) - DESC siteIds: description: List of Site IDs type: array items: type: integer format: int64 buildingIds: description: List of building IDs type: array items: type: integer format: int64 floorIds: description: List of Floor IDs type: array items: type: integer format: int64 ssids: description: | List of SSIDs to filter type: array items: type: string band: description: | List of Bands to filter type: string enum: - 2.4GHz - 5GHz - 6GHz channelNums: description: | List of channel numbers to filter type: array items: type: integer format: int32 deviceIds: description: | List of deviceIds to filter type: array items: type: integer format: int64 startTime: description: Epoch Time in milliseconds since 1/1/1970 type: array items: type: integer format: int64 endTime: description: Epoch Time in milliseconds since 1/1/1970 type: array items: type: integer format: int64 export: description: export to CSV format. true will initiate export. default value false type: boolean pageno: description: page number >= 1. Ignored if export is set to true type: integer format: int limit: description: size of each page. Ignored if export is set to true type: integer format: int async: description: LRO operation. default value false. Will be true if export is set to true type: boolean XiqUniqueClientsByOSRequest-2: allOf: - type: object description: Network Service required: - service_type properties: METRICS: $ref: '#/components/schemas/XiqReportMetrics' sortField: description: '' type: string enum: - TIME_STAMP (default) - MAC - HOSTNAME sortOrder: type: string description: '' enum: - ASC (default) - DESC siteIds: description: List of Site IDs type: array items: type: integer format: int64 buildingIds: description: List of building IDs type: array items: type: integer format: int64 floorIds: description: List of Floor IDs type: array items: type: integer format: int64 ssids: description: | List of SSIDs to filter type: array items: type: string band: description: | List of Bands to filter type: string enum: - 2.4GHz - 5GHz - 6GHz ostypes: description: List of OS types **The below table defines the different Widgets with there path param and description** 1. UnKnown -- 0 2. Windows -- 21000 3. Windows Phone -- 21001 4. MAC OS -- 21002 5. IPad -- 21003 6. IPhone -- 21004 7. IOS Device -- 21005 8. android -- 21006 9. Symbian -- 21007 10. blackbery -- 21008 11. chrome -- 21009 type: integer format: int32 deviceType: description: Device types type: array items: type: integer format: int startTime: description: Epoch Time in milliseconds since 1/1/1970 type: array items: type: integer format: int64 endTime: description: Epoch Time in milliseconds since 1/1/1970 type: array items: type: integer format: int64 export: description: export to CSV format. true will initiate export. default value false type: boolean pageno: description: page number >= 1. Ignored if export is set to true type: integer format: int limit: description: size of each page. Ignored if export is set to true type: integer format: int async: description: LRO operation. default value false. Will be true if export is set to true type: boolean XiqAppTrafficPercentageRequest-2: allOf: - type: object description: Network Service required: - service_type properties: METRICS: $ref: '#/components/schemas/XiqReportMetrics' sortField: description: '' type: string enum: - TIME_STAMP (default) - MAC - HOSTNAME - APPLICATION_USAGE sortOrder: type: string description: '' enum: - ASC (default) - DESC siteIds: description: List of Site IDs type: array items: type: integer format: int64 buildingIds: description: List of building IDs type: array items: type: integer format: int64 floorIds: description: List of Floor IDs type: array items: type: integer format: int64 userID: description: List of User IDs. type: array items: type: integer format: int64 clientMac: description: List of Client Mac Address. type: array items: type: string applicationId: description: List of Application IDs. type: array items: type: integer format: int64 startTime: description: Epoch Time in milliseconds since 1/1/1970 type: array items: type: integer format: int64 endTime: description: Epoch Time in milliseconds since 1/1/1970 type: array items: type: integer format: int64 export: description: export to CSV format. true will initiate export. default value false type: boolean pageno: description: page number >= 1. Ignored if export is set to true type: integer format: int limit: description: size of each page. Ignored if export is set to true type: integer format: int async: description: LRO operation. default value false. Will be true if export is set to true type: boolean XiqMaxConcurrentClientsResponse: allOf: - type: object description: Network Service required: - service_type properties: metrics: $ref: '#/components/schemas/XiqReportMetrics' - type: object properties: time_stamp: type: integer description: time in epoch format: int64 user_name: type: string description: Name of the User user_profile_name: type: string description: Profile Name of the User os_name: type: string description: Profile Name of the operating system ssid: type: string description: ssid XiqUniqueWifiClientsResponse: allOf: - type: object description: Network Service required: - service_type properties: metrics: $ref: '#/components/schemas/XiqReportMetrics' - type: object properties: time_stamp: type: integer description: Time in Epoch format: int64 client_hostname: type: string description: Host Name of the Client client_mac: type: string description: MAC Address of the Client ip_address: type: string description: IP Address of the Client os_type: type: string description: Operating System of the Client connected_time: type: integer description: Connected Time of the Client format: int64 disconnected_time: type: integer description: Disconnected Time of the Client format: int64 XiqClientSessionsResponse: allOf: - type: object description: Network Service required: - service_type properties: metrics: $ref: '#/components/schemas/XiqReportMetrics' - type: object properties: time_stamp: type: integer description: time in epoch format: int64 client_hostname: type: string description: Host Name of the Client client_mac: type: string description: MAC Address of the Client ip_address: type: string description: IP Address of the Client os_type: type: string description: Operating System of the Client session_duration: description: Session Duration of the Client in MilliSeconds type: integer format: int64 XiqAppTrafficPercentageResponse: allOf: - type: object description: Network Service required: - service_type properties: metrics: $ref: '#/components/schemas/XiqReportMetrics' - type: object properties: time_stamp: type: integer description: time in epoch format: int64 application_name: type: string description: Name of the Application application_usage: type: integer format: int64 description: Application Usage in Bytes XiqClientAirtimeUsageResponse: allOf: - type: object description: Network Service required: - service_type properties: metrics: $ref: '#/components/schemas/XiqReportMetrics' - type: object properties: time_stamp: type: integer description: time in epoch format: int64 devicet_hostname: type: string description: Host Name of the Device device_mac: type: string description: MAC Address of the Device ip_address: type: string description: IP Address of the Device percentage_airtime_utilization: type: integer description: percentage channle utilization format: int64 releative_time: type: integer description: relative time in epoch format: int64 XiqUniqueClientsByOSResponse: allOf: - type: object description: Network Service required: - service_type properties: metrics: $ref: '#/components/schemas/XiqReportMetrics' - type: object properties: time_stamp: type: integer description: time in epoch format: int64 client_hostname: type: string description: Name of the Client client_mac: type: string description: MAC Address of the Client ip_address: type: string description: IP Address of the Device os_type: type: integer description: Type of Operating System format: int XiqDiagnosticsTableDataResponse: type: object description: Metrics response properties: Response Body ( Select Metrics ): anyOf: - $ref: '#/components/schemas/XiqMaxConcurrentClientsResponse' - $ref: '#/components/schemas/XiqUniqueWifiClientsResponse' - $ref: '#/components/schemas/XiqClientSessionsResponse' - $ref: '#/components/schemas/XiqAppTrafficPercentageResponse' - $ref: '#/components/schemas/XiqClientAirtimeUsageResponse' - $ref: '#/components/schemas/XiqUniqueClientsByOSResponse' discriminator: propertyName: metrics mapping: MAX_CONCURRENT_CLIENTS: '#/components/schemas/XiqMaxConcurrentClientsResponse' UNIQUE_WIFI_CLIENTS: '#/components/schemas/XiqUniqueWifiClientsResponse' CLIENT_SESSIONS: '#/components/schemas/XiqClientSessionsResponse' APP_TRAFFIC_PERCENTAGE: '#/components/schemas/XiqAppTrafficPercentageResponse' CLIENT_AIRTIME_USAGE: '#/components/schemas/XiqClientAirtimeUsageResponse' UNIQUE_CLIENTS_BY_OS: '#/components/schemas/XiqUniqueClientsByOSResponse' XiqDownloadReportsRequest: allOf: - type: object description: Network Service required: - service_type properties: metrics: type: array items: $ref: '#/components/schemas/XiqReportMetrics' site_ids: description: List of Site IDs type: array items: type: integer format: int64 building_ids: description: List of Building IDs type: array items: type: integer format: int64 floor_ids: description: List of Floor IDs type: array items: type: integer format: int64 ssids: description: List of SSIDs to filter type: array items: type: string bands: description: List of Bands to filter (Supports Multi-Select) type: array items: type: string enum: - 2.4GHz - 5GHz - 6GHz channel_nums: description: List of channel numbers to filter type: array items: type: integer format: int32 device_ids: description: List of device IDs to filter type: array items: type: integer format: int64 start_time: description: Epoch Time in milliseconds since 1/1/1970 type: integer format: int64 end_time: description: Epoch Time in milliseconds since 1/1/1970 type: integer format: int64 mode: type: string enum: - AGG_SNAPSHOT - SNAPSHOT download_type: type: string enum: - XLSX - PDF connTypes: description: | List of connection types type: string enum: - UNKNOWN - WIRELESS - WIRED - THREAD XiqScheduledReport: type: object properties: report_run_id: type: integer format: int64 description: Unique identifier for the report run report_run_timestamp: type: integer format: int64 description: Epoch timestamp (in milliseconds) when the report was run recipients_count: type: integer format: int64 description: Number of recipients for the report report_name: type: string description: Name of the scheduled report XiqCustomScheduledReport: type: object properties: report_schedule_id: type: integer format: int64 description: Unique identifier for the report schedule report_id: type: integer format: int64 description: Unique identifier for the report report_name: type: string description: The name of the scheduled report report_description: type: string description: The description of the report recipients_count: type: integer format: int64 description: The number of recipients for the report frequency: type: string enum: - MONTHLY - WEEKLY - DAILY description: Frequency of the report schedule enable_schedule: type: boolean default: true description: Whether the schedule is enabled PagedCustomScheduledReport: allOf: - $ref: '#/components/schemas/XiqPage' - type: object properties: data: type: array description: The data in the current page items: $ref: '#/components/schemas/XiqCustomScheduledReport' XiqScheduleFrequencyRequest: type: object properties: enable_schedule: type: boolean default: true description: Whether the schedule is enabled frequency_type: type: string enum: - DAILY - WEEKLY - MONTHLY description: Frequency of the report schedule schedule_time: type: string pattern: ^([01]\d|2[0-3]):([0-5]\d):([0-5]\d)$ description: Time of day to run the report in 24-hour format (HH:mm:ss), e.g., "09:00:00" schedule_timezone: type: string description: IANA-compliant time zone identifier (e.g., "Asia/Kolkata", "America/New_York") example: Asia/Kolkata schedule_days: type: array items: type: integer description: | Days to run the report: - For DAILY/WEEKLY: 1 (Sunday) to 7 (Saturday) - For MONTHLY: 1–31 or -1 for the last day of the month XiqCreateCustomReportScheduleRequest: type: object properties: metrics: type: array items: $ref: '#/components/schemas/XiqReportMetrics' description: List of metrics to include in the report report_name: type: string description: The name of the report report_description: type: string description: The description of the report site_ids: type: array items: type: integer format: int64 description: List of Site IDs building_ids: type: array items: type: integer format: int64 description: List of building IDs floor_ids: type: array items: type: integer format: int64 description: List of Floor IDs ssids: type: array items: type: string description: List of SSIDs to filter bands: type: array items: type: string enum: - TWO_GHZ - FIVE_GHZ - SIX_GHZ description: List of Bands to filter recipients: type: array description: List of recipients to notify items: type: object properties: email: type: string description: Recipient email address notifier_id: type: integer format: int64 description: Unique identifier for the notifier schedules: type: array items: $ref: '#/components/schemas/XiqScheduleFrequencyRequest' description: List of report schedules by frequency file_format: type: array items: type: string enum: - PDF - XLSX description: File format to download (PDF or XLSX) XiqScheduleFrequencyResponse: type: object properties: enable_schedule: type: boolean default: true description: Whether the schedule is enabled report_schedule_id: type: integer format: int64 description: The Unique Identifier for Report Schedule frequency_type: type: string enum: - DAILY - WEEKLY - MONTHLY description: Frequency of the report schedule schedule_time: type: string pattern: ^([01]\d|2[0-3]):([0-5]\d):([0-5]\d)$ description: Time of day to run the report in 24-hour format (HH:mm:ss), e.g., "09:00:00" schedule_timezone: type: string description: IANA-compliant time zone identifier (e.g., "Asia/Kolkata", "America/New_York") example: Asia/Kolkata schedule_days: type: array items: type: integer description: | Days to run the report: - For DAILY/WEEKLY: 1 (Sunday) to 7 (Saturday) - For MONTHLY: 1–31 or -1 for the last day of the month XiqCustomReportScheduleResponse: type: object properties: report_id: type: integer format: int64 description: Unique identifier for the report report_name: type: string description: The name of the scheduled report report_description: type: string description: The description of the report metrics: type: array items: $ref: '#/components/schemas/XiqReportMetrics' description: List of metrics to include in the report site_ids: type: array items: type: integer format: int64 description: List of Site IDs building_ids: type: array items: type: integer format: int64 description: List of building IDs floor_ids: type: array items: type: integer format: int64 description: List of Floor IDs ssids: type: array items: type: string description: List of SSIDs to filter bands: type: array items: type: string enum: - 2.4GHz - 5GHz - 6GHz description: List of Bands to filter recipients: type: array description: List of recipients items: type: object properties: email: type: string description: Recipient email address notifier_id: type: integer format: int64 description: Unique identifier for the notifier schedules: type: array items: $ref: '#/components/schemas/XiqScheduleFrequencyResponse' description: List of report schedules by frequency file_format: type: array items: type: string enum: - PDF - XLSX description: File format to download (PDF or XLSX) XiqUpdateCustomReportScheduleRequest: type: object properties: metrics: type: array items: $ref: '#/components/schemas/XiqReportMetrics' description: List of metrics to include in the report report_name: type: string description: The name of the report report_description: type: string description: The description of the report site_ids: type: array items: type: integer format: int64 description: List of Site IDs building_ids: type: array items: type: integer format: int64 description: List of building IDs floor_ids: type: array items: type: integer format: int64 description: List of Floor IDs ssids: type: array items: type: string description: List of SSIDs to filter bands: type: array items: type: string enum: - TWO_GHZ - FIVE_GHZ - SIX_GHZ description: List of Bands to filter recipients: type: array description: List of recipients to update items: type: object properties: email: type: string description: Recipient email address notifier_id: type: integer format: int64 description: Unique identifier for the notifier schedules: type: array items: $ref: '#/components/schemas/XiqScheduleFrequencyResponse' description: List of report schedules by frequency file_format: type: array items: type: string enum: - PDF - XLSX description: File format to download (PDF or XLSX) XiqReportRun: type: object properties: report_run_id: type: integer format: int64 description: Unique identifier for the report run report_run_timestamp: type: integer format: int64 description: Epoch timestamp (in milliseconds) when the report was run report_name: type: string description: Name of the report report_id: type: integer format: int64 description: Unique identifier for the report XiqReportRunRecipient: type: object properties: report_run_id: type: integer format: int64 description: Unique identifier for the report run report_id: type: integer format: int64 description: Unique identifier for the report report_name: type: string description: Name of the scheduled report recipients: type: array description: List of recipients for this scheduled report items: type: object properties: recipient_id: type: string description: Unique identifier of the recipient recipient_email: type: string format: email description: Email address of the recipient XiqReportRecipient: type: object properties: report_id: type: integer format: int64 description: Unique identifier for the report report_name: type: string description: Name of the scheduled report recipients: type: array description: List of recipients for this scheduled report items: type: object properties: recipient_id: type: string description: Unique identifier of the recipient recipient_email: type: string format: email description: Email address of the recipient DefaultError: type: object properties: error_code: type: string description: The error code error_id: type: string description: The error ID for internal troubleshooting error_msg: type: string description: The error detailed message required: - error_code - error_id - error_msg LicensingIdentitiesCountResponse: description: Licensing Identities Count type: object properties: owner_id: description: Owner ID type: integer format: int64 example: 1106 users_count: description: Users Count type: integer format: int64 example: 10 devices_count: description: Devices Count type: integer format: int64 example: 187 ServicesAvailabilityStatusResponse: description: Services Availability Status type: object properties: up: description: Services Availability Up type: integer format: int64 example: 0 down: description: Services Availability Down type: integer format: int64 example: 1 partially_down: description: Services Availability Partially Down type: integer format: int64 example: 1 total: description: Services Availability Total type: integer format: int64 example: 2 HostsAvailabilityStatusResponse: description: Service Connectors Availability Status type: object properties: up: description: Service Connectors Availability Up type: integer format: int64 example: 1 down: description: Service Connectors Availability Down type: integer format: int64 example: 4 total: description: Service Connectors Availability Total type: integer format: int64 example: 5 RadsecProxiesStatusResponse: description: Radsec Proxies Status type: object properties: total: description: Radsec Proxies Total type: integer format: int64 example: 7 partially_down: description: Radsec Proxies Partially Down type: integer format: int64 example: 0 up: description: Radsec Proxies Up type: integer format: int64 example: 1 down: description: Radsec Proxies Down type: integer format: int64 example: 6 ServicesProtocolDistributionResponse: description: Services Protocol Distribution type: object properties: total: description: Total count type: integer format: int64 example: 16 additionalProperties: type: integer format: int64 description: Protocol count example: http: 2 vnc: 2 https: 4 rdp: 4 ssh: 4 total: 16 ServicesUsageResponse: description: Services Usage type: object properties: id: description: Service ID type: string format: string example: 200b5557-3883-4f82-9a3e-6b563ba60d66 total_bytes: description: Total Bytes type: integer format: int64 example: 5303685209 name: description: Service Name type: string format: string example: VLC TimeRange1: type: object properties: start_time: description: start of the time-range. formatted UTC date time(yyyy-MM-dd'T'HH:mm:ss) type: string example: '2023-10-08T08:00:14' end_time: description: end of the time-range. formatted UTC date time(yyyy-MM-dd'T'HH:mm:ss) type: string example: '2023-10-10T08:03:52' interval: description: time interval for aggregation. type: integer format: int64 example: 3600 EndSystemsDashboardAuthenticationTypesResponse: type: object properties: data: description: End System Dashboard Authentication Types type: object properties: 802.1x(TTLS): description: 802.1x(TTLS) authentication type count type: integer format: int64 example: 100 Guest: description: Guest authentication type count type: integer format: int64 example: 100 MAC-AUTH: description: MAC authentication type count type: integer format: int64 example: 100 EAP-TTLS: description: EAP-TTLS authentication type count type: integer format: int64 example: 100 EAP-TLS: description: EAP-TLS authentication type count type: integer format: int64 example: 100 time_range: description: The time range response $ref: '#/components/schemas/TimeRange1' EndSystemsDashboardAuthenticationTrendsResponse: type: object properties: data: description: End System Dashboard Authentication Trends type: array items: properties: timestamp: description: timestamp formatted UTC date time yyyy-MM-dd'T'HH:mm:ss type: string example: '2023-10-10T08:03:52.000Z' auth_types: description: authentication types type: object properties: 802.1x(TTLS): description: 802.1x(TTLS) authentication type count type: integer format: int64 example: 100 Guest: description: Guest authentication type count type: integer format: int64 example: 100 MAC-AUTH: description: MAC authentication type count type: integer format: int64 example: 100 EAP-TTLS: description: EAP-TTLS authentication type count type: integer format: int64 example: 100 EAP-TLS: description: EAP-TLS authentication type count type: integer format: int64 example: 100 time_range: description: The time range response $ref: '#/components/schemas/TimeRange1' EndSystemsDashboardNetworkAccessSummaryResponse: type: object properties: data: description: End System Dashboard Network Access Summary type: object properties: Rejected: description: rejected state count type: integer format: int64 example: 100 Accepted: description: accepted state count type: integer format: int64 example: 90 Disconnected: description: disconnected state count type: integer format: int64 example: 70 time_range: description: The time range response $ref: '#/components/schemas/TimeRange1' EndSystemsDashboardTopDeviceFamiliesResponse: type: object properties: data: description: End System Dashboard Top device families type: array items: properties: device_family: description: device family type: string example: Windows Mobile count: description: number of times above device family was seen in the given time range type: integer format: int64 example: 100 time_range: description: The time range response $ref: '#/components/schemas/TimeRange1' EndSystemsDashboardAuthStateTrendsResponse: type: object properties: data: description: End System Dashboard Auth State Trends type: array items: properties: timestamp: description: timestamp formatted UTC date time yyyy-MM-dd'T'HH:mm:ss type: string example: '2023-10-10T08:03:52.000Z' auth_states: description: auth states type: object properties: Rejected: description: rejected state count type: integer format: int64 example: 100 Accepted: description: accepted state count type: integer format: int64 example: 90 Disconnected: description: disconnected state count type: integer format: int64 example: 70 time_range: description: The time range response $ref: '#/components/schemas/TimeRange1' EndSystemsDashboardTopPoliciesUsageResponse: type: object properties: data: description: End System Dashboard Top Policies Usage type: array items: properties: policy: description: policy type: string example: Rejected count: description: number of times above policy was seen in the given time range type: integer format: int64 example: 100 time_range: description: The time range response $ref: '#/components/schemas/TimeRange1' PoliciesCountResponse: description: Policies Count type: object properties: total_active_count: description: Total active policies count type: integer format: int64 example: 42 total_inactive_count: description: Total inactive policies count type: integer format: int64 example: 0 total_delete_in_progress_count: description: Total policies with delete in progress count type: integer format: int64 example: 0 total_deleted_count: description: Total deleted policies count type: integer format: int64 example: 0 total_expired_count: description: Total expired policies count type: integer format: int64 example: 2 total_impending_count: description: Total impending policies count type: integer format: int64 example: 2 total_deleted_from_xiq_count: description: Total policies deleted from XIQ count type: integer format: int64 example: 0 application: type: object properties: active_count: description: Active application policies count type: integer format: int64 example: 10 inactive_count: description: Inactive application policies count type: integer format: int64 example: 0 delete_in_progress: description: Application policies with delete in progress count type: integer format: int64 example: 0 deleted: description: Deleted application policies count type: integer format: int64 example: 0 expired: description: Expired application policies count type: integer format: int64 example: 2 impending: description: Impending application policies count type: integer format: int64 example: 2 network: type: object properties: active_count: description: Active network policies count type: integer format: int64 example: 26 inactive_count: description: Inactive network policies count type: integer format: int64 example: 0 delete_in_progress: description: Network policies with delete in progress count type: integer format: int64 example: 0 deleted: description: Deleted network policies count type: integer format: int64 example: 0 expired: description: Expired network policies count type: integer format: int64 example: 0 impending: description: Impending network policies count type: integer format: int64 example: 0 deleted_from_xiq: description: Network policies deleted from XIQ count type: integer format: int64 example: 0 hybrid: type: object properties: active_count: description: Active hybrid policies count type: integer format: int64 example: 6 inactive_count: description: Inactive hybrid policies count type: integer format: int64 example: 0 delete_in_progress: description: Hybrid policies with delete in progress count type: integer format: int64 example: 0 deleted: description: Deleted hybrid policies count type: integer format: int64 example: 0 expired: description: Expired hybrid policies count type: integer format: int64 example: 0 impending: description: Impending hybrid policies count type: integer format: int64 example: 0 topology_link: type: object description: The Topology Link properties: source: type: integer source_port_id: type: string source_lag: type: string destination: type: integer destination_port_id: type: string destination_lag: type: string index: type: integer connected: type: boolean connection_mode: type: string enum: - LLDP - CLIENT - UNKNOWNDEVICE - MESH - VGVA - FAKEGATEWAY topology_node_vlan: type: object description: Vlan Info for Topology Node properties: mgmt_vlan: type: integer native_vlan: type: integer access_port_vlans: type: array items: type: integer trunk_port_vlans: type: array items: type: integer user_profile_vlans: type: array items: type: integer topology_unknown_device: type: object description: Details of Unknown Device in Topology properties: mac_address: type: string hostname: type: string type: type: string ip_address: type: string topology_node_poe_info: type: object description: Poe Info of Topology Node properties: powerState: type: object 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 topology_stack_member_info: type: object description: Details of Topology Node stack vlan_info properties: stack_member_id: type: integer format: int64 device_id: type: integer format: int64 serial_number: type: string unit_number: type: integer member_type: type: string poe_info: $ref: '#/components/schemas/topology_node_poe_info' topology_position: type: object description: Position for Topology Node properties: x: type: integer format: dobule y: type: integer format: double topology_node: type: object description: The Topology Node properties: id: type: integer hostname: type: string mac_address: type: string ip_address: type: string port_number: type: string radio_info: type: string health_score: type: integer client_count: type: integer format: int64 last_node: type: boolean topology_start_node: type: boolean connected: type: boolean vlan_info: $ref: '#/components/schemas/topology_node_vlan' 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/topology_unknown_device' wired_interface_name: type: string connected_port: type: string stack_member_info: type: array items: $ref: '#/components/schemas/topology_stack_member_info' make: type: string position: $ref: '#/components/schemas/topology_position' poe_info: $ref: '#/components/schemas/topology_node_poe_info' product_type: type: string is_locally_managed: type: boolean sim_type: type: string topology_neighbor: type: object description: Neighbor of Topology nodes 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 client_details_topology: type: object description: The Topology for Client properties: links: type: array items: $ref: '#/components/schemas/topology_link' nodes: type: array items: $ref: '#/components/schemas/topology_node' baseline: type: boolean user_initiated: type: boolean created_at: type: integer format: int64 zoom: type: integer format: double pan: $ref: '#/components/schemas/topology_position' neighbors: type: array items: $ref: '#/components/schemas/topology_neighbor' client_details_overview: type: object description: The OverView for Client properties: device_connected: type: boolean device_id: type: integer format: int64 os_type: type: string ip_address: type: string mac_address: type: string device_location_names: type: string device_location_id: type: integer format: int64 alias: type: string user: type: string connection_to: type: string connection_time: type: integer format: int64 vlan: type: integer cwp_used: type: integer user_profile: type: string ssid: type: string radio: type: string wifi_protocol: type: string channel: type: integer client_hostname: type: string client_type: type: string rtts_supported: type: boolean XiqRttsSupportedDevicesRequest: type: object description: Location filters properties: site_ids: type: array description: The Site ID list items: type: integer description: The Site ID format: int64 building_ids: type: array description: The Building ID list items: type: integer description: The Building ID format: int64 floor_ids: type: array description: The Floor ID list items: type: integer description: The Floor ID format: int64 XiqRttsSupportedDevice: type: object description: Device Details properties: device_id: type: integer description: The Device ID format: int64 host_name: type: string description: The Hostname of Device serial_number: type: string description: The Serial Number of Device responses: ErrorResponse: description: The generic ExtremeCloud IQ API error response content: application/json: schema: $ref: '#/components/schemas/XiqError' 400BadRequestError: description: Bad Request content: application/json: schema: allOf: - $ref: '#/components/schemas/Error' - type: object properties: violations: type: array items: type: object properties: field: type: string message: type: string example: status: 400 title: Bad Request detail: Constraint Violation violations: - field: id message: may not be null - field: name message: may not be empty 401UnauthorizedError: description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error' example: status: 401 title: Unauthorized detail: You are not authenticated 403ForbiddenError: description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error' example: status: 403 title: Forbidden detail: Resource not authorized 404NotFoundError: description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error' example: status: 404 title: Not Found detail: Resource not found 405MethodNotAllowedError: description: Method Not Allowed content: application/json: schema: $ref: '#/components/schemas/Error' example: status: 405 title: Method Not Allowed detail: Only POST is allowed 500InternalServerError: description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error' example: status: 500 title: Internal Server Error detail: Things are a little unstable Error: description: The generic ExtremeCloud IQ API error response content: application/json: schema: $ref: '#/components/schemas/DefaultError' securitySchemes: BearerAuth: type: http description: JSON Web Token (JWT) based authentication scheme: bearer bearerFormat: JWT parameters: id: name: id in: path description: The unique identifier required: true schema: type: integer format: int64 page: name: page in: query description: Page number, min = 1 required: false schema: minimum: 1 type: integer format: int32 default: 1 limit: name: limit in: query description: Page Size, min = 1, max = 100 required: false schema: maximum: 100 minimum: 1 type: integer format: int32 default: 10 order: name: order in: query description: The sort order (ascending by default) required: false schema: $ref: '#/components/schemas/XiqSortOrder' startTime: 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 endTime: 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 locationIds: name: locationIds in: query description: The location IDs required: false schema: type: array items: type: integer format: int64 async: in: query name: async description: Whether to enable async mode required: false schema: type: boolean default: false XiqDeviceVlanPageLimit: name: XiqDeviceVlanPageLimit in: query description: Page Size, min = 1, max = 4095 required: false schema: maximum: 4095 minimum: 1 type: integer format: int32 default: 10 XiqDeviceVlanIpv4InterfacesPageLimit: name: XiqDeviceVlanIpv4InterfacesPageLimit in: query description: Page Size, min = 1, max = 2048 required: false schema: maximum: 2048 minimum: 1 type: integer format: int32 default: 10 XiqDeviceIpv4RoutePageLimit: name: XiqDeviceIpv4RoutePageLimit in: query description: Page Size, min = 1, max = 300 required: false schema: maximum: 300 minimum: 1 type: integer format: int32 default: 10 deviceIds: name: deviceIds in: query description: The device IDs required: false schema: type: array items: type: integer format: int64 ownerId: name: ownerId in: query description: The Owner Id required: true schema: type: integer format: int64 fields: name: fields in: query description: The client fields to return required: false schema: type: array items: $ref: '#/components/schemas/XiqClientField' views: 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' mac: name: clientMac in: path description: The mac address of client required: true schema: type: string n: name: n in: path description: The TopN number required: true schema: maximum: 100 minimum: 1 type: integer format: int32 acknowledged: in: query name: acknowledged description: Default is null, which will return all alerts. Set it to false to only return unacknowledged alerts. Otherwise, set it to true only return acknowledged alerts. required: false schema: type: boolean categoryIds: in: query description: The alert category Ids to filter, use alert/metadata API to get category information. name: categoryIds required: false schema: type: array description: The alert category ID list. items: type: integer format: int64 description: The alert category ID. 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. name: severityIds required: false schema: type: array description: The alert severity ID list. items: type: integer format: int64 description: The alert severity ID. messageMetadataIds: in: query description: The message metadata ID list to filter. Use /alert/metadata/events-by-category or /alert/metadata/metrics-by-metricset APIs to get the message metadata information. name: messageMetadataIds required: false schema: type: array description: The message metadata ID list. items: type: string description: The message metadata ID. siteId: in: query description: The site ID to filter. name: siteId required: false schema: type: integer format: int64 description: The site ID group: name: group in: path description: The group to count from required: true schema: $ref: '#/components/schemas/XiqAlertGroupQuery' policyId: in: path name: policyId description: The alert policy identifier. schema: type: integer format: int64 required: true ruleId: name: ruleId in: path description: The alert rule identifier. required: true schema: type: integer format: int64 wirelessViewType: in: query description: The wireless experience view type name: viewType required: true schema: type: string enum: - LOCATION - SSID - OS sortField: name: sortField in: query description: The sort field required: false schema: type: string enum: - NAME - QUALITY_INDEX sortOrder: name: sortOrder in: query description: The sort order (ascending by default) required: false schema: $ref: '#/components/schemas/XiqSortOrder' wiredViewType: in: query description: The wired experience view type name: viewType required: false schema: type: string enum: - LOCATION wiredViewIdentifier: in: query description: The view identifier based on selected view type name: viewId required: true schema: type: string forensicBucket: in: query description: The historical period bucket name: forensicBucket required: true schema: type: string enum: - TWENTY_FOUR_HOURS - ONE_HOUR - ONE_DAY - ONE_WEEK - SEVEN_DAYS - THIRTY_DAYS - NINETY_DAYS locationId: in: query description: The location id name: locationId required: false schema: type: integer format: int64 wiredScoreType: in: query description: The wired score type name: scoreType required: true schema: type: string enum: - PORT_ERRORS wiredSortField: name: sortField in: query description: The sort field required: false schema: type: string enum: - IN_ERRORS searchKey: in: query description: The search key name: searchKey required: false schema: type: string timestamp: name: timestamp in: query description: The timestamp to query, epoch time in milliseconds since 1/1/1970 required: false schema: type: integer format: int64 clientType: name: clientType in: query description: The client type required: false schema: $ref: '#/components/schemas/XiqClientType' qualityIndex: name: qualityIndex in: query description: The quality index score required: false schema: $ref: '#/components/schemas/XiqQualityIndex' viewId: in: query description: The location id name: locationId required: true schema: type: integer format: int64 ssid: in: query description: The ssid value name: ssid required: false schema: type: string osType: in: query description: The os type value name: osType required: false schema: type: string wirelessSortField: name: sortField in: query description: The sort field required: false schema: type: string enum: - AVERAGE wirelessScoreType: in: query description: The wireless score type name: scoreType required: true schema: type: string enum: - TIME_TO_AUTHENTICATE - TIME_TO_ASSOCIATE - TIME_TO_DHCP - RETRIES anomalyId: in: query description: The anomaly id name: anomalyId required: true schema: type: string offsetTime: in: query description: The offset value name: offsetTime required: true schema: type: integer format: int32 deviceId: in: query description: The device id name: deviceId required: true schema: type: integer format: int64 channelNumber: in: query description: The channel number name: channel required: true schema: type: integer format: int32 timestamp1: in: query description: The timestamp name: timestamp required: true schema: type: integer format: int64 startTime1: in: query description: The start time name: startTime required: false schema: type: integer format: int64 endTime1: in: query description: The end time name: endTime required: false schema: type: integer format: int64 buildingId: in: query description: The building id name: buildingId required: false schema: type: integer format: int64 severity: name: severity in: query description: The anomaly severity required: false schema: $ref: '#/components/schemas/XiqAnomalySeverity' anomalyType: name: anomalyType in: query description: The anomaly type required: false schema: $ref: '#/components/schemas/XiqAnomalyType' muted: in: query name: excludeMuted description: To filter muted anomalies required: false schema: type: boolean default: false sortField1: name: sortField in: query description: The sort field required: false schema: type: string enum: - DEVICE_NAME - SEVERITY - LOCATION - CATEGORY - ANOMALY_TYPE - TIME fileType: name: fileType in: query description: The file type required: false schema: type: string lastDetectedTime: in: query description: The last detected time name: lastDetectedTime required: false schema: type: integer format: int64 startTimeCount: in: query name: startTime description: The Start time required: true schema: type: integer format: int64 endTimeCount: in: query name: endTime description: The End time required: true schema: type: integer format: int64 vlanIds: in: query description: The vlan ids name: vlanIds required: true schema: type: array description: The vlan Ids items: type: integer format: int64 siteIds: in: query description: The site ids name: siteIds required: true schema: type: array description: The site Ids items: type: integer format: int64 hhStatsFieldType: name: hhStatsFieldType in: query description: The Hardware Health anomaly CPU or Memory Stats type required: true schema: $ref: '#/components/schemas/XiqAnomalyHhStatsType' floorId: in: query description: The location ID of the floor name: floorId required: true schema: type: string parentId: in: query description: The location ID of the floor's parent name: parentId required: true schema: type: string NetworkPolicyId: name: policyId in: path description: ID of the related network policy required: true schema: type: integer format: int64 ApplianceId: name: applianceId in: path description: ID of the related appliance required: true schema: type: integer format: int64 sn: name: sn in: path description: The serial number of an Ap. required: true schema: type: string folderId: name: folderId in: query description: The folder id for the location required: true schema: type: integer format: int64 selectedTime: name: selectedTime in: query description: The selected time to query, epoch time in milliseconds since 1/1/1970 required: false schema: type: integer format: int64 id-2: name: metrics in: path description: | **The below table defines the different REPORT_METRICS values and their descriptions** | Metric Identifier | Description | |-----------------------------|-----------------------------------------------------------------------------| | MAX_CONCURRENT_CLIENTS | Maximum concurrent clients over time | | UNIQUE_CLIENTS_BY_SSID | Unique clients over time by SSID | | UNIQUE_WIFI_CLIENTS | Unique WiFi clients over time | | CLIENT_QUALITY_SCORE | Client quality score over time | | CLIENT_SESSIONS | Client sessions over time | | CLIENT_AIRTIME_USAGE | Client airtime usage over time | | WIRELESS_CLIENTS_BY_OS | Wireless clients categorized by OS | | UNIQUE_CLIENTS_BY_OS | Unique clients categorized by OS | | TRAFFIC_VOLUME_PER_APP | Traffic volume per application | | APP_TRAFFIC_PERCENTAGE | Percentage of total traffic per application | | DEVICES_BY_CLIENTS | Devices used by clients over time | | SWITCH_SUMMARY | Summary of switch-related metrics | required: true schema: type: string