ExtremeLocation Device Classification APIs (1.0.0)
Download OpenAPI specification:Download
ExtremeLocation Device Classification Service APIs allow to programmatically classify client devices based on configured rules with ssid, dwell time into Asset, Associate and Personal devices.
Delete classified devices
This API provides user the option to directly delete the classified device based on the type.
Request Body schema: application/json
JSON string containing device configuration
Responses
Device deleted successfully
Bad Request
Error deleting the device
Request samples
- Payload
Reclassify devices
This API helps user in reclassifying the device to Asset, Associate or Visitor.
Request Body schema: application/json
JSON string containing device configuration.
Responses
Device classified successfully
Bad Request
Error in classifying the device
Request samples
- Payload
Upload list of classified MAC addresses
In case of manual classification user need to upload classified list of MAC addresses into a file with asset or associate option.
.The form-data content can be as follows.
type : Type can be Asset,Associate or BYOD.
name : Name is the name of the file.This should be a csv file. (for i.e Sample.csv).Download Sample CSV file
Request Body schema: multipart/form-data
Type of string
| contentDisposition | object (ContentDisposition) |
| entity | object |
| headers | object |
| mediaType | object (MediaType) |
| messageBodyWorkers | object (MessageBodyWorkers) |
| parent | object (MultiPart) |
| providers | object (Providers) |
| simple | boolean Default: false |
| formDataContentDisposition | object (FormDataContentDisposition) |
| name | string |
| value | string |
| parameterizedHeaders | object |
Responses
File uploaded successfully to the server
Bad Request
Failed to upload the file.
Retrieve device rule configuration
Returns rule configuration for Tenant's devices
Request Body schema: application/json
JSON object containing device configuration.
Responses
Device classified successfully.
Bad Request
Error classifying device.
Request samples
- Payload
Create device configuration
In order to classify devices into asset, associate and BYOD type.
* There is a provision to create configuration and save it which is called Device Classification Rule.
* A rule can be configured with asset, associate option where either SSID or dwell time can be specified.
* Rule can also be enabled or disabled for BYOD classification. Refer sample.
* OUI based classification is by default provided into classification service which classifies devices as Asset and needs no configuration.
* The required parameters are as follows.
* Asset : An Asset is a device which is placed at a fixed location.
* Associate : An Associate is a device which is associated with associates in the premises.
* BYOD : The acronym for the BYOD is bring your own device. These are the some of the personal devices in the premises.
Request Body schema: application/json
JSON object containing device configuration.
Responses
Connection successful. Asset or Associate added.
Bad Request
Connection Error. No Connection found
Request samples
- Payload
Retrieve site SSID or BSSID
Returns SSID or BSSID saved rule configuration for Tenant's site containing devices.
query Parameters
| siteId | string JSON object containing device configuration. |
Responses
Configuration retrieved successfully
Bad Request
Error retrieving configuration.