From ceef0a83fd72f492233d94e0a516cd2b8bd4bd8a Mon Sep 17 00:00:00 2001 From: XIQ Service Account Date: Tue, 4 Apr 2023 18:50:25 -0700 Subject: [PATCH] Publishing new release --- xcloudiq-openapi.yaml | 14382 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 14382 insertions(+) create mode 100644 xcloudiq-openapi.yaml diff --git a/xcloudiq-openapi.yaml b/xcloudiq-openapi.yaml new file mode 100644 index 0000000..8afbb90 --- /dev/null +++ b/xcloudiq-openapi.yaml @@ -0,0 +1,14382 @@ +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: 23.2.0.30 +servers: +- url: '{base_url}' + description: ExtremeCloud IQ REST API Server + variables: + base_url: + description: ExtremeCloud IQ Production + default: https://api.extremecloudiq.com +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: 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 - Authentication + description: AD/LDAP/RADIUS/CWP/... +- name: Configuration - Certificate + description: Certificate +- name: Copilot - Connectivity Experience + description: The Copilot Connectivity Experience API +- name: Copilot - Anomalies + description: The Copilot Anomalies API +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. + 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 + required: true + responses: + '200': + description: Successfully login + content: + application/json: + schema: + $ref: '#/components/schemas/XiqLoginResponse' + examples: + 200 example: + summary: Login successful + description: Login successful response example. + value: + access_token: eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjpmYWxzZSwib3duZXJfaWQiOjEwMiwib3JnX2lkIjowLCJkYXRhX2NlbnRlciI6IlVTX1dlc3QiLCJxdW90YSI6Ijc1MDA7dz0zNjAwIiwianRpIjoiMTcyZTExMWMwNDMzNDBkODkyYmViYTkyNmZlOTM0NmYiLCJpc3MiOiJleHRyZW1lY2xvdWRpcS5jb20iLCJpYXQiOjE2NDQ4NzcwNDgsImV4cCI6MTY0NDk2MzQ0OH0.kFRSUXLhg9800gSU2BQ4Gf7l_8eEhgpd0D90Ia6w0kw + token_type: Bearer + expires_in: 86400 + 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. \nThe available permission list can be found via 'GET /auth/permissions' endpoint." + 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 example 1: + summary: Generate API token with specific permissions + description: Generate API token with a single permission to read account info + value: + description: Token for reading account info only + expire_time: 1604737598 + permissions: + - account:r + required: true + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/XiqGenerateApiTokenResponse' + default: + $ref: '#/components/responses/ErrorResponse' + /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/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: [] + /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: [] + /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/XiqCreateLocationRequest' + required: true + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/XiqLocation' + 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/XiqLocation' + 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 500 KB." + 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/XiqUpdateLocationRequest' + required: true + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/XiqLocation' + 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: + 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/XiqCreateFloorRequest' + required: true + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/XiqFloor' + default: + $ref: '#/components/responses/ErrorResponse' + security: + - BearerAuth: [] + /locations/floor/{id}: + 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/XiqUpdateFloorRequest' + required: true + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/XiqFloor' + 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: + 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/XiqCreateBuildingRequest' + required: true + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/XiqBuilding' + default: + $ref: '#/components/responses/ErrorResponse' + security: + - BearerAuth: [] + /locations/building/{id}: + 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/XiqUpdateBuildingRequest' + required: true + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/XiqBuilding' + 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: [] + /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' + - 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' + - $ref: '#/components/parameters/async' + 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, and Dell. + 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/: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 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/XiqDeviceFilter' + 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' + 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}/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/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: [] + /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: [] + /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 + 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 + 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 + - 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: clientConnectionTypes + in: query + description: The client connection types + 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/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_for_one_client + 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/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_active_clients_count + 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 + 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#_disconnect_client_by_macAddress_for_one_client + operationId: disconnectClient + description: Disconnect the client. + parameters: + - $ref: '#/components/parameters/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: [] + /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' + - name: severity + in: query + description: The alert severity to filter + required: false + schema: + $ref: '#/components/schemas/XiqAlertSeverity' + - name: category + in: query + description: The alert category to filter + required: false + schema: + $ref: '#/components/schemas/XiqAlertCategory' + - name: alertType + in: query + description: The alert type to filter + required: false + schema: + type: string + - name: keyword + in: query + description: The keyword to filter, such as device SN or MAC address + 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/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/group' + - $ref: '#/components/parameters/startTime' + - $ref: '#/components/parameters/endTime' + responses: + '200': + description: OK + content: + application/json: + schema: + type: object + additionalProperties: + type: integer + format: int64 + default: + $ref: '#/components/responses/ErrorResponse' + security: + - BearerAuth: [] + /logs/audit: + get: + tags: + - Log + summary: List audit logs + description: List a page of audit logs. + externalDocs: + description: API Reference + url: https://extremecloudiq.com/api-docs/api-reference.html#_list_audit_log + operationId: listAuditLogs + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/limit' + - 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 + required: false + schema: + type: integer + format: int64 + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/PagedXiqAuditLog' + 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 + responses: + '200': + description: OK + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/XiqWebhookSubscription' + 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: [] + /deployments: + post: + tags: + - Configuration - Deployment + summary: Push configuration and upgrade firmware + description: Push configuration and upgrade firmware to the target devices. + externalDocs: + description: API Reference + url: https://extremecloudiq.com/api-docs/api-reference.html#_push_configuration_and_upgrade_firmware_to_devices + operationId: deployConfig + requestBody: + description: The device deploy configuration + content: + application/json: + schema: + $ref: '#/components/schemas/XiqDeploymentRequest' + required: true + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/XiqDeploymentResponse' + 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: [] + /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: Setup a Key-based Private Client Group + description: Setup a Key-based Private Client Group, including network policy, user, user group, SSID, etc. + externalDocs: + description: API Reference + url: https://extremecloudiq.com/api-docs/api-reference.html#_initiate_key_based_pcg + operationId: setupKeyBasedPrivateClientGroupNetworkPolicy + requestBody: + description: The request to setup Key-based PCG network policy + content: + application/json: + schema: + $ref: '#/components/schemas/XiqInitKeyBasedPcgNetworkPolicyRequest' + required: true + responses: + '202': + description: Accepted + default: + $ref: '#/components/responses/ErrorResponse' + security: + - BearerAuth: [] + /pcgs/key-based/network-policy-{policyId}/:onboard: + post: + tags: + - Configuration - User Management + summary: Create Key-based PCG in network policy + description: Create a Key-based Private Client Group for a specific network policy. + externalDocs: + description: API Reference + url: https://extremecloudiq.com/api-docs/api-reference.html#_create_key_based_pcg_data + operationId: onboardKeyBasedPrivateClientGroup + parameters: + - name: policyId + in: path + description: The network policy ID + required: true + schema: + type: integer + format: int64 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/XiqOnboardKeyBasedPcgRequest' + required: true + responses: + '202': + description: Accepted + 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: Add users to a PCG-enabled network policy + description: Add users to a PCG-enabled network policy. + externalDocs: + description: API Reference + url: https://extremecloudiq.com/api-docs/api-reference.html#_add_key_based_pcg_users_to_an_exists_key_based_pcg + operationId: addKeyBasedPcgUsers + parameters: + - name: policyId + in: path + description: The network policy ID + required: true + schema: + type: integer + format: int64 + requestBody: + description: The payload of add users to PCG-enabled network policy + content: + application/json: + schema: + $ref: '#/components/schemas/XiqCreateKeyBasedPcgUsersRequest' + required: true + responses: + '202': + description: Accepted + 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 profiles + description: List all L3 Address Profiles. + externalDocs: + description: API Reference + url: https://extremecloudiq.com/api-docs/api-reference.html#_list_the_l3_address_profile + operationId: listL3AddressProfiles + parameters: + - name: addressType + in: query + description: The address type + required: true + schema: + type: string + enum: + - L3_ADDRESS_TYPE_UNSPECIFIED + - L3_ADDRESS_TYPE_IP_ADDRESS + - L3_ADDRESS_TYPE_IP_SUBNET + - L3_ADDRESS_TYPE_IP_RANGE + - UNRECOGNIZED + responses: + '200': + description: OK + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/XiqL3AddressProfile' + 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: [] + /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/PagedXiqSsid' + 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 + 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 + 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}/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: [] + /ccgs: + get: + tags: + - Configuration - Policy + summary: List clould config groups + description: List a papge of cloud config groups. + externalDocs: + description: API Reference + url: https://extremecloudiq.com/api-docs/api-reference.html#_list_cloud_config_groups + operationId: listCloudConfigGroups + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/limit' + 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: [] + /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' + required: true + responses: + '201': + description: Created + content: + application/json: + schema: + $ref: '#/components/schemas/XiqExternalRadiusServer' + 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: [] + /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: [] + /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/wireless/quality-index: + get: + tags: + - Copilot - Connectivity Experience + summary: Get Wireless 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_wireless_quality_index + operationId: getWirelessQualityIndex + parameters: + - $ref: '#/components/parameters/wirelessViewType' + - $ref: '#/components/parameters/wirelessViewIdentifier' + - $ref: '#/components/parameters/forensicBucket' + - $ref: '#/components/parameters/startTime' + - $ref: '#/components/parameters/endTime' + - $ref: '#/components/parameters/locationType' + - $ref: '#/components/parameters/locationId' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/XiqCopilotWirelessQualityIndex' + default: + $ref: '#/components/responses/ErrorResponse' + security: + - BearerAuth: [] + /copilot/connectivity/wireless/time-to-connect: + get: + tags: + - Copilot - Connectivity Experience + summary: Get Wireless Connectivity Time-To-Connect + 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 + operationId: getWirelessTimeToConnect + parameters: + - $ref: '#/components/parameters/wirelessViewType' + - $ref: '#/components/parameters/wirelessViewIdentifier' + - $ref: '#/components/parameters/forensicBucket' + - $ref: '#/components/parameters/startTime' + - $ref: '#/components/parameters/endTime' + - $ref: '#/components/parameters/locationType' + - $ref: '#/components/parameters/locationId' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/XiqCopilotTimeToConnect' + default: + $ref: '#/components/responses/ErrorResponse' + security: + - BearerAuth: [] + /copilot/connectivity/wireless/performance: + get: + tags: + - Copilot - Connectivity Experience + summary: Get Wireless Connectivity Performance + 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 + operationId: getWirelessPerformance + parameters: + - $ref: '#/components/parameters/wirelessViewType' + - $ref: '#/components/parameters/wirelessViewIdentifier' + - $ref: '#/components/parameters/forensicBucket' + - $ref: '#/components/parameters/startTime' + - $ref: '#/components/parameters/endTime' + - $ref: '#/components/parameters/locationType' + - $ref: '#/components/parameters/locationId' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/XiqCopilotPerformance' + default: + $ref: '#/components/responses/ErrorResponse' + security: + - BearerAuth: [] + /copilot/connectivity/wireless/events: + get: + tags: + - Copilot - Connectivity Experience + summary: List Wireless Connectivity Events + 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 + operationId: getWirelessEvents + parameters: + - $ref: '#/components/parameters/wirelessViewType' + - $ref: '#/components/parameters/wirelessViewIdentifier' + - $ref: '#/components/parameters/wirelessScoreType' + - $ref: '#/components/parameters/forensicBucket' + - $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/searchKey' + - $ref: '#/components/parameters/locationType' + - $ref: '#/components/parameters/locationId' + - $ref: '#/components/parameters/timestamp' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/XiqCopilotWirelessEvents' + default: + $ref: '#/components/responses/ErrorResponse' + security: + - BearerAuth: [] + /copilot/connectivity/wireless/apps: + get: + tags: + - Copilot - Connectivity Experience + summary: Get Wireless Connectivity Apps Info + description: Get app statistics for a specific view type. + externalDocs: + description: API Reference + url: https://extremecloudiq.com/api-docs/api-reference.html#_get_wireless_apps + operationId: getWirelessApps + parameters: + - $ref: '#/components/parameters/wirelessViewType' + - $ref: '#/components/parameters/wirelessViewIdentifier' + - $ref: '#/components/parameters/forensicBucket' + - $ref: '#/components/parameters/startTime' + - $ref: '#/components/parameters/endTime' + - $ref: '#/components/parameters/locationType' + - $ref: '#/components/parameters/locationId' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/XiqCopilotWirelessApps' + default: + $ref: '#/components/responses/ErrorResponse' + security: + - BearerAuth: [] + /copilot/connectivity/wireless/views: + get: + tags: + - Copilot - Connectivity Experience + summary: Get Wireless Connectivity Views + description: Get all the views for a selected view type. + externalDocs: + description: API Reference + url: https://extremecloudiq.com/api-docs/api-reference.html#_get_wireless_views + operationId: getWirelessViews + parameters: + - $ref: '#/components/parameters/wirelessViewType' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/XiqCopilotWirelessViewsList' + 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' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/XiqCopilotWiredQualityIndex' + default: + $ref: '#/components/responses/ErrorResponse' + security: + - BearerAuth: [] + /copilot/connectivity/wired/hardware: + get: + tags: + - Copilot - Connectivity Experience + summary: Get Wired Connectivity Experience - Hardware + description: List a page of hardware score data over a selected period of time. + externalDocs: + description: API Reference + url: https://extremecloudiq.com/api-docs/api-reference.html#_get_wired_hardware + operationId: getWiredHardware + 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/XiqCopilotHardware' + 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/anomalies/locations: + get: + tags: + - Copilot - Anomalies + summary: List Anomaly Locations + description: List a page of Anomaly Locations. + externalDocs: + description: API Reference + url: https://extremecloudiq.com/api-docs/api-reference.html#_get_copilot_anomaly_locations + operationId: getCopilotAnomalyLocations + parameters: + - $ref: '#/components/parameters/anomalyType' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/limit' + - $ref: '#/components/parameters/sortField1' + - $ref: '#/components/parameters/sortOrder' + - $ref: '#/components/parameters/muted' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/XiqCopilotAnomaliesLocations' + default: + $ref: '#/components/responses/ErrorResponse' + security: + - BearerAuth: [] + /copilot/anomalies/devices-by-location: + get: + tags: + - Copilot - Anomalies + summary: Get Anomaly Devices for a given location + description: Get all anomaly devices for a given location. + externalDocs: + description: API Reference + url: https://extremecloudiq.com/api-docs/api-reference.html#_get_copilot_anomaly_devices + operationId: getCopilotAnomalyDevices + parameters: + - $ref: '#/components/parameters/anomalyType' + - $ref: '#/components/parameters/locationId1' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/XiqCopilotAnomaliesDevicesByLocation' + default: + $ref: '#/components/responses/ErrorResponse' + security: + - BearerAuth: [] + /copilot/anomalies/poeflapping/stats: + get: + tags: + - Copilot - Anomalies + summary: Get 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' + - $ref: '#/components/parameters/locationId1' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/XiqCopilotPoeFlappingStats' + 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' + - $ref: '#/components/parameters/locationId1' + 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' + - $ref: '#/components/parameters/locationId1' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/XiqCopilotDFSRecurrenceChannelStats' + default: + $ref: '#/components/responses/ErrorResponse' + security: + - BearerAuth: [] +components: + schemas: + XiqLoginRequest: + type: object + required: + - username + - password + properties: + username: + type: string + description: The login username + password: + type: string + description: The login password + 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 + 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: + 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 + 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 + 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 + 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. + 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 + XiqCreateLocationRequest: + type: object + required: + - name + properties: + parent_id: + type: integer + description: The parent location ID + format: int64 + name: + type: string + description: The location name + XiqLocation: + 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 for the location + children: + type: array + description: The child locations + items: + $ref: '#/components/schemas/XiqLocation' + XiqUpdateLocationRequest: + type: object + properties: + parent_id: + type: integer + description: The parent location ID + format: int64 + name: + type: string + description: The location name + XiqRfEnvironmentType: + type: string + description: The floor RF environment + enum: + - AUTO_ESTIMATE + - OFFICE + - OUTDOOR_FREE_SPACE + - OBSTRUCTED_IN_BUILDING + - OUTDOOR_SUBURBAN + - WAREHOUSE + - OUTDOOR_DENSE_URBAN + XiqMeasurementUnit: + type: string + description: The measurement unit in feet/meters + enum: + - FEET + - METERS + XiqCreateFloorRequest: + 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/XiqRfEnvironmentType' + db_attenuation: + type: number + description: The floor attenuation in dBs + format: double + measurement_unit: + $ref: '#/components/schemas/XiqMeasurementUnit' + installation_height: + type: number + description: The installation height + format: double + map_size_width: + type: number + description: The floor map width + format: double + map_size_height: + type: number + description: The floor map height + format: double + map_name: + type: string + description: The floor map name + XiqFloor: + 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/XiqRfEnvironmentType' + db_attenuation: + type: number + description: The floor attenuation in dBs + format: double + measurement_unit: + $ref: '#/components/schemas/XiqMeasurementUnit' + installation_height: + type: number + description: The installation height + format: double + map_size_width: + type: number + description: The floormap width + format: double + map_size_height: + type: number + description: The floormap height + format: double + map_name: + type: string + description: The floormap name + XiqUpdateFloorRequest: + type: object + properties: + parent_id: + type: integer + description: The parent building ID + format: int64 + name: + type: string + description: The floor name + environment: + $ref: '#/components/schemas/XiqRfEnvironmentType' + db_attenuation: + type: number + description: The floor attenuation in dBs + format: double + measurement_unit: + $ref: '#/components/schemas/XiqMeasurementUnit' + installation_height: + type: number + description: The installation height + format: double + map_size_width: + type: number + description: The floor map width + format: double + map_size_height: + type: number + description: The floor map height + format: double + map_name: + type: string + description: The floor map name + XiqCreateBuildingRequest: + 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: + type: string + description: The street address + XiqBuilding: + allOf: + - $ref: '#/components/schemas/XiqViqEntity' + - type: object + description: The building information + required: + - name + - parent_id + - address + properties: + name: + type: string + description: The building name + parent_id: + type: integer + description: The parent location ID + format: int64 + address: + type: string + description: The building street address + XiqUpdateBuildingRequest: + type: object + properties: + parent_id: + type: integer + description: The parent location ID + format: int64 + name: + type: string + description: The building name + address: + type: string + description: The street address + 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 + XiqSortOrder: + type: string + enum: + - ASC + - DESC + 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
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' + 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 + 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 + 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 + description: + type: string + description: The device description + 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 + 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' + 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 + 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 + 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 + description: Whether to enable iBeacon monitoring. Default to True on new device iBeacon setting. + 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 + 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 + 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 + description: Whether the device iBeacon monitoring is enabled. + network_policy_ibeacon_id: + type: integer + description: The beacon network policy ID. + format: int64 + 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' + 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 + 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 + PagedXiqSsid: + allOf: + - $ref: '#/components/schemas/XiqPage' + - type: object + properties: + data: + type: array + description: The data in the current page + items: + $ref: '#/components/schemas/XiqSsid' + 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 + - HEALTH_UPDATE_TIME + - RSSI + - RSSI_UPDATE_TIME + - SNR + - SNR_UPDATE_TIME + - RADIO_TYPE + - WING_AP + - VENDOR + - MOBILITY + - CATEGORY + - DESCRIPTION + - DEVICE_MAC_ADDRESS + 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
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 + format: int32 + encryption_method: + type: integer + description: The encryption method + format: int32 + interface_name: + type: string + description: The interface name + bssid: + type: string + description: The bssid + rssi: + type: integer + description: The RSSI + format: int32 + snr: + type: integer + description: The SNR + format: int32 + description: + type: string + description: The description of client + category: + type: string + description: The category of client + mobility: + type: string + description: The client mobility + port_type_name: + type: string + description: The client port type name + wing_ap: + type: boolean + description: Wing ap flag + vendor: + type: string + description: The vendor of client + locations: + type: array + description: The detailed location + items: + $ref: '#/components/schemas/XiqLocationLegend' + 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 + 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 + XiqAlertSeverity: + type: string + enum: + - CRITICAL + - INFO + - WARNING + XiqAlertCategory: + type: string + enum: + - DEVICE + - XIQ + - SECURITY + - PERFORMANCE + - CLIENT + - ANOMALY + XiqAlertSourceType: + type: string + enum: + - DEVICE + - CLIENT + XiqAlertSource: + type: object + description: The alert source info + properties: + source_name: + type: string + description: The alert source name + source_type: + $ref: '#/components/schemas/XiqAlertSourceType' + source_id: + type: string + description: The alert source ID + XiqAlert: + type: object + properties: + id: + type: string + description: The unique identifier + owner_id: + type: integer + description: The owner ID + format: int64 + timestamp: + type: string + description: The alert create time + format: date-time + org_id: + type: integer + description: The organization identifier, valid when enabling HIQ feature + format: int64 + type: + type: string + description: The alert type + summary: + type: string + description: A high-level, text summary message of the event. Will be used to construct an alert's description. + severity: + $ref: '#/components/schemas/XiqAlertSeverity' + category: + $ref: '#/components/schemas/XiqAlertCategory' + source: + $ref: '#/components/schemas/XiqAlertSource' + tags: + type: object + additionalProperties: + type: string + description: Additional information for the alert + description: Additional information for the alert + description: The Alert Model + required: + - id + - tags + - timestamp + PagedXiqAlert: + allOf: + - $ref: '#/components/schemas/XiqPage' + - type: object + properties: + data: + type: array + description: The data in the current page + items: + $ref: '#/components/schemas/XiqAlert' + XiqAlertGroupQuery: + type: string + enum: + - SEVERITY + - CATEGORY + - ALERT_TYPE + XiqAuditLogCategory: + type: string + enum: + - ADMIN + - SYSTEM + - DEPLOYMENT + - CONFIG + - MONITOR + - ALARM + 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 + PagedXiqAuditLog: + allOf: + - $ref: '#/components/schemas/XiqPage' + - type: object + properties: + data: + type: array + description: The data in the current page + items: + $ref: '#/components/schemas/XiqAuditLog' + 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' + 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' + 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) + XiqFirmwareActivateOption: + type: object + description: The firmware activate option (Only one of them can be enabled) + properties: + enable_activate_at_next_reboot: + type: boolean + description: Activate at next reboot (requires rebooting manually) + activation_delay_seconds: + type: integer + description: Activate after the given seconds + format: int64 + activation_time: + type: integer + description: Activate at the following time according to the system clock on the updated device + format: int64 + XiqDeploymentPolicy: + type: object + description: Push configuration and upgrade firmware policy + required: + - enable_complete_configuration_update + properties: + enable_complete_configuration_update: + type: boolean + description: true if update complete configuration, otherwise update delta configuration + firmware_upgrade_policy: + $ref: '#/components/schemas/XiqFirmwareUpgradePolicy' + firmware_activate_option: + $ref: '#/components/schemas/XiqFirmwareActivateOption' + XiqDeploymentRequest: + type: object + description: The configuration deployment request to devices + required: + - devices + - policy + properties: + devices: + $ref: '#/components/schemas/XiqDeviceFilter' + policy: + $ref: '#/components/schemas/XiqDeploymentPolicy' + XiqDeploymentResponse: + type: object + description: The configuration deployment response + properties: + request_id: + type: integer + format: int64 + 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 + 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 + 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' + 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 + 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 + 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 + 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 + XiqInitKeyBasedPcgNetworkPolicyRequest: + 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' + 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 + 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' + 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 + XiqL3AddressProfile: + allOf: + - $ref: '#/components/schemas/XiqBaseEntity' + - type: object + description: The L3 address profile + required: + - address_type + - name + properties: + address_type: + $ref: '#/components/schemas/XiqL3AddressType' + name: + type: string + description: Address profile name + 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 + 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' + 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 + 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. + required: + - key_management + - encryption_method + - enable_idm + properties: + key_management: + $ref: '#/components/schemas/XiqSsidDot1xKeyManagement' + encryption_method: + $ref: '#/components/schemas/XiqSsidDot1xEncryptionMethod' + enable_idm: + type: boolean + description: Flag for using ExtremeCloud IQ Authentication Service or not + transition_mode: + type: boolean + description: Flag for enabling transition mode if using WPA3 as the key management type + radius_server_group_id: + type: integer + description: The RADIUS server group ID if not using ExtremeCloud IQ Authentication Service + format: int64 + user_group_ids: + type: array + description: The user group IDs if using ExtremeCloud IQ Authentication Service + items: + type: integer + description: The user group IDs if using ExtremeCloud IQ Authentication Service + format: int64 + 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 + 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 + 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 + 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 + 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 + XiqExternalRadiusServer: + allOf: + - $ref: '#/components/schemas/XiqViqEntity' + - type: object + description: The configuration of external RADIUS server object + required: + - name + - authentication_port + - accounting_port + - server_type + - ip_address + - 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) + format: int32 + accounting_port: + type: integer + description: The accounting port for the external RADIUS server (1 ~ 65535) + format: int32 + server_type: + $ref: '#/components/schemas/XiqRadiusServerType' + ip_address: + type: string + description: The ip address or hostname of the RADIUS server + enable_a3: + type: boolean + description: Indicates whether this is an Extreme A3 RADIUS server or not, cannot be updated after creation. Please set it to false if it is not an Extreme A3 RADIUS server. + 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 + - ip_addr + - 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) + format: int32 + default: 1812 + accounting_port: + maximum: 65535 + minimum: 1 + type: integer + description: The accounting port for the external RADIUS server (1 ~ 65535) + format: int32 + default: 1813 + server_type: + $ref: '#/components/schemas/XiqRadiusServerType' + ip_addr: + type: string + description: The IP address or hostname of the RADIUS server + enable_a3: + type: boolean + description: Indicates whether this is an Extreme A3 RADIUS server or not, cannot be updated after creation. Please set it to false if it is not an Extreme A3 RADIUS server. + XiqUpdateExternalRadiusServerRequest: + type: object + required: + - name + - authentication_port + - accounting_port + - server_type + - ip_addr + properties: + name: + type: string + description: The external RADIUS server name + shared_secret: + type: string + description: The shared secret for the external RADIUS server (optional) + authentication_port: + maximum: 65535 + minimum: 1 + type: integer + description: The authentication port for the external RADIUS server (1 ~ 65535) + format: int32 + default: 1812 + accounting_port: + maximum: 65535 + minimum: 1 + type: integer + description: The accounting port for the external RADIUS server (1 ~ 65535) + format: int32 + default: 1813 + server_type: + $ref: '#/components/schemas/XiqRadiusServerType' + ip_addr: + type: string + description: The IP address or hostname of the RADIUS server + XiqCertificateType: + type: string + enum: + - CERT + - KEY + 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' + PagedXiqCertificate: + allOf: + - $ref: '#/components/schemas/XiqPage' + - type: object + properties: + data: + type: array + description: The data in the current page + items: + $ref: '#/components/schemas/XiqCertificate' + XiqCopilotConnectivityExperienceEntity: + type: object + description: Copilot Experience Entity + required: + - id + - name + - info + - quality_index + - trend_indicator + - 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 + 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' + XiqCopilotWirelessQualityIndex: + type: object + description: Wireless Connectivity Experience QualityIndex + required: + - quality_index + - time_to_connect_score + - performance_score + 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 + 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' + XiqCopilotWirelessApps: + type: object + description: Wireless Connectivity Experience Apps + required: + - total_clients + - most_active_app + - most_active_user + - total_apps + - total_users + properties: + total_clients: + type: integer + most_active_app: + type: string + most_active_user: + type: string + total_apps: + type: integer + total_users: + type: integer + XiqCopilotWirelessViewsList: + type: object + properties: + views_list_entities: + type: array + items: + type: string + 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 + 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 + XiqCopilotHardware: + type: object + properties: + quality_index_graph: + type: array + description: The data in the current page + items: + $ref: '#/components/schemas/XiqCopilotHardwareEntity' + 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' + XiqAnomalyType: + type: string + enum: + - POE_FLAPPING + - DFS_RECURRENCE + - MULTI_BROADCAST + - UPLINK_EFFICIENCY + - WIFI_CAPACITY + - WIFI_EFFICIENCY + XiqLocationType: + type: string + enum: + - SITE + - BUILDING + - FLOOR + XiqAnomalySeverity: + type: string + enum: + - LOW + - MEDIUM + - HIGH + XiqCopilotAnomaliesLocationEntity: + type: object + description: Anomaly Location Entity + required: + - location_type + - location_id + - location_name + - pinned + - muted + - severity + - severity_id + - summary + - anomaly_type + - affected_device_count + - last_detected_time + properties: + location_type: + $ref: '#/components/schemas/XiqLocationType' + location_id: + type: integer + format: int64 + location_name: + type: string + pinned: + type: boolean + muted: + type: boolean + severity_id: + type: integer + minimum: 1 + maximum: 3 + severity: + $ref: '#/components/schemas/XiqAnomalySeverity' + summary: + type: string + anomaly_type: + $ref: '#/components/schemas/XiqAnomalyType' + affected_device_count: + type: integer + last_detected_time: + type: integer + format: int64 + XiqCopilotAnomaliesLocations: + allOf: + - $ref: '#/components/schemas/XiqPage' + - type: object + properties: + summary: + type: string + locations: + type: array + description: The data in the current page + items: + $ref: '#/components/schemas/XiqCopilotAnomaliesLocationEntity' + XiqCopilotAnomaliesDeviceEntity: + type: object + description: Anomaly Device Entity + required: + - device_id + - device_name + - pinned + - wired + - anomaly_id + - severity + - summary + - last_detected_time + - recommended_action + - anomaly_subtypes + - interface_name + properties: + device_id: + type: string + device_name: + type: string + pinned: + type: boolean + wired: + type: boolean + anomaly_id: + type: string + severity: + $ref: '#/components/schemas/XiqAnomalySeverity' + summary: + type: string + last_detected_time: + type: integer + format: int64 + recommended_action: + type: string + anomaly_subtypes: + type: string + interface_name: + type: string + XiqCopilotAnomaliesDevicesByLocation: + allOf: + - $ref: '#/components/schemas/XiqCopilotAnomaliesLocationEntity' + - type: object + properties: + devices: + type: array + description: The data in the current page + items: + $ref: '#/components/schemas/XiqCopilotAnomaliesDeviceEntity' + 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' + 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 + responses: + ErrorResponse: + description: The generic ExtremeCloud IQ API error response + content: + application/json: + schema: + $ref: '#/components/schemas/XiqError' + securitySchemes: + BearerAuth: + type: http + description: JSON Web Token (JWT) based authentication + scheme: bearer + bearerFormat: JWT + parameters: + page: + name: page + in: query + description: Page number, min = 1 + required: false + schema: + minimum: 1 + type: integer + format: int32 + default: 1 + limit: + name: limit + in: query + description: Page Size, min = 1, max = 100 + required: false + schema: + maximum: 100 + minimum: 1 + type: integer + format: int32 + default: 10 + id: + name: id + in: path + description: The unique identifier + required: true + schema: + type: integer + format: int64 + order: + name: order + in: query + description: The sort order (ascending by default) + required: false + schema: + $ref: '#/components/schemas/XiqSortOrder' + async: + name: async + in: query + description: Whether to enable async mode + required: false + schema: + type: boolean + default: false + 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 + 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' + locationIds: + name: locationIds + in: query + description: The location IDs + required: false + schema: + type: array + items: + type: integer + format: int64 + deviceIds: + name: deviceIds + in: query + description: The device IDs + required: false + schema: + type: array + items: + type: integer + format: int64 + 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 + group: + name: group + in: path + description: The group to count from + required: true + schema: + $ref: '#/components/schemas/XiqAlertGroupQuery' + 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' + wirelessViewIdentifier: + 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 + locationType: + in: query + description: The location type + name: locationType + required: false + schema: + type: string + locationId: + in: query + description: The location id + name: locationId + required: false + schema: + type: string + 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 + wirelessSortField: + name: sortField + in: query + description: The sort field + required: false + schema: + type: string + enum: + - AVERAGE + searchKey: + in: query + description: The search keyword + 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 + wiredViewType: + in: query + description: The wired experience view type + name: viewType + required: true + schema: + type: string + enum: + - LOCATION + wiredViewIdentifier: + in: query + description: The view identifier based on selected view type + name: viewId + required: true + schema: + type: string + 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 + anomalyType: + name: anomalyType + in: query + description: The anomaly type + required: true + schema: + $ref: '#/components/schemas/XiqAnomalyType' + sortField1: + name: sortField + in: query + description: The sort field + required: false + schema: + type: string + enum: + - LOCATION + - SEVERITY + - TIME + muted: + in: query + name: excludeMuted + description: To filter muted anomalies + required: false + schema: + type: boolean + default: false + locationId1: + in: query + description: The location id + name: locationId + required: true + schema: + type: integer + format: int64 + anomalyId: + in: query + description: The anomaly id + name: anomalyId + required: true + schema: + type: string