Extreme Networks Copilot - Anomalies API

The Copilot Anomalies API

OpenAPI Specification

extreme-networks-copilot-anomalies-api-openapi.yml Raw ↑
openapi: 3.0.3
info:
  title: ExtremeCloud IQ Account Copilot - Anomalies API
  description: 'ExtremeCloud IQ™ API allows customers and partners to create solutions for the management, monitoring, and provisioning

    of any ExtremeCloud IQ™ environment.


    All related resources and documentation are available at [ExtremeCloud IQ Developer Portal](https://developer.extremecloudiq.com/).

    Please check [Get Started and Tutorial](https://developer.extremecloudiq.com/documentation/) to understand how to use the APIs.


    Get the [latest OpenAPI definition](https://github.com/extremenetworks/ExtremeCloudIQ-OpenAPI/blob/main/xcloudiq-openapi.yaml)

    from [ExtremeCloud IQ OpenAPI GitHub repository](https://github.com/extremenetworks/ExtremeCloudIQ-OpenAPI).


    Please have a valid [ExtremeCloud IQ](https://extremecloudiq.com/) account before getting started.

    If you don''t have one, please [register a new account](https://www.extremenetworks.com/cloud-networking/).'
  termsOfService: https://www.extremenetworks.com/company/legal/terms-of-use/
  contact:
    name: Extreme Networks Support
    url: https://www.extremenetworks.com/support
    email: support@extremenetworks.com
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
  version: 25.9.0-36
servers:
- url: https://api.extremecloudiq.com
  description: ExtremeCloud IQ REST API Server
tags:
- name: Copilot - Anomalies
  description: The Copilot Anomalies API
paths:
  /copilot/anomalies/poeflapping/stats:
    get:
      tags:
      - Copilot - Anomalies
      summary: Get POE Flapping Anomaly Device Stats
      description: Get all the stats for anomaly device.
      externalDocs:
        description: API Reference
        url: https://extremecloudiq.com/api-docs/api-reference.html#_get_copilot_anomaly_device_stats
      operationId: getCopilotAnomalyDeviceStats
      parameters:
      - $ref: '#/components/parameters/anomalyId'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/XiqCopilotPoeFlappingStats'
        default:
          $ref: '#/components/responses/ErrorResponse'
      security:
      - BearerAuth: []
  /copilot/anomalies/port-efficiency/stats:
    get:
      tags:
      - Copilot - Anomalies
      summary: Get PortEfficiency Device Stats
      description: Get all the stats for PortEfficiency device.
      externalDocs:
        description: API Reference
        url: https://extremecloudiq.com/api-docs/api-reference.html#_get_copilot_portefficiency_device_stats
      operationId: getCopilotPortEfficiencyDeviceStats
      parameters:
      - $ref: '#/components/parameters/anomalyId'
      - $ref: '#/components/parameters/offsetTime'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/XiqCopilotPortEfficiencyStats'
        default:
          $ref: '#/components/responses/ErrorResponse'
      security:
      - BearerAuth: []
  /copilot/anomalies/port-efficiency/speed-duplex-stats:
    get:
      tags:
      - Copilot - Anomalies
      summary: Get PortEfficiency Device Speed and Duplex Stats
      description: Get all the speed and duplex for PortEfficiency device.
      externalDocs:
        description: API Reference
        url: https://extremecloudiq.com/api-docs/api-reference.html#_get_copilot_portefficiency_device_speed_duplex
      operationId: getCopilotPortEfficiencyDeviceSpeedDuplex
      parameters:
      - $ref: '#/components/parameters/anomalyId'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/XiqCopilotPortEfficiencySpeedDuplex'
        default:
          $ref: '#/components/responses/ErrorResponse'
      security:
      - BearerAuth: []
  /copilot/anomalies/dfs-recurrence/count-stats:
    get:
      tags:
      - Copilot - Anomalies
      summary: Get DFSRecurrence Device Channel Count Stats
      description: Get DFS Recurrence anomaly radar event count stats.
      externalDocs:
        description: API Reference
        url: https://extremecloudiq.com/api-docs/api-reference.html#_get_copilot_dfsrecurrence_countstats
      operationId: getCopilotDfsRecurrenceCountStats
      parameters:
      - $ref: '#/components/parameters/anomalyId'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/XiqCopilotDfsRecurrenceCountStats'
        default:
          $ref: '#/components/responses/ErrorResponse'
      security:
      - BearerAuth: []
  /copilot/anomalies/dfs-recurrence/channel-stats:
    get:
      tags:
      - Copilot - Anomalies
      summary: Get DFSRecurrence Device Channel Change Stats
      description: Get DFS Recurrence anomaly device channel change stats.
      externalDocs:
        description: API Reference
        url: https://extremecloudiq.com/api-docs/api-reference.html#_get_copilot_dfsrecurrence_channelstats
      operationId: getCopilotDfsRecurrenceChannelStats
      parameters:
      - $ref: '#/components/parameters/anomalyId'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/XiqCopilotDFSRecurrenceChannelStats'
        default:
          $ref: '#/components/responses/ErrorResponse'
      security:
      - BearerAuth: []
  /copilot/anomalies/adverse-traffic/device-stats:
    get:
      tags:
      - Copilot - Anomalies
      summary: Get Adverse Traffic Pattern Anomaly Device Stats
      description: Get all the stats for anomaly device.
      externalDocs:
        description: API Reference
        url: https://extremecloudiq.com/api-docs/api-reference.html#_get_copilot_anomaly_adverse-traffic_device-stats
      operationId: getCopilotAnomalyAtpDeviceStats
      parameters:
      - $ref: '#/components/parameters/anomalyId'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/XiqCopilotATPDeviceStats'
        default:
          $ref: '#/components/responses/ErrorResponse'
      security:
      - BearerAuth: []
  /copilot/anomalies/adverse-traffic/packet-counts:
    get:
      tags:
      - Copilot - Anomalies
      summary: Get Adverse Traffic Pattern Anomaly Packet Counts
      description: Get all the stats for anomaly device.
      externalDocs:
        description: API Reference
        url: https://extremecloudiq.com/api-docs/api-reference.html#_get_copilot_anomaly_adverse-traffic_packet-counts
      operationId: getCopilotAnomalyAtpPacketCounts
      parameters:
      - $ref: '#/components/parameters/anomalyId'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/XiqCopilotATPPacketCounts'
        default:
          $ref: '#/components/responses/ErrorResponse'
      security:
      - BearerAuth: []
  /copilot/anomalies/wifi-efficiency/stats:
    get:
      tags:
      - Copilot - Anomalies
      summary: Get WifiEfficiency Device Stats
      description: Get all the stats for WifiEfficiency device.
      externalDocs:
        description: API Reference
        url: https://extremecloudiq.com/api-docs/api-reference.html#_get_copilot_wifiefficiency_stats
      operationId: getCopilotWifiEfficiencyStats
      parameters:
      - $ref: '#/components/parameters/anomalyId'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/XiqCopilotWifiEfficiencyStats'
        default:
          $ref: '#/components/responses/ErrorResponse'
      security:
      - BearerAuth: []
  /copilot/anomalies/wifi-efficiency/client-list:
    get:
      tags:
      - Copilot - Anomalies
      summary: Get WifiEfficiency contributing client list
      description: Get all the client list for WifiEfficiency device.
      externalDocs:
        description: API Reference
        url: https://extremecloudiq.com/api-docs/api-reference.html#_get_copilot_wifiefficiency_client-list
      operationId: getCopilotWifiEfficiencyClientlist
      parameters:
      - $ref: '#/components/parameters/deviceId'
      - $ref: '#/components/parameters/channelNumber'
      - $ref: '#/components/parameters/timestamp1'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/XiqCopilotWifiEfficiencyClientlist'
        default:
          $ref: '#/components/responses/ErrorResponse'
      security:
      - BearerAuth: []
  /copilot/anomalies/wifi-capacity/stats:
    get:
      tags:
      - Copilot - Anomalies
      summary: Get WifiCapacity Device Stats
      description: Get all the stats for WifiCapacity device.
      externalDocs:
        description: API Reference
        url: https://extremecloudiq.com/api-docs/api-reference.html#_get_copilot_wificapacity_stats
      operationId: getCopilotWifiCapacityStats
      parameters:
      - $ref: '#/components/parameters/anomalyId'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/XiqCopilotWifiCapacityStats'
        default:
          $ref: '#/components/responses/ErrorResponse'
      security:
      - BearerAuth: []
  /copilot/anomalies/wifi-capacity/client-list:
    get:
      tags:
      - Copilot - Anomalies
      summary: Get WifiCapacity contributing client list
      description: Get all the client list for WifiCapacity device.
      externalDocs:
        description: API Reference
        url: https://extremecloudiq.com/api-docs/api-reference.html#_get_copilot_wificapacity_client-list
      operationId: getCopilotWifiCapacityClientList
      parameters:
      - $ref: '#/components/parameters/deviceId'
      - $ref: '#/components/parameters/channelNumber'
      - $ref: '#/components/parameters/timestamp1'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/XiqCopilotWifiCapacityClientlist'
        default:
          $ref: '#/components/responses/ErrorResponse'
      security:
      - BearerAuth: []
  /copilot/assurance-scans/overview:
    get:
      tags:
      - Copilot - Anomalies
      summary: Get AssuranceScans for all anomaly devices
      description: Get all assuranceScans data for a given location.
      externalDocs:
        description: API Reference
        url: https://extremecloudiq.com/api-docs/api-reference.html#_get_copilot_assurancescans_overview
      operationId: getCopilotAssuranceScansOverview
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/XiqCopilotAssuranceScansOverview'
        default:
          $ref: '#/components/responses/ErrorResponse'
      security:
      - BearerAuth: []
  /copilot/anomalies/devices/feedback:
    put:
      tags:
      - Copilot - Anomalies
      summary: Update Anomalies Feedback
      description: Update and save Anomaly Feedback.
      externalDocs:
        description: API Reference
        url: https://extremecloudiq.com/api-docs/api-reference.html#_put_copilot_anomaly_devices_feedback
      operationId: putCopilotAnomalyDevicesFeedback
      requestBody:
        description: The body of update feedback
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/XiqAnomaliesFeedbackRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/XiqCopilotAnomaliesSuccess'
        default:
          $ref: '#/components/responses/ErrorResponse'
      security:
      - BearerAuth: []
  /copilot/anomalies/anomalies-by-category:
    get:
      tags:
      - Copilot - Anomalies
      summary: Get Anomalies by Categories
      description: Get all anomalies for a given viewType.
      externalDocs:
        description: API Reference
        url: https://extremecloudiq.com/api-docs/api-reference.html#_get_copilot_anomaly_anomalies-by-category
      operationId: getCopilotAnomaliesbyCategory
      parameters:
      - $ref: '#/components/parameters/startTime1'
      - $ref: '#/components/parameters/endTime1'
      - $ref: '#/components/parameters/buildingId'
      - $ref: '#/components/parameters/severity'
      - $ref: '#/components/parameters/anomalyType'
      - $ref: '#/components/parameters/muted'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/XiqCopilotAnomaliesByCategory'
        default:
          $ref: '#/components/responses/ErrorResponse'
      security:
      - BearerAuth: []
  /copilot/anomalies/devices-with-locations:
    get:
      tags:
      - Copilot - Anomalies
      summary: Devices with Locations
      description: Get all devices for all the anomalies and locations.
      externalDocs:
        description: API Reference
        url: https://extremecloudiq.com/api-docs/api-reference.html#_get_copilot_anomaly_devices_with_locations
      operationId: getCopilotDevicesWithLocations
      parameters:
      - $ref: '#/components/parameters/startTime1'
      - $ref: '#/components/parameters/endTime1'
      - $ref: '#/components/parameters/buildingId'
      - $ref: '#/components/parameters/severity'
      - $ref: '#/components/parameters/anomalyType'
      - $ref: '#/components/parameters/muted'
      - $ref: '#/components/parameters/sortField1'
      - $ref: '#/components/parameters/sortOrder'
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/searchKey'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/XiqCopilotAnomaliesDevicesWithLocation'
        default:
          $ref: '#/components/responses/ErrorResponse'
      security:
      - BearerAuth: []
  /copilot/anomalies/update-device-action:
    put:
      tags:
      - Copilot - Anomalies
      summary: Update Devices Action
      description: Update & save action for Anomaly devices.
      externalDocs:
        description: API Reference
        url: https://extremecloudiq.com/api-docs/api-reference.html#update_copilot_anomalies_devices_action
      operationId: updateCopilotAnomaliesDevicesAction
      parameters:
      - $ref: '#/components/parameters/async'
      requestBody:
        description: The body of update devices
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/XiqUpdateAnomaliesAndDevicesRequest'
        required: true
      responses:
        '200':
          description: OK
        default:
          $ref: '#/components/responses/ErrorResponse'
      security:
      - BearerAuth: []
  /copilot/anomalies/report:
    get:
      tags:
      - Copilot - Anomalies
      summary: Download Anomalies Report
      description: Download all devices and locations for all the anomalies.
      externalDocs:
        description: API Reference
        url: https://extremecloudiq.com/api-docs/api-reference.html#_get_copilot_anomaly_download_report
      operationId: getAnomaliesReport
      parameters:
      - $ref: '#/components/parameters/startTime1'
      - $ref: '#/components/parameters/endTime1'
      - $ref: '#/components/parameters/buildingId'
      - $ref: '#/components/parameters/severity'
      - $ref: '#/components/parameters/anomalyType'
      - $ref: '#/components/parameters/muted'
      - $ref: '#/components/parameters/sortField1'
      - $ref: '#/components/parameters/sortOrder'
      - $ref: '#/components/parameters/searchKey'
      - $ref: '#/components/parameters/fileType'
      - $ref: '#/components/parameters/offsetTime'
      responses:
        '200':
          description: OK
          content:
            text/csv:
              schema:
                $ref: '#/components/schemas/XiqCopilotAnomaliesReport'
            application/pdf:
              schema:
                $ref: '#/components/schemas/XiqCopilotAnomaliesReport'
        default:
          $ref: '#/components/responses/ErrorResponse'
      security:
      - BearerAuth: []
  /copilot/anomalies/poeflapping/trends:
    get:
      tags:
      - Copilot - Anomalies
      summary: Get POE Flapping Anomaly Device Power Mode Trends
      description: Get all the poe trends for anomalous device.
      externalDocs:
        description: API Reference
        url: https://extremecloudiq.com/api-docs/api-reference.html#_get_copilot_anomaly_poe-flapping_trends
      operationId: getPoeFlappingTrends
      parameters:
      - $ref: '#/components/parameters/anomalyId'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/XiqPoeTrendGraphsResponse'
        default:
          $ref: '#/components/responses/ErrorResponse'
      security:
      - BearerAuth: []
  /copilot/anomalies/poeflapping/lldp-cdp-info:
    get:
      tags:
      - Copilot - Anomalies
      summary: Get anomalous device lldp cdp Info details
      description: Get LLDP-CDP information and location details for anomalous devices.
      externalDocs:
        description: API Reference
        url: https://extremecloudiq.com/api-docs/api-reference.html#_get_copilot_anomaly_poe-flapping_lldp-cdp-info
      operationId: getLldpCdpInfo
      parameters:
      - $ref: '#/components/parameters/anomalyId'
      - $ref: '#/components/parameters/deviceId'
      - $ref: '#/components/parameters/lastDetectedTime'
      - $ref: '#/components/parameters/anomalyType'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/XiqCopilotLldpCdpInfo'
        default:
          $ref: '#/components/responses/ErrorResponse'
      security:
      - BearerAuth: []
  /copilot/anomalies/excluded-vlans-list:
    get:
      tags:
      - Copilot - Anomalies
      summary: Get Excluded Vlan List
      description: Get Excluded vlans details with Site details.
      externalDocs:
        description: API Reference
        url: https://extremecloudiq.com/api-docs/api-reference.html#_get_exceptional_vlan_list
      operationId: getCopilotExceptionalVlanList
      parameters:
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/limit'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/XiqCopilotExceptionalVlanList'
        default:
          $ref: '#/components/responses/ErrorResponse'
      security:
      - BearerAuth: []
  /copilot/anomalies/exclude-vlans:
    post:
      tags:
      - Copilot - Anomalies
      summary: Excluding Vlan from Sites
      description: Add, Update, Delete excluded vlan from sites.
      operationId: excludeSitesVlan
      externalDocs:
        description: API Reference
        url: https://extremecloudiq.com/api-docs/api-reference.html#_exclude_sites_vlan
      requestBody:
        description: Excluding vlan from sites request body
        content:
          multipart/json:
            schema:
              type: object
              required:
              - excludeSitesVlanRequest
              - old_vlan_id
              - action_type
              - dismiss
              properties:
                excludeSitesVlanRequest:
                  type: object
                  description: excluded sites vlan details.
                  required:
                  - excluded_vlan_details
                  properties:
                    excluded_vlan_details:
                      type: array
                      items:
                        $ref: '#/components/schemas/XiqCopilotVlanDetailsEntity'
                old_vlan_id:
                  type: integer
                  format: int32
                action_type:
                  $ref: '#/components/schemas/XiqCopilotActionType'
                dismiss:
                  type: boolean
      responses:
        '200':
          description: OK
        default:
          $ref: '#/components/responses/ErrorResponse'
      security:
      - BearerAuth: []
  /copilot/anomalies/exclude-vlans-csv:
    post:
      tags:
      - Copilot - Anomalies
      summary: Excluding Vlan from Sites - CSV
      description: Add excluded vlan from sites using CSV.
      operationId: excludeSitesVlanCsv
      externalDocs:
        description: API Reference
        url: https://extremecloudiq.com/api-docs/api-reference.html#_exclude_sites_vlan_csv
      parameters:
      - name: action_type
        in: query
        description: The type of action to perform (add)
        required: true
        schema:
          $ref: '#/components/schemas/XiqCopilotActionType'
      - name: dismiss
        in: query
        description: Whether to dismiss the action after execution
        required: true
        schema:
          type: boolean
      requestBody:
        description: Excluding vlan from sites request body using CSV
        content:
          multipart/form-data:
            schema:
              type: object
              required:
              - csv_file
              properties:
                csv_file:
                  type: string
                  format: binary
      responses:
        '200':
          description: OK
        default:
          $ref: '#/components/responses/ErrorResponse'
      security:
      - BearerAuth: []
  /copilot/anomalies/missing-vlan/count:
    get:
      tags:
      - Copilot - Anomalies
      summary: Get MissingVlan Anomalies Count
      description: MissingVlan anomaly count for specified vlanIds and siteIds.
      externalDocs:
        description: API Reference
        url: https://extremecloudiq.com/api-docs/api-reference.html#_get_copilot_anomaly_missing-vlan_count
      operationId: getCopilotAnomalyMissingVlanCount
      parameters:
      - $ref: '#/components/parameters/startTimeCount'
      - $ref: '#/components/parameters/endTimeCount'
      - $ref: '#/components/parameters/vlanIds'
      - $ref: '#/components/parameters/siteIds'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/XiqCopilotMissingVlanCount'
        default:
          $ref: '#/components/responses/ErrorResponse'
      security:
      - BearerAuth: []
  /copilot/anomalies/hardware-health/stats:
    get:
      tags:
      - Copilot - Anomalies
      summary: Get HardwareHealth Anomaly Stats
      description: Get all the stats for anomaly device.
      externalDocs:
        description: API Reference
        url: https://extremecloudiq.com/api-docs/api-reference.html#_get_copilot_anomaly_hardware-health_stats
      operationId: getCopilotAnomalyHardwareHealthStats
      parameters:
      - $ref: '#/components/parameters/anomalyId'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/XiqCopilotHardwareHealthStats'
        default:
          $ref: '#/components/responses/ErrorResponse'
      security:
      - BearerAuth: []
  /copilot/anomalies/hardware-health/client-list:
    get:
      tags:
      - Copilot - Anomalies
      summary: Get HardwareHealth contributing client list
      description: Get all the client list for HardwareHealth device.
      externalDocs:
        description: API Reference
        url: https://extremecloudiq.com/api-docs/api-reference.html#_get_copilot_hardware-health_client-list
      operationId: getCopilotHardwareHealthClientList
      parameters:
      - $ref: '#/components/parameters/deviceId'
      - $ref: '#/components/parameters/timestamp1'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/XiqCopilotHardwareHealthClientlist'
        default:
          $ref: '#/components/responses/ErrorResponse'
      security:
      - BearerAuth: []
  /copilot/anomalies/hardware-health/cpu-mem-stats:
    get:
      tags:
      - Copilot - Anomalies
      summary: Get HardwareHealth CPU & Memory Stats
      description: Get CPU or memory details for HardwareHealth device.
      externalDocs:
        description: API Reference
        url: https://extremecloudiq.com/api-docs/api-reference.html#_get_copilot_hardware-health_cpu_mem_stats
      operationId: getCopilotHardwareHealthCpuMemStats
      parameters:
      - $ref: '#/components/parameters/deviceId'
      - $ref: '#/components/parameters/hhStatsFieldType'
      - $ref: '#/components/parameters/timestamp1'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/XiqCopilotHardwareHealthCpuMemStats'
        default:
          $ref: '#/components/responses/ErrorResponse'
      security:
      - BearerAuth: []
components:
  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
    async:
      in: query
      name: async
      description: Whether to enable async mode
      required: false
      schema:
        type: boolean
        default: false
    anomalyId:
      in: query
      description: The anomaly id
      name: anomalyId
      required: true
      schema:
        type: string
    sortOrder:
      name: sortOrder
      in: query
      description: The sort order (ascending by default)
      required: false
      schema:
        $ref: '#/components/schemas/XiqSortOrder'
    deviceId:
      in: query
      description: The device id
      name: deviceId
      required: true
      schema:
        type: integer
        format: int64
    buildingId:
      in: query
      description: The building id
      name: buildingId
      required: false
      schema:
        type: integer
        format: int64
    vlanIds:
      in: query
      description: The vlan ids
      name: vlanIds
      required: true
      schema:
        type: array
        description: The vlan Ids
        items:
          type: integer
          format: int64
    offsetTime:
      in: query
      description: The offset value
      name: offsetTime
      required: true
      schema:
        type: integer
        format: int32
    endTimeCount:
      in: query
      name: endTime
      description: The End time
      required: true
      schema:
        type: integer
        format: int64
    endTime1:
      in: query
      description: The end time
      name: endTime
      required: false
      schema:
        type: integer
        format: int64
    hhStatsFieldType:
      name: hhStatsFieldType
      in: query
      description: The Hardware Health anomaly CPU or Memory Stats type
      required: true
      schema:
        $ref: '#/components/schemas/XiqAnomalyHhStatsType'
    lastDetectedTime:
      in: query
      description: The last detected time
      name: lastDetectedTime
      required: false
      schema:
        type: integer
        format: int64
    fileType:
      name: fileType
      in: query
      description: The file type
      required: false
      schema:
        type: string
    sortField1:
      name: sortField
      in: query
      description: The sort field
      required: false
      schema:
        type: string
        enum:
        - DEVICE_NAME
        - SEVERITY
        - LOCATION
        - CATEGORY
        - ANOMALY_TYPE
        - TIME
    siteIds:
      in: query
      description: The site ids
      name: siteIds
      required: true
      schema:
        type: array
        description: The site Ids
        items:
          type: integer
          format: int64
    muted:
      in: query
      name: excludeMuted
      description: To filter muted anomalies
      required: false
      schema:
        type: boolean
        default: false
    timestamp1:
      in: query
      description: The timestamp
      name: timestamp
      required: true
      schema:
        type: integer
        format: int64
    anomalyType:
      name: anomalyType
      in: query
      description: The anomaly type
      required: false
      schema:
        $ref: '#/components/schemas/XiqAnomalyType'
    startTime1:
      in: query
      description: The start time
      name: startTime
      required: false
      schema:
        type: integer
        format: int64
    searchKey:
      in: query
      description: The search key
      name: searchKey
      required: false
      schema:
        type: string
    startTimeCount:
      in: query
      name: startTime
      description: The Start time
      required: true
      schema:
        type: integer
        format: int64
    severity:
      name: severity
      in: query
      description: The anomaly severity
      required: false
      schema:
        $ref: '#/components/schemas/XiqAnomalySeverity'
    channelNumber:
      in: query
      description: The channel number
      name: channel
      required: true
      schema:
        type: integer
        format: int32
  schemas:
    XiqHardwareHealthClientStatsEntity:
      type: object
      description: data sequence
      required:
      - client_mac
      - client_name
      - client_host_os
      - avg_snr
      - health_score
      - client_id
      properties:
        client_mac:
          type: string
        client_name:
          type: string
        client_host_os:
          type: string
        avg_snr:
          type: integer
        health_score:
          type: array
          description: The health score type
          items:
            $ref: '#/components/schemas/HealthScoreType'
        client_id:
          type: integer
          format: int64
    XiqPoeTrendGraphsResponse:
      type: object
      properties:
        trend_graph_entities:
          type: array
          description: The data in the current page
          items:
            $ref: '#/components/schemas/XiqTrendGraphEntity'
    XiqUnaffectedDownlinkDevice:
      type: object
      description: Copilot Anomaly Unaffected Downlink Devices Details
      required:
      - host_name
      - product_type
      - interface_name
      - port_id
      properties:
        host_name:
          type: string
          description: host name of unaffected downlink device
        product_type:
          type: string
          description: model of unaffected downlink device
        interface_name:
          type: string
          description: interface name of unaffected downlink device
        port_id:
          type: string
          description: port ID of unaffected downlink device
    XiqCopilotLldpCdpInfo:
      type: object
      description: Copilot Anomalies LLdp-Cdp Info Response
      properties:
        lldp_cdp_info:
          type: object
          description: The data in the current page
          $ref: '#/components/schemas/XiqPowerSourceEquipment'
    XiqHardwareHealthPacketCountsEntity:
      type: object
      description: data sequence
      required:
      - timestamp
      - unicast_tx
      - unicast_rx
      - multicast_tx
      - multicast_rx
      - broadcast_tx
      - broadcast_rx
      - throughput
      properties:
        timestamp:
          type: integer
          format: int64
        unicas

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