diff --git a/xcloudiq-openapi.yaml b/xcloudiq-openapi.yaml
index 79c557c..b727d69 100644
--- a/xcloudiq-openapi.yaml
+++ b/xcloudiq-openapi.yaml
@@ -21,7 +21,7 @@ info:
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0.html
- version: 23.6.0.46
+ version: 23.7.1.1
servers:
- url: https://api.extremecloudiq.com
description: ExtremeCloud IQ REST API Server
@@ -77,6 +77,8 @@ tags:
description: Packet capture sessions in ExtremeCloud IQ
- name: Essentials - ExtremeLocation
description: The ExtremeLocation and Analytics API
+- name: Misc
+ description: Metadata - Country/...
paths:
/login:
post:
@@ -1049,7 +1051,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/XiqCreateLocationRequest'
+ $ref: '#/components/schemas/ClsCreateLocationRequest'
required: true
responses:
'200':
@@ -1057,7 +1059,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/XiqLocation'
+ $ref: '#/components/schemas/ClsLocation'
default:
$ref: '#/components/responses/ErrorResponse'
security:
@@ -1097,7 +1099,7 @@ paths:
schema:
type: array
items:
- $ref: '#/components/schemas/XiqLocation'
+ $ref: '#/components/schemas/ClsLocation'
default:
$ref: '#/components/responses/ErrorResponse'
security:
@@ -1137,7 +1139,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PagedXiqLocationTreeDevice'
+ $ref: '#/components/schemas/PagedClsLocationTreeDevice'
default:
$ref: '#/components/responses/ErrorResponse'
security:
@@ -1177,7 +1179,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PagedXiqLocationTreeMap'
+ $ref: '#/components/schemas/PagedClsLocationTreeMap'
default:
$ref: '#/components/responses/ErrorResponse'
security:
@@ -1202,7 +1204,7 @@ paths:
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."
+ description: "The floorplan image file to upload. \n For better performance, Extreme Networks recommends that the image file (.png .jpeg) be less than 10 MB."
format: binary
required: true
responses:
@@ -1229,7 +1231,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/XiqUpdateLocationRequest'
+ $ref: '#/components/schemas/ClsUpdateLocationRequest'
required: true
responses:
'200':
@@ -1237,7 +1239,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/XiqLocation'
+ $ref: '#/components/schemas/ClsLocation'
default:
$ref: '#/components/responses/ErrorResponse'
security:
@@ -1279,7 +1281,7 @@ paths:
description: Get floor location without tree.
externalDocs:
description: API Reference
- url: https://extremecloudiq.com/api-docs/api-reference.html#_get_location_floor
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_list_floors
operationId: getFloors
parameters:
- $ref: '#/components/parameters/page'
@@ -1298,7 +1300,7 @@ paths:
schema:
type: array
items:
- $ref: '#/components/schemas/XiqFloor'
+ $ref: '#/components/schemas/ClsFloor'
default:
$ref: '#/components/responses/ErrorResponse'
security:
@@ -1317,7 +1319,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/XiqCreateFloorRequest'
+ $ref: '#/components/schemas/ClsCreateFloorRequest'
required: true
responses:
'200':
@@ -1325,7 +1327,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/XiqFloor'
+ $ref: '#/components/schemas/ClsFloor'
default:
$ref: '#/components/responses/ErrorResponse'
security:
@@ -1347,7 +1349,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/XiqUpdateFloorRequest'
+ $ref: '#/components/schemas/ClsUpdateFloorRequest'
required: true
responses:
'200':
@@ -1355,7 +1357,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/XiqFloor'
+ $ref: '#/components/schemas/ClsFloor'
default:
$ref: '#/components/responses/ErrorResponse'
security:
@@ -1386,7 +1388,7 @@ paths:
description: Get building location without tree.
externalDocs:
description: API Reference
- url: https://extremecloudiq.com/api-docs/api-reference.html#_get_location_building
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_list_buildings
operationId: getBuildings
parameters:
- $ref: '#/components/parameters/page'
@@ -1405,7 +1407,7 @@ paths:
schema:
type: array
items:
- $ref: '#/components/schemas/XiqBuilding'
+ $ref: '#/components/schemas/ClsBuilding'
default:
$ref: '#/components/responses/ErrorResponse'
security:
@@ -1424,7 +1426,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/XiqCreateBuildingRequest'
+ $ref: '#/components/schemas/ClsCreateBuildingRequest'
required: true
responses:
'200':
@@ -1432,7 +1434,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/XiqBuilding'
+ $ref: '#/components/schemas/ClsBuilding'
default:
$ref: '#/components/responses/ErrorResponse'
security:
@@ -1454,7 +1456,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/XiqUpdateBuildingRequest'
+ $ref: '#/components/schemas/ClsUpdateBuildingRequest'
required: true
responses:
'200':
@@ -1462,7 +1464,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/XiqBuilding'
+ $ref: '#/components/schemas/ClsBuilding'
default:
$ref: '#/components/responses/ErrorResponse'
security:
@@ -1496,11 +1498,11 @@ paths:
get:
tags:
- Location
- summary: Get site location
- description: Get site location without tree.
+ summary: Get a list of site location
+ description: Get list of site location without tree.
externalDocs:
description: API Reference
- url: https://extremecloudiq.com/api-docs/api-reference.html#_get_location_site
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_list_sites
operationId: getSites
parameters:
- $ref: '#/components/parameters/page'
@@ -1519,7 +1521,7 @@ paths:
schema:
type: array
items:
- $ref: '#/components/schemas/XiqSite'
+ $ref: '#/components/schemas/ClsSite'
default:
$ref: '#/components/responses/ErrorResponse'
security:
@@ -1538,7 +1540,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/XiqCreateSiteRequest'
+ $ref: '#/components/schemas/ClsCreateSiteRequest'
required: true
responses:
'200':
@@ -1546,12 +1548,34 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/XiqSite'
+ $ref: '#/components/schemas/ClsSite'
default:
$ref: '#/components/responses/ErrorResponse'
security:
- BearerAuth: []
/locations/site/{id}:
+ get:
+ tags:
+ - Location
+ summary: Get site by ID
+ description: Get the site for the specified ID.
+ externalDocs:
+ description: API Reference
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_get_site
+ operationId: getSite
+ parameters:
+ - $ref: '#/components/parameters/id'
+ responses:
+ '200':
+ description: OK
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ClsSite'
+ default:
+ $ref: '#/components/responses/ErrorResponse'
+ security:
+ - BearerAuth: []
put:
tags:
- Location
@@ -1568,7 +1592,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/XiqUpdateSiteRequest'
+ $ref: '#/components/schemas/ClsUpdateSiteRequest'
required: true
responses:
'200':
@@ -1576,7 +1600,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/XiqSite'
+ $ref: '#/components/schemas/ClsSite'
default:
$ref: '#/components/responses/ErrorResponse'
security:
@@ -2791,6 +2815,61 @@ paths:
$ref: '#/components/responses/ErrorResponse'
security:
- BearerAuth: []
+ /devices/radio-information:
+ get:
+ tags:
+ - Device
+ summary: List radio information
+ description: List radio and BSS information associated to a device.
+ externalDocs:
+ description: API Reference
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_get_list_devices_radio_information
+ operationId: listDevicesRadioInformation
+ parameters:
+ - $ref: '#/components/parameters/page'
+ - $ref: '#/components/parameters/limit'
+ - $ref: '#/components/parameters/deviceIds'
+ responses:
+ '200':
+ description: OK
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/PagedXiqRadioEntity'
+ default:
+ $ref: '#/components/responses/ErrorResponse'
+ security:
+ - BearerAuth: []
+ /devices/{id}/gallery-image:
+ get:
+ tags:
+ - Device
+ summary: Download device gallery image
+ description: Download the image file from the device media gallery.
+ externalDocs:
+ description: API Reference
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_download_device_gallery_image
+ operationId: downloadDeviceGalleryImage
+ parameters:
+ - $ref: '#/components/parameters/id'
+ - name: imageName
+ in: query
+ description: The image name
+ required: true
+ schema:
+ type: string
+ responses:
+ '200':
+ description: OK
+ content:
+ application/octet-stream:
+ schema:
+ format: binary
+ type: string
+ default:
+ $ref: '#/components/responses/ErrorResponse'
+ security:
+ - BearerAuth: []
/network-policies:
get:
tags:
@@ -3073,6 +3152,14 @@ paths:
required: false
schema:
type: boolean
+ - name: userNames
+ in: query
+ description: The user names.
+ required: false
+ schema:
+ type: array
+ items:
+ type: string
- name: searchString
in: query
description: The SearchString
@@ -3519,27 +3606,21 @@ paths:
- $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
+ - $ref: '#/components/parameters/acknowledged'
+ - $ref: '#/components/parameters/categoryIds'
+ - $ref: '#/components/parameters/severityIds'
+ - $ref: '#/components/parameters/messageMetadataIds'
+ - $ref: '#/components/parameters/siteId'
+ - name: sortField
in: query
- description: The alert type to filter
+ description: The sort field
required: false
schema:
- type: string
+ $ref: '#/components/schemas/XiqAlertSortField'
+ - $ref: '#/components/parameters/order'
- name: keyword
in: query
- description: The keyword to filter, such as device SN or MAC address
+ description: The keyword to filter, such as summery, severity, source and etc.
required: false
schema:
type: string
@@ -3554,128 +3635,77 @@ paths:
$ref: '#/components/responses/ErrorResponse'
security:
- BearerAuth: []
- /alerts/count-by-{group}:
- get:
+ /alerts/:acknowledge:
+ post:
tags:
- Alert
- summary: Count the alerts by different grouping
- description: Count the number of alerts and events based on Severity, Category, and Alert Type.
+ summary: Acknowledge the alerts
+ description: Acknowledge the alerts by ID list.
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'
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_acknowledge_the_alerts
+ operationId: acknowledgeAlerts
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/alertIds'
responses:
'200':
description: OK
- content:
- application/json:
- schema:
- type: object
- additionalProperties:
- type: integer
- format: int64
default:
$ref: '#/components/responses/ErrorResponse'
security:
- BearerAuth: []
- /logs/audit:
+ /alerts/count-by-{group}:
get:
tags:
- - Log
- summary: List audit logs
- description: List a page of audit logs.
+ - 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#_list_audit_log
- operationId: listAuditLogs
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_count_the_alerts_by_group
+ operationId: countAlertsByGroup
parameters:
- - $ref: '#/components/parameters/page'
- - $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/startTime'
- - name: categories
- in: query
- description: Audit category
- required: false
- schema:
- type: array
- items:
- $ref: '#/components/schemas/XiqAuditLogCategory'
- - name: username
- in: query
- description: The user login name
- required: false
- schema:
- type: string
- - name: endTime
- in: query
- description: 'The end time to query, epoch time in milliseconds since 1/1/1970. Note: endTime - startTime must be no greater than 2592000000 (30 days)'
- required: true
- schema:
- type: integer
- format: int64
- - name: keyword
- in: query
- description: The case-insensitive keyword to search in description
- required: false
- schema:
- type: string
- - name: sortField
- in: query
- description: The field for sorting
- required: false
- schema:
- $ref: '#/components/schemas/XiqAuditLogSortField'
- - $ref: '#/components/parameters/order'
+ - $ref: '#/components/parameters/endTime'
+ - $ref: '#/components/parameters/group'
+ - $ref: '#/components/parameters/acknowledged'
+ - $ref: '#/components/parameters/siteId'
responses:
'200':
description: OK
content:
application/json:
schema:
- $ref: '#/components/schemas/PagedXiqAuditLog'
+ type: array
+ items:
+ $ref: '#/components/schemas/XiqAlertGroupCount'
default:
$ref: '#/components/responses/ErrorResponse'
security:
- BearerAuth: []
- /logs/audit/reports:
+ /alerts/reports:
post:
tags:
- - Log
- summary: Create audit logs report
- description: Creates a report page of audit logs.
+ - Alert
+ summary: '[LRO] Create alert event report'
+ description: Creates a report page of alert event. This API can be run at async mode, please follow the Long-Running Operation (LRO) guide to track the progress and the result.
externalDocs:
description: API Reference
- url: https://extremecloudiq.com/api-docs/api-reference.html#_audit_log_report
- operationId: createAuditLogReport
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_create_an_alert_report
+ operationId: createAlertReport
parameters:
- - name: categories
- in: query
- description: Audit category
- required: false
- schema:
- type: array
- items:
- $ref: '#/components/schemas/XiqAuditLogCategory'
- - name: username
- in: query
- description: The user login name
- required: false
- schema:
- type: string
- - name: startTime
- in: query
- description: The start time to query, epoch time in milliseconds since 1/1/1970, default is 0 if not specified or is negative
- required: false
- schema:
- type: integer
- format: int64
- - name: endTime
+ - $ref: '#/components/parameters/startTime'
+ - $ref: '#/components/parameters/endTime'
+ - $ref: '#/components/parameters/acknowledged'
+ - $ref: '#/components/parameters/categoryIds'
+ - $ref: '#/components/parameters/severityIds'
+ - $ref: '#/components/parameters/messageMetadataIds'
+ - name: siteId
in: query
- description: The end time to query, epoch time in milliseconds since 1/1/1970, default is now if not specified or is negative, endTime - startTime must be no greater than 2592000000 (30 days)
+ description: The site to filter, return global data if not specified
required: false
schema:
type: integer
@@ -3687,42 +3717,49 @@ paths:
schema:
type: integer
format: int32
- - name: keyword
+ - name: sortField
in: query
- description: The case-insensitive keyword to search in description
+ description: The sort field
required: false
schema:
- type: string
- - name: sortField
+ $ref: '#/components/schemas/XiqAlertSortField'
+ - $ref: '#/components/parameters/order'
+ - name: keyword
in: query
- description: The field for sorting
+ description: The keyword to filter, such as summery, severity, source and etc.
required: false
schema:
- $ref: '#/components/schemas/XiqAuditLogSortField'
- - $ref: '#/components/parameters/order'
+ type: string
+ - $ref: '#/components/parameters/async'
responses:
'200':
description: OK
content:
application/json:
schema:
- $ref: '#/components/schemas/XiqAuditLogReport'
+ $ref: '#/components/schemas/XiqAlertReport'
default:
$ref: '#/components/responses/ErrorResponse'
security:
- BearerAuth: []
- /logs/audit/reports/{id}:
+ /alerts/reports/{id}:
get:
tags:
- - Log
- summary: Download audit logs
- description: Download report of audit logs.
+ - Alert
+ summary: Download an alert event report
+ description: Download report of alert event .
externalDocs:
description: API Reference
- url: https://extremecloudiq.com/api-docs/api-reference.html#_audit_log_download
- operationId: downloadAuditLogs
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_download_an_alert_report
+ operationId: downloadAlertReport
parameters:
- - $ref: '#/components/parameters/id'
+ - name: id
+ in: path
+ description: The report ID
+ required: true
+ schema:
+ type: integer
+ format: int64
responses:
'200':
description: OK
@@ -3735,321 +3772,208 @@ paths:
$ref: '#/components/responses/ErrorResponse'
security:
- BearerAuth: []
- /logs/sms:
+ /alert-subscriptions/emails:
get:
tags:
- - Log
- summary: List SMS logs
- description: List a page of SMS logs.
+ - Alert
+ summary: List email subscriptions
+ description: List all email subscriptions.
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
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_list_alert_email_subscriptions
+ operationId: listEmailSubscriptions
responses:
'200':
description: OK
content:
application/json:
schema:
- $ref: '#/components/schemas/PagedXiqSmsLog'
+ type: array
+ items:
+ $ref: '#/components/schemas/XiqAlertEmailSubscription'
default:
$ref: '#/components/responses/ErrorResponse'
security:
- BearerAuth: []
- /logs/email:
- get:
+ post:
tags:
- - Log
- summary: List Email logs
- description: List a page of Email logs.
+ - Alert
+ summary: Create email subscription
+ description: Create email subscription.
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
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_create_subscription_email
+ operationId: createEmailSubscription
+ requestBody:
+ description: The payload of create email subscription.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/XiqCreateAlertEmailSubscriptionRequest'
+ required: true
responses:
'200':
description: OK
content:
application/json:
schema:
- $ref: '#/components/schemas/PagedXiqEmailLog'
+ $ref: '#/components/schemas/XiqAlertEmailSubscription'
default:
$ref: '#/components/responses/ErrorResponse'
security:
- BearerAuth: []
- /logs/auth:
- get:
+ /alert-subscriptions/emails/:delete:
+ post:
tags:
- - Log
- summary: List auth logs
- description: List a page of auth logs.
+ - Alert
+ summary: '[LRO] Delete alert subscription email in bulk'
+ description: Delete alert subscription email by a list of IDs.This API can be run at async mode, please follow the Long-Running Operation (LRO) guide to track the progress and the result.
externalDocs:
description: API Reference
- url: https://extremecloudiq.com/api-docs/api-reference.html#_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
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_bulk_delete_alert_email_subscriptions
+ operationId: deleteBulkAertSubscriptionEmail
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/subscriptionIds'
responses:
'200':
description: OK
content:
application/json:
schema:
- $ref: '#/components/schemas/PagedXiqAuthLog'
+ $ref: '#/components/schemas/XiqDeleteBulkAlertSubscriptionEmailResponse'
default:
$ref: '#/components/responses/ErrorResponse'
security:
- BearerAuth: []
- /logs/credential:
+ /alert-subscriptions/emails/{id}:
get:
tags:
- - Log
- summary: List credential logs
- description: List a page of credential logs.
+ - Alert
+ summary: Get email subscription info for a specific email
+ description: Get email subscription info for a specific email.
externalDocs:
description: API Reference
- url: https://extremecloudiq.com/api-docs/api-reference.html#_list_credential_log
- operationId: listCredentialLogs
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_get_an_alert_email_subscription
+ operationId: getEmailSubscription
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
+ - $ref: '#/components/parameters/id'
responses:
'200':
description: OK
content:
application/json:
schema:
- $ref: '#/components/schemas/PagedXiqCredentialLog'
+ $ref: '#/components/schemas/XiqAlertEmailSubscription'
default:
$ref: '#/components/responses/ErrorResponse'
security:
- BearerAuth: []
- /logs/accounting:
- get:
+ put:
tags:
- - Log
- summary: List accounting logs
- description: List a page of accounting logs.
+ - Alert
+ summary: Update email subscription
+ description: Update email subscription.
externalDocs:
description: API Reference
- url: https://extremecloudiq.com/api-docs/api-reference.html#_list_accounting_log
- operationId: listAccountingLogs
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_update_an_alert_email_subscription
+ operationId: updateEmailSubscription
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
+ - $ref: '#/components/parameters/id'
+ requestBody:
+ description: The payload of update email subscription.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/XiqUpdateAlertEmailSubscriptionRequest'
responses:
'200':
description: OK
content:
application/json:
schema:
- $ref: '#/components/schemas/PagedXiqAccountingLog'
+ $ref: '#/components/schemas/XiqAlertEmailSubscription'
default:
$ref: '#/components/responses/ErrorResponse'
security:
- BearerAuth: []
- /subscriptions/webhook:
- get:
+ delete:
tags:
- - Notification
- summary: List webhook subscriptions
- description: List all webhook subscriptions.
+ - Alert
+ summary: Delete email subscription
+ description: Delete an exist email subscription.
externalDocs:
description: API Reference
- url: https://extremecloudiq.com/api-docs/api-reference.html#_list_webhook_subscriptions
- operationId: list
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_delete_an_alert_email_subscription
+ operationId: deleteEmailSubscription
+ parameters:
+ - $ref: '#/components/parameters/id'
responses:
'200':
description: OK
- content:
- application/json:
- schema:
- type: array
- items:
- $ref: '#/components/schemas/XiqWebhookSubscription'
default:
$ref: '#/components/responses/ErrorResponse'
security:
- BearerAuth: []
+ /alert-subscriptions/emails/{id}/:verify:
post:
tags:
- - Notification
- summary: Create webhook subscriptions
- description: Create multiple webhook subscriptions.
+ - Alert
+ summary: External email address verification
+ description: User sends a verification email to the specified email address to verify, by clicking the verify link/button in the email.
externalDocs:
description: API Reference
- url: https://extremecloudiq.com/api-docs/api-reference.html#_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
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_verify_an_alert_email_subscription
+ operationId: verifySubscriptionEmail
+ parameters:
+ - $ref: '#/components/parameters/id'
responses:
- '202':
- description: Accepted
+ '200':
+ description: OK
default:
$ref: '#/components/responses/ErrorResponse'
security:
- BearerAuth: []
- /subscriptions/webhook/{id}:
- delete:
+ /alert-subscriptions/webhooks:
+ get:
tags:
- - Notification
- summary: Delete webhook subscription
- description: Delete an exist webhook subscription.
+ - Alert
+ summary: List webhook subscriptions
+ description: List webhook subscriptions.
externalDocs:
description: API Reference
- url: https://extremecloudiq.com/api-docs/api-reference.html#_delete_webhook_subscriptions
- operationId: deleteSubscription
- parameters:
- - $ref: '#/components/parameters/id'
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_list_alert_webhook_subscriptions
+ operationId: listWebhookSubscriptions
responses:
- '202':
- description: Accepted
+ '200':
+ description: OK
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/XiqAlertWebhookSubscription'
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.
+ - Alert
+ summary: Create webhook subscription
+ description: Create webhook subscription.
externalDocs:
description: API Reference
- url: https://extremecloudiq.com/api-docs/api-reference.html#_push_configuration_and_upgrade_firmware_to_devices
- operationId: deployConfig
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_create_an_alert_webhook_subscription
+ operationId: createWebhookSubscription
requestBody:
- description: The device deploy configuration
+ description: The payload of create webhook subscription.
content:
application/json:
schema:
- $ref: '#/components/schemas/XiqDeploymentRequest'
+ $ref: '#/components/schemas/XiqCreateAlertWebhookSubscriptionRequest'
required: true
responses:
'200':
@@ -4057,157 +3981,167 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/XiqDeploymentResponse'
+ $ref: '#/components/schemas/XiqAlertWebhookSubscription'
default:
$ref: '#/components/responses/ErrorResponse'
security:
- BearerAuth: []
- /deployments/overview:
- get:
+ /alert-subscriptions/webhooks/:delete:
+ post:
tags:
- - Configuration - Deployment
- summary: Get configuration deployment overview
- description: Get configuration deployment status overview.
+ - Alert
+ summary: '[LRO] Delete alert subscription webhook in bulk'
+ description: Delete alert subscription webhook by a list of IDs.This API can be run at async mode, please follow the Long-Running Operation (LRO) guide to track the progress and the result.
externalDocs:
description: API Reference
- url: https://extremecloudiq.com/api-docs/api-reference.html#_get_configuration_deployment_overview
- operationId: getDeployOverview
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_bulk_delete_alert_webhook_subscriptions
+ operationId: deleteBulkAertSubscriptionWebhook
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/subscriptionIds'
responses:
'200':
description: OK
content:
application/json:
schema:
- $ref: '#/components/schemas/XiqDeploymentOverview'
+ $ref: '#/components/schemas/XiqDeleteBulkAlertSubscriptionWebhookResponse'
default:
$ref: '#/components/responses/ErrorResponse'
security:
- BearerAuth: []
- /deployments/status:
+ /alert-subscriptions/webhooks/{id}:
get:
tags:
- - Configuration - Deployment
- summary: Get configuration deployment status
- description: Get configuration deployment status for the target devices.
+ - Alert
+ summary: Get webhook subscription info for a specific url
+ description: Get webhook subscription info for a specific url.
externalDocs:
description: API Reference
- url: https://extremecloudiq.com/api-docs/api-reference.html#_get_configuration_deployment_status
- operationId: getDeployStatus
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_get_an_alert_webhook_subscription
+ operationId: getWebhookSubscription
parameters:
- - name: deviceIds
- in: query
- description: The target device IDs
- required: true
- schema:
- uniqueItems: true
- type: array
- items:
- type: integer
- format: int64
+ - $ref: '#/components/parameters/id'
responses:
'200':
description: OK
content:
application/json:
schema:
- type: object
- additionalProperties:
- $ref: '#/components/schemas/XiqDeploymentStatus'
+ $ref: '#/components/schemas/XiqAlertWebhookSubscription'
default:
$ref: '#/components/responses/ErrorResponse'
security:
- BearerAuth: []
- /vlan-profiles:
- get:
+ put:
tags:
- - Configuration - Basic
- summary: List VLAN profiles
- description: Get a page of VLAN profiles.
+ - Alert
+ summary: Update webhook subscription
+ description: Update webhook subscription.
externalDocs:
description: API Reference
- url: https://extremecloudiq.com/api-docs/api-reference.html#_list_the_vlan_profiles
- operationId: listVlanProfiles
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_update_an_alert_webhook_subscription
+ operationId: updateWebhookSubscription
parameters:
- - $ref: '#/components/parameters/page'
- - $ref: '#/components/parameters/limit'
+ - $ref: '#/components/parameters/id'
+ requestBody:
+ description: The payload of update webhook subscription.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/XiqUpdateAlertWebhookSubscriptionRequest'
responses:
'200':
description: OK
content:
application/json:
schema:
- $ref: '#/components/schemas/PagedXiqVlanProfile'
+ $ref: '#/components/schemas/XiqAlertWebhookSubscription'
default:
$ref: '#/components/responses/ErrorResponse'
security:
- BearerAuth: []
- post:
+ delete:
tags:
- - Configuration - Basic
- summary: Create VLAN profile
- description: Create a new VLAN profile.
+ - Alert
+ summary: Delete webhook subscription
+ description: Delete an exist webhook subscription.
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
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_delete_an_alert_webhook_subscription
+ operationId: deleteWebhookSubscription
+ parameters:
+ - $ref: '#/components/parameters/id'
responses:
- '201':
- description: Created
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/XiqVlanProfile'
+ '200':
+ description: OK
default:
$ref: '#/components/responses/ErrorResponse'
security:
- BearerAuth: []
- /vlan-profiles/{id}:
+ /alert-policies:
get:
tags:
- - Configuration - Basic
- summary: Get a VLAN profile
- description: Get a specific VLAN profile by ID.
+ - Alert
+ summary: List all alert policies
+ description: Get a list of all alert policies belonging to the current user and an overview of their associated alert rules. The details for the rules is available from the alert policy rules API.
externalDocs:
description: API Reference
- url: https://extremecloudiq.com/api-docs/api-reference.html#_get_vlan_profile_by_id
- operationId: getVlanProfile
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_list_the_alert_policies
+ operationId: listAlertPolicies
+ security:
+ - BearerAuth: []
parameters:
- - $ref: '#/components/parameters/id'
+ - name: keyword
+ in: query
+ description: The keyword to filter, such as policy name or site name
+ required: false
+ schema:
+ type: string
+ - name: policyType
+ in: query
+ description: The policy type to filter, such as SITE or GLOBAL
+ required: false
+ schema:
+ $ref: '#/components/schemas/XiqAlertPolicyType'
responses:
'200':
description: OK
content:
application/json:
schema:
- $ref: '#/components/schemas/XiqVlanProfile'
+ type: object
+ description: The alert policies belonging to this user.
+ properties:
+ global_policy:
+ description: The global policy. Empty when includeGlobal is false.
+ $ref: '#/components/schemas/XiqAlertPolicy'
+ site_policies:
+ type: array
+ description: A list of site policies.
+ items:
+ $ref: '#/components/schemas/XiqAlertPolicy'
default:
$ref: '#/components/responses/ErrorResponse'
- security:
- - BearerAuth: []
- patch:
+ post:
tags:
- - Configuration - Basic
- summary: Update a VLAN profile
- description: Update a specific VLAN profile.
+ - Alert
+ summary: Create a site based alert policy
+ description: Create a new site-based alert policy. The global policy for each account is created automatically.
externalDocs:
description: API Reference
- url: https://extremecloudiq.com/api-docs/api-reference.html#_update_vlan_profile_configuration
- operationId: updateVlanProfile
- parameters:
- - $ref: '#/components/parameters/id'
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_create_an_alert_policy
+ operationId: createAlertPolicy
+ security:
+ - BearerAuth: []
requestBody:
- description: The payload to update VLAN profile
+ description: The body of create site policy API
content:
application/json:
schema:
- $ref: '#/components/schemas/XiqUpdateVlanProfileRequest'
+ $ref: '#/components/schemas/XiqCreateAlertPolicyRequest'
required: true
responses:
'200':
@@ -4215,175 +4149,148 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/XiqVlanProfile'
+ $ref: '#/components/schemas/XiqAlertPolicy'
+ description: The newly created alert policy.
default:
$ref: '#/components/responses/ErrorResponse'
- security:
- - BearerAuth: []
- delete:
+ /alert-policies/{policyId}:
+ get:
tags:
- - Configuration - Basic
- summary: Delete a VLAN profile
- description: Delete a specific VLAN profile by ID.
+ - Alert
+ summary: Get details of an alert policy
+ description: Get the details related to a specific alert policy, given the policy's identifier.
externalDocs:
description: API Reference
- url: https://extremecloudiq.com/api-docs/api-reference.html#_delete_vlan_profile_configuration
- operationId: deleteVlanProfile
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_get_an_alert_policy
+ operationId: getAlertPolicy
+ security:
+ - BearerAuth: []
parameters:
- - $ref: '#/components/parameters/id'
+ - $ref: '#/components/parameters/policyId'
responses:
'200':
description: OK
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/XiqAlertPolicy'
default:
$ref: '#/components/responses/ErrorResponse'
- security:
- - BearerAuth: []
- /email-templates:
- get:
+ put:
tags:
- - Configuration - User Management
- summary: List Email templates
- description: List all Email notification templates.
+ - Alert
+ summary: Update a site-based alert policy
+ description: Modify a site-based alert policy's details, including the policy name and sites. The global policy cannot be updated. The sites can be obtained from the alerts/sites API.
externalDocs:
description: API Reference
- url: https://extremecloudiq.com/api-docs/api-reference.html#_list_email_templates
- operationId: listEmailTemplates
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_update_an_alert_policy
+ operationId: updateAlertPolicy
+ security:
+ - BearerAuth: []
parameters:
- - name: passwordType
- in: query
- description: The password type
- required: false
- schema:
- $ref: '#/components/schemas/XiqPasswordType'
+ - $ref: '#/components/parameters/policyId'
+ requestBody:
+ description: The body of update alert site policy API
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/XiqUpdateAlertPolicyRequest'
+ required: true
responses:
'200':
description: OK
content:
application/json:
schema:
- type: array
- items:
- $ref: '#/components/schemas/XiqEmailTemplate'
+ $ref: '#/components/schemas/XiqAlertPolicy'
+ description: The newly created alert policy.
default:
$ref: '#/components/responses/ErrorResponse'
- security:
- - BearerAuth: []
- /sms-templates:
- get:
+ delete:
tags:
- - Configuration - User Management
- summary: List SMS templates
- description: List all SMS notification templates.
+ - Alert
+ summary: Delete a site-based alert policy
+ description: Delete an alert policy. All the associated alert rules will be deleted as well. The global policy cannot be deleted.
externalDocs:
description: API Reference
- url: https://extremecloudiq.com/api-docs/api-reference.html#_list_sms_templates
- operationId: listSmsTemplates
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_delete_an_alert_policy
+ operationId: deleteAlertPolicy
+ security:
+ - BearerAuth: []
parameters:
- - name: passwordType
- in: query
- description: The password type
- required: false
- schema:
- $ref: '#/components/schemas/XiqPasswordType'
+ - $ref: '#/components/parameters/policyId'
responses:
'200':
description: OK
- content:
- application/json:
- schema:
- type: array
- items:
- $ref: '#/components/schemas/XiqSmsTemplate'
default:
$ref: '#/components/responses/ErrorResponse'
- security:
- - BearerAuth: []
- /endusers:
+ /alert-policies/available-sites:
get:
tags:
- - Configuration - User Management
- summary: List end users
- description: List a page of end users.
+ - Alert
+ summary: The list of current owner's available sites
+ description: List all sites belonging to the current owner. If the site has been configured an alert policy, then the site will not be available.
externalDocs:
description: API Reference
- url: https://extremecloudiq.com/api-docs/api-reference.html#_list_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
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_list_the_available_sites
+ operationId: listAvailableSites
responses:
'200':
description: OK
content:
application/json:
schema:
- $ref: '#/components/schemas/PagedXiqEndUser'
+ type: array
+ items:
+ $ref: '#/components/schemas/XiqAlertSite'
default:
$ref: '#/components/responses/ErrorResponse'
security:
- BearerAuth: []
- post:
+ /alert-policies/{policyId}/rules/{ruleId}:
+ get:
tags:
- - Configuration - User Management
- summary: Create an end user
- description: Create a new end user.
+ - Alert
+ summary: Get details of an alert rule
+ description: Get the full details of an alert rule's state.
externalDocs:
description: API Reference
- url: https://extremecloudiq.com/api-docs/api-reference.html#_create_end_user
- operationId: createEndUser
- requestBody:
- description: Create end user request body
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/XiqCreateEndUserRequest'
- required: true
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_get_an_alert_rule
+ operationId: getAlertRule
+ security:
+ - BearerAuth: []
+ parameters:
+ - $ref: '#/components/parameters/policyId'
+ - $ref: '#/components/parameters/ruleId'
responses:
'200':
description: OK
content:
application/json:
schema:
- $ref: '#/components/schemas/XiqEndUser'
+ $ref: '#/components/schemas/XiqAlertRule'
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.
+ - Alert
+ summary: Update an alert rule
+ description: Update the state of an alert rule. The rule's identifier may change as a result of this operation.
externalDocs:
description: API Reference
- url: https://extremecloudiq.com/api-docs/api-reference.html#_update_end_user
- operationId: updateEndUser
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_update_an_alert_rule
+ operationId: updateAlertRule
+ security:
+ - BearerAuth: []
parameters:
- - $ref: '#/components/parameters/id'
+ - $ref: '#/components/parameters/policyId'
+ - $ref: '#/components/parameters/ruleId'
requestBody:
- description: Update end user request body
+ description: The body of update alert rule API
content:
application/json:
schema:
- $ref: '#/components/schemas/XiqUpdateEndUserRequest'
+ $ref: '#/components/schemas/XiqUpdateAlertRuleRequest'
required: true
responses:
'200':
@@ -4391,292 +4298,454 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/XiqEndUser'
+ $ref: '#/components/schemas/XiqAlertRule'
default:
$ref: '#/components/responses/ErrorResponse'
- security:
- - BearerAuth: []
- delete:
+ /alert-policies/{policyId}/rules/{ruleId}/:enable:
+ post:
tags:
- - Configuration - User Management
- summary: Delete end user by ID
- description: Delete a specific end user.
+ - Alert
+ summary: Enable a rule from an alert policy
+ description: Set the status of a rule to enabled. The rule's identifier may change as a result of this operation.
externalDocs:
description: API Reference
- url: https://extremecloudiq.com/api-docs/api-reference.html#_delete_end_user
- operationId: deleteSsidUser
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_enable_an_alert_rule
+ operationId: enableAlertRule
+ security:
+ - BearerAuth: []
parameters:
- - $ref: '#/components/parameters/id'
+ - $ref: '#/components/parameters/policyId'
+ - $ref: '#/components/parameters/ruleId'
responses:
'200':
description: OK
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/XiqAlertRule'
+ description: The updated alert rule status.
default:
$ref: '#/components/responses/ErrorResponse'
- security:
- - BearerAuth: []
- /endusers/{id}/:regenerate-password:
+ /alert-policies/{policyId}/rules/{ruleId}/:disable:
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.
+ - Alert
+ summary: Disable a rule from an alert policy
+ description: Set the status of a rule to disabled. The rule's identifier may change as a result of this operation.
externalDocs:
description: API Reference
- url: https://extremecloudiq.com/api-docs/api-reference.html#_regenerate_end_user_password
- operationId: regenerateEndUserPassword
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_disable_an_alert_rule
+ operationId: disableAlertRule
+ security:
+ - BearerAuth: []
parameters:
- - $ref: '#/components/parameters/id'
+ - $ref: '#/components/parameters/policyId'
+ - $ref: '#/components/parameters/ruleId'
responses:
'200':
description: OK
content:
application/json:
schema:
- $ref: '#/components/schemas/XiqRegenerateEndUserPasswordResponse'
+ $ref: '#/components/schemas/XiqAlertRule'
+ description: The updated alert rule status.
default:
$ref: '#/components/responses/ErrorResponse'
- security:
- - BearerAuth: []
- /usergroups:
+ /logs/audit:
get:
tags:
- - Configuration - User Management
- summary: List user groups
- description: List a page of user groups.
+ - 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_user_groups
- operationId: listUserGroups
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_list_audit_log
+ operationId: listAuditLogs
parameters:
- $ref: '#/components/parameters/page'
- $ref: '#/components/parameters/limit'
- - name: password_db_location
+ - $ref: '#/components/parameters/startTime'
+ - name: categories
in: query
- description: The password DB location
+ description: Audit category
required: false
schema:
- $ref: '#/components/schemas/XiqPasswordDbLocation'
- - name: password_type
- in: query
- description: The password type
+ type: array
+ items:
+ $ref: '#/components/schemas/XiqAuditLogCategory'
+ - name: username
+ in: query
+ description: The user login name
required: false
schema:
- $ref: '#/components/schemas/XiqPasswordType'
+ type: string
+ - name: endTime
+ in: query
+ description: 'The end time to query, epoch time in milliseconds since 1/1/1970. Note: endTime - startTime must be no greater than 2592000000 (30 days)'
+ required: true
+ schema:
+ type: integer
+ format: int64
+ - name: keyword
+ in: query
+ description: The case-insensitive keyword to search in description
+ required: false
+ schema:
+ type: string
+ - name: sortField
+ in: query
+ description: The field for sorting
+ required: false
+ schema:
+ $ref: '#/components/schemas/XiqAuditLogSortField'
+ - $ref: '#/components/parameters/order'
responses:
'200':
description: OK
content:
application/json:
schema:
- $ref: '#/components/schemas/PagedXiqUserGroup'
+ $ref: '#/components/schemas/PagedXiqAuditLog'
default:
$ref: '#/components/responses/ErrorResponse'
security:
- BearerAuth: []
+ /logs/audit/reports:
post:
tags:
- - Configuration - User Management
- summary: Create user group
- description: Create a new user group.
+ - Log
+ summary: Create audit logs report
+ description: Creates a report page of audit logs.
externalDocs:
description: API Reference
- url: https://extremecloudiq.com/api-docs/api-reference.html#_create_user_group
- operationId: createUserGroup
- requestBody:
- description: Create user group request body
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/XiqCreateUserGroupRequest'
- required: true
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_audit_log_report
+ operationId: createAuditLogReport
+ parameters:
+ - name: categories
+ in: query
+ description: Audit category
+ required: false
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/XiqAuditLogCategory'
+ - name: username
+ in: query
+ description: The user login name
+ required: false
+ schema:
+ type: string
+ - name: startTime
+ in: query
+ description: The start time to query, epoch time in milliseconds since 1/1/1970, default is 0 if not specified or is negative
+ required: false
+ schema:
+ type: integer
+ format: int64
+ - name: endTime
+ in: query
+ description: The end time to query, epoch time in milliseconds since 1/1/1970, default is now if not specified or is negative, endTime - startTime must be no greater than 2592000000 (30 days)
+ required: false
+ schema:
+ type: integer
+ format: int64
+ - name: timeZoneOffset
+ in: query
+ description: The time zone off set
+ required: false
+ schema:
+ type: integer
+ format: int32
+ - name: keyword
+ in: query
+ description: The case-insensitive keyword to search in description
+ required: false
+ schema:
+ type: string
+ - name: sortField
+ in: query
+ description: The field for sorting
+ required: false
+ schema:
+ $ref: '#/components/schemas/XiqAuditLogSortField'
+ - $ref: '#/components/parameters/order'
responses:
'200':
description: OK
content:
application/json:
schema:
- $ref: '#/components/schemas/XiqUserGroup'
+ $ref: '#/components/schemas/XiqAuditLogReport'
default:
$ref: '#/components/responses/ErrorResponse'
security:
- BearerAuth: []
- /usergroups/{id}:
- put:
+ /logs/audit/reports/{id}:
+ get:
tags:
- - Configuration - User Management
- summary: Update user group
- description: Update existing user group information.
+ - Log
+ summary: Download audit logs
+ description: Download report of audit logs.
externalDocs:
description: API Reference
- url: https://extremecloudiq.com/api-docs/api-reference.html#_update_user_group
- operationId: updateUserGroup
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_audit_log_download
+ operationId: downloadAuditLogs
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:
+ application/octet-stream:
schema:
- $ref: '#/components/schemas/XiqUserGroup'
+ type: string
+ format: byte
default:
$ref: '#/components/responses/ErrorResponse'
security:
- BearerAuth: []
- delete:
+ /logs/sms:
+ get:
tags:
- - Configuration - User Management
- summary: Delete user group by ID
- description: Delete the user-group for the specified ID.
+ - 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#_delete_user_group
- operationId: deleteUserGroup
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_list_sms_log
+ operationId: listSmsLogs
parameters:
- - $ref: '#/components/parameters/id'
+ - $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: []
- /pcgs/key-based:
+ /logs/email:
get:
tags:
- - Configuration - User Management
- summary: List Key-based Private Client Groups
- description: List all Key-based Private Client Groups.
+ - 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_all_key_based_pcg_entries
- operationId: listKeyBasedPrivateClientGroups
+ 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:
- 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
+ $ref: '#/components/schemas/PagedXiqEmailLog'
default:
$ref: '#/components/responses/ErrorResponse'
security:
- BearerAuth: []
- /pcgs/key-based/network-policy-{policyId}/:onboard:
- post:
+ /logs/auth:
+ get:
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.
+ - 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#_create_key_based_pcg_data
- operationId: onboardKeyBasedPrivateClientGroup
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_list_authentication_log
+ operationId: listAuthLogs
parameters:
- - name: policyId
- in: path
- description: The network policy ID
- required: true
+ - $ref: '#/components/parameters/page'
+ - $ref: '#/components/parameters/limit'
+ - name: username
+ in: query
+ description: The user login name
+ required: false
schema:
- type: integer
- format: int64
- requestBody:
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/XiqOnboardKeyBasedPcgRequest'
- required: true
+ 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:
- '202':
- description: Accepted
+ '200':
+ description: OK
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/PagedXiqAuthLog'
default:
$ref: '#/components/responses/ErrorResponse'
security:
- BearerAuth: []
- /pcgs/key-based/network-policy-{policyId}:
- delete:
+ /logs/credential:
+ get:
tags:
- - Configuration - User Management
- summary: Delete Private Client Group from a network policy
- description: Delete Private Client Group settings from a network policy.
+ - 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#_delete_key_based_pcg
- operationId: deletePcg
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_list_credential_log
+ operationId: listCredentialLogs
parameters:
- - name: policyId
- in: path
- description: The network policy ID
- required: true
+ - $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: ids
+ - name: endTime
in: query
- description: The IDs of the Key-based PCG entity to be deleted from network policy
- required: true
+ 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: array
- items:
- type: integer
- format: int64
+ type: integer
+ format: int64
responses:
- '202':
- description: Accepted
+ '200':
+ description: OK
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/PagedXiqCredentialLog'
default:
$ref: '#/components/responses/ErrorResponse'
security:
- BearerAuth: []
- /pcgs/key-based/network-policy-{policyId}/users:
+ /logs/accounting:
get:
tags:
- - Configuration - User Management
- summary: Get users for a PCG-enabled network policy
- description: Get users for a specific PCG-enabled network policy.
+ - 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#_get_key_based_pcg_users_from_given_network_policy_id
- operationId: getKeyBasedPcgUsers
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_list_accounting_log
+ operationId: listAccountingLogs
parameters:
- - name: policyId
- in: path
- description: The network policy ID
- required: true
+ - $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
@@ -4685,34 +4754,28 @@ paths:
schema:
type: array
items:
- $ref: '#/components/schemas/XiqKeyBasedPcgUser'
+ $ref: '#/components/schemas/XiqWebhookSubscription'
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.
+ - Notification
+ summary: Create webhook subscriptions
+ description: Create multiple webhook subscriptions.
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
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_create_webhook_subscriptions
+ operationId: createSubscriptions
requestBody:
- description: The payload of add users to PCG-enabled network policy
+ description: The payload of create multiple webhook subscriptions
content:
application/json:
schema:
- $ref: '#/components/schemas/XiqCreateKeyBasedPcgUsersRequest'
+ type: array
+ items:
+ $ref: '#/components/schemas/XiqCreateWebhookSubscriptionRequest'
required: true
responses:
'202':
@@ -4721,30 +4784,18 @@ paths:
$ref: '#/components/responses/ErrorResponse'
security:
- BearerAuth: []
- put:
+ /subscriptions/webhook/{id}:
+ delete:
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.
+ - Notification
+ summary: Delete webhook subscription
+ description: Delete an exist webhook subscription.
externalDocs:
description: API Reference
- url: https://extremecloudiq.com/api-docs/api-reference.html#_replace_all_key_based_pcg_users
- operationId: updateKeyBasedPcgUsers
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_delete_webhook_subscriptions
+ operationId: deleteSubscription
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
+ - $ref: '#/components/parameters/id'
responses:
'202':
description: Accepted
@@ -4752,179 +4803,99 @@ paths:
$ref: '#/components/responses/ErrorResponse'
security:
- BearerAuth: []
- delete:
+ /deployments:
+ post:
tags:
- - Configuration - User Management
- summary: Delete users from a PCG-enabled network policy
- description: Delete users from a PCG-enabled network policy.
+ - 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#_delete_key_based_pcg_users
- operationId: deleteKeyBasedPcgUsers
- parameters:
- - name: policyId
- in: path
- description: The network policy ID
- required: true
- schema:
- type: integer
- format: int64
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_push_configuration_and_upgrade_firmware_to_devices
+ operationId: deployConfig
requestBody:
- description: The payload of delete Key-based PCG users request
+ description: The device deploy configuration
content:
application/json:
schema:
- $ref: '#/components/schemas/XiqDeleteKeyBasedPcgUsersRequest'
+ $ref: '#/components/schemas/XiqDeploymentRequest'
required: true
responses:
- '202':
- description: Accepted
+ '200':
+ description: OK
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/XiqDeploymentResponse'
default:
$ref: '#/components/responses/ErrorResponse'
security:
- BearerAuth: []
- /pcgs/key-based/network-policy-{policyId}/port-assignments:
+ /deployments/overview:
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.
+ - 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_port_assignment_details_of_ap150w
- operationId: getPortAssignments
- parameters:
- - name: policyId
- in: path
- description: The network policy ID
- required: true
- schema:
- type: integer
- format: int64
+ 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/XiqGetPortAssignmentDetailsResponse'
+ $ref: '#/components/schemas/XiqDeploymentOverview'
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:
+ /deployments/status:
+ get:
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.
+ - 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#_email_keys
- operationId: emailKeys
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_get_configuration_deployment_status
+ operationId: getDeployStatus
parameters:
- - name: policyId
- in: path
- description: The network policy ID
- required: true
- schema:
- type: integer
- format: int64
- - name: userIds
+ - name: deviceIds
in: query
- description: The user IDs
+ description: The target device IDs
required: true
schema:
+ uniqueItems: true
type: array
items:
type: integer
format: int64
responses:
- '202':
- description: Accepted
+ '200':
+ description: OK
+ content:
+ application/json:
+ schema:
+ type: object
+ additionalProperties:
+ $ref: '#/components/schemas/XiqDeploymentStatus'
default:
$ref: '#/components/responses/ErrorResponse'
security:
- BearerAuth: []
- /classification-rules:
+ /vlan-profiles:
get:
tags:
- - Configuration - Policy
- summary: List classification rules
- description: List a page of classification rules.
+ - 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_classification_rules
- operationId: listClassificationRules
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_list_the_vlan_profiles
+ operationId: listVlanProfiles
parameters:
- $ref: '#/components/parameters/page'
- $ref: '#/components/parameters/limit'
@@ -4934,26 +4905,26 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PagedXiqClassificationRule'
+ $ref: '#/components/schemas/PagedXiqVlanProfile'
default:
$ref: '#/components/responses/ErrorResponse'
security:
- BearerAuth: []
post:
tags:
- - Configuration - Policy
- summary: Create classification rule
- description: Create a new classification rule.
+ - 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_classification_rule_configuration
- operationId: createClassificationRule
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_create_vlan_profile_configuration
+ operationId: createVlanProfile
requestBody:
- description: The payload to create a new classification rule
+ description: The payload to create new VLAN profile
content:
application/json:
schema:
- $ref: '#/components/schemas/XiqCreateClassificationRuleRequest'
+ $ref: '#/components/schemas/XiqCreateVlanProfileRequest'
required: true
responses:
'201':
@@ -4961,21 +4932,21 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/XiqClassificationRule'
+ $ref: '#/components/schemas/XiqVlanProfile'
default:
$ref: '#/components/responses/ErrorResponse'
security:
- BearerAuth: []
- /classification-rules/{id}:
+ /vlan-profiles/{id}:
get:
tags:
- - Configuration - Policy
- summary: Get a classification rule by ID
- description: Get a specific classification rule.
+ - 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_classification_rule_by_id
- operationId: getClassificationRule
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_get_vlan_profile_by_id
+ operationId: getVlanProfile
parameters:
- $ref: '#/components/parameters/id'
responses:
@@ -4984,28 +4955,28 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/XiqClassificationRule'
+ $ref: '#/components/schemas/XiqVlanProfile'
default:
$ref: '#/components/responses/ErrorResponse'
security:
- BearerAuth: []
- put:
+ patch:
tags:
- - Configuration - Policy
- summary: Update classification rule
- description: Update the exist classification rule.
+ - 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_classification_rule_configuration
- operationId: updateClassificationRule
+ 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 exist classification rule
+ description: The payload to update VLAN profile
content:
application/json:
schema:
- $ref: '#/components/schemas/XiqUpdateClassificationRuleRequest'
+ $ref: '#/components/schemas/XiqUpdateVlanProfileRequest'
required: true
responses:
'200':
@@ -5013,20 +4984,20 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/XiqClassificationRule'
+ $ref: '#/components/schemas/XiqVlanProfile'
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.
+ - 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_classification_rule_configuration
- operationId: deleteClassificationRule
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_delete_vlan_profile_configuration
+ operationId: deleteVlanProfile
parameters:
- $ref: '#/components/parameters/id'
responses:
@@ -5036,29 +5007,23 @@ paths:
$ref: '#/components/responses/ErrorResponse'
security:
- BearerAuth: []
- /l3-address-profiles:
+ /email-templates:
get:
tags:
- - Configuration - Policy
- summary: List L3 address profiles
- description: List all L3 Address Profiles.
+ - 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_the_l3_address_profile
- operationId: listL3AddressProfiles
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_list_email_templates
+ operationId: listEmailTemplates
parameters:
- - name: addressType
+ - name: passwordType
in: query
- description: The address type
- required: true
+ description: The password type
+ required: false
schema:
- type: string
- enum:
- - L3_ADDRESS_TYPE_UNSPECIFIED
- - L3_ADDRESS_TYPE_IP_ADDRESS
- - L3_ADDRESS_TYPE_IP_SUBNET
- - L3_ADDRESS_TYPE_IP_RANGE
- - UNRECOGNIZED
+ $ref: '#/components/schemas/XiqPasswordType'
responses:
'200':
description: OK
@@ -5067,102 +5032,97 @@ paths:
schema:
type: array
items:
- $ref: '#/components/schemas/XiqL3AddressProfile'
+ $ref: '#/components/schemas/XiqEmailTemplate'
default:
$ref: '#/components/responses/ErrorResponse'
security:
- BearerAuth: []
- /radio-profiles:
+ /sms-templates:
get:
tags:
- - Configuration - Policy
- summary: List radio profiles
- description: List a page of radio profiles.
+ - 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_the_radio_profiles
- operationId: listRadioProfiles
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_list_sms_templates
+ operationId: listSmsTemplates
parameters:
- - $ref: '#/components/parameters/page'
- - $ref: '#/components/parameters/limit'
+ - name: passwordType
+ in: query
+ description: The password type
+ required: false
+ schema:
+ $ref: '#/components/schemas/XiqPasswordType'
responses:
'200':
description: OK
content:
application/json:
schema:
- $ref: '#/components/schemas/PagedXiqRadioProfile'
+ type: array
+ items:
+ $ref: '#/components/schemas/XiqSmsTemplate'
default:
$ref: '#/components/responses/ErrorResponse'
security:
- BearerAuth: []
- post:
+ /endusers:
+ get:
tags:
- - Configuration - Policy
- summary: Create a radio profile
- description: Create a new radio profile.
+ - 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#_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
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_list_end_users
+ operationId: listEndUsers
parameters:
- - $ref: '#/components/parameters/id'
+ - $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/XiqRadioProfile'
+ $ref: '#/components/schemas/PagedXiqEndUser'
default:
$ref: '#/components/responses/ErrorResponse'
security:
- BearerAuth: []
- put:
+ post:
tags:
- - Configuration - Policy
- summary: Update radio profile by ID
- description: Update the existing radio profile by the profile ID.
+ - 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#_update_radio_profile_configuration
- operationId: updateRadioProfile
- parameters:
- - $ref: '#/components/parameters/id'
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_create_end_user
+ operationId: createEndUser
requestBody:
- description: The payload of the update radio profile request.
+ description: Create end user request body
content:
application/json:
schema:
- $ref: '#/components/schemas/XiqUpdateRadioProfileRequest'
+ $ref: '#/components/schemas/XiqCreateEndUserRequest'
required: true
responses:
'200':
@@ -5170,172 +5130,163 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/XiqRadioProfile'
+ $ref: '#/components/schemas/XiqEndUser'
default:
$ref: '#/components/responses/ErrorResponse'
security:
- BearerAuth: []
- delete:
+ /endusers/{id}:
+ put:
tags:
- - Configuration - Policy
- summary: Delete radio profile by ID
- description: Delete the existing radio profile by the profile ID.
+ - 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#_delete_radio_profile_configuration
- operationId: deleteRadioProfile
+ 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: []
- /radio-profiles/channel-selection/{id}:
- get:
+ delete:
tags:
- - Configuration - Policy
- summary: Get channel selection settings
- description: Get the channel selection settings belonging to a radio profile.
+ - 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#_get_radio_profile_channel_selection_by_id
- operationId: getRpChannelSelection
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_delete_end_user
+ operationId: deleteSsidUser
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:
+ /endusers/{id}/:regenerate-password:
+ post:
tags:
- - Configuration - Policy
- summary: Update channel selection settings
- description: Update the channel selection settings belonging to a radio profile.
+ - 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#_update_radio_profile_channel_selection_by_id
- operationId: updateRpChannelSelection
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_regenerate_end_user_password
+ operationId: regenerateEndUserPassword
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'
+ $ref: '#/components/schemas/XiqRegenerateEndUserPasswordResponse'
default:
$ref: '#/components/responses/ErrorResponse'
security:
- BearerAuth: []
- /radio-profiles/mac-ouis:
+ /usergroups:
get:
tags:
- - Configuration - Policy
- summary: List MAC OUI profiles
- description: List a page of MAC OUI profiles.
+ - 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_mac_oui_profiles
- operationId: listRpMacOuiProfiles
+ 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/PagedXiqRpMacOuiProfile'
+ $ref: '#/components/schemas/PagedXiqUserGroup'
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.
+ - 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_mac_oui_profile_configuration
- operationId: createMacOuiProfile
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_create_user_group
+ operationId: createUserGroup
requestBody:
- description: The request body to create new user profile.
+ description: Create user group request body
content:
application/json:
schema:
- $ref: '#/components/schemas/XiqCreateRpMacOuiProfileRequest'
+ $ref: '#/components/schemas/XiqCreateUserGroupRequest'
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'
+ $ref: '#/components/schemas/XiqUserGroup'
default:
$ref: '#/components/responses/ErrorResponse'
security:
- BearerAuth: []
+ /usergroups/{id}:
put:
tags:
- - Configuration - Policy
- summary: Update MAC OUI profile
- description: Update the existing MAC OUI profile for radio usage optimization.
+ - 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_mac_oui_profile_by_id
- operationId: updateRpMacOuiProfile
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_update_user_group
+ operationId: updateUserGroup
parameters:
- $ref: '#/components/parameters/id'
requestBody:
- description: The payload of the update MAC OUI profile request.
+ description: Update user-group request body
content:
application/json:
schema:
- $ref: '#/components/schemas/XiqUpdateRpMacOuiProfileRequest'
+ $ref: '#/components/schemas/XiqUpdateUserGroupRequest'
required: true
responses:
'200':
@@ -5343,20 +5294,20 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/XiqRpMacOuiProfile'
+ $ref: '#/components/schemas/XiqUserGroup'
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.
+ - 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_mac_oui_profile_by_id
- operationId: deleteRpMacOuiProfile
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_delete_user_group
+ operationId: deleteUserGroup
parameters:
- $ref: '#/components/parameters/id'
responses:
@@ -5366,254 +5317,293 @@ paths:
$ref: '#/components/responses/ErrorResponse'
security:
- BearerAuth: []
- /radio-profiles/miscellaneous/{id}:
+ /pcgs/key-based:
get:
tags:
- - Configuration - Policy
- summary: Get radio miscellaneous settings
- description: Get the radio miscellaneous settings belonging to a radio profile.
+ - 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#_get_radio_miscellaneous_settings_by_id
- operationId: getRpMiscellaneousSettings
- parameters:
- - $ref: '#/components/parameters/id'
+ 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:
- $ref: '#/components/schemas/XiqRpMiscellaneousSettings'
+ type: array
+ items:
+ $ref: '#/components/schemas/XiqKeyBasedPcg'
default:
$ref: '#/components/responses/ErrorResponse'
security:
- BearerAuth: []
- put:
+ post:
tags:
- - Configuration - Policy
- summary: Update radio miscellaneous settings
- description: Update the radio miscellaneous settings belonging to a radio profile.
+ - 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#_update_radio_miscellaneous_settings_by_id
- operationId: updateRpMiscellaneousSettings
- parameters:
- - $ref: '#/components/parameters/id'
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_initiate_key_based_pcg
+ operationId: setupKeyBasedPrivateClientGroupNetworkPolicy
requestBody:
- description: The payload of the update radio miscellaneous settings request.
+ description: The request to setup Key-based PCG network policy
content:
application/json:
schema:
- $ref: '#/components/schemas/XiqUpdateRpMiscellaneousSettingsRequest'
+ $ref: '#/components/schemas/XiqInitKeyBasedPcgNetworkPolicyRequest'
required: true
responses:
- '200':
- description: OK
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/XiqRpMiscellaneousSettings'
+ '202':
+ description: Accepted
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.
+ /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#_get_radio_profile_neighborhood_analysis_by_id
- operationId: getNeighborhoodAnalysis
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_create_key_based_pcg_data
+ operationId: onboardKeyBasedPrivateClientGroup
parameters:
- - $ref: '#/components/parameters/id'
+ - 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:
- '200':
- description: OK
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/XiqRpNeighborhoodAnalysis'
+ '202':
+ description: Accepted
default:
$ref: '#/components/responses/ErrorResponse'
security:
- BearerAuth: []
- put:
+ /pcgs/key-based/network-policy-{policyId}:
+ delete:
tags:
- - Configuration - Policy
- summary: Update neighborhood analysis settings
- description: Update the neighborhood analysis settings belonging to a radio profile.
+ - 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#_update_radio_profile_neighborhood_analysis_by_id
- operationId: updateNeighborhoodAnalysis
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_delete_key_based_pcg
+ operationId: deletePcg
parameters:
- - $ref: '#/components/parameters/id'
- requestBody:
- description: The payload of the update neighborhood analysis settings request.
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/XiqUpdateRpNeighborhoodAnalysisRequest'
+ - 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:
- '200':
- description: OK
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/XiqRpNeighborhoodAnalysis'
+ '202':
+ description: Accepted
default:
$ref: '#/components/responses/ErrorResponse'
security:
- BearerAuth: []
- /radio-profiles/radio-usage-opt/{id}:
+ /pcgs/key-based/network-policy-{policyId}/users:
get:
tags:
- - Configuration - Policy
- summary: Get radio usage optimization settings
- description: Get the radio usage optimization settings belonging to a radio profile.
+ - 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_radio_usage_optimization_by_id
- operationId: getRpRadioUsageOptimization
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_get_key_based_pcg_users_from_given_network_policy_id
+ operationId: getKeyBasedPcgUsers
parameters:
- - $ref: '#/components/parameters/id'
+ - 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/XiqRpRadioUsageOptimization'
+ type: array
+ items:
+ $ref: '#/components/schemas/XiqKeyBasedPcgUser'
default:
$ref: '#/components/responses/ErrorResponse'
security:
- BearerAuth: []
- put:
+ post:
tags:
- - Configuration - Policy
- summary: Update radio usage optimization settings
- description: Update the radio usage optimization settings belonging to a radio profile.
+ - 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#_update_radio_usage_optimization_by_id
- operationId: updateRpRadioUsageOptimization
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_add_key_based_pcg_users_to_an_exists_key_based_pcg
+ operationId: addKeyBasedPcgUsers
parameters:
- - $ref: '#/components/parameters/id'
+ - name: policyId
+ in: path
+ description: The network policy ID
+ required: true
+ schema:
+ type: integer
+ format: int64
requestBody:
- description: The payload of the update radio usage optimization settings request.
+ description: The payload of add users to PCG-enabled network policy
content:
application/json:
schema:
- $ref: '#/components/schemas/XiqUpdateRpRadioUsageOptimizationRequest'
+ $ref: '#/components/schemas/XiqCreateKeyBasedPcgUsersRequest'
required: true
responses:
- '200':
- description: OK
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/XiqRpRadioUsageOptimization'
+ '202':
+ description: Accepted
default:
$ref: '#/components/responses/ErrorResponse'
security:
- BearerAuth: []
- /radio-profiles/sensor-scan/{id}:
- get:
+ put:
tags:
- - Configuration - Policy
- summary: Get sensor scan settings
- description: Get the sensor scan settings belonging to a radio profile.
+ - 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#_get_sensor_scan_settings_by_id
- operationId: getRpSensorScanSettings
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_replace_all_key_based_pcg_users
+ operationId: updateKeyBasedPcgUsers
parameters:
- - $ref: '#/components/parameters/id'
+ - 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:
- '200':
- description: OK
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/XiqRpSensorScanSettings'
+ '202':
+ description: Accepted
default:
$ref: '#/components/responses/ErrorResponse'
security:
- BearerAuth: []
- put:
+ delete:
tags:
- - Configuration - Policy
- summary: Update sensor scan settings
- description: Update the sensor scan settings belonging to a radio profile.
+ - 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#_update_sensor_scan_settings_by_id
- operationId: updateRpSensorScanSettings
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_delete_key_based_pcg_users
+ operationId: deleteKeyBasedPcgUsers
parameters:
- - $ref: '#/components/parameters/id'
+ - name: policyId
+ in: path
+ description: The network policy ID
+ required: true
+ schema:
+ type: integer
+ format: int64
requestBody:
- description: The payload of the update sensor scan settings request.
+ description: The payload of delete Key-based PCG users request
content:
application/json:
schema:
- $ref: '#/components/schemas/XiqUpdateRpSensorScanSettingsRequest'
+ $ref: '#/components/schemas/XiqDeleteKeyBasedPcgUsersRequest'
required: true
responses:
- '200':
- description: OK
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/XiqRpSensorScanSettings'
+ '202':
+ description: Accepted
default:
$ref: '#/components/responses/ErrorResponse'
security:
- BearerAuth: []
- /radio-profiles/wmm-qos/{id}:
+ /pcgs/key-based/network-policy-{policyId}/port-assignments:
get:
tags:
- - Configuration - Policy
- summary: Get Wmm QoS settings
- description: Get the Wi-Fi Multimedia (WMM) QoS settings belonging to a radio profile.
+ - 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_wmm_qos_settings_by_id
- operationId: getRpWmmQosSettings
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_get_port_assignment_details_of_ap150w
+ operationId: getPortAssignments
parameters:
- - $ref: '#/components/parameters/id'
+ - 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/XiqRpWmmQosSettings'
+ $ref: '#/components/schemas/XiqGetPortAssignmentDetailsResponse'
default:
$ref: '#/components/responses/ErrorResponse'
security:
- BearerAuth: []
- put:
+ post:
tags:
- - Configuration - Policy
- summary: Update Wmm QoS settings
- description: Update the Wi-Fi Multimedia (WMM) QoS settings belonging to a radio profile.
+ - 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#_update_wmm_qos_settings_by_id
- operationId: updateRpWmmQosSettings
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_assign_ports_for_ap150w
+ operationId: assignPorts
parameters:
- - $ref: '#/components/parameters/id'
+ - name: policyId
+ in: path
+ description: The network policy ID
+ required: true
+ schema:
+ type: integer
+ format: int64
requestBody:
- description: The payload of the update Wmm QoS settings request.
+ description: The payload of assign ports for devices
content:
application/json:
schema:
- $ref: '#/components/schemas/XiqUpdateRpWmmQosSettingsRequest'
+ $ref: '#/components/schemas/XiqPcgAssignPortsRequest'
required: true
responses:
'200':
@@ -5621,21 +5611,89 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/XiqRpWmmQosSettings'
+ $ref: '#/components/schemas/XiqPcgAssignPortsResponse'
default:
$ref: '#/components/responses/ErrorResponse'
security:
- BearerAuth: []
- /user-profiles:
- get:
+ /pcgs/key-based/network-policy-{policyId}/keys/:generate:
+ post:
tags:
- - Configuration - Policy
- summary: List user profiles
- description: List a page of user profiles.
+ - 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#_list_the_user_profiles
- operationId: listUserProfiles
+ 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'
@@ -5645,7 +5703,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PagedXiqUserProfile'
+ $ref: '#/components/schemas/PagedXiqClassificationRule'
default:
$ref: '#/components/responses/ErrorResponse'
security:
@@ -5653,18 +5711,18 @@ paths:
post:
tags:
- Configuration - Policy
- summary: Create a user profile
- description: Create a new user profile.
+ summary: Create classification rule
+ description: Create a new classification rule.
externalDocs:
description: API Reference
- url: https://extremecloudiq.com/api-docs/api-reference.html#_create_user_profile_configuration
- operationId: createUserProfile
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_create_classification_rule_configuration
+ operationId: createClassificationRule
requestBody:
- description: The request body to create new user profile.
+ description: The payload to create a new classification rule
content:
application/json:
schema:
- $ref: '#/components/schemas/XiqCreateUserProfileRequest'
+ $ref: '#/components/schemas/XiqCreateClassificationRuleRequest'
required: true
responses:
'201':
@@ -5672,21 +5730,21 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/XiqUserProfile'
+ $ref: '#/components/schemas/XiqClassificationRule'
default:
$ref: '#/components/responses/ErrorResponse'
security:
- BearerAuth: []
- /user-profiles/{id}:
+ /classification-rules/{id}:
get:
tags:
- Configuration - Policy
- summary: Get user profile by ID
- description: Get user profile details for the specified ID.
+ 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_user_profile_by_id
- operationId: getUserProfile
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_get_classification_rule_by_id
+ operationId: getClassificationRule
parameters:
- $ref: '#/components/parameters/id'
responses:
@@ -5695,7 +5753,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/XiqUserProfile'
+ $ref: '#/components/schemas/XiqClassificationRule'
default:
$ref: '#/components/responses/ErrorResponse'
security:
@@ -5703,20 +5761,20 @@ paths:
put:
tags:
- Configuration - Policy
- summary: Update user profile
- description: Update an existing user profile.
+ summary: Update classification rule
+ description: Update the exist classification rule.
externalDocs:
description: API Reference
- url: https://extremecloudiq.com/api-docs/api-reference.html#_update_user_profile_configuration
- operationId: updateCoUserProfile
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_update_classification_rule_configuration
+ operationId: updateClassificationRule
parameters:
- $ref: '#/components/parameters/id'
requestBody:
- description: The payload of user profile.
+ description: The payload to update exist classification rule
content:
application/json:
schema:
- $ref: '#/components/schemas/XiqUpdateUserProfileRequest'
+ $ref: '#/components/schemas/XiqUpdateClassificationRuleRequest'
required: true
responses:
'200':
@@ -5724,7 +5782,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/XiqUserProfile'
+ $ref: '#/components/schemas/XiqClassificationRule'
default:
$ref: '#/components/responses/ErrorResponse'
security:
@@ -5732,12 +5790,12 @@ paths:
delete:
tags:
- Configuration - Policy
- summary: Delete an user profile by ID
- description: Delete an existing user profile by ID.
+ 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_user_profile_configuration
- operationId: deleteCoUserProfile
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_delete_classification_rule_configuration
+ operationId: deleteClassificationRule
parameters:
- $ref: '#/components/parameters/id'
responses:
@@ -5747,16 +5805,52 @@ paths:
$ref: '#/components/responses/ErrorResponse'
security:
- BearerAuth: []
- /ssids:
+ /l3-address-profiles:
get:
tags:
- Configuration - Policy
- summary: List SSIDs
- description: List SSIDs with filter and pagination.
+ 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_ssids
- operationId: listSsids
+ 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'
@@ -5766,101 +5860,99 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PagedXiqSsid'
+ $ref: '#/components/schemas/PagedXiqRadioProfile'
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).
+ summary: Create a radio profile
+ description: Create a new radio profile.
externalDocs:
description: API Reference
- url: https://extremecloudiq.com/api-docs/api-reference.html#_rename_ssidwireless_name
- operationId: renameSsid
- parameters:
- - $ref: '#/components/parameters/id'
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_create_radio_profile_configuration
+ operationId: createRadioProfile
requestBody:
- description: The new SSID name
+ description: The request body to create new user profile.
content:
application/json:
schema:
- type: string
+ $ref: '#/components/schemas/XiqCreateRadioProfileRequest'
required: true
responses:
- '200':
- description: OK
+ '201':
+ description: Created
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/XiqRadioProfile'
default:
$ref: '#/components/responses/ErrorResponse'
security:
- BearerAuth: []
- /ssids/{id}/cwp/:attach:
- post:
+ /radio-profiles/{id}:
+ get:
tags:
- Configuration - Policy
- summary: Attach CWP to an SSID
- description: Attach CWP to an SSID.
+ 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#_attach_cwp_to_an_ssid
- operationId: attachCwpToSsid
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_get_radio_profile_by_id
+ operationId: getRadioProfile
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
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/XiqRadioProfile'
default:
$ref: '#/components/responses/ErrorResponse'
security:
- BearerAuth: []
- /ssids/{id}/cwp/:enable:
- post:
+ put:
tags:
- Configuration - Policy
- summary: Enable and attach the CWP on the SSID
- description: Enable and attach the CWP on the SSID.
+ 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#_enable_and_attach_the_cwp_on_the_ssid
- operationId: enableSsidCwp
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_update_radio_profile_configuration
+ operationId: updateRadioProfile
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.
+ description: The payload of the update radio profile request.
content:
application/json:
schema:
- type: integer
- format: int64
+ $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: []
- /ssids/{id}/cwp/:disable:
- post:
+ delete:
tags:
- Configuration - Policy
- summary: Disable the CWP on the SSID
- description: Disable the CWP on the SSID.
+ 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#_disable_and_detach_the_cwp_on_the_ssid
- operationId: disableSsidCwp
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_delete_radio_profile_configuration
+ operationId: deleteRadioProfile
parameters:
- $ref: '#/components/parameters/id'
responses:
@@ -5870,148 +5962,172 @@ paths:
$ref: '#/components/responses/ErrorResponse'
security:
- BearerAuth: []
- /ssids/{id}/mode/dot1x:
- put:
+ /radio-profiles/channel-selection/{id}:
+ get:
tags:
- Configuration - Policy
- summary: Change the SSID mode to 802.1x
- description: Change the SSID mode to 802.1x.
+ 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#_set_ssid_mode_to_dot1x
- operationId: setSsidModeDot1x
+ 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 to change the SSID mode to 802.1x
+ description: The payload of the update channel selection settings request.
content:
application/json:
schema:
- $ref: '#/components/schemas/XiqSetSsidModeDot1xRequest'
+ $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: []
- /ssids/{id}/mode/open:
- put:
+ /radio-profiles/mac-ouis:
+ get:
tags:
- Configuration - Policy
- summary: Change the SSID mode to open access
- description: Change the SSID mode to open access.
+ 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#_set_ssid_mode_to_open_access
- operationId: setSsidModeOpen
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_list_mac_oui_profiles
+ operationId: listRpMacOuiProfiles
parameters:
- - $ref: '#/components/parameters/id'
+ - $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: []
- /ssids/{id}/mode/psk:
- put:
+ post:
tags:
- Configuration - Policy
- summary: Change the SSID mode to PSK
- description: Change the SSID mode to PSK.
+ 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#_set_ssid_mode_to_psk
- operationId: setSsidModePsk
- parameters:
- - $ref: '#/components/parameters/id'
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_create_mac_oui_profile_configuration
+ operationId: createMacOuiProfile
requestBody:
- description: The payload to change the SSID mode to PSK
+ description: The request body to create new user profile.
content:
application/json:
schema:
- $ref: '#/components/schemas/XiqSetSsidModePskRequest'
+ $ref: '#/components/schemas/XiqCreateRpMacOuiProfileRequest'
required: true
responses:
- '200':
- description: OK
+ '201':
+ description: Created
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/XiqRpMacOuiProfile'
default:
$ref: '#/components/responses/ErrorResponse'
security:
- BearerAuth: []
- /ssids/{id}/mode/ppsk:
- put:
+ /radio-profiles/mac-ouis/{id}:
+ get:
tags:
- Configuration - Policy
- summary: Change the SSID mode to PPSK
- description: Change the SSID mode to PPSK.
+ 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#_set_ssid_mode_to_ppsk
- operationId: setSsidModePpsk
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_get_mac_oui_profile_by_id
+ operationId: getRpMacOuiProfile
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
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/XiqRpMacOuiProfile'
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.
+ 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#_set_ssid_mode_to_wep
- operationId: setSsidModeWep
+ 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 to change the SSID mode to WEP
+ description: The payload of the update MAC OUI profile request.
content:
application/json:
schema:
- $ref: '#/components/schemas/XiqSetSsidModeWepRequest'
+ $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: []
- /ssids/{id}/psk/password:
- put:
+ delete:
tags:
- Configuration - Policy
- summary: Change the SSID PSK password
- description: Change the SSID PSK password.
+ 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#_change_the_ssid_psk_password
- operationId: changePskPassword
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_delete_mac_oui_profile_by_id
+ operationId: deleteRpMacOuiProfile
parameters:
- $ref: '#/components/parameters/id'
- requestBody:
- description: The new SSID PSK password
- content:
- application/json:
- schema:
- type: string
- required: true
responses:
'200':
description: OK
@@ -6019,121 +6135,120 @@ paths:
$ref: '#/components/responses/ErrorResponse'
security:
- BearerAuth: []
- /ssids/{id}/radius-server-group/:attach:
- post:
+ /radio-profiles/miscellaneous/{id}:
+ get:
tags:
- Configuration - Policy
- summary: Attach radius server group to an SSID
- description: Attach radius server group to an SSID.
+ 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#_attach_radius_server_group_to_an_ssid
- operationId: attachRadiusServerGroupToSsid
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_get_radio_miscellaneous_settings_by_id
+ operationId: getRpMiscellaneousSettings
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
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/XiqRpMiscellaneousSettings'
default:
$ref: '#/components/responses/ErrorResponse'
security:
- BearerAuth: []
- /ssids/{id}/user-profile/:attach:
- post:
+ put:
tags:
- Configuration - Policy
- summary: Attach user profile to an SSID
- description: Attach user profile to an SSID.
+ 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#_attach_user_profile_to_an_ssid
- operationId: attachUserProfileToSsid
+ 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 user profile ID to be attached to the SSID
+ description: The payload of the update radio miscellaneous settings request.
content:
application/json:
schema:
- type: integer
- format: int64
+ $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: []
- /ccgs:
+ /radio-profiles/neighborhood-analysis/{id}:
get:
tags:
- Configuration - Policy
- summary: List clould config groups
- description: List a papge of cloud config groups.
+ 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#_list_cloud_config_groups
- operationId: listCloudConfigGroups
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_get_radio_profile_neighborhood_analysis_by_id
+ operationId: getNeighborhoodAnalysis
parameters:
- - $ref: '#/components/parameters/page'
- - $ref: '#/components/parameters/limit'
+ - $ref: '#/components/parameters/id'
responses:
'200':
description: OK
content:
application/json:
schema:
- $ref: '#/components/schemas/PagedXiqCloudConfigGroup'
+ $ref: '#/components/schemas/XiqRpNeighborhoodAnalysis'
default:
$ref: '#/components/responses/ErrorResponse'
security:
- BearerAuth: []
- post:
+ put:
tags:
- Configuration - Policy
- summary: Create new cloud config group
- description: Create a new cloud config group.
+ 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#_create_cloud_config_group
- operationId: createCloudConfigGroup
+ 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: Create new cloud config group request body
+ description: The payload of the update neighborhood analysis settings request.
content:
application/json:
schema:
- $ref: '#/components/schemas/XiqCreateCloudConfigGroupRequest'
+ $ref: '#/components/schemas/XiqUpdateRpNeighborhoodAnalysisRequest'
required: true
responses:
- '201':
- description: Created
+ '200':
+ description: OK
content:
application/json:
schema:
- $ref: '#/components/schemas/XiqCloudConfigGroup'
+ $ref: '#/components/schemas/XiqRpNeighborhoodAnalysis'
default:
$ref: '#/components/responses/ErrorResponse'
security:
- BearerAuth: []
- /ccgs/{id}:
+ /radio-profiles/radio-usage-opt/{id}:
get:
tags:
- Configuration - Policy
- summary: Get a cloud config group
- description: Get cloud config group info for the specified ID.
+ 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_cloud_config_group
- operationId: getCloudConfigGroup
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_get_radio_usage_optimization_by_id
+ operationId: getRpRadioUsageOptimization
parameters:
- $ref: '#/components/parameters/id'
responses:
@@ -6142,7 +6257,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/XiqCloudConfigGroup'
+ $ref: '#/components/schemas/XiqRpRadioUsageOptimization'
default:
$ref: '#/components/responses/ErrorResponse'
security:
@@ -6150,20 +6265,20 @@ paths:
put:
tags:
- Configuration - Policy
- summary: Update cloud config group information
- description: Update the cloud config group details having the specified ID.
+ 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_cloud_config_group
- operationId: updateCloudConfigGroup
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_update_radio_usage_optimization_by_id
+ operationId: updateRpRadioUsageOptimization
parameters:
- $ref: '#/components/parameters/id'
requestBody:
- description: Update cloud config group request body
+ description: The payload of the update radio usage optimization settings request.
content:
application/json:
schema:
- $ref: '#/components/schemas/XiqUpdateCloudConfigGroupRequest'
+ $ref: '#/components/schemas/XiqUpdateRpRadioUsageOptimizationRequest'
required: true
responses:
'200':
@@ -6171,90 +6286,73 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/XiqCloudConfigGroup'
+ $ref: '#/components/schemas/XiqRpRadioUsageOptimization'
default:
$ref: '#/components/responses/ErrorResponse'
security:
- BearerAuth: []
- delete:
+ /radio-profiles/sensor-scan/{id}:
+ get:
tags:
- Configuration - Policy
- summary: Delete a cloud config group
- description: Delete a specific cloud config group by ID.
+ 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#_delete_cloud_config_group
- operationId: deleteCloudConfigGroup
+ 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
- default:
- $ref: '#/components/responses/ErrorResponse'
- security:
- - BearerAuth: []
- /iot-profiles:
- get:
- tags:
- - Configuration - Policy
- summary: List IoT profiles
- description: List a page of IoT profiles.
- externalDocs:
- description: API Reference
- url: https://extremecloudiq.com/api-docs/api-reference.html#_list_the_iot_profiles
- operationId: listIotProfiles
- parameters:
- - $ref: '#/components/parameters/page'
- - $ref: '#/components/parameters/limit'
responses:
'200':
description: OK
content:
application/json:
schema:
- $ref: '#/components/schemas/PagedXiqIotProfile'
+ $ref: '#/components/schemas/XiqRpSensorScanSettings'
default:
$ref: '#/components/responses/ErrorResponse'
security:
- BearerAuth: []
- post:
+ put:
tags:
- Configuration - Policy
- summary: Create an IoT profile
- description: Create a new IoT profile.
+ 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#_create_iot_profile_configuration
- operationId: createIotProfile
+ 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 request body to create new IoT profile.
+ description: The payload of the update sensor scan settings request.
content:
application/json:
schema:
- $ref: '#/components/schemas/XiqIotProfileRequest'
+ $ref: '#/components/schemas/XiqUpdateRpSensorScanSettingsRequest'
required: true
responses:
- '201':
- description: Created
+ '200':
+ description: OK
content:
application/json:
schema:
- $ref: '#/components/schemas/XiqIotProfile'
+ $ref: '#/components/schemas/XiqRpSensorScanSettings'
default:
$ref: '#/components/responses/ErrorResponse'
security:
- BearerAuth: []
- /iot-profiles/{id}:
+ /radio-profiles/wmm-qos/{id}:
get:
tags:
- Configuration - Policy
- summary: Get IoT profile by ID
- description: Get IoT profile details for the specified ID.
+ 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_iot_profile_by_id
- operationId: getIotProfile
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_get_wmm_qos_settings_by_id
+ operationId: getRpWmmQosSettings
parameters:
- $ref: '#/components/parameters/id'
responses:
@@ -6263,7 +6361,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/XiqIotProfile'
+ $ref: '#/components/schemas/XiqRpWmmQosSettings'
default:
$ref: '#/components/responses/ErrorResponse'
security:
@@ -6271,20 +6369,20 @@ paths:
put:
tags:
- Configuration - Policy
- summary: Update IoT profile by ID
- description: Update the existing IoT profile by the profile ID.
+ 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_iot_profile_configuration
- operationId: updateIotProfile
+ 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 IoT profile request.
+ description: The payload of the update Wmm QoS settings request.
content:
application/json:
schema:
- $ref: '#/components/schemas/XiqIotProfileRequest'
+ $ref: '#/components/schemas/XiqUpdateRpWmmQosSettingsRequest'
required: true
responses:
'200':
@@ -6292,87 +6390,21 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/XiqIotProfile'
- default:
- $ref: '#/components/responses/ErrorResponse'
- security:
- - BearerAuth: []
- delete:
- tags:
- - Configuration - Policy
- summary: Delete IoT profile by ID
- description: Delete the existing IoT profile by the profile ID.
- externalDocs:
- description: API Reference
- url: https://extremecloudiq.com/api-docs/api-reference.html#_delete_iot_profile_configuration
- operationId: deleteIotProfile
- parameters:
- - $ref: '#/components/parameters/id'
- responses:
- '200':
- description: OK
- default:
- $ref: '#/components/responses/ErrorResponse'
- security:
- - BearerAuth: []
- /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'
+ $ref: '#/components/schemas/XiqRpWmmQosSettings'
default:
$ref: '#/components/responses/ErrorResponse'
security:
- BearerAuth: []
- /ldap-servers:
+ /user-profiles:
get:
tags:
- - Configuration - Authentication
- summary: List LDAP servers
- description: List a page of LDAP servers.
+ - 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_ldap_servers
- operationId: listLdapServers
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_list_the_user_profiles
+ operationId: listUserProfiles
parameters:
- $ref: '#/components/parameters/page'
- $ref: '#/components/parameters/limit'
@@ -6382,46 +6414,26 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PagedXiqLdapServer'
+ $ref: '#/components/schemas/PagedXiqUserProfile'
default:
$ref: '#/components/responses/ErrorResponse'
security:
- BearerAuth: []
post:
tags:
- - Configuration - Authentication
- summary: Create LDAP server
- description: Create a new LDAP server.
+ - 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_ldap_server
- operationId: createLdapServer
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_create_user_profile_configuration
+ operationId: createUserProfile
requestBody:
- description: The body of create LDAP server API
+ description: The request body to create new user profile.
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: ''
+ $ref: '#/components/schemas/XiqCreateUserProfileRequest'
required: true
responses:
'201':
@@ -6429,21 +6441,21 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/XiqLdapServer'
+ $ref: '#/components/schemas/XiqUserProfile'
default:
$ref: '#/components/responses/ErrorResponse'
security:
- BearerAuth: []
- /ldap-servers/{id}:
+ /user-profiles/{id}:
get:
tags:
- - Configuration - Authentication
- summary: Get LDAP server by ID
- description: Get a specific LDAP server by ID.
+ - 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_ldap_server
- operationId: getLdapServer
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_get_user_profile_by_id
+ operationId: getUserProfile
parameters:
- $ref: '#/components/parameters/id'
responses:
@@ -6452,28 +6464,28 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/XiqLdapServer'
+ $ref: '#/components/schemas/XiqUserProfile'
default:
$ref: '#/components/responses/ErrorResponse'
security:
- BearerAuth: []
put:
tags:
- - Configuration - Authentication
- summary: Update LDAP server configuration
- description: Update configuration for a specific LDAP server.
+ - 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_ldap_server
- operationId: updateLdapServer
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_update_user_profile_configuration
+ operationId: updateCoUserProfile
parameters:
- $ref: '#/components/parameters/id'
requestBody:
- description: The body of update LDAP server API
+ description: The payload of user profile.
content:
application/json:
schema:
- $ref: '#/components/schemas/XiqUpdateLdapServerRequest'
+ $ref: '#/components/schemas/XiqUpdateUserProfileRequest'
required: true
responses:
'200':
@@ -6481,20 +6493,20 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/XiqLdapServer'
+ $ref: '#/components/schemas/XiqUserProfile'
default:
$ref: '#/components/responses/ErrorResponse'
security:
- BearerAuth: []
delete:
tags:
- - Configuration - Authentication
- summary: Delete a LDAP server
- description: Delete a specific LDAP server by ID.
+ - 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_ldap_server
- operationId: deleteLdapServer
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_delete_user_profile_configuration
+ operationId: deleteCoUserProfile
parameters:
- $ref: '#/components/parameters/id'
responses:
@@ -6504,16 +6516,16 @@ paths:
$ref: '#/components/responses/ErrorResponse'
security:
- BearerAuth: []
- /radius-client-objects:
+ /ssids:
get:
tags:
- - Configuration - Authentication
- summary: List RADIUS client objects
- description: List a page of RADIUS client object configurations.
+ - 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_the_radius_client_objects_configuration
- operationId: listRadiusClientObjects
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_list_ssids
+ operationId: listSsids
parameters:
- $ref: '#/components/parameters/page'
- $ref: '#/components/parameters/limit'
@@ -6523,78 +6535,56 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PagedXiqRadiusClientObject'
+ $ref: '#/components/schemas/PagedXiqSsid'
default:
$ref: '#/components/responses/ErrorResponse'
security:
- BearerAuth: []
+ /ssids/{id}/:rename:
post:
tags:
- - Configuration - Authentication
- summary: Create RADIUS client object configuration
- description: Create a new RADIUS client object configuration.
+ - 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#_create_radius_client_object_configuration
- operationId: createRadiusClientObject
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_rename_ssidwireless_name
+ operationId: renameSsid
+ parameters:
+ - $ref: '#/components/parameters/id'
requestBody:
- description: Use the payload configuration to create a new RADIUS client object
+ description: The new SSID name
content:
application/json:
schema:
- $ref: '#/components/schemas/XiqCreateRadiusClientObjectRequest'
+ type: string
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:
+ /ssids/{id}/cwp/:attach:
+ post:
tags:
- - Configuration - Authentication
- summary: Update RADIUS client object configuration
- description: Update RADIUS client object configuration by ID.
+ - 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#_update_radius_client_object_configuration
- operationId: updateRadiusClientObject
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_attach_cwp_to_an_ssid
+ operationId: attachCwpToSsid
parameters:
- $ref: '#/components/parameters/id'
requestBody:
- description: The payload to update the RADIUS client object
+ 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:
- $ref: '#/components/schemas/XiqUpdateRadiusClientObjectRequest'
+ type: integer
+ format: int64
required: true
responses:
'200':
@@ -6603,17 +6593,26 @@ paths:
$ref: '#/components/responses/ErrorResponse'
security:
- BearerAuth: []
- delete:
+ /ssids/{id}/cwp/:enable:
+ post:
tags:
- - Configuration - Authentication
- summary: Delete a RADIUS client object configuration
- description: Delete an existing RADIUS client object configuration by ID.
+ - 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#_delete_radius_client_object_configuration
- operationId: deleteRadiusClientObject
+ 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
@@ -6621,145 +6620,115 @@ paths:
$ref: '#/components/responses/ErrorResponse'
security:
- BearerAuth: []
- /radius-proxies:
- get:
+ /ssids/{id}/cwp/:disable:
+ post:
tags:
- - Configuration - Authentication
- summary: List RADIUS proxies
- description: List a page of RADIUS proxy configurations.
+ - 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#_list_the_radius_proxy_configuration
- operationId: listRadiusProxies
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_disable_and_detach_the_cwp_on_the_ssid
+ operationId: disableSsidCwp
parameters:
- - $ref: '#/components/parameters/page'
- - $ref: '#/components/parameters/limit'
+ - $ref: '#/components/parameters/id'
responses:
'200':
description: OK
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/PagedXiqRadiusProxy'
default:
$ref: '#/components/responses/ErrorResponse'
security:
- BearerAuth: []
- post:
+ /ssids/{id}/mode/dot1x:
+ put:
tags:
- - Configuration - Authentication
- summary: Create RADIUS proxy configuration
- description: Create a new RADIUS proxy configuration.
+ - 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#_create_radius_proxy_configuration
- operationId: createRadiusProxy
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_set_ssid_mode_to_dot1x
+ operationId: setSsidModeDot1x
+ parameters:
+ - $ref: '#/components/parameters/id'
requestBody:
- description: The body of create RADIUS proxy API
+ description: The payload to change the SSID mode to 802.1x
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
+ $ref: '#/components/schemas/XiqSetSsidModeDot1xRequest'
required: true
responses:
- '201':
- description: Created
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/XiqRadiusProxy'
+ '200':
+ description: OK
default:
$ref: '#/components/responses/ErrorResponse'
security:
- BearerAuth: []
- /radius-proxies/{id}:
- get:
+ /ssids/{id}/mode/open:
+ put:
tags:
- - Configuration - Authentication
- summary: Get the RADIUS proxy configuration
- description: Get an existing RADIUS proxy configuration by ID.
+ - 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#_get_the_radius_proxy_configuration_by_id
- operationId: getRadiusProxy
+ 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
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/XiqRadiusProxy'
default:
$ref: '#/components/responses/ErrorResponse'
security:
- BearerAuth: []
+ /ssids/{id}/mode/psk:
put:
tags:
- - Configuration - Authentication
- summary: Update RADIUS proxy configuration
- description: Update RADIUS proxy configuration by ID.
+ - 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#_update_radius_proxy_configuration
- operationId: updateRadiusProxy
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_set_ssid_mode_to_psk
+ operationId: setSsidModePsk
parameters:
- $ref: '#/components/parameters/id'
requestBody:
- description: The body of update RADIUS proxy API
+ description: The payload to change the SSID mode to PSK
content:
application/json:
schema:
- $ref: '#/components/schemas/XiqUpdateRadiusProxyRequest'
+ $ref: '#/components/schemas/XiqSetSsidModePskRequest'
required: true
responses:
'200':
description: OK
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/XiqRadiusProxy'
default:
$ref: '#/components/responses/ErrorResponse'
security:
- BearerAuth: []
- delete:
+ /ssids/{id}/mode/ppsk:
+ put:
tags:
- - Configuration - Authentication
- summary: Delete the RADIUS proxy configuration
- description: Delete an existing RADIUS proxy configuration by ID.
+ - 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#_delete_radius_proxy_configuration
- operationId: deleteRadiusProxy
+ 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
@@ -6767,185 +6736,243 @@ paths:
$ref: '#/components/responses/ErrorResponse'
security:
- BearerAuth: []
- /radius-proxies/devices:
- get:
+ /ssids/{id}/mode/wep:
+ put:
tags:
- - Configuration - Authentication
- summary: List Radius proxy devices
- operationId: listRadiusProxyDevices
- description: List devices for Radius Proxy.
+ - 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#_list_radius_proxy_devices
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_set_ssid_mode_to_wep
+ operationId: setSsidModeWep
parameters:
- - $ref: '#/components/parameters/page'
- - $ref: '#/components/parameters/limit'
+ - $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
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/PagedXiqInternalRadiusDevice'
default:
$ref: '#/components/responses/ErrorResponse'
security:
- BearerAuth: []
- /radius-servers/internal:
- get:
+ /ssids/{id}/psk/password:
+ put:
tags:
- - Configuration - Authentication
- summary: List all internal RADIUS servers
- description: List all internal RADIUS servers configurations.
+ - 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#_list_the_internal_radius_servers
- operationId: listInternalRadiusServers
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_change_the_ssid_psk_password
+ operationId: changePskPassword
parameters:
- - $ref: '#/components/parameters/page'
- - $ref: '#/components/parameters/limit'
+ - $ref: '#/components/parameters/id'
+ requestBody:
+ description: The new SSID PSK password
+ content:
+ application/json:
+ schema:
+ type: string
+ required: true
responses:
'200':
description: OK
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/PagedXiqInternalRadiusServer'
default:
$ref: '#/components/responses/ErrorResponse'
security:
- BearerAuth: []
+ /ssids/{id}/radius-server-group/:attach:
post:
tags:
- - Configuration - Authentication
- summary: Create internal RADIUS server configuration
- description: Create a new internal RADIUS server configuration.
+ - 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#_create_internal_radius_server_configuration
- operationId: createInternalRadiusServer
+ 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: Use the payload configuration to create a new internal RADIUS server
+ description: The radius server group ID to be attached to the SSID
content:
application/json:
schema:
- $ref: '#/components/schemas/XiqCreateInternalRadiusServerRequest'
+ type: integer
+ format: int64
required: true
responses:
- '201':
- description: Created
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/XiqInternalRadiusServer'
+ '200':
+ description: OK
default:
$ref: '#/components/responses/ErrorResponse'
security:
- BearerAuth: []
- /radius-servers/internal/{id}:
- get:
+ /ssids/{id}/user-profile/:attach:
+ post:
tags:
- - Configuration - Authentication
- summary: Get internal RADIUS server by ID
- description: Get detailed configuration for internal RADIUS server by ID.
+ - 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#_list_the_internal_radius_server_by_id
- operationId: getInternalRadiusServer
+ 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/XiqInternalRadiusServer'
+ $ref: '#/components/schemas/PagedXiqCloudConfigGroup'
default:
$ref: '#/components/responses/ErrorResponse'
security:
- BearerAuth: []
- put:
+ post:
tags:
- - Configuration - Authentication
- summary: Update internal RADIUS server configuration
- description: Update internal RADIUS server configuration by ID.
+ - 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#_update_internal_radius_server_configuration
- operationId: updateInternalRadiusServer
- parameters:
- - $ref: '#/components/parameters/id'
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_create_cloud_config_group
+ operationId: createCloudConfigGroup
requestBody:
- description: The payload to update the internal RADIUS server
+ description: Create new cloud config group request body
content:
application/json:
schema:
- $ref: '#/components/schemas/XiqUpdateInternalRadiusServerRequest'
+ $ref: '#/components/schemas/XiqCreateCloudConfigGroupRequest'
required: true
responses:
- '200':
- description: OK
+ '201':
+ description: Created
content:
application/json:
schema:
- $ref: '#/components/schemas/XiqInternalRadiusServer'
+ $ref: '#/components/schemas/XiqCloudConfigGroup'
default:
$ref: '#/components/responses/ErrorResponse'
security:
- BearerAuth: []
- delete:
+ /ccgs/{id}:
+ get:
tags:
- - Configuration - Authentication
- summary: Delete internal RADIUS server configuration
- description: Delete an existing internal RADIUS server configuration by ID.
+ - 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#_delete_internal_radius_server_configuration
- operationId: deleteInternalRadiusServer
+ 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: []
- /radius-servers/internal/devices:
- get:
+ put:
tags:
- - Configuration - Authentication
- summary: List all internal RADIUS devices
- description: List all internal RADIUS devices fields.
+ - 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#_list_the_internal_radius_devices
- operationId: listInternalRadiusDevices
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_update_cloud_config_group
+ operationId: updateCloudConfigGroup
parameters:
- - $ref: '#/components/parameters/page'
- - $ref: '#/components/parameters/limit'
+ - $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/PagedXiqInternalRadiusDevice'
+ $ref: '#/components/schemas/XiqCloudConfigGroup'
default:
$ref: '#/components/responses/ErrorResponse'
security:
- BearerAuth: []
- /radius-servers/external:
+ delete:
+ tags:
+ - Configuration - Policy
+ summary: Delete a cloud config group
+ description: Delete a specific cloud config group by ID.
+ externalDocs:
+ description: API Reference
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_delete_cloud_config_group
+ operationId: deleteCloudConfigGroup
+ parameters:
+ - $ref: '#/components/parameters/id'
+ responses:
+ '200':
+ description: OK
+ default:
+ $ref: '#/components/responses/ErrorResponse'
+ security:
+ - BearerAuth: []
+ /iot-profiles:
get:
tags:
- - Configuration - Authentication
- summary: List external RADIUS servers
- description: List a page of external RADIUS server configurations.
+ - Configuration - Policy
+ summary: List IoT profiles
+ description: List a page of IoT profiles.
externalDocs:
description: API Reference
- url: https://extremecloudiq.com/api-docs/api-reference.html#_list_the_external_radius_servers
- operationId: listExternalRadiusServers
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_list_the_iot_profiles
+ operationId: listIotProfiles
parameters:
- $ref: '#/components/parameters/page'
- $ref: '#/components/parameters/limit'
@@ -6955,26 +6982,26 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PagedXiqExternalRadiusServer'
+ $ref: '#/components/schemas/PagedXiqIotProfile'
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.
+ - Configuration - Policy
+ summary: Create an IoT profile
+ description: Create a new IoT profile.
externalDocs:
description: API Reference
- url: https://extremecloudiq.com/api-docs/api-reference.html#_create_external_radius_server_configuration
- operationId: createExternalRadiusServer
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_create_iot_profile_configuration
+ operationId: createIotProfile
requestBody:
- description: Use the payload configuration to create a new external RADIUS server
+ description: The request body to create new IoT profile.
content:
application/json:
schema:
- $ref: '#/components/schemas/XiqCreateExternalRadiusServerRequest'
+ $ref: '#/components/schemas/XiqIotProfileRequest'
required: true
responses:
'201':
@@ -6982,21 +7009,21 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/XiqExternalRadiusServer'
+ $ref: '#/components/schemas/XiqIotProfile'
default:
$ref: '#/components/responses/ErrorResponse'
security:
- BearerAuth: []
- /radius-servers/external/{id}:
+ /iot-profiles/{id}:
get:
tags:
- - Configuration - Authentication
- summary: Get external RADIUS server by ID
- description: Get detailed configuration for a specific external RADIUS server.
+ - Configuration - Policy
+ summary: Get IoT profile by ID
+ description: Get IoT profile details for the specified ID.
externalDocs:
description: API Reference
- url: https://extremecloudiq.com/api-docs/api-reference.html#_list_the_external_radius_server_by_id
- operationId: getExternalRadiusServer
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_get_iot_profile_by_id
+ operationId: getIotProfile
parameters:
- $ref: '#/components/parameters/id'
responses:
@@ -7005,45 +7032,49 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/XiqExternalRadiusServer'
+ $ref: '#/components/schemas/XiqIotProfile'
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.
+ - Configuration - Policy
+ summary: Update IoT profile by ID
+ description: Update the existing IoT profile by the profile ID.
externalDocs:
description: API Reference
- url: https://extremecloudiq.com/api-docs/api-reference.html#_update_external_radius_server_configuration
- operationId: updateExternalRadiusServer
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_update_iot_profile_configuration
+ operationId: updateIotProfile
parameters:
- $ref: '#/components/parameters/id'
requestBody:
- description: The payload to update the external RADIUS server
+ description: The payload of the update IoT profile request.
content:
application/json:
schema:
- $ref: '#/components/schemas/XiqUpdateExternalRadiusServerRequest'
+ $ref: '#/components/schemas/XiqIotProfileRequest'
required: true
responses:
'200':
description: OK
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/XiqIotProfile'
default:
$ref: '#/components/responses/ErrorResponse'
security:
- BearerAuth: []
delete:
tags:
- - Configuration - Authentication
- summary: Delete external RADIUS server configuration
- description: Delete an existing external RADIUS server configuration by ID.
+ - Configuration - Policy
+ summary: Delete IoT profile by ID
+ description: Delete the existing IoT profile by the profile ID.
externalDocs:
description: API Reference
- url: https://extremecloudiq.com/api-docs/api-reference.html#_delete_external_radius_server_configuration
- operationId: deleteExternalRadiusServer
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_delete_iot_profile_configuration
+ operationId: deleteIotProfile
parameters:
- $ref: '#/components/parameters/id'
responses:
@@ -7053,1343 +7084,2340 @@ paths:
$ref: '#/components/responses/ErrorResponse'
security:
- BearerAuth: []
- /certificates:
+ /ad-servers:
get:
tags:
- - Configuration - Certificate
- summary: List certificates
- description: List a page of certificates.
+ - 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_certificates
- operationId: listCertificates
+ 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'
- - 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'
+ $ref: '#/components/schemas/PagedXiqActiveDirectoryServer'
default:
$ref: '#/components/responses/ErrorResponse'
security:
- BearerAuth: []
- /copilot/connectivity/wireless/experience:
+ /cwps:
get:
tags:
- - Copilot - Connectivity Experience
- summary: List Wireless Connectivity Experiences
- description: List a page of Quality-Index trends by selected view type.
+ - 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#_get_wireless_experience
- operationId: getWirelessExperience
- parameters:
- - $ref: '#/components/parameters/wirelessViewType'
- - $ref: '#/components/parameters/startTime'
- - $ref: '#/components/parameters/endTime'
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_list_captive_web_portals
+ operationId: listCaptiveWebPortals
+ parameters:
- $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'
+ $ref: '#/components/schemas/PagedXiqCwp'
default:
$ref: '#/components/responses/ErrorResponse'
security:
- BearerAuth: []
- /copilot/connectivity/wireless/quality-index:
+ /ldap-servers:
get:
tags:
- - Copilot - Connectivity Experience
- summary: Get Wireless Connectivity QualityIndex
- description: Get Quality-Index for a specific view type.
+ - 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#_get_wireless_quality_index
- operationId: getWirelessQualityIndex
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_list_ldap_servers
+ operationId: listLdapServers
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'
+ - $ref: '#/components/parameters/page'
+ - $ref: '#/components/parameters/limit'
responses:
'200':
description: OK
content:
application/json:
schema:
- $ref: '#/components/schemas/XiqCopilotWirelessQualityIndex'
+ $ref: '#/components/schemas/PagedXiqLdapServer'
default:
$ref: '#/components/responses/ErrorResponse'
security:
- BearerAuth: []
- /copilot/connectivity/wireless/time-to-connect:
- get:
+ post:
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.
+ - 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#_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'
+ 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:
- '200':
- description: OK
+ '201':
+ description: Created
content:
application/json:
schema:
- $ref: '#/components/schemas/XiqCopilotTimeToConnect'
+ $ref: '#/components/schemas/XiqLdapServer'
default:
$ref: '#/components/responses/ErrorResponse'
security:
- BearerAuth: []
- /copilot/connectivity/wireless/performance:
+ /ldap-servers/{id}:
get:
tags:
- - Copilot - Connectivity Experience
- summary: Get Wireless Connectivity Performance
- description: List a page of Performance score data over a selected period of time.
+ - 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_wireless_performance
- operationId: getWirelessPerformance
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_get_ldap_server
+ operationId: getLdapServer
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'
+ - $ref: '#/components/parameters/id'
responses:
'200':
description: OK
content:
application/json:
schema:
- $ref: '#/components/schemas/XiqCopilotPerformance'
+ $ref: '#/components/schemas/XiqLdapServer'
default:
$ref: '#/components/responses/ErrorResponse'
security:
- BearerAuth: []
- /copilot/connectivity/wireless/events:
- get:
+ put:
tags:
- - Copilot - Connectivity Experience
- summary: List Wireless Connectivity Events
- description: List a page of wireless events over a selected period of time.
+ - 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#_get_wireless_events
- operationId: getWirelessEvents
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_update_ldap_server
+ operationId: updateLdapServer
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'
+ - $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/XiqCopilotWirelessEvents'
+ $ref: '#/components/schemas/XiqLdapServer'
default:
$ref: '#/components/responses/ErrorResponse'
security:
- BearerAuth: []
- /copilot/connectivity/wireless/apps:
- get:
+ delete:
tags:
- - Copilot - Connectivity Experience
- summary: Get Wireless Connectivity Apps Info
- description: Get app statistics for a specific view type.
+ - 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#_get_wireless_apps
- operationId: getWirelessApps
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_delete_ldap_server
+ operationId: deleteLdapServer
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'
+ - $ref: '#/components/parameters/id'
responses:
'200':
description: OK
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/XiqCopilotWirelessApps'
default:
$ref: '#/components/responses/ErrorResponse'
security:
- BearerAuth: []
- /copilot/connectivity/wireless/views:
+ /radius-client-objects:
get:
tags:
- - Copilot - Connectivity Experience
- summary: Get Wireless Connectivity Views
- description: Get all the views for a selected view type.
+ - 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#_get_wireless_views
- operationId: getWirelessViews
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_list_the_radius_client_objects_configuration
+ operationId: listRadiusClientObjects
parameters:
- - $ref: '#/components/parameters/wirelessViewType'
+ - $ref: '#/components/parameters/page'
+ - $ref: '#/components/parameters/limit'
responses:
'200':
description: OK
content:
application/json:
schema:
- $ref: '#/components/schemas/XiqCopilotWirelessViewsList'
+ $ref: '#/components/schemas/PagedXiqRadiusClientObject'
default:
$ref: '#/components/responses/ErrorResponse'
security:
- BearerAuth: []
- /copilot/connectivity/wired/experience:
- get:
+ post:
tags:
- - Copilot - Connectivity Experience
- summary: List Wired Connectivity Experiences
- description: List a page of Quality-Index trends by selected view type.
+ - 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#_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'
+ 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:
- '200':
- description: OK
+ '201':
+ description: Created
content:
application/json:
schema:
- $ref: '#/components/schemas/XiqCopilotConnectivityExperience'
+ $ref: '#/components/schemas/XiqRadiusClientObject'
default:
$ref: '#/components/responses/ErrorResponse'
security:
- BearerAuth: []
- /copilot/connectivity/wired/quality-index:
+ /radius-client-objects/{id}:
get:
tags:
- - Copilot - Connectivity Experience
- summary: Get Wired Connectivity QualityIndex
- description: Get Quality-Index for a specific view type.
+ - 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#_get_wired_quality_index
- operationId: getWiredQualityIndex
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_list_the_radius_client_object_configuration_by_id
+ operationId: getRadiusClientObject
parameters:
- - $ref: '#/components/parameters/wiredViewType'
- - $ref: '#/components/parameters/wiredViewIdentifier'
- - $ref: '#/components/parameters/forensicBucket'
- - $ref: '#/components/parameters/startTime'
- - $ref: '#/components/parameters/endTime'
+ - $ref: '#/components/parameters/id'
responses:
'200':
description: OK
content:
application/json:
schema:
- $ref: '#/components/schemas/XiqCopilotWiredQualityIndex'
+ $ref: '#/components/schemas/XiqRadiusClientObject'
default:
$ref: '#/components/responses/ErrorResponse'
security:
- BearerAuth: []
- /copilot/connectivity/wired/hardware:
- get:
+ put:
tags:
- - Copilot - Connectivity Experience
- summary: Get Wired Connectivity Experience - Hardware
- description: List a page of hardware score data over a selected period of time.
+ - 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#_get_wired_hardware
- operationId: getWiredHardware
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_update_radius_client_object_configuration
+ operationId: updateRadiusClientObject
parameters:
- - $ref: '#/components/parameters/wiredViewType'
- - $ref: '#/components/parameters/wiredViewIdentifier'
- - $ref: '#/components/parameters/forensicBucket'
- - $ref: '#/components/parameters/startTime'
- - $ref: '#/components/parameters/endTime'
+ - $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
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/XiqCopilotHardware'
default:
$ref: '#/components/responses/ErrorResponse'
security:
- BearerAuth: []
- /copilot/connectivity/wired/events:
- get:
+ delete:
tags:
- - Copilot - Connectivity Experience
- summary: List Wired Connectivity Events
- description: List a page of wired events over a selected period of time.
+ - 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#_get_wired_events
- operationId: getWiredEvents
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_delete_radius_client_object_configuration
+ operationId: deleteRadiusClientObject
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'
+ - $ref: '#/components/parameters/id'
responses:
'200':
description: OK
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/XiqCopilotWiredEvents'
default:
$ref: '#/components/responses/ErrorResponse'
security:
- BearerAuth: []
- /copilot/anomalies/locations:
+ /radius-proxies:
get:
tags:
- - Copilot - Anomalies
- summary: List Anomaly Locations
- description: List a page of Anomaly Locations.
+ - 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#_get_copilot_anomaly_locations
- operationId: getCopilotAnomalyLocations
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_list_the_radius_proxy_configuration
+ operationId: listRadiusProxies
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'
+ $ref: '#/components/schemas/PagedXiqRadiusProxy'
default:
$ref: '#/components/responses/ErrorResponse'
security:
- BearerAuth: []
- /copilot/anomalies/devices-by-location:
- get:
+ post:
tags:
- - Copilot - Anomalies
- summary: Get Anomaly Devices for a given location
- description: Get all anomaly devices for a given location.
+ - 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#_get_copilot_anomaly_devices
- operationId: getCopilotAnomalyDevices
- parameters:
- - $ref: '#/components/parameters/anomalyType'
- - $ref: '#/components/parameters/locationIds1'
+ 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:
- '200':
- description: OK
+ '201':
+ description: Created
content:
application/json:
schema:
- $ref: '#/components/schemas/XiqCopilotAnomaliesDevicesByLocation'
+ $ref: '#/components/schemas/XiqRadiusProxy'
default:
$ref: '#/components/responses/ErrorResponse'
security:
- BearerAuth: []
- /copilot/anomalies/poeflapping/stats:
+ /radius-proxies/{id}:
get:
tags:
- - Copilot - Anomalies
- summary: Get POE Flapping Anomaly Device Stats
- description: Get all the stats for anomaly device.
+ - 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_copilot_anomaly_device_stats
- operationId: getCopilotAnomalyDeviceStats
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_get_the_radius_proxy_configuration_by_id
+ operationId: getRadiusProxy
parameters:
- - $ref: '#/components/parameters/anomalyId'
+ - $ref: '#/components/parameters/id'
responses:
'200':
description: OK
content:
application/json:
schema:
- $ref: '#/components/schemas/XiqCopilotPoeFlappingStats'
+ $ref: '#/components/schemas/XiqRadiusProxy'
default:
$ref: '#/components/responses/ErrorResponse'
security:
- BearerAuth: []
- /copilot/anomalies/port-efficiency/stats:
- get:
+ put:
tags:
- - Copilot - Anomalies
- summary: Get PortEfficiency Device Stats
- description: Get all the stats for PortEfficiency device.
+ - 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#_get_copilot_portefficiency_device_stats
- operationId: getCopilotPortEfficiencyDeviceStats
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_update_radius_proxy_configuration
+ operationId: updateRadiusProxy
parameters:
- - $ref: '#/components/parameters/anomalyId'
+ - $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/XiqCopilotPortEfficiencyStats'
+ $ref: '#/components/schemas/XiqRadiusProxy'
default:
$ref: '#/components/responses/ErrorResponse'
security:
- BearerAuth: []
- /copilot/anomalies/port-efficiency/speed-duplex-stats:
- get:
+ delete:
tags:
- - Copilot - Anomalies
- summary: Get PortEfficiency Device Speed and Duplex Stats
- description: Get all the speed and duplex for PortEfficiency device.
+ - 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#_get_copilot_portefficiency_device_speed_duplex
- operationId: getCopilotPortEfficiencyDeviceSpeedDuplex
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_delete_radius_proxy_configuration
+ operationId: deleteRadiusProxy
parameters:
- - $ref: '#/components/parameters/anomalyId'
+ - $ref: '#/components/parameters/id'
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:
+ /radius-proxies/devices:
get:
tags:
- - Copilot - Anomalies
- summary: Get DFSRecurrence Device Channel Count Stats
- description: Get DFS Recurrence anomaly radar event count stats.
+ - 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#_get_copilot_dfsrecurrence_countstats
- operationId: getCopilotDfsRecurrenceCountStats
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_list_radius_proxy_devices
parameters:
- - $ref: '#/components/parameters/anomalyId'
+ - $ref: '#/components/parameters/page'
+ - $ref: '#/components/parameters/limit'
responses:
'200':
description: OK
content:
application/json:
schema:
- $ref: '#/components/schemas/XiqCopilotDfsRecurrenceCountStats'
+ $ref: '#/components/schemas/PagedXiqInternalRadiusDevice'
default:
$ref: '#/components/responses/ErrorResponse'
security:
- BearerAuth: []
- /copilot/anomalies/dfs-recurrence/channel-stats:
+ /radius-servers/internal:
get:
tags:
- - Copilot - Anomalies
- summary: Get DFSRecurrence Device Channel Change Stats
- description: Get DFS Recurrence anomaly device channel change stats.
+ - 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#_get_copilot_dfsrecurrence_channelstats
- operationId: getCopilotDfsRecurrenceChannelStats
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_list_the_internal_radius_servers
+ operationId: listInternalRadiusServers
parameters:
- - $ref: '#/components/parameters/anomalyId'
+ - $ref: '#/components/parameters/page'
+ - $ref: '#/components/parameters/limit'
responses:
'200':
description: OK
content:
application/json:
schema:
- $ref: '#/components/schemas/XiqCopilotDFSRecurrenceChannelStats'
+ $ref: '#/components/schemas/PagedXiqInternalRadiusServer'
default:
$ref: '#/components/responses/ErrorResponse'
security:
- BearerAuth: []
- /copilot/anomalies/adverse-traffic/device-stats:
- get:
+ post:
tags:
- - Copilot - Anomalies
- summary: Get Adverse Traffic Pattern Anomaly Device Stats
- description: Get all the stats for anomaly device.
+ - 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#_get_copilot_anomaly_adverse-traffic_device-stats
- operationId: getCopilotAnomalyAtpDeviceStats
- parameters:
- - $ref: '#/components/parameters/anomalyId'
+ 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:
- '200':
- description: OK
+ '201':
+ description: Created
content:
application/json:
schema:
- $ref: '#/components/schemas/XiqCopilotATPDeviceStats'
+ $ref: '#/components/schemas/XiqInternalRadiusServer'
default:
$ref: '#/components/responses/ErrorResponse'
security:
- BearerAuth: []
- /copilot/anomalies/adverse-traffic/packet-counts:
+ /radius-servers/internal/{id}:
get:
tags:
- - Copilot - Anomalies
- summary: Get Adverse Traffic Pattern Anomaly Packet Counts
- description: Get all the stats for anomaly device.
+ - 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#_get_copilot_anomaly_adverse-traffic_packet-counts
- operationId: getCopilotAnomalyAtpPacketCounts
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_list_the_internal_radius_server_by_id
+ operationId: getInternalRadiusServer
parameters:
- - $ref: '#/components/parameters/anomalyId'
+ - $ref: '#/components/parameters/id'
responses:
'200':
description: OK
content:
application/json:
schema:
- $ref: '#/components/schemas/XiqCopilotATPPacketCounts'
+ $ref: '#/components/schemas/XiqInternalRadiusServer'
default:
$ref: '#/components/responses/ErrorResponse'
security:
- BearerAuth: []
- /copilot/anomalies/wifi-efficiency/stats:
- get:
+ put:
tags:
- - Copilot - Anomalies
- summary: Get WifiEfficiency Device Stats
- description: Get all the stats for WifiEfficiency device.
+ - 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#_get_copilot_wifiefficiency_stats
- operationId: getCopilotWifiEfficiencyStats
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_update_internal_radius_server_configuration
+ operationId: updateInternalRadiusServer
parameters:
- - $ref: '#/components/parameters/anomalyId'
+ - $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/XiqCopilotWifiEfficiencyStats'
+ $ref: '#/components/schemas/XiqInternalRadiusServer'
default:
$ref: '#/components/responses/ErrorResponse'
security:
- BearerAuth: []
- /copilot/anomalies/wifi-efficiency/client-list:
- get:
+ delete:
tags:
- - Copilot - Anomalies
- summary: Get WifiEfficiency contributing client list
- description: Get all the client list for WifiEfficiency device.
+ - 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#_get_copilot_wifiefficiency_client-list
- operationId: getCopilotWifiEfficiencyClientlist
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_delete_internal_radius_server_configuration
+ operationId: deleteInternalRadiusServer
parameters:
- - $ref: '#/components/parameters/deviceId'
- - $ref: '#/components/parameters/channelNumber'
- - $ref: '#/components/parameters/timestamp1'
+ - $ref: '#/components/parameters/id'
responses:
'200':
description: OK
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/XiqCopilotWifiEfficiencyClientlist'
default:
$ref: '#/components/responses/ErrorResponse'
security:
- BearerAuth: []
- /copilot/anomalies/wifi-capacity/stats:
+ /radius-servers/internal/devices:
get:
tags:
- - Copilot - Anomalies
- summary: Get WifiCapacity Device Stats
- description: Get all the stats for WifiCapacity device.
+ - 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#_get_copilot_wificapacity_stats
- operationId: getCopilotWifiCapacityStats
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_list_the_internal_radius_devices
+ operationId: listInternalRadiusDevices
parameters:
- - $ref: '#/components/parameters/anomalyId'
+ - $ref: '#/components/parameters/page'
+ - $ref: '#/components/parameters/limit'
responses:
'200':
description: OK
content:
application/json:
schema:
- $ref: '#/components/schemas/XiqCopilotWifiCapacityStats'
+ $ref: '#/components/schemas/PagedXiqInternalRadiusDevice'
default:
$ref: '#/components/responses/ErrorResponse'
security:
- BearerAuth: []
- /copilot/anomalies/wifi-capacity/client-list:
+ /radius-servers/external:
get:
tags:
- - Copilot - Anomalies
- summary: Get WifiCapacity contributing client list
- description: Get all the client list for WifiCapacity device.
+ - 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#_get_copilot_wificapacity_client-list
- operationId: getCopilotWifiCapacityClientList
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_list_the_external_radius_servers
+ operationId: listExternalRadiusServers
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
+ - $ref: '#/components/parameters/page'
+ - $ref: '#/components/parameters/limit'
responses:
'200':
description: OK
content:
application/json:
schema:
- $ref: '#/components/schemas/XiqCopilotAssuranceScansOverview'
+ $ref: '#/components/schemas/PagedXiqExternalRadiusServer'
default:
$ref: '#/components/responses/ErrorResponse'
security:
- BearerAuth: []
- /copilot/anomalies/update-action:
- put:
+ post:
tags:
- - Copilot - Anomalies
- summary: Update Anomaly Action
- description: Update & save action for Anomaly.
+ - 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#_put_update_copilot_anomaly_action
- operationId: updateCopilotAnomalyAction
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_create_external_radius_server_configuration
+ operationId: createExternalRadiusServer
requestBody:
- description: The body of update action
+ description: Use the payload configuration to create a new external RADIUS server
content:
application/json:
schema:
- $ref: '#/components/schemas/XiqAnomaliesUpdateActionRequest'
+ $ref: '#/components/schemas/XiqCreateExternalRadiusServerRequest'
required: true
responses:
- '200':
- description: OK
+ '201':
+ description: Created
content:
application/json:
schema:
- $ref: '#/components/schemas/XiqCopilotAnomaliesSuccess'
+ $ref: '#/components/schemas/XiqExternalRadiusServer'
default:
$ref: '#/components/responses/ErrorResponse'
security:
- BearerAuth: []
- /copilot/anomalies/devices/feedback:
- put:
+ /radius-servers/external/{id}:
+ get:
tags:
- - Copilot - Anomalies
- summary: Update Anomalies Feedback
- description: Update and save Anomaly Feedback.
+ - 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#_put_copilot_anomaly_devices_feedback
- operationId: putCopilotAnomalyDevicesFeedback
- requestBody:
- description: The body of update feedback
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/XiqAnomaliesFeedbackRequest'
- required: true
+ 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/XiqCopilotAnomaliesSuccess'
+ $ref: '#/components/schemas/XiqExternalRadiusServer'
default:
$ref: '#/components/responses/ErrorResponse'
security:
- BearerAuth: []
- /copilot/anomalies/devices/update-action:
put:
tags:
- - Copilot - Anomalies
- summary: Update Anomaly Devices Action
- description: Update & save action for Anomaly devices.
+ - 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#_put_update_copilot_anomaly_devices_action
- operationId: updateCopilotAnomalyDevicesAction
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_update_external_radius_server_configuration
+ operationId: updateExternalRadiusServer
+ parameters:
+ - $ref: '#/components/parameters/id'
requestBody:
- description: The body of update feedback
+ description: The payload to update the external RADIUS server
content:
application/json:
schema:
- $ref: '#/components/schemas/XiqAnomaliesDeviceUpdateActionRequest'
+ $ref: '#/components/schemas/XiqUpdateExternalRadiusServerRequest'
required: true
responses:
'200':
description: OK
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/XiqCopilotAnomaliesSuccess'
default:
$ref: '#/components/responses/ErrorResponse'
security:
- BearerAuth: []
- /copilot/anomalies/notifications:
- get:
+ delete:
tags:
- - Copilot - Anomalies
- summary: Get Anomalies Notifications
- description: Get Anomaly notifications count and details.
+ - 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#_get_copilot_anomaly_notifications
- operationId: getCopilotAnomalyNotifications
+ 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
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/XiqCopilotAnomaliesNotificationsVo'
default:
$ref: '#/components/responses/ErrorResponse'
security:
- BearerAuth: []
- /copilot/anomalies/anomalies-by-category:
+ /certificates:
get:
tags:
- - Copilot - Anomalies
- summary: Get Anomalies by Categories
- description: Get all anomalies for a given viewType.
+ - Configuration - Certificate
+ summary: List certificates
+ description: List a page of certificates.
externalDocs:
description: API Reference
- url: https://extremecloudiq.com/api-docs/api-reference.html#_get_copilot_anomaly_anomalies-by-category
- operationId: getCopilotAnomaliesbyCategory
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_list_certificates
+ operationId: listCertificates
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/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/XiqCopilotAnomaliesByCategory'
+ $ref: '#/components/schemas/PagedXiqCertificate'
default:
$ref: '#/components/responses/ErrorResponse'
security:
- BearerAuth: []
- /copilot/anomalies/devices-with-locations:
+ /copilot/connectivity/wireless/experience:
get:
tags:
- - Copilot - Anomalies
- summary: Devices with Locations
- description: Get all devices for all the anomalies and locations.
+ - 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_copilot_anomaly_devices_with_locations
- operationId: getCopilotDevicesWithLocations
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_get_wireless_experience
+ operationId: getWirelessExperience
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/wirelessViewType'
+ - $ref: '#/components/parameters/startTime'
+ - $ref: '#/components/parameters/endTime'
- $ref: '#/components/parameters/page'
- $ref: '#/components/parameters/limit'
- - $ref: '#/components/parameters/searchKey1'
+ - $ref: '#/components/parameters/sortField'
+ - $ref: '#/components/parameters/sortOrder'
responses:
'200':
description: OK
content:
application/json:
schema:
- $ref: '#/components/schemas/XiqCopilotAnomaliesDevicesWithLocation'
+ $ref: '#/components/schemas/XiqCopilotConnectivityExperience'
default:
$ref: '#/components/responses/ErrorResponse'
security:
- BearerAuth: []
- /copilot/anomalies/update-device-action:
- put:
+ /copilot/connectivity/wireless/quality-index:
+ get:
tags:
- - Copilot - Anomalies
- summary: Update Devices Action
- description: Update & save action for Anomaly devices.
+ - 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#update_copilot_anomalies_devices_action
- operationId: updateCopilotAnomaliesDevicesAction
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_get_wireless_quality_index
+ operationId: getWirelessQualityIndex
parameters:
- - $ref: '#/components/parameters/async1'
- requestBody:
- description: The body of update devices
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/XiqUpdateAnomaliesAndDevicesRequest'
- required: true
+ - $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/anomalies/report:
+ /copilot/connectivity/wireless/time-to-connect:
get:
tags:
- - Copilot - Anomalies
- summary: Download Anomalies Report
- description: Download all devices and locations for all the anomalies.
+ - 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_copilot_anomaly_download_report
- operationId: getAnomaliesReport
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_get_wireless_time_to_connect
+ operationId: getWirelessTimeToConnect
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/searchKey1'
- - $ref: '#/components/parameters/fileType'
- - $ref: '#/components/parameters/offsetTime'
+ - $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:
- text/csv:
- schema:
- $ref: '#/components/schemas/XiqCopilotAnomaliesReport'
- application/pdf:
+ application/json:
schema:
- $ref: '#/components/schemas/XiqCopilotAnomaliesReport'
+ $ref: '#/components/schemas/XiqCopilotTimeToConnect'
default:
$ref: '#/components/responses/ErrorResponse'
security:
- BearerAuth: []
- /packetcaptures:
+ /copilot/connectivity/wireless/performance:
get:
tags:
- - PacketCaptures
- summary: List packet capture sessions
- operationId: listPacketCaptures
- description: List packet capture sessions with filters and pagination.
+ - 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#_list_packet_captures
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_get_wireless_performance
+ operationId: getWirelessPerformance
parameters:
- - $ref: '#/components/parameters/page'
- - $ref: '#/components/parameters/limit'
- - name: searchString
- in: query
- description: The string to be searched in capture session name, interface name and device host name
- required: false
- schema:
- type: string
- - name: sortField
- in: query
- description: Sort field. Available values - NAME, START_TIME and STATUS
- required: false
- schema:
- type: string
- enum:
- - NAME
- - START_TIME
- - STATUS
- - $ref: '#/components/parameters/order'
- - name: fields
- in: query
- description: The packet capture fields to return
- required: false
- schema:
- type: array
- items:
- $ref: '#/components/schemas/XiqPacketCaptureField'
+ - $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/PagedXiqPacketCapture'
+ $ref: '#/components/schemas/XiqCopilotPerformance'
default:
$ref: '#/components/responses/ErrorResponse'
security:
- BearerAuth: []
- post:
+ /copilot/connectivity/wireless/events:
+ get:
tags:
- - PacketCaptures
- summary: Create a new packet capture session
- operationId: createPacketCapture
- description: Create and start a new packet capture session with requested capture location and filter criteria.
+ - 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#_create_packet_capture
- requestBody:
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/XiqPacketCapture'
- required: true
+ 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/XiqPacketCapture'
+ $ref: '#/components/schemas/XiqCopilotWirelessEvents'
default:
$ref: '#/components/responses/ErrorResponse'
security:
- BearerAuth: []
- /packetcaptures/{id}:
+ /copilot/connectivity/wireless/apps:
get:
tags:
- - PacketCaptures
- summary: Get a packet capture session by ID
- operationId: getPacketCapture
- description: Get a packet capture session by id.
+ - 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_packet_capture
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_get_wireless_apps
+ operationId: getWirelessApps
parameters:
- - $ref: '#/components/parameters/id'
- - name: fields
- in: query
- description: The packet capture fields to return
- required: false
- schema:
- type: array
- items:
- $ref: '#/components/schemas/XiqPacketCaptureField'
+ - $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/XiqPacketCapture'
+ $ref: '#/components/schemas/XiqCopilotWirelessApps'
default:
$ref: '#/components/responses/ErrorResponse'
security:
- BearerAuth: []
- delete:
+ /copilot/connectivity/wireless/views:
+ get:
tags:
- - PacketCaptures
- summary: Delete a packet capture session
- operationId: deletePacketCapture
- description: Delete an existing packet capture session and capture files by ID.
+ - 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#_delete_packet_capture
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_get_wireless_views
+ operationId: getWirelessViews
parameters:
- - $ref: '#/components/parameters/id'
+ - $ref: '#/components/parameters/wirelessViewType'
responses:
'200':
description: OK
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/XiqCopilotWirelessViewsList'
default:
$ref: '#/components/responses/ErrorResponse'
security:
- BearerAuth: []
- /packetcaptures/{id}/:stop:
- post:
+ /copilot/connectivity/wired/experience:
+ get:
tags:
- - PacketCaptures
- summary: Stop a packet capture session
- operationId: stopPacketCapture
- description: Stop an active packet capture session.
+ - 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#_stop_active_packet_capture
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_get_wired_experience
+ operationId: getWiredExperience
parameters:
- - $ref: '#/components/parameters/id'
- requestBody:
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/XiqCaptureStopRequest'
- required: true
+ - $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: []
- /packetcaptures/{id}/:upload:
- post:
+ /copilot/connectivity/wired/quality-index:
+ get:
tags:
- - PacketCaptures
- summary: Upload a packet capture session's capture files
- operationId: uploadPacketCaptureFiles
- description: Upload the capture files from a packet capture session, if files previously failed to be uploaded to XIQ cloud.
+ - 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#_upload_packet_captures_capture_files
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_get_wired_quality_index
+ operationId: getWiredQualityIndex
parameters:
- - $ref: '#/components/parameters/id'
+ - $ref: '#/components/parameters/wiredViewType'
+ - $ref: '#/components/parameters/wiredViewIdentifier'
+ - $ref: '#/components/parameters/forensicBucket'
+ - $ref: '#/components/parameters/startTime'
+ - $ref: '#/components/parameters/endTime'
+ - $ref: '#/components/parameters/locationId'
responses:
'200':
description: OK
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/XiqCopilotWiredQualityIndex'
default:
$ref: '#/components/responses/ErrorResponse'
security:
- BearerAuth: []
- /packetcaptures/files:
+ /copilot/connectivity/wired/hardware:
get:
tags:
- - PacketCaptures
- summary: Get an AP packet capture file
- operationId: getPacketCaptureFile
- description: Get an AP packet capture file from XIQ cloud storage.
+ - 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_packet_capture_file
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_get_wired_hardware
+ operationId: getWiredHardware
parameters:
- - name: cloudFileUrl
- in: query
- description: The packet capture file path
- required: true
- schema:
- type: string
+ - $ref: '#/components/parameters/wiredViewType'
+ - $ref: '#/components/parameters/wiredViewIdentifier'
+ - $ref: '#/components/parameters/forensicBucket'
+ - $ref: '#/components/parameters/startTime'
+ - $ref: '#/components/parameters/endTime'
responses:
'200':
- description: Returns requested packet capture file.
+ description: OK
content:
- application/octet-stream:
+ application/json:
schema:
- type: string
- description: Packet capture file
- format: binary
+ $ref: '#/components/schemas/XiqCopilotHardware'
default:
$ref: '#/components/responses/ErrorResponse'
security:
- BearerAuth: []
- /essentials/eloc/clients/{clientMac}/last-known-location:
+ /copilot/connectivity/wired/events:
get:
tags:
- - Essentials - ExtremeLocation
- summary: Get the last known location of the client
- description: Get the last known location of the client on the floor plan.
+ - 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#_eloc_clients_lastknown_location_by_macAddress_for_one_client
- operationId: elocLastKnownClientLocation
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_get_wired_events
+ operationId: getWiredEvents
parameters:
- - $ref: '#/components/parameters/mac'
- - $ref: '#/components/parameters/floorId'
- - $ref: '#/components/parameters/parentId'
+ - $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/XiqEssentialsElocClientLastknownLocation'
+ $ref: '#/components/schemas/XiqCopilotWiredEvents'
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
+ /copilot/connectivity/locations:
+ get:
+ tags:
+ - Copilot - Connectivity Experience
+ summary: Get Connectivity By Locations
+ description: Get Connectivity details by Locations in a Table with pagination & sorting.
+ externalDocs:
+ description: API Reference
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_get_connectivity_by_locations
+ operationId: getConnectivityDetailsByLocations
+ parameters:
+ - $ref: '#/components/parameters/startTime'
+ - $ref: '#/components/parameters/endTime'
+ - $ref: '#/components/parameters/locationId'
+ - $ref: '#/components/parameters/searchKey'
+ - $ref: '#/components/parameters/clientType'
+ - $ref: '#/components/parameters/qualityIndex'
+ - $ref: '#/components/parameters/forensicBucket'
+ - $ref: '#/components/parameters/page'
+ - $ref: '#/components/parameters/limit'
+ - $ref: '#/components/parameters/sortField'
+ - $ref: '#/components/parameters/sortOrder'
+ responses:
+ '200':
+ description: OK
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/XiqCopilotConnectivityByLocations'
+ default:
+ $ref: '#/components/responses/ErrorResponse'
+ security:
+ - BearerAuth: []
+ /copilot/connectivity/client-type:
+ get:
+ tags:
+ - Copilot - Connectivity Experience
+ summary: Get Connectivity By Client Type
+ description: Get Connectivity details by client type in the widgets.
+ externalDocs:
+ description: API Reference
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_get_connectivity_by_client_type
+ operationId: getConnectivityDetailsByClientType
+ parameters:
+ - $ref: '#/components/parameters/startTime'
+ - $ref: '#/components/parameters/endTime'
+ - $ref: '#/components/parameters/locationId'
+ - $ref: '#/components/parameters/clientType'
+ - $ref: '#/components/parameters/qualityIndex'
+ - $ref: '#/components/parameters/forensicBucket'
+ responses:
+ '200':
+ description: OK
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/XiqCopilotConnectivityByClientType'
+ default:
+ $ref: '#/components/responses/ErrorResponse'
+ security:
+ - BearerAuth: []
+ /copilot/connectivity/wireless/locations/quality-index:
+ get:
+ tags:
+ - Copilot - Connectivity Experience
+ summary: Get Wireless QualityIndex By Locations
+ description: Get Quality-Index for a specific view type.
+ externalDocs:
+ description: API Reference
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_get_wireless_quality_index_by_locations
+ operationId: getWirelessQualityIndexByLocations
+ parameters:
+ - $ref: '#/components/parameters/startTime'
+ - $ref: '#/components/parameters/endTime'
+ - $ref: '#/components/parameters/forensicBucket'
+ - $ref: '#/components/parameters/viewId'
+ - $ref: '#/components/parameters/ssid'
+ - $ref: '#/components/parameters/osType'
+ responses:
+ '200':
+ description: OK
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/XiqCopilotWirelessQualityIndexByLocation'
+ default:
+ $ref: '#/components/responses/ErrorResponse'
+ security:
+ - BearerAuth: []
+ /copilot/connectivity/wireless/locations/time-to-connect:
+ get:
+ tags:
+ - Copilot - Connectivity Experience
+ summary: Get Wireless Time-To-Connect By Locations
+ description: List a page of Time-To-Connect score data over a selected period of time.
+ externalDocs:
+ description: API Reference
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_get_wireless_time_to_connect_by_locations
+ operationId: getWirelessTimeToConnectByLocations
+ parameters:
+ - $ref: '#/components/parameters/startTime'
+ - $ref: '#/components/parameters/endTime'
+ - $ref: '#/components/parameters/forensicBucket'
+ - $ref: '#/components/parameters/viewId'
+ - $ref: '#/components/parameters/ssid'
+ - $ref: '#/components/parameters/osType'
+ responses:
+ '200':
+ description: OK
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/XiqCopilotTimeToConnect'
+ default:
+ $ref: '#/components/responses/ErrorResponse'
+ security:
+ - BearerAuth: []
+ /copilot/connectivity/wireless/locations/performance:
+ get:
+ tags:
+ - Copilot - Connectivity Experience
+ summary: Get Wireless Connectivity Performance By Locations
+ description: List a page of Performance score data over a selected period of time.
+ externalDocs:
+ description: API Reference
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_get_wireless_performance_by_locations
+ operationId: getWirelessPerformanceByLocations
+ parameters:
+ - $ref: '#/components/parameters/startTime'
+ - $ref: '#/components/parameters/endTime'
+ - $ref: '#/components/parameters/forensicBucket'
+ - $ref: '#/components/parameters/viewId'
+ - $ref: '#/components/parameters/ssid'
+ - $ref: '#/components/parameters/osType'
+ responses:
+ '200':
+ description: OK
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/XiqCopilotPerformance'
+ default:
+ $ref: '#/components/responses/ErrorResponse'
+ security:
+ - BearerAuth: []
+ /copilot/connectivity/wireless/locations/events:
+ get:
+ tags:
+ - Copilot - Connectivity Experience
+ summary: List Wireless Connectivity Events By Locations
+ description: List a page of wireless events over a selected period of time.
+ externalDocs:
+ description: API Reference
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_get_wireless_events_by_locations
+ operationId: getWirelessEventsByLocations
+ parameters:
+ - $ref: '#/components/parameters/startTime'
+ - $ref: '#/components/parameters/endTime'
+ - $ref: '#/components/parameters/page'
+ - $ref: '#/components/parameters/limit'
+ - $ref: '#/components/parameters/wirelessSortField'
+ - $ref: '#/components/parameters/sortOrder'
+ - $ref: '#/components/parameters/wirelessScoreType'
+ - $ref: '#/components/parameters/forensicBucket'
+ - $ref: '#/components/parameters/searchKey'
+ - $ref: '#/components/parameters/viewId'
+ - $ref: '#/components/parameters/timestamp'
+ - $ref: '#/components/parameters/ssid'
+ - $ref: '#/components/parameters/osType'
+ responses:
+ '200':
+ description: OK
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/XiqCopilotWirelessEvents'
+ default:
+ $ref: '#/components/responses/ErrorResponse'
+ security:
+ - BearerAuth: []
+ /copilot/connectivity/wired/locations/hardware:
+ get:
+ tags:
+ - Copilot - Connectivity Experience
+ summary: Get Wired - Hardware By Locations
+ description: List a page of hardware score data over a selected period of time and total ports with affected.
+ externalDocs:
+ description: API Reference
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_get_wired_hardware_by_location
+ operationId: getWiredHardwareByLocation
+ parameters:
+ - $ref: '#/components/parameters/wiredViewType'
+ - $ref: '#/components/parameters/wiredViewIdentifier'
+ - $ref: '#/components/parameters/forensicBucket'
+ - $ref: '#/components/parameters/startTime'
+ - $ref: '#/components/parameters/endTime'
+ responses:
+ '200':
+ description: OK
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/XiqCopilotHardwareByLocation'
+ default:
+ $ref: '#/components/responses/ErrorResponse'
+ security:
+ - BearerAuth: []
+ /copilot/anomalies/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/locationIds1'
+ 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 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'
+ 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/update-action:
+ put:
+ tags:
+ - Copilot - Anomalies
+ summary: Update Anomaly Action
+ description: Update & save action for Anomaly.
+ externalDocs:
+ description: API Reference
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_put_update_copilot_anomaly_action
+ operationId: updateCopilotAnomalyAction
+ requestBody:
+ description: The body of update action
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/XiqAnomaliesUpdateActionRequest'
+ required: true
+ responses:
+ '200':
+ description: OK
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/XiqCopilotAnomaliesSuccess'
+ 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/devices/update-action:
+ put:
+ tags:
+ - Copilot - Anomalies
+ summary: Update Anomaly Devices Action
+ description: Update & save action for Anomaly devices.
+ externalDocs:
+ description: API Reference
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_put_update_copilot_anomaly_devices_action
+ operationId: updateCopilotAnomalyDevicesAction
+ requestBody:
+ description: The body of update feedback
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/XiqAnomaliesDeviceUpdateActionRequest'
+ required: true
+ responses:
+ '200':
+ description: OK
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/XiqCopilotAnomaliesSuccess'
+ default:
+ $ref: '#/components/responses/ErrorResponse'
+ security:
+ - BearerAuth: []
+ /copilot/anomalies/notifications:
+ get:
+ tags:
+ - Copilot - Anomalies
+ summary: Get Anomalies Notifications
+ description: Get Anomaly notifications count and details.
+ externalDocs:
+ description: API Reference
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_get_copilot_anomaly_notifications
+ operationId: getCopilotAnomalyNotifications
+ responses:
+ '200':
+ description: OK
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/XiqCopilotAnomaliesNotificationsVo'
+ 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/async1'
+ 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: []
+ /packetcaptures:
+ get:
+ tags:
+ - PacketCaptures
+ summary: List packet capture sessions
+ operationId: listPacketCaptures
+ description: List packet capture sessions with filters and pagination.
+ externalDocs:
+ description: API Reference
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_list_packet_captures
+ parameters:
+ - $ref: '#/components/parameters/page'
+ - $ref: '#/components/parameters/limit'
+ - name: searchString
+ in: query
+ description: The string to be searched in capture session name, interface name and device host name
+ required: false
+ schema:
+ type: string
+ - name: sortField
+ in: query
+ description: Sort field. Available values - NAME, START_TIME and STATUS
+ required: false
+ schema:
+ type: string
+ enum:
+ - NAME
+ - START_TIME
+ - STATUS
+ - $ref: '#/components/parameters/order'
+ - name: fields
+ in: query
+ description: The packet capture fields to return
+ required: false
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/XiqPacketCaptureField'
+ responses:
+ '200':
+ description: OK
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/PagedXiqPacketCapture'
+ default:
+ $ref: '#/components/responses/ErrorResponse'
+ security:
+ - BearerAuth: []
+ post:
+ tags:
+ - PacketCaptures
+ summary: Create a new packet capture session
+ operationId: createPacketCapture
+ description: Create and start a new packet capture session with requested capture location and filter criteria.
+ externalDocs:
+ description: API Reference
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_create_packet_capture
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/XiqPacketCapture'
+ required: true
+ responses:
+ '200':
+ description: OK
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/XiqPacketCapture'
+ default:
+ $ref: '#/components/responses/ErrorResponse'
+ security:
+ - BearerAuth: []
+ /packetcaptures/{id}:
+ get:
+ tags:
+ - PacketCaptures
+ summary: Get a packet capture session by ID
+ operationId: getPacketCapture
+ description: Get a packet capture session by id.
+ externalDocs:
+ description: API Reference
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_get_packet_capture
+ parameters:
+ - $ref: '#/components/parameters/id'
+ - name: fields
+ in: query
+ description: The packet capture fields to return
+ required: false
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/XiqPacketCaptureField'
+ responses:
+ '200':
+ description: OK
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/XiqPacketCapture'
+ default:
+ $ref: '#/components/responses/ErrorResponse'
+ security:
+ - BearerAuth: []
+ delete:
+ tags:
+ - PacketCaptures
+ summary: Delete a packet capture session
+ operationId: deletePacketCapture
+ description: Delete an existing packet capture session and capture files by ID.
+ externalDocs:
+ description: API Reference
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_delete_packet_capture
+ parameters:
+ - $ref: '#/components/parameters/id'
+ responses:
+ '200':
+ description: OK
+ default:
+ $ref: '#/components/responses/ErrorResponse'
+ security:
+ - BearerAuth: []
+ /packetcaptures/{id}/:stop:
+ post:
+ tags:
+ - PacketCaptures
+ summary: Stop a packet capture session
+ operationId: stopPacketCapture
+ description: Stop an active packet capture session.
+ externalDocs:
+ description: API Reference
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_stop_active_packet_capture
+ parameters:
+ - $ref: '#/components/parameters/id'
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/XiqCaptureStopRequest'
+ required: true
+ responses:
+ '200':
+ description: OK
+ default:
+ $ref: '#/components/responses/ErrorResponse'
+ security:
+ - BearerAuth: []
+ /packetcaptures/{id}/:upload:
+ post:
+ tags:
+ - PacketCaptures
+ summary: Upload a packet capture session's capture files
+ operationId: uploadPacketCaptureFiles
+ description: Upload the capture files from a packet capture session, if files previously failed to be uploaded to XIQ cloud.
+ externalDocs:
+ description: API Reference
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_upload_packet_captures_capture_files
+ parameters:
+ - $ref: '#/components/parameters/id'
+ responses:
+ '200':
+ description: OK
+ default:
+ $ref: '#/components/responses/ErrorResponse'
+ security:
+ - BearerAuth: []
+ /packetcaptures/files:
+ get:
+ tags:
+ - PacketCaptures
+ summary: Get an AP packet capture file
+ operationId: getPacketCaptureFile
+ description: Get an AP packet capture file from XIQ cloud storage.
+ externalDocs:
+ description: API Reference
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_get_packet_capture_file
+ parameters:
+ - name: cloudFileUrl
+ in: query
+ description: The packet capture file path
+ required: true
+ schema:
+ type: string
+ responses:
+ '200':
+ description: Returns requested packet capture file.
+ content:
+ application/octet-stream:
+ schema:
+ type: string
+ description: Packet capture file
+ format: binary
+ default:
+ $ref: '#/components/responses/ErrorResponse'
+ security:
+ - BearerAuth: []
+ /essentials/eloc/clients/{clientMac}/last-known-location:
+ get:
+ tags:
+ - Essentials - ExtremeLocation
+ summary: Get the last known location of the client
+ description: Get the last known location of the client on the floor plan.
+ externalDocs:
+ description: API Reference
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_eloc_clients_lastknown_location_by_macAddress_for_one_client
+ operationId: elocLastKnownClientLocation
+ parameters:
+ - $ref: '#/components/parameters/mac'
+ - $ref: '#/components/parameters/floorId'
+ - $ref: '#/components/parameters/parentId'
+ responses:
+ '200':
+ description: OK
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/XiqEssentialsElocClientLastknownLocation'
+ default:
+ $ref: '#/components/responses/ErrorResponse'
+ security:
+ - BearerAuth: []
+ /countries:
+ get:
+ tags:
+ - Misc
+ summary: Get country list
+ description: Get list of countries and country codes.
+ externalDocs:
+ description: API Reference
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_get_country_list
+ operationId: getCountryList
+ responses:
+ '200':
+ description: OK
+ content:
+ application/json:
+ schema:
+ type: array
+ $ref: '#/components/schemas/XiqCountry'
+ default:
+ $ref: '#/components/responses/ErrorResponse'
+ security:
+ - BearerAuth: []
+ /countries/{countryCode}/:validate:
+ get:
+ tags:
+ - Misc
+ summary: Validate country code
+ description: Validate whether the country code is a valid code or not.
+ externalDocs:
+ description: API Reference
+ url: https://extremecloudiq.com/api-docs/api-reference.html#_validate_country_code
+ operationId: validateCountryCode
+ parameters:
+ - name: countryCode
+ in: path
+ description: The country code.
+ required: true
+ schema:
+ type: integer
+ format: int32
+ responses:
+ '200':
+ description: OK
+ content:
+ application/json:
+ schema:
+ type: boolean
+ default:
+ $ref: '#/components/responses/ErrorResponse'
+ security:
+ - 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)
@@ -8902,9 +9930,10 @@ components:
color:
type: string
description: The tagged color for the organization
- XiqCreateLocationRequest:
+ ClsCreateLocationRequest:
type: object
required:
+ - parent_id
- name
properties:
parent_id:
@@ -8914,7 +9943,7 @@ components:
name:
type: string
description: The location name
- XiqLocation:
+ ClsLocation:
allOf:
- $ref: '#/components/schemas/XiqViqEntity'
- type: object
@@ -8939,13 +9968,13 @@ components:
description: The location type
address:
type: string
- description: The address for the location
+ description: The address of the location
children:
type: array
description: The child locations
items:
- $ref: '#/components/schemas/XiqLocation'
- XiqLocationTreeDevice:
+ $ref: '#/components/schemas/ClsLocation'
+ ClsLocationTreeDevice:
type: object
description: The device on the location hierarchy.
required:
@@ -9002,7 +10031,7 @@ components:
type: number
description: The vertical scale for the background map in meter.
format: double
- PagedXiqLocationTreeDevice:
+ PagedClsLocationTreeDevice:
allOf:
- $ref: '#/components/schemas/XiqPage'
- type: object
@@ -9011,8 +10040,8 @@ components:
type: array
description: The data in the current page
items:
- $ref: '#/components/schemas/XiqLocationTreeDevice'
- XiqLocationTreeMap:
+ $ref: '#/components/schemas/ClsLocationTreeDevice'
+ ClsLocationTreeMap:
type: object
description: The map on the location hierarchy.
required:
@@ -9035,7 +10064,7 @@ components:
data:
type: string
description: The base-64 encoded string of the map.
- PagedXiqLocationTreeMap:
+ PagedClsLocationTreeMap:
allOf:
- $ref: '#/components/schemas/XiqPage'
- type: object
@@ -9044,9 +10073,12 @@ components:
type: array
description: The data in the current page
items:
- $ref: '#/components/schemas/XiqLocationTreeMap'
- XiqUpdateLocationRequest:
+ $ref: '#/components/schemas/ClsLocationTreeMap'
+ ClsUpdateLocationRequest:
type: object
+ required:
+ - parent_id
+ - name
properties:
parent_id:
type: integer
@@ -9055,7 +10087,7 @@ components:
name:
type: string
description: The location name
- XiqRfEnvironmentType:
+ ClsRfEnvironmentType:
type: string
description: The floor RF environment
enum:
@@ -9066,13 +10098,13 @@ components:
- OUTDOOR_SUBURBAN
- WAREHOUSE
- OUTDOOR_DENSE_URBAN
- XiqMeasurementUnit:
+ ClsMeasurementUnit:
type: string
description: The measurement unit in feet/meters
enum:
- FEET
- METERS
- XiqFloor:
+ ClsFloor:
allOf:
- $ref: '#/components/schemas/XiqViqEntity'
- type: object
@@ -9097,13 +10129,13 @@ components:
type: string
description: The floor unique name
environment:
- $ref: '#/components/schemas/XiqRfEnvironmentType'
+ $ref: '#/components/schemas/ClsRfEnvironmentType'
db_attenuation:
type: number
description: The floor attenuation in dBs
format: double
measurement_unit:
- $ref: '#/components/schemas/XiqMeasurementUnit'
+ $ref: '#/components/schemas/ClsMeasurementUnit'
installation_height:
type: number
description: The installation height
@@ -9119,7 +10151,7 @@ components:
map_name:
type: string
description: The floormap name
- XiqCreateFloorRequest:
+ ClsCreateFloorRequest:
type: object
required:
- parent_id
@@ -9138,13 +10170,13 @@ components:
type: string
description: The floor name
environment:
- $ref: '#/components/schemas/XiqRfEnvironmentType'
+ $ref: '#/components/schemas/ClsRfEnvironmentType'
db_attenuation:
type: number
description: The floor attenuation in dBs
format: double
measurement_unit:
- $ref: '#/components/schemas/XiqMeasurementUnit'
+ $ref: '#/components/schemas/ClsMeasurementUnit'
installation_height:
type: number
description: The installation height
@@ -9160,8 +10192,16 @@ components:
map_name:
type: string
description: The floor map name
- XiqUpdateFloorRequest:
+ ClsUpdateFloorRequest:
type: object
+ required:
+ - parent_id
+ - name
+ - db_attenuation
+ - measurement_unit
+ - installation_height
+ - map_size_width
+ - map_size_height
properties:
parent_id:
type: integer
@@ -9171,13 +10211,13 @@ components:
type: string
description: The floor name
environment:
- $ref: '#/components/schemas/XiqRfEnvironmentType'
+ $ref: '#/components/schemas/ClsRfEnvironmentType'
db_attenuation:
type: number
description: The floor attenuation in dBs
format: double
measurement_unit:
- $ref: '#/components/schemas/XiqMeasurementUnit'
+ $ref: '#/components/schemas/ClsMeasurementUnit'
installation_height:
type: number
description: The installation height
@@ -9193,7 +10233,30 @@ components:
map_name:
type: string
description: The floor map name
- XiqBuilding:
+ ClsAddress:
+ type: object
+ required:
+ - address
+ - city
+ - postal_code
+ - state
+ properties:
+ address:
+ type: string
+ description: The street address 1
+ address2:
+ type: string
+ description: The street address 2
+ city:
+ type: string
+ description: the city/town of the address
+ postal_code:
+ type: string
+ description: The postal/ZIP code of the address
+ state:
+ type: string
+ description: The province/state of the address
+ ClsBuilding:
allOf:
- $ref: '#/components/schemas/XiqViqEntity'
- type: object
@@ -9201,7 +10264,6 @@ components:
required:
- name
- parent_id
- - address
properties:
parent_id:
type: integer
@@ -9217,9 +10279,8 @@ components:
type: string
description: The location type
address:
- type: string
- description: The address for the location
- XiqCreateBuildingRequest:
+ $ref: '#/components/schemas/ClsAddress'
+ ClsCreateBuildingRequest:
type: object
required:
- parent_id
@@ -9234,10 +10295,13 @@ components:
type: string
description: The building name
address:
- type: string
- description: The street address
- XiqUpdateBuildingRequest:
+ $ref: '#/components/schemas/ClsAddress'
+ ClsUpdateBuildingRequest:
type: object
+ required:
+ - parent_id
+ - name
+ - address
properties:
parent_id:
type: integer
@@ -9247,9 +10311,8 @@ components:
type: string
description: The building name
address:
- type: string
- description: The street address
- XiqSite:
+ $ref: '#/components/schemas/ClsAddress'
+ ClsSite:
allOf:
- $ref: '#/components/schemas/XiqViqEntity'
- type: object
@@ -9257,46 +10320,67 @@ components:
required:
- name
- parent_id
+ - country_code
properties:
parent_id:
type: integer
- description: The parent location ID
+ description: The parent site group ID
format: int64
name:
type: string
- description: The location name
+ description: The site name
unique_name:
type: string
- description: The unique location name
+ description: The site unique name
type:
type: string
description: The location type
+ country_code:
+ type: integer
+ format: int32
+ description: The site country code. Get the list of country codes from /countries XAPI
address:
- type: string
- description: The address for the location
- XiqCreateSiteRequest:
+ $ref: '#/components/schemas/ClsAddress'
+ ClsCreateSiteRequest:
type: object
required:
- parent_id
- name
+ - country_code
properties:
parent_id:
type: integer
- description: The parent location ID
+ description: The parent site group ID
format: int64
name:
type: string
description: The site name
- XiqUpdateSiteRequest:
+ country_code:
+ type: integer
+ format: int32
+ description: The site country code. Get the list of country codes from /countries XAPI
+ address:
+ $ref: '#/components/schemas/ClsAddress'
+ ClsUpdateSiteRequest:
type: object
+ required:
+ - parent_id
+ - name
+ - country_code
properties:
parent_id:
type: integer
- description: The parent location ID
+ description: The parent site group ID
format: int64
name:
type: string
description: The site name
+ country_code:
+ type: integer
+ format: int32
+ description: The site country code. Get the list of country codes from /countries XAPI
+ address:
+ $ref: '#/components/schemas/ClsAddress'
XiqDeviceAdminState:
type: string
enum:
@@ -10337,95 +11421,690 @@ components:
managed_device_count:
type: integer
format: int32
- connected_device_count:
+ 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
- format: int32
- XiqDeviceLevelSsid:
+ description: The beacon network policy ID.
+ format: int64
+ XiqDigitalTwinProducts:
type: object
- description: The ssid/passphrase for device level ssid to override
+ description: The Digital Twin product information.
required:
- - ssid_id
+ - make
+ - model
+ - os_versions
properties:
- ssid_id:
- type: integer
- description: The SSID ID to override, cannot be null.
- format: int64
- ssid:
+ make:
type: string
- description: The broadcast ssid name to override. Can only override if the SSID profile is OPEN or PSK mode.
- passphrase:
+ description: The Digital Twin device make.
+ model:
type: string
- description: The ssid passphrase to override. Can only override if the SSID profile is in PSK mode.
- XiqDeviceLevelSsidStatus:
+ description: The Digital Twin device model.
+ os_type:
+ type: string
+ description: The Digital Twin device OS type.
+ os_versions:
+ type: array
+ description: The Digital Twin device OS versions.
+ items:
+ type: string
+ description: The Digital Twin device OS versions.
+ PagedXiqDigitalTwinProducts:
+ allOf:
+ - $ref: '#/components/schemas/XiqPage'
+ - type: object
+ properties:
+ data:
+ type: array
+ description: The data in the current page
+ items:
+ $ref: '#/components/schemas/XiqDigitalTwinProducts'
+ XiqBounceDevicePortRequest:
type: object
- description: The SSID status
+ description: The request for bounce port for the given device id.
required:
- - wifi0_enabled
- - wifi1_enabled
+ - interfaceName
properties:
- wifi0_enabled:
+ 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: The SSID is enabled or not on wifi0 interface
- wifi1_enabled:
+ 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: The SSID is enabled or not on wifi1 interface
- XiqWirelessIfName:
+ description: Enable PoE
+ xiq_connectivity:
+ type: boolean
+ description: Cloud or Locally managed indicator. True means Cloud managed device
+ installation_images:
+ type: boolean
+ description: Device contains installation images or not
+ XiqThreadStartCommissionerRequest:
+ type: object
+ description: Start the Thread Commissioner on a thread router device.
+ properties:
+ comm_timeout:
+ type: integer
+ default: 120
+ minimum: 1
+ maximum: 2000000
+ description: After this timeout the Commissioner will shutdown. The default is 120 sec. but the max is approximately 23 days.
+ interface_name:
+ type: string
+ description: The IoT interface on which to start the Commissioner. The default is iot0.
+ XiqThreadStopCommissionerRequest:
+ type: object
+ description: Stop the Thread Commissioner on a thread router device.
+ properties:
+ interface_name:
+ type: string
+ description: The IoT interface on which to stop the Commissioner. The default is iot0.
+ XiqSsidStatus:
type: string
- 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:
+ - OPEN
+ - CLOSED
+ XiqSsidSecurityType:
+ type: string
+ enum:
+ - OPEN
+ - ENHANCED_OPEN
+ - PPSK
+ - PSK
+ - WEP
+ - TYPE_802DOT1X
+ XiqWirelessClient:
type: object
- description: The request for disable/enable device level ssid.
+ description: ExtremeCloud IQ BSS and Network Data
required:
- - ssid_ids
- - if_names
- - enabled
+ - network_policy_name
+ - ssid
+ - ssid_status
+ - ssid_security_type
properties:
- ssid_ids:
+ network_policy_name:
+ type: string
+ description: The network policy name
+ ssid:
+ type: string
+ description: The SSID
+ ssid_status:
+ $ref: '#/components/schemas/XiqSsidStatus'
+ description: The SSID status
+ ssid_security_type:
+ $ref: '#/components/schemas/XiqSsidSecurityType'
+ description: The SSID access security type
+ XiqRadio:
+ type: object
+ description: ExtremeCloud IQ Radio Information associated to a device
+ required:
+ - name
+ - channel_number
+ - channel_width
+ - mode
+ - mac
+ - power
+ properties:
+ name:
+ type: string
+ description: The radio name
+ channel_number:
+ type: integer
+ description: The channel number
+ format: int32
+ channel_width:
+ type: string
+ description: The channel width
+ mode:
+ type: string
+ description: The radio mode
+ mac_address:
+ type: string
+ description: The radio MAC address
+ power:
+ type: integer
+ description: The radio power
+ format: int32
+ clients:
type: array
- description: The one or multiple SSID to be disabled/enabled, cannot be empty or no action will be triggered.
+ description: the wireless client details
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:
+ $ref: '#/components/schemas/XiqWirelessClient'
+ XiqRadioEntity:
+ type: object
+ description: ExtremeCloud IQ Radio Information per device
+ required:
+ - device_id
+ properties:
+ device_id:
+ type: integer
+ description: The device ID
+ format: int64
+ radios:
type: array
- description: The 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.
+ description: The radio information associated to device
items:
- $ref: '#/components/schemas/XiqWirelessIfName'
- enabled:
- type: boolean
- description: To disable or enable the given device level SSIDs on the wifi interfaces.
- XiqDeviceAlarm:
+ $ref: '#/components/schemas/XiqRadio'
+ PagedXiqRadioEntity:
+ allOf:
+ - $ref: '#/components/schemas/XiqPage'
+ - type: object
+ properties:
+ data:
+ type: array
+ description: The data in the current page
+ items:
+ $ref: '#/components/schemas/XiqRadioEntity'
+ 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
- description: The device alarm view
+ required:
+ - name
+ - type
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:
+ name:
type: string
- description: The category of the alarm
- device_mac:
+ description: The network policy name
+ description:
type: string
- description: The device MAC of the alarm
- client_mac:
+ description: The network policy description
+ type:
+ $ref: '#/components/schemas/XiqNetworkPolicyType'
+ XiqUpdateNetworkPolicyRequest:
+ type: object
+ properties:
+ name:
type: string
- description: The client MAC of the alarm
+ description: The network policy name
description:
type: string
- description: The alarm description
- PagedXiqDeviceAlarm:
+ 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
+ - RSSI
+ - SNR
+ - RADIO_TYPE
+ - WING_AP
+ - VENDOR
+ - MOBILITY
+ - CATEGORY
+ - DESCRIPTION
+ - DEVICE_MAC_ADDRESS
+ - ALIAS
+ - PRODUCT_TYPE
+ XiqClientView:
+ type: string
+ description: The logic collections of client fields
BASIC: ID, ORG_ID, HOSTNAME, MAC_ADDRESS, IP_ADDRESS, IPV6_ADDRESS, OS_TYPE, DEVICE_ID,CONNECTED, ONLINE_TIME, OFFLINE_TIME, CONNECTION_TYPE, SSID, PORT
FULL: All fields
STATUS: ID, CONNECTED, ONLINE_TIME, OFFLINE_TIME
DETAIL: ID, CREATE_TIME, UPDATE_TIME, ORG_ID, ORG_NAME, LOCATION_ID, HOSTNAME, MAC_ADDRESS, IP_ADDRESS, IPV6_ADDRESS, OS_TYPE, DEVICE_ID, DEVICE_FUNCTION, DEVICE_NAME, DEVICE_MAC_ADDRESS, USERNAME, USER_PROFILE_NAME, CONNECTED, ONLINE_TIME, OFFLINE_TIME, VLAN, CONNECTION_TYPE, SSID, PORT, BSSID, PORT_TYPE_NAME, INTERFACE_NAME, AUTH, ENCRYPTION_METHOD, CHANNEL, RSSI, SNR, WING_AP, VENDOR, RADIO_TYPE, ALIAS
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'
+ productType:
+ type: string
+ description: The Category which describes the Extreme device types(For example:SR_2208P, AP_4000, AP_5010)
+ alias:
+ type: string
+ maxLength: 255
+ description: The alias of the client
+ PagedXiqClient:
allOf:
- $ref: '#/components/schemas/XiqPage'
- type: object
@@ -10434,209 +12113,107 @@ components:
type: array
description: The data in the current page
items:
- $ref: '#/components/schemas/XiqDeviceAlarm'
- XiqDeviceCpuMemoryUsage:
+ $ref: '#/components/schemas/XiqClient'
+ XiqClientSummary:
type: object
- description: Get time series of the average device cpu and memory usage
+ description: The summary for clients
properties:
- average_cpu:
- type: integer
- description: The device average cpu usage
- format: int32
- average_memory:
+ connected_wireless_client_count:
type: integer
- description: The device average memory usage
- format: int32
- timestamp:
+ description: The connected wireless client count
+ format: int64
+ detected_wired_client_count:
type: integer
- description: The timestamp for data aggregate
+ description: The detected wired client count
format: int64
- XiqDeviceIbeacon:
+ XiqClientUsage:
type: object
- description: The device iBeacon settings.
- required:
- - enabled
- - major
- - minor
- - power
- - enable_monitoring
+ description: The client usage over the period
properties:
- id:
+ client_id:
type: integer
- description: The device iBeacon ID.
+ description: The client 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:
+ usage:
type: integer
- description: The beacon network policy ID.
+ description: The client total usage
format: int64
- XiqDigitalTwinProducts:
- type: object
- description: The Digital Twin product information.
- required:
- - make
- - model
- - os_versions
- properties:
- make:
- type: string
- description: The Digital Twin device make.
- model:
- type: string
- description: The Digital Twin device model.
- os_type:
- type: string
- description: The Digital Twin device OS type.
- os_versions:
- type: array
- description: The Digital Twin device OS versions.
- items:
- type: string
- description: The Digital Twin device OS versions.
- PagedXiqDigitalTwinProducts:
- allOf:
- - $ref: '#/components/schemas/XiqPage'
- - type: object
- properties:
- data:
- type: array
- description: The data in the current page
- items:
- $ref: '#/components/schemas/XiqDigitalTwinProducts'
- XiqBounceDevicePortRequest:
- type: object
- description: The request for bounce port for the given device id.
- required:
- - interfaceName
- properties:
- portNumber:
- type: string
- description: The port number of the device (eg. 1,2, ..)
- bouncePortReason:
- type: string
- description: The reason to bounce the port of the specific device/switch.
- XiqBounceDevicePortOperationResult:
- allOf:
- - type: object
- description: Generic ExtremeCloud IQ Device model
- properties:
- status:
- type: string
- description: The status value
- message:
- type: string
- description: The message
- XiqBounceDevicePortData:
- allOf:
- - type: object
- description: Generic ExtremeCloud IQ Device model
- properties:
- status:
- type: integer
- description: The status value
- requestId:
- type: integer
- description: The requestId of the response
- format: int32
- results:
- type: array
- description: The list of results
- items:
- $ref: '#/components/schemas/XiqBounceDevicePortOperationResult'
- XiqBounceDevicePortResponse:
- allOf:
- - type: object
- description: Generic ExtremeCloud IQ Device model
- properties:
- data:
- $ref: '#/components/schemas/XiqBounceDevicePortData'
- XiqDeviceInstallationReportResponse:
+ XiqClientMacAddressAlias:
type: object
- description: The device installation response
+ description: The client's mac address and alias
required:
- - onboarded
- - location_name
- - network_policy_name
- - device_template_name
- - ip_address
- - default_gateway
- - ntp_server
- - dns_server
- - enable_poe
- - xiq_connectivity
- - installation_images
+ - mac_address
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:
+ mac_address:
type: string
- description: ntp server address
- dns_server:
+ minLength: 12
+ maxLength: 12
+ description: The MAC address of the client
+ alias:
type: string
- description: dns server address
- enable_poe:
- type: boolean
- description: Enable PoE
- xiq_connectivity:
- type: boolean
- description: Cloud or Locally managed indicator. True means Cloud managed device
- installation_images:
- type: boolean
- description: Device contains installation images or not
- XiqThreadStartCommissionerRequest:
+ maxLength: 255
+ description: The alias of the client
+ GetActiveClientsResponse:
type: object
- description: Start the Thread Commissioner on a thread router device.
properties:
- comm_timeout:
+ count:
type: integer
- default: 120
- minimum: 1
- maximum: 2000000
- description: After this timeout the Commissioner will shutdown. The default is 120 sec. but the max is approximately 23 days.
- interface_name:
- type: string
- description: The IoT interface on which to start the Commissioner. The default is iot0.
- XiqThreadStopCommissionerRequest:
+ 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: Stop the Thread Commissioner on a thread router device.
+ description: The Application Detection Rule
properties:
- interface_name:
+ value:
type: string
- description: The IoT interface on which to stop the Commissioner. The default is iot0.
- PagedXiqNetworkPolicy:
+ 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
@@ -10645,66 +12222,195 @@ components:
type: array
description: The data in the current page
items:
- $ref: '#/components/schemas/XiqNetworkPolicy'
- XiqNetworkPolicyType:
+ $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
+ XiqAlertSortField:
type: string
- description: The network policy type
+ description: All available device sort fields TIMESTAMP = Last Detected, SOURCE = Source Name.
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:
+ - TIMESTAMP
+ - SOURCE
+ XiqAlertSource:
type: object
+ description: The alert source info
+ properties:
+ source_type_id:
+ type: string
+ description: The alert source type ID.
+ source_name:
+ type: string
+ description: The alert source name
+ source_type:
+ type: string
+ description: The alert source type.
+ source_id:
+ type: string
+ description: The alert source ID.
required:
- - name
- - type
+ - source_type_id
+ - source_name
+ - source_type
+ - source_id
+ XiqAlertTag:
+ type: object
+ description: The tag for the alert
properties:
+ id:
+ type: integer
+ format: int64
+ description: The unique identifier for the tag metadata
name:
type: string
- description: The network policy name
- description:
+ description: The tag display name
+ value:
type: string
- description: The network policy description
- type:
- $ref: '#/components/schemas/XiqNetworkPolicyType'
- XiqUpdateNetworkPolicyRequest:
+ description: The tag value
+ is_hidden:
+ type: boolean
+ description: If tag should be hidden from the user
+ required:
+ - id
+ - name
+ - value
+ - is_hidden
+ XiqAlert:
type: object
+ description: The Alert Model
properties:
- name:
+ id:
type: string
- description: The network policy name
- description:
+ description: The unique identifier
+ owner_id:
+ type: integer
+ description: The owner ID
+ format: int64
+ timestamp:
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:
+ description: The alert create time
+ format: date-time
+ org_id:
+ type: integer
+ description: The organization identifier, valid when enabling HIQ feature
+ format: int64
+ message_metadata_id:
+ type: integer
+ format: int64
+ description: The identifier for the unique message type that corresponds to this rule. If message_metadata_type is "EVENT", then this identifier corresponds to the ID from the alerts metadata events API. If message_metadata_type is "METRIC", then this identifier corresponds to the ID from the alerts metadata metrics API.
+ message_metadata_type:
+ type: string
+ description: The type of the message. Currently "EVENT" and "METRIC". Used for getting the metadata API.
+ summary:
+ type: string
+ description: A high-level, text summary message of the event. Will be used to construct an alert's description.
+ severity_id:
+ type: integer
+ format: int64
+ description: The alert severity ID.
+ severity_name:
+ type: string
+ description: The alert severity name.
+ category_id:
+ type: integer
+ format: int64
+ description: The alert category ID.
+ category_name:
+ type: string
+ description: The alert category name.
+ source:
+ $ref: '#/components/schemas/XiqAlertSource'
+ acknowledged:
+ type: boolean
+ description: Whether or not this alert has been acknowledged.
+ site_id:
+ type: integer
+ description: The site identifier.
+ format: int64
+ site_name:
+ type: string
+ description: The site name.
+ alert_policy_id:
+ type: integer
+ description: The alert policy identifier.
+ format: int64
+ alert_policy_name:
+ type: string
+ description: The alert policy name.
+ alert_rule_id:
+ type: integer
+ description: The alert rule identifier.
+ format: int64
+ acknowledged_username:
+ type: string
+ description: The login name of the user that acknowledged the alert.
+ tags:
+ type: array
+ description: Additional information for the alert. The values correspond to the object from the alerts/metadata/tags API.
+ items:
+ $ref: '#/components/schemas/XiqAlertTag'
+ required:
+ - id
+ - owner_id
+ - timestamp
+ - message_metadata_id
+ - message_metadata_type
+ - summary
+ - severity_id
+ - severity_name
+ - category_id
+ - category_name
+ - source
+ - acknowledged
+ - site_id
+ - site_name
+ - alert_policy_id
+ - alert_policy_name
+ - alert_rule_id
+ - tags
+ PagedXiqAlert:
allOf:
- $ref: '#/components/schemas/XiqPage'
- type: object
@@ -10713,470 +12419,535 @@ components:
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
- - RSSI
- - SNR
- - RADIO_TYPE
- - WING_AP
- - VENDOR
- - MOBILITY
- - CATEGORY
- - DESCRIPTION
- - DEVICE_MAC_ADDRESS
- - ALIAS
- - PRODUCT_TYPE
- XiqClientView:
+ $ref: '#/components/schemas/XiqAlert'
+ alertIds:
+ type: object
+ description: The request object to acknowledge.
+ properties:
+ alert_ids:
+ type: array
+ description: The alert ID list
+ items:
+ type: string
+ description: The alert ID
+ XiqAlertGroupQuery:
type: string
- description: The logic collections of client fields
BASIC: ID, ORG_ID, HOSTNAME, MAC_ADDRESS, IP_ADDRESS, IPV6_ADDRESS, OS_TYPE, DEVICE_ID,CONNECTED, ONLINE_TIME, OFFLINE_TIME, CONNECTION_TYPE, SSID, PORT
FULL: All fields
STATUS: ID, CONNECTED, ONLINE_TIME, OFFLINE_TIME
DETAIL: ID, CREATE_TIME, UPDATE_TIME, ORG_ID, ORG_NAME, LOCATION_ID, HOSTNAME, MAC_ADDRESS, IP_ADDRESS, IPV6_ADDRESS, OS_TYPE, DEVICE_ID, DEVICE_FUNCTION, DEVICE_NAME, DEVICE_MAC_ADDRESS, USERNAME, USER_PROFILE_NAME, CONNECTED, ONLINE_TIME, OFFLINE_TIME, VLAN, CONNECTION_TYPE, SSID, PORT, BSSID, PORT_TYPE_NAME, INTERFACE_NAME, AUTH, ENCRYPTION_METHOD, CHANNEL, RSSI, SNR, WING_AP, VENDOR, RADIO_TYPE, ALIAS
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:
+ - SEVERITY
+ - CATEGORY
+ - ALERT_TYPE
+ XiqAlertGroupCount:
+ type: object
+ properties:
+ group_id:
+ type: integer
+ description: The group unique identifier.
+ format: int64
+ group_name:
+ type: string
+ description: The group display name on GUI.
+ count:
+ type: integer
+ description: The count of the type.
+ format: int64
+ description: The alert group count information. When the group is SEVERITY, the group_id will be severity ID When the group is CATEGORY, the group_id will be category ID When the group is ALERT_TYPE, the group_id will be message metadata ID.
+ required:
+ - group_id
+ - group_name
+ - count
+ XiqAlertReport:
+ type: object
+ description: ExtremeCloud IQ alert report
+ properties:
+ id:
+ type: integer
+ description: The alert report ID
+ format: int64
+ XiqAlertEmailSubscription:
allOf:
- - $ref: '#/components/schemas/XiqLocationEntity'
+ - $ref: '#/components/schemas/XiqBaseEntity'
- type: object
- properties:
- device_id:
- type: integer
- description: The device identifier
- format: int64
+ description: The email subscription data model
required:
- - device_id
- XiqClient:
- allOf:
- - $ref: '#/components/schemas/XiqDeviceEntity'
- - type: object
+ - email
+ - is_email_verified
+ - is_subscribe_all
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:
+ email:
type: string
- description: The user profile name of the client
- connected:
+ format: email
+ description: The email address.
+ is_enabled:
type: boolean
- description: Client is connected or not
- online_time:
- type: string
- description: The online time for the client
- format: date-time
- offline_time:
+ description: Enable/disable alert notifications for an email.
+ is_email_verified:
+ type: boolean
+ description: The email address verified flag.
+ is_subscribe_all:
+ type: boolean
+ description: The all alert policy selected flag.
+ alert_policy_ids:
+ type: array
+ items:
+ type: integer
+ format: int64
+ description: The selected alert policy list. This field is optional because it is only needed when is_subscribe_all is false.
+ resend_email_after:
type: string
- 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:
+ description: This field represents the time after for the user can resend a new verification email.
+ XiqCreateAlertEmailSubscriptionRequest:
+ type: object
+ description: The payload to create email subscription
+ required:
+ - email
+ - is_subscribe_all
+ - alert_policy_ids
+ properties:
+ email:
+ type: string
+ format: email
+ description: The email address.
+ is_enabled:
+ type: boolean
+ description: Enable/disable alert notifications for an email.
+ is_subscribe_all:
+ type: boolean
+ description: The all alert policy selected flag.
+ alert_policy_ids:
+ type: array
+ items:
type: integer
- description: The encryption method
- format: int32
- interface_name:
- type: string
- description: The interface name
- bssid:
- type: string
- description: The bssid
- rssi:
+ format: int64
+ description: The selected alert policy list. This field will be an empty collection when is_subscribe_all is true.
+ subscriptionIds:
+ type: object
+ description: The filter to get alert subscriptions
+ properties:
+ ids:
+ type: array
+ description: The subscription ID list
+ items:
type: integer
- description: The RSSI
- format: int32
- snr:
+ description: The subscription ID list
+ format: int64
+ XiqBulkOperationResult:
+ type: string
+ enum:
+ - PARTIAL_SUCCESS
+ - SUCCESS
+ XiqBulkDeleteEmailSubscriptionResult:
+ type: object
+ description: The result of bulk detele email susbscriptions.
+ properties:
+ ID:
+ type: integer
+ format: int64
+ description: The ID of email subscription.
+ XiqDeleteBulkAlertSubscriptionEmailResponse:
+ type: object
+ description: The result of a bulk delete for alert email subscriptions.
+ required:
+ - result
+ properties:
+ result:
+ type: string
+ description: The result of this bulk deletion (SUCCESS/PARTIAL_SUCCESS).
+ $ref: '#/components/schemas/XiqBulkOperationResult'
+ example: PARTIAL_SUCCESS
+ reason:
+ type: string
+ description: Indicate the reason of unresolved_deletion.
+ example: At least one ID not found.
+ unresolved_deletions:
+ type: array
+ description: This result will be shown when a bulk delete partially succeeds, providing details of unsuccessful delete IDs and associated names.
+ items:
+ $ref: '#/components/schemas/XiqBulkDeleteEmailSubscriptionResult'
+ XiqUpdateAlertEmailSubscriptionRequest:
+ type: object
+ description: The payload to create email subscription
+ required:
+ - alert_policy_ids
+ properties:
+ email:
+ type: string
+ format: email
+ description: The email address.
+ is_enabled:
+ type: boolean
+ description: Enable/disable alert notifications for an email.
+ is_subscribe_all:
+ type: boolean
+ description: The all alert policy selected flag.
+ alert_policy_ids:
+ type: array
+ items:
type: integer
- description: The SNR
- format: int32
- description:
- type: string
- description: The description of client
- category:
- type: string
- description: The category of client
- mobility:
- type: string
- description: The client mobility
- port_type_name:
- type: string
- description: The client port type name
- wing_ap:
- type: boolean
- description: Wing ap flag
- vendor:
- type: string
- description: The vendor of client
- locations:
- type: array
- description: The detailed location
- items:
- $ref: '#/components/schemas/XiqLocationLegend'
- productType:
- type: string
- description: The Category which describes the Extreme device types(For example:SR_2208P, AP_4000, AP_5010)
- alias:
- type: string
- maxLength: 255
- description: The alias of the client
- PagedXiqClient:
+ format: int64
+ description: The selected alert policy list. This field will be an empty collection when is_subscribe_all is true.
+ XiqAlertWebhookSubscription:
allOf:
- - $ref: '#/components/schemas/XiqPage'
+ - $ref: '#/components/schemas/XiqBaseEntity'
- type: object
+ description: The webhook subscription data model
+ required:
+ - url
+ - is_subscribe_all
properties:
- data:
+ url:
+ type: string
+ format: uri
+ description: The webhook endpoint URL.
+ secret:
+ type: string
+ description: The auth secret for the webhook endpoint.
+ is_enabled:
+ type: boolean
+ description: Enable/disable alert notifications for a webhook endpoint.
+ is_subscribe_all:
+ type: boolean
+ description: The all alert policy selected flag.
+ alert_policy_ids:
type: array
- description: The data in the current page
items:
- $ref: '#/components/schemas/XiqClient'
- XiqClientSummary:
+ type: integer
+ format: int64
+ description: The selected alert policy list. This field is optional because it is only needed when is_subscribe_all is false.
+ XiqCreateAlertWebhookSubscriptionRequest:
type: object
- description: The summary for clients
+ description: The payload to create webhook subscription
+ required:
+ - url
+ - is_subscribe_all
+ - alert_policy_ids
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:
+ url:
+ type: string
+ format: uri
+ description: The webhook endpoint URL.
+ secret:
+ type: string
+ description: The auth secret for the webhook endpoint.
+ is_enabled:
+ type: boolean
+ description: Enable/disable alert notifications for a webhook url.
+ is_subscribe_all:
+ type: boolean
+ description: The all alert policy selected flag.
+ alert_policy_ids:
+ type: array
+ items:
+ type: integer
+ format: int64
+ description: The selected alert policy list. This field will be an empty collection when is_subscribe_all is true.
+ XiqBulkDeleteWebhookSubscriptionResult:
type: object
- description: The client usage over the period
+ description: The result of bulk detele webhook susbscriptions.
properties:
- client_id:
- type: integer
- description: The client ID
- format: int64
- usage:
+ ID:
type: integer
- description: The client total usage
format: int64
- XiqClientMacAddressAlias:
+ description: The ID of webhook subscription.
+ XiqDeleteBulkAlertSubscriptionWebhookResponse:
type: object
- description: The client's mac address and alias
+ description: The result of a bulk delete for alert webhook subscriptions.
required:
- - mac_address
+ - result
properties:
- mac_address:
+ result:
type: string
- minLength: 12
- maxLength: 12
- description: The MAC address of the client
- alias:
+ description: The result of this bulk deletion (SUCCESS/PARTIAL_SUCCESS).
+ $ref: '#/components/schemas/XiqBulkOperationResult'
+ reason:
type: string
- maxLength: 255
- description: The alias of the client
- GetActiveClientsResponse:
+ description: Indicate the reason of unresolved_deletion.
+ example: At least one ID not found.
+ unresolved_deletions:
+ type: array
+ description: This result will be shown when a bulk delete partially succeeds, providing details of unsuccessful delete IDs and associated names.
+ items:
+ $ref: '#/components/schemas/XiqBulkDeleteWebhookSubscriptionResult'
+ XiqUpdateAlertWebhookSubscriptionRequest:
type: object
+ description: The payload to create webhook subscription
+ required:
+ - alert_policy_ids
properties:
- count:
- type: integer
- description: The connected wireless client count
- format: int64
- XiqApplicationSortField:
- type: string
- enum:
- - NAME
- - CATEGORY
- XiqApplicationDetectionProtocol:
- type: string
- enum:
- - HTTP
- - HTTPS
- XiqApplicationDetectionType:
+ url:
+ type: string
+ format: uri
+ description: The webhook endpoint URL.
+ secret:
+ type: string
+ description: The auth secret for the webhook endpoint.
+ is_enabled:
+ type: boolean
+ description: Enable/disable alert notifications for a webhook url.
+ is_subscribe_all:
+ type: boolean
+ description: The all alert policy selected flag.
+ alert_policy_ids:
+ type: array
+ items:
+ type: integer
+ format: int64
+ description: The selected alert policy list. This field will be an empty collection when is_subscribe_all is true.
+ XiqAlertPolicyType:
type: string
+ description: All available policy type GLOBAL and SITE.
enum:
- - HOST_NAME
- - SERVER_IP_ADDRESS
- - PORT_NUMBER
- XiqApplicationDetectionRule:
+ - GLOBAL
+ - SITE
+ XiqAlertSite:
type: object
- description: The Application Detection Rule
properties:
- value:
+ site_id:
+ type: integer
+ description: The location unique identifier
+ format: int64
+ site_name:
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:
+ description: The site name
+ description: The site information.
+ required:
+ - site_id
+ - site_name
+ XiqAlertRuleOverview:
type: object
- description: The Top N Applications Usage
+ description: The overview for an alert rule. Detailed information is available from the get alert rule API.
properties:
id:
type: integer
- description: The application ID
format: int64
+ description: The unique identifier of this rule.
name:
type: string
- description: The application name
- clients:
- type: integer
- description: The associated unique client count
- format: int64
- users:
+ description: The human-readable name of this rule. Corresponds to the message_metadata_name from the get alert rule details API.
+ enabled:
+ type: boolean
+ description: Indicates whether this rule is in effect.
+ required:
+ - id
+ - name
+ - enabled
+ XiqAlertEventRulesByCategory:
+ type: object
+ description: A category and overviews of the associated event-based alert rules.
+ properties:
+ category_id:
type: integer
- description: The associated unique user count
format: int64
- usage:
+ category_name:
+ type: string
+ rules:
+ type: array
+ items:
+ $ref: '#/components/schemas/XiqAlertRuleOverview'
+ required:
+ - category_id
+ - category_name
+ - rules
+ XiqAlertMetricRulesByMetricset:
+ type: object
+ description: A metricset and overviews of the associated metric-based alert rules.
+ properties:
+ metricset_id:
type: integer
- description: The application usage
format: int64
- XiqApplicationTopClientsUsage:
+ metricset_name:
+ type: string
+ rules:
+ type: array
+ items:
+ $ref: '#/components/schemas/XiqAlertRuleOverview'
+ required:
+ - metricset_id
+ - metricset_name
+ - rules
+ XiqAlertPolicy:
type: object
- description: The Top N Clients Usage per Application
properties:
- application_id:
+ id:
type: integer
- description: The application ID
+ description: The unique identifier
format: int64
- client_id:
+ owner_id:
type: integer
- description: The TOP N client ID
+ description: The owner 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:
+ org_id:
type: integer
- description: The TOP N client usage
+ description: The organization identifier, valid when enabling HIQ feature
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:
+ name:
+ type: string
+ description: The name of this policy
+ sites:
+ type: array
+ items:
+ $ref: '#/components/schemas/XiqAlertSite'
+ event_rules_overview:
+ type: array
+ description: A list of overviews of the event-based alert rules, grouped by category.
+ items:
+ $ref: '#/components/schemas/XiqAlertEventRulesByCategory'
+ metric_rules_overview:
+ type: array
+ description: A list of overviews of the metric-based alert rules, grouped by metricset.
+ items:
+ $ref: '#/components/schemas/XiqAlertMetricRulesByMetricset'
+ description: The alert policy model. Includes the alert policy and the associated rules.
+ required:
+ - id
+ - owner_id
+ - org_id
+ - name
+ - event_rules_overview
+ - metric_rules_overview
+ XiqCreateAlertPolicyRequest:
type: object
- description: The alert source info
+ description: The body of a create alert policy request.
properties:
- source_name:
+ name:
type: string
- description: The alert source name
- source_type:
- $ref: '#/components/schemas/XiqAlertSourceType'
- source_id:
+ description: The alert policy name
+ site_ids:
+ type: array
+ description: The list of sites to be included in this policy
+ items:
+ type: integer
+ format: int64
+ required:
+ - name
+ - site_ids
+ XiqUpdateAlertPolicyRequest:
+ type: object
+ description: The request body for updating an alert policy.
+ required:
+ - site_ids
+ properties:
+ name:
type: string
- description: The alert source ID
- XiqAlert:
+ description: The alert policy name
+ site_ids:
+ type: array
+ description: The list of sites to be included in this policy
+ items:
+ type: integer
+ format: int64
+ XiqAlertRuleThresholdOperator:
+ type: string
+ enum:
+ - GT
+ - GE
+ - EQ
+ - LT
+ - LE
+ - NE
+ description: Has value when message_metadata_type is "METRIC". The operator for comparing with the threshold.
+ XiqAlertRule:
type: object
+ description: The state for a configured alert rule.
properties:
id:
- type: string
- description: The unique identifier
- owner_id:
type: integer
- description: The owner ID
+ description: The unique identifier of this rule.
format: int64
- timestamp:
+ message_metadata_id:
+ type: integer
+ format: int64
+ description: The identifier for the unique message type that corresponds to this rule. If message_metadata_type is "EVENT", then this identifier corresponds to the ID from the alerts metadata events API. If message_metadata_type is "METRIC", then this identifier corresponds to the ID from the alerts metadata metrics API.
+ message_metadata_name:
type: string
- description: The alert create time
- format: date-time
- org_id:
+ description: The display name for the message. Can also be used as a display name for this rule.
+ message_metadata_type:
+ type: string
+ description: The type of the message. Currently "EVENT" and "METRIC". Used for getting the metadata API.
+ description:
+ type: string
+ description: This is a description for the alert rule.
+ severity_id:
type: integer
- description: The organization identifier, valid when enabling HIQ feature
format: int64
- type:
+ description: The severity identifier. The currently supported severity IDs are 1 for critical, 2 for warning, and 3 for info.
+ severity_name:
type: string
- description: The alert type
- summary:
+ description: The display name for the alert severity.
+ trigger_type:
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
+ description: The configured trigger type of the rule. Currently "DEFERRED", "REPEATED", and "IMMEDIATE". Additional values may be added in the future.
+ example: DEFERRED
+ is_enabled:
+ type: boolean
+ description: True if this rule is active and enabled.
+ duration:
+ type: integer
+ format: int32
+ description: Has value when trigger_type is "DEFERRED". The deferred duration, in seconds.
+ example: 1
+ time_window:
+ type: integer
+ format: int32
+ description: Has value when trigger_type is "REPEATED". The time window to count the number of repeated messages, in seconds.
+ count:
+ type: integer
+ format: int32
+ description: Has value when trigger_type is "REPEATED". The lower bound of the number of messages required to trigger this rule.
+ example: 3
+ threshold:
+ type: number
+ format: double
+ description: Has value when message_metadata_type is "METRIC". The threshold for the metric.
+ unit:
+ type: string
+ description: The unit of this threshold
+ operator:
+ $ref: '#/components/schemas/XiqAlertRuleThresholdOperator'
+ required:
+ - id
+ - message_metadata_id
+ - message_metadata_name
+ - message_metadata_type
+ - description
+ - severity_id
+ - severity_name
+ - trigger_type
+ - is_enabled
+ XiqUpdateAlertRuleRequest:
+ type: object
+ properties:
+ description:
+ type: string
+ description: This is a description for the alert rule.
+ severity_id:
+ type: integer
+ format: int64
+ description: The severity identifier. The currently supported severity IDs are 1 for critical, 2 for warning, and 3 for info.
+ trigger_type:
+ type: string
+ description: The configured trigger type of the rule. Currently "DEFERRED", "REPEATED", and "IMMEDIATE". Additional values may be added in the future.
+ example: DEFERRED
+ duration:
+ type: integer
+ format: int32
+ description: Has value when trigger_type is "DEFERRED". The deferred duration, in seconds.
+ example: 1
+ time_window:
+ type: integer
+ format: int32
+ description: Has value when trigger_type is "REPEATED". The time window to count the number of repeated messages, in seconds.
+ count:
+ type: integer
+ format: int32
+ description: Has value when trigger_type is "REPEATED". The lower bound of the number of messages required to trigger this rule.
+ example: 3
+ threshold:
+ type: number
+ format: double
+ description: Has value when type is "METRIC". The threshold for the message.
+ operator:
+ $ref: '#/components/schemas/XiqAlertRuleThresholdOperator'
XiqAuditLogCategory:
type: string
enum:
@@ -15545,6 +17316,11 @@ components:
description: The data in the current page
items:
$ref: '#/components/schemas/XiqCertificate'
+ XiqClientType:
+ type: string
+ enum:
+ - WIRELESS
+ - WIRED
XiqCopilotConnectivityExperienceEntity:
type: object
description: Copilot Experience Entity
@@ -15554,6 +17330,7 @@ components:
- info
- quality_index
- trend_indicator
+ - client_type
- quality_index_graph
properties:
id:
@@ -15572,6 +17349,9 @@ components:
- UP
- DOWN
- EQUAL
+ - NA
+ client_type:
+ $ref: '#/components/schemas/XiqClientType'
quality_index_graph:
type: array
description: The data in the current page
@@ -15871,6 +17651,9 @@ components:
maximum: 100
XiqCopilotHardware:
type: object
+ description: Wired Connectivity Experience Hardware
+ required:
+ - quality_index_graph
properties:
quality_index_graph:
type: array
@@ -15915,6 +17698,154 @@ components:
description: The data in the current page
items:
$ref: '#/components/schemas/XiqCopilotWiredEventEntity'
+ XiqQualityIndex:
+ type: string
+ enum:
+ - LOW
+ - MEDIUM
+ - HIGH
+ XiqCopilotConnectivityByLocationsEntity:
+ type: object
+ description: Copilot Experience Entity
+ required:
+ - id
+ - name
+ - quality_index
+ - quality_index_value
+ - client_type
+ - quality_index_graph
+ properties:
+ id:
+ type: string
+ name:
+ type: string
+ quality_index:
+ type: integer
+ minimum: 1
+ maximum: 10
+ quality_index_value:
+ $ref: '#/components/schemas/XiqQualityIndex'
+ client_type:
+ $ref: '#/components/schemas/XiqClientType'
+ quality_index_graph:
+ type: array
+ description: The data in the current page
+ items:
+ type: object
+ description: Connectivity experience quality sequence
+ required:
+ - timestamp
+ - value
+ properties:
+ timestamp:
+ type: integer
+ format: int64
+ value:
+ type: integer
+ minimum: 1
+ maximum: 10
+ XiqCopilotConnectivityByLocations:
+ allOf:
+ - $ref: '#/components/schemas/XiqPage'
+ - type: object
+ properties:
+ data:
+ type: array
+ description: The data in the current page
+ items:
+ $ref: '#/components/schemas/XiqCopilotConnectivityByLocationsEntity'
+ XiqCopilotConnectivityByClientType:
+ type: object
+ description: data sequence
+ required:
+ - sites_by_wireless
+ - sites_by_wired
+ properties:
+ sites_by_wireless:
+ type: object
+ description: The data in the current page
+ required:
+ - low_quality_score_count
+ - medium_quality_score_count
+ - high_quality_score_count
+ - total_quality_score_count
+ properties:
+ low_quality_score_count:
+ type: integer
+ format: int32
+ medium_quality_score_count:
+ type: integer
+ format: int32
+ high_quality_score_count:
+ type: integer
+ format: int32
+ total_quality_score_count:
+ type: integer
+ format: int32
+ sites_by_wired:
+ type: object
+ description: The data in the current page
+ required:
+ - low_quality_score_count
+ - medium_quality_score_count
+ - high_quality_score_count
+ - total_quality_score_count
+ properties:
+ low_quality_score_count:
+ type: integer
+ format: int32
+ medium_quality_score_count:
+ type: integer
+ format: int32
+ high_quality_score_count:
+ type: integer
+ format: int32
+ total_quality_score_count:
+ type: integer
+ format: int32
+ XiqCopilotWirelessQualityIndexByLocation:
+ type: object
+ description: Wireless Connectivity Experience QualityIndex
+ required:
+ - quality_index
+ - time_to_connect_score
+ - performance_score
+ - total_clients
+ properties:
+ quality_index:
+ type: integer
+ minimum: 1
+ maximum: 10
+ time_to_connect_score:
+ type: integer
+ minimum: 1
+ maximum: 10
+ performance_score:
+ type: integer
+ minimum: 1
+ maximum: 10
+ total_clients:
+ type: integer
+ format: int32
+ XiqCopilotHardwareByLocation:
+ type: object
+ description: Wired Connectivity Experience Hardware
+ required:
+ - quality_index_graph
+ - total_ports
+ - total_affected_ports
+ properties:
+ quality_index_graph:
+ type: array
+ description: The data in the current page
+ items:
+ $ref: '#/components/schemas/XiqCopilotHardwareEntity'
+ total_ports:
+ type: integer
+ format: int32
+ total_affected_ports:
+ type: integer
+ format: int32
XiqAnomalyType:
type: string
enum:
@@ -17182,6 +19113,63 @@ components:
type: number
description: The located client's last known vertical value on the floor plan
format: double
+ XiqCountry:
+ type: object
+ description: The country list and country codes.
+ required:
+ - alpha2_code
+ - country_code
+ - short_name
+ properties:
+ dial_code:
+ description: The dialing code for international calls, typically prefixed by the '+' key for mobile.
+ type: string
+ alpha2_code:
+ description: The country ISO 2-letter code.
+ type: string
+ country_code:
+ description: The country ISO numeric code.
+ format: int32
+ maximum: 999
+ minimum: 1
+ type: integer
+ internal_country_codes:
+ description: Extreme IQ internal country codes.
+ items:
+ description: Extreme IQ internal country codes.
+ format: int32
+ type: integer
+ type: array
+ short_name:
+ description: The country short name.
+ type: string
+ name_en:
+ description: The country official name in English.
+ type: string
+ name_jp:
+ description: The country official name in Japanese.
+ type: string
+ name_fr:
+ description: The country official name in French.
+ type: string
+ name_de:
+ description: The country official name in German.
+ type: string
+ name_it:
+ description: The country official name in Italian.
+ type: string
+ name_pt:
+ description: The country official name in Portuguese.
+ type: string
+ name_zh:
+ description: The country official name in Chinese.
+ type: string
+ name_es:
+ description: The country official name in Spanish.
+ type: string
+ name_ko:
+ description: The country official name in Korean.
+ type: string
responses:
ErrorResponse:
description: The generic ExtremeCloud IQ API error response
@@ -17266,6 +19254,16 @@ components:
schema:
type: integer
format: int64
+ deviceIds:
+ name: deviceIds
+ in: query
+ description: The device IDs
+ required: false
+ schema:
+ type: array
+ items:
+ type: integer
+ format: int64
fields:
name: fields
in: query
@@ -17284,16 +19282,6 @@ components:
type: array
items:
$ref: '#/components/schemas/XiqClientView'
- deviceIds:
- name: deviceIds
- in: query
- description: The device IDs
- required: false
- schema:
- type: array
- items:
- type: integer
- format: int64
mac:
name: clientMac
in: path
@@ -17311,6 +19299,57 @@ components:
minimum: 1
type: integer
format: int32
+ acknowledged:
+ in: query
+ name: acknowledged
+ description: Default is null, which will return all alerts. Set it to false to only return unacknowledged alerts. Otherwise, set it to true only return acknowledged alerts.
+ required: false
+ schema:
+ type: boolean
+ categoryIds:
+ in: query
+ description: The alert category Ids to filter, use alert/metadata API to get category information.
+ name: categoryIds
+ required: false
+ schema:
+ type: array
+ description: The alert category ID list.
+ items:
+ type: integer
+ format: int64
+ description: The alert category ID.
+ severityIds:
+ in: query
+ description: The alert severity identifiers to filter. The currently supported severity IDs are 1 for critical, 2 for warning, and 3 for info.
+ name: severityIds
+ required: false
+ schema:
+ type: array
+ description: The alert severity ID list.
+ items:
+ type: integer
+ format: int64
+ description: The alert severity ID.
+ messageMetadataIds:
+ in: query
+ description: The message metadata ID list to filter. Use /alert/metadata/events-by-category or /alert/metadata/metrics-by-metricset APIs to get the message metadata information.
+ name: messageMetadataIds
+ required: false
+ schema:
+ type: array
+ description: The message metadata ID list.
+ items:
+ type: string
+ description: The message metadata ID.
+ siteId:
+ in: query
+ description: The site ID to filter.
+ name: siteId
+ required: false
+ schema:
+ type: integer
+ format: int64
+ description: The site ID
group:
name: group
in: path
@@ -17318,6 +19357,22 @@ components:
required: true
schema:
$ref: '#/components/schemas/XiqAlertGroupQuery'
+ policyId:
+ in: path
+ name: policyId
+ description: The alert policy identifier.
+ schema:
+ type: integer
+ format: int64
+ required: true
+ ruleId:
+ name: ruleId
+ in: path
+ description: The alert rule identifier.
+ required: true
+ schema:
+ type: integer
+ format: int64
wirelessViewType:
in: query
description: The wireless experience view type
@@ -17381,7 +19436,8 @@ components:
name: locationId
required: false
schema:
- type: string
+ type: integer
+ format: int64
wirelessScoreType:
in: query
description: The wireless score type
@@ -17405,7 +19461,7 @@ components:
- AVERAGE
searchKey:
in: query
- description: The search keyword
+ description: The search key
name: searchKey
required: false
schema:
@@ -17422,7 +19478,7 @@ components:
in: query
description: The wired experience view type
name: viewType
- required: true
+ required: false
schema:
type: string
enum:
@@ -17452,6 +19508,42 @@ components:
type: string
enum:
- IN_ERRORS
+ clientType:
+ name: clientType
+ in: query
+ description: The client type
+ required: false
+ schema:
+ $ref: '#/components/schemas/XiqClientType'
+ qualityIndex:
+ name: qualityIndex
+ in: query
+ description: The quality index score
+ required: false
+ schema:
+ $ref: '#/components/schemas/XiqQualityIndex'
+ viewId:
+ in: query
+ description: The location id
+ name: locationId
+ required: true
+ schema:
+ type: integer
+ format: int64
+ ssid:
+ in: query
+ description: The ssid value
+ name: ssid
+ required: false
+ schema:
+ type: string
+ osType:
+ in: query
+ description: The os type value
+ name: osType
+ required: false
+ schema:
+ type: string
anomalyType:
name: anomalyType
in: query
@@ -17553,13 +19645,6 @@ components:
required: false
schema:
$ref: '#/components/schemas/XiqAnomalySeverity'
- searchKey1:
- in: query
- description: The search key
- name: searchKey
- required: false
- schema:
- type: string
async1:
in: query
name: async