ExtremeCloud IQ API

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: [email protected]
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
  version: 25.9.0-36
servers:
- url: https://api.extremecloudiq.com
  description: ExtremeCloud IQ REST API Server
externalDocs:
  description: API Reference
  url: https://extremecloudiq.com/api-docs/api-reference.html
tags:
- name: Authentication
  description: User login & logout
- name: Authorization
  description: API token and permissions
- name: Operation
  description: Long-Running Operations (LRO) management for asynchronous APIs
- name: Account
  description: ExtremeCloud IQ Account
- name: User
  description: Local and external user management in ExtremeCloud IQ account
- name: HIQ
  description: Hierarchical ExtremeCloud IQ
- name: Location
  description: Hierarchical locations and floor plan
- name: Device
  description: 'Supported device platforms: Cloud Engine, IQ Engine, WiNG, VOSS, EXOS...'
- name: Network Policy
  description: Unified configuration management for wireless and wired network devices
- name: Network Scorecard
  description: The network scorecard containing device, client, network, Wi-Fi, services health of the selected location.
- name: Client
  description: The clients associate to the devices of ExtremeCloud IQ
- name: Application
  description: Application management and application metrics
- name: Alert
  description: ExtremeCloud IQ generated alerts and events
- name: Log
  description: Access all kinds of logs in ExtremeCloud IQ
- name: Notification
  description: Push events/logs to users via Webhook, Email, SMS, etc.
- name: Configuration - Deployment
  description: Push configuration to devices
- name: Configuration - Basic
  description: VLAN Profile/DHCP Server/...
- name: Configuration - User Management
  description: User Group/End User/PCG/PPSK Classification
- name: Configuration - Policy
  description: SSID/User Profile/Classification Rule/CCG/Radio Profile/...
- name: Configuration - Network
  description: Tunnel Concentrator Service, Network service
- name: Configuration - Authentication
  description: AD/LDAP/RADIUS/RADSEC/CWP/...
- name: Configuration - Certificate
  description: Certificate
- name: Copilot - Connectivity Experience
  description: The Copilot Connectivity Experience API
- name: Copilot - Anomalies
  description: The Copilot Anomalies API
- name: PacketCaptures
  description: Packet capture sessions in ExtremeCloud IQ
- name: Essentials - ExtremeLocation
  description: The ExtremeLocation and Analytics API
- name: Misc
  description: Metadata - Country/...
- name: SDWAN
  description: The SDWAN API
- name: Thread
  description: Thread Networks in ExtremeCloud IQ
- name: AFC
  description: ExtremeCloud IQ AFC Feature.
- name: Universal Compute Platform
  description: The Universal Compute Platform (UCP) API
- name: Administration
  description: API Token Management and 3rd Party API Connections
- name: Dashboard
  description: Device and client health and status/dashboard
- name: D360
  description: Device 360
- name: Dashboard - Wireless Client Health
  description: Client dashboard
- name: Dashboard - Wireless Usage and Capacity
  description: Usage and capacity dashboard
- name: Dashboard - Wireless Device Health
  description: Device dashboard
- name: Dashboard - Wired Client Health
  description: Client dashboard
- name: Dashboard - Wired Device Health
  description: Device dashboard
- name: Dashboard - Wired Usage and Capacity
  description: Wired Usage and Capacity
- name: Switch Inspector Panel
  description: Switch Inspector Panel
- name: Geo-View
  description: Geo View
- name: NG Reports
  description: The NG Reports - On Demand Analytics and Scheduled Reporting
- name: NG Scheduled Reports
  description: The NG Reports - Scheduled Reporting
- name: UZ
  description: UZ Requests
- name: Client - Details
  description: The details of client associate to the devices of ExtremeCloud IQ
- name: RTTS
  description: RTT sessions in ExtremeCloud IQ
paths:
  /login:
    post:
      tags:
      - Authentication
      summary: User login with username and password
      description: Get access token via username and password authentication. <p> 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. <p> User can also provide an optional rate limits parameter to control the rate limiting for the current session.
      operationId: login
      externalDocs:
        description: API Reference
        url: https://extremecloudiq.com/api-docs/api-reference.html#_login
      requestBody:
        description: Login request body
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/XiqLoginRequest'
            examples:
              Normal_login:
                summary: Login with username and password
                description: User login with username/email and password
                value:
                  username: [email protected]
                  password: ChangeMe
              login_with_rate_limiting:
                summary: Login with rate limiting
                description: User login with rate limiting
                value:
                  username: [email protected]
                  password: ChangeMe
                  rate_limit:
                    hour: 7500
              login_with_multiple_rate_limits:
                summary: Login with multiple rate limits
                description: User login with multiple rate limits
                value:
                  username: [email protected]
                  password: ChangeMe
                  rate_limit:
                    hour: 7500
                    second: 100
        required: true
      responses:
        '200':
          description: Successfully login
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/XiqLoginResponse'
              examples:
                Login_successful:
                  summary: Login successful
                  description: Login successful response example.
                  value:
                    access_token: eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjpmYWxzZSwib3duZXJfaWQiOjEwMiwib3JnX2lkIjowLCJkYXRhX2NlbnRlciI6IlVTX1dlc3QiLCJxdW90YSI6Ijc1MDA7dz0zNjAwIiwianRpIjoiMTcyZTExMWMwNDMzNDBkODkyYmViYTkyNmZlOTM0NmYiLCJpc3MiOiJleHRyZW1lY2xvdWRpcS5jb20iLCJpYXQiOjE2NDQ4NzcwNDgsImV4cCI6MTY0NDk2MzQ0OH0.kFRSUXLhg9800gSU2BQ4Gf7l_8eEhgpd0D90Ia6w0kw
                    token_type: Bearer
                    expires_in: 86400
        default:
          $ref: '#/components/responses/ErrorResponse'
  /logout:
    post:
      tags:
      - Authentication
      summary: User logout (Revoke the current access token)
      description: User logout, the current access token will be revoked and the following access with the same token will be immediately denied.
      operationId: logout
      externalDocs:
        description: API Reference
        url: https://extremecloudiq.com/api-docs/api-reference.html#_logout
      responses:
        '200':
          description: OK
        default:
          $ref: '#/components/responses/ErrorResponse'
      security:
      - BearerAuth: []
  /auth/apitoken:
    post:
      tags:
      - Authorization
      summary: Generate new API token
      description: Generate a new API token with given permissions and expiration time.  <p> The available permission list can be found via 'GET /auth/permissions' endpoint. <p> User can also provide an optional rate limits parameter to control the rate limiting for the API token.
      operationId: generateApiToken
      externalDocs:
        description: API Reference
        url: https://extremecloudiq.com/api-docs/api-reference.html#_generate_api_token
      requestBody:
        description: Generate API token request body
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/XiqGenerateApiTokenRequest'
            examples:
              Generate_API_token:
                summary: Generate API token with specific permissions
                description: Generate API token with a single permission to read account info
                value:
                  description: Token for reading account info only
                  expire_time: 1604737598
                  permissions:
                  - account:r
              Generate_API_token_with_rate_limiting:
                summary: Generate API token with specific permissions and rate limiting
                description: Generate API token with a single permission to read account info and rate limiting
                value:
                  description: Token for reading account info only
                  expire_time: 1604737598
                  permissions:
                  - account:r
                  rate_limit:
                    hour: 7500
              Generate_API_token_with_multiple_rate_limits:
                summary: Generate API token with specific permissions and multiple rate limits
                description: Generate API token with a single permission to read account info and multiple rate limits
                value:
                  description: Token for reading account info only
                  expire_time: 1604737598
                  permissions:
                  - account:r
                  rate_limit:
                    hour: 7500
                    second: 100
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/XiqGenerateApiTokenResponse'
        default:
          $ref: '#/components/responses/ErrorResponse'
      security:
      - BearerAuth: []
  /auth/apitoken/info:
    get:
      tags:
      - Authorization
      summary: Get current API token details
      description: Introspect current API token and get detail information.
      operationId: getCurrentApiTokenInfo
      externalDocs:
        description: API Reference
        url: https://extremecloudiq.com/api-docs/api-reference.html#_get_api_token_details
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/XiqApiTokenInfo'
        default:
          $ref: '#/components/responses/ErrorResponse'
      security:
      - BearerAuth: []
  /auth/apitoken/:validate:
    post:
      tags:
      - Authorization
      summary: Validate API token
      description: Validate JWT format API token.
      operationId: validateApiToken
      externalDocs:
        description: API Reference
        url: https://extremecloudiq.com/api-docs/api-reference.html#_validate_api_token
      requestBody:
        content:
          text/plain:
            schema:
              type: string
              description: The API token to be validated
        required: true
      responses:
        '200':
          description: The API token is valid
        '401':
          description: The API token is invalid or revoked
        default:
          $ref: '#/components/responses/ErrorResponse'
  /auth/permissions:
    get:
      tags:
      - Authorization
      summary: Get permissions for current login user
      description: Get permissions for current login user, which are allowed for generating new API tokens.
      operationId: listPermissions
      externalDocs:
        description: API Reference
        url: https://extremecloudiq.com/api-docs/api-reference.html#_list_permissions
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: string
        default:
          $ref: '#/components/responses/ErrorResponse'
      security:
      - BearerAuth: []
  /auth/permissions/:check:
    post:
      tags:
      - Authorization
      summary: Check permissions
      description: Get required permissions for given HTTP request.
      operationId: checkPermissions
      externalDocs:
        description: API Reference
        url: https://extremecloudiq.com/api-docs/api-reference.html#_check_permissions
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/XiqCheckPermissionRequest'
        required: true
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/XiqCheckPermissionResponse'
        default:
          $ref: '#/components/responses/ErrorResponse'
      security:
      - BearerAuth: []
  /operations/{operationId}:
    get:
      tags:
      - Operation
      summary: Get Long-Running Operation (LRO) status and result
      description: |-
        Get the Long-Running Operation (LRO) status and result.
        The response will include either result or error if the operation is done.
      externalDocs:
        description: API Reference
        url: https://extremecloudiq.com/api-docs/api-reference.html#_get_operation
      operationId: getOperation
      parameters:
      - name: operationId
        in: path
        description: The operation ID
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/XiqOperationObject'
        default:
          $ref: '#/components/responses/ErrorResponse'
      security:
      - BearerAuth: []
    delete:
      tags:
      - Operation
      summary: Delete Long-Running Operation (LRO)
      description: The Long-Running Operation (LRO) can be deleted when the operation is done or in PENDING status.
      externalDocs:
        description: API Reference
        url: https://extremecloudiq.com/api-docs/api-reference.html#_delete_operation
      operationId: deleteOperation
      parameters:
      - name: operationId
        in: path
        description: The operation ID
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
        default:
          $ref: '#/components/responses/ErrorResponse'
      security:
      - BearerAuth: []
  /operations/{operationId}/:cancel:
    post:
      tags:
      - Operation
      summary: Cancel Long-Running Operation (LRO)
      description: |-
        When the cancelable is true in operation metadata the clients are allowed to send a cancel request to ask the backend to cancel the operation.
        The server makes its best effort to cancel the operation, but success is not guaranteed.
      externalDocs:
        description: API Reference
        url: https://extremecloudiq.com/api-docs/api-reference.html#_cancel_operation
      operationId: cancelOperation
      parameters:
      - name: operationId
        in: path
        description: The operation ID
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
        default:
          $ref: '#/components/responses/ErrorResponse'
      security:
      - BearerAuth: []
  /account/home:
    get:
      tags:
      - Account
      summary: Get home ExtremeCloud IQ account info
      description: Get home ExtremeCloud IQ account info.
      externalDocs:
        description: API Reference
        url: https://extremecloudiq.com/api-docs/api-reference.html#_get_basic_info
      operationId: getHomeAccount
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/XiqAccount'
        default:
          $ref: '#/components/responses/ErrorResponse'
      security:
      - BearerAuth: []
  /account/external:
    get:
      tags:
      - Account
      summary: List accessible external guest accounts
      description: List accessible external ExtremeCloud IQ accounts.
      externalDocs:
        description: API Reference
        url: https://extremecloudiq.com/api-docs/api-reference.html#_list_external_accounts
      operationId: listExternalAccounts
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/XiqExternalAccount'
        default:
          $ref: '#/components/responses/ErrorResponse'
      security:
      - BearerAuth: []
  /account/:switch:
    post:
      tags:
      - Account
      summary: Switch to another ExtremeCloud IQ account
      description: Switch to external ExtremeCloud IQ account or switch back to home ExtremeCloud IQ account.
      externalDocs:
        description: API Reference
        url: https://extremecloudiq.com/api-docs/api-reference.html#_switch_account
      operationId: switchAccount
      parameters:
      - name: id
        in: query
        description: The account ID to switch, switch back to home ExtremeCloud IQ account if not provide
        required: false
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/XiqLoginResponse'
        default:
          $ref: '#/components/responses/ErrorResponse'
      security:
      - BearerAuth: []
  /account/viq:
    get:
      tags:
      - Account
      summary: Get VIQ Info
      description: Get account VIQ and license info.
      externalDocs:
        description: API Reference
        url: https://extremecloudiq.com/api-docs/api-reference.html#_get_viq_info
      operationId: getViqInfo
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/XiqViq'
        default:
          $ref: '#/components/responses/ErrorResponse'
      security:
      - BearerAuth: []
  /account/viq/:backup:
    post:
      tags:
      - Account
      summary: Backup VIQ
      description: Backup VIQ in ExtremeCloud IQ.
      externalDocs:
        description: API Reference
        url: https://extremecloudiq.com/api-docs/api-reference.html#_viq_backup
      operationId: backupViq
      responses:
        '200':
          description: OK
        default:
          $ref: '#/components/responses/ErrorResponse'
      security:
      - BearerAuth: []
  /account/viq/default-device-password:
    get:
      tags:
      - Account
      summary: Get the default device password in the account
      description: Get the default device password in the account.
      externalDocs:
        description: API Reference
        url: https://extremecloudiq.com/api-docs/api-reference.html#_get_default_device_password
      operationId: getDefaultDevicePassword
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/XiqDefaultDevicePassword'
        default:
          $ref: '#/components/responses/ErrorResponse'
      security:
      - BearerAuth: []
    put:
      tags:
      - Account
      summary: Update the default device password in the account
      description: Update the default device password in the global setting for accessing the console/shell of the devices.
      externalDocs:
        description: API Reference
        url: https://extremecloudiq.com/api-docs/api-reference.html#_update_default_device_password
      operationId: updateDefaultDevicePassword
      requestBody:
        description: The new default device password
        content:
          application/json:
            schema:
              type: string
        required: true
      responses:
        '200':
          description: OK
        default:
          $ref: '#/components/responses/ErrorResponse'
      security:
      - BearerAuth: []
  /v1/account/viq/default-device-password:
    put:
      tags:
      - Account
      summary: Update the default device password with validation
      description: Update the default device password in the global setting for accessing the console/shell of the devices.
      externalDocs:
        description: API Reference
        url: https://extremecloudiq.com/api-docs/api-reference.html#_update_default_device_password_with_validation
      operationId: updateDefaultDevicePasswordWithValidation
      requestBody:
        description: The new default device password
        content:
          application/json:
            schema:
              type: string
        required: true
      responses:
        '200':
          description: OK
        default:
          $ref: '#/components/responses/ErrorResponse'
      security:
      - BearerAuth: []
  /account/export:
    post:
      tags:
      - Account
      summary: Create VIQ export data
      description: Export VIQ reports.
      externalDocs:
        description: API Reference
        url: https://extremecloudiq.com/api-docs/api-reference.html#_viq_export_report
      operationId: viqExportReport
      parameters:
      - name: timeoutInSeconds
        in: query
        description: The maximum export duration
        required: false
        schema:
          type: integer
          format: int64
      - name: excludeDeviceFirmware
        in: query
        description: Whether exclude device firmwares from VIQ export file or not
        required: false
        schema:
          type: boolean
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/XiqViqExportReport'
        default:
          $ref: '#/components/responses/ErrorResponse'
      security:
      - BearerAuth: []
  /account/import:
    post:
      tags:
      - Account
      summary: Import VIQ details from a file
      description: Import Viq details.
      externalDocs:
        description: API Reference
        url: https://extremecloudiq.com/api-docs/api-reference.html#_viq_import
      operationId: viqImport
      requestBody:
        content:
          multipart/form-data:
            schema:
              required:
              - file
              type: object
              properties:
                file:
                  type: string
                  description: The import file to import VIQ data(.tar/.tar.gz)
                  format: binary
        required: true
      parameters:
      - name: timeoutInSeconds
        in: query
        description: The maximum import duration
        required: false
        schema:
          type: integer
          format: int64
      - name: resendUserNotifications
        in: query
        description: Resend Cloud PPSK/RADIUS password through email/SMS.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/XiqViqImportReport'
        default:
          $ref: '#/components/responses/ErrorResponse'
      security:
      - BearerAuth: []
  /account/download:
    get:
      tags:
      - Account
      summary: Download VIQ reports or logs
      description: Download VIQ exports reports and export or import logs.
      externalDocs:
        description: API Reference
        url: https://extremecloudiq.com/api-docs/api-reference.html#_viq_reports_download
      operationId: downloadViqReports
      parameters:
      - name: reportName
        in: query
        description: The name of the report
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/octet-stream:
              schema:
                type: string
                format: byte
        default:
          $ref: '#/components/responses/ErrorResponse'
      security:
      - BearerAuth: []
  /account/export-import-status:
    get:
      tags:
      - Account
      summary: Status of VIQ export/import operation
      description: Check the current VIQ export or import status.
      externalDocs:
        description: API Reference
        url: https://extremecloudiq.com/api-docs/api-reference.html#_viq_export_import_status
      operationId: exportImportStatus
      parameters:
      - name: reportName
        in: query
        description: The name of the report
        required: true
        schema:
          type: string
      - name: statusType
        in: query
        description: The operation type- export or import
        required: true
        schema:
          type: string
          items:
            $ref: '#/components/schemas/XiqViqStatusType'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/XiqViqExportImportResponse'
        default:
          $ref: '#/components/responses/ErrorResponse'
      security:
      - BearerAuth: []
  /account/viq/:reset:
    post:
      tags:
      - Account
      summary: Resetting VIQ
      description: Reset VIQ in ExtremeCloud IQ.
      externalDocs:
        description: API Reference
        url: https://extremecloudiq.com/api-docs/api-reference.html#_viq_reset
      operationId: resetViq
      responses:
        '200':
          description: OK
        default:
          $ref: '#/components/responses/ErrorResponse'
      security:
      - BearerAuth: []
  /account/vhm/setting:
    get:
      tags:
      - Account
      summary: Get Account VHM Setting
      description: Get Flag status of CoPilot, SSH Aavailibility, Supplemental CLI, AP Out-of-the-box Wireless Onboarding.
      externalDocs:
        description: API Reference
        url: https://extremecloudiq.com/api-docs/api-reference.html#_get_vhm_setting
      operationId: getVhmSetting
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/XiqVhmSettingInfo'
        default:
          $ref: '#/components/responses/ErrorResponse'
      security:
      - BearerAuth: []
  /account/vhm/setting/{id}:
    put:
      tags:
      - Account
      summary: Update Account VHM Setting
      description: Enable/Disable CoPilot, SSH Aavailibility, Supplemental CLI, AP Out-of-the-box Wireless Onboarding.
      externalDocs:
        description: API Reference
        url: https://extremecloudiq.com/api-docs/api-reference.html#_update_vhm_setting_by_id
      operationId: updateVhmSetting
      parameters:
      - $ref: '#/components/parameters/id'
      requestBody:
        description: The payload of the update Account VHM Setting.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/XiqUpdateVhmSettingRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/XiqVhmSetting'
        default:
          $ref: '#/components/responses/ErrorResponse'
      security:
      - BearerAuth: []
  /account/vhm/status:
    get:
      tags:
      - Account
      summary: Get Account VHM Status
      description: Check VHM Account status like vhm name, current run status.
      externalDocs:
        description: API Reference
        url: https://extremecloudiq.com/api-docs/api-reference.html#_get_vhm_status
      operationId: getVhmStatus
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/XiqVhmStatus'
        default:
          $ref: '#/components/responses/ErrorResponse'
      security:
      - BearerAuth: []
  /backup/history/grid:
    get:
      tags:
      - Account
      summary: Get Backup History Grid
      description: Get Backup History Grid to track and restore backed up database.
      externalDocs:
        description: API Reference
        url: https://extremecloudiq.com/api-docs/api-reference.html#_backup_history_grid
      operationId: backupGrid
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagedBackupGrid'
        default:
          $ref: '#/components/responses/ErrorResponse'
      security:
      - BearerAuth: []
  /backup/history/:restore:
    post:
      tags:
      - Account
      summary: Backup History Restore
      description: Restore Backup History in ExtremeCloud IQ.
      externalDocs:
        description: API Reference
        url: https://extremecloudiq.com/api-docs/api-reference.html#_backup_restore
      operationId: backupRestore
      parameters:
      - name: backup_file
        in: query
        description: The backup file that needs to be restored.
        required: true
        schema:
          type: string
      responses:
        '201':
          description: OK
        default:
          $ref: '#/components/responses/ErrorResponse'
      security:
      - BearerAuth: []
  /backup/history/delete:
    delete:
      tags:
      - Account
      summary: Backup History Delete
      description: Delete Backup History by backup files.
      externalDocs:
        description: API Reference
        url: https://extremecloudiq.com/api-docs/api-reference.html#_backup_history_delete
      operationId: backupDelete
      parameters:
      - name: backup_files
        in: query
        description: The list of backup files (comma-separated) that need to be deleted.
        required: true
        schema:
          type: array
          items:
            type: string
          example:
          - 24.5.0.28_1719393103615
          - 24.5.0.28_1719333999741
        style: form
        explode: false
      responses:
        '200':
          description: OK
        default:
          $ref: '#/components/responses/ErrorResponse'
      security:
      - BearerAuth: []
  /third/party/applications:
    get:
      tags:
      - Account
      summary: Get third party applications
      description: Get third party applications.
      externalDocs:
        description: API Reference
        url: https://extremecloudiq.com/api-docs/api-reference.html#_get_third_party_applications_by_owner_id
      operationId: getThirdPartyApplications
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/XiqThirdPartyApplications'
        default:
          $ref: '#/components/responses/ErrorResponse'
      security:
      - BearerAuth: []
  /users:
    get:
      tags:
      - User
      summary: List all users
      description: Lis

# --- truncated at 32 KB (1514 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/extreme-networks/refs/heads/main/openapi/extremecloud-iq-openapi.yml